@standard-community/standard-openapi 0.2.0-rc.1 → 0.2.1

package/README.md

@@ -18,7 +18,7 @@ For some specific vendor, install the respective package also -
 
 | Vendor  | Package |
 | ------- | ------- |
-| Zod v3  | `zod-openapi` |
+| Zod v3  | `zod-openapi@4` |
 | Valibot | `@valibot/to-json-schema` |
 
 ## Usage
@@ -39,16 +39,27 @@ const schema = v.pipe(
 const openapiSchema = await toOpenAPISchema(schema);
 ```
 
-## Compatibility
+### Sync Usage
 
-List of supported validators -
+This is useful for -
 
-| Vendor  | Supported |
-| ------- | ------- |
-| Zod     | ✅ |
-| Valibot | ✅ |
-| ArkType | ✅ |
-| Typebox | ✅ (Using [TypeMap](https://github.com/sinclairzx81/typemap) |
-| Effect Schema | 🛠️ |
+1. Adding support for Unsupported validation libs, like Sury
+2. Customize the toOpenAPISchema of a supported lib
+
+```ts
+import { toOpenAPISchema, loadVendor } from "@standard-community/standard-openapi";
+import { convertSchemaToJson } from "your-validation-lib";
+
+// The lib should support Standard Schema
+// as we use 'schema["~standard"].vendor' to get the vendor name
+// Eg. loadVendor(zod["~standard"].vendor, convertorFunction)
+loadVendor("validation-lib-name", convertSchemaToJson)
 
-You can check the compatibility versions at [standardschema.dev](https://standardschema.dev/)
+// Define your validation schema
+const schema = {
+    // ...
+};
+
+// Convert it to OpenAPI Schema
+const openapiSchema = toOpenAPISchema(schema);
+```

package/dist/index-2CxeAJPp.js

@@ -0,0 +1,44 @@
+const errorMessageWrapper = (message) => `standard-openapi: ${message}`;
+const openapiVendorMap = /* @__PURE__ */ new Map();
+
+const getToOpenAPISchemaFn = async (vendor) => {
+  const cached = openapiVendorMap.get(vendor);
+  if (cached) {
+    return cached;
+  }
+  let vendorFnPromise;
+  switch (vendor) {
+    case "valibot":
+      vendorFnPromise = (await import('./valibot-pYvQeYpK.js')).default();
+      break;
+    case "zod":
+      vendorFnPromise = (await import('./zod-FmKJCmIM.js')).default();
+      break;
+    case "arktype":
+    case "effect":
+      vendorFnPromise = (await import('./default-B3j_H5mf.js')).default();
+      break;
+    default:
+      throw new Error(
+        errorMessageWrapper(`Unsupported schema vendor "${vendor}".`)
+      );
+  }
+  const vendorFn = await vendorFnPromise;
+  openapiVendorMap.set(vendor, vendorFn);
+  return vendorFn;
+};
+
+const toOpenAPISchema = async (schema, context = {}) => {
+  const fn = await getToOpenAPISchemaFn(schema["~standard"].vendor);
+  const { components = {}, options } = context;
+  const _schema = await fn(schema, { components, options });
+  return {
+    schema: _schema,
+    components: Object.keys(components).length > 0 ? components : void 0
+  };
+};
+function loadVendor(vendor, fn) {
+  openapiVendorMap.set(vendor, fn);
+}
+
+export { errorMessageWrapper as e, loadVendor as l, toOpenAPISchema as t };

package/dist/index-DbUgUmtU.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+const errorMessageWrapper = (message) => `standard-openapi: ${message}`;
+const openapiVendorMap = /* @__PURE__ */ new Map();
+
+const getToOpenAPISchemaFn = async (vendor) => {
+  const cached = openapiVendorMap.get(vendor);
+  if (cached) {
+    return cached;
+  }
+  let vendorFnPromise;
+  switch (vendor) {
+    case "valibot":
+      vendorFnPromise = (await Promise.resolve().then(function () { return require('./valibot-CmK54MCp.cjs'); })).default();
+      break;
+    case "zod":
+      vendorFnPromise = (await Promise.resolve().then(function () { return require('./zod-Dcc_GKUA.cjs'); })).default();
+      break;
+    case "arktype":
+    case "effect":
+      vendorFnPromise = (await Promise.resolve().then(function () { return require('./default-CLvGm-jP.cjs'); })).default();
+      break;
+    default:
+      throw new Error(
+        errorMessageWrapper(`Unsupported schema vendor "${vendor}".`)
+      );
+  }
+  const vendorFn = await vendorFnPromise;
+  openapiVendorMap.set(vendor, vendorFn);
+  return vendorFn;
+};
+
+const toOpenAPISchema = async (schema, context = {}) => {
+  const fn = await getToOpenAPISchemaFn(schema["~standard"].vendor);
+  const { components = {}, options } = context;
+  const _schema = await fn(schema, { components, options });
+  return {
+    schema: _schema,
+    components: Object.keys(components).length > 0 ? components : void 0
+  };
+};
+function loadVendor(vendor, fn) {
+  openapiVendorMap.set(vendor, fn);
+}
+
+exports.errorMessageWrapper = errorMessageWrapper;
+exports.loadVendor = loadVendor;
+exports.toOpenAPISchema = toOpenAPISchema;

package/dist/index.cjs

@@ -1,7 +1,8 @@
 'use strict';
 
-var index = require('./index-6sg7Y400.cjs');
+var index = require('./index-DbUgUmtU.cjs');
 
 
 
+exports.loadVendor = index.loadVendor;
 exports.toOpenAPISchema = index.toOpenAPISchema;

package/dist/index.d.cts

@@ -1,12 +1,20 @@
-import { StandardSchemaV1 } from '@standard-schema/spec';
+import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+
+type ToOpenAPISchemaContext = {
+    components: OpenAPIV3_1.ComponentsObject;
+    options?: Record<string, unknown>;
+};
+type ToOpenAPISchemaFn = (schema: StandardSchemaV1, context: ToOpenAPISchemaContext) => OpenAPIV3_1.SchemaObject | Promise<OpenAPIV3_1.SchemaObject>;
 
 /**
  * Converts a Standard Schema to a OpenAPI schema.
  */
-declare const toOpenAPISchema: (schema: StandardSchemaV1, options?: Record<string, unknown>) => Promise<{
-    schema: OpenAPIV3_1.SchemaObject;
-    components: OpenAPIV3_1.ComponentsObject | undefined;
+declare const toOpenAPISchema: (schema: StandardSchemaV1, context?: Partial<ToOpenAPISchemaContext>) => Promise<{
+    schema: openapi_types.OpenAPIV3_1.SchemaObject;
+    components: openapi_types.OpenAPIV3_1.ComponentsObject | undefined;
 }>;
+declare function loadVendor(vendor: string, fn: ToOpenAPISchemaFn): void;
 
-export { toOpenAPISchema };
+export { loadVendor, toOpenAPISchema };

package/dist/index.d.ts

@@ -1,12 +1,20 @@
-import { StandardSchemaV1 } from '@standard-schema/spec';
+import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+
+type ToOpenAPISchemaContext = {
+    components: OpenAPIV3_1.ComponentsObject;
+    options?: Record<string, unknown>;
+};
+type ToOpenAPISchemaFn = (schema: StandardSchemaV1, context: ToOpenAPISchemaContext) => OpenAPIV3_1.SchemaObject | Promise<OpenAPIV3_1.SchemaObject>;
 
 /**
  * Converts a Standard Schema to a OpenAPI schema.
  */
-declare const toOpenAPISchema: (schema: StandardSchemaV1, options?: Record<string, unknown>) => Promise<{
-    schema: OpenAPIV3_1.SchemaObject;
-    components: OpenAPIV3_1.ComponentsObject | undefined;
+declare const toOpenAPISchema: (schema: StandardSchemaV1, context?: Partial<ToOpenAPISchemaContext>) => Promise<{
+    schema: openapi_types.OpenAPIV3_1.SchemaObject;
+    components: openapi_types.OpenAPIV3_1.ComponentsObject | undefined;
 }>;
+declare function loadVendor(vendor: string, fn: ToOpenAPISchemaFn): void;
 
-export { toOpenAPISchema };
+export { loadVendor, toOpenAPISchema };

package/dist/index.js

@@ -1 +1 @@
-export { t as toOpenAPISchema } from './index-BBkvvbCv.js';
+export { l as loadVendor, t as toOpenAPISchema } from './index-2CxeAJPp.js';

package/dist/valibot-CmK54MCp.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+var standardJson = require('@standard-community/standard-json');
+var convert = require('./convert--bmLap0k.cjs');
+
+function getToOpenAPISchemaFn() {
+  return (schema, context) => standardJson.toJsonSchema(schema, {
+    // @ts-expect-error
+    overrideAction: ({ valibotAction, jsonSchema }) => {
+      const _jsonSchema = convert.convertToOpenAPISchema(jsonSchema, context);
+      if (valibotAction.kind === "metadata" && valibotAction.type === "metadata" && !("$ref" in _jsonSchema)) {
+        const metadata = valibotAction.metadata;
+        if (metadata.example !== void 0) {
+          _jsonSchema.example = metadata.example;
+        }
+        if (metadata.examples && metadata.examples.length > 0) {
+          _jsonSchema.examples = metadata.examples;
+        }
+        if (metadata.ref) {
+          context.components.schemas = {
+            ...context.components.schemas,
+            [metadata.ref]: _jsonSchema
+          };
+          return {
+            $ref: `#/components/schemas/${metadata.ref}`
+          };
+        }
+      }
+      return _jsonSchema;
+    },
+    ...context.options
+  });
+}
+
+exports.default = getToOpenAPISchemaFn;

