@navios/jwt 0.5.0 → 0.7.1

package/dist/src/options/jwt-service.options.d.mts

@@ -1,9 +1,22 @@
 import type { Secret as JwtSecret } from 'jsonwebtoken';
 import { z } from 'zod/v4';
+/**
+ * Request type for secret or key provider functions.
+ *
+ * Used to distinguish between signing and verification operations when
+ * dynamically resolving secrets or keys.
+ */
 export declare enum RequestType {
+    /** Request is for signing a token */
     Sign = "Sign",
+    /** Request is for verifying a token */
     Verify = "Verify"
 }
+/**
+ * Supported JWT algorithms.
+ *
+ * Includes symmetric (HMAC) and asymmetric (RSA, ECDSA, EdDSA) algorithms.
+ */
 export declare const AlgorithmType: z.ZodEnum<{
     HS256: "HS256";
     HS384: "HS384";
@@ -19,6 +32,11 @@ export declare const AlgorithmType: z.ZodEnum<{
     PS512: "PS512";
     none: "none";
 }>;
+/**
+ * JWT header schema.
+ *
+ * Defines the structure of the JWT header with standard claims.
+ */
 export declare const JwtHeaderSchema: z.ZodObject<{
     alg: z.ZodUnion<[z.ZodEnum<{
         HS256: "HS256";
@@ -45,7 +63,18 @@ export declare const JwtHeaderSchema: z.ZodObject<{
     x5t: z.ZodOptional<z.ZodString>;
     x5c: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
 }, z.core.$strip>;
+/**
+ * JWT header type.
+ *
+ * Contains algorithm, type, and optional header claims.
+ */
 export type JwtHeader = z.infer<typeof JwtHeaderSchema>;
+/**
+ * Schema for JWT signing options.
+ *
+ * Defines all available options for signing tokens including algorithm,
+ * expiration, audience, issuer, and other standard JWT claims.
+ */
 export declare const SignOptionsSchema: z.ZodObject<{
     algorithm: z.ZodOptional<z.ZodEnum<{
         HS256: "HS256";
@@ -101,7 +130,18 @@ export declare const SignOptionsSchema: z.ZodObject<{
     allowInsecureKeySizes: z.ZodOptional<z.ZodBoolean>;
     allowInvalidAsymmetricKeyTypes: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Options for signing JWT tokens.
+ *
+ * @see SignOptionsSchema for the complete schema definition
+ */
 export type SignOptions = z.infer<typeof SignOptionsSchema>;
+/**
+ * Schema for JWT verification options.
+ *
+ * Defines all available options for verifying tokens including allowed
+ * algorithms, audience, issuer, expiration handling, and other validation rules.
+ */
 export declare const VerifyOptionsSchema: z.ZodObject<{
     algorithms: z.ZodOptional<z.ZodArray<z.ZodEnum<{
         HS256: "HS256";
@@ -131,13 +171,28 @@ export declare const VerifyOptionsSchema: z.ZodObject<{
     maxAge: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
     allowInvalidAsymmetricKeyTypes: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Options for verifying JWT tokens.
+ *
+ * @see VerifyOptionsSchema for the complete schema definition
+ */
 export type VerifyOptions = z.infer<typeof VerifyOptionsSchema>;
+/**
+ * Schema for JWT secret/key types.
+ *
+ * Supports string secrets, Buffer objects, and key objects with passphrases.
+ */
 export declare const SecretSchema: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>, z.ZodObject<{
     type: z.ZodString;
 }, z.core.$loose>, z.ZodObject<{
     key: z.ZodUnion<readonly [z.ZodString, z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>]>;
     passphrase: z.ZodString;
 }, z.core.$strip>]>;
+/**
+ * Secret or key type for JWT operations.
+ *
+ * Can be a string, Buffer, or an object with key and optional passphrase.
+ */
 export type Secret = z.infer<typeof SecretSchema>;
 export declare const JwtServiceOptionsSchema: z.ZodObject<{
     signOptions: z.ZodOptional<z.ZodObject<{
@@ -326,14 +381,65 @@ export declare const JwtServiceOptionsSchema: z.ZodObject<{
         passphrase: z.ZodString;
     }, z.core.$strip>]>>]>>>;
 }, z.core.$strip>;
+/**
+ * Configuration options for the JWT service.
+ *
+ * @property signOptions - Default options for signing tokens
+ * @property secret - Default secret for symmetric algorithms (HS256, HS384, HS512)
+ * @property publicKey - Default public key for asymmetric algorithms (RS256, ES256, etc.)
+ * @property privateKey - Default private key for asymmetric algorithms
+ * @property verifyOptions - Default options for verifying tokens
+ * @property secretOrKeyProvider - Optional function to dynamically resolve secrets/keys
+ *
+ * @example
+ * ```ts
+ * const options: JwtServiceOptions = {
+ *   secret: 'your-secret-key',
+ *   signOptions: {
+ *     expiresIn: '1h',
+ *     algorithm: 'HS256',
+ *   },
+ *   verifyOptions: {
+ *     algorithms: ['HS256'],
+ *   },
+ * }
+ * ```
+ */
 export type JwtServiceOptions = z.infer<typeof JwtServiceOptionsSchema>;
+/**
+ * Options for signing JWT tokens.
+ *
+ * Extends `SignOptions` with additional properties for specifying
+ * the secret or private key to use for signing.
+ *
+ * @property secret - Secret key for symmetric algorithms (overrides service default)
+ * @property privateKey - Private key for asymmetric algorithms (overrides service default)
+ */
 export interface JwtSignOptions extends SignOptions {
+    /** Secret key for symmetric algorithms */
     secret?: string | Buffer;
+    /** Private key for asymmetric algorithms */
     privateKey?: Secret;
 }
+/**
+ * Options for verifying JWT tokens.
+ *
+ * Extends `VerifyOptions` with additional properties for specifying
+ * the secret or public key to use for verification.
+ *
+ * @property secret - Secret key for symmetric algorithms (overrides service default)
+ * @property publicKey - Public key for asymmetric algorithms (overrides service default)
+ */
 export interface JwtVerifyOptions extends VerifyOptions {
+    /** Secret key for symmetric algorithms */
     secret?: string | Buffer;
+    /** Public key for asymmetric algorithms */
     publicKey?: string | Buffer;
 }
+/**
+ * Result type for secret/key resolution.
+ *
+ * Represents the possible return types from secret or key provider functions.
+ */
 export type GetSecretKeyResult = string | Buffer | JwtSecret;
 //# sourceMappingURL=jwt-service.options.d.mts.map

package/dist/src/options/jwt-service.options.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"jwt-service.options.d.mts","sourceRoot":"","sources":["../../../src/options/jwt-service.options.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,cAAc,CAAA;AAEvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;EAcxB,CAAA;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;iBAW1B,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEvD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqB5B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAE3D,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D,eAAO,MAAM,YAAY;;;;;mBAYvB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAEjD,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBlC,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAEvE,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA"}
+{"version":3,"file":"jwt-service.options.d.mts","sourceRoot":"","sources":["../../../src/options/jwt-service.options.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,cAAc,CAAA;AAEvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B;;;;;GAKG;AACH,oBAAY,WAAW;IACrB,qCAAqC;IACrC,IAAI,SAAS;IACb,uCAAuC;IACvC,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;EAcxB,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;iBAW1B,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqB5B,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB9B,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE/D;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;mBAYvB,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAEjD,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBlC,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAEvE;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACrD,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA"}