@elysiajs/jwt 0.6.2 → 0.6.4

package/README.md

@@ -1,104 +1,121 @@
 # @elysiajs/static
+
 Plugin for [Elysia](https://github.com/elysiajs/elysia) for using JWT Authentication.
 
 ## Installation
+
 ```bash
 bun add @elysiajs/jwt
 ```
 
 ## Example
+
 ```typescript
-import { Elysia, t } from 'elysia'
-import { jwt } from '@elysiajs/jwt'
-import { cookie } from '@elysiajs/cookie'
+import { Elysia, t } from 'elysia';
+import { jwt } from '@elysiajs/jwt';
+import { cookie } from '@elysiajs/cookie';
 
 const app = new Elysia()
-    .use(
-        jwt({
-            name: 'jwt',
-            // This should be Environment Variable
-            secret: 'MY_SECRETS'
-        })
-    )
-    .use(cookie())
-    .get('/sign/:name', async ({ jwt, cookie, setCookie, params }) => {
-        setCookie('auth', await jwt.sign(params), {
-            httpOnly: true
-        })
-
-        return `Sign in as ${params.name}`
-    })
-    .get('/profile', async ({ jwt, set, cookie: { auth } }) => {
-        const profile = await jwt.verify(auth)
-
-        if (!profile) {
-            set.status = 401
-            return 'Unauthorized'
-        }
-
-        return `Hello ${profile.name}`
+  .use(
+    jwt({
+      name: 'jwt',
+      // This should be Environment Variable
+      secret: 'MY_SECRETS',
     })
-    .listen(8080)
+  )
+  .use(cookie())
+  .get('/sign/:name', async ({ jwt, cookie, setCookie, params }) => {
+    setCookie('auth', await jwt.sign(params), {
+      httpOnly: true,
+    });
+
+    return `Sign in as ${params.name}`;
+  })
+  .get('/profile', async ({ jwt, set, cookie: { auth } }) => {
+    const profile = await jwt.verify(auth);
+
+    if (!profile) {
+      set.status = 401;
+      return 'Unauthorized';
+    }
+
+    return `Hello ${profile.name}`;
+  })
+  .listen(8080);
 ```
 
 ## Config
-This package extends [jose](https://github.com/panva/jose), most config is inherited from Jose. 
+
+This package extends [jose](https://github.com/panva/jose), most config is inherited from Jose.
 
 Below are configurable properties for using JWT plugin
 
 ### name
+
 Name to decorate method as:
 
 For example, `jwt` will decorate Context with `Context.jwt`
 
 ### secret
+
 JWT secret key
 
 ### schema
+
 Type strict validation for JWT payload
 
 ## Jose's config
+
 Below is the config inherits from [jose](https://github.com/panva/jose)
 
 ### alg
+
 @default 'HS256'
 
 Algorithm to sign JWT with
 
 ### crit
+
 Critical Header Parameter.
 
 ### iss
+
 JWT Issuer
 
 @see [RFC7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
 
 ### sub
+
 JWT Subject
 
 @see [RFC7519#section-4.1.2](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2)
 
 ### aud
-JWT Audience 
+
+JWT Audience
 
 @see [RFC7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
 
 ### jti
+
 JWT ID
 
 @see [RFC7519#section-4.1.7](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7)
 
 ### nbf
+
 JWT Not Before
 
 @see [RFC7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
 
 ### exp
+
 JWT Expiration Time
 
 @see [RFC7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
 
 ### iat
+
 JWT Issued At
 
 @see [RFC7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)

package/dist/cjs/index.d.ts

@@ -1,5 +1,5 @@
 import { Elysia } from 'elysia';
-import { type JWTPayload, type JWSHeaderParameters } from 'jose';
+import { type JWTPayload, type JWSHeaderParameters, type KeyLike } from 'jose';
 import type { Static, TSchema } from '@sinclair/typebox';
 type UnwrapSchema<Schema extends TSchema | undefined, Fallback = unknown> = Schema extends TSchema ? Static<NonNullable<Schema>> : Fallback;
 export interface JWTPayloadSpec {
@@ -13,7 +13,7 @@ export interface JWTPayloadSpec {
 }
 export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWSHeaderParameters, Omit<JWTPayload, 'nbf' | 'exp'> {
     name?: Name;
-    secret: string;
+    secret: string | Uint8Array | KeyLike;
     schema?: Schema;
     nbf?: string | number;
     exp?: string | number;

package/dist/cjs/index.js

@@ -7,9 +7,9 @@ const typebox_1 = require("@sinclair/typebox");
 const jwt = ({ name = 'jwt', secret, alg = 'HS256', crit, schema, nbf, exp, ...payload }) => {
     if (!secret)
         throw new Error("Secret can't be empty");
-    const key = new TextEncoder().encode(secret);
+    const key = typeof secret === 'string' ? new TextEncoder().encode(secret) : secret;
     const validator = schema
-        ? (0, elysia_1.getSchemaValidator)(typebox_1.Type.Union([
+        ? (0, elysia_1.getSchemaValidator)(typebox_1.Type.Intersect([
             schema,
             typebox_1.Type.Object({
                 iss: typebox_1.Type.Optional(typebox_1.Type.String()),

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Elysia } from 'elysia';
-import { type JWTPayload, type JWSHeaderParameters } from 'jose';
+import { type JWTPayload, type JWSHeaderParameters, type KeyLike } from 'jose';
 import type { Static, TSchema } from '@sinclair/typebox';
 type UnwrapSchema<Schema extends TSchema | undefined, Fallback = unknown> = Schema extends TSchema ? Static<NonNullable<Schema>> : Fallback;
 export interface JWTPayloadSpec {
@@ -13,7 +13,7 @@ export interface JWTPayloadSpec {
 }
 export interface JWTOption<Name extends string | undefined = 'jwt', Schema extends TSchema | undefined = undefined> extends JWSHeaderParameters, Omit<JWTPayload, 'nbf' | 'exp'> {
     name?: Name;
-    secret: string;
+    secret: string | Uint8Array | KeyLike;
     schema?: Schema;
     nbf?: string | number;
     exp?: string | number;

package/dist/index.js

@@ -1,12 +1,12 @@
-import { ValidationError, getSchemaValidator, Elysia } from 'elysia';
+import { Elysia, ValidationError, getSchemaValidator } from 'elysia';
 import { SignJWT, jwtVerify } from 'jose';
 import { Type as t } from '@sinclair/typebox';
 export const jwt = ({ name = 'jwt', secret, alg = 'HS256', crit, schema, nbf, exp, ...payload }) => {
     if (!secret)
         throw new Error("Secret can't be empty");
-    const key = new TextEncoder().encode(secret);
+    const key = typeof secret === 'string' ? new TextEncoder().encode(secret) : secret;
     const validator = schema
-        ? getSchemaValidator(t.Union([
+        ? getSchemaValidator(t.Intersect([
             schema,
             t.Object({
                 iss: t.Optional(t.String()),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elysiajs/jwt",
   "description": "Plugin for Elysia for using JWT Authentication",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "author": {
     "name": "saltyAom",
     "url": "https://github.com/SaltyAom",
@@ -19,7 +19,7 @@
     "import": "./dist/index.js",
     "default": "./dist/index.js"
   },
-  "types": "./dist/index.ts",
+  "types": "./dist/index.d.ts",
   "bugs": "https://github.com/elysiajs/elysia-jwt/issues",
   "homepage": "https://github.com/elysiajs/elysia-jwt",
   "keywords": [
@@ -31,7 +31,7 @@
   "license": "MIT",
   "scripts": {
     "dev": "bun run --hot example/index.ts",
-    "test": "bun wiptest && npm run test:node",
+    "test": "bun test && npm run test:node",
     "test:node": "npm install --prefix ./test/node/cjs/ && npm install --prefix ./test/node/esm/ && node ./test/node/cjs/index.js && node ./test/node/esm/index.js",
     "build": "rimraf dist && tsc --project tsconfig.esm.json && tsc --project tsconfig.cjs.json",
     "release": "npm run build && npm run test && npm publish --access public"
@@ -43,6 +43,8 @@
     "@elysiajs/cookie": "^0.3.0",
     "@sinclair/typebox": "^0.30.4",
     "@types/node": "^20.1.4",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
     "bun-types": "^0.5.8",
     "elysia": "0.6.6",
     "eslint": "^8.40.0",
@@ -50,6 +52,6 @@
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "elysia": ">= 0.5.12"
+    "elysia": ">= 0.6.0"
   }
 }

package/src/index.ts

@@ -1,177 +0,0 @@
-import {
-    ValidationError,
-    getSchemaValidator,
-    Elysia,
-    type Context,
-    ElysiaInstance
-} from 'elysia'
-
-import {
-    SignJWT,
-    jwtVerify,
-    type JWTPayload,
-    type JWSHeaderParameters
-} from 'jose'
-
-import { Type as t } from '@sinclair/typebox'
-import type { Static, TObject, TSchema } from '@sinclair/typebox'
-
-type UnwrapSchema<
-    Schema extends TSchema | undefined,
-    Fallback = unknown
-> = Schema extends TSchema ? Static<NonNullable<Schema>> : Fallback
-
-export interface JWTPayloadSpec {
-    iss?: string
-    sub?: string
-    aud?: string | string[]
-    jti?: string
-    nbf?: number
-    exp?: number
-    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
-    /**
-     * 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 const jwt = <
-    Name extends string = 'jwt',
-    Schema extends TSchema | undefined = undefined
->({
-    name = 'jwt' as Name,
-    secret,
-    // Start JWT Header
-    alg = 'HS256',
-    crit,
-    schema,
-    // End JWT Header
-    // Start JWT Payload
-    nbf,
-    exp,
-    ...payload
-}: // End JWT Payload
-JWTOption<Name, Schema>) => {
-    if (!secret) throw new Error("Secret can't be empty")
-
-    const key = new TextEncoder().encode(secret)
-
-    const validator = schema
-        ? getSchemaValidator(
-              t.Union([
-                  schema as any,
-                  t.Object({
-                      iss: t.Optional(t.String()),
-                      sub: t.Optional(t.String()),
-                      aud: t.Optional(
-                          t.Union([t.String(), t.Array(t.String())])
-                      ),
-                      jti: t.Optional(t.String()),
-                      nbf: t.Optional(t.Union([t.String(), t.Number()])),
-                      exp: t.Optional(t.Union([t.String(), t.Number()])),
-                      iat: t.Optional(t.String())
-                  })
-              ]) as any,
-              {}
-          )
-        : undefined
-
-    return new Elysia({
-        name: '@elysiajs/jwt',
-        seed: {
-            name,
-            secret,
-            alg,
-            crit,
-            schema,
-            nbf,
-            exp,
-            ...payload
-        }
-    }).decorate(name as Name extends string ? Name : 'jwt', {
-        sign: (
-            morePayload: UnwrapSchema<Schema, Record<string, string>> &
-                JWTPayloadSpec
-        ) => {
-            let jwt = new SignJWT({
-                ...payload,
-                ...morePayload,
-                nbf: undefined,
-                exp: undefined
-            }).setProtectedHeader({
-                alg,
-                crit
-            })
-
-            if (nbf) jwt = jwt.setNotBefore(nbf)
-            if (exp) jwt = jwt.setExpirationTime(exp)
-
-            return jwt.sign(key)
-        },
-        verify: async (
-            jwt?: string
-        ): Promise<
-            | (UnwrapSchema<Schema, Record<string, string>> & JWTPayloadSpec)
-            | false
-        > => {
-            if (!jwt) return false
-
-            try {
-                const data: any = (await jwtVerify(jwt, key)).payload
-
-                if (validator && !validator!.Check(data))
-                    throw new ValidationError('JWT', validator, data)
-
-                return data
-            } catch (_) {
-                return false
-            }
-        }
-    })
-}
-
-export default jwt