package/dist/valibot-pYvQeYpK.js

@@ -0,0 +1,33 @@
+import { toJsonSchema } from '@standard-community/standard-json';
+import { c as convertToOpenAPISchema } from './convert-BrW5dcj8.js';
+
+function getToOpenAPISchemaFn() {
+  return (schema, context) => toJsonSchema(schema, {
+    // @ts-expect-error
+    overrideAction: ({ valibotAction, jsonSchema }) => {
+      const _jsonSchema = convertToOpenAPISchema(jsonSchema, context);
+      if (valibotAction.kind === "metadata" && valibotAction.type === "metadata" && !("$ref" in _jsonSchema)) {
+        const metadata = valibotAction.metadata;
+        if (metadata.example !== void 0) {
+          _jsonSchema.example = metadata.example;
+        }
+        if (metadata.examples && metadata.examples.length > 0) {
+          _jsonSchema.examples = metadata.examples;
+        }
+        if (metadata.ref) {
+          context.components.schemas = {
+            ...context.components.schemas,
+            [metadata.ref]: _jsonSchema
+          };
+          return {
+            $ref: `#/components/schemas/${metadata.ref}`
+          };
+        }
+      }
+      return _jsonSchema;
+    },
+    ...context.options
+  });
+}
+
+export { getToOpenAPISchemaFn as default };

