orval 6.8.0 → 6.9.1

package/dist/index.d.ts

@@ -54,6 +54,14 @@ declare type GetterParams = GetterParam[];
 declare type GetterQueryParam = {
     schema: GeneratorSchema;
     deps: GeneratorSchema[];
+    isOptional: boolean;
+};
+declare type GetterPropType = 'param' | 'body' | 'queryParam' | 'header';
+declare const GetterPropType: {
+    PARAM: GetterPropType;
+    BODY: GetterPropType;
+    QUERY_PARAM: GetterPropType;
+    HEADER: GetterPropType;
 };
 declare type GetterProp = {
     name: string;
@@ -61,7 +69,7 @@ declare type GetterProp = {
     implementation: string;
     default: boolean;
     required: boolean;
-    type: 'param' | 'body' | 'queryParam';
+    type: GetterPropType;
 };
 declare type GetterProps = GetterProp[];
 
@@ -124,6 +132,9 @@ declare type GeneratorOperation = {
     formData?: GeneratorMutator;
     formUrlEncoded?: GeneratorMutator;
     operationName: string;
+    types?: {
+        result: (title?: string) => string;
+    };
 };
 declare type GeneratorVerbOptions = {
     verb: Verbs;
@@ -134,13 +145,14 @@ declare type GeneratorVerbOptions = {
     operationName: string;
     response: GetterResponse;
     body: GetterBody;
+    headers?: GetterQueryParam;
     queryParams?: GetterQueryParam;
     params: GetterParams;
     props: GetterProps;
     mutator?: GeneratorMutator;
     formData?: GeneratorMutator;
     formUrlEncoded?: GeneratorMutator;
-    override: NormalizedOperationOptions;
+    override: NormalizedOverrideOutput;
 };
 declare type GeneratorVerbsOptions = GeneratorVerbOptions[];
 declare type GeneratorOptions = {
@@ -153,6 +165,9 @@ declare type GeneratorOptions = {
 declare type GeneratorClient = {
     implementation: string;
     imports: GeneratorImport[];
+    types?: {
+        result: (title?: string) => string;
+    };
 };
 declare type GeneratorClientExtra = {
     implementation: string;
@@ -179,7 +194,6 @@ declare type ClientHeaderBuilder = (params: {
     isMutator: boolean;
     noFunction?: boolean;
     isGlobalMutator: boolean;
-    provideInRoot: boolean;
     provideIn: boolean | 'root' | 'any';
     hasAwaitedType: boolean;
 }) => string;
@@ -187,9 +201,11 @@ declare type ClientFooterBuilder = (params: {
     noFunction?: boolean | undefined;
     operationNames: string[];
     title?: string;
+    hasAwaitedType: boolean;
+    hasMutator: boolean;
 }) => string;
 declare type ClientTitleBuilder = (title: string) => string;
-declare type ClientDependenciesBuilder = (hasGlobalMutator: boolean) => GeneratorDependency[];
+declare type ClientDependenciesBuilder = (hasGlobalMutator: boolean, packageJson?: PackageJson) => GeneratorDependency[];
 declare type ClientMSWBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => {
     imports: string[];
     implementation: string;
@@ -206,6 +222,7 @@ declare type GeneratorClients = Record<OutputClient, ClientGeneratorsBuilder>;
 interface Options {
     output?: string | OutputOptions;
     input?: string | InputOptions;
+    hooks?: Partial<HooksOptions>;
 }
 declare type OptionsFn = () => Options | Promise<Options>;
 declare type OptionsExport = Options | Promise<Options> | OptionsFn;
@@ -231,7 +248,9 @@ declare type NormalizedOverrideOutput = {
         };
         required?: boolean;
         baseUrl?: string;
+        delay?: number;
     };
+    contentType?: OverrideOutputContentType;
     header: false | ((info: InfoObject) => string[] | string);
     formData: boolean | NormalizedMutator;
     formUrlEncoded: boolean | NormalizedMutator;
@@ -250,10 +269,14 @@ declare type NormalizedOverrideOutput = {
         };
     };
     query: QueryOptions;
-    angular: Omit<Required<AngularOptions>, 'provideInRoot'>;
+    angular: Required<AngularOptions>;
+    swr: {
+        options?: any;
+    };
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions: Record<string, any> | boolean;
     useDates?: boolean;
+    useTypeOverInterfaces?: boolean;
 };
 declare type NormalizedMutator = {
     path: string;
@@ -268,11 +291,16 @@ declare type NormalizedOperationOptions = {
         data?: MockProperties;
         properties?: MockProperties;
     };
+    contentType?: OverrideOutputContentType;
     query?: QueryOptions;
+    angular?: Required<AngularOptions>;
+    swr?: {
+        options?: any;
+    };
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
-    formData: boolean | NormalizedMutator;
-    formUrlEncoded: boolean | NormalizedMutator;
-    requestOptions: object | boolean;
+    formData?: boolean | NormalizedMutator;
+    formUrlEncoded?: boolean | NormalizedMutator;
+    requestOptions?: object | boolean;
 };
 declare type OutputClientFunc = (clients: GeneratorClients) => ClientGeneratorsBuilder;
 declare type OutputOptions = {
@@ -288,6 +316,7 @@ declare type OutputOptions = {
     tslint?: boolean;
     tsconfig?: string | Tsconfig;
     packageJson?: string;
+    headers?: boolean;
 };
 declare type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
     validate?: boolean;
@@ -347,6 +376,7 @@ declare type OverrideOutput = {
         required?: boolean;
         baseUrl?: string;
     };
+    contentType?: OverrideOutputContentType;
     header?: boolean | ((info: InfoObject) => string[] | string);
     formData?: boolean | Mutator;
     formUrlEncoded?: boolean | Mutator;
@@ -365,19 +395,27 @@ declare type OverrideOutput = {
         };
     };
     query?: QueryOptions;
+    swr?: {
+        options?: any;
+    };
     angular?: AngularOptions;
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     requestOptions?: Record<string, any> | boolean;
     useDates?: boolean;
+    useTypeOverInterfaces?: boolean;
+};
+declare type OverrideOutputContentType = {
+    include?: string[];
+    exclude?: string[];
 };
 declare type QueryOptions = {
     useQuery?: boolean;
     useInfinite?: boolean;
     useInfiniteQueryParam?: string;
     options?: any;
+    signal?: boolean;
 };
 declare type AngularOptions = {
-    provideInRoot?: boolean;
     provideIn?: 'root' | 'any' | boolean;
 };
 declare type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;
@@ -393,11 +431,20 @@ declare type OperationOptions = {
         properties?: MockProperties;
     };
     query?: QueryOptions;
+    angular?: Required<AngularOptions>;
+    swr?: {
+        options?: any;
+    };
     operationName?: (operation: OperationObject, route: string, verb: Verbs) => string;
     formData?: boolean | Mutator;
     formUrlEncoded?: boolean | Mutator;
     requestOptions?: object | boolean;
 };
+declare type Hook = 'afterAllFilesWrite';
+declare type HookFunction = (...args: any[]) => void | Promise<void>;
+declare type HookCommand = string | HookFunction | (string | HookFunction)[];
+declare type NormalizedHookCommand = HookCommand[];
+declare type HooksOptions<T = HookCommand | NormalizedHookCommand> = Partial<Record<Hook, T>>;
 declare type Verbs = 'post' | 'put' | 'get' | 'patch' | 'delete' | 'head';
 declare const Verbs: {
     POST: Verbs;
@@ -434,11 +481,13 @@ interface Tsconfig {
     compilerOptions?: {
         esModuleInterop?: boolean;
         allowSyntheticDefaultImports?: boolean;
+        exactOptionalPropertyTypes?: boolean;
         paths?: Record<string, string[]>;
     };
 }
 interface PackageJson {
     dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
 }
 
 /**
@@ -458,7 +507,11 @@ declare const generateImports: ({ imports, target, isRootKey, specsName, }: {
     isRootKey: boolean;
     specsName: Record<string, string>;
 }) => string;
-declare const generateMutatorImports: (mutators: GeneratorMutator[], oneMore?: boolean | undefined) => string;
+declare const generateMutatorImports: ({ mutators, implementation, oneMore, }: {
+    mutators: GeneratorMutator[];
+    implementation?: string | undefined;
+    oneMore?: boolean | undefined;
+}) => string;
 declare const addDependency: ({ implementation, exports, dependency, specsName, hasSchemaDir, isAllowSyntheticDefaultImports, }: {
     implementation: string;
     exports: GeneratorImport[];
@@ -471,13 +524,21 @@ declare const generateDependencyImports: (implementation: string, imports: {
     exports: GeneratorImport[];
     dependency: string;
 }[], specsName: Record<string, string>, hasSchemaDir: boolean, isAllowSyntheticDefaultImports: boolean) => string;
-declare const generateVerbImports: ({ response, body, queryParams, params, }: GeneratorVerbOptions) => GeneratorImport[];
+declare const generateVerbImports: ({ response, body, queryParams, headers, params, }: GeneratorVerbOptions) => GeneratorImport[];
 
 declare const generateBodyOptions: (body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean) => string;
-declare const generateAxiosOptions: (response: GetterResponse, queryParams?: GeneratorSchema | undefined, requestOptions?: boolean | object | undefined) => string;
-declare const generateOptions: ({ route, body, queryParams, response, verb, requestOptions, isFormData, isFormUrlEncoded, isAngular, }: {
+declare const generateAxiosOptions: ({ response, isExactOptionalPropertyTypes, queryParams, headers, requestOptions, hasSignal, }: {
+    response: GetterResponse;
+    isExactOptionalPropertyTypes: boolean;
+    queryParams?: GeneratorSchema | undefined;
+    headers?: GeneratorSchema | undefined;
+    requestOptions?: boolean | object | undefined;
+    hasSignal: boolean;
+}) => string;
+declare const generateOptions: ({ route, body, headers, queryParams, response, verb, requestOptions, isFormData, isFormUrlEncoded, isAngular, isExactOptionalPropertyTypes, hasSignal, }: {
     route: string;
     body: GetterBody;
+    headers?: GetterQueryParam | undefined;
     queryParams?: GetterQueryParam | undefined;
     response: GetterResponse;
     verb: Verbs;
@@ -485,12 +546,15 @@ declare const generateOptions: ({ route, body, queryParams, response, verb, requ
     isFormData: boolean;
     isFormUrlEncoded: boolean;
     isAngular?: boolean | undefined;
+    isExactOptionalPropertyTypes: boolean;
+    hasSignal: boolean;
 }) => string;
 declare const generateBodyMutatorConfig: (body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean) => string;
-declare const generateQueryParamsAxiosConfig: (response: GetterResponse, queryParams?: GeneratorSchema | undefined) => string;
-declare const generateMutatorConfig: ({ route, body, queryParams, response, verb, isFormData, isFormUrlEncoded, isBodyVerb, hasSignal, }: {
+declare const generateQueryParamsAxiosConfig: (response: GetterResponse, queryParams?: GetterQueryParam | undefined) => string;
+declare const generateMutatorConfig: ({ route, body, headers, queryParams, response, verb, isFormData, isFormUrlEncoded, isBodyVerb, hasSignal, isExactOptionalPropertyTypes, }: {
     route: string;
     body: GetterBody;
+    headers?: GetterQueryParam | undefined;
     queryParams?: GetterQueryParam | undefined;
     response: GetterResponse;
     verb: Verbs;
@@ -498,6 +562,7 @@ declare const generateMutatorConfig: ({ route, body, queryParams, response, verb
     isFormUrlEncoded: boolean;
     isBodyVerb: boolean;
     hasSignal: boolean;
+    isExactOptionalPropertyTypes: boolean;
 }) => string;
 declare const generateMutatorRequestOptions: (requestOptions: boolean | object | undefined, hasSecondArgument: boolean) => string | undefined;
 declare const generateFormDataAndUrlEncodedFunction: ({ body, formData, formUrlEncoded, isFormData, isFormUrlEncoded, }: {
@@ -520,6 +585,7 @@ declare const sanitize: (value: string, options?: {
     dot?: string | true | undefined;
     dash?: string | true | undefined;
     es5keyword?: boolean | undefined;
+    special?: boolean | undefined;
 } | undefined) => string;
 declare const toObjectString: <T>(props: T[], path?: keyof T | undefined) => string;
 declare const getNumberWord: (num: number) => string;

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _chunkRWT44D3Mjs = require('./chunk-RWT44D3M.js');_chunkRWT44D3Mjs.b.call(void 0, );var _chalk = require('chalk'); var _chalk2 = _interopRequireDefault(_chalk);_chunkRWT44D3Mjs.b.call(void 0, );var c=async(r,o=process.cwd(),e)=>{if(!r||_chunkRWT44D3Mjs.c.call(void 0, r))return _chunkRWT44D3Mjs.M.call(void 0, r,e);let n=await _chunkRWT44D3Mjs.H.call(void 0, r,o,e);if(e!=null&&e.watch)_chunkRWT44D3Mjs.K.call(void 0, e==null?void 0:e.watch,async()=>{try{await _chunkRWT44D3Mjs.L.call(void 0, o,n)}catch(a){_chunkRWT44D3Mjs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${e!=null&&e.projectName?`${e==null?void 0:e.projectName} - `:""}${a}`))}},n.input.target);else try{return await _chunkRWT44D3Mjs.L.call(void 0, o,n)}catch(a){_chunkRWT44D3Mjs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${e!=null&&e.projectName?`${e==null?void 0:e.projectName} - `:""}${a}`))}};var re=c;exports.URL_REGEX = _chunkRWT44D3Mjs.s; exports.VERBS_WITH_BODY = _chunkRWT44D3Mjs.r; exports.addDependency = _chunkRWT44D3Mjs.v; exports.camel = _chunkRWT44D3Mjs.g; exports.default = re; exports.defineConfig = _chunkRWT44D3Mjs.G; exports.escape = _chunkRWT44D3Mjs.o; exports.generalJSTypes = _chunkRWT44D3Mjs.p; exports.generalJSTypesWithArray = _chunkRWT44D3Mjs.q; exports.generate = c; exports.generateAxiosOptions = _chunkRWT44D3Mjs.z; exports.generateBodyMutatorConfig = _chunkRWT44D3Mjs.B; exports.generateBodyOptions = _chunkRWT44D3Mjs.y; exports.generateDependencyImports = _chunkRWT44D3Mjs.w; exports.generateFormDataAndUrlEncodedFunction = _chunkRWT44D3Mjs.F; exports.generateImports = _chunkRWT44D3Mjs.t; exports.generateMutatorConfig = _chunkRWT44D3Mjs.D; exports.generateMutatorImports = _chunkRWT44D3Mjs.u; exports.generateMutatorRequestOptions = _chunkRWT44D3Mjs.E; exports.generateOptions = _chunkRWT44D3Mjs.A; exports.generateQueryParamsAxiosConfig = _chunkRWT44D3Mjs.C; exports.generateVerbImports = _chunkRWT44D3Mjs.x; exports.getNumberWord = _chunkRWT44D3Mjs.n; exports.isSyntheticDefaultImportsAllow = _chunkRWT44D3Mjs.J; exports.kebab = _chunkRWT44D3Mjs.i; exports.loadTsconfig = _chunkRWT44D3Mjs.I; exports.pascal = _chunkRWT44D3Mjs.f; exports.sanitize = _chunkRWT44D3Mjs.l; exports.snake = _chunkRWT44D3Mjs.h; exports.stringify = _chunkRWT44D3Mjs.k; exports.toObjectString = _chunkRWT44D3Mjs.m; exports.upper = _chunkRWT44D3Mjs.j;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }"use strict";var _chunkXC24MY5Ujs = require('./chunk-XC24MY5U.js');_chunkXC24MY5Ujs.b.call(void 0, );var _chalk = require('chalk'); var _chalk2 = _interopRequireDefault(_chalk);_chunkXC24MY5Ujs.b.call(void 0, );var c=async(t,o=process.cwd(),e)=>{if(!t||_chunkXC24MY5Ujs.c.call(void 0, t))return _chunkXC24MY5Ujs.M.call(void 0, t,e);let n=await _chunkXC24MY5Ujs.H.call(void 0, t,o,e);if(e!=null&&e.watch)_chunkXC24MY5Ujs.K.call(void 0, e==null?void 0:e.watch,async()=>{try{await _chunkXC24MY5Ujs.L.call(void 0, o,n)}catch(a){_chunkXC24MY5Ujs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${e!=null&&e.projectName?`${e==null?void 0:e.projectName} - `:""}${a}`))}},n.input.target);else try{return await _chunkXC24MY5Ujs.L.call(void 0, o,n)}catch(a){_chunkXC24MY5Ujs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${e!=null&&e.projectName?`${e==null?void 0:e.projectName} - `:""}${a}`))}};var te=c;exports.URL_REGEX = _chunkXC24MY5Ujs.s; exports.VERBS_WITH_BODY = _chunkXC24MY5Ujs.r; exports.addDependency = _chunkXC24MY5Ujs.v; exports.camel = _chunkXC24MY5Ujs.g; exports.default = te; exports.defineConfig = _chunkXC24MY5Ujs.G; exports.escape = _chunkXC24MY5Ujs.o; exports.generalJSTypes = _chunkXC24MY5Ujs.p; exports.generalJSTypesWithArray = _chunkXC24MY5Ujs.q; exports.generate = c; exports.generateAxiosOptions = _chunkXC24MY5Ujs.z; exports.generateBodyMutatorConfig = _chunkXC24MY5Ujs.B; exports.generateBodyOptions = _chunkXC24MY5Ujs.y; exports.generateDependencyImports = _chunkXC24MY5Ujs.w; exports.generateFormDataAndUrlEncodedFunction = _chunkXC24MY5Ujs.F; exports.generateImports = _chunkXC24MY5Ujs.t; exports.generateMutatorConfig = _chunkXC24MY5Ujs.D; exports.generateMutatorImports = _chunkXC24MY5Ujs.u; exports.generateMutatorRequestOptions = _chunkXC24MY5Ujs.E; exports.generateOptions = _chunkXC24MY5Ujs.A; exports.generateQueryParamsAxiosConfig = _chunkXC24MY5Ujs.C; exports.generateVerbImports = _chunkXC24MY5Ujs.x; exports.getNumberWord = _chunkXC24MY5Ujs.n; exports.isSyntheticDefaultImportsAllow = _chunkXC24MY5Ujs.J; exports.kebab = _chunkXC24MY5Ujs.i; exports.loadTsconfig = _chunkXC24MY5Ujs.I; exports.pascal = _chunkXC24MY5Ujs.f; exports.sanitize = _chunkXC24MY5Ujs.l; exports.snake = _chunkXC24MY5Ujs.h; exports.stringify = _chunkXC24MY5Ujs.k; exports.toObjectString = _chunkXC24MY5Ujs.m; exports.upper = _chunkXC24MY5Ujs.j;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "orval",
   "description": "A swagger client generator for typescript",
-  "version": "6.8.0",
+  "version": "6.9.1",
   "license": "MIT",
   "files": [
     "dist"
@@ -56,10 +56,10 @@
     "update-samples": "zx ./scripts/update-samples.mjs"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.1",
-    "@commitlint/config-conventional": "^16.2.1",
-    "@faker-js/faker": "^6.1.1",
-    "@release-it/conventional-changelog": "^4.2.0",
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.3",
+    "@faker-js/faker": "^7.3.0",
+    "@release-it/conventional-changelog": "^5.0.0",
     "@types/chalk": "^2.2.0",
     "@types/commander": "^2.12.2",
     "@types/fs-extra": "^9.0.12",
@@ -71,30 +71,30 @@
     "@types/lodash.uniqby": "^4.7.6",
     "@types/lodash.uniqwith": "^4.5.6",
     "@types/micromatch": "^4.0.2",
-    "@types/node": "^17.0.21",
+    "@types/node": "^18.0.0",
     "@types/prettier": "^2.4.4",
     "@types/request": "^2.48.8",
     "@types/validator": "^13.7.1",
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/parser": "^5.14.0",
-    "dotenv-cli": "^4.0.0",
+    "dotenv-cli": "^5.1.0",
     "eslint": "^8.10.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.2",
-    "lint-staged": "^12.3.5",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
     "npm-run-all": "^4.1.5",
     "prettier": "2.6.2",
     "pretty-quick": "^3.1.3",
-    "release-it": "^14.12.5",
+    "release-it": "^15.1.0",
     "rimraf": "^3.0.2",
     "tsup": "^5.12.0",
     "typescript": "^4.6.2",
     "vitest": "^0.6.0",
-    "zx": "^5.2.0"
+    "zx": "^7.0.2"
   },
   "dependencies": {
-    "@apidevtools/swagger-parser": "^10.0.3",
+    "@apidevtools/swagger-parser": "^10.1.0",
     "acorn": "^8.7.0",
     "cac": "^6.7.12",
     "chalk": "^4.1.2",
@@ -108,7 +108,7 @@
     "find-up": "5.0.0",
     "fs-extra": "^10.0.1",
     "globby": "11.0.4",
-    "ibm-openapi-validator": "^0.57.4",
+    "ibm-openapi-validator": "^0.83.0",
     "inquirer": "^8.2.0",
     "lodash.get": "^4.4.2",
     "lodash.omit": "^4.5.0",
@@ -118,8 +118,9 @@
     "lodash.uniqwith": "^4.5.0",
     "micromatch": "^4.0.4",
     "openapi3-ts": "^2.0.2",
+    "string-argv": "^0.3.1",
     "swagger2openapi": "^7.0.8",
-    "tsconfck": "^1.2.0",
+    "tsconfck": "^2.0.1",
     "upath": "^2.0.1",
     "url": "^0.11.0",
     "validator": "^13.7.0"