zod-openapi 3.0.1 → 3.1.1

package/dist/create/content.d.ts

@@ -1,7 +1,8 @@
 import { ZodType } from 'zod';
 import { SchemaObject, ReferenceObject } from '../openapi3-ts/dist/model/openapi31.js';
 import { ComponentsObject, CreationType } from './components.js';
+import { CreateDocumentOptions } from './document.js';
 
-declare const createMediaTypeSchema: (schemaObject: ZodType | SchemaObject | ReferenceObject | undefined, components: ComponentsObject, type: CreationType, subpath: string[]) => SchemaObject | ReferenceObject | undefined;
+declare const createMediaTypeSchema: (schemaObject: ZodType | SchemaObject | ReferenceObject | undefined, components: ComponentsObject, type: CreationType, subpath: string[], documentOptions?: CreateDocumentOptions) => SchemaObject | ReferenceObject | undefined;
 
 export { createMediaTypeSchema };

package/dist/create/document.d.ts

@@ -73,6 +73,16 @@ interface ZodOpenApiObject extends Omit<OpenAPIObject, 'openapi' | 'paths' | 'we
     components?: ZodOpenApiComponentsObject;
 }
 type ZodObjectInputType<Output = unknown, Def extends ZodTypeDef = ZodTypeDef, Input = Record<string, unknown>> = ZodType<Output, Def, Input>;
-declare const createDocument: (zodOpenApiObject: ZodOpenApiObject) => OpenAPIObject;
+interface CreateDocumentOptions {
+    /**
+     * Used to change the default Zod Date schema
+     */
+    defaultDateSchema?: Pick<SchemaObject, 'type' | 'format'>;
+    /**
+     * Used to set the output of a ZodUnion to be `oneOf` instead of `allOf`
+     */
+    unionOneOf?: boolean;
+}
+declare const createDocument: (zodOpenApiObject: ZodOpenApiObject, documentOptions?: CreateDocumentOptions) => OpenAPIObject;
 
-export { type ZodObjectInputType, type ZodOpenApiCallbackObject, type ZodOpenApiCallbacksObject, type ZodOpenApiComponentsObject, type ZodOpenApiContentObject, type ZodOpenApiMediaTypeObject, type ZodOpenApiObject, type ZodOpenApiOperationObject, type ZodOpenApiParameters, type ZodOpenApiPathItemObject, type ZodOpenApiPathsObject, type ZodOpenApiRequestBodyObject, type ZodOpenApiResponseObject, type ZodOpenApiResponsesObject, type ZodOpenApiVersion, createDocument };
+export { type CreateDocumentOptions, type ZodObjectInputType, type ZodOpenApiCallbackObject, type ZodOpenApiCallbacksObject, type ZodOpenApiComponentsObject, type ZodOpenApiContentObject, type ZodOpenApiMediaTypeObject, type ZodOpenApiObject, type ZodOpenApiOperationObject, type ZodOpenApiParameters, type ZodOpenApiPathItemObject, type ZodOpenApiPathsObject, type ZodOpenApiRequestBodyObject, type ZodOpenApiResponseObject, type ZodOpenApiResponsesObject, type ZodOpenApiVersion, createDocument };

package/dist/create/parameters.d.ts

@@ -1,8 +1,8 @@
 import { ZodType } from 'zod';
 import { ParameterObject, ReferenceObject } from '../openapi3-ts/dist/model/openapi31.js';
 import { ComponentsObject } from './components.js';
-import { ZodOpenApiParameters } from './document.js';
+import { ZodOpenApiParameters, CreateDocumentOptions } from './document.js';
 
-declare const createParamOrRef: (zodSchema: ZodType, components: ComponentsObject, subpath: string[], type?: keyof ZodOpenApiParameters, name?: string) => ParameterObject | ReferenceObject;
+declare const createParamOrRef: (zodSchema: ZodType, components: ComponentsObject, subpath: string[], type?: keyof ZodOpenApiParameters, name?: string, documentOptions?: CreateDocumentOptions) => ParameterObject | ReferenceObject;
 
 export { createParamOrRef };

package/dist/create/schema/single.d.ts

