@cerios/openapi-to-zod 1.1.1 → 1.3.0

package/dist/internal.d.mts

@@ -1,4 +1,4 @@
-import { E as ExecutionMode, d as OperationFilters } from './types-CI48CjiU.mjs';
+import { E as ExecutionMode, g as OperationFilters, f as OpenAPISpec, b as OpenAPIParameter, c as OpenAPIRequestBody, d as OpenAPIResponse, e as OpenAPISchema } from './types-B3GgqGzM.mjs';
 import { z } from 'zod';
 import { Loader } from 'cosmiconfig';
 
@@ -59,6 +59,7 @@ declare const RequestResponseOptionsSchema: z.ZodObject<{
     }>>;
     useDescribe: z.ZodOptional<z.ZodBoolean>;
     includeDescriptions: z.ZodOptional<z.ZodBoolean>;
+    defaultNullable: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strict>;
 /**
  * @shared Base Zod schema for operation filters (without status codes)
@@ -225,6 +226,55 @@ declare function stripPrefix(input: string, pattern: string | undefined, ensureL
  */
 declare function stripPathPrefix(path: string, pattern: string | undefined): string;
 
+/**
+ * OpenAPI $ref resolution utilities
+ *
+ * Provides functions to resolve $ref references to component definitions
+ * Supports: parameters, requestBodies, responses, schemas
+ *
+ * @internal Used by core and playwright packages
+ */
+
+/**
+ * Type for any resolvable component
+ */
+type ResolvableComponent = OpenAPIParameter | OpenAPIRequestBody | OpenAPIResponse | OpenAPISchema | any;
+/**
+ * Resolve a $ref to a component definition
+ * Handles nested $refs by recursively resolving until no more refs found
+ *
+ * @param obj - Object that may contain a $ref
+ * @param spec - The OpenAPI specification
+ * @param maxDepth - Maximum recursion depth to prevent infinite loops (default: 10)
+ * @returns The resolved component, or the original object if not a reference
+ */
+declare function resolveRef<T extends ResolvableComponent>(obj: T | any, spec: OpenAPISpec, maxDepth?: number): T;
+/**
+ * Resolve a parameter reference
+ * Convenience wrapper for resolveRef with parameter type
+ */
+declare function resolveParameterRef(param: any, spec: OpenAPISpec): OpenAPIParameter | any;
+/**
+ * Resolve a request body reference
+ * Convenience wrapper for resolveRef with request body type
+ */
+declare function resolveRequestBodyRef(requestBody: any, spec: OpenAPISpec): OpenAPIRequestBody | any;
+/**
+ * Resolve a response reference
+ * Convenience wrapper for resolveRef with response type
+ */
+declare function resolveResponseRef(response: any, spec: OpenAPISpec): OpenAPIResponse | any;
+/**
+ * Merge path-level parameters with operation-level parameters
+ * Operation parameters override path-level parameters with the same name and location
+ *
+ * @param pathParams - Parameters defined at the path level
+ * @param operationParams - Parameters defined at the operation level
+ * @param spec - The OpenAPI specification for resolving $refs
+ * @returns Merged array of resolved parameters
+ */
+declare function mergeParameters(pathParams: any[] | undefined, operationParams: any[] | undefined, spec: OpenAPISpec): any[];
+
 /**
  * String utility functions for escaping and formatting
  */
@@ -248,4 +298,24 @@ declare function escapeJSDoc(str: string): string;
  */
 declare function createTypeScriptLoader(): Loader;
 
