openapi-ts-request 1.12.0 → 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 类型 |
@@ -287,6 +287,8 @@ openapi --i ./spec.json --o ./apis
 | exportFormat | string | 指定导出的 OpenAPI 文件的格式，可以有值如 'JSON' 或 'YAML' | 'JSON' |
 | includeApifoxExtensionProperties | boolean | 指定是否包含 Apifox 的 OpenAPI 规范扩展字段 `x-apifox` | false |
 | addFoldersToTags | boolean | 指定是否在标签字段中包含接口的目录名称 | false |
+| branchId | number | 分支ID | false |
+| moduleId | number | 模块ID | false |
 
 ## JSON Schemas
 

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/generator/serviceGenarator.js

@@ -1011,6 +1011,7 @@ class ServiceGenerator {
         return Helper.getProps({
             schemaObject,
             getType: (schema, namespace) => this.getType(schema, namespace),
+            openAPIData: this.openAPIData,
         });
     }
     resolveParameterRef(param) {

package/dist/generator/serviceGeneratorHelper.d.ts

@@ -67,6 +67,7 @@ export declare function resolveAllOfObject(params: {
 export declare function getProps(params: {
     schemaObject: SchemaObject;
     getType: (schema: SchemaObject) => string;
+    openAPIData?: OpenAPIObject;
 }): IPropObject[];
 /**
  * 解析参数引用

package/dist/generator/serviceGeneratorHelper.js

@@ -145,19 +145,36 @@ function resolveAllOfObject(params) {
  */
 function getProps(params) {
     var _a;
-    const { schemaObject, getType } = params;
+    const { schemaObject, getType, openAPIData } = params;
     const requiredPropKeys = (_a = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.required) !== null && _a !== void 0 ? _a : false;
     const properties = schemaObject.properties;
     return (0, lodash_1.keys)(properties).map((propKey) => {
+        var _a, _b;
         const schema = ((properties === null || properties === void 0 ? void 0 : properties[propKey]) || config_2.DEFAULT_SCHEMA);
         // 剔除属性键值中的特殊符号，因为函数入参变量存在特殊符号会导致解析文件失败
         // eslint-disable-next-line no-useless-escape
         propKey = propKey.replace(/[\[|\]]/g, '');
+        // 获取描述信息，如果是 $ref 引用，尝试获取引用对象的描述
+        let desc = [schema.title, schema.description]
+            .filter((item) => item)
+            .join(' ')
+            .replace(config_2.lineBreakReg, '');
+        // 如果是 $ref 引用，尝试获取引用对象的描述
+        if ((0, util_1.isReferenceObject)(schema) && openAPIData) {
+            const refName = (0, util_1.getLastRefName)(schema.$ref);
+            const refSchema = (_b = (_a = openAPIData.components) === null || _a === void 0 ? void 0 : _a.schemas) === null || _b === void 0 ? void 0 : _b[refName];
+            if (refSchema) {
+                const refDesc = [refSchema.title, refSchema.description]
+                    .filter((item) => item)
+                    .join(' ')
+                    .replace(config_2.lineBreakReg, '');
+                if (refDesc) {
+                    desc = desc + refDesc;
+                }
+            }
+        }
         // 复用 schema 部分字段
-        return Object.assign(Object.assign({}, schema), { name: propKey, type: getType(schema), desc: [schema.title, schema.description]
-                .filter((item) => item)
-                .join(' ')
-                .replace(config_2.lineBreakReg, ''), 
+        return Object.assign(Object.assign({}, schema), { name: propKey, type: getType(schema), desc: desc, 
             // 如果没有 required 信息，默认全部是非必填
             required: requiredPropKeys
                 ? requiredPropKeys.some((key) => key === propKey)

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/dist/type.d.ts

@@ -96,13 +96,15 @@ export interface APIFoxBody {
     oasVersion?: '2.0' | '3.0' | '3.1';
     exportFormat?: 'JSON' | 'YAML';
     environmentIds?: string[];
+    branchId?: number;
+    moduleId?: number;
 }
-export interface GetSchemaByApifoxProps extends Pick<APIFoxBody, 'oasVersion' | 'exportFormat'>, Pick<APIFoxBody['options'], 'includeApifoxExtensionProperties' | 'addFoldersToTags'> {
+export type GetSchemaByApifoxProps = {
     projectId: string;
     apifoxToken: string;
     locale?: string;
     apifoxVersion?: string;
     selectedTags?: string[];
     excludedByTags?: string[];
-}
+} & Pick<APIFoxBody, 'oasVersion' | 'exportFormat' | 'branchId' | 'moduleId'> & APIFoxBody['options'];
 export {};

package/dist/util.js

@@ -32,7 +32,7 @@ exports.getImportStatement = getImportStatement;
  * @param params.apifoxVersion {string} apifox 版本 目前固定为 2024-03-28 可通过 https://api.apifox.com/v1/versions 获取最新版本
  * @returns
  */
-const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ projectId, locale = 'zh-CN', apifoxVersion = '2024-03-28', selectedTags, excludedByTags = [], apifoxToken, oasVersion = '3.0', exportFormat = 'JSON', includeApifoxExtensionProperties = false, addFoldersToTags = false, }) {
+const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, function* ({ projectId, locale = 'zh-CN', apifoxVersion = '2024-03-28', selectedTags, excludedByTags = [], apifoxToken, oasVersion = '3.0', exportFormat = 'JSON', includeApifoxExtensionProperties = false, addFoldersToTags = false, branchId, moduleId, }) {
     try {
         const body = {
             scope: {
@@ -45,6 +45,12 @@ const getSchemaByApifox = (_a) => tslib_1.__awaiter(void 0, [_a], void 0, functi
             oasVersion,
             exportFormat,
         };
+        if (branchId !== undefined) {
+            body.branchId = branchId;
+        }
+        if (moduleId !== undefined) {
+            body.moduleId = moduleId;
+        }
         const tags = !(0, lodash_1.isEmpty)(selectedTags) ? selectedTags : '*';
         if (tags === '*') {
             body.scope.type = 'ALL';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.12.0",
+  "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"
   }
 }

package/templates/enum.njk

@@ -4,6 +4,9 @@
 {%- if list.length > 0 %}
   {% for type in list -%}
     {%- if type.isEnum  %}
+      {%- if type.description%} 
+      /** {{ type.description }} */
+      {%- endif %}
       export enum {{ type.typeName | safe }} {{ type.type }};
 
       export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}

package/templates/interface.njk

@@ -43,6 +43,9 @@
       {%- endfor %}
     {%- else %}
       {%- if type.isEnum  %}
+        {%- if type.description%} 
+        /** {{ type.description }} */
+        {%- endif %}
         export enum {{ type.typeName | safe }} {{ type.type }};
 
         export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}