@orval/core 8.11.0 → 8.12.2

package/dist/index.d.mts

@@ -36,7 +36,7 @@ interface NormalizedOutputOptions {
   namingConvention: NamingConvention;
   fileExtension: string;
   mode: OutputMode;
-  mock?: GlobalMockOptions | ClientMockBuilder;
+  mock: NormalizedMocksConfig;
   override: NormalizedOverrideOutput;
   client: OutputClient | OutputClientFunc;
   httpClient: OutputHttpClient;
@@ -261,7 +261,7 @@ interface OutputOptions {
   namingConvention?: NamingConvention;
   fileExtension?: string;
   mode?: OutputMode;
-  mock?: boolean | GlobalMockOptions | ClientMockBuilder;
+  mock?: OutputMocksOption;
   override?: OverrideOutput;
   client?: OutputClient | OutputClientFunc;
   httpClient?: OutputHttpClient;
@@ -340,19 +340,34 @@ type OutputDocsOptions = {
 } & Partial<TypeDocOptions>;
 declare const OutputMockType: {
   readonly MSW: "msw";
+  readonly FAKER: "faker";
 };
 type OutputMockType = (typeof OutputMockType)[keyof typeof OutputMockType];
 type PreferredContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | (string & {});
-interface GlobalMockOptions {
-  type: OutputMockType;
+interface CommonMockOptions {
   useExamples?: boolean;
   generateEachHttpStatus?: boolean;
-  delay?: false | number | (() => number);
-  delayFunctionLazyExecute?: boolean;
-  baseUrl?: string;
   locale?: keyof typeof allLocales;
   preferredContentType?: string;
+}
+interface MswMockOptions extends CommonMockOptions {
+  type: typeof OutputMockType.MSW;
+  baseUrl?: string;
+  delay?: false | number | (() => number);
+  delayFunctionLazyExecute?: boolean;
+}
+interface FakerMockOptions extends CommonMockOptions {
+  type: typeof OutputMockType.FAKER;
+}
+type GlobalMockOptions = MswMockOptions | FakerMockOptions;
+interface OutputMocksConfig {
   indexMockFiles?: boolean;
+  generators: (GlobalMockOptions | ClientMockBuilder)[];
+}
+type OutputMocksOption = boolean | OutputMocksConfig | ClientMockBuilder;
+interface NormalizedMocksConfig {
+  indexMockFiles: boolean;
+  generators: (GlobalMockOptions | ClientMockBuilder)[];
 }
 type OverrideMockOptions = Partial<GlobalMockOptions> & {
   arrayMin?: number;
@@ -824,7 +839,7 @@ interface GlobalOptions {
   verbose?: boolean;
   clean?: boolean | string[];
   formatter?: SupportedFormatter;
-  mock?: boolean | GlobalMockOptions;
+  mock?: OutputMocksOption;
   client?: OutputClient;
   httpClient?: OutputHttpClient;
   mode?: OutputMode;
@@ -904,11 +919,24 @@ interface GeneratorApiResponse {
   schemas: GeneratorSchema[];
 }
 type GeneratorOperations = Record<string, GeneratorOperation>;
+interface GeneratorMockOutput {
+  type: OutputMockType;
+  implementation: string;
+  imports: GeneratorImport[];
+}
+interface GeneratorMockOutputFull {
+  type: OutputMockType;
+  implementation: {
+    function: string;
+    handler: string;
+    handlerName: string;
+  };
+  imports: GeneratorImport[];
+}
 interface GeneratorTarget {
   imports: GeneratorImport[];
   implementation: string;
-  implementationMock: string;
-  importsMock: GeneratorImport[];
+  mockOutputs: GeneratorMockOutput[];
   mutators?: GeneratorMutator[];
   clientMutators?: GeneratorMutator[];
   formData?: GeneratorMutator[];
@@ -920,12 +948,7 @@ interface GeneratorTarget {
 interface GeneratorTargetFull {
   imports: GeneratorImport[];
   implementation: string;
-  implementationMock: {
-    function: string;
-    handler: string;
-    handlerName: string;
-  };
-  importsMock: GeneratorImport[];
+  mockOutputs: GeneratorMockOutputFull[];
   mutators?: GeneratorMutator[];
   clientMutators?: GeneratorMutator[];
   formData?: GeneratorMutator[];
@@ -937,12 +960,7 @@ interface GeneratorTargetFull {
 interface GeneratorOperation {
   imports: GeneratorImport[];
   implementation: string;
-  implementationMock: {
-    function: string;
-    handler: string;
-    handlerName: string;
-  };
-  importsMock: GeneratorImport[];
+  mockOutputs: GeneratorMockOutputFull[];
   tags: string[];
   mutator?: GeneratorMutator;
   clientMutators?: GeneratorMutator[];
@@ -1611,10 +1629,11 @@ declare function generateVerbsOptions({
 //#endregion
 //#region src/getters/object.d.ts
 /**
- * Context for multipart/form-data type generation.
+ * Context for form request body (multipart/form-data and
+ * application/x-www-form-urlencoded) type generation.
  * Discriminated union with two states:
  *
- * 1. `{ atPart: false, encoding }` - At form-data root, before property iteration
+ * 1. `{ atPart: false, encoding }` - At form root, before property iteration
  *    - May traverse through allOf/anyOf/oneOf to reach properties
  *    - Carries encoding map so getObject can look up `encoding[key]`
  *
@@ -1623,16 +1642,22 @@ declare function generateVerbsOptions({
  *    - Used by getScalar for file type detection (precedence over contentMediaType)
  *    - Arrays pass this through to items; combiners inside arrays also get context
  *
- * `undefined` means not in form-data context (or nested inside plain object field = JSON)
+ * `urlEncoded` marks an application/x-www-form-urlencoded body. Such bodies are
+ * built with URLSearchParams, whose values are always strings, so getScalar
+ * keeps file/binary fields as `string` instead of `Blob` (#1624).
+ *
+ * `undefined` means not in form context (or nested inside plain object field = JSON)
  */
 type FormDataContext = {
   atPart: false;
   encoding: Record<string, {
     contentType?: string;
   }>;
+  urlEncoded?: boolean;
 } | {
   atPart: true;
   partContentType?: string;
+  urlEncoded?: boolean;
 };
 interface GetObjectOptions {
   item: OpenApiSchemaObject;
@@ -1900,6 +1925,8 @@ declare function getFullRoute(route: string, servers: OpenApiServerObject[] | un
  * type-only symbols referenced from the expression).
  */
 declare function getBaseUrlRuntimeImports(baseUrl?: NormalizedOutputOptions['baseUrl']): GeneratorImport[];
+declare const wrapRouteParameters: (route: string, prepend: string, append: string) => string;
+declare const makeRouteSafe: (route: string) => string;
 declare function getRouteAsArray(route: string): string;
 //#endregion
 //#region src/getters/scalar.d.ts
@@ -2001,6 +2028,16 @@ declare function isNumeric(x: unknown): x is number;
 declare function isSchema(x: unknown): x is OpenApiSchemaObject;
 declare function isVerb(verb: string): verb is Verbs;
 declare function isUrl(str: string): boolean;
+/**
+ * Type guard for the MSW mock generator. Use to narrow a
+ * `GlobalMockOptions | ClientMockBuilder` value to `MswMockOptions`.
+ */
+declare function isMswMock(mock: GlobalMockOptions | ClientMockBuilder): mock is MswMockOptions;
+/**
+ * Type guard for the Faker mock generator. Use to narrow a
+ * `GlobalMockOptions | ClientMockBuilder` value to `FakerMockOptions`.
+ */
+declare function isFakerMock(mock: GlobalMockOptions | ClientMockBuilder): mock is FakerMockOptions;
 //#endregion
 //#region src/utils/async-reduce.d.ts
 declare function asyncReduce<IterationItem, AccValue>(array: IterationItem[], reducer: (accumulate: AccValue, current: IterationItem) => AccValue | Promise<AccValue>, initValue: AccValue): Promise<AccValue>;
@@ -2122,7 +2159,15 @@ declare function getFileInfo(target?: string, {
 declare function removeFilesAndEmptyFolders(patterns: string[], dir: string): Promise<void>;
 //#endregion
 //#region src/utils/file-extensions.d.ts
-declare function getMockFileExtensionByTypeName(mock: GlobalMockOptions | ClientMockBuilder): string;
+/**
+ * Returns the filename suffix for a given mock entry's output file. For
+ * example a `{ type: OutputMockType.MSW }` entry produces `<file>.msw.ts` and
+ * a `{ type: OutputMockType.FAKER }` entry produces `<file>.faker.ts`.
+ *
+ * Custom `ClientMockBuilder` functions default to the `msw` suffix to preserve
+ * the historical behavior.
+ */
+declare function getMockFileExtensionByTypeName(mock: GlobalMockOptions | ClientMockBuilder): OutputMockType;
 //#endregion
 //#region src/utils/get-property-safe.d.ts
 /**
@@ -2458,5 +2503,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
 declare function getOrvalGeneratedTypes(): string;
 declare function getTypedResponse(): string;
 //#endregion
-export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, BaseUrlRuntime, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, DefaultTag, 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, InvalidateTargetParam, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, McpOptions, McpServerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NAMED_COMPONENT_SECTIONS, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, 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, SupportedFormatter, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigModule, TsConfigModuleResolution, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, addDependency, asyncReduce, buildAngularParamsFilterExpression, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, filteredVerbs, 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, getBaseUrlRuntimeImports, getBodiesByContentType, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getImportExtension, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, getWarningCount, isBinaryContentType, isBoolean, isComponentRef, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, 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, BaseUrlRuntime, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, CommonMockOptions, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, DefaultTag, EnumGeneration, ErrorWithTag, FakerMockOptions, FetchOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMockOutput, GeneratorMockOutputFull, 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, InvalidateTargetParam, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, McpOptions, McpServerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MswMockOptions, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NAMED_COMPONENT_SECTIONS, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, NormalizedMocksConfig, 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, OutputMocksConfig, OutputMocksOption, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, ReadonlyRequestBodiesMode, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SupportedFormatter, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigModule, TsConfigModuleResolution, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, addDependency, asyncReduce, buildAngularParamsFilterExpression, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, filteredVerbs, 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, getBaseUrlRuntimeImports, getBodiesByContentType, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getImportExtension, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, getWarningCount, isBinaryContentType, isBoolean, isComponentRef, isDirectory, isFakerMock, isFunction, isModule, isMswMock, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, makeRouteSafe, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, wrapRouteParameters, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
 //# sourceMappingURL=index.d.mts.map