orval 6.7.1 → 6.8.0

package/dist/index.d.ts

@@ -181,12 +181,12 @@ declare type ClientHeaderBuilder = (params: {
     isGlobalMutator: boolean;
     provideInRoot: boolean;
     provideIn: boolean | 'root' | 'any';
+    hasAwaitedType: boolean;
 }) => string;
 declare type ClientFooterBuilder = (params: {
     noFunction?: boolean | undefined;
     operationNames: string[];
     title?: string;
-    hasMutator: boolean;
 }) => string;
 declare type ClientTitleBuilder = (title: string) => string;
 declare type ClientDependenciesBuilder = (hasGlobalMutator: boolean) => GeneratorDependency[];
@@ -287,6 +287,7 @@ declare type OutputOptions = {
     prettier?: boolean;
     tslint?: boolean;
     tsconfig?: string | Tsconfig;
+    packageJson?: string;
 };
 declare type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {
     validate?: boolean;
@@ -305,6 +306,7 @@ declare const OutputClient: {
     AXIOS_FUNCTIONS: OutputClient;
     REACT_QUERY: OutputClient;
     SVELTE_QUERY: OutputClient;
+    VUE_QUERY: OutputClient;
 };
 declare type OutputMode = 'single' | 'split' | 'tags' | 'tags-split';
 declare const OutputMode: {
@@ -413,6 +415,7 @@ interface ContextSpecs {
     specs: Record<string, OpenAPIObject>;
     override: NormalizedOverrideOutput;
     tsconfig?: Tsconfig;
+    packageJson?: PackageJson;
 }
 interface GlobalOptions {
     projectName?: string;
@@ -423,7 +426,8 @@ interface GlobalOptions {
     mock?: boolean;
     client?: OutputClient;
     mode?: OutputMode;
-    tsconfig?: Tsconfig;
+    tsconfig?: string | Tsconfig;
+    packageJson?: string;
 }
 interface Tsconfig {
     baseUrl?: string;
@@ -433,6 +437,9 @@ interface Tsconfig {
         paths?: Record<string, string[]>;
     };
 }
+interface PackageJson {
+    dependencies?: Record<string, string>;
+}
 
 /**
  * Type helper to make it easier to use orval.config.ts
@@ -440,6 +447,90 @@ interface Tsconfig {
  */
 declare function defineConfig(options: ConfigExternal): ConfigExternal;
 
+declare const generalJSTypes: string[];
+declare const generalJSTypesWithArray: string[];
+declare const VERBS_WITH_BODY: Verbs[];
+declare const URL_REGEX: RegExp;
+
+declare const generateImports: ({ imports, target, isRootKey, specsName, }: {
+    imports: GeneratorImport[];
+    target: string;
+    isRootKey: boolean;
+    specsName: Record<string, string>;
+}) => string;
+declare const generateMutatorImports: (mutators: GeneratorMutator[], oneMore?: boolean | undefined) => string;
+declare const addDependency: ({ implementation, exports, dependency, specsName, hasSchemaDir, isAllowSyntheticDefaultImports, }: {
+    implementation: string;
+    exports: GeneratorImport[];
+    dependency: string;
+    specsName: Record<string, string>;
+    hasSchemaDir: boolean;
+    isAllowSyntheticDefaultImports: boolean;
+}) => string | undefined;
+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 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, }: {
+    route: string;
+    body: GetterBody;
+    queryParams?: GetterQueryParam | undefined;
+    response: GetterResponse;
+    verb: Verbs;
+    requestOptions?: boolean | object | undefined;
+    isFormData: boolean;
+    isFormUrlEncoded: boolean;
+    isAngular?: boolean | undefined;
+}) => 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, }: {
+    route: string;
+    body: GetterBody;
+    queryParams?: GetterQueryParam | undefined;
+    response: GetterResponse;
+    verb: Verbs;
+    isFormData: boolean;
+    isFormUrlEncoded: boolean;
+    isBodyVerb: boolean;
+    hasSignal: boolean;
+}) => string;
+declare const generateMutatorRequestOptions: (requestOptions: boolean | object | undefined, hasSecondArgument: boolean) => string | undefined;
+declare const generateFormDataAndUrlEncodedFunction: ({ body, formData, formUrlEncoded, isFormData, isFormUrlEncoded, }: {
+    body: GetterBody;
+    formData?: GeneratorMutator | undefined;
+    formUrlEncoded?: GeneratorMutator | undefined;
+    isFormData: boolean;
+    isFormUrlEncoded: boolean;
+}) => string;
+
+declare const loadTsconfig: (tsconfig?: string | Tsconfig | undefined, workspace?: string) => Promise<Tsconfig | undefined>;
+declare const isSyntheticDefaultImportsAllow: (config?: Tsconfig | undefined) => boolean;
+
+declare const stringify: (data?: string | any[] | {
+    [key: string]: any;
+} | undefined) => string | undefined;
+declare const sanitize: (value: string, options?: {
+    whitespace?: string | true | undefined;
+    underscore?: string | true | undefined;
+    dot?: string | true | undefined;
+    dash?: string | true | undefined;
+    es5keyword?: boolean | undefined;
+} | undefined) => string;
+declare const toObjectString: <T>(props: T[], path?: keyof T | undefined) => string;
+declare const getNumberWord: (num: number) => string;
+declare const escape: (str: string, char?: string) => string;
+
+declare const pascal: (s: string) => string;
+declare const camel: (s: string) => string;
+declare const snake: (s: string) => string;
+declare const kebab: (s: string) => string;
+declare const upper: (s: string, fillWith?: string | undefined, isDeapostrophe?: boolean | undefined) => string;
+
 declare const generate: (optionsExport?: string | OptionsExport | undefined, workspace?: string, options?: GlobalOptions | undefined) => Promise<void>;
 
