@orval/core 8.3.0 → 8.4.0

package/dist/{chunk-C6wwvPpM.mjs → chunk-1-as6MWF.mjs}

@@ -1,3 +1,5 @@
+import { createRequire } from "node:module";
+
 //#region rolldown:runtime
 var __defProp = Object.defineProperty;
 var __export = (all, symbols) => {

package/dist/index.d.mts

@@ -269,6 +269,7 @@ declare const OutputMockType: {
   readonly MSW: "msw";
 };
 type OutputMockType = (typeof OutputMockType)[keyof typeof OutputMockType];
+type PreferredContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | (string & {});
 type GlobalMockOptions = {
   type: OutputMockType;
   useExamples?: boolean;
@@ -277,6 +278,7 @@ type GlobalMockOptions = {
   delayFunctionLazyExecute?: boolean;
   baseUrl?: string;
   locale?: keyof typeof allLocales;
+  preferredContentType?: PreferredContentType;
   indexMockFiles?: boolean;
 };
 type OverrideMockOptions = Partial<GlobalMockOptions> & {
@@ -499,6 +501,7 @@ type InvalidateTarget = string | {
   query: string;
   params?: string[] | Record<string, string>;
   invalidateMode?: 'invalidate' | 'reset';
+  file?: string;
 };
 type MutationInvalidatesRule = {
   onMutations: string[];
@@ -670,6 +673,7 @@ interface PackageJson {
   peerDependencies?: Record<string, string>;
   catalog?: Record<string, string>;
   catalogs?: Record<string, Record<string, string>>;
+  resolvedVersions?: Record<string, string>;
 }
 type GeneratorSchema = {
   name: string;
@@ -679,20 +683,20 @@ type GeneratorSchema = {
   schema?: OpenApiSchemaObject;
 };
 type GeneratorImport = {
-  name: string;
-  schemaName?: string;
-  isZodSchema?: boolean;
-  isConstant?: boolean;
-  alias?: string;
-  default?: boolean;
-  values?: boolean;
-  syntheticDefaultImport?: boolean;
-  namespaceImport?: boolean;
-  importPath?: string;
+  readonly name: string;
+  readonly schemaName?: string;
+  readonly isZodSchema?: boolean;
+  readonly isConstant?: boolean;
+  readonly alias?: string;
+  readonly default?: boolean;
+  readonly values?: boolean;
+  readonly syntheticDefaultImport?: boolean;
+  readonly namespaceImport?: boolean;
+  readonly importPath?: string;
 };
 type GeneratorDependency = {
-  exports: GeneratorImport[];
-  dependency: string;
+  readonly exports: readonly GeneratorImport[];
+  readonly dependency: string;
 };
 type GeneratorApiResponse = {
   operations: GeneratorOperations;
@@ -828,7 +832,7 @@ 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) => GeneratorDependency[];
+type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient, hasTagsMutator?: boolean, override?: NormalizedOverrideOutput) => readonly GeneratorDependency[];
 type ClientMockGeneratorImplementation = {
   function: string;
   handlerName: string;
@@ -901,6 +905,7 @@ type GetterQueryParam = {
   schema: GeneratorSchema;
   deps: GeneratorSchema[];
   isOptional: boolean;
+  requiredNullableKeys?: string[];
   originalSchema?: OpenApiSchemaObject;
 };
 type GetterPropType = 'param' | 'body' | 'queryParam' | 'header' | 'namedPathParams';
@@ -1093,7 +1098,7 @@ declare function generateComponentDefinition(responses: OpenApiComponentsObject[
 //#endregion
 //#region src/generators/imports.d.ts
 interface GenerateImportsOptions {
-  imports: GeneratorImport[];
+  imports: readonly GeneratorImport[];
   target: string;
   namingConvention?: NamingConvention;
 }
@@ -1113,7 +1118,7 @@ declare function generateMutatorImports({
 }: GenerateMutatorImportsOptions): string;
 interface AddDependencyOptions {
   implementation: string;
-  exports: GeneratorImport[];
+  exports: readonly GeneratorImport[];
   dependency: string;
   projectName?: string;
   hasSchemaDir: boolean;
@@ -1127,7 +1132,7 @@ declare function addDependency({
   isAllowSyntheticDefaultImports
 }: AddDependencyOptions): string | undefined;
 declare function generateDependencyImports(implementation: string, imports: {
-  exports: GeneratorImport[];
+  exports: readonly GeneratorImport[];
   dependency: string;
 }[], projectName: string | undefined, hasSchemaDir: boolean, isAllowSyntheticDefaultImports: boolean): string;
 declare function generateVerbImports({
@@ -1161,6 +1166,30 @@ declare function generateMutator({
 }: GenerateMutatorOptions): Promise<GeneratorMutator | undefined>;
 //#endregion
 //#region src/generators/options.d.ts
+/**
+ * Filters query params for Angular's HttpClient.
+ *
+ * Why: Angular's HttpParams / HttpClient `params` type does not accept `null` or
+ * `undefined` values, and arrays must only contain string/number/boolean.
+ * Orval models often include nullable query params, so we remove nullish values
+ * (including nulls inside arrays) before passing params to HttpClient or a
+ * paramsSerializer to avoid runtime and type issues.
+ *
+ * Returns an inline IIFE expression. For paths that benefit from a shared helper
+ * (e.g. observe-mode branches), prefer getAngularFilteredParamsCallExpression +
+ * getAngularFilteredParamsHelperBody instead.
+ */
+declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
+/**
+ * Returns the body of a standalone `filterParams` helper function
+ * to be emitted once in the generated file header, replacing the
+ * inline IIFE that was previously duplicated in every method.
+ */
+declare const getAngularFilteredParamsHelperBody: () => string;
+/**
+ * Returns a call expression to the `filterParams` helper function.
+ */
+declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
 interface GenerateFormDataAndUrlEncodedFunctionOptions {
   body: GetterBody;
   formData?: GeneratorMutator;
@@ -1172,6 +1201,9 @@ declare function generateBodyOptions(body: GetterBody, isFormData: boolean, isFo
 interface GenerateAxiosOptions {
   response: GetterResponse;
   isExactOptionalPropertyTypes: boolean;
+  angularObserve?: 'body' | 'events' | 'response';
+  angularParamsRef?: string;
+  requiredNullableQueryParamKeys?: string[];
   queryParams?: GeneratorSchema;
   headers?: GeneratorSchema;
   requestOptions?: object | boolean;
@@ -1185,6 +1217,9 @@ interface GenerateAxiosOptions {
 declare function generateAxiosOptions({
   response,
   isExactOptionalPropertyTypes,
+  angularObserve,
+  angularParamsRef,
+  requiredNullableQueryParamKeys,
   queryParams,
   headers,
   requestOptions,
@@ -1198,6 +1233,8 @@ declare function generateAxiosOptions({
 interface GenerateOptionsOptions {
   route: string;
   body: GetterBody;
+  angularObserve?: 'body' | 'events' | 'response';
+  angularParamsRef?: string;
   headers?: GetterQueryParam;
   queryParams?: GetterQueryParam;
   response: GetterResponse;
@@ -1216,6 +1253,8 @@ interface GenerateOptionsOptions {
 declare function generateOptions({
   route,
   body,
+  angularObserve,
+  angularParamsRef,
   headers,
   queryParams,
   response,
@@ -1232,7 +1271,7 @@ declare function generateOptions({
   paramsSerializerOptions
 }: GenerateOptionsOptions): string;
 declare function generateBodyMutatorConfig(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string;
-declare function generateQueryParamsAxiosConfig(response: GetterResponse, isVue: boolean, queryParams?: GetterQueryParam): string;
+declare function generateQueryParamsAxiosConfig(response: GetterResponse, isVue: boolean, isAngular: boolean, requiredNullableQueryParamKeys?: string[], queryParams?: GetterQueryParam): string;
 interface GenerateMutatorConfigOptions {
   route: string;
   body: GetterBody;
@@ -1246,6 +1285,7 @@ interface GenerateMutatorConfigOptions {
   hasSignalParam?: boolean;
   isExactOptionalPropertyTypes: boolean;
   isVue?: boolean;
+  isAngular?: boolean;
 }
 declare function generateMutatorConfig({
   route,
@@ -1259,7 +1299,8 @@ declare function generateMutatorConfig({
   hasSignal,
   hasSignalParam,
   isExactOptionalPropertyTypes,
-  isVue
+  isVue,
+  isAngular
 }: GenerateMutatorConfigOptions): string;
 declare function generateMutatorRequestOptions(requestOptions: boolean | object | undefined, hasSecondArgument: boolean): string;
 declare function generateFormDataAndUrlEncodedFunction({
@@ -1547,6 +1588,11 @@ declare function getResReqTypes(responsesOrRequests: [string, OpenApiReferenceOb
  * Maps to Angular HttpClient's responseType, Axios responseType, and Fetch response methods.
  */
 type ResponseTypeCategory = 'json' | 'text' | 'blob' | 'arraybuffer';
+/**
+ * Determine the responseType option based on success content types only.
+ * This avoids error-response content types influencing the responseType.
+ */
+declare function getSuccessResponseType(response: GetterResponse): 'blob' | 'text' | undefined;
 /**
  * Determine the response type category for a given content type.
  * Used to set the correct responseType option in HTTP clients.
@@ -1864,6 +1910,10 @@ declare const separator$1 = "/";
 declare function normalizeSafe(value: string): string;
 declare function joinSafe(...values: string[]): string;
 //#endregion
+//#region src/utils/resolve-version.d.ts
+declare function resolveInstalledVersion(packageName: string, fromDir: string): string | undefined;
+declare function resolveInstalledVersions(packageJson: PackageJson, fromDir: string): Record<string, string>;
+//#endregion
 //#region src/utils/sort.d.ts
 declare const sortByPriority: <T>(arr: (T & {
   default?: boolean;
@@ -2069,5 +2119,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, 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, 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, getRequestBodyContentTypes, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveObject, resolveRef, resolveValue, sanitize, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
+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, getRequestBodyContentTypes, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, 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