@elysiajs/jwt 1.0.2 → 1.1.0-rc.0

package/dist/cjs/index.d.ts

@@ -12,20 +12,54 @@ export interface JWTPayloadSpec {
     iat?: number;
 }
 export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWSHeaderParameters, Omit<JWTPayload, 'nbf' | 'exp'> {
+    /**
+     * Name to decorate method as
+     *
+     * ---
+     * @example
+     * For example, `jwt` will decorate Context with `Context.jwt`
+     *
+     * ```typescript
+     * app
+     *     .decorate({
+     *         name: 'myJWTNamespace',
+     *         secret: process.env.JWT_SECRETS
+     *     })
+     *     .get('/sign/:name', ({ myJWTNamespace, params }) => {
+     *         return myJWTNamespace.sign(params)
+     *     })
+     * ```
+     */
     name?: Name;
+    /**
+     * JWT Secret
+     */
     secret: string | Uint8Array | KeyLike;
+    /**
+     * Type strict validation for JWT payload
+     */
     schema?: Schema;
+    /**
+     * JWT Not Before
+     *
+     * @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
+     */
     nbf?: string | number;
+    /**
+     * JWT Expiration Time
+     *
+     * @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
+     */
     exp?: string | number;
 }
 export declare const jwt: <const Name extends string = "jwt", const Schema extends TSchema | undefined = undefined>({ name, secret, alg, crit, schema, nbf, exp, ...payload }: JWTOption<Name, Schema>) => Elysia<"", false, {
-    decorator: { [name in Name extends string ? Name : "jwt"]: {
+    decorator: ({ [name in Name extends string ? Name : "jwt"]: {
         readonly sign: (morePayload: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) => Promise<string>;
-        readonly verify: (jwt?: string) => Promise<false | (UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec)>;
-    }; } extends infer T ? { [K in keyof T]: { [name in Name extends string ? Name : "jwt"]: {
+        readonly verify: (jwt?: string) => Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+    }; } extends infer T extends Object ? { [key in keyof T as key extends never ? never : key]: { [name in Name extends string ? Name : "jwt"]: {
         readonly sign: (morePayload: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) => Promise<string>;
-        readonly verify: (jwt?: string) => Promise<false | (UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec)>;
-    }; }[K]; } : never;
+        readonly verify: (jwt?: string) => Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+    }; }[key]; } : never) extends infer Collision ? {} extends Collision ? {} : { [K in keyof ({} & Collision)]: ({} & Collision)[K]; } : never;
     store: {};
     derive: {};
     resolve: {};
@@ -35,13 +69,14 @@ export declare const jwt: <const Name extends string = "jwt", const Schema exten
 }, {
     schema: {};
     macro: {};
+    macroFn: {};
 }, {}, {
-    decorator: {};
-    store: {};
     derive: {};
     resolve: {};
+    schema: {};
 }, {
+    derive: {};
+    resolve: {};
     schema: {};
-    macro: {};
 }>;
 export default jwt;