-export { ClientBuilder, ClientDependenciesBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMSWBuilder, ClientTitleBuilder, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, Options, generate as default, defineConfig, generate };
+export { ClientBuilder, ClientDependenciesBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMSWBuilder, ClientTitleBuilder, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, Options, URL_REGEX, VERBS_WITH_BODY, addDependency, camel, generate as default, defineConfig, escape, generalJSTypes, generalJSTypesWithArray, generate, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateQueryParamsAxiosConfig, generateVerbImports, getNumberWord, isSyntheticDefaultImportsAllow, kebab, loadTsconfig, pascal, sanitize, snake, stringify, toObjectString, upper };

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 _chunkCV7R5DXPjs = require('./chunk-CV7R5DXP.js');_chunkCV7R5DXPjs.b.call(void 0, );var _chalk = require('chalk'); var _chalk2 = _interopRequireDefault(_chalk);_chunkCV7R5DXPjs.b.call(void 0, );var c=async(t,o=process.cwd(),e)=>{if(!t||_chunkCV7R5DXPjs.c.call(void 0, t))return _chunkCV7R5DXPjs.j.call(void 0, t,e);let n=await _chunkCV7R5DXPjs.g.call(void 0, t,o,e);if(e==null?void 0:e.watch)_chunkCV7R5DXPjs.h.call(void 0, e==null?void 0:e.watch,async()=>{try{await _chunkCV7R5DXPjs.i.call(void 0, o,n)}catch(a){_chunkCV7R5DXPjs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${(e==null?void 0:e.projectName)?`${e==null?void 0:e.projectName} - `:""}${a}`))}},n.input.target);else try{return await _chunkCV7R5DXPjs.i.call(void 0, o,n)}catch(a){_chunkCV7R5DXPjs.d.call(void 0, _chalk2.default.red(`\u{1F6D1}  ${(e==null?void 0:e.projectName)?`${e==null?void 0:e.projectName} - `:""}${a}`))}};var S=c;exports.default = S; exports.defineConfig = _chunkCV7R5DXPjs.f; exports.generate = c;
+"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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "orval",
   "description": "A swagger client generator for typescript",
-  "version": "6.7.1",
+  "version": "6.8.0",
   "license": "MIT",
   "files": [
     "dist"
@@ -45,7 +45,8 @@
     "dev": "tsup ./src/bin/orval.ts ./src/index.ts --clean --watch src --onSuccess 'yarn generate-api'",
     "lint": "eslint src/**/*.ts",
     "test": "vitest --global test.ts",
-    "format": "prettier --write 'src/**/*.{js,ts}'",
+    "format": "prettier --write .",
+    "format:staged": "pretty-quick --staged",
     "prerelease": "yarn build && cd ./tests && yarn generate && yarn build",
     "release": "dotenv release-it",
     "postrelease": "yarn build && yarn update-samples",
@@ -83,7 +84,8 @@
     "husky": "^7.0.2",
     "lint-staged": "^12.3.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.5.1",
+    "prettier": "2.6.2",
+    "pretty-quick": "^3.1.3",
     "release-it": "^14.12.5",
     "rimraf": "^3.0.2",
     "tsup": "^5.12.0",
@@ -97,6 +99,7 @@
     "cac": "^6.7.12",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
+    "compare-versions": "^4.1.3",
     "cuid": "^2.1.8",
     "debug": "^4.3.3",
     "esbuild": "^0.14.25",