@@ -0,0 +1,28 @@
+import { ZodType } from 'zod';
+import { OpenApiVersion } from '../../openapi.js';
+import { SchemaObject } from '../../openapi3-ts/dist/model/openapi30.js';
+import { SchemaObject as SchemaObject$1, ReferenceObject } from '../../openapi3-ts/dist/model/openapi31.js';
+import { CreationType } from '../components.js';
+import { CreateDocumentOptions } from '../document.js';
+
+interface SchemaResult {
+    schema: SchemaObject | SchemaObject$1 | ReferenceObject;
+    components?: Record<string, SchemaObject | SchemaObject$1 | ReferenceObject> | undefined;
+}
+interface CreateSchemaOptions extends CreateDocumentOptions {
+    /**
+     * This controls whether this should be rendered as a request (`input`) or response (`output`). Defaults to `output`
+     */
+    schemaType?: CreationType;
+    /**
+     * OpenAPI version to use, defaults to `'3.1.0'`
+     */
+    openapi?: OpenApiVersion;
+    /**
+     * Additional components to use and create while rendering the schema
+     */
+    components?: Record<string, ZodType>;
+}
+declare const createSchema: (zodType: ZodType, opts?: CreateSchemaOptions) => SchemaResult;
+
+export { type CreateSchemaOptions, type SchemaResult, createSchema };

package/dist/extendZodTypes.d.ts

@@ -20,7 +20,7 @@ interface ZodOpenApiMetadata<T extends ZodTypeAny, TInferred = z.input<T> | z.ou
      */
     ref?: string;
     /**
-     * Used when you are manually adding a Zod Schema to the components section. This controls whether this should be rendered as request (`input`) or response (`output`). Defaults to `output`
+     * Used when you are manually adding a Zod Schema to the components section. This controls whether this should be rendered as a request (`input`) or response (`output`). Defaults to `output`
      */
     refType?: CreationType;
     /**

package/dist/index.cjs

@@ -2,15 +2,23 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const components = require("./components.chunk.cjs");
 const extendZod = require("./extendZod.chunk.cjs");
-const createDocument = (zodOpenApiObject) => {
+const createDocument = (zodOpenApiObject, documentOptions) => {
   const { paths, webhooks, components: components$1 = {}, ...rest } = zodOpenApiObject;
   const defaultComponents = components.getDefaultComponents(
     components$1,
     zodOpenApiObject.openapi
   );
-  const createdPaths = components.createPaths(paths, defaultComponents);
-  const createdWebhooks = components.createPaths(webhooks, defaultComponents);
-  const createdComponents = components.createComponents(components$1, defaultComponents);
+  const createdPaths = components.createPaths(paths, defaultComponents, documentOptions);
+  const createdWebhooks = components.createPaths(
+    webhooks,
+    defaultComponents,
+    documentOptions
+  );
+  const createdComponents = components.createComponents(
+    components$1,
+    defaultComponents,
+    documentOptions
+  );
   return {
     ...rest,
     ...createdPaths && { paths: createdPaths },
@@ -18,6 +26,27 @@ const createDocument = (zodOpenApiObject) => {
     ...createdComponents && { components: createdComponents }
   };
 };
+const createSchema = (zodType, opts) => {
+  const components$1 = components.getDefaultComponents(
+    {
+      schemas: opts == null ? void 0 : opts.components
+    },
+    opts == null ? void 0 : opts.openapi
+  );
+  const state = {
+    components: components$1,
+    type: (opts == null ? void 0 : opts.schemaType) ?? "output",
+    path: [],
+    visited: /* @__PURE__ */ new Set(),
+    documentOptions: opts
+  };
+  const schema = components.createSchema(zodType, state, ["createSchema"]);
+  const schemaComponents = components.createSchemaComponents({}, components$1);
+  return {
+    schema,
+    components: schemaComponents
+  };
+};
 const oas30 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null
 }, Symbol.toStringTag, { value: "Module" }));
@@ -26,5 +55,6 @@ const oas31 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePropert
 }, Symbol.toStringTag, { value: "Module" }));
 exports.extendZodWithOpenApi = extendZod.extendZodWithOpenApi;
 exports.createDocument = createDocument;
+exports.createSchema = createSchema;
 exports.oas30 = oas30;
 exports.oas31 = oas31;

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-export { ZodObjectInputType, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiVersion, createDocument } from './create/document.js';
+export { CreateDocumentOptions, ZodObjectInputType, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiVersion, createDocument } from './create/document.js';
+export { CreateSchemaOptions, SchemaResult, createSchema } from './create/schema/single.js';
 export { extendZodWithOpenApi } from './extendZod.js';
 import * as oas30 from './openapi3-ts/dist/oas30.js';
 export { oas30 };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { ZodObjectInputType, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiVersion, createDocument } from './create/document.js';
