openapi-ts-request 1.12.1 → 1.12.2

package/README.md

@@ -225,7 +225,8 @@ openapi --i ./spec.json --o ./apis
 
 | 属性 | 必填 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- | --- |
-| schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
+| schemaPath | 否\* | string | - | Swagger2/OpenAPI3 地址（与 apifoxConfig 互斥，两者必填其一） |
+| apifoxConfig | 否\* | [Apifox Config](#Apifox-Config) | - | apifox 配置（与 schemaPath 互斥，两者必填其一） |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
 | isSplitTypesByModule | 否 | boolean | false | 按模块拆分类型文件，开启后会生成：{module}.type.ts（各模块类型）、common.type.ts（公共类型）、enum.ts（枚举类型）、types.ts（统一导出） |
@@ -248,7 +249,6 @@ openapi --i ./spec.json --o ./apis
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |
 | authorization | 否 | string | - | 文档权限凭证 |
-| apifoxConfig | 否 | [Apifox Config](#Apifox-Config) | - | apifox 配置 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |

package/dist/bin/cli.js

@@ -7,6 +7,7 @@ const commander_1 = require("commander");
 const index_1 = require("../index");
 const log_1 = require("../log");
 const readConfig_1 = require("../readConfig");
+const utils_1 = require("./utils");
 commander_1.program
     .option('-cfn, --configFileName <string>', 'config file name')
     .option('-cfp, --configFilePath <string>', 'config file path');
@@ -38,10 +39,7 @@ function run() {
                     (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,
-                        })),
+                        options: (0, utils_1.createMultiselectOptions)(configs),
                     });
                     if ((0, prompts_1.isCancel)(selected)) {
                         (0, prompts_1.cancel)('👋 Has cancelled');
@@ -58,7 +56,8 @@ function run() {
                     const result = results[i];
                     if (result.status === 'rejected') {
                         const cnf = configs[i];
-                        const label = cnf.describe || cnf.schemaPath;
+                        const label = cnf.describe ||
+                            ('schemaPath' in cnf ? cnf.schemaPath : 'Apifox Config');
                         errorMsg += `${label}${label && ':'}${result.reason}\n`;
                     }
                 }

package/dist/bin/openapi.js

@@ -10,6 +10,7 @@ const pkg = tslib_1.__importStar(require("../../package.json"));
 const index_1 = require("../index");
 const log_1 = require("../log");
 const readConfig_1 = require("../readConfig");
+const utils_1 = require("./utils");
 const params = commander_1.program
     .name('openapi')
     .usage('[options]')
@@ -112,10 +113,7 @@ function run() {
                     (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,
-                        })),
+                        options: (0, utils_1.createMultiselectOptions)(configs),
                     });
                     if ((0, prompts_1.isCancel)(selected)) {
                         (0, prompts_1.cancel)('👋 Has cancelled');
@@ -132,7 +130,8 @@ function run() {
                     const result = results[i];
                     if (result.status === 'rejected') {
                         const cnf = configs[i];
-                        const label = cnf.describe || cnf.schemaPath;
+                        const label = cnf.describe ||
+                            ('schemaPath' in cnf ? cnf.schemaPath : 'Apifox Config');
                         errorMsg += `${label}${label && ':'}${result.reason}\n`;
                     }
                 }

package/dist/bin/utils.d.ts

@@ -0,0 +1,8 @@
+import type { GenerateServiceProps } from '../index';
+/**
+ * Helper function to create multiselect options with proper typing
+ */
+export declare function createMultiselectOptions(configs: GenerateServiceProps[]): Array<{
+    value: GenerateServiceProps;
+    label: string;
+}>;

package/dist/bin/utils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMultiselectOptions = createMultiselectOptions;
+/**
+ * Helper function to create multiselect options with proper typing
+ */
+function createMultiselectOptions(configs) {
+    return configs.map((config) => ({
+        value: config,
+        label: config.describe ||
+            ('schemaPath' in config ? config.schemaPath : 'Apifox Config'),
+    }));
+}

package/dist/index.d.ts

@@ -1,13 +1,9 @@
 import type { TypescriptFileType } from './generator/config';
 import type { APIDataType, ControllerType, ISchemaItem, ITypeItem } from './generator/type';
-import type { ComponentsObject, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
+import type { ComponentsObject, IPriorityRule, IReactQueryMode, MutuallyExclusive, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
 import { type GetSchemaByApifoxProps } from './type';
 export * from './generator/patchSchema';
-export type GenerateServiceProps = {
-    /**
-     * Swagger2/OpenAPI3 地址
-     */
-    schemaPath: string;
+export type GenerateServicePropsBase = {
     /**
      * 生成的文件夹的路径
      */
@@ -113,10 +109,6 @@ export type GenerateServiceProps = {
      * 文档权限凭证
      */
     authorization?: string;
-    /**
-     * apifox 配置
-     */
-    apifoxConfig?: GetSchemaByApifoxProps;
     /**
      * 默认为false，true时使用null代替可选值
      */
@@ -291,6 +283,19 @@ export type GenerateServiceProps = {
         };
     };
 };
+/**
+ * Swagger2/OpenAPI3 地址或 Apifox 配置，两者必须填写一个
+ */
+export type GenerateServiceProps = GenerateServicePropsBase & MutuallyExclusive<{
+    /**
+     * Swagger2/OpenAPI3 地址
+     */
+    schemaPath: string;
+    /**
+     * apifox 配置
+     */
+    apifoxConfig: GetSchemaByApifoxProps;
+}>;
 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.

package/dist/index.js

@@ -13,7 +13,10 @@ function generateService(_a) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         var { requestLibPath, schemaPath, mockFolder, includeTags, excludeTags, includePaths, excludePaths, authorization, isTranslateToEnglishTag, priorityRule = config_1.PriorityRule.include, timeout = 60000, reactQueryMode = config_1.ReactQueryMode.react, apifoxConfig } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "includeTags", "excludeTags", "includePaths", "excludePaths", "authorization", "isTranslateToEnglishTag", "priorityRule", "timeout", "reactQueryMode", "apifoxConfig"]);
         if (!schemaPath && !apifoxConfig) {
-            return;
+            throw new Error('Either schemaPath or apifoxConfig must be provided. Please provide at least one configuration option.');
+        }
+        if (schemaPath && apifoxConfig) {
+            throw new Error('schemaPath and apifoxConfig cannot be provided at the same time. Please provide only one configuration option.');
         }
         let openAPI = null;
         if (apifoxConfig) {
@@ -34,7 +37,7 @@ function generateService(_a) {
             }
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, enableLogging: false, priorityRule, includeTags: includeTags
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign(Object.assign(Object.assign({}, (schemaPath ? { schemaPath } : { apifoxConfig })), { serversPath: './src/apis', requestImportStatement, enableLogging: false, priorityRule, includeTags: includeTags
                 ? includeTags
                 : priorityRule === config_1.PriorityRule.include ||
                     priorityRule === config_1.PriorityRule.both
@@ -44,7 +47,7 @@ function generateService(_a) {
                 : priorityRule === config_1.PriorityRule.include ||
                     priorityRule === config_1.PriorityRule.both
                     ? [/.*/g]
-                    : null, excludeTags: excludeTags ? excludeTags : null, excludePaths: excludePaths ? excludePaths : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true, isSupportParseEnumDesc: false, full: true }, rest), openAPI);
+                    : null, excludeTags: excludeTags ? excludeTags : null, excludePaths: excludePaths ? excludePaths : null, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', isGenReactQuery: false, reactQueryMode, isGenJavaScript: false, isDisplayTypeLabel: false, isGenJsonSchemas: false, nullable: false, isOnlyGenTypeScriptType: false, isCamelCase: true, isSupportParseEnumDesc: false, full: true }), rest), openAPI);
         serviceGenerator.genFile();
         if (mockFolder) {
             (0, mockGenarator_1.mockGenerator)({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.12.1",
+  "version": "1.12.2",
   "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",
@@ -96,6 +96,6 @@
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test:unit": "vitest",
-    "openapi-ts-request": "openapi-ts"
+    "openapi-ts-request": "openapi"
   }
 }