@elysiajs/openapi 1.4.0-exp.0 → 1.4.1

package/dist/cjs/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/cjs/index.js

@@ -295,7 +295,6 @@ var Hint = Symbol.for("TypeBox.Hint");
 var Kind = Symbol.for("TypeBox.Kind");
 
 // src/openapi.ts
-var import_xsschema = require("xsschema");
 var capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 var toRef = (name) => import_elysia.t.Ref(`#/components/schemas/${name}`);
 var toOperationId = (method, paths) => {
@@ -324,14 +323,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 (0, import_xsschema.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,
@@ -384,8 +390,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
@@ -399,8 +404,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(
@@ -415,8 +419,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(
@@ -431,8 +434,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(
@@ -448,8 +450,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;
@@ -511,8 +512,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;
@@ -531,8 +531,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;
@@ -583,8 +582,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 {
@@ -608,7 +606,8 @@ var openapi = ({
   exclude,
   swagger,
   scalar,
-  references
+  references,
+  mapJsonSchema
 } = {}) => {
   if (!enabled) return new import_elysia2.Elysia({ name: "@elysiajs/openapi" });
   const info = {
@@ -652,13 +651,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/cjs/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/cjs/openapi.js

@@ -38,7 +38,6 @@ var Hint = Symbol.for("TypeBox.Hint");
 var Kind = Symbol.for("TypeBox.Kind");
 
 // src/openapi.ts
-var import_xsschema = require("xsschema");
 var capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 var toRef = (name) => import_elysia.t.Ref(`#/components/schemas/${name}`);
 var toOperationId = (method, paths) => {
@@ -67,14 +66,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 (0, import_xsschema.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,
@@ -127,8 +133,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
@@ -142,8 +147,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(
@@ -158,8 +162,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(
@@ -174,8 +177,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(
@@ -191,8 +193,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;
@@ -254,8 +255,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;
@@ -274,8 +274,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;
@@ -326,8 +325,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/cjs/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
      *'