@orval/core 6.22.1 → 6.24.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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 * 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 { allLocales } from '@faker-js/faker';
 import { CompareOperator } from 'compare-versions';
@@ -44,6 +44,7 @@ type NormalizedOutputOptions = {
     baseUrl?: string;
     allParamsOptional: boolean;
     urlEncodeParameters: boolean;
+    unionAddMissingProperties: boolean;
 };
 type NormalizedParamsSerializerOptions = {
     qs?: Record<string, any>;
@@ -68,6 +69,7 @@ type NormalizedOverrideOutput = {
     components: {
         schemas: {
             suffix: string;
+            itemSuffix: string;
         };
         responses: {
             suffix: string;
@@ -81,9 +83,7 @@ type NormalizedOverrideOutput = {
     };
     query: NormalizedQueryOptions;
     angular: Required<AngularOptions>;
-    swr: {
-        options?: any;
-    };
+    swr: SwrOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions: Record<string, any> | boolean;
     useDates?: boolean;
@@ -148,6 +148,7 @@ type OutputOptions = {
     baseUrl?: string;
     allParamsOptional?: boolean;
     urlEncodeParameters?: boolean;
+    unionAddMissingProperties?: boolean;
 };
 type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
     validate?: boolean;
@@ -172,18 +173,18 @@ declare const OutputClient: {
     readonly SWR: "swr";
     readonly ZOD: "zod";
 };
-type OutputClient = typeof OutputClient[keyof typeof OutputClient];
+type OutputClient = (typeof OutputClient)[keyof typeof OutputClient];
 declare const OutputMode: {
     readonly SINGLE: "single";
     readonly SPLIT: "split";
     readonly TAGS: "tags";
     readonly TAGS_SPLIT: "tags-split";
 };
-type OutputMode = typeof OutputMode[keyof typeof OutputMode];
+type OutputMode = (typeof OutputMode)[keyof typeof OutputMode];
 declare const OutputMockType: {
     readonly MSW: "msw";
 };
-type OutputMockType = typeof OutputMockType[keyof typeof OutputMockType];
+type OutputMockType = (typeof OutputMockType)[keyof typeof OutputMockType];
 type GlobalMockOptions = {
     type: OutputMockType;
     useExamples?: boolean;
@@ -244,6 +245,7 @@ type OverrideOutput = {
     components?: {
         schemas?: {
             suffix?: string;
+            itemSuffix?: string;
         };
         responses?: {
             suffix?: string;
@@ -256,9 +258,7 @@ type OverrideOutput = {
         };
     };
     query?: QueryOptions;
-    swr?: {
-        options?: any;
-    };
+    swr?: SwrOptions;
     angular?: AngularOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions?: Record<string, any> | boolean;
@@ -285,6 +285,7 @@ type NormalizedQueryOptions = {
     queryKey?: NormalizedMutator;
     queryOptions?: NormalizedMutator;
     mutationOptions?: NormalizedMutator;
+    shouldExportMutatorHooks?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
@@ -300,12 +301,17 @@ type QueryOptions = {
     queryKey?: Mutator;
     queryOptions?: Mutator;
     mutationOptions?: Mutator;
+    shouldExportMutatorHooks?: boolean;
     signal?: boolean;
     version?: 3 | 4 | 5;
 };
 type AngularOptions = {
     provideIn?: 'root' | 'any' | boolean;
 };
+type SwrOptions = {
+    options?: any;
+    useInfinite?: boolean;
+};
 type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;
 type InputTransformer = string | InputTransformerFn;
 type OverrideInput = {
@@ -320,9 +326,7 @@ type OperationOptions = {
     };
     query?: QueryOptions;
     angular?: Required<AngularOptions>;
-    swr?: {
-        options?: any;
-    };
+    swr?: SwrOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     formData?: boolean | Mutator;
     formUrlEncoded?: boolean | Mutator;
@@ -331,7 +335,11 @@ type OperationOptions = {
 };
 type Hook = 'afterAllFilesWrite';
 type HookFunction = (...args: any[]) => void | Promise<void>;
-type HookCommand = string | HookFunction | (string | HookFunction)[];
+interface HookOption {
+    command: string | HookFunction;
+    injectGeneratedDirsAndFiles?: boolean;
+}
+type HookCommand = string | HookFunction | HookOption | (string | HookFunction | HookOption)[];
 type NormalizedHookCommand = HookCommand[];
 type HooksOptions<T = HookCommand | NormalizedHookCommand> = Partial<Record<Hook, T>>;
 type NormalizedHookOptions = HooksOptions<NormalizedHookCommand>;
@@ -355,12 +363,9 @@ interface ContextSpecs {
     specKey: string;
     target: string;
     workspace: string;
-    tslint: boolean;
     specs: Record<string, OpenAPIObject>;
-    override: NormalizedOverrideOutput;
-    tsconfig?: Tsconfig;
-    packageJson?: PackageJson;
     parents?: string[];
+    output: NormalizedOutputOptions;
 }
 interface GlobalOptions {
     projectName?: string;
@@ -433,6 +438,7 @@ type GeneratorTargetFull = {
     implementationMock: {
         function: string;
         handler: string;
+        handlerName: string;
     };
     importsMock: GeneratorImport[];
     mutators?: GeneratorMutator[];
@@ -447,6 +453,7 @@ type GeneratorOperation = {
     implementationMock: {
         function: string;
         handler: string;
+        handlerName: string;
     };
     importsMock: GeneratorImport[];
     tags: string[];
@@ -922,7 +929,7 @@ declare const getParamsInPath: (path: string) => string[];
 declare const getParams: ({ route, pathParams, operationId, context, output, }: {
     route: string;
     pathParams?: {
-        parameter: openapi3_ts.ParameterObject;
+        parameter: openapi3_ts_oas30.ParameterObject;
         imports: GeneratorImport[];
     }[] | undefined;
     operationId: string;
@@ -1071,7 +1078,7 @@ declare const startMessage: ({ name, version, description, }: {
     version: string;
     description: string;
 }) => void;
-declare const errorMessage: (err: string) => void;
+declare const logError: (err: unknown, tag?: string) => void;
 declare const mismatchArgsMessage: (mismatchArgs: string[]) => void;
 declare const createSuccessMessage: (backend?: string) => void;
 declare const ibmOpenapiValidatorWarnings: (warnings: {
@@ -1250,4 +1257,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 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 };
+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 HookOption, 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 SwrOptions, 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, 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 };