@orval/core 6.31.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  [![npm version](https://badge.fury.io/js/orval.svg)](https://badge.fury.io/js/orval)
2
2
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
3
- [![tests](https://github.com/anymaniax/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/anymaniax/orval/actions/workflows/tests.yaml)
3
+ [![tests](https://github.com/orval-labs/orval/actions/workflows/tests.yaml/badge.svg)](https://github.com/orval-labs/orval/actions/workflows/tests.yaml)
4
4
 
5
5
  <p align="center">
6
6
  <img src="./logo/orval-logo-horizontal.svg?raw=true" width="500" height="160" alt="orval - Restfull Client Generator" />
@@ -19,11 +19,11 @@
19
19
 
20
20
  You can find below some samples
21
21
 
22
- - [react app](https://github.com/anymaniax/orval/tree/master/samples/react-app)
23
- - [react query](https://github.com/anymaniax/orval/tree/master/samples/react-query)
24
- - [svelte query](https://github.com/anymaniax/orval/tree/master/samples/svelte-query)
25
- - [vue query](https://github.com/anymaniax/orval/tree/master/samples/vue-query)
26
- - [react app with swr](https://github.com/anymaniax/orval/tree/master/samples/react-app-with-swr)
27
- - [angular app](https://github.com/anymaniax/orval/tree/master/samples/angular-app)
28
- - [hono](https://github.com/anymaniax/orval/tree/master/samples/hono)
29
- - [next app with fetch](https://github.com/anymaniax/orval/tree/master/samples/next-app-with-fetch)
22
+ - [react app](https://github.com/orval-labs/orval/tree/master/samples/react-app)
23
+ - [react query](https://github.com/orval-labs/orval/tree/master/samples/react-query)
24
+ - [svelte query](https://github.com/orval-labs/orval/tree/master/samples/svelte-query)
25
+ - [vue query](https://github.com/orval-labs/orval/tree/master/samples/vue-query)
26
+ - [react app with swr](https://github.com/orval-labs/orval/tree/master/samples/react-app-with-swr)
27
+ - [angular app](https://github.com/orval-labs/orval/tree/master/samples/angular-app)
28
+ - [hono](https://github.com/orval-labs/orval/tree/master/samples/hono)
29
+ - [next app with fetch](https://github.com/orval-labs/orval/tree/master/samples/next-app-with-fetch)
package/dist/index.d.ts CHANGED
@@ -36,6 +36,7 @@ type NormalizedOutputOptions = {
36
36
  mock?: GlobalMockOptions | ClientMockBuilder;
37
37
  override: NormalizedOverrideOutput;
38
38
  client: OutputClient | OutputClientFunc;
39
+ httpClient: OutputHttpClient;
39
40
  clean: boolean | string[];
40
41
  prettier: boolean;
41
42
  tslint: boolean;
@@ -143,6 +144,7 @@ type OutputOptions = {
143
144
  mock?: boolean | GlobalMockOptions | ClientMockBuilder;
144
145
  override?: OverrideOutput;
145
146
  client?: OutputClient | OutputClientFunc;
147
+ httpClient?: OutputHttpClient;
146
148
  clean?: boolean | string[];
147
149
  prettier?: boolean;
148
150
  tslint?: boolean;
@@ -185,6 +187,11 @@ declare const OutputClient: {
185
187
  readonly FETCH: "fetch";
186
188
  };
187
189
  type OutputClient = (typeof OutputClient)[keyof typeof OutputClient];
190
+ declare const OutputHttpClient: {
191
+ readonly AXIOS: "axios";
192
+ readonly FETCH: "fetch";
193
+ };
194
+ type OutputHttpClient = (typeof OutputHttpClient)[keyof typeof OutputHttpClient];
188
195
  declare const OutputMode: {
189
196
  readonly SINGLE: "single";
190
197
  readonly SPLIT: "split";
@@ -308,6 +315,13 @@ type ZodOptions = {
308
315
  body?: boolean;
309
316
  response?: boolean;
310
317
  };
318
+ generate: {
319
+ param: boolean;
320
+ query: boolean;
321
+ header: boolean;
322
+ body: boolean;
323
+ response: boolean;
324
+ };
311
325
  coerce?: {
312
326
  param?: boolean | ZodCoerceType[];
313
327
  query?: boolean | ZodCoerceType[];
@@ -333,6 +347,13 @@ type NormalizedZodOptions = {
333
347
  body: boolean;
334
348
  response: boolean;
335
349
  };
350
+ generate: {
351
+ param: boolean;
352
+ query: boolean;
353
+ header: boolean;
354
+ body: boolean;
355
+ response: boolean;
356
+ };
336
357
  coerce: {
337
358
  param: boolean | ZodCoerceType[];
338
359
  query: boolean | ZodCoerceType[];
@@ -463,6 +484,7 @@ interface GlobalOptions {
463
484
  biome?: boolean;
464
485
  mock?: boolean | GlobalMockOptions;
465
486
  client?: OutputClient;
487
+ httpClient?: OutputHttpClient;
466
488
  mode?: OutputMode;
467
489
  tsconfig?: string | Tsconfig;
468
490
  packageJson?: string;
@@ -634,7 +656,7 @@ type ClientFooterBuilder = (params: {
634
656
  hasMutator: boolean;
635
657
  }) => string;
636
658
  type ClientTitleBuilder = (title: string) => string;
637
- type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson) => GeneratorDependency[];
659
+ type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient) => GeneratorDependency[];
638
660
  type ClientMockGeneratorImplementation = {
639
661
  function: string;
640
662
  handlerName: string;
@@ -858,6 +880,9 @@ type GeneratorApiBuilder = GeneratorApiOperations & {
858
880
  importsMock: GenerateMockImports;
859
881
  extraFiles: ClientFileBuilder[];
860
882
  };
883
+ interface SchemaWithConst extends SchemaObject {
884
+ const: string;
885
+ }
861
886
 
862
887
  declare const generalJSTypes: string[];
863
888
  declare const generalJSTypesWithArray: string[];
@@ -1385,4 +1410,4 @@ declare const generateTarget: (builder: WriteSpecsBuilder, options: NormalizedOu
1385
1410
 
1386
1411
  declare const generateTargetForTags: (builder: WriteSpecsBuilder, options: NormalizedOutputOptions) => Record<string, GeneratorTarget>;
1387
1412
 
1388
- 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 };
1413
+ 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, 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 };