@elysiajs/jwt 1.3.2 → 1.3.3

package/README.md

@@ -1,4 +1,4 @@
-# @elysiajs/static
+# @elysiajs/jwt
 
 Plugin for [Elysia](https://github.com/elysiajs/elysia) for using JWT Authentication.
 
@@ -13,7 +13,6 @@ bun add @elysiajs/jwt
 ```typescript
 import { Elysia, t } from 'elysia';
 import { jwt } from '@elysiajs/jwt';
-import { cookie } from '@elysiajs/cookie';
 
 const app = new Elysia()
   .use(
@@ -23,9 +22,9 @@ const app = new Elysia()
       secret: 'MY_SECRETS',
     })
   )
-  .use(cookie())
-  .get('/sign/:name', async ({ jwt, cookie, setCookie, params }) => {
-    setCookie('auth', await jwt.sign(params), {
+  .get('/sign/:name', async ({ jwt, cookie: { auth }, params }) => {
+    auth.set({
+      value: await jwt.sign(params),
       httpOnly: true,
     });
 

package/dist/cjs/index.d.ts

@@ -1,6 +1,11 @@
 import { Elysia, type TSchema, type UnwrapSchema as Static } from 'elysia';
-import { type CryptoKey, type JWK, type KeyObject, type JoseHeaderParameters } from 'jose';
+import { type CryptoKey, type JWK, type KeyObject, type JoseHeaderParameters, type JWTVerifyOptions } from 'jose';
 type UnwrapSchema<Schema extends TSchema | undefined, Fallback = unknown> = Schema extends TSchema ? Static<NonNullable<Schema>> : Fallback;
+type NormalizedClaim = 'nbf' | 'exp' | 'iat';
+type AllowClaimValue = string | number | boolean | null | undefined | AllowClaimValue[] | {
+    [key: string]: AllowClaimValue;
+};
+type ClaimType = Record<string, AllowClaimValue>;
 /**
  * This interface is a specific, strongly-typed representation of the
  * standard claims found in a JWT payload.
@@ -36,6 +41,36 @@ export interface JWTPayloadSpec {
      * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7 RFC7519#section-4.1.7}
      */
     jti?: string;
+    /**
+     * JWT Not Before
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5 RFC7519#section-4.1.5}
+     */
+    nbf?: number;
+    /**
+     * JWT Expiration Time
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4 RFC7519#section-4.1.4}
+     */
+    exp?: number;
+    /**
+     * JWT Issued At
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6 RFC7519#section-4.1.6}
+     */
+    iat?: number;
+}
+/**
+ * This interface defines the shape of JWT payload fields that can be
+ * provided as input when creating or signing a token.
+ *
+ * Unlike `JWTPayloadSpec`, values here may be expressed in more flexible forms,
+ * such as relative time strings or control flags (e.g., `iat: true`).
+ *
+ * This interface is parsed and normalized by the plugin before becoming part
+ * of the final JWT payload.
+ */
+export interface JWTPayloadInput extends Omit<JWTPayloadSpec, NormalizedClaim> {
     /**
      * JWT Not Before
      *
@@ -80,7 +115,7 @@ export interface JWTHeaderParameters extends JoseHeaderParameters {
     /** JWS "crit" (Critical) Header Parameter */
     crit?: string[];
 }
-export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWTHeaderParameters, JWTPayloadSpec {
+export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWTHeaderParameters, JWTPayloadInput {
     /**
      * Name to decorate method as
      *
@@ -111,11 +146,11 @@ export interface JWTOption<Name extends string | undefined = 'jwt', Schema exten
 }
 export declare const jwt: <const Name extends string = "jwt", const Schema extends TSchema | undefined = undefined>({ name, secret, schema, ...defaultValues }: JWTOption<Name, Schema>) => Elysia<"", {
     decorator: { [name in Name extends string ? Name : "jwt"]: {
-        sign(data: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec): Promise<string>;
-        verify(jwt?: string): Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+        sign(signValue: Omit<UnwrapSchema<Schema, ClaimType>, NormalizedClaim> & JWTPayloadInput): Promise<string>;
+        verify(jwt?: string, options?: JWTVerifyOptions): Promise<(UnwrapSchema<Schema, ClaimType> & Omit<JWTPayloadSpec, keyof UnwrapSchema<Schema, {}>>) | false>;
     }; } extends infer T ? { [K in keyof T]: { [name in Name extends string ? Name : "jwt"]: {
-        sign(data: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec): Promise<string>;
-        verify(jwt?: string): Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+        sign(signValue: Omit<UnwrapSchema<Schema, ClaimType>, NormalizedClaim> & JWTPayloadInput): Promise<string>;
+        verify(jwt?: string, options?: JWTVerifyOptions): Promise<(UnwrapSchema<Schema, ClaimType> & Omit<JWTPayloadSpec, keyof UnwrapSchema<Schema, {}>>) | false>;
     }; }[K]; } : never;
     store: {};
     derive: {};

package/dist/cjs/index.js

@@ -2657,9 +2657,9 @@ var jwt = ({
           Type.Union([Type.String(), Type.Array(Type.String())])
         ),
         jti: Type.Optional(Type.String()),
-        nbf: Type.Optional(Type.Union([Type.String(), Type.Number()])),
-        exp: Type.Optional(Type.Union([Type.String(), Type.Number()])),
-        iat: Type.Optional(Type.Union([Type.Number(), Type.String()]))
+        nbf: Type.Optional(Type.Number()),
+        exp: Type.Optional(Type.Number()),
+        iat: Type.Optional(Type.Number())
       })
     ]),
     {
@@ -2675,7 +2675,8 @@ var jwt = ({
       ...defaultValues
     }
   }).decorate(name, {
-    sign(data) {
+    sign(signValue) {
+      const { nbf, exp, iat, ...data } = signValue;
       const JWTHeader = {
         alg: defaultValues.alg ?? "HS256",
         b64: defaultValues.b64,
@@ -2706,28 +2707,32 @@ var jwt = ({
          * Subject (sub): Identifies the principal that is the subject of the JWT.
          */
         sub: data.sub ?? defaultValues.sub,
-        // Includes all other properties from the data source, both standard and custom.
+        // Includes all other properties from the data source, both standard and custom,
+        // excluding standard JWT claims like `nbf`, `exp` and `iat`.
         ...data
       };
       let jwt2 = new import_jose.SignJWT({ ...JWTPayload }).setProtectedHeader({
         alg: JWTHeader.alg,
         ...JWTHeader
       });
-      if (data.nbf !== void 0 || defaultValues.nbf !== void 0) {
-        jwt2 = jwt2.setNotBefore(data.nbf ?? defaultValues.nbf);
+      const setNbf = "nbf" in signValue ? nbf : defaultValues.nbf;
+      if (setNbf !== void 0) {
+        jwt2 = jwt2.setNotBefore(setNbf);
       }
-      if (data.exp !== void 0 || defaultValues.exp !== void 0) {
-        jwt2 = jwt2.setExpirationTime(data.exp ?? defaultValues.exp);
+      const setExp = "exp" in signValue ? exp : defaultValues.exp;
+      if (setExp !== void 0) {
+        jwt2 = jwt2.setExpirationTime(setExp);
       }
-      if (defaultValues.iat !== false || data.iat !== false) {
+      const setIat = "iat" in signValue ? iat : defaultValues.iat;
+      if (setIat !== false) {
         jwt2 = jwt2.setIssuedAt(/* @__PURE__ */ new Date());
       }
       return jwt2.sign(key);
     },
-    async verify(jwt2) {
+    async verify(jwt2, options) {
       if (!jwt2) return false;
       try {
-        const data = (await (0, import_jose.jwtVerify)(jwt2, key)).payload;
+        const data = (await (options ? (0, import_jose.jwtVerify)(jwt2, key, options) : (0, import_jose.jwtVerify)(jwt2, key))).payload;
         if (validator && !validator.Check(data))
           throw new import_elysia.ValidationError("JWT", validator, data);
         return data;

package/dist/index.d.ts

@@ -1,6 +1,11 @@
 import { Elysia, type TSchema, type UnwrapSchema as Static } from 'elysia';
-import { type CryptoKey, type JWK, type KeyObject, type JoseHeaderParameters } from 'jose';
+import { type CryptoKey, type JWK, type KeyObject, type JoseHeaderParameters, type JWTVerifyOptions } from 'jose';
 type UnwrapSchema<Schema extends TSchema | undefined, Fallback = unknown> = Schema extends TSchema ? Static<NonNullable<Schema>> : Fallback;
+type NormalizedClaim = 'nbf' | 'exp' | 'iat';
+type AllowClaimValue = string | number | boolean | null | undefined | AllowClaimValue[] | {
+    [key: string]: AllowClaimValue;
+};
+type ClaimType = Record<string, AllowClaimValue>;
 /**
  * This interface is a specific, strongly-typed representation of the
  * standard claims found in a JWT payload.
@@ -36,6 +41,36 @@ export interface JWTPayloadSpec {
      * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7 RFC7519#section-4.1.7}
      */
     jti?: string;
+    /**
+     * JWT Not Before
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5 RFC7519#section-4.1.5}
+     */
+    nbf?: number;
+    /**
+     * JWT Expiration Time
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4 RFC7519#section-4.1.4}
+     */
+    exp?: number;
+    /**
+     * JWT Issued At
+     *
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6 RFC7519#section-4.1.6}
+     */
+    iat?: number;
+}
+/**
+ * This interface defines the shape of JWT payload fields that can be
+ * provided as input when creating or signing a token.
+ *
+ * Unlike `JWTPayloadSpec`, values here may be expressed in more flexible forms,
+ * such as relative time strings or control flags (e.g., `iat: true`).
+ *
+ * This interface is parsed and normalized by the plugin before becoming part
+ * of the final JWT payload.
+ */
+export interface JWTPayloadInput extends Omit<JWTPayloadSpec, NormalizedClaim> {
     /**
      * JWT Not Before
      *
@@ -80,7 +115,7 @@ export interface JWTHeaderParameters extends JoseHeaderParameters {
     /** JWS "crit" (Critical) Header Parameter */
     crit?: string[];
 }
-export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWTHeaderParameters, JWTPayloadSpec {
+export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWTHeaderParameters, JWTPayloadInput {
     /**
      * Name to decorate method as
      *
@@ -111,11 +146,11 @@ export interface JWTOption<Name extends string | undefined = 'jwt', Schema exten
 }
 export declare const jwt: <const Name extends string = "jwt", const Schema extends TSchema | undefined = undefined>({ name, secret, schema, ...defaultValues }: JWTOption<Name, Schema>) => Elysia<"", {
     decorator: { [name in Name extends string ? Name : "jwt"]: {
-        sign(data: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec): Promise<string>;
-        verify(jwt?: string): Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+        sign(signValue: Omit<UnwrapSchema<Schema, ClaimType>, NormalizedClaim> & JWTPayloadInput): Promise<string>;
+        verify(jwt?: string, options?: JWTVerifyOptions): Promise<(UnwrapSchema<Schema, ClaimType> & Omit<JWTPayloadSpec, keyof UnwrapSchema<Schema, {}>>) | false>;
     }; } extends infer T ? { [K in keyof T]: { [name in Name extends string ? Name : "jwt"]: {
-        sign(data: UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec): Promise<string>;
-        verify(jwt?: string): Promise<(UnwrapSchema<Schema, Record<string, string | number>> & JWTPayloadSpec) | false>;
+        sign(signValue: Omit<UnwrapSchema<Schema, ClaimType>, NormalizedClaim> & JWTPayloadInput): Promise<string>;
+        verify(jwt?: string, options?: JWTVerifyOptions): Promise<(UnwrapSchema<Schema, ClaimType> & Omit<JWTPayloadSpec, keyof UnwrapSchema<Schema, {}>>) | false>;
     }; }[K]; } : never;
     store: {};
     derive: {};

package/dist/index.mjs

@@ -2645,9 +2645,9 @@ var jwt = ({
           Type.Union([Type.String(), Type.Array(Type.String())])
         ),
         jti: Type.Optional(Type.String()),
-        nbf: Type.Optional(Type.Union([Type.String(), Type.Number()])),
-        exp: Type.Optional(Type.Union([Type.String(), Type.Number()])),
-        iat: Type.Optional(Type.Union([Type.Number(), Type.String()]))
+        nbf: Type.Optional(Type.Number()),
+        exp: Type.Optional(Type.Number()),
+        iat: Type.Optional(Type.Number())
       })
     ]),
     {
@@ -2663,7 +2663,8 @@ var jwt = ({
       ...defaultValues
     }
   }).decorate(name, {
-    sign(data) {
+    sign(signValue) {
+      const { nbf, exp, iat, ...data } = signValue;
       const JWTHeader = {
         alg: defaultValues.alg ?? "HS256",
         b64: defaultValues.b64,
@@ -2694,28 +2695,32 @@ var jwt = ({
          * Subject (sub): Identifies the principal that is the subject of the JWT.
          */
         sub: data.sub ?? defaultValues.sub,
-        // Includes all other properties from the data source, both standard and custom.
+        // Includes all other properties from the data source, both standard and custom,
+        // excluding standard JWT claims like `nbf`, `exp` and `iat`.
         ...data
       };
       let jwt2 = new SignJWT({ ...JWTPayload }).setProtectedHeader({
         alg: JWTHeader.alg,
         ...JWTHeader
       });
-      if (data.nbf !== void 0 || defaultValues.nbf !== void 0) {
-        jwt2 = jwt2.setNotBefore(data.nbf ?? defaultValues.nbf);
+      const setNbf = "nbf" in signValue ? nbf : defaultValues.nbf;
+      if (setNbf !== void 0) {
+        jwt2 = jwt2.setNotBefore(setNbf);
       }
-      if (data.exp !== void 0 || defaultValues.exp !== void 0) {
-        jwt2 = jwt2.setExpirationTime(data.exp ?? defaultValues.exp);
+      const setExp = "exp" in signValue ? exp : defaultValues.exp;
+      if (setExp !== void 0) {
+        jwt2 = jwt2.setExpirationTime(setExp);
       }
-      if (defaultValues.iat !== false || data.iat !== false) {
+      const setIat = "iat" in signValue ? iat : defaultValues.iat;
+      if (setIat !== false) {
         jwt2 = jwt2.setIssuedAt(/* @__PURE__ */ new Date());
       }
       return jwt2.sign(key);
     },
-    async verify(jwt2) {
+    async verify(jwt2, options) {
       if (!jwt2) return false;
       try {
-        const data = (await jwtVerify(jwt2, key)).payload;
+        const data = (await (options ? jwtVerify(jwt2, key, options) : jwtVerify(jwt2, key))).payload;
         if (validator && !validator.Check(data))
           throw new ValidationError("JWT", validator, data);
         return data;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@elysiajs/jwt",
 	"description": "Plugin for Elysia for using JWT Authentication",
-	"version": "1.3.2",
+	"version": "1.3.3",
 	"author": {
 		"name": "saltyAom",
 		"url": "https://github.com/SaltyAom",