two-stroke 1.0.6 → 1.0.8

package/bin/test.mjs

@@ -9,14 +9,14 @@ if (fs.existsSync("wrangler.toml")) {
   await cmd("wrangler deploy --dry-run --outdir=dist");
   const app = await import(`${process.cwd()}/dist/index.js`);
   const request = await app.default.fetch(
-    { url: "http://example.com/doc/", method: "GET" },
+    { url: "http://example.com/doc", method: "GET" },
     { SENTRY_DSN: null, SENTRY_ENVIRONMENT: null },
     null,
   );
   const types = await openapiTS(await consumers.json(request.body));
   fs.writeFileSync("test/api.d.ts", types);
 }
-await cmd("vitest --globals --no-file-parallelism --coverage", [
+await cmd("vitest --globals --no-file-parallelism", [
   ...(!process.argv.slice(2).includes("-w") &&
   !process.argv.slice(2).includes("--watch")
     ? ["--run"]

package/package.json

@@ -9,20 +9,21 @@
   },
   "dependencies": {
     "@anatine/zod-openapi": "^2.2.3",
-    "@asteasolutions/zod-to-openapi": "^6.3.1",
-    "@cloudflare/workers-types": "^4.20240208.0",
-    "@sentry/cli": "^2.28.6",
-    "@typescript-eslint/eslint-plugin": "^7.0.1",
-    "@typescript-eslint/parser": "^7.0.1",
-    "@vitest/coverage-v8": "^1.2.2",
+    "@asteasolutions/zod-to-openapi": "^6.4.0",
+    "@cloudflare/workers-types": "^4.20240222.0",
+    "@sentry/cli": "^2.30.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "@vitest/coverage-v8": "^1.3.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-two-stroke": "^1.0.0",
     "eslint-config-typescript": "^3.0.0",
+    "jose": "^5.2.3",
     "jwk-subtle": "^1.0.6",
-    "miniflare": "^3.20240129.1",
-    "openapi-fetch": "^0.9.0",
+    "miniflare": "^3.20240223.1",
+    "openapi-fetch": "^0.9.3",
     "openapi-typescript": "^6.7.4",
-    "openapi3-ts": "^4.2.1",
+    "openapi3-ts": "^4.2.2",
     "pbkdf-subtle": "^1.0.0",
     "toml": "^3.0.0",
     "toucan-js": "^3.3.1",
@@ -50,13 +51,13 @@
   "name": "two-stroke",
   "packageManager": "yarn@4.1.0",
   "type": "module",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "devDependencies": {
-    "@types/eslint": "^8.56.2",
-    "@types/node": "^20.11.17",
-    "eslint": "^8.56.0",
+    "@types/eslint": "^8.56.5",
+    "@types/node": "^20.11.25",
+    "eslint": "^8.57.0",
     "prettier": "^3.2.5",
-    "typescript": "^5.3.3",
-    "vitest": "^1.2.2"
+    "typescript": "^5.4.2",
+    "vitest": "^1.3.1"
   }
 }

package/src/index.ts

@@ -16,12 +16,13 @@ export function twoStroke<T extends Env>(title: string, release: string) {
     env: T;
     sentry: Toucan;
   }) => Promise<void>;
-  const routes: Route<T>[] = [];
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const routes: Route<T, any>[] = [];
   routes.push({
     auth: noAuth,
     method: "GET",
-    path: "/doc/",
-    matcher: /^\/doc\/$/,
+    path: "/doc",
+    matcher: /^\/doc$/,
     output: z.object({}),
     handler: openAPI(title, release, noAuth, routes),
   });
@@ -53,6 +54,17 @@ export function twoStroke<T extends Env>(title: string, release: string) {
         release,
       });
       try {
+        if (req.method == "OPTIONS") {
+          return new Response("", {
+            status: 204,
+            headers: {
+              "Access-Control-Allow-Origin": "*",
+              "Access-Control-Max-Age": "86400",
+              "Access-Control-Allow-Methods": "GET,PUT,POST,DELETE",
+              "Access-Control-Allow-Headers": "Authorization,Content-Type",
+            },
+          });
+        }
         const { pathname } = new URL(req.url);
         let response;
         for (const route of routes) {
@@ -68,6 +80,7 @@ export function twoStroke<T extends Env>(title: string, release: string) {
                 statusText: "Invalid Authorization",
                 headers: {
                   "WWW-Authenticate": "Bearer",
+                  "Access-Control-Allow-Origin": "*",
                 },
               });
             }
@@ -94,9 +107,18 @@ export function twoStroke<T extends Env>(title: string, release: string) {
                   error: body.error,
                   body: rawBody,
                 });
-                return new Response(JSON.stringify(body.error), {
-                  status: 400,
-                });
+                return new Response(
+                  JSON.stringify({
+                    error: "Request body schema invalid",
+                    ...body.error,
+                  }),
+                  {
+                    status: 400,
+                    headers: {
+                      "Access-Control-Allow-Origin": "*",
+                    },
+                  },
+                );
               }
             } else {
               response = await route.handler({
@@ -109,17 +131,21 @@ export function twoStroke<T extends Env>(title: string, release: string) {
                 sentry,
               });
             }
-            const output = route.output.safeParse(response.body);
-            if (!output.success) {
-              console.error({
-                message: "Response body schema invalid",
-                error: output.error,
-                body: response.body,
-              });
+            if (response.status === undefined || response.status == 200) {
+              const output = route.output.safeParse(response.body);
+              if (!output.success) {
+                console.error({
+                  message: "Response body schema invalid",
+                  error: output.error,
+                  body: response.body,
+                });
+              }
             }
             response.headers = response.headers ?? {};
             response.headers["Content-Type"] =
               response.headers["Content-Type"] ?? "application/json";
+            response.headers["Access-Control-Allow-Origin"] =
+              response.headers["Access-Control-Allow-Origin"] ?? "*";
             return new Response(
               response.headers["Content-Type"] == "application/json"
                 ? JSON.stringify(response.body)
@@ -128,13 +154,17 @@ export function twoStroke<T extends Env>(title: string, release: string) {
             );
           }
         }
-        return new Response("", { status: 404 });
+        return new Response("", {
+          status: 404,
+          headers: { "Access-Control-Allow-Origin": "*" },
+        });
       } catch (err) {
         console.warn(err);
         sentry.captureException(err);
         return new Response("", {
           status: 500,
           statusText: "Internal Server Error",
+          headers: { "Access-Control-Allow-Origin": "*" },
         });
       }
     },