package/dist/{zod-DBFeduLX.cjs → zod-Dcc_GKUA.cjs}

@@ -2,7 +2,7 @@
 
 var standardJson = require('@standard-community/standard-json');
 var convert = require('./convert--bmLap0k.cjs');
-var index = require('./index-6sg7Y400.cjs');
+var index = require('./index-DbUgUmtU.cjs');
 
 async function getToOpenAPISchemaFn() {
   return async (schema, context) => {

package/dist/{zod-DMhHBlXu.js → zod-FmKJCmIM.js}

@@ -1,6 +1,6 @@
 import { toJsonSchema } from '@standard-community/standard-json';
 import { c as convertToOpenAPISchema } from './convert-BrW5dcj8.js';
-import { e as errorMessageWrapper } from './index-BBkvvbCv.js';
+import { e as errorMessageWrapper } from './index-2CxeAJPp.js';
 
 async function getToOpenAPISchemaFn() {
   return async (schema, context) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@standard-community/standard-openapi",
-  "version": "0.2.0-rc.1",
+  "version": "0.2.1",
   "type": "module",
   "license": "MIT",
   "main": "dist/index.cjs",
@@ -23,8 +23,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/standard-community/standard-openapi.git",
-    "directory": "packages/core"
+    "url": "git+https://github.com/standard-community/standard-openapi.git"
   },
   "bugs": {
     "url": "https://github.com/standard-community/standard-openapi/issues"
@@ -40,7 +39,7 @@
     }
   },
   "peerDependencies": {
-    "@standard-community/standard-json": "^0.3.0-rc.1",
+    "@standard-community/standard-json": "^0.3.0",
     "@standard-schema/spec": "^1.0.0",
     "arktype": "^2.1.20",
     "openapi-types": "^12.1.3",
@@ -65,6 +64,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.0.4",
     "@types/json-schema": "^7.0.15",
+    "@types/node": "^24.3.1",
     "@valibot/to-json-schema": "^1.3.0",
     "pkgroll": "^2.13.1",
     "typescript": "^5.8.3",

package/dist/index-6sg7Y400.cjs

@@ -1,33 +0,0 @@
-'use strict';
-
-const errorMessageWrapper = (message) => `standard-openapi: ${message}`;
-
-const getToOpenAPISchemaFn = async (vendor) => {
-  switch (vendor) {
-    case "valibot":
-      return (await Promise.resolve().then(function () { return require('./valibot-Bhs--VcX.cjs'); })).default();
-    case "zod":
-      return (await Promise.resolve().then(function () { return require('./zod-DBFeduLX.cjs'); })).default();
-    case "arktype":
-    case "effect":
-      return (await Promise.resolve().then(function () { return require('./default-CLvGm-jP.cjs'); })).default();
-    default:
-      throw new Error(
-        errorMessageWrapper(`Unsupported schema vendor "${vendor}".`)
-      );
-  }
-};
-
-const toOpenAPISchema = async (schema, options) => {
-  const components = {};
-  const _schema = await getToOpenAPISchemaFn(schema["~standard"].vendor).then(
-    (toOpenAPISchemaFn) => toOpenAPISchemaFn(schema, { components, options })
-  );
-  return {
-    schema: _schema,
-    components: Object.keys(components).length > 0 ? components : void 0
-  };
-};
-
-exports.errorMessageWrapper = errorMessageWrapper;
-exports.toOpenAPISchema = toOpenAPISchema;

package/dist/index-BBkvvbCv.js

@@ -1,30 +0,0 @@
-const errorMessageWrapper = (message) => `standard-openapi: ${message}`;
-
-const getToOpenAPISchemaFn = async (vendor) => {
-  switch (vendor) {
-    case "valibot":
-      return (await import('./valibot-68LL3XLE.js')).default();
-    case "zod":
-      return (await import('./zod-DMhHBlXu.js')).default();
-    case "arktype":
-    case "effect":
-      return (await import('./default-B3j_H5mf.js')).default();
-    default:
-      throw new Error(
-        errorMessageWrapper(`Unsupported schema vendor "${vendor}".`)
-      );
-  }
-};
-
-const toOpenAPISchema = async (schema, options) => {
-  const components = {};
-  const _schema = await getToOpenAPISchemaFn(schema["~standard"].vendor).then(
-    (toOpenAPISchemaFn) => toOpenAPISchemaFn(schema, { components, options })
-  );
-  return {
-    schema: _schema,
-    components: Object.keys(components).length > 0 ? components : void 0
-  };
-};
-
-export { errorMessageWrapper as e, toOpenAPISchema as t };

package/dist/valibot-68LL3XLE.js

@@ -1,36 +0,0 @@
-import { toJsonSchema } from '@standard-community/standard-json';
-import { c as convertToOpenAPISchema } from './convert-BrW5dcj8.js';
-
-async function getToOpenAPISchemaFn() {
-  return async (schema, context) => toJsonSchema(
-    schema,
-    {
-      // @ts-expect-error
-      overrideAction: ({ valibotAction, jsonSchema }) => {
-        const _jsonSchema = convertToOpenAPISchema(jsonSchema, context);
-        if (valibotAction.kind === "metadata" && valibotAction.type === "metadata" && !("$ref" in _jsonSchema)) {
-          const metadata = valibotAction.metadata;
-          if (metadata.example !== void 0) {
-            _jsonSchema.example = metadata.example;
-          }
-          if (metadata.examples && metadata.examples.length > 0) {
-            _jsonSchema.examples = metadata.examples;
-          }
-          if (metadata.ref) {
-            context.components.schemas = {
-              ...context.components.schemas,
-              [metadata.ref]: _jsonSchema
-            };
-            return {
-              $ref: `#/components/schemas/${metadata.ref}`
-            };
-          }
-        }
-        return _jsonSchema;
-      },
-      ...context.options
-    }
-  );
-}
-
-export { getToOpenAPISchemaFn as default };

package/dist/valibot-Bhs--VcX.cjs

@@ -1,38 +0,0 @@
-'use strict';
-
-var standardJson = require('@standard-community/standard-json');
-var convert = require('./convert--bmLap0k.cjs');
-
-async function getToOpenAPISchemaFn() {
-  return async (schema, context) => standardJson.toJsonSchema(
-    schema,
-    {
-      // @ts-expect-error
-      overrideAction: ({ valibotAction, jsonSchema }) => {
-        const _jsonSchema = convert.convertToOpenAPISchema(jsonSchema, context);
-        if (valibotAction.kind === "metadata" && valibotAction.type === "metadata" && !("$ref" in _jsonSchema)) {
-          const metadata = valibotAction.metadata;
-          if (metadata.example !== void 0) {
-            _jsonSchema.example = metadata.example;
-          }
-          if (metadata.examples && metadata.examples.length > 0) {
-            _jsonSchema.examples = metadata.examples;
-          }
-          if (metadata.ref) {
-            context.components.schemas = {
-              ...context.components.schemas,
-              [metadata.ref]: _jsonSchema
-            };
-            return {
-              $ref: `#/components/schemas/${metadata.ref}`
-            };
-          }
-        }
-        return _jsonSchema;
-      },
-      ...context.options
-    }
-  );
-}
-
-exports.default = getToOpenAPISchemaFn;