-export { type BaseOperationFilters, type FilterStatistics, type Generator, LRUCache, OperationFiltersSchema, type RequestResponseOptions, RequestResponseOptionsSchema, createFilterStatistics, createTypeScriptLoader, escapeJSDoc, executeBatch, formatConfigValidationError, formatFilterStatistics, getBatchExitCode, shouldIncludeOperation, stripPathPrefix, stripPrefix, toCamelCase, toPascalCase, validateFilters };
+/**
+ * Configure custom date-time format validation
+ * Overrides the default z.iso.datetime() with a custom regex pattern
+ *
+ * @param pattern - Regex pattern (string or RegExp) for date-time validation
+ * @throws {Error} If the provided pattern is not a valid regular expression
+ * @example
+ * // String pattern (required for JSON/YAML configs)
+ * configureDateTimeFormat('^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$')
+ *
+ * @example
+ * // RegExp literal (TypeScript configs only)
+ * configureDateTimeFormat(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/)
+ */
+declare function configureDateTimeFormat(pattern?: string | RegExp): void;
+/**
+ * Reset format map to defaults (useful for testing)
+ */
+declare function resetFormatMap(): void;
+
+export { type BaseOperationFilters, type FilterStatistics, type Generator, LRUCache, OperationFiltersSchema, type RequestResponseOptions, RequestResponseOptionsSchema, configureDateTimeFormat, createFilterStatistics, createTypeScriptLoader, escapeJSDoc, executeBatch, formatConfigValidationError, formatFilterStatistics, getBatchExitCode, mergeParameters, resetFormatMap, resolveParameterRef, resolveRef, resolveRequestBodyRef, resolveResponseRef, shouldIncludeOperation, stripPathPrefix, stripPrefix, toCamelCase, toPascalCase, validateFilters };

package/dist/internal.d.ts

@@ -1,4 +1,4 @@
-import { E as ExecutionMode, d as OperationFilters } from './types-CI48CjiU.js';
+import { E as ExecutionMode, g as OperationFilters, f as OpenAPISpec, b as OpenAPIParameter, c as OpenAPIRequestBody, d as OpenAPIResponse, e as OpenAPISchema } from './types-B3GgqGzM.js';
 import { z } from 'zod';
 import { Loader } from 'cosmiconfig';
 
@@ -59,6 +59,7 @@ declare const RequestResponseOptionsSchema: z.ZodObject<{
     }>>;
     useDescribe: z.ZodOptional<z.ZodBoolean>;
     includeDescriptions: z.ZodOptional<z.ZodBoolean>;
+    defaultNullable: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strict>;
 /**
  * @shared Base Zod schema for operation filters (without status codes)
@@ -225,6 +226,55 @@ declare function stripPrefix(input: string, pattern: string | undefined, ensureL
  */
 declare function stripPathPrefix(path: string, pattern: string | undefined): string;
 
+/**
+ * OpenAPI $ref resolution utilities
+ *
+ * Provides functions to resolve $ref references to component definitions
+ * Supports: parameters, requestBodies, responses, schemas
+ *
+ * @internal Used by core and playwright packages
+ */
+
+/**
+ * Type for any resolvable component
+ */
+type ResolvableComponent = OpenAPIParameter | OpenAPIRequestBody | OpenAPIResponse | OpenAPISchema | any;
+/**
+ * Resolve a $ref to a component definition
+ * Handles nested $refs by recursively resolving until no more refs found
+ *
+ * @param obj - Object that may contain a $ref
+ * @param spec - The OpenAPI specification
+ * @param maxDepth - Maximum recursion depth to prevent infinite loops (default: 10)
+ * @returns The resolved component, or the original object if not a reference
+ */
+declare function resolveRef<T extends ResolvableComponent>(obj: T | any, spec: OpenAPISpec, maxDepth?: number): T;
+/**
+ * Resolve a parameter reference
+ * Convenience wrapper for resolveRef with parameter type
+ */
+declare function resolveParameterRef(param: any, spec: OpenAPISpec): OpenAPIParameter | any;
+/**
+ * Resolve a request body reference
+ * Convenience wrapper for resolveRef with request body type
+ */
+declare function resolveRequestBodyRef(requestBody: any, spec: OpenAPISpec): OpenAPIRequestBody | any;
+/**
+ * Resolve a response reference
+ * Convenience wrapper for resolveRef with response type
+ */
+declare function resolveResponseRef(response: any, spec: OpenAPISpec): OpenAPIResponse | any;
+/**
+ * Merge path-level parameters with operation-level parameters
+ * Operation parameters override path-level parameters with the same name and location
+ *
+ * @param pathParams - Parameters defined at the path level
+ * @param operationParams - Parameters defined at the operation level
+ * @param spec - The OpenAPI specification for resolving $refs
+ * @returns Merged array of resolved parameters
+ */
+declare function mergeParameters(pathParams: any[] | undefined, operationParams: any[] | undefined, spec: OpenAPISpec): any[];
+
 /**
  * String utility functions for escaping and formatting
  */
