@orval/core 8.5.2 → 8.6.0

package/dist/index.d.mts

@@ -22,7 +22,7 @@ interface NormalizedOptions {
   input: NormalizedInputOptions;
   hooks: NormalizedHookOptions;
 }
-type NormalizedOutputOptions = {
+interface NormalizedOutputOptions {
   workspace?: string;
   target: string;
   schemas?: string | SchemaOptions;
@@ -48,11 +48,30 @@ type NormalizedOutputOptions = {
   unionAddMissingProperties: boolean;
   optionsParamRequired: boolean;
   propertySortOrder: PropertySortOrder;
-};
-type NormalizedParamsSerializerOptions = {
+}
+interface NormalizedParamsSerializerOptions {
   qs?: Record<string, unknown>;
-};
-type NormalizedOverrideOutput = {
+}
+/**
+ * Controls how readonly properties are treated when a schema is reused as a request body.
+ *
+ * Best practice:
+ * - `strip` (default): recommended for most OpenAPI specs, because `readOnly`
+ *   properties are response-oriented and generally should not constrain request
+ *   payload authoring.
+ * - `preserve`: use when your schema intentionally models immutable request DTOs
+ *   and you want generated request-body types to keep readonly modifiers.
+ *
+ * Note: this applies to request bodies regardless of the generated client style
+ * (`httpClient`, `httpResource`, etc.). `httpResource` still issues request
+ * payloads, so the same OpenAPI guidance applies.
+ *
+ * If we later want a stricter OpenAPI-aligned mode that omits `readOnly`
+ * properties from request bodies entirely, that should be introduced as a new
+ * explicit mode rather than overloading `preserve`.
+ */
+type ReadonlyRequestBodiesMode = 'strip' | 'preserve';
+interface NormalizedOverrideOutput {
   title?: (title: string) => string;
   transformer?: OutputTransformer;
   mutator?: NormalizedMutator;
@@ -85,7 +104,7 @@ type NormalizedOverrideOutput = {
   };
   hono: NormalizedHonoOptions;
   query: NormalizedQueryOptions;
-  angular: Required<AngularOptions>;
+  angular: NormalizedAngularOptions;
   swr: SwrOptions;
   zod: NormalizedZodOptions;
   fetch: NormalizedFetchOptions;
@@ -98,6 +117,14 @@ type NormalizedOverrideOutput = {
   useNamedParameters?: boolean;
   enumGenerationType: EnumGeneration;
   suppressReadonlyModifier?: boolean;
+  /**
+   * Controls how readonly properties are handled for generated request-body types.
+   *
+   * Prefer `strip` for most OpenAPI specs because `readOnly` fields are
+   * response-oriented. Use `preserve` only when your request DTOs are
+   * intentionally immutable and should remain readonly in generated types.
+   */
+  preserveReadonlyRequestBodies?: ReadonlyRequestBodiesMode;
   jsDoc: NormalizedJsDocOptions;
   aliasCombinedTypes: boolean;
   /**
@@ -105,16 +132,16 @@ type NormalizedOverrideOutput = {
    * @default false
    */
   useNullForOptional?: boolean;
-};
-type NormalizedMutator = {
+}
+interface NormalizedMutator {
   path: string;
   name?: string;
   default: boolean;
   alias?: Record<string, string>;
   external?: string[];
   extension?: string;
-};
-type NormalizedOperationOptions = {
+}
+interface NormalizedOperationOptions {
   transformer?: OutputTransformer;
   mutator?: NormalizedMutator;
   mock?: {
@@ -123,7 +150,7 @@ type NormalizedOperationOptions = {
   };
   contentType?: OverrideOutputContentType;
   query?: NormalizedQueryOptions;
-  angular?: Required<AngularOptions>;
+  angular?: NormalizedAngularOptions;
   swr?: SwrOptions;
   zod?: NormalizedZodOptions;
   operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
@@ -132,8 +159,8 @@ type NormalizedOperationOptions = {
   formUrlEncoded?: boolean | NormalizedMutator;
   paramsSerializer?: NormalizedMutator;
   requestOptions?: object | boolean;
-};
-type NormalizedInputOptions = {
+}
+interface NormalizedInputOptions {
   target: string | OpenApiDocument;
   override: OverrideInput;
   filters?: InputFiltersOptions;
@@ -143,20 +170,20 @@ type NormalizedInputOptions = {
       headers: Record<string, string>;
     }[];
   };
-};
+}
 type OutputClientFunc = (clients: GeneratorClients) => ClientGeneratorsBuilder;
-type BaseUrlFromSpec = {
+interface BaseUrlFromSpec {
   getBaseUrlFromSpecification: true;
   variables?: Record<string, string>;
   index?: number;
   baseUrl?: never;
-};
-type BaseUrlFromConstant = {
+}
+interface BaseUrlFromConstant {
   getBaseUrlFromSpecification: false;
   variables?: never;
   index?: never;
   baseUrl: string;
-};
+}
 declare const PropertySortOrder: {
   readonly ALPHABETICAL: "Alphabetical";
   readonly SPECIFICATION: "Specification";
@@ -176,15 +203,15 @@ declare const EnumGeneration: {
 };
 type EnumGeneration = (typeof EnumGeneration)[keyof typeof EnumGeneration];
 type SchemaGenerationType = 'typescript' | 'zod';
-type SchemaOptions = {
+interface SchemaOptions {
   path: string;
   type: SchemaGenerationType;
-};
-type NormalizedSchemaOptions = {
+}
+interface NormalizedSchemaOptions {
   path: string;
   type: SchemaGenerationType;
-};
-type OutputOptions = {
+}
+interface OutputOptions {
   workspace?: string;
   target: string;
   schemas?: string | SchemaOptions;
@@ -215,13 +242,13 @@ type OutputOptions = {
   unionAddMissingProperties?: boolean;
   optionsParamRequired?: boolean;
   propertySortOrder?: PropertySortOrder;
-};
-type InputFiltersOptions = {
+}
+interface InputFiltersOptions {
   mode?: 'include' | 'exclude';
   tags?: (string | RegExp)[];
   schemas?: (string | RegExp)[];
-};
-type InputOptions = {
+}
+interface InputOptions {
   target: string | string[] | Record<string, unknown> | OpenApiDocument;
   override?: OverrideInput;
   filters?: InputFiltersOptions;
@@ -231,7 +258,7 @@ type InputOptions = {
       headers: Record<string, string>;
     }[];
   };
-};
+}
 declare const OutputClient: {
   readonly ANGULAR: "angular";
   readonly ANGULAR_QUERY: "angular-query";
@@ -270,7 +297,7 @@ declare const OutputMockType: {
 };
 type OutputMockType = (typeof OutputMockType)[keyof typeof OutputMockType];
 type PreferredContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | (string & {});
-type GlobalMockOptions = {
+interface GlobalMockOptions {
   type: OutputMockType;
   useExamples?: boolean;
   generateEachHttpStatus?: boolean;
@@ -278,9 +305,9 @@ type GlobalMockOptions = {
   delayFunctionLazyExecute?: boolean;
   baseUrl?: string;
   locale?: keyof typeof allLocales;
-  preferredContentType?: PreferredContentType;
+  preferredContentType?: string;
   indexMockFiles?: boolean;
-};
+}
 type OverrideMockOptions = Partial<GlobalMockOptions> & {
   arrayMin?: number;
   arrayMax?: number;
@@ -312,18 +339,18 @@ type MockDataArrayFn = (specs: OpenApiDocument) => MockDataArray;
 type MockData = MockDataObject | MockDataObjectFn | MockDataArray | MockDataArrayFn;
 type OutputTransformerFn = (verb: GeneratorVerbOptions) => GeneratorVerbOptions;
 type OutputTransformer = string | OutputTransformerFn;
-type MutatorObject = {
+interface MutatorObject {
   path: string;
   name?: string;
   default?: boolean;
   alias?: Record<string, string>;
   external?: string[];
   extension?: string;
-};
+}
 type Mutator = string | MutatorObject;
-type ParamsSerializerOptions = {
+interface ParamsSerializerOptions {
   qs?: Record<string, unknown>;
-};
+}
 declare const FormDataArrayHandling: {
   readonly SERIALIZE: "serialize";
   readonly EXPLODE: "explode";
@@ -346,7 +373,7 @@ type FormDataType<TMutator> = {
   mutator?: TMutator;
   arrayHandling: FormDataArrayHandling;
 };
-type OverrideOutput = {
+interface OverrideOutput {
   title?: (title: string) => string;
   transformer?: OutputTransformer;
   mutator?: Mutator;
@@ -392,6 +419,14 @@ type OverrideOutput = {
   useNamedParameters?: boolean;
   enumGenerationType?: EnumGeneration;
   suppressReadonlyModifier?: boolean;
+  /**
+   * Controls how readonly properties are handled for generated request-body types.
+   *
+   * Prefer `strip` for most OpenAPI specs because `readOnly` fields are
+   * response-oriented. Use `preserve` only when your request DTOs are
+   * intentionally immutable and should remain readonly in generated types.
+   */
+  preserveReadonlyRequestBodies?: ReadonlyRequestBodiesMode;
   jsDoc?: JsDocOptions;
   aliasCombinedTypes?: boolean;
   /**
@@ -399,38 +434,38 @@ type OverrideOutput = {
    * @default false
    */
   useNullForOptional?: boolean;
-};
-type JsDocOptions = {
+}
+interface JsDocOptions {
   filter?: (schema: Record<string, unknown>) => {
     key: string;
     value: string;
   }[];
-};
-type NormalizedJsDocOptions = {
+}
+interface NormalizedJsDocOptions {
   filter?: (schema: Record<string, unknown>) => {
     key: string;
     value: string;
   }[];
-};
-type OverrideOutputContentType = {
+}
+interface OverrideOutputContentType {
   include?: string[];
   exclude?: string[];
-};
-type NormalizedHonoOptions = {
+}
+interface NormalizedHonoOptions {
   handlers?: string;
   compositeRoute: string;
   validator: boolean | 'hono';
   validatorOutputPath: string;
-};
-type ZodDateTimeOptions = {
+}
+interface ZodDateTimeOptions {
   offset?: boolean;
   local?: boolean;
   precision?: number;
-};
-type ZodTimeOptions = {
+}
+interface ZodTimeOptions {
   precision?: -1 | 0 | 1 | 2 | 3;
-};
-type ZodOptions = {
+}
+interface ZodOptions {
   strict?: {
     param?: boolean;
     query?: boolean;
@@ -462,9 +497,9 @@ type ZodOptions = {
   dateTimeOptions?: ZodDateTimeOptions;
   timeOptions?: ZodTimeOptions;
   generateEachHttpStatus?: boolean;
-};
+}
 type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
-type NormalizedZodOptions = {
+interface NormalizedZodOptions {
   strict: {
     param: boolean;
     query: boolean;
@@ -496,25 +531,25 @@ type NormalizedZodOptions = {
   generateEachHttpStatus: boolean;
   dateTimeOptions: ZodDateTimeOptions;
   timeOptions: ZodTimeOptions;
-};
+}
 type InvalidateTarget = string | {
   query: string;
   params?: string[] | Record<string, string>;
   invalidateMode?: 'invalidate' | 'reset';
   file?: string;
 };
-type MutationInvalidatesRule = {
+interface MutationInvalidatesRule {
   onMutations: string[];
   invalidates: InvalidateTarget[];
-};
+}
 type MutationInvalidatesConfig = MutationInvalidatesRule[];
-type HonoOptions = {
+interface HonoOptions {
   handlers?: string;
   compositeRoute?: string;
   validator?: boolean | 'hono';
   validatorOutputPath?: string;
-};
-type NormalizedQueryOptions = {
+}
+interface NormalizedQueryOptions {
   useQuery?: boolean;
   useSuspenseQuery?: boolean;
   useMutation?: boolean;
@@ -536,8 +571,8 @@ type NormalizedQueryOptions = {
   version?: 3 | 4 | 5;
   mutationInvalidates?: MutationInvalidatesConfig;
   runtimeValidation?: boolean;
-};
-type QueryOptions = {
+}
+interface QueryOptions {
   useQuery?: boolean;
   useSuspenseQuery?: boolean;
   useMutation?: boolean;
@@ -559,12 +594,58 @@ type QueryOptions = {
   version?: 3 | 4 | 5;
   mutationInvalidates?: MutationInvalidatesConfig;
   runtimeValidation?: boolean;
-};
-type AngularOptions = {
+}
+interface AngularOptions {
   provideIn?: 'root' | 'any' | boolean;
+  /**
+   * Preferred name for configuring how retrieval-style operations are emitted.
+   *
+   * - `httpClient`: keep retrievals as service methods
+   * - `httpResource`: emit retrievals as Angular `httpResource` helpers
+   * - `both`: emit retrieval helpers and keep service methods where needed
+   *
+   * Mutation-style operations still use generated `HttpClient` service methods
+   * by default unless a per-operation override forces a different behavior.
+   */
+  retrievalClient?: 'httpClient' | 'httpResource' | 'both';
+  /**
+   * Backward-compatible alias for `retrievalClient`.
+   *
+   * Kept for compatibility with existing configs.
+   */
+  client?: 'httpClient' | 'httpResource' | 'both';
   runtimeValidation?: boolean;
-};
-type SwrOptions = {
+  httpResource?: AngularHttpResourceOptions;
+}
+interface NormalizedAngularOptions {
+  provideIn: 'root' | 'any' | boolean;
+  client: 'httpClient' | 'httpResource' | 'both';
+  runtimeValidation: boolean;
+  httpResource?: AngularHttpResourceOptions;
+}
+interface AngularHttpResourceOptions {
+  /**
+   * Value to expose while the resource is idle/loading.
+   *
+   * Serialized as a literal into generated code.
+   */
+  defaultValue?: unknown;
+  /**
+   * Debug name shown in Angular DevTools.
+   */
+  debugName?: string;
+  /**
+   * Raw code expression for HttpResourceOptions.injector.
+   * Example: `inject(Injector)`.
+   */
+  injector?: string;
+  /**
+   * Raw code expression for HttpResourceOptions.equal.
+   * Example: `(a, b) => a.id === b.id`.
+   */
+  equal?: string;
+}
+interface SwrOptions {
   useInfinite?: boolean;
   useSWRMutationForGet?: boolean;
   useSuspense?: boolean;
@@ -572,25 +653,25 @@ type SwrOptions = {
   swrOptions?: unknown;
   swrMutationOptions?: unknown;
   swrInfiniteOptions?: unknown;
-};
-type NormalizedFetchOptions = {
+}
+interface NormalizedFetchOptions {
   includeHttpResponseReturnType: boolean;
   forceSuccessResponse: boolean;
   jsonReviver?: Mutator;
   runtimeValidation: boolean;
-};
-type FetchOptions = {
+}
+interface FetchOptions {
   includeHttpResponseReturnType?: boolean;
   forceSuccessResponse?: boolean;
   jsonReviver?: Mutator;
   runtimeValidation?: boolean;
-};
+}
 type InputTransformerFn = (spec: OpenApiDocument) => OpenApiDocument;
 type InputTransformer = string | InputTransformerFn;
-type OverrideInput = {
+interface OverrideInput {
   transformer?: InputTransformer;
-};
-type OperationOptions = {
+}
+interface OperationOptions {
   transformer?: OutputTransformer;
   mutator?: Mutator;
   mock?: {
@@ -598,7 +679,7 @@ type OperationOptions = {
     properties?: MockProperties;
   };
   query?: QueryOptions;
-  angular?: Required<AngularOptions>;
+  angular?: AngularOptions;
   swr?: SwrOptions;
   zod?: ZodOptions;
   operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
@@ -607,9 +688,9 @@ type OperationOptions = {
   formUrlEncoded?: boolean | Mutator;
   paramsSerializer?: Mutator;
   requestOptions?: object | boolean;
-};
+}
 type Hook = 'afterAllFilesWrite';
-type HookFunction = (...args: unknown[]) => void | Promise<void>;
+type HookFunction<TArgs extends unknown[] = unknown[]> = (...args: TArgs) => void | Promise<void>;
 interface HookOption {
   command: string | HookFunction;
   injectGeneratedDirsAndFiles?: boolean;
@@ -627,14 +708,14 @@ declare const Verbs: {
   DELETE: Verbs;
   HEAD: Verbs;
 };
-type ImportOpenApi = {
+interface ImportOpenApi {
   spec: OpenApiDocument;
   input: NormalizedInputOptions;
   output: NormalizedOutputOptions;
   target: string;
   workspace: string;
   projectName?: string;
-};
+}
 interface ContextSpec {
   projectName?: string;
   target: string;
@@ -645,6 +726,7 @@ interface ContextSpec {
 }
 interface GlobalOptions {
   watch?: boolean | string | string[];
+  verbose?: boolean;
   clean?: boolean | string[];
   prettier?: boolean;
   biome?: boolean;
@@ -656,7 +738,6 @@ interface GlobalOptions {
   packageJson?: string;
   input?: string | string[];
   output?: string;
-  verbose?: boolean;
 }
 interface Tsconfig {
   baseUrl?: string;
@@ -677,14 +758,14 @@ interface PackageJson {
   catalogs?: Record<string, Record<string, string>>;
   resolvedVersions?: Record<string, string>;
 }
-type GeneratorSchema = {
+interface GeneratorSchema {
   name: string;
   model: string;
   imports: GeneratorImport[];
   dependencies?: string[];
   schema?: OpenApiSchemaObject;
-};
-type GeneratorImport = {
+}
+interface GeneratorImport {
   readonly name: string;
   readonly schemaName?: string;
   readonly isZodSchema?: boolean;
@@ -695,17 +776,17 @@ type GeneratorImport = {
   readonly syntheticDefaultImport?: boolean;
   readonly namespaceImport?: boolean;
   readonly importPath?: string;
-};
-type GeneratorDependency = {
+}
+interface GeneratorDependency {
   readonly exports: readonly GeneratorImport[];
   readonly dependency: string;
-};
-type GeneratorApiResponse = {
+}
+interface GeneratorApiResponse {
   operations: GeneratorOperations;
   schemas: GeneratorSchema[];
-};
+}
 type GeneratorOperations = Record<string, GeneratorOperation>;
-type GeneratorTarget = {
+interface GeneratorTarget {
   imports: GeneratorImport[];
   implementation: string;
   implementationMock: string;
@@ -716,8 +797,8 @@ type GeneratorTarget = {
   formUrlEncoded?: GeneratorMutator[];
   paramsSerializer?: GeneratorMutator[];
   fetchReviver?: GeneratorMutator[];
-};
-type GeneratorTargetFull = {
+}
+interface GeneratorTargetFull {
   imports: GeneratorImport[];
   implementation: string;
   implementationMock: {
@@ -732,8 +813,8 @@ type GeneratorTargetFull = {
   formUrlEncoded?: GeneratorMutator[];
   paramsSerializer?: GeneratorMutator[];
   fetchReviver?: GeneratorMutator[];
-};
-type GeneratorOperation = {
+}
+interface GeneratorOperation {
   imports: GeneratorImport[];
   implementation: string;
   implementationMock: {
@@ -753,8 +834,8 @@ type GeneratorOperation = {
   types?: {
     result: (title?: string) => string;
   };
-};
-type GeneratorVerbOptions = {
+}
+interface GeneratorVerbOptions {
   verb: Verbs;
   route: string;
   pathRoute: string;
@@ -777,26 +858,26 @@ type GeneratorVerbOptions = {
   override: NormalizedOverrideOutput;
   deprecated?: boolean;
   originalOperation: OpenApiOperationObject;
-};
+}
 type GeneratorVerbsOptions = GeneratorVerbOptions[];
-type GeneratorOptions = {
+interface GeneratorOptions {
   route: string;
   pathRoute: string;
   override: NormalizedOverrideOutput;
   context: ContextSpec;
   mock?: GlobalMockOptions | ClientMockBuilder;
   output: string;
-};
-type GeneratorClient = {
+}
+interface GeneratorClient {
   implementation: string;
   imports: GeneratorImport[];
   mutators?: GeneratorMutator[];
-};
-type GeneratorMutatorParsingInfo = {
+}
+interface GeneratorMutatorParsingInfo {
   numberOfParams: number;
   returnNumberOfParams?: number;
-};
-type GeneratorMutator = {
+}
+interface GeneratorMutator {
   name: string;
   path: string;
   default: boolean;
@@ -806,12 +887,12 @@ type GeneratorMutator = {
   hasThirdArg: boolean;
   isHook: boolean;
   bodyTypeName?: string;
-};
+}
 type ClientBuilder = (verbOptions: GeneratorVerbOptions, options: GeneratorOptions, outputClient: OutputClient | OutputClientFunc, output?: NormalizedOutputOptions) => GeneratorClient | Promise<GeneratorClient>;
-type ClientFileBuilder = {
+interface ClientFileBuilder {
   path: string;
   content: string;
-};
+}
 type ClientExtraFilesBuilder = (verbOptions: Record<string, GeneratorVerbOptions>, output: NormalizedOutputOptions, context: ContextSpec) => Promise<ClientFileBuilder[]>;
 type ClientHeaderBuilder = (params: {
   title: string;
@@ -834,16 +915,16 @@ type ClientFooterBuilder = (params: {
   hasMutator: boolean;
 }) => string;
 type ClientTitleBuilder = (title: string) => string;
-type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient, hasTagsMutator?: boolean, override?: NormalizedOverrideOutput) => readonly GeneratorDependency[];
-type ClientMockGeneratorImplementation = {
+type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient, hasTagsMutator?: boolean, override?: NormalizedOverrideOutput) => GeneratorDependency[];
+interface ClientMockGeneratorImplementation {
   function: string;
   handlerName: string;
   handler: string;
-};
-type ClientMockGeneratorBuilder = {
+}
+interface ClientMockGeneratorBuilder {
   imports: GeneratorImport[];
   implementation: ClientMockGeneratorImplementation;
-};
+}
 type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => ClientMockGeneratorBuilder;
 interface ClientGeneratorsBuilder {
   client: ClientBuilder;
@@ -854,7 +935,7 @@ interface ClientGeneratorsBuilder {
   extraFiles?: ClientExtraFilesBuilder;
 }
 type GeneratorClients = Record<OutputClient, ClientGeneratorsBuilder>;
-type GetterResponse = {
+interface GetterResponse {
   imports: GeneratorImport[];
   definition: {
     success: string;
@@ -868,8 +949,8 @@ type GetterResponse = {
   contentTypes: string[];
   schemas: GeneratorSchema[];
   originalSchema?: OpenApiResponsesObject;
-};
-type GetterBody = {
+}
+interface GetterBody {
   originalSchema: OpenApiReferenceObject | OpenApiRequestBodyObject;
   imports: GeneratorImport[];
   definition: string;
@@ -879,8 +960,8 @@ type GetterBody = {
   formUrlEncoded?: string;
   contentType: string;
   isOptional: boolean;
-};
-type GetterParameters = {
+}
+interface GetterParameters {
   query: {
     parameter: OpenApiParameterObject;
     imports: GeneratorImport[];
@@ -893,23 +974,23 @@ type GetterParameters = {
     parameter: OpenApiParameterObject;
     imports: GeneratorImport[];
   }[];
-};
-type GetterParam = {
+}
+interface GetterParam {
   name: string;
   definition: string;
   implementation: string;
-  default: boolean;
+  default: unknown;
   required: boolean;
   imports: GeneratorImport[];
-};
+}
 type GetterParams = GetterParam[];
-type GetterQueryParam = {
+interface GetterQueryParam {
   schema: GeneratorSchema;
   deps: GeneratorSchema[];
   isOptional: boolean;
-  requiredNullableKeys?: string[];
   originalSchema?: OpenApiSchemaObject;
-};
+  requiredNullableKeys?: string[];
+}
 type GetterPropType = 'param' | 'body' | 'queryParam' | 'header' | 'namedPathParams';
 declare const GetterPropType: {
   readonly PARAM: "param";
@@ -918,13 +999,13 @@ declare const GetterPropType: {
   readonly QUERY_PARAM: "queryParam";
   readonly HEADER: "header";
 };
-type GetterPropBase = {
+interface GetterPropBase {
   name: string;
   definition: string;
   implementation: string;
-  default: boolean;
+  default: unknown;
   required: boolean;
-};
+}
 type GetterProp = GetterPropBase & ({
   type: 'namedPathParams';
   destructured: string;
@@ -945,7 +1026,7 @@ declare const SchemaType: {
   enum: string;
   unknown: string;
 };
-type ScalarValue = {
+interface ScalarValue {
   value: string;
   useTypeAlias?: boolean;
   isEnum: boolean;
@@ -956,8 +1037,8 @@ type ScalarValue = {
   isRef: boolean;
   dependencies: string[];
   example?: unknown;
-  examples?: Record<string, unknown>;
-};
+  examples?: Record<string, unknown> | unknown[];
+}
 type ResolverValue = ScalarValue & {
   originalSchema: OpenApiSchemaObject;
 };
@@ -970,7 +1051,7 @@ type ResReqTypesValue = ScalarValue & {
   contentType: string;
   originalSchema?: OpenApiSchemaObject;
 };
-type WriteSpecBuilder = {
+interface WriteSpecBuilder {
   operations: GeneratorOperations;
   verbOptions: Record<string, GeneratorVerbOptions>;
   schemas: GeneratorSchema[];
@@ -983,24 +1064,24 @@ type WriteSpecBuilder = {
   info: OpenApiInfoObject;
   target: string;
   spec: OpenApiDocument;
-};
-type WriteModeProps = {
+}
+interface WriteModeProps {
   builder: WriteSpecBuilder;
   output: NormalizedOutputOptions;
   workspace: string;
   projectName?: string;
   header: string;
   needSchema: boolean;
-};
-type GeneratorApiOperations = {
+}
+interface GeneratorApiOperations {
   verbOptions: Record<string, GeneratorVerbOptions>;
   operations: GeneratorOperations;
   schemas: GeneratorSchema[];
-};
-type GeneratorClientExtra = {
+}
+interface GeneratorClientExtra {
   implementation: string;
   implementationMock: string;
-};
+}
 type GeneratorClientTitle = (data: {
   outputClient?: OutputClient | OutputClientFunc;
   title: string;
@@ -1095,7 +1176,6 @@ declare function generateComponentDefinition(responses: OpenApiComponentsObject[
 //#region src/generators/imports.d.ts
 interface GenerateImportsOptions {
   imports: readonly GeneratorImport[];
-  target: string;
   namingConvention?: NamingConvention;
 }
 declare function generateImports({
@@ -1142,7 +1222,7 @@ declare function generateVerbImports({
 //#endregion
 //#region src/generators/models-inline.d.ts
 declare function generateModelInline(acc: string, model: string): string;
-declare function generateModelsInline(obj: Record<string, GeneratorSchema[]>): string;
+declare function generateModelsInline(obj: Record<string, GeneratorSchema[]> | GeneratorSchema[]): string;
 //#endregion
 //#region src/generators/mutator.d.ts
 declare const BODY_TYPE_NAME = "BodyType";
@@ -1175,7 +1255,7 @@ declare function generateMutator({
  * (e.g. observe-mode branches), prefer getAngularFilteredParamsCallExpression +
  * getAngularFilteredParamsHelperBody instead.
  */
-declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
+declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
 /**
  * Returns the body of a standalone `filterParams` helper function
  * to be emitted once in the generated file header, replacing the
@@ -1185,7 +1265,7 @@ declare const getAngularFilteredParamsHelperBody: () => string;
 /**
  * Returns a call expression to the `filterParams` helper function.
  */
-declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
+declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
 interface GenerateFormDataAndUrlEncodedFunctionOptions {
   body: GetterBody;
   formData?: GeneratorMutator;
@@ -1462,16 +1542,16 @@ declare function getEnumNames(schemaObject: OpenApiSchemaObject | undefined): st
 declare function getEnumDescriptions(schemaObject: OpenApiSchemaObject | undefined): string[] | undefined;
 declare function getEnum(value: string, enumName: string, names: string[] | undefined, enumGenerationType: EnumGeneration, descriptions?: string[], enumNamingConvention?: NamingConvention): string;
 declare function getEnumImplementation(value: string, names?: string[], descriptions?: string[], enumNamingConvention?: NamingConvention): string;
-type CombinedEnumInput = {
+interface CombinedEnumInput {
   value: string;
   isRef: boolean;
   schema: OpenApiSchemaObject | undefined;
-};
-type CombinedEnumValue = {
+}
+interface CombinedEnumValue {
   value: string;
   valueImports: string[];
   hasNull: boolean;
-};
+}
 declare function getEnumUnionFromSchema(schema: OpenApiSchemaObject | undefined): string;
 declare function getCombinedEnumValue(inputs: CombinedEnumInput[]): CombinedEnumValue;
 //#endregion
@@ -1725,8 +1805,8 @@ declare function asyncReduce<IterationItem, AccValue>(array: IterationItem[], re
 //#region src/utils/case.d.ts
 declare function pascal(s?: string): string;
 declare function camel(s?: string): string;
-declare function snake(s: string): string;
-declare function kebab(s: string): string;
+declare function snake(s?: string): string;
+declare function kebab(s?: string): string;
 declare function upper(s: string, fillWith: string, isDeapostrophe?: boolean): string;
 declare function conventionName(name: string, convention: NamingConvention): string;
 //#endregion
@@ -1791,7 +1871,7 @@ declare function createDebugger(ns: string, options?: DebuggerOptions): debug.De
 type DeepNonNullable<T> = T extends ((...args: never[]) => unknown) ? T : T extends readonly (infer U)[] ? DeepNonNullable<NonNullable<U>>[] : T extends object ? { [K in keyof T]: DeepNonNullable<NonNullable<T[K]>> } : NonNullable<T>;
 //#endregion
 //#region src/utils/doc.d.ts
-declare function jsDoc(schema: {
+interface JsDocSchema extends Record<string, unknown> {
   description?: string[] | string;
   deprecated?: boolean;
   summary?: string;
@@ -1805,7 +1885,8 @@ declare function jsDoc(schema: {
   maxItems?: number;
   type?: string | string[];
   pattern?: string;
-}, tryOneLine?: boolean, context?: ContextSpec): string;
+}
+declare function jsDoc(schema: object & JsDocSchema, tryOneLine?: boolean, context?: ContextSpec): string;
 declare function keyValuePairsToJsDoc(keyValues: {
   key: string;
   value: string;
@@ -1897,7 +1978,7 @@ interface LoggerOptions {
 declare function createLogger(level?: LogLevel, options?: LoggerOptions): Logger;
 //#endregion
 //#region src/utils/merge-deep.d.ts
-declare function mergeDeep<T extends Record<string, unknown>, U extends Record<string, unknown>>(source: T, target: U): T & U;
+declare function mergeDeep<T extends object, U extends object>(source: T, target: U): T & U;
 //#endregion
 //#region src/utils/occurrence.d.ts
 declare function count(str: string | undefined, key: string): number;
@@ -1944,10 +2025,10 @@ declare function resolveInstalledVersions(packageJson: PackageJson, fromDir: str
 //#endregion
 //#region src/utils/sort.d.ts
 declare const sortByPriority: <T>(arr: (T & {
-  default?: boolean;
+  default?: unknown;
   required?: boolean;
 })[]) => (T & {
-  default?: boolean;
+  default?: unknown;
   required?: boolean;
 })[];
 //#endregion
@@ -1957,14 +2038,14 @@ declare const sortByPriority: <T>(arr: (T & {
  * Handles strings, numbers, booleans, functions, arrays, and objects.
  *
  * @param data - The data to stringify. Can be a string, array, object, number, boolean, function, null, or undefined.
- * @returns A string representation of the data, or undefined if data is null or undefined.
+ * @returns A string representation of the data, `null` for null, or undefined if data is undefined.
  * @example
  * stringify('hello') // returns "'hello'"
  * stringify(42) // returns "42"
  * stringify([1, 2, 3]) // returns "[1, 2, 3]"
  * stringify({ a: 1, b: 'test' }) // returns "{ a: 1, b: 'test', }"
  */
-declare function stringify(data?: string | unknown[] | Record<string, unknown>): string | undefined;
+declare function stringify(data?: unknown): string | undefined;
 /**
  * Sanitizes a string value by removing or replacing special characters and ensuring
  * it conforms to JavaScript identifier naming rules if needed.
@@ -2018,16 +2099,28 @@ declare function toObjectString<T>(props: T[], path?: keyof T): string;
  */
 declare function getNumberWord(num: number): string;
 /**
- * Escapes a specific character in a string by prefixing it with a backslash.
+ * Escapes a specific character in a string by prefixing all of its occurrences with a backslash.
  *
  * @param str - The string to escape, or null.
  * @param char - The character to escape. Defaults to single quote (').
  * @returns The escaped string, or null if the input is null.
  * @example
  * escape("don't") // returns "don\'t"
+ * escape("it's John's") // returns "it\'s John\'s"
  * escape('say "hello"', '"') // returns 'say \\"hello\\"'
+ * escape("a'''b", "'") // returns "a\'\'\'b"
  */
 declare function escape(str: string | null, char?: string): string | undefined;
+/**
+ * Escapes regular expression metacharacters in a string so it can be safely
+ * embedded inside a RegExp pattern.
+ *
+ * @param value - The raw string value to escape for regex usage.
+ * @returns The escaped string.
+ * @example
+ * escapeRegExp('foo$bar') // returns 'foo\\$bar'
+ */
+declare function escapeRegExp(value: string): string;
 /**
  * Escape all characters not included in SingleStringCharacters and
  * DoubleStringCharacters on
@@ -2147,5 +2240,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
 declare function getOrvalGeneratedTypes(): string;
 declare function getTypedResponse(): string;
 //#endregion
-export { AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, EnumGeneration, ErrorWithTag, FetchOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoOptions, Hook, HookCommand, HookFunction, HookOption, HooksOptions, ImportOpenApi, InputFiltersOptions, InputOptions, InputTransformerFn, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, filterByContentType, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbOptions, generateVerbsOptions, getAngularFilteredParamsCallExpression, getAngularFilteredParamsExpression, getAngularFilteredParamsHelperBody, getArray, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
+export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, EnumGeneration, ErrorWithTag, FetchOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoOptions, Hook, HookCommand, HookFunction, HookOption, HooksOptions, ImportOpenApi, InputFiltersOptions, InputOptions, InputTransformerFn, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, ReadonlyRequestBodiesMode, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbOptions, generateVerbsOptions, getAngularFilteredParamsCallExpression, getAngularFilteredParamsExpression, getAngularFilteredParamsHelperBody, getArray, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
 //# sourceMappingURL=index.d.mts.map