openapi-ts-request 1.9.1 → 1.10.0

package/README.md

@@ -45,19 +45,20 @@ pnpm i openapi-ts-request -D
 > 配置文件还支持 **_.openapi-ts-request.ts_**, **_openapi-ts-request.config.cjs_** 等格式，参考 [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#cosmiconfig)
 
 ```ts
-import type { GenerateServiceProps } from 'openapi-ts-request';
+import { defineConfig } from 'openapi-ts-request';
 
-export default {
+export default defineConfig({
   schemaPath: 'http://petstore.swagger.io/v2/swagger.json',
-} as GenerateServiceProps;
+  serversPath: './src/apis',
+});
 ```
 
 支持传入数组配置进行生成
 
 ```ts
-import type { GenerateServiceProps } from 'openapi-ts-request';
+import { defineConfig } from 'openapi-ts-request';
 
-export default [
+export default defineConfig([
   {
     schemaPath: 'http://app.swagger.io/v2/swagger.json',
     serversPath: './src/apis/app',
@@ -66,7 +67,7 @@ export default [
     schemaPath: 'http://auth.swagger.io/v2/swagger.json',
     serversPath: './src/apis/auth',
   },
-] as GenerateServiceProps[];
+]);
 ```
 
 在 `package.json` 的 `script` 中添加命令: `"openapi": "openapi-ts",`
@@ -190,7 +191,7 @@ $ openapi --help
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
-    --filterCaseInsensitive <boolean>   whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters
+    --filterCaseInsensitive <boolean>   whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters (default: false)
     --includeTags <(string|RegExp)[]>   generate code from include tags
     --includePaths <(string|RegExp)[]>  generate code from include paths
     --excludeTags <(string|RegExp)[]>   generate code from exclude tags
@@ -227,6 +228,7 @@ openapi --i ./spec.json --o ./apis
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
 | full | 否 | boolean | true | 是否全量替换 |
+| describe | 否 | string | - | 描述信息，在用 cli 可交互运行方式时会用到 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
 | priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
 | filterCaseInsensitive | 否 | boolean | false | 执行 includeTags、includePaths、excludeTags、excludePaths 过滤时是否忽略大小写 |
@@ -266,6 +268,8 @@ openapi --i ./spec.json --o ./apis
 | customTemplates | {<br>[TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;<br>} | 自定义模板，详情请看源码 |
 | customRenderTemplateData | {<br>[TypescriptFileType]?: (list: any[], context: {fileName: string, params: Record<string, unknown>}) => any[]<br>} | 自定义文件生成时的 list 参数处理，支持对不同文件类型进行精细化控制 |
 
+[hooks 示例](https://github.com/openapi-ui/openapi-ts-request/blob/main/agents.md#-advanced-customization-hooks)
+
 ## Apifox-Config
 
 | 属性 | 类型 | 说明 | 必填 |
@@ -343,7 +347,8 @@ export default {
 4. 确保你的代码可以通过所有测试用例(新增功能需要添加新的功能测试用例)：`pnpm test:unit`
 5. 创建 changeset 文件通过命令：`pnpm changeset`
 6. 使用 commit 提交你的修改(需遵循 commitlint 规范)
-7. 发起 Pull Request
+7. 如果涉及文档，请同步更新 README.md、READMD-en_US.md、agents.md
+8. 发起 Pull Request
 
 ## 感谢
 

package/dist/bin/cli.js

@@ -2,9 +2,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const prompts_1 = require("@clack/prompts");
 const commander_1 = require("commander");
 const index_1 = require("../index");
+const log_1 = require("../log");
 const readConfig_1 = require("../readConfig");
 commander_1.program
     .option('-cfn, --configFileName <string>', 'config file name')
@@ -12,6 +13,11 @@ commander_1.program
     .option('-u, --uniqueKey <string>', 'unique key');
 commander_1.program.parse();
 const options = commander_1.program.opts();
+/**
+ * 1. 执行 cli 命令读取配置文件，已经使用 openapi.ts 替代了 cli.ts，后期会废弃 cli.ts
+ * 2. 如果配置文件中有 uniqueKey，则根据 uniqueKey 生成 service
+ * 3. 如果配置文件中没有 uniqueKey，且有多个 service，则交互式选择要生成的 service
+ */
 function run() {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const config = yield (0, readConfig_1.readConfig)({
@@ -25,30 +31,55 @@ function run() {
                 let configs = Array.isArray(config)
                     ? config
                     : [config];
+                /** 是否交互式 */
+                let isInteractive = false;
                 if (options.uniqueKey) {
                     configs = configs.filter((config) => config.uniqueKey === options.uniqueKey);
                 }
+                else if (configs.length > 1) {
+                    // 如果没有指定 uniqueKey，并且有多个配置，则交互式选择
+                    isInteractive = true;
+                    console.log(''); // 添加一个空行
+                    (0, prompts_1.intro)('🎉 欢迎使用 openapi-ts-request 生成器');
+                    const selected = yield (0, prompts_1.multiselect)({
+                        message: '请选择要生成的 service',
+                        options: configs.map((config) => ({
+                            value: config,
+                            label: config.describe || config.schemaPath,
+                        })),
+                    });
+                    if ((0, prompts_1.isCancel)(selected)) {
+                        (0, prompts_1.cancel)('👋 Has cancelled');
+                        process.exit(0);
+                    }
+                    configs = selected;
+                }
                 for (const config of configs) {
                     tasks.push((0, index_1.generateService)(config));
                 }
                 const results = yield Promise.allSettled(tasks);
-                const errors = results.filter((result) => result.status === 'rejected');
                 let errorMsg = '';
-                for (let i = 0; i < errors.length; i++) {
-                    const error = errors[i];
-                    const cnf = configs[i];
-                    errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${error.reason}\n`;
+                for (let i = 0; i < results.length; i++) {
+                    const result = results[i];
+                    if (result.status === 'rejected') {
+                        const cnf = configs[i];
+                        errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${result.reason}\n`;
+                    }
                 }
                 if (errorMsg) {
                     throw new Error(errorMsg);
                 }
+                if (isInteractive && !errorMsg) {
+                    (0, prompts_1.outro)('🎉 All done!');
+                }
             }
             else {
                 throw new Error('config is not found');
             }
         }
         catch (error) {
-            console.log(chalk_1.default.red(error));
+            (0, log_1.logError)(error);
+            process.exit(1);
         }
     });
 }

package/dist/bin/openapi.js

@@ -2,6 +2,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const prompts_1 = require("@clack/prompts");
 const commander_1 = require("commander");
 const lodash_1 = require("lodash");
 const path_1 = require("path");
@@ -21,8 +22,7 @@ const params = commander_1.program
     .option('--requestLibPath <string>', 'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")')
     .option('-f, --full <boolean>', 'full replacement', true)
     .option('--enableLogging <boolean>', 'open the log', false)
-    .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
-    .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
+    .option('--priorityRule <string>', 'priority rule, include/exclude/both (default: "include")')
     .option('--filterCaseInsensitive <boolean>', 'whether to perform a case-insensitive match with includeTags, includePaths, excludeTags, excludePaths filters', false)
     .option('--includeTags <(string|RegExp)[]>', 'generate code from include tags')
     .option('--includePaths <(string|RegExp)[]>', 'generate code from include paths')
@@ -100,33 +100,50 @@ function run() {
             if (cnf) {
                 const tasks = [];
                 let configs = Array.isArray(cnf) ? cnf : [cnf];
+                /** 是否交互式 */
+                let isInteractive = false;
                 if (params.uniqueKey) {
                     configs = configs.filter((config) => config.uniqueKey === params.uniqueKey);
                 }
+                else if (configs.length > 1) {
+                    // 如果没有指定 uniqueKey，并且有多个配置，则交互式选择
+                    isInteractive = true;
+                    console.log(''); // 添加一个空行
+                    (0, prompts_1.intro)('🎉 欢迎使用 openapi-ts-request 生成器');
+                    const selected = yield (0, prompts_1.multiselect)({
+                        message: '请选择要生成的 service',
+                        options: configs.map((config) => ({
+                            value: config,
+                            label: config.describe || config.schemaPath,
+                        })),
+                    });
+                    if ((0, prompts_1.isCancel)(selected)) {
+                        (0, prompts_1.cancel)('👋 Has cancelled');
+                        process.exit(0);
+                    }
+                    configs = selected;
+                }
                 for (const config of configs) {
                     tasks.push((0, index_1.generateService)(config));
                 }
                 const results = yield Promise.allSettled(tasks);
-                const errors = results.filter((result) => result.status === 'rejected');
                 let errorMsg = '';
-                for (let i = 0; i < errors.length; i++) {
-                    const error = errors[i];
-                    const cnf = configs[i];
-                    errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${error.reason}\n`;
+                for (let i = 0; i < results.length; i++) {
+                    const result = results[i];
+                    if (result.status === 'rejected') {
+                        const cnf = configs[i];
+                        errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${result.reason}\n`;
+                    }
                 }
                 if (errorMsg) {
-                    (0, log_1.logError)(errorMsg);
-                    process.exit(1);
+                    throw new Error(errorMsg);
+                }
+                if (isInteractive && !errorMsg) {
+                    (0, prompts_1.outro)('🎉 All done!');
                 }
             }
             else {
-                if (!params.input || !params.output) {
-                    (0, log_1.logError)('Please provide either input/output options or a configuration file path and name.');
-                    process.exit(1);
-                }
-                const options = baseGenerate(params);
-                yield (0, index_1.generateService)((0, lodash_1.pickBy)(options, (value) => value !== null && value !== undefined && value !== ''));
-                process.exit(0);
+                throw new Error('Please provide either input/output options or a configuration file path and name.');
             }
         }
         catch (error) {

package/dist/generator/serviceGenarator.js

@@ -249,7 +249,7 @@ class ServiceGenerator {
             displayTypeLabelFileName: config_2.displayTypeLabelFileName,
         });
         // 打印日志
-        (0, log_1.default)('✅ 成功生成 api 文件目录-> ', this.config.serversPath);
+        (0, log_1.default)('✅ 成功生成 api 文件目录-> ', `  ${this.config.serversPath}`);
     }
     getInterfaceTPConfigs() {
         var _a, _b, _c;
@@ -391,7 +391,7 @@ class ServiceGenerator {
             // 暂不支持变量, path 需要普通前缀请使用例如: apiPrefix: "`api`", path 需要变量前缀请使用例如: apiPrefix: "api"
             !api.path.includes('${'))
                 .map((api) => {
-                var _a, _b, _c, _d, _e, _f;
+                var _a, _b, _c, _d, _e, _f, _g, _h;
                 const newApi = api;
                 try {
                     const params = this.getParamsTP(newApi.parameters, newApi.path) || {};
@@ -422,9 +422,13 @@ class ServiceGenerator {
                     }
                     if (response === null || response === void 0 ? void 0 : response.isAnonymous) {
                         const responseName = (0, lodash_1.upperFirst)(`${functionName}Response`);
+                        // 使用正则表达式移除 response?.type 中包含 this.config.namespace 的部分，isAnonymous模式不需要 this.config.namespace 前缀
+                        const cleanType = ((_b = response === null || response === void 0 ? void 0 : response.type) === null || _b === void 0 ? void 0 : _b.includes(`${this.config.namespace}.`))
+                            ? (_c = response === null || response === void 0 ? void 0 : response.type) === null || _c === void 0 ? void 0 : _c.replace(new RegExp(`${this.config.namespace}\\.`, 'g'), '')
+                            : (response === null || response === void 0 ? void 0 : response.type) || '';
                         this.interfaceTPConfigs.push({
                             typeName: responseName,
-                            type: response === null || response === void 0 ? void 0 : response.type,
+                            type: cleanType,
                             isEnum: false,
                             props: [],
                         });
@@ -494,13 +498,13 @@ class ServiceGenerator {
                             : [
                                 newApi.summary,
                                 newApi.description,
-                                ((_c = (_b = newApi.responses) === null || _b === void 0 ? void 0 : _b.default) === null || _c === void 0 ? void 0 : _c.description)
-                                    ? `返回值: ${((_d = newApi.responses) === null || _d === void 0 ? void 0 : _d.default).description}`
+                                ((_e = (_d = newApi.responses) === null || _d === void 0 ? void 0 : _d.default) === null || _e === void 0 ? void 0 : _e.description)
+                                    ? `返回值: ${((_f = newApi.responses) === null || _f === void 0 ? void 0 : _f.default).description}`
                                     : '',
                             ]
                                 .filter((s) => s)
                                 .join(' ')
-                                .replace(config_2.lineBreakReg, ''), hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_f = (_e = this.config.hook) === null || _e === void 0 ? void 0 : _e.customOptionsDefaultValue) === null || _f === void 0 ? void 0 : _f.call(_e, newApi)) || {}, body,
+                                .replace(config_2.lineBreakReg, ''), hasHeader: !!(params === null || params === void 0 ? void 0 : params.header) || !!(body === null || body === void 0 ? void 0 : body.mediaType), params: finalParams, hasParams: Boolean((0, lodash_1.keys)(finalParams).length), options: ((_h = (_g = this.config.hook) === null || _g === void 0 ? void 0 : _g.customOptionsDefaultValue) === null || _h === void 0 ? void 0 : _h.call(_g, newApi)) || {}, body,
                         file, hasFormData: formData, response });
                 }
                 catch (error) {

package/dist/index.d.ts

@@ -23,6 +23,10 @@ export type GenerateServiceProps = {
      * 是否全量替换, 默认: true, 如果为false, 则进行增量替换
      */
     full?: boolean;
+    /**
+     * 描述信息，在用 cli 可交互运行方式时会用到
+     */
+    describe?: string;
     /**
      * 开启日志
      */
@@ -280,3 +284,7 @@ export type GenerateServiceProps = {
     };
 };
 export declare function generateService({ requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, includePaths, excludePaths, authorization, isTranslateToEnglishTag, priorityRule, timeout, reactQueryMode, apifoxConfig, ...rest }: GenerateServiceProps): Promise<void>;
+/**
+ * Defines the configuration for openapi-ts-request.
+ */
+export declare function defineConfig(config: GenerateServiceProps | GenerateServiceProps[]): GenerateServiceProps | GenerateServiceProps[];

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateService = generateService;
+exports.defineConfig = defineConfig;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const config_1 = require("./config");
@@ -53,3 +54,9 @@ function generateService(_a) {
         }
     });
 }
+/**
+ * Defines the configuration for openapi-ts-request.
+ */
+function defineConfig(config) {
+    return config;
+}

package/dist/log.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.logError = void 0;
 const tslib_1 = require("tslib");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const log = (...rest) => console.log(`${chalk_1.default.blue('[openAPI]')}: ${rest.join('\n')}`);
-const logError = (...rest) => console.error(`${chalk_1.default.red('❌ [openAPI]')}: ${rest.join('\n')}`);
+const log = (...rest) => console.log(`  ${chalk_1.default.blue('[openAPI]')}: ${rest.join('\n')}`);
+const logError = (...rest) => console.error(`  ${chalk_1.default.red('❌ [openAPI]')}: ${rest.join('\n')}`);
 exports.logError = logError;
 exports.default = log;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "Swagger2/OpenAPI3/Apifox to TypeScript/JavaScript, request client(support any client), request mock service, enum and enum translation, react-query/vue-query, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",
@@ -24,6 +24,7 @@
     "prettier.config.cjs"
   ],
   "dependencies": {
+    "@clack/prompts": "^0.11.0",
     "@prettier/sync": "^0.6.1",
     "@trivago/prettier-plugin-sort-imports": "^5.2.1",
     "axios": "^1.7.2",