@@ -248,4 +298,24 @@ declare function escapeJSDoc(str: string): string;
  */
 declare function createTypeScriptLoader(): Loader;
 
-export { type BaseOperationFilters, type FilterStatistics, type Generator, LRUCache, OperationFiltersSchema, type RequestResponseOptions, RequestResponseOptionsSchema, createFilterStatistics, createTypeScriptLoader, escapeJSDoc, executeBatch, formatConfigValidationError, formatFilterStatistics, getBatchExitCode, shouldIncludeOperation, stripPathPrefix, stripPrefix, toCamelCase, toPascalCase, validateFilters };
+/**
+ * Configure custom date-time format validation
+ * Overrides the default z.iso.datetime() with a custom regex pattern
+ *
+ * @param pattern - Regex pattern (string or RegExp) for date-time validation
+ * @throws {Error} If the provided pattern is not a valid regular expression
+ * @example
+ * // String pattern (required for JSON/YAML configs)
+ * configureDateTimeFormat('^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$')
+ *
+ * @example
+ * // RegExp literal (TypeScript configs only)
+ * configureDateTimeFormat(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/)
+ */
+declare function configureDateTimeFormat(pattern?: string | RegExp): void;
+/**
+ * Reset format map to defaults (useful for testing)
+ */
+declare function resetFormatMap(): void;
+
+export { type BaseOperationFilters, type FilterStatistics, type Generator, LRUCache, OperationFiltersSchema, type RequestResponseOptions, RequestResponseOptionsSchema, configureDateTimeFormat, createFilterStatistics, createTypeScriptLoader, escapeJSDoc, executeBatch, formatConfigValidationError, formatFilterStatistics, getBatchExitCode, mergeParameters, resetFormatMap, resolveParameterRef, resolveRef, resolveRequestBodyRef, resolveResponseRef, shouldIncludeOperation, stripPathPrefix, stripPrefix, toCamelCase, toPascalCase, validateFilters };

package/dist/internal.js

