zod-openapi 3.1.0 → 3.2.0

package/README.md

@@ -276,6 +276,7 @@ const { schema, components } = createSchema(job, {
   schemaType: 'input'; // This controls whether this should be rendered as a request (`input`) or response (`output`). Defaults to `output`
   openapi: '3.0.0'; // OpenAPI version to use, defaults to `'3.1.0'`
   components: { jobId: z.string() } // Additional components to use and create while rendering the schema
+  componentRefPath: '#/definitions/' // Defaults to #/components/schemas/
 })
 ```
 

package/dist/components.chunk.cjs

@@ -653,7 +653,7 @@ const createObjectSchema = (zodObject, state) => {
   );
 };
 const createExtendedSchema = (zodObject, baseZodObject, state) => {
-  var _a;
+  var _a, _b;
   if (!baseZodObject) {
     return void 0;
   }
@@ -693,7 +693,14 @@ const createExtendedSchema = (zodObject, baseZodObject, state) => {
   return {
     type: "schema",
     schema: {
-      allOf: [{ $ref: createComponentSchemaRef(completeComponent.ref) }],
+      allOf: [
+        {
+          $ref: createComponentSchemaRef(
+            completeComponent.ref,
+            (_b = state.documentOptions) == null ? void 0 : _b.componentRefPath
+          )
+        }
+      ],
       ...extendedSchema.schema
     },
     effects: flattenEffects([
@@ -1281,6 +1288,7 @@ const createNewSchema = (zodSchema, state) => {
   return schemaWithMetadata;
 };
 const createNewRef = (ref, zodSchema, state) => {
+  var _a;
   state.components.schemas.set(zodSchema, {
     type: "in-progress",
     ref
@@ -1297,7 +1305,12 @@ const createNewRef = (ref, zodSchema, state) => {
   });
   return {
     type: "ref",
-    schema: { $ref: createComponentSchemaRef(ref) },
+    schema: {
+      $ref: createComponentSchemaRef(
+        ref,
+        (_a = state.documentOptions) == null ? void 0 : _a.componentRefPath
+      )
+    },
     effects: newSchema.effects ? [
       {
         type: "component",
@@ -1309,10 +1322,16 @@ const createNewRef = (ref, zodSchema, state) => {
   };
 };
 const createExistingRef = (zodSchema, component, state) => {
+  var _a, _b;
   if (component && component.type === "complete") {
     return {
       type: "ref",
-      schema: { $ref: createComponentSchemaRef(component.ref) },
+      schema: {
+        $ref: createComponentSchemaRef(
+          component.ref,
+          (_a = state.documentOptions) == null ? void 0 : _a.componentRefPath
+        )
+      },
       effects: component.effects ? [
         {
           type: "component",
@@ -1326,7 +1345,12 @@ const createExistingRef = (zodSchema, component, state) => {
   if (component && component.type === "in-progress") {
     return {
       type: "ref",
-      schema: { $ref: createComponentSchemaRef(component.ref) },
+      schema: {
+        $ref: createComponentSchemaRef(
+          component.ref,
+          (_b = state.documentOptions) == null ? void 0 : _b.componentRefPath
+        )
+      },
       effects: [
         {
           type: "component",
@@ -1436,7 +1460,7 @@ const createBaseParameter = (schema, components, subpath, documentOptions) => {
     ...required && { required }
   };
 };
-const createParamOrRef = (zodSchema, components, subpath, documentOptions, type, name) => {
+const createParamOrRef = (zodSchema, components, subpath, type, name, documentOptions) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i;
   const component = components.parameters.get(zodSchema);
   const paramType = ((_c = (_b = (_a = zodSchema._def) == null ? void 0 : _a.openapi) == null ? void 0 : _b.param) == null ? void 0 : _c.in) ?? (component == null ? void 0 : component.in) ?? type;
@@ -1494,9 +1518,9 @@ const createParameters = (type, zodObjectType, components, subpath, documentOpti
       zodSchema,
       components,
       [...subpath, key],
-      documentOptions,
       type,
-      key
+      key,
+      documentOptions
     )
   );
 };
@@ -1540,6 +1564,8 @@ const createManualParameters = (parameters, components, subpath, documentOptions
       param,
       components,
       [...subpath, `param index ${index}`],
+      void 0,
+      void 0,
       documentOptions
     );
   }
@@ -1996,7 +2022,7 @@ const getCallbacks = (callbacks, components) => {
     });
   });
 };
-const createComponentSchemaRef = (schemaRef) => `#/components/schemas/${schemaRef}`;
+const createComponentSchemaRef = (schemaRef, componentPath) => `${componentPath ?? "#/components/schemas/"}${schemaRef}`;
 const createComponentResponseRef = (responseRef) => `#/components/responses/${responseRef}`;
 const createComponentRequestBodyRef = (requestBodyRef) => `#/components/requestBodies/${requestBodyRef}`;
 const createComponentCallbackRef = (callbackRef) => `#/components/callbacks/${callbackRef}`;
@@ -2087,9 +2113,9 @@ const createParamComponents = (componentsObject, components, documentOptions) =>
         schema,
         components,
         [`component parameter index ${index}`],
-        documentOptions,
         component.in,
-        component.ref
+        component.ref,
+        documentOptions
       );
     }
   });

package/dist/components.chunk.mjs

