@orval/core 6.31.0 → 7.0.1

package/README.md

@@ -1,6 +1,6 @@
 [![npm version](https://badge.fury.io/js/orval.svg)](https://badge.fury.io/js/orval)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![tests](https://github.com/anymaniax/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/anymaniax/orval/actions/workflows/tests.yaml)
+[![tests](https://github.com/orval-labs/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/orval-labs/orval/actions/workflows/tests.yaml)
 
 <p align="center">
   <img src="./logo/orval-logo-horizontal.svg?raw=true" width="500" height="160" alt="orval - Restfull Client Generator" />
@@ -19,11 +19,11 @@
 
 You can find below some samples
 
-- [react app](https://github.com/anymaniax/orval/tree/master/samples/react-app)
-- [react query](https://github.com/anymaniax/orval/tree/master/samples/react-query)
-- [svelte query](https://github.com/anymaniax/orval/tree/master/samples/svelte-query)
-- [vue query](https://github.com/anymaniax/orval/tree/master/samples/vue-query)
-- [react app with swr](https://github.com/anymaniax/orval/tree/master/samples/react-app-with-swr)
-- [angular app](https://github.com/anymaniax/orval/tree/master/samples/angular-app)
-- [hono](https://github.com/anymaniax/orval/tree/master/samples/hono)
-- [next app with fetch](https://github.com/anymaniax/orval/tree/master/samples/next-app-with-fetch)
+- [react app](https://github.com/orval-labs/orval/tree/master/samples/react-app)
+- [react query](https://github.com/orval-labs/orval/tree/master/samples/react-query)
+- [svelte query](https://github.com/orval-labs/orval/tree/master/samples/svelte-query)
+- [vue query](https://github.com/orval-labs/orval/tree/master/samples/vue-query)
+- [react app with swr](https://github.com/orval-labs/orval/tree/master/samples/react-app-with-swr)
+- [angular app](https://github.com/orval-labs/orval/tree/master/samples/angular-app)
+- [hono](https://github.com/orval-labs/orval/tree/master/samples/hono)
+- [next app with fetch](https://github.com/orval-labs/orval/tree/master/samples/next-app-with-fetch)

package/dist/index.d.ts

@@ -36,6 +36,7 @@ type NormalizedOutputOptions = {
     mock?: GlobalMockOptions | ClientMockBuilder;
     override: NormalizedOverrideOutput;
     client: OutputClient | OutputClientFunc;
+    httpClient: OutputHttpClient;
     clean: boolean | string[];
     prettier: boolean;
     tslint: boolean;
@@ -90,6 +91,7 @@ type NormalizedOverrideOutput = {
     angular: Required<AngularOptions>;
     swr: SwrOptions;
     zod: NormalizedZodOptions;
+    fetch: FetchOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions: Record<string, any> | boolean;
     useDates?: boolean;
@@ -120,6 +122,7 @@ type NormalizedOperationOptions = {
     swr?: SwrOptions;
     zod?: NormalizedZodOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
+    fetch?: FetchOptions;
     formData?: boolean | NormalizedMutator;
     formUrlEncoded?: boolean | NormalizedMutator;
     paramsSerializer?: NormalizedMutator;
@@ -143,6 +146,7 @@ type OutputOptions = {
     mock?: boolean | GlobalMockOptions | ClientMockBuilder;
     override?: OverrideOutput;
     client?: OutputClient | OutputClientFunc;
+    httpClient?: OutputHttpClient;
     clean?: boolean | string[];
     prettier?: boolean;
     tslint?: boolean;
@@ -185,6 +189,11 @@ declare const OutputClient: {
     readonly FETCH: "fetch";
 };
 type OutputClient = (typeof OutputClient)[keyof typeof OutputClient];
+declare const OutputHttpClient: {
+    readonly AXIOS: "axios";
+    readonly FETCH: "fetch";
+};
+type OutputHttpClient = (typeof OutputHttpClient)[keyof typeof OutputHttpClient];
 declare const OutputMode: {
     readonly SINGLE: "single";
     readonly SPLIT: "split";
@@ -283,6 +292,7 @@ type OverrideOutput = {
     angular?: AngularOptions;
     zod?: ZodOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
+    fetch?: FetchOptions;
     requestOptions?: Record<string, any> | boolean;
     useDates?: boolean;
     useTypeOverInterfaces?: boolean;
@@ -308,6 +318,13 @@ type ZodOptions = {
         body?: boolean;
         response?: boolean;
     };
+    generate: {
+        param: boolean;
+        query: boolean;
+        header: boolean;
+        body: boolean;
+        response: boolean;
+    };
     coerce?: {
         param?: boolean | ZodCoerceType[];
         query?: boolean | ZodCoerceType[];
@@ -333,6 +350,13 @@ type NormalizedZodOptions = {
         body: boolean;
         response: boolean;
     };
+    generate: {
+        param: boolean;
+        query: boolean;
+        header: boolean;
+        body: boolean;
+        response: boolean;
+    };
     coerce: {
         param: boolean | ZodCoerceType[];
         query: boolean | ZodCoerceType[];
@@ -398,6 +422,9 @@ type SwrOptions = {
     swrMutationOptions?: any;
     swrInfiniteOptions?: any;
 };
+type FetchOptions = {
+    includeHttpStatusReturnType: boolean;
+};
 type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;
 type InputTransformer = string | InputTransformerFn;
 type OverrideInput = {
@@ -415,6 +442,7 @@ type OperationOptions = {
     swr?: SwrOptions;
     zod?: ZodOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
+    fetch?: FetchOptions;
     formData?: boolean | Mutator;
     formUrlEncoded?: boolean | Mutator;
     paramsSerializer?: Mutator;
@@ -463,6 +491,7 @@ interface GlobalOptions {
     biome?: boolean;
     mock?: boolean | GlobalMockOptions;
     client?: OutputClient;
+    httpClient?: OutputHttpClient;
     mode?: OutputMode;
     tsconfig?: string | Tsconfig;
     packageJson?: string;
@@ -483,6 +512,7 @@ type TsConfigTarget = 'es3' | 'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | '
 interface PackageJson {
     dependencies?: Record<string, string>;
     devDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
 }
 type GeneratorSchema = {
     name: string;
@@ -634,7 +664,7 @@ type ClientFooterBuilder = (params: {
     hasMutator: boolean;
 }) => string;
 type ClientTitleBuilder = (title: string) => string;
-type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson) => GeneratorDependency[];
+type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient) => GeneratorDependency[];
 type ClientMockGeneratorImplementation = {
     function: string;
     handlerName: string;
@@ -858,6 +888,9 @@ type GeneratorApiBuilder = GeneratorApiOperations & {
     importsMock: GenerateMockImports;
     extraFiles: ClientFileBuilder[];
 };
+interface SchemaWithConst extends SchemaObject {
+    const: string;
+}
 
 declare const generalJSTypes: string[];
 declare const generalJSTypesWithArray: string[];
@@ -1385,4 +1418,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 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, 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, 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 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 };