@cerios/openapi-to-zod 0.6.0 → 1.1.0

package/dist/internal.d.mts

@@ -0,0 +1,257 @@
+import { E as ExecutionMode, d as OperationFilters } from './types-B7ePTDjr.mjs';
+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 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>;
+}, 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;
+
+/**
+ * @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;
+
+/**
+ * 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;
+
+/**
+ * Pattern matching utilities for prefix stripping
+ *
+ * Shared utility used by core and playwright packages
+ *
+ * Supports both literal string matching and regex patterns for stripping
+ * prefixes from strings (paths, schema names, etc.)
+ */
+/**
+ * @shared Strips a prefix from a string using either literal string matching or regex
+ * @since 1.1.0
+ * Shared utility used by core and playwright packages
+ *
+ * @param input - The full string to strip from
+ * @param pattern - The pattern to strip (string or RegExp)
+ * @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
+ * // Regex pattern matching
+ * stripPrefix("/api/v1.0/users", "^/api/v\\d+\\.\\d+") // => "/users"
+ * stripPrefix("api_v2_UserSchema", "^api_v\\d+_") // => "UserSchema"
+ */
+declare function stripPrefix(input: string, pattern: string | RegExp | 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 pattern to strip (string or RegExp)
+ * @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\\d+") // => "/posts"
+ */
+declare function stripPathPrefix(path: string, pattern: string | RegExp | undefined): string;
+
+/**
+ * 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;
+
+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 };

package/dist/internal.d.ts

@@ -0,0 +1,257 @@
+import { E as ExecutionMode, d as OperationFilters } from './types-B7ePTDjr.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 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>;
+}, 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;
+
+/**
+ * @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;
+
+/**
+ * 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;
+
+/**
+ * Pattern matching utilities for prefix stripping
+ *
+ * Shared utility used by core and playwright packages
+ *
+ * Supports both literal string matching and regex patterns for stripping
+ * prefixes from strings (paths, schema names, etc.)
+ */
+/**
+ * @shared Strips a prefix from a string using either literal string matching or regex
+ * @since 1.1.0
+ * Shared utility used by core and playwright packages
+ *
+ * @param input - The full string to strip from
+ * @param pattern - The pattern to strip (string or RegExp)
+ * @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
+ * // Regex pattern matching
+ * stripPrefix("/api/v1.0/users", "^/api/v\\d+\\.\\d+") // => "/users"
+ * stripPrefix("api_v2_UserSchema", "^api_v\\d+_") // => "UserSchema"
+ */
+declare function stripPrefix(input: string, pattern: string | RegExp | 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 pattern to strip (string or RegExp)
+ * @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\\d+") // => "/posts"
+ */
+declare function stripPathPrefix(path: string, pattern: string | RegExp | undefined): string;
+
+/**
+ * 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;
+
+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 };