@@ -652,7 +652,7 @@ const createObjectSchema = (zodObject, state) => {
   );
 };
 const createExtendedSchema = (zodObject, baseZodObject, state) => {
-  var _a;
+  var _a, _b;
   if (!baseZodObject) {
     return void 0;
   }
@@ -692,7 +692,14 @@ const createExtendedSchema = (zodObject, baseZodObject, state) => {
   return {
     type: "schema",
     schema: {
-      allOf: [{ $ref: createComponentSchemaRef(completeComponent.ref) }],
+      allOf: [
+        {
+          $ref: createComponentSchemaRef(
+            completeComponent.ref,
+            (_b = state.documentOptions) == null ? void 0 : _b.componentRefPath
+          )
+        }
+      ],
       ...extendedSchema.schema
     },
     effects: flattenEffects([
@@ -1280,6 +1287,7 @@ const createNewSchema = (zodSchema, state) => {
   return schemaWithMetadata;
 };
 const createNewRef = (ref, zodSchema, state) => {
+  var _a;
   state.components.schemas.set(zodSchema, {
     type: "in-progress",
     ref
@@ -1296,7 +1304,12 @@ const createNewRef = (ref, zodSchema, state) => {
   });
   return {
     type: "ref",
-    schema: { $ref: createComponentSchemaRef(ref) },
+    schema: {
+      $ref: createComponentSchemaRef(
+        ref,
+        (_a = state.documentOptions) == null ? void 0 : _a.componentRefPath
+      )
+    },
     effects: newSchema.effects ? [
       {
         type: "component",
@@ -1308,10 +1321,16 @@ const createNewRef = (ref, zodSchema, state) => {
   };
 };
 const createExistingRef = (zodSchema, component, state) => {
+  var _a, _b;
   if (component && component.type === "complete") {
     return {
       type: "ref",
-      schema: { $ref: createComponentSchemaRef(component.ref) },
+      schema: {
+        $ref: createComponentSchemaRef(
+          component.ref,
+          (_a = state.documentOptions) == null ? void 0 : _a.componentRefPath
+        )
+      },
       effects: component.effects ? [
         {
           type: "component",
@@ -1325,7 +1344,12 @@ const createExistingRef = (zodSchema, component, state) => {
   if (component && component.type === "in-progress") {
     return {
       type: "ref",
-      schema: { $ref: createComponentSchemaRef(component.ref) },
+      schema: {
+        $ref: createComponentSchemaRef(
+          component.ref,
+          (_b = state.documentOptions) == null ? void 0 : _b.componentRefPath
+        )
+      },
       effects: [
         {
           type: "component",
@@ -1435,7 +1459,7 @@ const createBaseParameter = (schema, components, subpath, documentOptions) => {
     ...required && { required }
   };
 };
-const createParamOrRef = (zodSchema, components, subpath, documentOptions, type, name) => {
+const createParamOrRef = (zodSchema, components, subpath, type, name, documentOptions) => {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i;
   const component = components.parameters.get(zodSchema);
   const paramType = ((_c = (_b = (_a = zodSchema._def) == null ? void 0 : _a.openapi) == null ? void 0 : _b.param) == null ? void 0 : _c.in) ?? (component == null ? void 0 : component.in) ?? type;
@@ -1493,9 +1517,9 @@ const createParameters = (type, zodObjectType, components, subpath, documentOpti
       zodSchema,
       components,
       [...subpath, key],
-      documentOptions,
       type,
-      key
+      key,
+      documentOptions
     )
   );
 };
@@ -1539,6 +1563,8 @@ const createManualParameters = (parameters, components, subpath, documentOptions
       param,
       components,
       [...subpath, `param index ${index}`],
+      void 0,
+      void 0,
       documentOptions
     );
   }
@@ -1995,7 +2021,7 @@ const getCallbacks = (callbacks, components) => {
     });
   });
 };
-const createComponentSchemaRef = (schemaRef) => `#/components/schemas/${schemaRef}`;
+const createComponentSchemaRef = (schemaRef, componentPath) => `${componentPath ?? "#/components/schemas/"}${schemaRef}`;
 const createComponentResponseRef = (responseRef) => `#/components/responses/${responseRef}`;
 const createComponentRequestBodyRef = (requestBodyRef) => `#/components/requestBodies/${requestBodyRef}`;
 const createComponentCallbackRef = (callbackRef) => `#/components/callbacks/${callbackRef}`;
@@ -2086,9 +2112,9 @@ const createParamComponents = (componentsObject, components, documentOptions) =>
         schema,
         components,
         [`component parameter index ${index}`],
-        documentOptions,
         component.in,
-        component.ref
+        component.ref,
+        documentOptions
       );
     }
   });

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 { CreateDocumentOptions, ZodOpenApiParameters } from './document.js';
+import { ZodOpenApiParameters, CreateDocumentOptions } from './document.js';
 
-declare const createParamOrRef: (zodSchema: ZodType, components: ComponentsObject, subpath: string[], documentOptions?: CreateDocumentOptions, 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

@@ -22,6 +22,10 @@ interface CreateSchemaOptions extends CreateDocumentOptions {
      * Additional components to use and create while rendering the schema
      */
     components?: Record<string, ZodType>;
+    /**
+     * The $ref path to use for the component. Defaults to `#/components/schemas/`
+     */
+    componentRefPath?: string;
 }
 declare const createSchema: (zodType: ZodType, opts?: CreateSchemaOptions) => SchemaResult;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zod-openapi",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Convert Zod Schemas to OpenAPI v3.x documentation",
   "keywords": [
     "typescript",
@@ -74,12 +74,12 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "0.16.4",
     "@crackle/cli": "0.15.5",
-    "@redocly/cli": "1.25.5",
+    "@redocly/cli": "1.25.9",
     "@types/node": "^20.3.0",
     "eslint-plugin-zod-openapi": "^1.0.0-beta.0",
     "openapi3-ts": "4.4.0",
-    "skuba": "9.0.1",
-    "yaml": "2.5.1",
+    "skuba": "9.1.0",
+    "yaml": "2.6.0",
     "zod": "3.23.8"
   },
   "peerDependencies": {