+export { CreateDocumentOptions, ZodObjectInputType, ZodOpenApiCallbackObject, ZodOpenApiCallbacksObject, ZodOpenApiComponentsObject, ZodOpenApiContentObject, ZodOpenApiMediaTypeObject, ZodOpenApiObject, ZodOpenApiOperationObject, ZodOpenApiParameters, ZodOpenApiPathItemObject, ZodOpenApiPathsObject, ZodOpenApiRequestBodyObject, ZodOpenApiResponseObject, ZodOpenApiResponsesObject, ZodOpenApiVersion, createDocument } from './create/document.js';
+export { CreateSchemaOptions, SchemaResult, createSchema } from './create/schema/single.js';
 export { extendZodWithOpenApi } from './extendZod.js';
 import * as oas30 from './openapi3-ts/dist/oas30.js';
 export { oas30 };

package/dist/index.mjs

@@ -1,14 +1,22 @@
-import { getDefaultComponents, createPaths, createComponents } from "./components.chunk.mjs";
+import { getDefaultComponents, createPaths, createComponents, createSchema as createSchema$1, createSchemaComponents } from "./components.chunk.mjs";
 import { extendZodWithOpenApi } from "./extendZod.chunk.mjs";
-const createDocument = (zodOpenApiObject) => {
+const createDocument = (zodOpenApiObject, documentOptions) => {
   const { paths, webhooks, components = {}, ...rest } = zodOpenApiObject;
   const defaultComponents = getDefaultComponents(
     components,
     zodOpenApiObject.openapi
   );
-  const createdPaths = createPaths(paths, defaultComponents);
-  const createdWebhooks = createPaths(webhooks, defaultComponents);
-  const createdComponents = createComponents(components, defaultComponents);
+  const createdPaths = createPaths(paths, defaultComponents, documentOptions);
+  const createdWebhooks = createPaths(
+    webhooks,
+    defaultComponents,
+    documentOptions
+  );
+  const createdComponents = createComponents(
+    components,
+    defaultComponents,
+    documentOptions
+  );
   return {
     ...rest,
     ...createdPaths && { paths: createdPaths },
@@ -16,6 +24,27 @@ const createDocument = (zodOpenApiObject) => {
     ...createdComponents && { components: createdComponents }
   };
 };
+const createSchema = (zodType, opts) => {
+  const components = getDefaultComponents(
+    {
+      schemas: opts == null ? void 0 : opts.components
+    },
+    opts == null ? void 0 : opts.openapi
+  );
+  const state = {
+    components,
+    type: (opts == null ? void 0 : opts.schemaType) ?? "output",
+    path: [],
+    visited: /* @__PURE__ */ new Set(),
+    documentOptions: opts
+  };
+  const schema = createSchema$1(zodType, state, ["createSchema"]);
+  const schemaComponents = createSchemaComponents({}, components);
+  return {
+    schema,
+    components: schemaComponents
+  };
+};
 const oas30 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null
 }, Symbol.toStringTag, { value: "Module" }));
@@ -24,6 +53,7 @@ const oas31 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePropert
 }, Symbol.toStringTag, { value: "Module" }));
 export {
   createDocument,
+  createSchema,
   extendZodWithOpenApi,
   oas30,
   oas31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -72,13 +72,13 @@
     "test:watch": "skuba test --watch"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.16.2",
+    "@arethetypeswrong/cli": "0.16.4",
     "@crackle/cli": "0.15.5",
-    "@redocly/cli": "1.25.2",
+    "@redocly/cli": "1.25.5",
     "@types/node": "^20.3.0",
-    "eslint-plugin-zod-openapi": "^0.2.0",
+    "eslint-plugin-zod-openapi": "^1.0.0-beta.0",
     "openapi3-ts": "4.4.0",
-    "skuba": "8.2.1",
+    "skuba": "9.0.1",
     "yaml": "2.5.1",
     "zod": "3.23.8"
   },
@@ -97,6 +97,6 @@
     "entryPoint": "src/index.ts",
     "template": "oss-npm-package",
     "type": "package",
-    "version": "8.1.0"
+    "version": "9.0.0-main-20240928013837"
   }
 }