zod-openapi 3.0.1 → 3.1.1

package/dist/components.chunk.cjs

@@ -56,12 +56,15 @@ const createBooleanSchema = (_zodBoolean) => ({
 });
 const createBrandedSchema = (zodBranded, state) => createSchemaObject(zodBranded._def.type, state, ["brand"]);
 const createCatchSchema = (zodCatch, state) => createSchemaObject(zodCatch._def.innerType, state, ["catch"]);
-const createDateSchema = (_zodDate) => ({
-  type: "schema",
-  schema: {
-    type: "string"
-  }
-});
+const createDateSchema = (_zodDate, state) => {
+  var _a;
+  return {
+    type: "schema",
+    schema: ((_a = state.documentOptions) == null ? void 0 : _a.defaultDateSchema) ?? {
+      type: "string"
+    }
+  };
+};
 const createDefaultSchema = (zodDefault, state) => {
   const schemaObject = createSchemaObject(zodDefault._def.innerType, state, [
     "default"
@@ -82,7 +85,7 @@ const createNativeEnumSchema = (zodEnum, state) => {
   const enumValues = getValidEnumValues(zodEnum._def.values);
   const { numbers, strings } = sortStringsAndNumbers(enumValues);
   if (strings.length && numbers.length) {
-    if (satisfiesVersion(state.components.openapi, "3.1.0"))
+    if (satisfiesVersion(state.components.openapi, "3.1.0")) {
       return {
         type: "schema",
         schema: {
@@ -90,6 +93,7 @@ const createNativeEnumSchema = (zodEnum, state) => {
           enum: [...strings, ...numbers]
         }
       };
+    }
     return {
       type: "schema",
       schema: {
@@ -1129,11 +1133,11 @@ const mapPrefixItems = (items, state) => {
   return void 0;
 };
 const createUnionSchema = (zodUnion, state) => {
-  var _a;
+  var _a, _b;
   const schemas = zodUnion.options.map(
     (option, index) => createSchemaObject(option, state, [`union option ${index}`])
   );
-  if ((_a = zodUnion._def.openapi) == null ? void 0 : _a.unionOneOf) {
+  if (((_a = zodUnion._def.openapi) == null ? void 0 : _a.unionOneOf) ?? ((_b = state.documentOptions) == null ? void 0 : _b.unionOneOf)) {
     return {
       type: "schema",
       schema: {
@@ -1211,7 +1215,7 @@ const createSchemaSwitch = (zodSchema, state) => {
     return createTupleSchema(zodSchema, state);
   }
   if (isZodType(zodSchema, "ZodDate")) {
-    return createDateSchema();
+    return createDateSchema(zodSchema, state);
   }
   if (isZodType(zodSchema, "ZodPipeline")) {
     return createPipelineSchema(zodSchema, state);
@@ -1361,7 +1365,7 @@ const createSchema = (zodSchema, state, subpath) => {
   }
   return schema.schema;
 };
-const createMediaTypeSchema = (schemaObject, components, type, subpath) => {
+const createMediaTypeSchema = (schemaObject, components, type, subpath, documentOptions) => {
   if (!schemaObject) {
     return void 0;
   }
@@ -1374,30 +1378,35 @@ const createMediaTypeSchema = (schemaObject, components, type, subpath) => {
       components,
       type,
       path: [],
-      visited: /* @__PURE__ */ new Set()
+      visited: /* @__PURE__ */ new Set(),
+      documentOptions
     },
     subpath
   );
 };
-const createMediaTypeObject = (mediaTypeObject, components, type, subpath) => {
+const createMediaTypeObject = (mediaTypeObject, components, type, subpath, documentOptions) => {
   if (!mediaTypeObject) {
     return void 0;
   }
   return {
     ...mediaTypeObject,
-    schema: createMediaTypeSchema(mediaTypeObject.schema, components, type, [
-      ...subpath,
-      "schema"
-    ])
+    schema: createMediaTypeSchema(
+      mediaTypeObject.schema,
+      components,
+      type,
+      [...subpath, "schema"],
+      documentOptions
+    )
   };
 };
-const createContent = (contentObject, components, type, subpath) => Object.entries(contentObject).reduce(
+const createContent = (contentObject, components, type, subpath, documentOptions) => Object.entries(contentObject).reduce(
   (acc, [mediaType, zodOpenApiMediaTypeObject]) => {
     const mediaTypeObject = createMediaTypeObject(
       zodOpenApiMediaTypeObject,
       components,
       type,
-      [...subpath, mediaType]
+      [...subpath, mediaType],
+      documentOptions
     );
     if (mediaTypeObject) {
       acc[mediaType] = mediaTypeObject;
@@ -1407,14 +1416,15 @@ const createContent = (contentObject, components, type, subpath) => Object.entri
   {}
 );
 const createComponentParamRef = (ref) => `#/components/parameters/${ref}`;
-const createBaseParameter = (schema, components, subpath) => {
+const createBaseParameter = (schema, components, subpath, documentOptions) => {
   var _a, _b, _c;
   const { ref, ...rest } = ((_a = schema._def.openapi) == null ? void 0 : _a.param) ?? {};
   const state = {
     components,
     type: "input",
     path: [],
-    visited: /* @__PURE__ */ new Set()
+    visited: /* @__PURE__ */ new Set(),
+    documentOptions
   };
   const schemaObject = createSchema(schema, state, [...subpath, "schema"]);
   const required = !((_b = isOptionalSchema(schema, state)) == null ? void 0 : _b.optional);
@@ -1426,7 +1436,7 @@ const createBaseParameter = (schema, components, subpath) => {
     ...required && { required }
   };
 };
-const createParamOrRef = (zodSchema, components, subpath, 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;
@@ -1445,7 +1455,12 @@ const createParamOrRef = (zodSchema, components, subpath, type, name) => {
       $ref: createComponentParamRef(component.ref)
     };
   }
-  const baseParamOrRef = createBaseParameter(zodSchema, components, subpath);
+  const baseParamOrRef = createBaseParameter(
+    zodSchema,
+    components,
+    subpath,
+    documentOptions
+  );
   if ("$ref" in baseParamOrRef) {
     throw new Error("Unexpected Error: received a reference object");
   }
@@ -1469,59 +1484,82 @@ const createParamOrRef = (zodSchema, components, subpath, type, name) => {
   }
   return paramObject;
 };
-const createParameters = (type, zodObjectType, components, subpath) => {
+const createParameters = (type, zodObjectType, components, subpath, documentOptions) => {
   if (!zodObjectType) {
     return [];
   }
   const zodObject = getZodObject(zodObjectType).shape;
   return Object.entries(zodObject).map(
-    ([key, zodSchema]) => createParamOrRef(zodSchema, components, [...subpath, key], type, key)
+    ([key, zodSchema]) => createParamOrRef(
+      zodSchema,
+      components,
+      [...subpath, key],
+      type,
+      key,
+      documentOptions
+    )
   );
 };
-const createRequestParams = (requestParams, components, subpath) => {
+const createRequestParams = (requestParams, components, subpath, documentOptions) => {
   if (!requestParams) {
     return [];
   }
-  const pathParams = createParameters("path", requestParams.path, components, [
-    ...subpath,
-    "path"
-  ]);
+  const pathParams = createParameters(
+    "path",
+    requestParams.path,
+    components,
+    [...subpath, "path"],
+    documentOptions
+  );
   const queryParams = createParameters(
     "query",
     requestParams.query,
     components,
-    [...subpath, "query"]
+    [...subpath, "query"],
+    documentOptions
   );
   const cookieParams = createParameters(
     "cookie",
     requestParams.cookie,
     components,
-    [...subpath, "cookie"]
+    [...subpath, "cookie"],
+    documentOptions
   );
   const headerParams = createParameters(
     "header",
     requestParams.header,
     components,
-    [...subpath, "header"]
+    [...subpath, "header"],
+    documentOptions
   );
   return [...pathParams, ...queryParams, ...cookieParams, ...headerParams];
 };
-const createManualParameters = (parameters, components, subpath) => (parameters == null ? void 0 : parameters.map((param, index) => {
+const createManualParameters = (parameters, components, subpath, documentOptions) => (parameters == null ? void 0 : parameters.map((param, index) => {
   if (isAnyZodType(param)) {
-    return createParamOrRef(param, components, [
-      ...subpath,
-      `param index ${index}`
-    ]);
+    return createParamOrRef(
+      param,
+      components,
+      [...subpath, `param index ${index}`],
+      void 0,
+      void 0,
+      documentOptions
+    );
   }
   return param;
 })) ?? [];
-const createParametersObject = (parameters, requestParams, components, subpath) => {
+const createParametersObject = (parameters, requestParams, components, subpath, documentOptions) => {
   const manualParameters = createManualParameters(
     parameters,
     components,
-    subpath
+    subpath,
+    documentOptions
+  );
+  const createdParams = createRequestParams(
+    requestParams,
+    components,
+    subpath,
+    documentOptions
   );
-  const createdParams = createRequestParams(requestParams, components, subpath);
   const combinedParameters = [
     ...manualParameters,
     ...createdParams
@@ -1549,19 +1587,19 @@ const getZodObject = (schema, type) => {
   throw new Error("failed to find ZodObject in schema");
 };
 const isISpecificationExtension = (key) => key.startsWith("x-");
-const createResponseHeaders = (responseHeaders, components) => {
+const createResponseHeaders = (responseHeaders, components, documentOptions) => {
   if (!responseHeaders) {
     return void 0;
   }
   if (isAnyZodType(responseHeaders)) {
     return Object.entries(responseHeaders.shape).reduce((acc, [key, zodSchema]) => {
-      acc[key] = createHeaderOrRef(zodSchema, components);
+      acc[key] = createHeaderOrRef(zodSchema, components, documentOptions);
       return acc;
     }, {});
   }
   return responseHeaders;
 };
-const createHeaderOrRef = (schema, components) => {
+const createHeaderOrRef = (schema, components, documentOptions) => {
   var _a, _b, _c;
   const component = components.headers.get(schema);
   if (component && component.type === "complete") {
@@ -1569,7 +1607,7 @@ const createHeaderOrRef = (schema, components) => {
       $ref: createComponentHeaderRef(component.ref)
     };
   }
-  const baseHeader = createBaseHeader(schema, components);
+  const baseHeader = createBaseHeader(schema, components, documentOptions);
   if ("$ref" in baseHeader) {
     throw new Error("Unexpected Error: received a reference object");
   }
@@ -1586,14 +1624,15 @@ const createHeaderOrRef = (schema, components) => {
   }
   return baseHeader;
 };
-const createBaseHeader = (schema, components) => {
+const createBaseHeader = (schema, components, documentOptions) => {
   var _a, _b;
   const { ref, ...rest } = ((_a = schema._def.openapi) == null ? void 0 : _a.header) ?? {};
   const state = {
     components,
     type: "output",
     path: [],
-    visited: /* @__PURE__ */ new Set()
+    visited: /* @__PURE__ */ new Set(),
+    documentOptions
   };
   const schemaObject = createSchema(schema, state, ["header"]);
   const required = !((_b = isOptionalSchema(schema, state)) == null ? void 0 : _b.optional);
@@ -1604,7 +1643,7 @@ const createBaseHeader = (schema, components) => {
   };
 };
 const createComponentHeaderRef = (ref) => `#/components/headers/${ref}`;
-const createResponse = (responseObject, components, subpath) => {
+const createResponse = (responseObject, components, subpath, documentOptions) => {
   if ("$ref" in responseObject) {
     return responseObject;
   }
@@ -1613,15 +1652,22 @@ const createResponse = (responseObject, components, subpath) => {
     return { $ref: createComponentResponseRef(component.ref) };
   }
   const { content, headers, ref, ...rest } = responseObject;
-  const maybeHeaders = createResponseHeaders(headers, components);
+  const maybeHeaders = createResponseHeaders(
+    headers,
+    components,
+    documentOptions
+  );
   const response = {
     ...rest,
     ...maybeHeaders && { headers: maybeHeaders },
     ...content && {
-      content: createContent(content, components, "output", [
-        ...subpath,
-        "content"
-      ])
+      content: createContent(
+        content,
+        components,
+        "output",
+        [...subpath, "content"],
+        documentOptions
+      )
     }
   };
   const responseRef = ref ?? (component == null ? void 0 : component.ref);
@@ -1637,21 +1683,23 @@ const createResponse = (responseObject, components, subpath) => {
   }
   return response;
 };
-const createResponses = (responsesObject, components, subpath) => Object.entries(responsesObject).reduce(
+const createResponses = (responsesObject, components, subpath, documentOptions) => Object.entries(responsesObject).reduce(
   (acc, [statusCode, responseObject]) => {
     if (isISpecificationExtension(statusCode)) {
       acc[statusCode] = responseObject;
       return acc;
     }
-    acc[statusCode] = createResponse(responseObject, components, [
-      ...subpath,
-      statusCode
-    ]);
+    acc[statusCode] = createResponse(
+      responseObject,
+      components,
+      [...subpath, statusCode],
+      documentOptions
+    );
     return acc;
   },
   {}
 );
-const createRequestBody = (requestBodyObject, components, subpath) => {
+const createRequestBody = (requestBodyObject, components, subpath, documentOptions) => {
   if (!requestBodyObject) {
     return void 0;
   }
@@ -1664,10 +1712,13 @@ const createRequestBody = (requestBodyObject, components, subpath) => {
   const ref = requestBodyObject.ref ?? (component == null ? void 0 : component.ref);
   const requestBody = {
     ...requestBodyObject,
-    content: createContent(requestBodyObject.content, components, "input", [
-      ...subpath,
-      "content"
-    ])
+    content: createContent(
+      requestBodyObject.content,
+      components,
+      "input",
+      [...subpath, "content"],
+      documentOptions
+    )
   };
   if (ref) {
     components.requestBodies.set(requestBodyObject, {
@@ -1681,28 +1732,32 @@ const createRequestBody = (requestBodyObject, components, subpath) => {
   }
   return requestBody;
 };
-const createOperation = (operationObject, components, subpath) => {
+const createOperation = (operationObject, components, subpath, documentOptions) => {
   const { parameters, requestParams, requestBody, responses, ...rest } = operationObject;
   const maybeParameters = createParametersObject(
     parameters,
     requestParams,
     components,
-    [...subpath, "parameters"]
+    [...subpath, "parameters"],
+    documentOptions
   );
   const maybeRequestBody = createRequestBody(
     operationObject.requestBody,
     components,
-    [...subpath, "request body"]
+    [...subpath, "request body"],
+    documentOptions
   );
   const maybeResponses = createResponses(
     operationObject.responses,
     components,
-    [...subpath, "responses"]
+    [...subpath, "responses"],
+    documentOptions
   );
   const maybeCallbacks = createCallbacks(
     operationObject.callbacks,
     components,
-    [...subpath, "callbacks"]
+    [...subpath, "callbacks"],
+    documentOptions
   );
   return {
     ...rest,
@@ -1712,7 +1767,7 @@ const createOperation = (operationObject, components, subpath) => {
     ...maybeCallbacks && { callbacks: maybeCallbacks }
   };
 };
-const createPathItem = (pathObject, components, path) => Object.entries(pathObject).reduce(
+const createPathItem = (pathObject, components, path, documentOptions) => Object.entries(pathObject).reduce(
   (acc, [key, value]) => {
     if (!value) {
       return acc;
@@ -1721,7 +1776,8 @@ const createPathItem = (pathObject, components, path) => Object.entries(pathObje
       acc[key] = createOperation(
         value,
         components,
-        [...path, key]
+        [...path, key],
+        documentOptions
       );
       return acc;
     }
@@ -1730,7 +1786,7 @@ const createPathItem = (pathObject, components, path) => Object.entries(pathObje
   },
   {}
 );
-const createPaths = (pathsObject, components) => {
+const createPaths = (pathsObject, components, documentOptions) => {
   if (!pathsObject) {
     return void 0;
   }
@@ -1740,13 +1796,18 @@ const createPaths = (pathsObject, components) => {
         acc[path] = pathItemObject;
         return acc;
       }
-      acc[path] = createPathItem(pathItemObject, components, [path]);
+      acc[path] = createPathItem(
+        pathItemObject,
+        components,
+        [path],
+        documentOptions
+      );
       return acc;
     },
     {}
   );
 };
-const createCallback = (callbackObject, components, subpath) => {
+const createCallback = (callbackObject, components, subpath, documentOptions) => {
   const { ref, ...callbacks } = callbackObject;
   const callback = Object.entries(
     callbacks
@@ -1755,10 +1816,13 @@ const createCallback = (callbackObject, components, subpath) => {
       acc[callbackName] = pathItemObject;
       return acc;
     }
-    acc[callbackName] = createPathItem(pathItemObject, components, [
-      ...subpath,
-      callbackName
-    ]);
+    acc[callbackName] = createPathItem(
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+      pathItemObject,
+      components,
+      [...subpath, callbackName],
+      documentOptions
+    );
     return acc;
   }, {});
   if (ref) {
@@ -1773,7 +1837,7 @@ const createCallback = (callbackObject, components, subpath) => {
   }
   return callback;
 };
-const createCallbacks = (callbacksObject, components, subpath) => {
+const createCallbacks = (callbacksObject, components, subpath, documentOptions) => {
   if (!callbacksObject) {
     return void 0;
   }
@@ -1783,10 +1847,13 @@ const createCallbacks = (callbacksObject, components, subpath) => {
         acc[callbackName] = callbackObject;
         return acc;
       }
-      acc[callbackName] = createCallback(callbackObject, components, [
-        ...subpath,
-        callbackName
-      ]);
+      acc[callbackName] = createCallback(
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        callbackObject,
+        components,
+        [...subpath, callbackName],
+        documentOptions
+      );
       return acc;
     },
     {}
@@ -1935,16 +2002,34 @@ const createComponentSchemaRef = (schemaRef) => `#/components/schemas/${schemaRe
 const createComponentResponseRef = (responseRef) => `#/components/responses/${responseRef}`;
 const createComponentRequestBodyRef = (requestBodyRef) => `#/components/requestBodies/${requestBodyRef}`;
 const createComponentCallbackRef = (callbackRef) => `#/components/callbacks/${callbackRef}`;
-const createComponents = (componentsObject, components) => {
-  const combinedSchemas = createSchemaComponents(componentsObject, components);
+const createComponents = (componentsObject, components, documentOptions) => {
+  const combinedSchemas = createSchemaComponents(
+    componentsObject,
+    components,
+    documentOptions
+  );
   const combinedParameters = createParamComponents(
     componentsObject,
-    components
+    components,
+    documentOptions
+  );
+  const combinedHeaders = createHeaderComponents(
+    componentsObject,
+    components,
+    documentOptions
+  );
+  const combinedResponses = createResponseComponents(
+    components,
+    documentOptions
+  );
+  const combinedRequestBodies = createRequestBodiesComponents(
+    components,
+    documentOptions
+  );
+  const combinedCallbacks = createCallbackComponents(
+    components,
+    documentOptions
   );
-  const combinedHeaders = createHeaderComponents(componentsObject, components);
-  const combinedResponses = createResponseComponents(components);
-  const combinedRequestBodies = createRequestBodiesComponents(components);
-  const combinedCallbacks = createCallbackComponents(components);
   const { schemas, parameters, headers, responses, requestBodies, ...rest } = componentsObject;
   const finalComponents = {
     ...rest,
@@ -1957,7 +2042,7 @@ const createComponents = (componentsObject, components) => {
   };
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createSchemaComponents = (componentsObject, components) => {
+const createSchemaComponents = (componentsObject, components, documentOptions) => {
   Array.from(components.schemas).forEach(([schema, { type }], index) => {
     var _a;
     if (type === "manual") {
@@ -1965,7 +2050,8 @@ const createSchemaComponents = (componentsObject, components) => {
         components,
         type: ((_a = schema._def.openapi) == null ? void 0 : _a.refType) ?? "output",
         path: [],
-        visited: /* @__PURE__ */ new Set()
+        visited: /* @__PURE__ */ new Set(),
+        documentOptions
       };
       createSchema(schema, state, [`component schema index ${index}`]);
     }
@@ -1996,7 +2082,7 @@ const createSchemaComponents = (componentsObject, components) => {
   }, customComponents);
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createParamComponents = (componentsObject, components) => {
+const createParamComponents = (componentsObject, components, documentOptions) => {
   Array.from(components.parameters).forEach(([schema, component], index) => {
     if (component.type === "manual") {
       createParamOrRef(
@@ -2004,7 +2090,8 @@ const createParamComponents = (componentsObject, components) => {
         components,
         [`component parameter index ${index}`],
         component.in,
-        component.ref
+        component.ref,
+        documentOptions
       );
     }
   });
@@ -2033,10 +2120,10 @@ const createParamComponents = (componentsObject, components) => {
   }, customComponents);
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createHeaderComponents = (componentsObject, components) => {
+const createHeaderComponents = (componentsObject, components, documentOptions) => {
   Array.from(components.headers).forEach(([schema, component]) => {
     if (component.type === "manual") {
-      createHeaderOrRef(schema, components);
+      createHeaderOrRef(schema, components, documentOptions);
     }
   });
   const headers = componentsObject.headers ?? {};
@@ -2060,10 +2147,15 @@ const createHeaderComponents = (componentsObject, components) => {
   }, customComponents);
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createResponseComponents = (components) => {
+const createResponseComponents = (components, documentOptions) => {
   Array.from(components.responses).forEach(([schema, component], index) => {
     if (component.type === "manual") {
-      createResponse(schema, components, [`component response index ${index}`]);
+      createResponse(
+        schema,
+        components,
+        [`component response index ${index}`],
+        documentOptions
+      );
     }
   });
   const finalComponents = Array.from(components.responses).reduce((acc, [_zodType, component]) => {
@@ -2077,12 +2169,15 @@ const createResponseComponents = (components) => {
   }, {});
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createRequestBodiesComponents = (components) => {
+const createRequestBodiesComponents = (components, documentOptions) => {
   Array.from(components.requestBodies).forEach(([schema, component], index) => {
     if (component.type === "manual") {
-      createRequestBody(schema, components, [
-        `component request body ${index}`
-      ]);
+      createRequestBody(
+        schema,
+        components,
+        [`component request body ${index}`],
+        documentOptions
+      );
     }
   });
   const finalComponents = Array.from(components.requestBodies).reduce((acc, [_zodType, component]) => {
@@ -2096,10 +2191,15 @@ const createRequestBodiesComponents = (components) => {
   }, {});
   return Object.keys(finalComponents).length ? finalComponents : void 0;
 };
-const createCallbackComponents = (components) => {
+const createCallbackComponents = (components, documentOptions) => {
   Array.from(components.callbacks).forEach(([schema, component], index) => {
     if (component.type === "manual") {
-      createCallback(schema, components, [`component callback ${index}`]);
+      createCallback(
+        schema,
+        components,
+        [`component callback ${index}`],
+        documentOptions
+      );
     }
   });
   const finalComponents = Array.from(components.callbacks).reduce((acc, [_zodType, component]) => {
@@ -2117,4 +2217,6 @@ exports.createComponents = createComponents;
 exports.createMediaTypeSchema = createMediaTypeSchema;
 exports.createParamOrRef = createParamOrRef;
 exports.createPaths = createPaths;
+exports.createSchema = createSchema;
+exports.createSchemaComponents = createSchemaComponents;
 exports.getDefaultComponents = getDefaultComponents;