Simplify OpenAPI

Author: mpppk

examples/misc/express/valibot/openapi/index.ts

@@ -2,8 +2,7 @@ import express from "express";
 import * as v from "valibot";
 import cors from "cors";
 import { OpenAPIV3_1 } from "openapi-types";
-import { ValibotOpenApiEndpoints } from "@notainc/typed-api-spec/valibot/openapi";
-import { toOpenApiDoc } from "@notainc/typed-api-spec/valibot";
+import { SSOpenApiEndpoints, toOpenApiDoc } from "@notainc/typed-api-spec/core";
 
 const openapiBaseDoc: Omit<OpenAPIV3_1.Document, "paths"> = {
   openapi: "3.1.0",
@@ -45,7 +44,7 @@ const apiEndpoints = {
       },
     },
   },
-} satisfies ValibotOpenApiEndpoints;
+} satisfies SSOpenApiEndpoints;
 
 const newApp = () => {
   const app = express();

examples/misc/express/zod/openapi/index.ts

@@ -3,8 +3,7 @@ import cors from "cors";
 import { OpenAPIV3_1 } from "openapi-types";
 import "zod-openapi/extend";
 import z from "zod";
-import { toOpenApiDoc } from "@notainc/typed-api-spec/zod/openapi";
-import { ZodOpenApiEndpoints } from "@notainc/typed-api-spec/zod/openapi";
+import { SSOpenApiEndpoints, toOpenApiDoc } from "@notainc/typed-api-spec/core";
 
 const openapiBaseDoc: Omit<OpenAPIV3_1.Document, "paths"> = {
   openapi: "3.1.0",
@@ -48,15 +47,15 @@ const apiEndpoints = {
       },
     },
   },
