@cerios/openapi-to-zod 1.4.0 → 1.5.0

package/dist/internal.d.ts

@@ -1,470 +0,0 @@
-import { E as ExecutionMode, e as OpenAPISchema, f as OpenAPISpec, g as OperationFilters, b as OpenAPIParameter, c as OpenAPIRequestBody, d as OpenAPIResponse } from './types-DZ4Bw-D5.js';
-import { z } from 'zod';
-import { Loader } from 'cosmiconfig';
-
-/**
- * @shared Generator interface for batch execution
- * @since 1.0.0
- * Interface that both OpenApiGenerator and OpenApiPlaywrightGenerator must implement
- */
-interface Generator {
-    generate(): void;
-}
-/**
- * Result of processing a single spec
- */
-interface SpecResult<T> {
-    spec: T;
-    success: boolean;
-    error?: string;
-}
-/**
- * Summary of batch execution results
- */
-interface BatchExecutionSummary<T> {
-    total: number;
-    successful: number;
-    failed: number;
-    results: SpecResult<T>[];
-}
-/**
- * @shared Execute batch processing of multiple specs with custom generator
- * @since 1.0.0
- * Utility used by core and playwright packages
- *
- * @param specs - Array of spec configurations to process
- * @param executionMode - Execution mode: "parallel" (default) or "sequential"
- * @param createGenerator - Factory function to create generator from spec
- * @param batchSize - Number of specifications to process concurrently in parallel mode
- * @returns BatchExecutionSummary with results
- * @throws Never throws - collects all errors and reports them
- */
-declare function executeBatch<T>(specs: T[], executionMode: ExecutionMode | undefined, createGenerator: (spec: T) => Generator, batchSize: number): Promise<BatchExecutionSummary<T>>;
-/**
- * Determine exit code based on batch execution results
- * Returns 1 if any spec failed, 0 if all succeeded
- */
-declare function getBatchExitCode<T>(summary: BatchExecutionSummary<T>): number;
-
-/**
- * @shared Simple LRU Cache implementation for performance optimization
- * @since 1.0.0
- * Utility used by core and playwright packages
- * Prevents memory leaks from unbounded cache growth
- */
-declare class LRUCache<K, V> {
-    private cache;
-    private maxSize;
-    constructor(maxSize: number);
-    get capacity(): number;
-    get(key: K): V | undefined;
-    set(key: K, value: V): void;
-    has(key: K): boolean;
-    clear(): void;
-    size(): number;
-}
-
-/**
- * Name conversion utilities
- */
-interface NamingOptions {
-    prefix?: string;
-    suffix?: string;
-}
-/**
- * Convert schema name to camelCase with optional prefix/suffix
- * Handles dotted names like "Company.Models.User" -> "companyModelsUser"
- */
-declare function toCamelCase(str: string, options?: NamingOptions): string;
-/**
- * @shared Convert enum value to PascalCase and sanitize for TypeScript enum keys
- * @since 1.0.0
- * Utility used by core and playwright packages
- * Handles dotted names like "Company.Models.User" -> "CompanyModelsUser"
- */
-declare function toPascalCase(str: string | number): string;
-
-type ObjectMode = "strict" | "normal" | "loose";
-
-interface PropertyGeneratorContext {
-    spec: OpenAPISpec;
-    schemaDependencies: Map<string, Set<string>>;
-    schemaType: "all" | "request" | "response";
-    mode: ObjectMode;
-    includeDescriptions: boolean;
-    useDescribe: boolean;
-    namingOptions: NamingOptions;
-    stripSchemaPrefix?: string;
-    /**
-     * Default nullable behavior when not explicitly specified
-     * @default false
-     */
-    defaultNullable: boolean;
-    /**
-     * Behavior for empty object schemas (objects with no properties defined)
-     * @default 'loose'
-     */
-    emptyObjectBehavior: "strict" | "loose" | "record";
-    /**
-     * Zod validation string for date-time format fields
-     * @default "z.iso.datetime()"
-     */
-    dateTimeValidation: string;
-    /**
-     * Instance-level cache for escaped regex patterns (parallel-safe)
-     */
-    patternCache: LRUCache<string, string>;
-}
-/**
- * Property schema generator with memoization for performance
- */
-declare class PropertyGenerator {
-    private context;
-    private filteredPropsCache;
-    private schemaCache;
-    static readonly INCLUSION_RULES: {
-        readonly request: (schema: OpenAPISchema) => boolean;
-        readonly response: (schema: OpenAPISchema) => boolean;
-        readonly all: () => boolean;
-    };
-    constructor(context: PropertyGeneratorContext);
-    /**
-     * Check if a property should be included based on schemaType and readOnly/writeOnly flags
-     */
-    shouldIncludeProperty(schema: OpenAPISchema): boolean;
-    /**
-     * Recursively filter any schema type (helper for composition schemas)
-     */
-    private filterSchemaRecursive;
-    /**
-     * Recursively filter properties in nested objects based on readOnly/writeOnly
-     * Performance optimized with memoization
-     */
-    private filterNestedProperties;
-    /**
-     * Resolve discriminator mapping to actual schema references
-     */
-    private resolveDiscriminatorMapping;
-    /**
-     * Resolve a $ref string to the actual schema
-     */
-    private resolveSchemaRef;
-    /**
-     * Resolve a schema name through any aliases to get the actual schema name
-     * If the schema is an alias (allOf with single $ref), return the target name
-     */
-    private resolveSchemaAlias;
-    /**
-     * Check if this is a circular dependency through aliases
-     */
-    private isCircularThroughAlias;
-    /**
-     * Generate union for multiple types (OpenAPI 3.1)
-     */
-    private generateMultiTypeUnion;
-    /**
-     * Apply unevaluatedProperties validation to a schema
-     */
-    private applyUnevaluatedProperties;
-    /**
-     * Generate Zod schema for a property
-     * @param schema - The OpenAPI schema to generate
-     * @param currentSchema - The name of the current schema being processed (for circular ref detection)
-     * @param isTopLevel - Whether this is a top-level schema definition
-     * @param suppressDefaultNullable - When true, don't apply defaultNullable (used when outer schema has explicit nullable: false)
-     */
-    generatePropertySchema(schema: OpenAPISchema, currentSchema?: string, isTopLevel?: boolean, suppressDefaultNullable?: boolean): string;
-    /**
-     * Generate inline object shape for use with .extend()
-     * Returns just the shape object literal: { prop1: z.string(), prop2: z.number() }
-     *
-     * This method is specifically for allOf compositions where we need to pass
-     * the shape directly to .extend() instead of using z.object({...}).shape.
-     * This avoids the .nullable().shape bug when inline objects have nullable: true.
-     *
-     * According to Zod docs (https://zod.dev/api?id=extend):
-     * - .extend() accepts an object of shape definitions
-     * - e.g., baseSchema.extend({ prop: z.string() })
-     */
-    generateInlineObjectShape(schema: OpenAPISchema, currentSchema?: string): string;
-}
-
-/**
- * @shared Zod schema for request/response options validation
- * @since 1.0.0
- * Utility used by core and playwright packages
- */
-declare const RequestResponseOptionsSchema: z.ZodObject<{
-    mode: z.ZodOptional<z.ZodEnum<{
-        strict: "strict";
-        normal: "normal";
-        loose: "loose";
-    }>>;
-    useDescribe: z.ZodOptional<z.ZodBoolean>;
-    includeDescriptions: z.ZodOptional<z.ZodBoolean>;
-    defaultNullable: z.ZodOptional<z.ZodBoolean>;
-    emptyObjectBehavior: z.ZodOptional<z.ZodEnum<{
-        strict: "strict";
-        loose: "loose";
-        record: "record";
-    }>>;
-}, z.core.$strict>;
-/**
- * @shared Base Zod schema for operation filters (without status codes)
- * @since 1.0.0
- * Utility used by core and playwright packages
- */
-declare const OperationFiltersSchema: z.ZodObject<{
-    includeTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    excludeTags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    includePaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    excludePaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    includeMethods: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    excludeMethods: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    includeOperationIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    excludeOperationIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    excludeDeprecated: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strict>;
-/**
- * Inferred TypeScript type for request/response options
- */
-type RequestResponseOptions = z.infer<typeof RequestResponseOptionsSchema>;
-/**
- * Inferred TypeScript type for base operation filters
- */
-type BaseOperationFilters = z.infer<typeof OperationFiltersSchema>;
-
-/**
- * @shared Format Zod validation errors into user-friendly error messages
- * @since 1.0.0
- * Utility used by core and playwright packages
- *
- * @param error - The Zod validation error
- * @param filepath - Path to the config file that was being validated
- * @param configPath - Optional explicit config path provided by user
- * @param additionalNotes - Optional array of additional notes to append to the error message
- * @returns Formatted error message string
- */
-declare function formatConfigValidationError(error: z.ZodError, filepath: string | undefined, configPath: string | undefined, additionalNotes?: string[]): string;
-
-/**
- * Content type utilities for determining response parsing methods
- */
-/**
- * Result of content type analysis
- */
-interface ContentTypeParseResult {
-    /**
-     * The recommended parsing method
-     * - "json": Use response.json() for JSON content types
-     * - "text": Use response.text() for text-based content types
-     * - "body": Use response.body() for binary content types
-     */
-    method: "json" | "text" | "body";
-    /**
-     * Whether the content type was unknown and fallback was used
-     */
-    isUnknown: boolean;
-}
-/**
- * Fallback parsing method for unknown content types
- */
-type FallbackContentTypeParsing = "json" | "text" | "body";
-/**
- * Determines the appropriate response parsing method based on content type
- *
- * Categories:
- * - JSON: application/json, text/json, *+json suffix
- * - Text: text/* (except text/json), application/xml, *+xml suffix, application/javascript
- * - Binary: image/*, audio/*, video/*, font/*, application/octet-stream, application/pdf, etc.
- *
- * @param contentType - The content type to analyze (e.g., "application/json; charset=utf-8")
- * @param fallback - The method to use for unknown content types (default: "text" for safety)
- * @returns The recommended parsing method and whether the content type was unknown
- */
-declare function getResponseParseMethod(contentType: string | undefined, fallback?: FallbackContentTypeParsing): ContentTypeParseResult;
-
-/**
- * Filter statistics to track which operations were included/excluded
- */
-interface FilterStatistics {
-    totalOperations: number;
-    includedOperations: number;
-    filteredByTags: number;
-    filteredByPaths: number;
-    filteredByMethods: number;
-    filteredByOperationIds: number;
-    filteredByDeprecated: number;
-}
-/**
- * Create a new filter statistics object with all counters initialized to zero
- */
-declare function createFilterStatistics(): FilterStatistics;
-/**
- * Determine if an operation should be included based on filter criteria
- *
- * Filter logic:
- * 1. If no filters specified, include all operations
- * 2. Empty arrays are treated as "no constraint" (not as "exclude all")
- * 3. Include filters are applied first (allowlist)
- * 4. Exclude filters are applied second (blocklist)
- * 5. Exclude rules always win over include rules
- *
- * @param operation - The OpenAPI operation object
- * @param path - The operation path (e.g., "/users/{id}")
- * @param method - The HTTP method (e.g., "get", "post")
- * @param filters - Optional filter configuration
- * @param stats - Optional statistics object to track filtering reasons
- * @returns true if the operation should be included, false otherwise
- */
-declare function shouldIncludeOperation(operation: any, path: string, method: string, filters?: OperationFilters, stats?: FilterStatistics): boolean;
-/**
- * Validate filter statistics and emit warnings for filters that matched nothing
- * Helps users debug filter configurations that might be too restrictive or contain typos
- *
- * @param stats - Filter statistics object
- * @param filters - The filter configuration to validate
- */
-declare function validateFilters(stats: FilterStatistics, filters?: OperationFilters): void;
-/**
- * Format filter statistics for display in generated output
- * Returns a formatted string suitable for inclusion in comments
- *
- * @param stats - Filter statistics object
- * @returns Formatted statistics string
- */
-declare function formatFilterStatistics(stats: FilterStatistics): string;
-
-/**
- * @shared Strips a prefix from a string using either literal string matching or glob patterns
- * @since 1.1.0
- * Shared utility used by core and playwright packages
- *
- * @param input - The full string to strip from
- * @param pattern - The glob pattern to strip
- * @param ensureLeadingChar - Optional character to ensure at start (e.g., "/" for paths)
- * @returns The string with prefix removed, or original string if no match
- *
- * @example
- * // Literal string matching
- * stripPrefix("/api/v1/users", "/api/v1") // => "/users"
- * stripPrefix("Company.Models.User", "Company.Models.") // => "User"
- *
- * @example
- * // Glob pattern matching
- * stripPrefix("/api/v1.0/users", "/api/v*") // => matches and strips
- * stripPrefix("Company.Models.User", "*.Models.") // => "User"
- * stripPrefix("api_v2_UserSchema", "api_v[0-9]_") // => "UserSchema"
- */
-declare function stripPrefix(input: string, pattern: string | undefined, ensureLeadingChar?: string): string;
-/**
- * @shared Strips a prefix from a path (ensures leading slash)
- * @since 1.1.0
- * Shared utility used by playwright package for path manipulation
- *
- * @param path - The full path to strip from
- * @param pattern - The glob pattern to strip
- * @returns The path with prefix removed, or original path if no match
- *
- * @example
- * stripPathPrefix("/api/v1/users", "/api/v1") // => "/users"
- * stripPathPrefix("/api/v2/posts", "/api/v*") // => "/posts"
- * stripPathPrefix("/api/v1.0/items", "/api/v[0-9].*") // => "/items"
- */
-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
- */
-
-/**
- * @shared Escape JSDoc comment content to prevent injection
- * @since 1.0.0
- * Utility used by core and playwright packages
- */
-declare function escapeJSDoc(str: string): string;
-
-/**
- * @shared Create a TypeScript loader for cosmiconfig using esbuild
- * @since 1.0.0
- * Utility used by core and playwright packages
- *
- * Creates a loader that transpiles TypeScript config files to JavaScript
- * using esbuild, then executes them to load the configuration.
- *
- * @returns A cosmiconfig Loader function
- */
-declare function createTypeScriptLoader(): Loader;
-
-/**
- * Build the Zod validation string for date-time format
- * Pure function that returns the validation string without side effects
- *
- * @param pattern - Optional regex pattern (string or RegExp) for date-time validation
- * @returns Zod validation string (either "z.iso.datetime()" or custom regex)
- * @throws {Error} If the provided pattern is not a valid regular expression
- *
- * @example
- * // Default (no pattern)
- * buildDateTimeValidation() // Returns "z.iso.datetime()"
- *
- * @example
- * // String pattern (for JSON/YAML configs)
- * buildDateTimeValidation('^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$')
- *
- * @example
- * // RegExp literal (TypeScript configs)
- * buildDateTimeValidation(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$/)
- */
-declare function buildDateTimeValidation(pattern?: string | RegExp): string;
-
-export { type BaseOperationFilters, type ContentTypeParseResult, type FallbackContentTypeParsing, type FilterStatistics, type Generator, LRUCache, OperationFiltersSchema, PropertyGenerator, type PropertyGeneratorContext, type RequestResponseOptions, RequestResponseOptionsSchema, buildDateTimeValidation, createFilterStatistics, createTypeScriptLoader, escapeJSDoc, executeBatch, formatConfigValidationError, formatFilterStatistics, getBatchExitCode, getResponseParseMethod, mergeParameters, resolveParameterRef, resolveRef, resolveRequestBodyRef, resolveResponseRef, shouldIncludeOperation, stripPathPrefix, stripPrefix, toCamelCase, toPascalCase, validateFilters };