@@ -33,6 +33,7 @@ __export(internal_exports, {
   LRUCache: () => LRUCache,
   OperationFiltersSchema: () => OperationFiltersSchema,
   RequestResponseOptionsSchema: () => RequestResponseOptionsSchema,
+  configureDateTimeFormat: () => configureDateTimeFormat,
   createFilterStatistics: () => createFilterStatistics,
   createTypeScriptLoader: () => createTypeScriptLoader,
   escapeJSDoc: () => escapeJSDoc,
@@ -40,6 +41,12 @@ __export(internal_exports, {
   formatConfigValidationError: () => formatConfigValidationError,
   formatFilterStatistics: () => formatFilterStatistics,
   getBatchExitCode: () => getBatchExitCode,
+  mergeParameters: () => mergeParameters,
+  resetFormatMap: () => resetFormatMap,
+  resolveParameterRef: () => resolveParameterRef,
+  resolveRef: () => resolveRef,
+  resolveRequestBodyRef: () => resolveRequestBodyRef,
+  resolveResponseRef: () => resolveResponseRef,
   shouldIncludeOperation: () => shouldIncludeOperation,
   stripPathPrefix: () => stripPathPrefix,
   stripPrefix: () => stripPrefix,
@@ -184,7 +191,8 @@ var import_zod = require("zod");
 var RequestResponseOptionsSchema = import_zod.z.strictObject({
   mode: import_zod.z.enum(["strict", "normal", "loose"]).optional(),
   useDescribe: import_zod.z.boolean().optional(),
-  includeDescriptions: import_zod.z.boolean().optional()
+  includeDescriptions: import_zod.z.boolean().optional(),
+  defaultNullable: import_zod.z.boolean().optional()
 });
 var OperationFiltersSchema = import_zod.z.strictObject({
   includeTags: import_zod.z.array(import_zod.z.string()).optional(),
@@ -519,7 +527,69 @@ function stripPathPrefix(path, pattern) {
   return stripPrefix(path, pattern, "/");
 }
 
+// src/utils/ref-resolver.ts
+function resolveRef(obj, spec, maxDepth = 10) {
+  var _a, _b, _c, _d;
+  if (!obj || typeof obj !== "object" || maxDepth <= 0) return obj;
+  if (!obj.$ref) return obj;
+  const ref = obj.$ref;
+  let resolved = null;
+  const paramMatch = ref.match(/^#\/components\/parameters\/(.+)$/);
+  const requestBodyMatch = ref.match(/^#\/components\/requestBodies\/(.+)$/);
+  const responseMatch = ref.match(/^#\/components\/responses\/(.+)$/);
+  const schemaMatch = ref.match(/^#\/components\/schemas\/(.+)$/);
+  if (paramMatch && ((_a = spec.components) == null ? void 0 : _a.parameters)) {
+    const name = paramMatch[1];
+    resolved = spec.components.parameters[name];
+  } else if (requestBodyMatch && ((_b = spec.components) == null ? void 0 : _b.requestBodies)) {
+    const name = requestBodyMatch[1];
+    resolved = spec.components.requestBodies[name];
+  } else if (responseMatch && ((_c = spec.components) == null ? void 0 : _c.responses)) {
+    const name = responseMatch[1];
+    resolved = spec.components.responses[name];
+  } else if (schemaMatch && ((_d = spec.components) == null ? void 0 : _d.schemas)) {
+    const name = schemaMatch[1];
+    resolved = spec.components.schemas[name];
+  }
+  if (resolved) {
+    if (resolved.$ref) {
+      return resolveRef(resolved, spec, maxDepth - 1);
+    }
+    return resolved;
+  }
+  return obj;
+}
+function resolveParameterRef(param, spec) {
+  return resolveRef(param, spec);
+}
+function resolveRequestBodyRef(requestBody, spec) {
+  return resolveRef(requestBody, spec);
+}
+function resolveResponseRef(response, spec) {
+  return resolveRef(response, spec);
+}
+function mergeParameters(pathParams, operationParams, spec) {
+  const resolvedPathParams = (pathParams || []).map((p) => resolveParameterRef(p, spec));
+  const resolvedOperationParams = (operationParams || []).map((p) => resolveParameterRef(p, spec));
+  const merged = [...resolvedPathParams];
+  for (const opParam of resolvedOperationParams) {
+    if (!opParam || typeof opParam !== "object") continue;
+    const existingIndex = merged.findIndex(
+      (p) => p && typeof p === "object" && p.name === opParam.name && p.in === opParam.in
+    );
+    if (existingIndex >= 0) {
+      merged[existingIndex] = opParam;
+    } else {
+      merged.push(opParam);
+    }
+  }
+  return merged;
+}
+
 // src/utils/string-utils.ts
+function escapePattern(str) {
+  return str.replace(/\//g, "\\/");
+}
 function escapeJSDoc(str) {
   return str.replace(/\*\//g, "*\\/");
 }
@@ -557,11 +627,73 @@ function createTypeScriptLoader() {
     }
   };
 }
+
+// src/validators/string-validator.ts
+var PATTERN_CACHE = new LRUCache(1e3);
+var DEFAULT_FORMAT_MAP = {
+  uuid: "z.uuid()",
+  email: "z.email()",
+  uri: "z.url()",
+  url: "z.url()",
+  "uri-reference": 'z.string().refine((val) => !/\\s/.test(val), { message: "Must be a valid URI reference" })',
+  hostname: 'z.string().refine((val) => /^(?=.{1,253}$)(?:(?!-)[A-Za-z0-9-]{1,63}(?<!-)\\.)*(?!-)[A-Za-z0-9-]{1,63}(?<!-)$/.test(val), { message: "Must be a valid hostname" })',
+  byte: "z.base64()",
+  binary: "z.string()",
+  date: "z.iso.date()",
+  time: "z.iso.time()",
+  duration: 'z.string().refine((val) => /^P(?:(?:\\d+Y)?(?:\\d+M)?(?:\\d+D)?(?:T(?:\\d+H)?(?:\\d+M)?(?:\\d+(?:\\.\\d+)?S)?)?|\\d+W)$/.test(val) && !/^PT?$/.test(val), { message: "Must be a valid ISO 8601 duration" })',
+  ipv4: "z.ipv4()",
+  ipv6: "z.ipv6()",
+  emoji: "z.emoji()",
+  base64: "z.base64()",
+  base64url: "z.base64url()",
+  nanoid: "z.nanoid()",
+  cuid: "z.cuid()",
+  cuid2: "z.cuid2()",
+  ulid: "z.ulid()",
+  cidr: "z.cidrv4()",
+  // Default to v4
+  cidrv4: "z.cidrv4()",
+  cidrv6: "z.cidrv6()",
+  "json-pointer": 'z.string().refine((val) => val === "" || /^(\\/([^~/]|~0|~1)+)+$/.test(val), { message: "Must be a valid JSON Pointer (RFC 6901)" })',
+  "relative-json-pointer": 'z.string().refine((val) => /^(0|[1-9]\\d*)(#|(\\/([^~/]|~0|~1)+)*)$/.test(val), { message: "Must be a valid relative JSON Pointer" })'
+};
+var FORMAT_MAP = {
+  ...DEFAULT_FORMAT_MAP,
+  "date-time": "z.iso.datetime()"
+};
+function configureDateTimeFormat(pattern) {
+  if (!pattern) {
+    FORMAT_MAP["date-time"] = "z.iso.datetime()";
+    return;
+  }
+  const patternStr = pattern instanceof RegExp ? pattern.source : pattern;
+  if (patternStr === "") {
+    FORMAT_MAP["date-time"] = "z.iso.datetime()";
+    return;
+  }
+  try {
+    new RegExp(patternStr);
+  } catch (error) {
+    throw new Error(
+      `Invalid regular expression pattern for customDateTimeFormatRegex: ${patternStr}. ${error instanceof Error ? error.message : "Pattern is malformed"}`
+    );
+  }
+  const escapedPattern = escapePattern(patternStr);
+  FORMAT_MAP["date-time"] = `z.string().regex(/${escapedPattern}/)`;
+}
+function resetFormatMap() {
+  FORMAT_MAP = {
+    ...DEFAULT_FORMAT_MAP,
+    "date-time": "z.iso.datetime()"
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   LRUCache,
   OperationFiltersSchema,
   RequestResponseOptionsSchema,
+  configureDateTimeFormat,
   createFilterStatistics,
   createTypeScriptLoader,
   escapeJSDoc,
@@ -569,6 +701,12 @@ function createTypeScriptLoader() {
   formatConfigValidationError,
   formatFilterStatistics,
   getBatchExitCode,
+  mergeParameters,
+  resetFormatMap,
+  resolveParameterRef,
+  resolveRef,
+  resolveRequestBodyRef,
+  resolveResponseRef,
   shouldIncludeOperation,
   stripPathPrefix,
   stripPrefix,