-} satisfies ZodOpenApiEndpoints;
+} satisfies SSOpenApiEndpoints;
 
 const newApp = () => {
   const app = express();
   app.use(express.json());
   app.use(cors());
   // const wApp = asAsync(typed(apiEndpoints, app));
-  app.get("/openapi", (req, res) => {
-    const openapi = toOpenApiDoc(openapiBaseDoc, apiEndpoints);
+  app.get("/openapi", async (req, res) => {
+    const openapi = await toOpenApiDoc(openapiBaseDoc, apiEndpoints);
     res.status(200).json(openapi);
   });
   return app;

examples/misc/simple/withValidation.ts

@@ -1,7 +1,7 @@
 import { withValidation } from "@notainc/typed-api-spec/fetch";
 import { z } from "zod";
 import { SpecValidatorError } from "@notainc/typed-api-spec/fetch";
-import { newSSValidator, SSApiEndpoints } from "@notainc/typed-api-spec/ss";
+import { SSApiEndpoints } from "@notainc/typed-api-spec/ss";
 
 const GITHUB_API_ORIGIN = "https://api.github.com";
 
@@ -25,11 +25,10 @@ const spec2 = {
 const main = async () => {
   {
     // const fetchT = fetch as FetchT<typeof GITHUB_API_ORIGIN, Spec>;
-    const { req: reqValidator, res: resValidator } = newSSValidator(spec);
-    const fetchWithV = withValidation(fetch, spec, reqValidator, resValidator);
+    const fetchWithV = withValidation(fetch, spec);
     const response = await fetchWithV(
       `${GITHUB_API_ORIGIN}/repos/nota/typed-api-spec/topics?page=1`,
-      { headers: { Accept: "application/vnd.github+json" } },
+      { headers: { Accept: "application/vnd.github+json" } }
     );
     if (!response.ok) {
       const { message } = await response.json();
@@ -41,12 +40,11 @@ const main = async () => {
 
   {
     // const fetchT = fetch as FetchT<typeof GITHUB_API_ORIGIN, Spec>;
-    const { req: reqValidator, res: resValidator } = newSSValidator(spec2);
-    const fetchWithV = withValidation(fetch, spec2, reqValidator, resValidator);
+    const fetchWithV = withValidation(fetch, spec2);
     try {
       await fetchWithV(
         `${GITHUB_API_ORIGIN}/repos/nota/typed-api-spec/topics?page=1`,
-        { headers: { Accept: "application/vnd.github+json" } },
+        { headers: { Accept: "application/vnd.github+json" } }
       );
     } catch (e) {
       if (e instanceof SpecValidatorError) {

pkgs/typed-api-spec/package.json

@@ -113,21 +113,11 @@
       "require": "./dist/zod/index.js",
       "import": "./dist/zod/index.mjs"
     },
-    "./zod/openapi": {
-      "types": "./dist/zod/openapi.d.ts",
-      "require": "./dist/zod/openapi.js",
-      "import": "./dist/zod/openapi.mjs"
-    },
     "./valibot": {
       "types": "./dist/valibot/index.d.ts",
       "require": "./dist/valibot/index.js",
       "import": "./dist/valibot/index.mjs"
     },
-    "./valibot/openapi": {
-      "types": "./dist/valibot/openapi.d.ts",
-      "require": "./dist/valibot/openapi.js",
-      "import": "./dist/valibot/openapi.mjs"
-    },
     "./ss": {
       "types": "./dist/ss/index.d.ts",
       "require": "./dist/ss/index.js",

pkgs/typed-api-spec/src/core/jsonschema.ts

@@ -13,56 +13,57 @@ import {
 } from "./spec";
 import { StatusCode } from "./hono-types";
 import { JSONSchema7 } from "json-schema";
+import { StandardSchemaV1 } from "@standard-schema/spec";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ToSchema = (schema: any) => JSONSchema7;
+type ToSchema = (schema: StandardSchemaV1<any>) => Promise<JSONSchema7>;
 
-export const toJsonSchemaApiEndpoints = <E extends AnyApiEndpoints>(
+export const toJsonSchemaApiEndpoints = async <E extends AnyApiEndpoints>(
   toSchema: ToSchema,
   endpoints: E,
-): JsonSchemaApiEndpoints => {
+): Promise<JsonSchemaApiEndpoints> => {
   const ret: JsonSchemaApiEndpoints = {};
   for (const path of Object.keys(endpoints)) {
-    ret[path] = toJsonSchemaEndpoint(toSchema, endpoints[path]);
+    ret[path] = await toJsonSchemaEndpoint(toSchema, endpoints[path]);
   }
   return ret;
 };
 
-export const toJsonSchemaEndpoint = <Endpoint extends AnyApiEndpoint>(
+export const toJsonSchemaEndpoint = async <Endpoint extends AnyApiEndpoint>(
   toSchema: ToSchema,
   endpoint: Endpoint,
-) => {
+): Promise<Partial<Record<Method, JsonSchemaApiSpec>>> => {
   const ret: Partial<Record<Method, JsonSchemaApiSpec>> = {};
   for (const method of Method) {
     const spec = endpoint[method];
     if (spec) {
-      ret[method] = toJsonSchemaApiSpec(toSchema, spec);
+      ret[method] = await toJsonSchemaApiSpec(toSchema, spec);
     }
   }
   return ret;
 };
 
-export const toJsonSchemaApiSpec = <Spec extends AnyApiSpec>(
+export const toJsonSchemaApiSpec = async <Spec extends AnyApiSpec>(
   toSchema: ToSchema,
   spec: Spec,
-): JsonSchemaApiSpec => {
+): Promise<JsonSchemaApiSpec> => {
   const extraProps = extractExtraApiSpecProps(spec);
   const ret: JsonSchemaApiSpec = {
-    responses: toJsonSchemaResponses(toSchema, spec.responses),
+    responses: await toJsonSchemaResponses(toSchema, spec.responses),
   };
   for (const key of apiSpecRequestKeys) {
     if (spec[key]) {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      ret[key] = toSchema(spec[key]);
+      ret[key] = await toSchema(spec[key]);
     }
   }
   return { ...extraProps, ...ret };
 };
 
-const toJsonSchemaResponses = (
+const toJsonSchemaResponses = async (
   toSchema: ToSchema,
   responses: AnyApiResponses,
-): JsonSchemaApiResponses => {
+): Promise<JsonSchemaApiResponses> => {
   const statusCodes = Object.keys(responses).map(Number) as StatusCode[];
   const ret: JsonSchemaApiResponses = {};
   for (const statusCode of statusCodes) {
@@ -72,8 +73,8 @@ const toJsonSchemaResponses = (
     }
     ret[statusCode] = {
       ...extractExtraResponseProps(r),
-      body: toSchema(r.body),
-      headers: r.headers ? toSchema(r.headers) : undefined,
+      body: await toSchema(r.body),
+      headers: r.headers ? await toSchema(r.headers) : undefined,
     };
   }
   return ret;

pkgs/typed-api-spec/src/core/openapi/openapi.ts

@@ -18,6 +18,7 @@ import {
 } from "./spec";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 import { SSAnyApiResponse } from "../../ss";
+import { toJsonSchemaApiEndpoints } from "../jsonschema";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type AnyStandardSchemaV1 = StandardSchemaV1<any>;
@@ -147,7 +148,7 @@ const toResponses = (
   return ret;
 };
 
-export const toOpenApiDoc = (
+export const jsonSchemaToOpenApiDoc = (
   doc: Omit<OpenAPIV3_1.Document, "paths">,
   endpoints: JsonSchemaOpenApiEndpoints,
 ): OpenAPIV3_1.Document => {
@@ -157,3 +158,29 @@ export const toOpenApiDoc = (
   }
   return { ...doc, paths };
 };
+
+export const toOpenApiDoc = async <E extends SSOpenApiEndpoints>(
+  doc: Omit<OpenAPIV3_1.Document, "paths">,
+  endpoints: E,
+): Promise<OpenAPIV3_1.Document> => {
+  const e = await toJsonSchemaApiEndpoints(toSchema, endpoints);
+  return jsonSchemaToOpenApiDoc(doc, e as JsonSchemaOpenApiEndpoints);
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const toSchema = async (s: StandardSchemaV1<any>) => {
+  switch (s["~standard"].vendor) {
+    case "zod": {
+      const { createSchema } = await import("zod-openapi");
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return createSchema(s as any).schema as JSONSchema7;
+    }
+    case "valibot": {
+      const { toJsonSchema } = await import("@valibot/to-json-schema");
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      return toJsonSchema(s as any);
+    }
+    default:
+      throw new Error(`Unsupported vendor: ${s["~standard"].vendor}`);
+  }
+};

pkgs/typed-api-spec/src/index.ts

@@ -15,7 +15,3 @@ import JSONT, { JSON$stringifyT } from "./json";
 export { JSONT, JSON$stringifyT };
 
 export * from "./zod";
-export {
-  toOpenApiDoc as toZodOpenApiDoc,
-  toJsonSchemaApiEndpoints as toZodJsonSchemaApiEndpoints,
-} from "./zod/openapi";

pkgs/typed-api-spec/src/valibot/index.ts

@@ -1,2 +1 @@
 export * from "./util";
-export * from "./openapi";

pkgs/typed-api-spec/src/valibot/openapi.test.ts

@@ -1,8 +1,7 @@
 import { describe, it, expect } from "vitest";
 import * as v from "valibot";
 import { OpenAPIV3_1 } from "openapi-types";
-import { toOpenApiDoc } from "./openapi";
-import { SSOpenApiEndpoints } from "../core";
+import { SSOpenApiEndpoints, toOpenApiDoc } from "../core";
 
 describe("openapi", () => {
   const endpoints = {
@@ -106,15 +105,15 @@ describe("openapi", () => {
     },
   };
 
-  it("toOpenApiDoc", () => {
+  it("toOpenApiDoc", async () => {
     const baseDoc: Omit<OpenAPIV3_1.Document, "paths"> = {
       openapi: "3.1.0",
       info: { title: "title", version: "1" },
       security: [],
       servers: [],
       components: {},
     };
-    const doc = toOpenApiDoc(baseDoc, endpoints);
+    const doc = await toOpenApiDoc(baseDoc, endpoints);
     expect(doc).toEqual({
       ...baseDoc,
       paths: {

pkgs/typed-api-spec/src/valibot/openapi.ts

@@ -1,10 +1,8 @@
 import { describe, it, expect } from "vitest";
 import { OpenAPIV3_1 } from "openapi-types";
-import { toOpenApiDoc } from "./openapi";
 import "zod-openapi/extend";
 import z from "zod";
-import { SSOpenApiEndpoints } from "../core";
-
+import { SSOpenApiEndpoints, toOpenApiDoc } from "../core";
 describe("openapi", () => {
   const endpoints = {
     "/pets": {
@@ -104,15 +102,15 @@ describe("openapi", () => {
     },
   };
 
-  it("toOpenApiDoc", () => {
+  it("toOpenApiDoc", async () => {
     const baseDoc: Omit<OpenAPIV3_1.Document, "paths"> = {
       openapi: "3.1.0",
       info: { title: "title", version: "1" },
       security: [],
       servers: [],
       components: {},
     };
-    const doc = toOpenApiDoc(baseDoc, endpoints);
+    const doc = await toOpenApiDoc(baseDoc, endpoints);
     expect(doc).toEqual({
       ...baseDoc,
       paths: {