explicit — Code View¶
← Back to Container | ← Back to System
Component Information¶
| Field | Value |
|---|---|
| Component | explicit |
| Container | @chrislyons-dev/flarelette-jwt |
| Type | module |
| Description | Explicit configuration API for JWT operations. This module provides functions that accept explicit configuration objects instead of relying on environment variables or global state. Use this API when you need full control over configuration, especially in development environments or when working with multiple JWT configurations. |
| --- |
Code Structure¶
Class Diagram¶
Code Elements¶
11 code element(s)
#### Functions ##### `signWithConfig()` Sign a JWT token with explicit configuration | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promiseimport("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/types").JwtPayload — - Claims to include in the token- `config`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").SignConfig — - Explicit JWT configuration- `overrides`: Partial<{ iss: string; aud: string | string[]; ttlSeconds: number; }> — - Optional per-call overrides for iss, aud, ttlSeconds **Examples:** --- ##### `verifyWithConfig()` Verify a JWT token with explicit configuration | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promisestring — - JWT token string to verify- `config`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").VerifyConfig — - Explicit JWT configuration- `overrides`: Partial<{ iss: string; aud: string | string[]; leeway: number; }> — - Optional per-call overrides for iss, aud, leeway **Examples:** --- ##### `createTokenWithConfig()` Create a signed JWT token with explicit configuration Higher-level wrapper around signWithConfig for convenience. | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promiseimport("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/types").JwtPayload — - Claims to include in the token- `config`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").SignConfig — - Explicit JWT configuration- `overrides`: Partial<{ iss: string; aud: string | string[]; ttlSeconds: number; }> — - Optional per-call overrides --- ##### `createDelegatedTokenWithConfig()` Create a delegated JWT token with explicit configuration Implements RFC 8693 actor claim pattern for service-to-service delegation. | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promiseimport("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/types").JwtPayload — - The verified JWT payload from external auth- `actorService`: string — - Identifier of the service creating this delegated token- `config`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").SignConfig — - Explicit JWT configuration- `overrides`: Partial<{ iss: string; aud: string | string[]; ttlSeconds: number; }> — - Optional per-call overrides **Examples:** --- ##### `checkAuthWithConfig()` Verify and authorize a JWT token with explicit configuration | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Async** | Yes || **Returns** | `Promisestring — - JWT token string to verify- `config`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").VerifyConfig — - Explicit JWT configuration- `authzOpts`: import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").AuthzOptsWithConfig — - Authorization policy requirements- `verifyOverrides`: Partial<{ iss: string; aud: string | string[]; leeway: number; }> — - Optional per-call verification overrides **Examples:** --- ##### `createHS512Config()` Helper function to create HS512 config from base64url-encoded secret | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").HS512Config` - HS512 configuration || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:470` | **Parameters:** - `secret`: string — - Base64url-encoded secret string- `baseConfig`: Omit & Partial> — - Base JWT configuration --- ##### `createEdDSASignConfig()` Helper function to create EdDSA sign config from JWK | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").EdDSASignConfig` - EdDSA sign configuration || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:499` | **Parameters:** - `privateJwk`: any — - Private JWK object or JSON string- `baseConfig`: Omit & Partial> — - Base JWT configuration- `kid`: string — - Optional key ID --- ##### `createEdDSAVerifyConfig()` Helper function to create EdDSA verify config from JWK | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").EdDSAVerifyConfig` - EdDSA verify configuration || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:521` | **Parameters:** - `publicJwk`: any — - Public JWK object or JSON string- `baseConfig`: Omit & Partial> — - Base JWT configuration --- ##### `createES512SignConfig()` Helper function to create ES512 sign config from a P-521 EC private JWK | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").ES512SignConfig` - ES512 sign configuration || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:542` | **Parameters:** - `privateJwk`: any — - Private JWK object or JSON string (EC P-521 key)- `baseConfig`: Omit & Partial> — - Base JWT configuration- `kid`: string — - Optional key ID --- ##### `createES512VerifyConfig()` Helper function to create ES512 verify config from a P-521 EC public JWK | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").ES512VerifyConfig` - ES512 verify configuration || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:564` | **Parameters:** - `publicJwk`: any — - Public JWK object or JSON string (EC P-521 key)- `baseConfig`: Omit & Partial> — - Base JWT configuration --- ##### `createJWKSUrlVerifyConfig()` | Field | Value | | --- | --- | | **Type** | `function` | | **Visibility** | `public` | | **Returns** | `import("C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit").JWKSUrlVerifyConfig` || **Location** | `C:/Users/chris/git/flarelette-jwt-kit/packages/flarelette-jwt-ts/src/explicit.ts:614` | **Parameters:** - `jwksUrl`: string- `algOrBaseConfig`: "EdDSA" | (Omit & Partial>) | "ES256" | "ES384" | "ES512" | "RS256" | "RS384" | "RS512" - `baseConfigOrCacheTtl`: number | (Omit & Partial>) - `maybeCacheTtl`: number ---