@orval/core 6.28.2 → 6.29.0

package/dist/index.d.ts

@@ -48,6 +48,7 @@ type NormalizedOutputOptions = {
     allParamsOptional: boolean;
     urlEncodeParameters: boolean;
     unionAddMissingProperties: boolean;
+    optionsParamRequired: boolean;
 };
 type NormalizedParamsSerializerOptions = {
     qs?: Record<string, any>;
@@ -98,6 +99,7 @@ type NormalizedOverrideOutput = {
     useBigInt?: boolean;
     useNamedParameters?: boolean;
     useNativeEnums?: boolean;
+    suppressReadonlyModifier?: boolean;
 };
 type NormalizedMutator = {
     path: string;
@@ -155,6 +157,7 @@ type OutputOptions = {
     allParamsOptional?: boolean;
     urlEncodeParameters?: boolean;
     unionAddMissingProperties?: boolean;
+    optionsParamRequired?: boolean;
 };
 type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
     validate?: boolean;
@@ -166,7 +169,7 @@ type InputOptions = {
     converterOptions?: swagger2openapi.Options;
     parserOptions?: SwaggerParserOptions;
     filters?: {
-        tags?: string[];
+        tags?: (string | RegExp)[];
     };
 };
 declare const OutputClient: {
@@ -196,7 +199,7 @@ type GlobalMockOptions = {
     type: OutputMockType;
     useExamples?: boolean;
     generateEachHttpStatus?: boolean;
-    delay?: number | (() => number);
+    delay?: false | number | (() => number);
     delayFunctionLazyExecute?: boolean;
     baseUrl?: string;
     locale?: keyof typeof allLocales;
@@ -286,6 +289,7 @@ type OverrideOutput = {
     useBigInt?: boolean;
     useNamedParameters?: boolean;
     useNativeEnums?: boolean;
+    suppressReadonlyModifier?: boolean;
 };
 type OverrideOutputContentType = {
     include?: string[];
@@ -293,6 +297,7 @@ type OverrideOutputContentType = {
 };
 type NormalizedHonoOptions = {
     handlers?: string;
+    validator: boolean | 'hono';
 };
 type ZodOptions = {
     strict?: {
@@ -303,13 +308,21 @@ type ZodOptions = {
         response?: boolean;
     };
     coerce?: {
-        param?: boolean;
-        query?: boolean;
-        header?: boolean;
-        body?: boolean;
-        response?: boolean;
+        param?: boolean | ZodCoerceType[];
+        query?: boolean | ZodCoerceType[];
+        header?: boolean | ZodCoerceType[];
+        body?: boolean | ZodCoerceType[];
+        response?: boolean | ZodCoerceType[];
+    };
+    preprocess?: {
+        param?: Mutator;
+        query?: Mutator;
+        header?: Mutator;
+        body?: Mutator;
+        response?: Mutator;
     };
 };
+type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
 type NormalizedZodOptions = {
     strict: {
         param: boolean;
@@ -319,15 +332,23 @@ type NormalizedZodOptions = {
         response: boolean;
     };
     coerce: {
-        param: boolean;
-        query: boolean;
-        header: boolean;
-        body: boolean;
-        response: boolean;
+        param: boolean | ZodCoerceType[];
+        query: boolean | ZodCoerceType[];
+        header: boolean | ZodCoerceType[];
+        body: boolean | ZodCoerceType[];
+        response: boolean | ZodCoerceType[];
+    };
+    preprocess: {
+        param?: NormalizedMutator;
+        query?: NormalizedMutator;
+        header?: NormalizedMutator;
+        body?: NormalizedMutator;
+        response?: NormalizedMutator;
     };
 };
 type HonoOptions = {
     handlers?: string;
+    validator?: boolean | 'hono';
 };
 type NormalizedQueryOptions = {
     useQuery?: boolean;
@@ -342,6 +363,8 @@ type NormalizedQueryOptions = {
     queryOptions?: NormalizedMutator;
     mutationOptions?: NormalizedMutator;
     shouldExportMutatorHooks?: boolean;
+    shouldExportHttpClient?: boolean;
+    shouldExportQueryKey?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
@@ -358,6 +381,8 @@ type QueryOptions = {
     queryOptions?: Mutator;
     mutationOptions?: Mutator;
     shouldExportMutatorHooks?: boolean;
+    shouldExportHttpClient?: boolean;
+    shouldExportQueryKey?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
@@ -607,10 +632,16 @@ type ClientFooterBuilder = (params: {
 }) => string;
 type ClientTitleBuilder = (title: string) => string;
 type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson) => GeneratorDependency[];
-type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => {
-    imports: string[];
-    implementation: string;
+type ClientMockGeneratorImplementation = {
+    function: string;
+    handlerName: string;
+    handler: string;
+};
+type ClientMockGeneratorBuilder = {
+    imports: GeneratorImport[];
+    implementation: ClientMockGeneratorImplementation;
 };
+type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => ClientMockGeneratorBuilder;
 interface ClientGeneratorsBuilder {
     client: ClientBuilder;
     header?: ClientHeaderBuilder;
@@ -1348,4 +1379,4 @@ declare const generateTarget: (builder: WriteSpecsBuilder, options: NormalizedOu
 
 declare const generateTargetForTags: (builder: WriteSpecsBuilder, options: NormalizedOutputOptions) => Record<string, GeneratorTarget>;
 
-export { type AngularOptions, BODY_TYPE_NAME, type ClientBuilder, type ClientDependenciesBuilder, type ClientExtraFilesBuilder, type ClientFileBuilder, 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 HonoOptions, type Hook, type HookCommand, type HookFunction, type HookOption, type HooksOptions, type ImportOpenApi, type InputOptions, type InputTransformerFn, type LogLevel, LogLevels, type LogOptions, type LogType, type Logger, type LoggerOptions, type MockData, type MockDataArray, type MockDataArrayFn, type MockDataObject, type MockDataObjectFn, type MockOptions, type MockProperties, type MockPropertiesObject, type MockPropertiesObjectFn, type Mutator, type MutatorObject, type NormalizedConfig, type NormalizedHonoOptions, type NormalizedHookCommand, type NormalizedHookOptions, type NormalizedInputOptions, type NormalizedMutator, type NormalizedOperationOptions, type NormalizedOptions, type NormalizedOutputOptions, type NormalizedOverrideOutput, type NormalizedParamsSerializerOptions, type NormalizedQueryOptions, type NormalizedZodOptions, 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 SwrOptions, type TsConfigTarget, type Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, type WriteModeProps, type WriteSpecsBuilder, type ZodOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, count, createDebugger, createLogger, createSuccessMessage, dynamicImport, 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, logError, 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 ClientExtraFilesBuilder, type ClientFileBuilder, type ClientFooterBuilder, type ClientGeneratorsBuilder, type ClientHeaderBuilder, type ClientMockBuilder, type ClientMockGeneratorBuilder, type ClientMockGeneratorImplementation, 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 HonoOptions, type Hook, type HookCommand, type HookFunction, type HookOption, type HooksOptions, type ImportOpenApi, type InputOptions, type InputTransformerFn, type LogLevel, LogLevels, type LogOptions, type LogType, type Logger, type LoggerOptions, type MockData, type MockDataArray, type MockDataArrayFn, type MockDataObject, type MockDataObjectFn, type MockOptions, type MockProperties, type MockPropertiesObject, type MockPropertiesObjectFn, type Mutator, type MutatorObject, type NormalizedConfig, type NormalizedHonoOptions, type NormalizedHookCommand, type NormalizedHookOptions, type NormalizedInputOptions, type NormalizedMutator, type NormalizedOperationOptions, type NormalizedOptions, type NormalizedOutputOptions, type NormalizedOverrideOutput, type NormalizedParamsSerializerOptions, type NormalizedQueryOptions, type NormalizedZodOptions, 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 SwrOptions, type TsConfigTarget, type Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, type WriteModeProps, type WriteSpecsBuilder, type ZodCoerceType, type ZodOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, count, createDebugger, createLogger, createSuccessMessage, dynamicImport, 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, logError, 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 };

package/dist/index.js

@@ -15487,13 +15487,13 @@ function destroyStream(stream, err) {
     stream.end();
   }
 }
-var import_stream, import_http, import_url, import_whatwg_url, import_https, import_zlib, Readable, BUFFER, TYPE, Blob, convert, INTERNALS, PassThrough, invalidTokenRegex, invalidHeaderCharRegex, MAP, Headers, INTERNAL, HeadersIteratorPrototype, INTERNALS$1, STATUS_CODES, Response, INTERNALS$2, URL2, parse_url, format_url, streamDestructionSupported, Request, URL$1, PassThrough$1, isDomainOrSubdomain, isSameProtocol, lib_default;
+var import_stream, import_http, import_url2, import_whatwg_url, import_https, import_zlib, Readable, BUFFER, TYPE, Blob, convert, INTERNALS, PassThrough, invalidTokenRegex, invalidHeaderCharRegex, MAP, Headers, INTERNAL, HeadersIteratorPrototype, INTERNALS$1, STATUS_CODES, Response, INTERNALS$2, URL2, parse_url, format_url, streamDestructionSupported, Request, URL$1, PassThrough$1, isDomainOrSubdomain, isSameProtocol, lib_default;
 var init_lib = __esm({
   "../../node_modules/node-fetch/lib/index.mjs"() {
     "use strict";
     import_stream = __toESM(require("stream"), 1);
     import_http = __toESM(require("http"), 1);
-    import_url = __toESM(require("url"), 1);
+    import_url2 = __toESM(require("url"), 1);
     import_whatwg_url = __toESM(require_public_api(), 1);
     import_https = __toESM(require("https"), 1);
     import_zlib = __toESM(require("zlib"), 1);
@@ -16011,9 +16011,9 @@ var init_lib = __esm({
       configurable: true
     });
     INTERNALS$2 = Symbol("Request internals");
-    URL2 = import_url.default.URL || import_whatwg_url.default.URL;
-    parse_url = import_url.default.parse;
-    format_url = import_url.default.format;
+    URL2 = import_url2.default.URL || import_whatwg_url.default.URL;
+    parse_url = import_url2.default.parse;
+    format_url = import_url2.default.format;
     streamDestructionSupported = "destroy" in import_stream.default.Readable.prototype;
     Request = class _Request {
       constructor(input) {
@@ -16106,7 +16106,7 @@ var init_lib = __esm({
     AbortError.prototype = Object.create(Error.prototype);
     AbortError.prototype.constructor = AbortError;
     AbortError.prototype.name = "AbortError";
-    URL$1 = import_url.default.URL || import_whatwg_url.default.URL;
+    URL$1 = import_url2.default.URL || import_whatwg_url.default.URL;
     PassThrough$1 = import_stream.default.PassThrough;
     isDomainOrSubdomain = function isDomainOrSubdomain2(destination, original) {
       const orig = new URL$1(original).hostname;
@@ -40735,6 +40735,7 @@ ${tryOneLine ? "  " : ""} *`;
 }
 
 // src/utils/dynamic-import.ts
+var import_url = require("url");
 var dynamicImport = async (toImport, from = process.cwd(), takeDefault = true) => {
   if (!toImport) {
     return toImport;
@@ -40742,7 +40743,8 @@ var dynamicImport = async (toImport, from = process.cwd(), takeDefault = true) =
   try {
     if (isString2(toImport)) {
       const path2 = resolve2(from, toImport);
-      const data = await import(path2);
+      const fileUrl = (0, import_url.pathToFileURL)(path2);
+      const data = await import(fileUrl.href);
       if (takeDefault && (isObject(data) || isModule(data)) && data.default) {
         return data.default;
       }
@@ -41379,7 +41381,7 @@ var getArray = ({
       context
     });
     return {
-      value: `${schema.readOnly === true ? "readonly " : ""}${resolvedObject.value.includes("|") ? `(${resolvedObject.value})[]` : `${resolvedObject.value}[]`}`,
+      value: `${schema.readOnly === true && !context.output.override.suppressReadonlyModifier ? "readonly " : ""}${resolvedObject.value.includes("|") ? `(${resolvedObject.value})[]` : `${resolvedObject.value}[]`}`,
       imports: resolvedObject.imports,
       schemas: resolvedObject.schemas,
       isEnum: false,
@@ -41810,7 +41812,7 @@ var getObject = ({
         acc.hasReadonlyProps ||= isReadOnly || false;
         acc.imports.push(...resolvedValue.imports);
         acc.value += `
-  ${doc ? `${doc}  ` : ""}${isReadOnly ? "readonly " : ""}${getKey(key)}${isRequired ? "" : "?"}: ${resolvedValue.value};`;
+  ${doc ? `${doc}  ` : ""}${isReadOnly && !context.output.override.suppressReadonlyModifier ? "readonly " : ""}${getKey(key)}${isRequired ? "" : "?"}: ${resolvedValue.value};`;
         acc.schemas.push(...resolvedValue.schemas);
         if (arr.length - 1 === index3) {
           if (item.additionalProperties) {
@@ -42125,19 +42127,29 @@ var combineSchemas = ({
     context
   });
   if (isAllEnums && name && items.length > 1) {
-    const newEnum = `
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
+    const newEnum = `// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ${pascal(
       name
-    )} = ${getCombineEnumValue(resolvedData)}`;
+    )} = ${getCombineEnumValue(resolvedData)};
+`;
     return {
-      value: `typeof ${pascal(name)}[keyof typeof ${pascal(name)}] ${nullable};` + newEnum,
-      imports: resolvedData.imports.map((toImport) => ({
-        ...toImport,
-        values: true
-      })),
-      schemas: resolvedData.schemas,
+      value: `typeof ${pascal(name)}[keyof typeof ${pascal(name)}] ${nullable}`,
+      imports: [
+        {
+          name: pascal(name)
+        }
+      ],
+      schemas: [
+        ...resolvedData.schemas,
+        {
+          imports: resolvedData.imports.map((toImport) => ({
+            ...toImport,
+            values: true
+          })),
+          model: newEnum,
+          name: pascal(name)
+        }
+      ],
       isEnum: false,
       type: "object",
       isRef: false,
@@ -43743,32 +43755,31 @@ ${exports2}`;
 
 // src/writers/types.ts
 var getOrvalGeneratedTypes = () => `
-type IsAny<T> = 0 extends 1 & T ? true : false;
-type IsUnknown<T> = IsAny<T> extends true ? false : unknown extends T ? true : false;
-type Primitive = string | number | boolean | bigint | symbol | undefined | null;
-type isBuiltin = Primitive | Function | Date | Error | RegExp;
-type NonReadonly<T> =
-  T extends Exclude<isBuiltin, Error>
-  ? T
-  : T extends Map<infer Key, infer Value>
-  ? Map<NonReadonly<Key>, NonReadonly<Value>>
-  : T extends ReadonlyMap<infer Key, infer Value>
-  ? Map<NonReadonly<Key>, NonReadonly<Value>>
-  : T extends WeakMap<infer Key, infer Value>
-  ? WeakMap<NonReadonly<Key>, NonReadonly<Value>>
-  : T extends Set<infer Values>
-  ? Set<NonReadonly<Values>>
-  : T extends ReadonlySet<infer Values>
-  ? Set<NonReadonly<Values>>
-  : T extends WeakSet<infer Values>
-  ? WeakSet<NonReadonly<Values>>
-  : T extends Promise<infer Value>
-  ? Promise<NonReadonly<Value>>
-  : T extends {}
-  ? { -readonly [Key in keyof T]: NonReadonly<T[Key]> }
-  : IsUnknown<T> extends true
-  ? unknown
-  : T;
+// https://stackoverflow.com/questions/49579094/typescript-conditional-types-filter-out-readonly-properties-pick-only-requir/49579497#49579497
+type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends <
+T,
+>() => T extends Y ? 1 : 2
+? A
+: B;
+
+type WritableKeys<T> = {
+[P in keyof T]-?: IfEquals<
+  { [Q in P]: T[P] },
+  { -readonly [Q in P]: T[P] },
+  P
+>;
+}[keyof T];
+
+type UnionToIntersection<U> =
+  (U extends any ? (k: U)=>void : never) extends ((k: infer I)=>void) ? I : never;
+type DistributeReadOnlyOverUnions<T> = T extends any ? NonReadonly<T> : never;
+
+type Writable<T> = Pick<T, WritableKeys<T>>;
+type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
+  [P in keyof Writable<T>]: T[P] extends object
+    ? NonReadonly<NonNullable<T[P]>>
+    : T[P];
+} : DistributeReadOnlyOverUnions<T>;
 `;
 
 // src/writers/single-mode.ts