@@ -258,7 +288,7 @@ export function twoStroke<T extends Env>(title: string, release: string) {
       };
     },
     put<I extends ZodSchema, O extends ZodSchema, A, P extends string>(
-      auth: Route<T>["auth"],
+      auth: Route<T, A>["auth"],
       path: P,
       input: I,
       output: O,
@@ -285,7 +315,7 @@ export function twoStroke<T extends Env>(title: string, release: string) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       PP extends ZodObject<any> | undefined,
     >(
-      auth: Route<T>["auth"],
+      auth: Route<T, A>["auth"],
       path: P,
       input: I,
       output: O,
@@ -313,7 +343,7 @@ export function twoStroke<T extends Env>(title: string, release: string) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       PP extends ZodObject<any> | undefined,
     >(
-      auth: Route<T>["auth"],
+      auth: Route<T, A>["auth"],
       path: P,
       output: O,
       handler: Handler<T, undefined, O, A, P>,
@@ -332,7 +362,7 @@ export function twoStroke<T extends Env>(title: string, release: string) {
       });
     },
     delete<O extends ZodSchema, A, P extends string>(
-      auth: Route<T>["auth"],
+      auth: Route<T, A>["auth"],
       path: P,
       output: O,
       handler: Handler<T, undefined, O, A, P>,

package/src/openAPI.ts

@@ -7,6 +7,7 @@ import { Env, Route } from "./types";
 import { ZodIssue, ZodType, z } from "zod";
 
 const ZodErrorSchema: ZodType<{ issues: ZodIssue[] }> = z.object({
+  error: z.string(),
   issues: z.array(
     z.object({
       code: z.literal("invalid_literal"),
@@ -31,11 +32,11 @@ type Method =
 extendZodWithOpenApi(z);
 
 export const openAPI =
-  <T extends Env>(
+  <T extends Env, A>(
     title: string,
     release: string,
-    noAuth: () => void,
-    routes: Route<T>[],
+    noAuth: () => A,
+    routes: Route<T, A>[],
   ) =>
   async () => {
     const openAPIRegistry = new OpenAPIRegistry();
@@ -88,6 +89,16 @@ export const openAPI =
               },
             },
           },
+          500: {
+            description: "Invalid Request",
+            content: {
+              "application/json": {
+                schema: z.object({
+                  error: z.string(),
+                }),
+              },
+            },
+          },
         },
       });
     });

package/src/test.ts

@@ -5,6 +5,7 @@ import { Env } from "./types";
 import consumers from "stream/consumers";
 import { URLSearchParams } from "url";
 import createClient from "openapi-fetch";
+import { generateKeyPair, SignJWT, JWTPayload, exportJWK } from "jose";
 
 // eslint-disable-next-line @typescript-eslint/ban-types
 export const setupTests = async <Paths extends {}>(bindings: Env) => {
@@ -41,6 +42,14 @@ export const setupTests = async <Paths extends {}>(bindings: Env) => {
     d1Databases: (config.d1_databases ?? []).map(
       ({ binding }: { binding: string }) => binding,
     ),
+    serviceBindings: Object.fromEntries(
+      (config.services ?? []).map(
+        ({ binding, service }: { binding: string; service: string }) => [
+          binding,
+          service,
+        ],
+      ),
+    ),
     fetchMock,
   });
 
@@ -65,6 +74,50 @@ export const setupTests = async <Paths extends {}>(bindings: Env) => {
       await waitUntil(() => expect(log).contains("Queue batch finished"));
       console.log = orig;
     },
+    async fakeJWK(issuer: string, audience: string, claims: JWTPayload) {
+      const { publicKey, privateKey } = await generateKeyPair("RS256");
+      const jwk = await exportJWK(publicKey);
+      jwk.kid = "test";
+      jwk.alg = "RS256";
+      fetchMock
+        .get(bindings[issuer] as string)
+        .intercept({ method: "GET", path: "/.well-known/openid-configuration" })
+        .reply(
+          200,
+          {
+            jwks_uri: `${bindings[issuer]}/.well-known/jwks`,
+          },
+          {
+            headers: {
+              "Content-Type": "application/json",
+            },
+          },
+        )
+        .persist();
+      fetchMock
+        .get(bindings[issuer] as string)
+        .intercept({ method: "GET", path: "/.well-known/jwks" })
+        .reply(
+          200,
+          {
+            keys: [jwk],
+          },
+          {
+            headers: {
+              "Content-Type": "application/json",
+            },
+          },
+        )
+        .persist();
+      return await new SignJWT(claims)
+        .setProtectedHeader({ typ: "JWT", alg: "RS256", kid: jwk.kid })
+        .setIssuedAt()
+        .setNotBefore("5 minutes ago")
+        .setIssuer(bindings[issuer] as string)
+        .setAudience([bindings[audience] as string])
+        .setExpirationTime("1h")
+        .sign(privateKey);
+    },
   };
 };
 
@@ -83,11 +136,14 @@ export function recordRequest(
   cb: (data: any) => void,
   statusCode: number,
   data: string | object | Buffer | undefined,
+  responseOptions?: {
+    headers: Record<string, string | string[] | undefined>;
+  },
 ) {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return ({ body }: any) => {
     consumers.json(body).then(cb);
-    return { statusCode, data };
+    return { statusCode, data, responseOptions };
   };
 }
 
@@ -96,6 +152,9 @@ export function recordFormRequest(
   cb: (data: any) => void,
   statusCode: number,
   data: string | object | Buffer | undefined,
+  responseOptions?: {
+    headers: Record<string, string | string[] | undefined>;
+  },
 ) {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return ({ body }: any) => {
@@ -105,7 +164,7 @@ export function recordFormRequest(
       .then((data: any) =>
         cb(Object.fromEntries(new URLSearchParams(data).entries())),
       );
-    return { statusCode, data };
+    return { statusCode, data, responseOptions };
   };
 }
 
@@ -114,6 +173,9 @@ export function recordFirehoseRequest(
   cb: (data: any) => void,
   statusCode: number,
   data: string | object | Buffer | undefined,
+  responseOptions?: {
+    headers: Record<string, string | string[] | undefined>;
+  },
 ) {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return ({ body }: any) => {
@@ -121,6 +183,6 @@ export function recordFirehoseRequest(
       .json(body)
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       .then((data: any) => cb(JSON.parse(atob(data["Record"]["Data"]))));
-    return { statusCode, data };
+    return { statusCode, data, responseOptions };
   };
 }

package/src/types.ts

@@ -1,29 +1,29 @@
 import { Toucan } from "toucan-js";
 import { ZodObject, ZodSchema, z } from "zod";
 export type Env = {
-  [k: string]: string | Queue | KVNamespace | R2Bucket | D1Database;
+  [k: string]: string | Queue | KVNamespace | R2Bucket | D1Database | Fetcher | Hyperdrive;
 };
-export type Route<T extends Env> =
+export type Route<T extends Env, A> =
   | {
-      auth: (c: { req: Request; env: T }) => unknown;
+      auth: (c: { req: Request; env: T }) => Promise<A>;
       method: "GET" | "DELETE";
       path: string;
       matcher: RegExp;
       output: ZodSchema;
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      handler: Handler<T, undefined, any, any, string>;
+      handler: Handler<T, undefined, any, A, string>;
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       params?: ZodObject<any>;
     }
   | {
-      auth: (c: { req: Request; env: T }) => unknown;
+      auth: (c: { req: Request; env: T }) => Promise<A>;
       method: "POST" | "PUT";
       path: string;
       matcher: RegExp;
       input: ZodSchema;
       output: ZodSchema;
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      handler: Handler<T, any, any, any, string>;
+      handler: Handler<T, any, any, A, string>;
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       params?: ZodObject<any>;
     };
@@ -47,8 +47,15 @@ export type Handler<
   searchParams: URLSearchParams;
   claims: A;
   sentry: Toucan;
-}) => Promise<{
-  body: z.infer<O>;
-  status?: number;
-  headers?: Record<string, string>;
-}>;
+}) => Promise<
+  | {
+      body: z.infer<O>;
+      status?: 200;
+      headers?: Record<string, string>;
+    }
+  | {
+      body?: { error: string };
+      status: number;
+      headers?: Record<string, string>;
+    }
+>;

package/tsconfig.json

@@ -2,9 +2,7 @@
   "compilerOptions": {
     "esModuleInterop": true,
     "isolatedModules": true,
-    "lib": [
-      "ESNext"
-    ],
+    "lib": ["ESNext"],
     "module": "ESNext",
     "moduleResolution": "bundler",
     "noUncheckedIndexedAccess": true,
@@ -12,9 +10,6 @@
     "skipLibCheck": true,
     "strict": true,
     "target": "ESNext",
-    "types": [
-      "@cloudflare/workers-types",
-      "vitest/globals"
-    ]
+    "types": ["@cloudflare/workers-types", "vitest/globals"]
   }
-}
+}