@meistrari/data-token 0.0.1

package/README.md

@@ -0,0 +1,77 @@
+# @meistrari/data-token
+
+Internal library to verify and decode the API Gateway data token.
+
+## Installation
+```shell
+pnpm install @meistrari/data-token
+```
+
+## Usage
+
+### Basic Usage (No Adapter)
+```ts
+import { getValidator } from '@meistrari/data-token'
+
+const validator = getValidator('https://some.api.com/well-known/jwks.json')
+
+async function validateToken(token: string): Promise<DataToken> {
+  return await validator(token)
+}
+```
+
+### Usage with Hono
+```ts
+import { Hono } from 'hono'
+import { DataTokenContext, createDataTokenMiddleware } from '@meistrari/data-token/hono'
+
+// Combine DataTokenContext with your own context type
+interface MyContext {
+  customProp: string
+}
+type AppContext = MyContext & DataTokenContext
+
+const app = new Hono<AppContext>()
+const dataToken = createDataTokenMiddleware('https://some.api.com/well-known/jwks.json')
+
+app.use(dataToken)
+
+app.get('/', (c) => {
+  const authData = c.get('authData')
+  return c.json({ data: authData })
+})
+```
+
+### Usage with Elysia
+```ts
+import { Elysia } from 'elysia'
+import { createDataTokenPlugin } from '@meistrari/data-token/elysia'
+
+const app = new Elysia()
+
+const dataToken = createDataTokenPlugin('https://some.api.com/well-known/jwks.json')
+
+app
+  .use(dataToken)
+  .get('/', ({ authData }) => ({ authData }))
+```
+
+## API Reference
+
+### getValidator(jwksUrl: string, options?: { algorithms?: string[] })
+Creates a validator function that can be used to validate and decode tokens.
+
+### createDataTokenMiddleware(url: string, getToken?: (c: Context) => string)
+Creates a Hono middleware for token validation.
+
+### createDataTokenPlugin(url: string, getToken?: (c: Context) => string)
+Creates an Elysia plugin for token validation.
+
+### Types
+The DataToken type, as well as a Zod schema for the token payload is available from the /types entrypoint, both under the name of `DataToken`:
+
+```ts
+import { DataToken } from '@meistrari/data-token/types'
+```
+
+This type represents the structure of the decoded token data.

package/dist/adapters/elysia.d.ts

@@ -0,0 +1,52 @@
+import type { Context } from 'elysia';
+import Elysia from 'elysia';
+/**
+ * Obtain an instance of the data token plugin for Elysia
+ * @param url - The URL of the JWKS endpoint
+ * @param skipOnError - Whether to skip the error and return null if the token is invalid
+ * @param getToken - A function to get the token from the context
+ * @returns An Elysia plugin
+ *
+ * @example
+ * ```ts
+ * import { createDataTokenPlugin } from 'elysia-jwt'
+ *
+ * const app = new Elysia()
+ * const dataToken = createDataTokenPlugin('https://some.api.com/well-known/jwks.json')
+ *
+ * app.use(dataToken)
+ *    .get('/', ({ authData }) => ({ authData }))
+ * ```
+ */
+export declare function createDataTokenPlugin(url: string, skipOnError?: boolean, getToken?: (c: Context) => string): Elysia<"", false, {
+    decorator: {};
+    store: {};
+    derive: {
+        readonly authData: {
+            workspace: {
+                id: string;
+                title: string;
+            };
+            user?: {
+                id: string | null;
+                name: string | null;
+            } | undefined;
+        } | null;
+    };
+    resolve: {};
+}, {
+    type: {};
+    error: {};
+}, {
+    schema: {};
+    macro: {};
+    macroFn: {};
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+}>;

package/dist/adapters/elysia.js

@@ -0,0 +1,35 @@
+import Elysia from 'elysia';
+import { getValidator } from '..';
+/**
+ * Obtain an instance of the data token plugin for Elysia
+ * @param url - The URL of the JWKS endpoint
+ * @param skipOnError - Whether to skip the error and return null if the token is invalid
+ * @param getToken - A function to get the token from the context
+ * @returns An Elysia plugin
+ *
+ * @example
+ * ```ts
+ * import { createDataTokenPlugin } from 'elysia-jwt'
+ *
+ * const app = new Elysia()
+ * const dataToken = createDataTokenPlugin('https://some.api.com/well-known/jwks.json')
+ *
+ * app.use(dataToken)
+ *    .get('/', ({ authData }) => ({ authData }))
+ * ```
+ */
+export function createDataTokenPlugin(url, skipOnError = false, getToken = c => c.headers['x-data-token'] ?? '') {
+    const validator = getValidator(url);
+    const plugin = new Elysia({ name: 'data-token' })
+        .derive({ as: 'global' }, async (c) => {
+        const token = getToken(c);
+        const data = await validator(token).catch(() => {
+            if (skipOnError) {
+                return null;
+            }
+            throw new Error('Invalid data token');
+        });
+        return { authData: data };
+    });
+    return plugin;
+}

package/dist/adapters/hono.d.ts

