@orval/core 7.2.0 → 7.4.0

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import SwaggerParser from '@apidevtools/swagger-parser';
+import { allLocales } from '@faker-js/faker';
 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 { TypeDocOptions } from 'typedoc';
 import { ValueIteratee } from 'lodash';
+import { ServerObject } from 'openapi3-ts/oas31';
 import { CompareOperator } from 'compare-versions';
 import debug from 'debug';
 
@@ -38,6 +40,7 @@ type NormalizedOutputOptions = {
     client: OutputClient | OutputClientFunc;
     httpClient: OutputHttpClient;
     clean: boolean | string[];
+    docs: boolean | OutputDocsOptions;
     prettier: boolean;
     tslint: boolean;
     biome: boolean;
@@ -45,11 +48,12 @@ type NormalizedOutputOptions = {
     packageJson?: PackageJson;
     headers: boolean;
     indexFiles: boolean;
-    baseUrl?: string;
+    baseUrl?: string | BaseUrlFromSpec | BaseUrlFromConstant;
     allParamsOptional: boolean;
     urlEncodeParameters: boolean;
     unionAddMissingProperties: boolean;
     optionsParamRequired: boolean;
+    propertySortOrder: PropertySortOrder;
 };
 type NormalizedParamsSerializerOptions = {
     qs?: Record<string, any>;
@@ -137,6 +141,25 @@ type NormalizedInputOptions = {
     filters?: InputFiltersOption;
 };
 type OutputClientFunc = (clients: GeneratorClients) => ClientGeneratorsBuilder;
+type BaseUrlFromSpec = {
+    getBaseUrlFromSpecification: true;
+    variables?: {
+        [variable: string]: string;
+    };
+    index?: number;
+    baseUrl?: never;
+};
+type BaseUrlFromConstant = {
+    getBaseUrlFromSpecification: false;
+    variables?: never;
+    index?: never;
+    baseUrl: string;
+};
+declare const PropertySortOrder: {
+    readonly ALPHABETICAL: "Alphabetical";
+    readonly SPECIFICATION: "Specification";
+};
+type PropertySortOrder = (typeof PropertySortOrder)[keyof typeof PropertySortOrder];
 type OutputOptions = {
     workspace?: string;
     target?: string;
@@ -148,6 +171,7 @@ type OutputOptions = {
     client?: OutputClient | OutputClientFunc;
     httpClient?: OutputHttpClient;
     clean?: boolean | string[];
+    docs?: boolean | OutputDocsOptions;
     prettier?: boolean;
     tslint?: boolean;
     biome?: boolean;
@@ -155,16 +179,18 @@ type OutputOptions = {
     packageJson?: string;
     headers?: boolean;
     indexFiles?: boolean;
-    baseUrl?: string;
+    baseUrl?: string | BaseUrlFromSpec | BaseUrlFromConstant;
     allParamsOptional?: boolean;
     urlEncodeParameters?: boolean;
     unionAddMissingProperties?: boolean;
     optionsParamRequired?: boolean;
+    propertySortOrder?: PropertySortOrder;
 };
 type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
     validate?: boolean;
 };
 type InputFiltersOption = {
+    mode?: 'include' | 'exclude';
     tags?: (string | RegExp)[];
     schemas?: (string | RegExp)[];
 };
@@ -201,6 +227,9 @@ declare const OutputMode: {
     readonly TAGS_SPLIT: "tags-split";
 };
 type OutputMode = (typeof OutputMode)[keyof typeof OutputMode];
+type OutputDocsOptions = {
+    configPath?: string;
+} & Partial<TypeDocOptions>;
 declare const OutputMockType: {
     readonly MSW: "msw";
 };
@@ -423,7 +452,7 @@ type SwrOptions = {
     swrInfiniteOptions?: any;
 };
 type FetchOptions = {
-    includeHttpStatusReturnType: boolean;
+    includeHttpResponseReturnType: boolean;
 };
 type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;
 type InputTransformer = string | InputTransformerFn;
@@ -970,7 +999,7 @@ declare const generateOptions: ({ route, body, headers, queryParams, response, v
 }) => string;
 declare const generateBodyMutatorConfig: (body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean) => string;
 declare const generateQueryParamsAxiosConfig: (response: GetterResponse, isVue: boolean, queryParams?: GetterQueryParam) => string;
-declare const generateMutatorConfig: ({ route, body, headers, queryParams, response, verb, isFormData, isFormUrlEncoded, isBodyVerb, hasSignal, isExactOptionalPropertyTypes, isVue, }: {
+declare const generateMutatorConfig: ({ route, body, headers, queryParams, response, verb, isFormData, isFormUrlEncoded, hasSignal, isExactOptionalPropertyTypes, isVue, }: {
     route: string;
     body: GetterBody;
     headers?: GetterQueryParam | undefined;
@@ -979,7 +1008,6 @@ declare const generateMutatorConfig: ({ route, body, headers, queryParams, respo
     verb: Verbs;
     isFormData: boolean;
     isFormUrlEncoded: boolean;
-    isBodyVerb: boolean;
     hasSignal: boolean;
     isExactOptionalPropertyTypes: boolean;
     isVue?: boolean | undefined;
@@ -1000,7 +1028,7 @@ declare const generateParameterDefinition: (parameters: ComponentsObject['parame
  *
  * @param schemas
  */
-declare const generateSchemasDefinition: (schemas: SchemasObject | undefined, context: ContextSpecs, suffix: string, schemasFilters?: InputFiltersOption['schemas']) => GeneratorSchema[];
+declare const generateSchemasDefinition: (schemas: SchemasObject | undefined, context: ContextSpecs, suffix: string, filters?: InputFiltersOption) => GeneratorSchema[];
 
 declare const generateVerbsOptions: ({ verbs, input, output, route, pathRoute, context, }: {
     verbs: PathItemObject;
@@ -1137,6 +1165,7 @@ declare const getResponse: ({ responses, operationName, context, contentType, }:
 }) => GetterResponse;
 
 declare const getRoute: (route: string) => string;
+declare const getFullRoute: (route: string, servers: ServerObject[] | undefined, baseUrl: string | BaseUrlFromConstant | BaseUrlFromSpec | undefined) => string;
 declare const getRouteAsArray: (route: string) => string;
 
 /**
@@ -1305,12 +1334,12 @@ declare const count: (str: string | undefined, key: string) => number;
 
 declare const openApiConverter: (schema: any, options: swagger2openapi.Options | undefined, specKey: string) => Promise<OpenAPIObject>;
 
-declare let join: (...paths: string[]) => string;
-declare let resolve: (...paths: string[]) => string;
-declare let extname: (path: string) => string;
-declare let dirname: (path: string) => string;
-declare let basename: (path: string, suffix?: string | undefined) => string;
-declare let isAbsolute: (path: string) => boolean;
+declare const join: (...paths: string[]) => string;
+declare const resolve: (...paths: string[]) => string;
+declare const extname: (path: string) => string;
+declare const dirname: (path: string) => string;
+declare const basename: (path: string, suffix?: string | undefined) => string;
+declare const isAbsolute: (path: string) => boolean;
 
 /**
  * Behaves exactly like `path.relative(from, to)`, but keeps the first meaningful "./"
@@ -1381,6 +1410,8 @@ declare const isSyntheticDefaultImportsAllow: (config?: Tsconfig) => boolean;
  */
 declare const ibmOpenapiValidator: (specs: OpenAPIObject) => 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, }: {
@@ -1419,4 +1450,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 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, OutputHttpClient, 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 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, 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, 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 };