@orval/core 7.6.0 → 7.8.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import * as openapi3_ts_oas30 from 'openapi3-ts/oas30';
 import { InfoObject, OperationObject, OpenAPIObject, ResponsesObject, ReferenceObject, RequestBodyObject, ParameterObject, SchemaObject, ComponentsObject, SchemasObject, PathItemObject, ResponseObject, ExampleObject } from 'openapi3-ts/oas30';
 import swagger2openapi from 'swagger2openapi';
 import { TypeDocOptions } from 'typedoc';
+import { SchemaObject as SchemaObject$1 } from 'openapi3-ts/dist/model/openapi30';
 import { ValueIteratee } from 'lodash';
 import { ServerObject } from 'openapi3-ts/oas31';
 import { CompareOperator } from 'compare-versions';
@@ -353,6 +354,11 @@ type NormalizedHonoOptions = {
     validator: boolean | 'hono';
     validatorOutputPath: string;
 };
+type ZodDateTimeOptions = {
+    offset?: boolean;
+    local?: boolean;
+    precision?: number;
+};
 type ZodOptions = {
     strict?: {
         param?: boolean;
@@ -382,6 +388,7 @@ type ZodOptions = {
         body?: Mutator;
         response?: Mutator;
     };
+    dateTimeOptions?: ZodDateTimeOptions;
     generateEachHttpStatus?: boolean;
 };
 type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
@@ -415,6 +422,7 @@ type NormalizedZodOptions = {
         response?: NormalizedMutator;
     };
     generateEachHttpStatus: boolean;
+    dateTimeOptions: ZodDateTimeOptions;
 };
 type HonoOptions = {
     handlers?: string;
@@ -437,6 +445,7 @@ type NormalizedQueryOptions = {
     shouldExportMutatorHooks?: boolean;
     shouldExportHttpClient?: boolean;
     shouldExportQueryKey?: boolean;
+    shouldSplitQueryKey?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
@@ -455,6 +464,7 @@ type QueryOptions = {
     shouldExportMutatorHooks?: boolean;
     shouldExportHttpClient?: boolean;
     shouldExportQueryKey?: boolean;
+    shouldSplitQueryKey?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
@@ -1087,6 +1097,7 @@ declare const combineSchemas: ({ name, schema, separator, context, nullable, }:
 
 declare const resolveDiscriminators: (schemas: SchemasObject, context: ContextSpecs) => SchemasObject;
 
+declare const getEnumNames: (schemaObject: SchemaObject$1 | undefined) => any;
 declare const getEnum: (value: string, enumName: string, names?: string[], useNativeEnums?: boolean) => string;
 declare const getEnumImplementation: (value: string, names?: string[]) => string;
 
@@ -1471,4 +1482,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 BaseUrlFromConstant, type BaseUrlFromSpec, 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 FetchOptions, 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 InputFiltersOption, 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, NamingConvention, 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, type OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, type OutputOptions, type OverrideInput, type OverrideMockOptions, type OverrideOutput, type OverrideOutputContentType, type PackageJson, type ParamsSerializerOptions, PropertySortOrder, type QueryOptions, RefComponentSuffix, type RefInfo, type ResReqTypesValue, type ResolverValue, type ScalarValue, SchemaType, type SchemaWithConst, type SwaggerParserOptions, type SwrOptions, TEMPLATE_TAG_REGEX, type TsConfigTarget, type Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, type WriteModeProps, type WriteSpecsBuilder, type ZodCoerceType, type ZodOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, 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, getFullRoute, getIsBodyVerb, 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 BaseUrlFromConstant, type BaseUrlFromSpec, 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 FetchOptions, 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 InputFiltersOption, 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, NamingConvention, 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, type OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, type OutputOptions, type OverrideInput, type OverrideMockOptions, type OverrideOutput, type OverrideOutputContentType, type PackageJson, type ParamsSerializerOptions, PropertySortOrder, type QueryOptions, RefComponentSuffix, type RefInfo, type ResReqTypesValue, type ResolverValue, type ScalarValue, SchemaType, type SchemaWithConst, type SwaggerParserOptions, type SwrOptions, TEMPLATE_TAG_REGEX, type TsConfigTarget, type Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, type WriteModeProps, type WriteSpecsBuilder, type ZodCoerceType, type ZodDateTimeOptions, type ZodOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, 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, getEnumNames, getExtension, getFileInfo, getFullRoute, getIsBodyVerb, 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

@@ -48171,6 +48171,7 @@ __export(src_exports, {
   getBody: () => getBody,
   getEnum: () => getEnum,
   getEnumImplementation: () => getEnumImplementation,
+  getEnumNames: () => getEnumNames,
   getExtension: () => getExtension,
   getFileInfo: () => getFileInfo,
   getFullRoute: () => getFullRoute,
@@ -49419,6 +49420,9 @@ var ibmOpenapiValidator = async (specs, validation) => {
 var getIsBodyVerb = (verb) => VERBS_WITH_BODY.includes(verb);
 
 // src/getters/enum.ts
+var getEnumNames = (schemaObject) => {
+  return schemaObject?.["x-enumNames"] || schemaObject?.["x-enumnames"] || schemaObject?.["x-enum-varnames"];
+};
 var getEnum = (value, enumName, names, useNativeEnums) => {
   const enumValue = useNativeEnums ? getNativeEnum(value, enumName, names) : getTypeConstEnum(value, enumName, names);
   return enumValue;
@@ -49746,11 +49750,11 @@ var resolveObjectOriginal = ({
     const enumValue = getEnum(
       resolvedValue.value,
       propName,
-      resolvedValue.originalSchema?.["x-enumNames"],
+      getEnumNames(resolvedValue.originalSchema),
       context.output.override.useNativeEnums
     );
     return {
-      value: context.output.override.useNativeEnums ? `(keyof typeof ${propName})` : propName,
+      value: propName,
       imports: [{ name: propName }],
       schemas: [
         ...resolvedValue.schemas,
@@ -50369,7 +50373,7 @@ var getObject = ({
         acc.hasReadonlyProps ||= isReadOnly || false;
         acc.imports.push(...resolvedValue.imports);
         acc.value += `
-  ${doc ? `${doc}  ` : ""}${isReadOnly && !context.output.override.suppressReadonlyModifier ? "readonly " : ""}${getKey(key)}${isRequired ? "" : "?"}: ${resolvedValue.isEnum && context.output.override.useNativeEnums ? `(keyof typeof ${resolvedValue.value})` : 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) {
@@ -50622,7 +50626,16 @@ var combineValues = ({
     return `${resolvedData.values.join(` | `)}${resolvedValue ? ` | ${resolvedValue.value}` : ""}`;
   }
   if (separator2 === "allOf") {
-    const joined = `${resolvedData.values.join(` & `)}${resolvedValue ? ` & ${resolvedValue.value}` : ""}`;
+    let resolvedDataValue = resolvedData.values.join(` & `);
+    if (resolvedData.originalSchema.length > 0 && resolvedValue) {
+      const discriminatedPropertySchemas = resolvedData.originalSchema.filter(
+        (s2) => s2?.discriminator && resolvedValue.value.includes(` ${s2.discriminator.propertyName}:`)
+      );
+      if (discriminatedPropertySchemas.length > 0) {
+        resolvedDataValue = `Omit<${resolvedDataValue}, '${discriminatedPropertySchemas.map((s2) => s2.discriminator?.propertyName).join("' | '")}'>`;
+      }
+    }
+    const joined = `${resolvedDataValue}${resolvedValue ? ` & ${resolvedValue.value}` : ""}`;
     const overrideRequiredProperties = resolvedData.requiredProperties.filter(
       (prop) => !resolvedData.originalSchema.some(
         (schema) => schema && schema.properties?.[prop] && schema.required?.includes(prop)
@@ -50789,7 +50802,7 @@ var getCombineEnumValue = ({
     if (isRef[i3]) {
       return `...${e3},`;
     }
-    const names = originalSchema[i3]?.["x-enumNames"];
+    const names = getEnumNames(originalSchema[i3]);
     return getEnumImplementation(e3, names);
   }).join("");
   return `{${enums}} as const`;
@@ -51072,7 +51085,7 @@ var getQueryParamsTypes = (queryParams, operationName, context) => {
       const enumValue = getEnum(
         resolvedValue.value,
         enumName,
-        resolvedValue.originalSchema?.["x-enumNames"],
+        getEnumNames(resolvedValue.originalSchema),
         context.output.override.useNativeEnums
       );
       return {
@@ -51363,15 +51376,17 @@ var generateMutatorImports = ({
     acc += "\n";
     if (implementation && (mutator.hasErrorType || mutator.bodyTypeName)) {
       let errorImportName = "";
-      if (mutator.hasErrorType && implementation.includes(mutator.errorTypeName) && !acc.includes(mutator.errorTypeName)) {
-        errorImportName = mutator.default ? `ErrorType as ${mutator.errorTypeName}` : mutator.errorTypeName;
+      const targetErrorImportName = mutator.default ? `ErrorType as ${mutator.errorTypeName}` : mutator.errorTypeName;
+      if (mutator.hasErrorType && implementation.includes(mutator.errorTypeName) && !acc.includes(`{ ${targetErrorImportName} `)) {
+        errorImportName = targetErrorImportName;
       }
       let bodyImportName = "";
-      if (mutator.bodyTypeName && implementation.includes(mutator.bodyTypeName) && !acc.includes(mutator.bodyTypeName)) {
-        bodyImportName = mutator.default ? `BodyType as ${mutator.bodyTypeName}` : mutator.bodyTypeName;
+      const targetBodyImportName = mutator.default ? `BodyType as ${mutator.bodyTypeName}` : mutator.bodyTypeName;
+      if (mutator.bodyTypeName && implementation.includes(mutator.bodyTypeName) && !acc.includes(` ${targetBodyImportName} }`)) {
+        bodyImportName = targetBodyImportName;
       }
       if (bodyImportName || errorImportName) {
-        acc += `import type { ${errorImportName}${errorImportName && bodyImportName ? ", " : ""}${bodyImportName} } from '${path2}';`;
+        acc += `import type { ${errorImportName}${errorImportName && bodyImportName ? " , " : ""}${bodyImportName} } from '${path2}';`;
         acc += "\n";
       }
     }
@@ -52036,7 +52051,7 @@ var generateInterface = ({
     }
   }
   if (scalar.type === "object" && !context?.output.override?.useTypeOverInterfaces) {
-    if (scalar.type === "object" && schema.properties && Object.values(schema.properties).every((item) => "const" in item)) {
+    if (scalar.type === "object" && schema.properties && Object.values(schema.properties).length > 0 && Object.values(schema.properties).every((item) => "const" in item)) {
       const mappedScalarValue = scalar.value.replaceAll(";", ",");
       model += `export const ${name}Value = ${mappedScalarValue} as const;
 export type ${name} = typeof ${name}Value;
@@ -52111,7 +52126,7 @@ var generateSchemasDefinition = (schemas = {}, context, suffix, filters) => {
         output += getEnum(
           resolvedValue.value,
           schemaName,
-          resolvedValue.originalSchema?.["x-enumNames"],
+          getEnumNames(resolvedValue.originalSchema),
           context.output.override.useNativeEnums
         );
       } else if (schemaName === resolvedValue.value && resolvedValue.isRef) {
@@ -52433,7 +52448,7 @@ var writeSchemas = async ({
       } else {
         duplicateNamesMap.set(
           schema.name,
-          (duplicateNamesMap.get(schema.name) || 0) + 1
+          (duplicateNamesMap.get(schema.name) || 1) + 1
         );
       }
     });
@@ -52603,7 +52618,10 @@ var writeSingleMode = async ({
 }) => {
   try {
     const { path: path2, dirname: dirname3 } = getFileInfo(output.target, {
-      backupFilename: camel(builder.info.title),
+      backupFilename: conventionName(
+        builder.info.title,
+        output.namingConvention
+      ),
       extension: output.fileExtension
     });
     const {
@@ -52704,7 +52722,10 @@ var writeSplitMode = async ({
 }) => {
   try {
     const { filename, dirname: dirname3, extension } = getFileInfo(output.target, {
-      backupFilename: camel(builder.info.title),
+      backupFilename: conventionName(
+        builder.info.title,
+        output.namingConvention
+      ),
       extension: output.fileExtension
     });
     const {
@@ -53280,6 +53301,7 @@ var writeTagsMode = async ({
   getBody,
   getEnum,
   getEnumImplementation,
+  getEnumNames,
   getExtension,
   getFileInfo,
   getFullRoute,