@orval/core 6.20.0 → 6.21.0

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import SwaggerParser from '@apidevtools/swagger-parser';
 import * as openapi3_ts from 'openapi3-ts';
 import { InfoObject, OperationObject, OpenAPIObject, ResponsesObject, ReferenceObject, RequestBodyObject, ParameterObject, SchemaObject, ComponentsObject, SchemasObject, PathItemObject, ResponseObject, ExampleObject } from 'openapi3-ts';
 import swagger2openapi from 'swagger2openapi';
+import { allLocales } from '@faker-js/faker';
 import { CompareOperator } from 'compare-versions';
 import debug from 'debug';
 
@@ -30,7 +31,7 @@ type NormalizedOutputOptions = {
     target?: string;
     schemas?: string;
     mode: OutputMode;
-    mock: boolean | ClientMSWBuilder;
+    mock?: GlobalMockOptions | ClientMockBuilder;
     override: NormalizedOverrideOutput;
     client: OutputClient | OutputClientFunc;
     clean: boolean | string[];
@@ -55,18 +56,7 @@ type NormalizedOverrideOutput = {
     tags: {
         [key: string]: NormalizedOperationOptions;
     };
-    mock?: {
-        arrayMin?: number;
-        arrayMax?: number;
-        properties?: MockProperties;
-        format?: {
-            [key: string]: unknown;
-        };
-        required?: boolean;
-        baseUrl?: string;
-        delay?: number | (() => number);
-        useExamples?: boolean;
-    };
+    mock?: OverrideMockOptions;
     contentType?: OverrideOutputContentType;
     header: false | ((info: InfoObject) => string[] | string);
     formData: boolean | NormalizedMutator;
@@ -95,10 +85,12 @@ type NormalizedOverrideOutput = {
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions: Record<string, any> | boolean;
     useDates?: boolean;
+    coerceTypes?: boolean;
     useTypeOverInterfaces?: boolean;
     useDeprecatedOperations?: boolean;
     useBigInt?: boolean;
     useNamedParameters?: boolean;
+    useNativeEnums?: boolean;
 };
 type NormalizedMutator = {
     path: string;
@@ -141,7 +133,7 @@ type OutputOptions = {
     target?: string;
     schemas?: string;
     mode?: OutputMode;
-    mock?: boolean | ClientMSWBuilder;
+    mock?: boolean | GlobalMockOptions | ClientMockBuilder;
     override?: OverrideOutput;
     client?: OutputClient | OutputClientFunc;
     clean?: boolean | string[];
@@ -166,33 +158,47 @@ type InputOptions = {
         tags?: string[];
     };
 };
-type OutputClient = 'axios' | 'axios-functions' | 'angular' | 'react-query' | 'svelte-query' | 'vue-query' | 'swr' | 'zod';
 declare const OutputClient: {
-    ANGULAR: OutputClient;
-    AXIOS: OutputClient;
-    AXIOS_FUNCTIONS: OutputClient;
-    REACT_QUERY: OutputClient;
-    SVELTE_QUERY: OutputClient;
-    VUE_QUERY: OutputClient;
+    readonly ANGULAR: "angular";
+    readonly AXIOS: "axios";
+    readonly AXIOS_FUNCTIONS: "axios-functions";
+    readonly REACT_QUERY: "react-query";
+    readonly SVELTE_QUERY: "svelte-query";
+    readonly VUE_QUERY: "vue-query";
 };
-type OutputMode = 'single' | 'split' | 'tags' | 'tags-split';
+type OutputClient = typeof OutputClient[keyof typeof OutputClient];
 declare const OutputMode: {
-    SINGLE: OutputMode;
-    SPLIT: OutputMode;
-    TAGS: OutputMode;
-    TAGS_SPLIT: OutputMode;
+    readonly SINGLE: "single";
+    readonly SPLIT: "split";
+    readonly TAGS: "tags";
+    readonly TAGS_SPLIT: "tags-split";
+};
+type OutputMode = typeof OutputMode[keyof typeof OutputMode];
+declare const OutputMockType: {
+    readonly MSW: "msw";
+};
+type OutputMockType = typeof OutputMockType[keyof typeof OutputMockType];
+type GlobalMockOptions = {
+    type: OutputMockType;
+    useExamples?: boolean;
+    delay?: number | (() => number);
+    baseUrl?: string;
+    locale?: keyof typeof allLocales;
 };
-type MockOptions = {
+type OverrideMockOptions = Partial<GlobalMockOptions> & {
     arrayMin?: number;
     arrayMax?: number;
     required?: boolean;
-    properties?: Record<string, string>;
+    properties?: MockProperties;
+    format?: Record<string, unknown>;
+};
+type MockOptions = Omit<OverrideMockOptions, 'properties'> & {
+    properties?: Record<string, unknown>;
     operations?: Record<string, {
-        properties: Record<string, string>;
+        properties: Record<string, unknown>;
     }>;
-    format?: Record<string, string>;
     tags?: Record<string, {
-        properties: Record<string, string>;
+        properties: Record<string, unknown>;
     }>;
 };
 type MockProperties = {
@@ -222,18 +228,7 @@ type OverrideOutput = {
     tags?: {
         [key: string]: OperationOptions;
     };
-    mock?: {
-        arrayMin?: number;
-        arrayMax?: number;
-        properties?: MockProperties;
-        format?: {
-            [key: string]: unknown;
-        };
-        required?: boolean;
-        baseUrl?: string;
-        delay?: number;
-        useExamples?: boolean;
-    };
+    mock?: OverrideMockOptions;
     contentType?: OverrideOutputContentType;
     header?: boolean | ((info: InfoObject) => string[] | string);
     formData?: boolean | Mutator;
@@ -266,6 +261,7 @@ type OverrideOutput = {
     useDeprecatedOperations?: boolean;
     useBigInt?: boolean;
     useNamedParameters?: boolean;
+    useNativeEnums?: boolean;
 };
 type OverrideOutputContentType = {
     include?: string[];
@@ -366,7 +362,7 @@ interface GlobalOptions {
     clean?: boolean | string[];
     prettier?: boolean;
     tslint?: boolean;
-    mock?: boolean;
+    mock?: boolean | GlobalMockOptions;
     client?: OutputClient;
     mode?: OutputMode;
     tsconfig?: string | Tsconfig;
@@ -417,8 +413,8 @@ type GeneratorOperations = {
 type GeneratorTarget = {
     imports: GeneratorImport[];
     implementation: string;
-    implementationMSW: string;
-    importsMSW: GeneratorImport[];
+    implementationMock: string;
+    importsMock: GeneratorImport[];
     mutators?: GeneratorMutator[];
     clientMutators?: GeneratorMutator[];
     formData?: GeneratorMutator[];
@@ -428,11 +424,11 @@ type GeneratorTarget = {
 type GeneratorTargetFull = {
     imports: GeneratorImport[];
     implementation: string;
-    implementationMSW: {
+    implementationMock: {
         function: string;
         handler: string;
     };
-    importsMSW: GeneratorImport[];
+    importsMock: GeneratorImport[];
     mutators?: GeneratorMutator[];
     clientMutators?: GeneratorMutator[];
     formData?: GeneratorMutator[];
@@ -442,11 +438,11 @@ type GeneratorTargetFull = {
 type GeneratorOperation = {
     imports: GeneratorImport[];
     implementation: string;
-    implementationMSW: {
+    implementationMock: {
         function: string;
         handler: string;
     };
-    importsMSW: GeneratorImport[];
+    importsMock: GeneratorImport[];
     tags: string[];
     mutator?: GeneratorMutator;
     clientMutators?: GeneratorMutator[];
@@ -485,7 +481,7 @@ type GeneratorOptions = {
     pathRoute: string;
     override: NormalizedOverrideOutput;
     context: ContextSpecs;
-    mock: boolean;
+    mock?: GlobalMockOptions | ClientMockBuilder;
     output: string;
 };
 type GeneratorClient = {
@@ -527,7 +523,7 @@ type ClientFooterBuilder = (params: {
 }) => string;
 type ClientTitleBuilder = (title: string) => string;
 type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson) => GeneratorDependency[];
-type ClientMSWBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => {
+type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => {
     imports: string[];
     implementation: string;
 };
@@ -676,7 +672,7 @@ type GeneratorApiOperations = {
 };
 type GeneratorClientExtra = {
     implementation: string;
-    implementationMSW: string;
+    implementationMock: string;
 };
 type GeneratorClientTitle = (data: {
     outputClient?: OutputClient | OutputClientFunc;
@@ -722,6 +718,7 @@ type GenerateMockImports = (data: {
     specsName: Record<string, string>;
     hasSchemaDir: boolean;
     isAllowSyntheticDefaultImports: boolean;
+    options?: GlobalMockOptions;
 }) => string;
 type GeneratorApiBuilder = GeneratorApiOperations & {
     title: GeneratorClientTitle;
@@ -874,7 +871,7 @@ declare const combineSchemas: ({ name, schema, separator, context, nullable, }:
 
 declare const resolveDiscriminators: (schemas: SchemasObject, context: ContextSpecs) => SchemasObject;
 
-declare const getEnum: (value: string, enumName: string, names?: string[]) => string;
+declare const getEnum: (value: string, enumName: string, names?: string[], useNativeEnums?: boolean) => string;
 declare const getEnumImplementation: (value: string, names?: string[]) => string;
 
 declare const getKey: (key: string) => string;
@@ -1119,6 +1116,8 @@ declare function loadFile<File = any>(filePath?: string, options?: {
 }>;
 declare function removeFiles(patterns: string[], dir: string): Promise<void>;
 
+declare const getMockFileExtensionByTypeName: (mock: GlobalMockOptions | ClientMockBuilder) => string;
+
 declare function mergeDeep<T extends Record<string, any>>(source: T, target: T): T;
 
 declare const count: (str: string | undefined, key: string) => number;
@@ -1155,20 +1154,7 @@ declare const path_relativeSafe: typeof relativeSafe;
 declare const path_resolve: typeof resolve;
 declare const path_separator: typeof separator;
 declare namespace path {
-  export {
-    path_basename as basename,
-    path_dirname as dirname,
-    path_extname as extname,
-    path_getSchemaFileName as getSchemaFileName,
-    path_getSpecName as getSpecName,
-    path_isAbsolute as isAbsolute,
-    path_join as join,
-    path_joinSafe as joinSafe,
-    path_normalizeSafe as normalizeSafe,
-    path_relativeSafe as relativeSafe,
-    path_resolve as resolve,
-    path_separator as separator,
-  };
+  export { path_basename as basename, path_dirname as dirname, path_extname as extname, path_getSchemaFileName as getSchemaFileName, path_getSpecName as getSpecName, path_isAbsolute as isAbsolute, path_join as join, path_joinSafe as joinSafe, path_normalizeSafe as normalizeSafe, path_relativeSafe as relativeSafe, path_resolve as resolve, path_separator as separator };
 }
 
 declare const sortByPriority: <T>(arr: (T & {
@@ -1250,4 +1236,4 @@ declare const generateTarget: (builder: WriteSpecsBuilder, options: NormalizedOu
 
 declare const generateTargetForTags: (builder: WriteSpecsBuilder, options: NormalizedOutputOptions) => Record<string, GeneratorTarget>;
 
-export { AngularOptions, BODY_TYPE_NAME, ClientBuilder, ClientDependenciesBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMSWBuilder, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContextSpecs, GenerateMockImports, 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, GlobalOptions, Hook, HookCommand, HookFunction, HooksOptions, ImportOpenApi, InputOptions, InputTransformerFn, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockOptions, MockProperties, Mutator, MutatorObject, NormalizedConfig, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputMode, OutputOptions, OverrideInput, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ScalarValue, SchemaType, SwaggerParserOptions, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecsBuilder, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, count, createDebugger, createLogger, createSuccessMessage, dynamicImport, errorMessage, escape, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbsOptions, getArray, getBody, getEnum, getEnumImplementation, getExtension, getFileInfo, getKey, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getRoute, getRouteAsArray, getScalar, ibmOpenapiValidator, ibmOpenapiValidatorErrors, ibmOpenapiValidatorWarnings, isBoolean, isDirectory, isFunction, isModule, isNull, isNumber, isNumeric, isObject, isReference, isRootKey, isSchema, isString, isSyntheticDefaultImportsAllow, isUndefined, isUrl, isVerb, jsDoc, jsStringEscape, kebab, loadFile, log, mergeDeep, mismatchArgsMessage, openApiConverter, pascal, removeFiles, resolveDiscriminators, resolveExampleRefs, resolveObject, resolveRef, resolveValue, sanitize, snake, sortByPriority, startMessage, stringify, toObjectString, path as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
+export { type AngularOptions, BODY_TYPE_NAME, type ClientBuilder, type ClientDependenciesBuilder, type ClientFooterBuilder, type ClientGeneratorsBuilder, type ClientHeaderBuilder, type ClientMockBuilder, type ClientTitleBuilder, type Config, type ConfigExternal, type ConfigFn, type ContextSpecs, type GenerateMockImports, type GeneratorApiBuilder, type GeneratorApiOperations, type GeneratorApiResponse, type GeneratorClient, type GeneratorClientExtra, type GeneratorClientFooter, type GeneratorClientHeader, type GeneratorClientImports, type GeneratorClientTitle, type GeneratorClients, type GeneratorDependency, type GeneratorImport, type GeneratorMutator, type GeneratorMutatorParsingInfo, type GeneratorOperation, type GeneratorOperations, type GeneratorOptions, type GeneratorSchema, type GeneratorTarget, type GeneratorTargetFull, type GeneratorVerbOptions, type GeneratorVerbsOptions, type GetterBody, type GetterParam, type GetterParameters, type GetterParams, type GetterProp, GetterPropType, type GetterProps, type GetterQueryParam, type GetterResponse, type GlobalMockOptions, type GlobalOptions, type Hook, type HookCommand, type HookFunction, type HooksOptions, type ImportOpenApi, type InputOptions, type InputTransformerFn, type LogLevel, LogLevels, type LogOptions, type LogType, type Logger, type LoggerOptions, type MockOptions, type MockProperties, type Mutator, type MutatorObject, type NormalizedConfig, type NormalizedHookCommand, type NormalizedHookOptions, type NormalizedInputOptions, type NormalizedMutator, type NormalizedOperationOptions, type NormalizedOptions, type NormalizedOutputOptions, type NormalizedOverrideOutput, type NormalizedParamsSerializerOptions, type NormalizedQueryOptions, type OperationOptions, type Options, type OptionsExport, type OptionsFn, OutputClient, type OutputClientFunc, OutputMockType, OutputMode, type OutputOptions, type OverrideInput, type OverrideMockOptions, type OverrideOutput, type OverrideOutputContentType, type PackageJson, type ParamsSerializerOptions, type QueryOptions, RefComponentSuffix, type RefInfo, type ResReqTypesValue, type ResolverValue, type ScalarValue, SchemaType, type SwaggerParserOptions, type TsConfigTarget, type Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, type WriteModeProps, type WriteSpecsBuilder, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, count, createDebugger, createLogger, createSuccessMessage, dynamicImport, errorMessage, escape, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbsOptions, getArray, getBody, getEnum, getEnumImplementation, getExtension, getFileInfo, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getRoute, getRouteAsArray, getScalar, ibmOpenapiValidator, ibmOpenapiValidatorErrors, ibmOpenapiValidatorWarnings, isBoolean, isDirectory, isFunction, isModule, isNull, isNumber, isNumeric, isObject, isReference, isRootKey, isSchema, isString, isSyntheticDefaultImportsAllow, isUndefined, isUrl, isVerb, jsDoc, jsStringEscape, kebab, loadFile, log, mergeDeep, mismatchArgsMessage, openApiConverter, pascal, removeFiles, resolveDiscriminators, resolveExampleRefs, resolveObject, resolveRef, resolveValue, sanitize, snake, sortByPriority, startMessage, stringify, toObjectString, path as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };