@elysiajs/openapi 1.4.0-exp.0 → 1.4.1

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import type { ElysiaOpenAPIConfig, OpenAPIProvider } from './types';
  *
  * @see https://github.com/elysiajs/elysia-swagger
  */
-export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi", const Provider extends OpenAPIProvider = "scalar">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references }?: ElysiaOpenAPIConfig<Enabled, Path, Provider>) => Elysia<"", {
+export declare const openapi: <const Enabled extends boolean = true, const Path extends string = "/openapi", const Provider extends OpenAPIProvider = "scalar">({ enabled, path, provider, specPath, documentation, exclude, swagger, scalar, references, mapJsonSchema }?: ElysiaOpenAPIConfig<Enabled, Path, Provider>) => Elysia<"", {
     decorator: {};
     store: {};
     derive: {};

package/dist/index.mjs

@@ -268,7 +268,6 @@ var Hint = Symbol.for("TypeBox.Hint");
 var Kind = Symbol.for("TypeBox.Kind");
 
 // src/openapi.ts
-import { toJsonSchema } from "xsschema";
 var capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 var toRef = (name) => t.Ref(`#/components/schemas/${name}`);
 var toOperationId = (method, paths) => {
@@ -297,14 +296,21 @@ var getLoosePath = (path) => {
     return path.slice(0, path.length - 1);
   return path + "/";
 };
-var unwrapSchema = (schema) => {
+var unwrapSchema = (schema, mapJsonSchema) => {
   if (!schema) return;
   if (typeof schema === "string") schema = toRef(schema);
   if (Kind in schema) return schema;
-  if (Kind in schema === false && schema["~standard"])
-    return toJsonSchema(schema);
+  if (Kind in schema || !schema?.["~standard"]) return;
+  const vendor = schema["~standard"].vendor;
+  if (mapJsonSchema?.[vendor] && typeof mapJsonSchema[vendor] === "function")
+    return mapJsonSchema[vendor](schema);
+  if (vendor === "zod" || vendor === "sury")
+    return schema.toJSONSchema?.();
+  if (vendor === "arktype")
+    return schema?.toJsonSchema?.();
+  return schema.toJSONSchema?.() ?? schema?.toJsonSchema?.();
 };
-async function toOpenAPISchema(app, exclude, references) {
+function toOpenAPISchema(app, exclude, references, vendors) {
   const {
     methods: excludeMethods = ["OPTIONS"],
     staticFile: excludeStaticFile = true,
@@ -357,8 +363,7 @@ async function toOpenAPISchema(app, exclude, references) {
     };
     const parameters = [];
     if (hooks.params) {
-      let params = unwrapSchema(hooks.params);
-      if (params) params = await params;
+      const params = unwrapSchema(hooks.params, vendors);
       if (params && params.type === "object" && params.properties)
         for (const [paramName, paramSchema] of Object.entries(
           params.properties
@@ -372,8 +377,7 @@ async function toOpenAPISchema(app, exclude, references) {
           });
     }
     if (hooks.query) {
-      let query = unwrapSchema(hooks.query);
-      if (query) query = await query;
+      let query = unwrapSchema(hooks.query, vendors);
       if (query && query.type === "object" && query.properties) {
         const required = query.required || [];
         for (const [queryName, querySchema] of Object.entries(
@@ -388,8 +392,7 @@ async function toOpenAPISchema(app, exclude, references) {
       }
     }
     if (hooks.headers) {
-      let headers = unwrapSchema(hooks.query);
-      if (headers) headers = await headers;
+      const headers = unwrapSchema(hooks.query, vendors);
       if (headers && headers.type === "object" && headers.properties) {
         const required = headers.required || [];
         for (const [headerName, headerSchema] of Object.entries(
@@ -404,8 +407,7 @@ async function toOpenAPISchema(app, exclude, references) {
       }
     }
     if (hooks.cookie) {
-      let cookie = unwrapSchema(hooks.cookie);
-      if (cookie) cookie = await cookie;
+      const cookie = unwrapSchema(hooks.cookie, vendors);
       if (cookie && cookie.type === "object" && cookie.properties) {
         const required = cookie.required || [];
         for (const [cookieName, cookieSchema] of Object.entries(
@@ -421,8 +423,7 @@ async function toOpenAPISchema(app, exclude, references) {
     }
     if (parameters.length > 0) operation.parameters = parameters;
     if (hooks.body && method !== "get" && method !== "head") {
-      let body = unwrapSchema(hooks.body);
-      if (body) body = await body;
+      const body = unwrapSchema(hooks.body, vendors);
       if (body) {
         const { type: _type, description, ...options } = body;
         const type = _type;
@@ -484,8 +485,7 @@ async function toOpenAPISchema(app, exclude, references) {
       operation.responses = {};
       if (typeof hooks.response === "object" && !hooks.response.type && !hooks.response.$ref) {
         for (let [status, schema] of Object.entries(hooks.response)) {
-          let response = unwrapSchema(schema);
-          if (response) response = await response;
+          const response = unwrapSchema(schema, vendors);
           if (!response) continue;
           const { type: _type, description, ...options } = response;
           const type = _type;
@@ -504,8 +504,7 @@ async function toOpenAPISchema(app, exclude, references) {
           };
         }
       } else {
-        let response = unwrapSchema(hooks.response);
-        if (response) response = await response;
+        const response = unwrapSchema(hooks.response, vendors);
         if (response) {
           const { type: _type, description, ...options } = response;
           const type = _type;
@@ -556,8 +555,7 @@ async function toOpenAPISchema(app, exclude, references) {
   const schemas = /* @__PURE__ */ Object.create(null);
   if (_schemas)
     for (const [name, schema] of Object.entries(_schemas)) {
-      let jsonSchema = unwrapSchema(schema);
-      if (jsonSchema instanceof Promise) jsonSchema = await jsonSchema;
+      const jsonSchema = unwrapSchema(schema, vendors);
       if (jsonSchema) schemas[name] = jsonSchema;
     }
   return {
@@ -581,7 +579,8 @@ var openapi = ({
   exclude,
   swagger,
   scalar,
-  references
+  references,
+  mapJsonSchema
 } = {}) => {
   if (!enabled) return new Elysia({ name: "@elysiajs/openapi" });
   const info = {
@@ -625,13 +624,13 @@ var openapi = ({
     );
   }).get(
     specPath,
-    async function openAPISchema() {
+    function openAPISchema() {
       if (totalRoutes === app.routes.length) return cachedSchema;
       totalRoutes = app.routes.length;
       const {
         paths,
         components: { schemas }
-      } = await toOpenAPISchema(app, exclude, references);
+      } = toOpenAPISchema(app, exclude, references, mapJsonSchema);
       return cachedSchema = {
         openapi: "3.0.3",
         ...documentation,

package/dist/openapi.d.ts

@@ -1,7 +1,7 @@
 import { type AnyElysia, type TSchema, type InputSchema } from 'elysia';
 import type { OpenAPIV3 } from 'openapi-types';
 import { type TProperties } from '@sinclair/typebox';
-import type { AdditionalReferences, ElysiaOpenAPIConfig } from './types';
+import type { AdditionalReferences, ElysiaOpenAPIConfig, MapJsonSchema } from './types';
 export declare const capitalize: (word: string) => string;
 /**
  * Get all possible paths of a path with optional parameters
@@ -10,20 +10,18 @@ export declare const capitalize: (word: string) => string;
  */
 export declare const getPossiblePath: (path: string) => string[];
 export declare const getLoosePath: (path: string) => string;
-type MaybePromise<T> = T | Promise<T>;
-export declare const unwrapSchema: (schema: InputSchema["body"]) => MaybePromise<OpenAPIV3.SchemaObject | undefined>;
+export declare const unwrapSchema: (schema: InputSchema["body"], mapJsonSchema?: MapJsonSchema) => OpenAPIV3.SchemaObject | undefined;
 /**
  * Converts Elysia routes to OpenAPI 3.0.3 paths schema
  * @param routes Array of Elysia route objects
  * @returns OpenAPI paths object
  */
-export declare function toOpenAPISchema(app: AnyElysia, exclude?: ElysiaOpenAPIConfig['exclude'], references?: AdditionalReferences): Promise<{
+export declare function toOpenAPISchema(app: AnyElysia, exclude?: ElysiaOpenAPIConfig['exclude'], references?: AdditionalReferences, vendors?: MapJsonSchema): {
     components: {
         schemas: any;
     };
     paths: OpenAPIV3.PathsObject<{}, {}>;
-}>;
+};
 export declare const withHeaders: (schema: TSchema, headers: TProperties) => TSchema & {
     headers: TProperties;
 };
-export {};

package/dist/openapi.mjs

@@ -9,7 +9,6 @@ var Hint = Symbol.for("TypeBox.Hint");
 var Kind = Symbol.for("TypeBox.Kind");
 
 // src/openapi.ts
-import { toJsonSchema } from "xsschema";
 var capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 var toRef = (name) => t.Ref(`#/components/schemas/${name}`);
 var toOperationId = (method, paths) => {
@@ -38,14 +37,21 @@ var getLoosePath = (path) => {
     return path.slice(0, path.length - 1);
   return path + "/";
 };
-var unwrapSchema = (schema) => {
+var unwrapSchema = (schema, mapJsonSchema) => {
   if (!schema) return;
   if (typeof schema === "string") schema = toRef(schema);
   if (Kind in schema) return schema;
-  if (Kind in schema === false && schema["~standard"])
-    return toJsonSchema(schema);
+  if (Kind in schema || !schema?.["~standard"]) return;
+  const vendor = schema["~standard"].vendor;
+  if (mapJsonSchema?.[vendor] && typeof mapJsonSchema[vendor] === "function")
+    return mapJsonSchema[vendor](schema);
+  if (vendor === "zod" || vendor === "sury")
+    return schema.toJSONSchema?.();
+  if (vendor === "arktype")
+    return schema?.toJsonSchema?.();
+  return schema.toJSONSchema?.() ?? schema?.toJsonSchema?.();
 };
-async function toOpenAPISchema(app, exclude, references) {
+function toOpenAPISchema(app, exclude, references, vendors) {
   const {
     methods: excludeMethods = ["OPTIONS"],
     staticFile: excludeStaticFile = true,
@@ -98,8 +104,7 @@ async function toOpenAPISchema(app, exclude, references) {
     };
     const parameters = [];
     if (hooks.params) {
-      let params = unwrapSchema(hooks.params);
-      if (params) params = await params;
+      const params = unwrapSchema(hooks.params, vendors);
       if (params && params.type === "object" && params.properties)
         for (const [paramName, paramSchema] of Object.entries(
           params.properties
@@ -113,8 +118,7 @@ async function toOpenAPISchema(app, exclude, references) {
           });
     }
     if (hooks.query) {
-      let query = unwrapSchema(hooks.query);
-      if (query) query = await query;
+      let query = unwrapSchema(hooks.query, vendors);
       if (query && query.type === "object" && query.properties) {
         const required = query.required || [];
         for (const [queryName, querySchema] of Object.entries(
@@ -129,8 +133,7 @@ async function toOpenAPISchema(app, exclude, references) {
       }
     }
     if (hooks.headers) {
-      let headers = unwrapSchema(hooks.query);
-      if (headers) headers = await headers;
+      const headers = unwrapSchema(hooks.query, vendors);
       if (headers && headers.type === "object" && headers.properties) {
         const required = headers.required || [];
         for (const [headerName, headerSchema] of Object.entries(
@@ -145,8 +148,7 @@ async function toOpenAPISchema(app, exclude, references) {
       }
     }
     if (hooks.cookie) {
-      let cookie = unwrapSchema(hooks.cookie);
-      if (cookie) cookie = await cookie;
+      const cookie = unwrapSchema(hooks.cookie, vendors);
       if (cookie && cookie.type === "object" && cookie.properties) {
         const required = cookie.required || [];
         for (const [cookieName, cookieSchema] of Object.entries(
@@ -162,8 +164,7 @@ async function toOpenAPISchema(app, exclude, references) {
     }
     if (parameters.length > 0) operation.parameters = parameters;
     if (hooks.body && method !== "get" && method !== "head") {
-      let body = unwrapSchema(hooks.body);
-      if (body) body = await body;
+      const body = unwrapSchema(hooks.body, vendors);
       if (body) {
         const { type: _type, description, ...options } = body;
         const type = _type;
@@ -225,8 +226,7 @@ async function toOpenAPISchema(app, exclude, references) {
       operation.responses = {};
       if (typeof hooks.response === "object" && !hooks.response.type && !hooks.response.$ref) {
         for (let [status, schema] of Object.entries(hooks.response)) {
-          let response = unwrapSchema(schema);
-          if (response) response = await response;
+          const response = unwrapSchema(schema, vendors);
           if (!response) continue;
           const { type: _type, description, ...options } = response;
           const type = _type;
@@ -245,8 +245,7 @@ async function toOpenAPISchema(app, exclude, references) {
           };
         }
       } else {
-        let response = unwrapSchema(hooks.response);
-        if (response) response = await response;
+        const response = unwrapSchema(hooks.response, vendors);
         if (response) {
           const { type: _type, description, ...options } = response;
           const type = _type;
@@ -297,8 +296,7 @@ async function toOpenAPISchema(app, exclude, references) {
   const schemas = /* @__PURE__ */ Object.create(null);
   if (_schemas)
     for (const [name, schema] of Object.entries(_schemas)) {
-      let jsonSchema = unwrapSchema(schema);
-      if (jsonSchema instanceof Promise) jsonSchema = await jsonSchema;
+      const jsonSchema = unwrapSchema(schema, vendors);
       if (jsonSchema) schemas[name] = jsonSchema;
     }
   return {

package/dist/types.d.ts

@@ -4,6 +4,9 @@ import type { ApiReferenceConfiguration } from '@scalar/types';
 import type { SwaggerUIOptions } from './swagger/types';
 export type OpenAPIProvider = 'scalar' | 'swagger-ui' | null;
 type MaybeArray<T> = T | T[];
+export type MapJsonSchema = {
+    [vendor: string]: Function;
+};
 export type AdditionalReference = {
     [path in string]: {
         [method in string]: {
@@ -69,6 +72,21 @@ export interface ElysiaOpenAPIConfig<Enabled extends boolean = true, Path extend
      * Additional reference for each endpoint
      */
     references?: AdditionalReferences;
+    /**
+     * Mapping function from Standard schema to OpenAPI schema
+     *
+     * @example
+     * ```ts
+     * import { openapi } from '@elysiajs/openapi'
+     * import { toJsonSchema } from '@valibot/to-json-schema'
+     *
+     * openapi({
+     * 	vendors: {
+     * 	  valibot: toJsonSchema
+     *   }
+     * })
+     */
+    mapJsonSchema?: MapJsonSchema;
     /**
      * Scalar configuration to customize scalar
      *'

package/package.json

@@ -1,96 +1,94 @@
 {
-	"name": "@elysiajs/openapi",
-	"version": "1.4.0-exp.0",
-	"description": "Plugin for Elysia to auto-generate API documentation",
-	"author": {
-		"name": "saltyAom",
-		"url": "https://github.com/SaltyAom",
-		"email": "saltyaom@gmail.com"
-	},
-	"main": "./dist/cjs/index.js",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		"./package.json": "./package.json",
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.mjs",
-			"require": "./dist/cjs/index.js"
-		},
-		"./gen": {
-			"types": "./dist/gen/index.d.ts",
-			"import": "./dist/gen/index.mjs",
-			"require": "./dist/cjs/gen/index.js"
-		},
-		"./openapi": {
-			"types": "./dist/openapi.d.ts",
-			"import": "./dist/openapi.mjs",
-			"require": "./dist/cjs/openapi.js"
-		},
-		"./scalar": {
-			"types": "./dist/scalar/index.d.ts",
-			"import": "./dist/scalar/index.mjs",
-			"require": "./dist/cjs/scalar/index.js"
-		},
-		"./scalar/theme": {
-			"types": "./dist/scalar/theme.d.ts",
-			"import": "./dist/scalar/theme.mjs",
-			"require": "./dist/cjs/scalar/theme.js"
-		},
-		"./swagger": {
-			"types": "./dist/swagger/index.d.ts",
-			"import": "./dist/swagger/index.mjs",
-			"require": "./dist/cjs/swagger/index.js"
-		},
-		"./swagger/types": {
-			"types": "./dist/swagger/types.d.ts",
-			"import": "./dist/swagger/types.mjs",
-			"require": "./dist/cjs/swagger/types.js"
-		},
-		"./types": {
-			"types": "./dist/types.d.ts",
-			"import": "./dist/types.mjs",
-			"require": "./dist/cjs/types.js"
-		}
-	},
-	"keywords": [
-		"elysia",
-		"openapi",
-		"swagger",
-		"scalar"
-	],
-	"homepage": "https://github.com/elysiajs/elysia-openapi",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/elysiajs/elysia-openapi"
-	},
-	"bugs": "https://github.com/elysiajs/elysia-openapi/issues",
-	"license": "MIT",
-	"scripts": {
-		"dev": "bun run --watch example/index.ts",
-		"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": "bun build.ts",
-		"release": "npm run build && npm run test && npm publish --access public"
-	},
-	"dependencies": {},
-	"devDependencies": {
-		"@sinclair/typemap": "^0.10.1",
-		"@apidevtools/swagger-parser": "^12.0.0",
-		"@scalar/types": "^0.2.13",
-		"@types/bun": "1.2.20",
-		"elysia": "1.4.0-exp.16",
-		"eslint": "9.6.0",
-		"openapi-types": "^12.1.3",
-		"tsup": "^8.5.0",
-		"typescript": "^5.9.2",
-		"xsschema": "^0.4.0-beta.3",
-		"zod": "^4.1.5"
-	},
-	"peerDependencies": {
-		"@sinclair/typemap": ">= 0.10.0",
-		"elysia": ">= 1.3.0",
-		"openapi-types": ">= 12.0.0",
-		"xsschema": ">= 0.4.0-beta.0"
-	}
+    "name": "@elysiajs/openapi",
+    "version": "1.4.1",
+    "description": "Plugin for Elysia to auto-generate API documentation",
+    "author": {
+        "name": "saltyAom",
+        "url": "https://github.com/SaltyAom",
+        "email": "saltyaom@gmail.com"
+    },
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs",
+            "require": "./dist/cjs/index.js"
+        },
+        "./gen": {
+            "types": "./dist/gen/index.d.ts",
+            "import": "./dist/gen/index.mjs",
+            "require": "./dist/cjs/gen/index.js"
+        },
+        "./openapi": {
+            "types": "./dist/openapi.d.ts",
+            "import": "./dist/openapi.mjs",
+            "require": "./dist/cjs/openapi.js"
+        },
+        "./scalar": {
+            "types": "./dist/scalar/index.d.ts",
+            "import": "./dist/scalar/index.mjs",
+            "require": "./dist/cjs/scalar/index.js"
+        },
+        "./scalar/theme": {
+            "types": "./dist/scalar/theme.d.ts",
+            "import": "./dist/scalar/theme.mjs",
+            "require": "./dist/cjs/scalar/theme.js"
+        },
+        "./swagger": {
+            "types": "./dist/swagger/index.d.ts",
+            "import": "./dist/swagger/index.mjs",
+            "require": "./dist/cjs/swagger/index.js"
+        },
+        "./swagger/types": {
+            "types": "./dist/swagger/types.d.ts",
+            "import": "./dist/swagger/types.mjs",
+            "require": "./dist/cjs/swagger/types.js"
+        },
+        "./types": {
+            "types": "./dist/types.d.ts",
+            "import": "./dist/types.mjs",
+            "require": "./dist/cjs/types.js"
+        }
+    },
+    "keywords": [
+        "elysia",
+        "openapi",
+        "swagger",
+        "scalar"
+    ],
+    "homepage": "https://github.com/elysiajs/elysia-openapi",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/elysiajs/elysia-openapi"
+    },
+    "bugs": "https://github.com/elysiajs/elysia-openapi/issues",
+    "license": "MIT",
+    "scripts": {
+        "dev": "bun run --watch example/index.ts",
+        "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": "bun build.ts",
+        "release": "npm run build && npm run test && npm publish --access public"
+    },
+    "dependencies": {},
+    "devDependencies": {
+        "@apidevtools/swagger-parser": "^12.0.0",
+        "@scalar/types": "^0.2.13",
+        "@sinclair/typemap": "^0.10.1",
+        "@types/bun": "1.2.20",
+        "elysia": "1.4.0",
+        "eslint": "9.6.0",
+        "openapi-types": "^12.1.3",
+        "tsup": "^8.5.0",
+        "typescript": "^5.9.2",
+        "xsschema": "^0.4.0-beta.3",
+        "zod": "^4.1.5"
+    },
+    "peerDependencies": {
+        "elysia": ">= 1.4.0",
+        "xsschema": ">= 0.4.0-beta.0"
+    }
 }