@orval/core 7.4.1 → 7.6.0

package/dist/index.d.ts

@@ -33,6 +33,7 @@ type NormalizedOutputOptions = {
     workspace?: string;
     target?: string;
     schemas?: string;
+    namingConvention: NamingConvention;
     fileExtension: string;
     mode: OutputMode;
     mock?: GlobalMockOptions | ClientMockBuilder;
@@ -112,6 +113,7 @@ type NormalizedMutator = {
     name?: string;
     default: boolean;
     alias?: Record<string, string>;
+    extension?: string;
 };
 type NormalizedOperationOptions = {
     transformer?: OutputTransformer;
@@ -134,7 +136,7 @@ type NormalizedOperationOptions = {
 };
 type NormalizedInputOptions = {
     target: string | Record<string, unknown> | OpenAPIObject;
-    validation: boolean;
+    validation: boolean | object;
     override: OverrideInput;
     converterOptions: swagger2openapi.Options;
     parserOptions: SwaggerParserOptions;
@@ -160,10 +162,18 @@ declare const PropertySortOrder: {
     readonly SPECIFICATION: "Specification";
 };
 type PropertySortOrder = (typeof PropertySortOrder)[keyof typeof PropertySortOrder];
+declare const NamingConvention: {
+    readonly CAMEL_CASE: "camelCase";
+    readonly PASCAL_CASE: "PascalCase";
+    readonly SNAKE_CASE: "snake_case";
+    readonly KEBAB_CASE: "kebab-case";
+};
+type NamingConvention = (typeof NamingConvention)[keyof typeof NamingConvention];
 type OutputOptions = {
     workspace?: string;
     target?: string;
     schemas?: string;
+    namingConvention?: NamingConvention;
     fileExtension?: string;
     mode?: OutputMode;
     mock?: boolean | GlobalMockOptions | ClientMockBuilder;
@@ -196,7 +206,7 @@ type InputFiltersOption = {
 };
 type InputOptions = {
     target: string | Record<string, unknown> | OpenAPIObject;
-    validation?: boolean;
+    validation?: boolean | object;
     override?: OverrideInput;
     converterOptions?: swagger2openapi.Options;
     parserOptions?: SwaggerParserOptions;
@@ -242,6 +252,7 @@ type GlobalMockOptions = {
     delayFunctionLazyExecute?: boolean;
     baseUrl?: string;
     locale?: keyof typeof allLocales;
+    indexMockFiles?: boolean;
 };
 type OverrideMockOptions = Partial<GlobalMockOptions> & {
     arrayMin?: number;
@@ -278,6 +289,7 @@ type MutatorObject = {
     name?: string;
     default?: boolean;
     alias?: Record<string, string>;
+    extension?: string;
 };
 type Mutator = string | MutatorObject;
 type ParamsSerializerOptions = {
@@ -337,7 +349,9 @@ type OverrideOutputContentType = {
 };
 type NormalizedHonoOptions = {
     handlers?: string;
+    compositeRoute: string;
     validator: boolean | 'hono';
+    validatorOutputPath: string;
 };
 type ZodOptions = {
     strict?: {
@@ -404,7 +418,9 @@ type NormalizedZodOptions = {
 };
 type HonoOptions = {
     handlers?: string;
+    compositeRoute?: string;
     validator?: boolean | 'hono';
+    validatorOutputPath?: string;
 };
 type NormalizedQueryOptions = {
     useQuery?: boolean;
@@ -498,7 +514,7 @@ declare const Verbs: {
 };
 type ImportOpenApi = {
     data: Record<string, unknown | OpenAPIObject>;
-    input: InputOptions;
+    input: NormalizedInputOptions;
     output: NormalizedOutputOptions;
     target: string;
     workspace: string;
@@ -551,6 +567,7 @@ type GeneratorSchema = {
 type GeneratorImport = {
     name: string;
     schemaName?: string;
+    isConstant?: boolean;
     alias?: string;
     specKey?: string;
     default?: boolean;
@@ -930,12 +947,13 @@ declare const TEMPLATE_TAG_REGEX: RegExp;
 
 declare const generateComponentDefinition: (responses: ComponentsObject['responses'] | ComponentsObject['requestBodies'], context: ContextSpecs, suffix: string) => GeneratorSchema[];
 
-declare const generateImports: ({ imports, target, isRootKey, specsName, specKey: currentSpecKey, }: {
+declare const generateImports: ({ imports, target, isRootKey, specsName, specKey: currentSpecKey, namingConvention, }: {
     imports: GeneratorImport[];
     target: string;
     isRootKey: boolean;
     specsName: Record<string, string>;
     specKey: string;
+    namingConvention?: NamingConvention | undefined;
 }) => string;
 declare const generateMutatorImports: ({ mutators, implementation, oneMore, }: {
     mutators: GeneratorMutator[];
@@ -1230,6 +1248,7 @@ declare const camel: (s: string) => string;
 declare const snake: (s: string) => string;
 declare const kebab: (s: string) => string;
 declare const upper: (s: string, fillWith: string, isDeapostrophe?: boolean) => string;
+declare const conventionName: (name: string, convention: NamingConvention) => string;
 
 declare const compareVersions: (firstVersion: string, secondVersions: string, operator?: CompareOperator) => boolean;
 
@@ -1408,26 +1427,28 @@ declare const isSyntheticDefaultImportsAllow: (config?: Tsconfig) => boolean;
  * More information: https://github.com/IBM/openapi-validator/#configuration
  * @param specs openAPI spec
  */
-declare const ibmOpenapiValidator: (specs: OpenAPIObject) => Promise<void>;
+declare const ibmOpenapiValidator: (specs: OpenAPIObject, validation: boolean | object) => Promise<void>;
 
 declare const getIsBodyVerb: (verb: Verbs) => boolean;
 
 declare const writeModelInline: (acc: string, model: string) => string;
 declare const writeModelsInline: (array: GeneratorSchema[]) => string;
-declare const writeSchema: ({ path, schema, target, fileExtension, specKey, isRootKey, specsName, header, }: {
+declare const writeSchema: ({ path, schema, target, namingConvention, fileExtension, specKey, isRootKey, specsName, header, }: {
     path: string;
     schema: GeneratorSchema;
     target: string;
+    namingConvention: NamingConvention;
     fileExtension: string;
     specKey: string;
     isRootKey: boolean;
     specsName: Record<string, string>;
     header: string;
 }) => Promise<void>;
-declare const writeSchemas: ({ schemaPath, schemas, target, fileExtension, specKey, isRootKey, specsName, header, indexFiles, }: {
+declare const writeSchemas: ({ schemaPath, schemas, target, namingConvention, fileExtension, specKey, isRootKey, specsName, header, indexFiles, }: {
     schemaPath: string;
     schemas: GeneratorSchema[];
     target: string;
+    namingConvention: NamingConvention;
     fileExtension: string;
     specKey: string;
     isRootKey: boolean;
@@ -1450,4 +1471,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, 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, 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 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 };