@@ -0,0 +1,26 @@
+import type { Context } from 'hono';
+import type { DataToken } from '../types';
+export interface DataTokenContext {
+    Variables: {
+        authData?: DataToken;
+    };
+}
+/**
+ * Create a data token middleware for Hono
+ * @param url - The URL of the JWKS endpoint
+ * @param skipOnError - Whether to skip the error and return null if the token is invalid
+ * @param getToken - A function to get the token from the context
+ * @returns A Hono middleware
+ *
+ * @example
+ * ```ts
+ * import { createDataTokenMiddleware } from 'hono-jwt'
+ *
+ * const app = new Hono<DataTokenContext>()
+ * const dataToken = createDataTokenMiddleware('https://some.api.com/well-known/jwks.json')
+ *
+ * app.use(dataToken)
+ * app.get('/', c => c.json({ data: c.get('authData') }))
+ * ```
+ */
+export declare function createDataTokenMiddleware(url: string, skipOnError?: boolean, getToken?: (c: Context) => string): import("hono").MiddlewareHandler<DataTokenContext, string, {}>;

package/dist/adapters/hono.js

@@ -0,0 +1,36 @@
+import { createMiddleware } from 'hono/factory';
+import { getValidator } from '..';
+/**
+ * Create a data token middleware for Hono
+ * @param url - The URL of the JWKS endpoint
+ * @param skipOnError - Whether to skip the error and return null if the token is invalid
+ * @param getToken - A function to get the token from the context
+ * @returns A Hono middleware
+ *
+ * @example
+ * ```ts
+ * import { createDataTokenMiddleware } from 'hono-jwt'
+ *
+ * const app = new Hono<DataTokenContext>()
+ * const dataToken = createDataTokenMiddleware('https://some.api.com/well-known/jwks.json')
+ *
+ * app.use(dataToken)
+ * app.get('/', c => c.json({ data: c.get('authData') }))
+ * ```
+ */
+export function createDataTokenMiddleware(url, skipOnError = false, getToken = c => c.req.header('x-data-token') ?? '') {
+    return createMiddleware(async (c, next) => {
+        const validator = getValidator(url);
+        const token = getToken(c);
+        const data = await validator(token).catch(() => {
+            if (skipOnError) {
+                return null;
+            }
+            throw new Error('Invalid or missing data token');
+        });
+        if (data) {
+            c.set('authData', data);
+        }
+        await next();
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export declare function getValidator(jwksUrl: string, { algorithms }?: {
+    algorithms: string[];
+}): (token: string) => Promise<{
+    workspace: {
+        id: string;
+        title: string;
+    };
+    user?: {
+        id: string | null;
+        name: string | null;
+    } | undefined;
+}>;

package/dist/index.js

@@ -0,0 +1,9 @@
+import { createRemoteJWKSet, jwtVerify } from 'jose';
+import { DataToken } from './types';
+export function getValidator(jwksUrl, { algorithms } = { algorithms: ['RS256'] }) {
+    const JWKS = createRemoteJWKSet(new URL(jwksUrl));
+    return async (token) => {
+        const { payload } = await jwtVerify(token, JWKS, { algorithms });
+        return DataToken.parse(payload);
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+export declare const DataToken: z.ZodObject<{
+    workspace: z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        title: string;
+    }, {
+        id: string;
+        title: string;
+    }>;
+    user: z.ZodOptional<z.ZodObject<{
+        id: z.ZodNullable<z.ZodString>;
+        name: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string | null;
+        name: string | null;
+    }, {
+        id: string | null;
+        name: string | null;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    workspace: {
+        id: string;
+        title: string;
+    };
+    user?: {
+        id: string | null;
+        name: string | null;
+    } | undefined;
+}, {
+    workspace: {
+        id: string;
+        title: string;
+    };
+    user?: {
+        id: string | null;
+        name: string | null;
+    } | undefined;
+}>;
+export type DataToken = z.infer<typeof DataToken>;
+export interface ValidatorConfig {
+    jwksUrl: string;
+    algorithms?: string[];
+}

package/dist/types.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export const DataToken = z.object({
+    workspace: z.object({
+        id: z.string(),
+        title: z.string(),
+    }),
+    user: z.object({
+        id: z.string().nullable(),
+        name: z.string().nullable(),
+    }).optional(),
+});

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@meistrari/data-token",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@9.0.1",
+  "description": "Internal library to verify and decode the API Gateway data token",
+  "author": "Roz <roz@meistrari.com>",
+  "license": "UNLICENSED",
+  "exports": {
+    ".": "./dist/index.js",
+    "./types": "./dist/types.js",
+    "./hono": "./dist/adapters/hono.js"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "^20.15.1"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "prepare": "husky",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "check": "pnpm run lint && pnpm tsc --noEmit",
+    "prepack": "pnpm run build"
+  },
+  "peerDependencies": {
+    "elysia": "^1.1.9",
+    "hono": "^4.5.9"
+  },
+  "dependencies": {
+    "jose": "^5.8.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^3.0.0",
+    "elysia": "^1.1.9",
+    "eslint": "^9.9.1",
+    "hono": "^4.5.9",
+    "husky": "^9.1.5",
+    "lint-staged": "^15.2.9",
+    "pnpm": "^9.9.0",
+    "typescript": "^5.5.4"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --fix"
+    ]
+  }
+}