openapi-ts-request 0.6.0 → 0.8.0

package/README.md

@@ -135,7 +135,7 @@ $ openapi --help
     -i, --input <string>               OpenAPI specification, can be a path, url (required)
     -o, --output <string>              output directory (required)
     --requestLibPath <string>          custom request lib path, for example: "@/request", "node-fetch", default is "axios"
-    --allowedTags <string[]>           generate results from allowed tags
+    --allowedTags <string[]>           generate code from allowed tags
     --requestOptionsType <string>      custom request method options parameter type (default: "{ [key:
                                       string]: unknown }")
     --requestImportStatement <string>  custom request import statement, for example: "const request =
@@ -145,6 +145,7 @@ $ openapi --help
     --isDisplayTypeLabel <boolean>     generate label matching type field (default: false)
     --isGenJsonSchemas <boolean>       generate JSON Schemas (default: false)
     --mockFolder <string>              mock file path
+    --authorization <string>           docs authorization
     --nullable <boolean>               null instead of optional (default: false)
     --isTranslateToEnglishTag <boolean>translate chinese tag name to english tag name (default: false)
     --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
@@ -164,13 +165,14 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 生成结果的文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
-| allowedTags | 否 | string[] | - | 根据指定的 tags 生成结果 |
+| allowedTags | 否 | string[] | - | 根据指定的 tags 生成代码 |
 | requestOptionsType | 否 | string | '{ [key: string]: unknown }' | 自定义请求方法 options 参数类型 |
 | requestImportStatement | 否 | string | - | 自定义请求方法表达式，例如："const request = require('@/request')" |
 | apiPrefix | 否 | string | - | api path的前缀，例如：'api'(动态变量), "'api'"(字符串) |
 | isDisplayTypeLabel | 否 | boolean | false | 是否生成 type 对应的label |
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | './mocks' | mock文件路径 |
+| authorization | 否 | string | - | 文档权限凭证 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |

package/dist/bin/openapi.js

@@ -20,6 +20,7 @@ const params = commander_1.program
     .option('--isDisplayTypeLabel <boolean>', 'generate label matching type field', false)
     .option('--isGenJsonSchemas <boolean>', 'generate JSON Schemas', false)
     .option('--mockFolder <string>', 'mock file path')
+    .option('--authorization <string>', 'docs authorization')
     .option('--nullable <boolean>', 'null instead of optional', false)
     .option('--isTranslateToEnglishTag <boolean>', 'translate chinese tag name to english tag name', false)
     .option('--isCamelCase <boolean>', 'camelCase naming of controller files and request client', true)
@@ -47,6 +48,7 @@ function run() {
                 isDisplayTypeLabel: JSON.parse(params.isDisplayTypeLabel) === true,
                 isGenJsonSchemas: JSON.parse(params.isGenJsonSchemas) === true,
                 mockFolder: params.mockFolder,
+                authorization: params.authorization,
                 nullable: JSON.parse(params.nullable) === true,
                 isTranslateToEnglishTag: JSON.parse(params.isTranslateToEnglishTag) === true,
                 isCamelCase: JSON.parse(params.isCamelCase) === true,

package/dist/generator/serviceGenarator.js

@@ -87,10 +87,11 @@ class ServiceGenerator {
                 interfaceFileName: config_1.interfaceFileName,
             });
         }
+        const displayTypeLabels = (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum);
         // 生成 type 翻译
-        if (this.config.isDisplayTypeLabel) {
+        if (this.config.isDisplayTypeLabel && !(0, lodash_1.isEmpty)(displayTypeLabels)) {
             this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
-                list: (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum),
+                list: displayTypeLabels,
                 namespace: this.config.namespace,
                 interfaceFileName: config_1.interfaceFileName,
             });
@@ -104,15 +105,7 @@ class ServiceGenerator {
         if (prettierError.includes(true)) {
             (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
         }
-        // 生成 service index 文件
-        this.genFileFromTemplate(`${config_1.serviceEntryFileName}.ts`, config_1.TypescriptFileType.serviceIndex, {
-            list: this.classNameList,
-            namespace: this.config.namespace,
-            interfaceFileName: config_1.interfaceFileName,
-            schemaFileName: config_1.schemaFileName,
-            isGenJsonSchemas: this.config.isGenJsonSchemas,
-        });
-        if (this.config.isGenJsonSchemas) {
+        if (this.config.isGenJsonSchemas && !(0, lodash_1.isEmpty)(this.schemaList)) {
             // 处理重复的 schemaName
             (0, util_1.handleDuplicateTypeNames)(this.schemaList);
             // 生成 schema 文件
@@ -120,6 +113,18 @@ class ServiceGenerator {
                 list: this.schemaList,
             });
         }
+        // 生成 service index 文件
+        this.genFileFromTemplate(`${config_1.serviceEntryFileName}.ts`, config_1.TypescriptFileType.serviceIndex, {
+            list: this.classNameList,
+            namespace: this.config.namespace,
+            interfaceFileName: config_1.interfaceFileName,
+            isGenJsonSchemas: this.config.isGenJsonSchemas && !(0, lodash_1.isEmpty)(this.schemaList),
+            schemaFileName: config_1.schemaFileName,
+            isDisplayEnumLabel: !(0, lodash_1.isEmpty)(enums),
+            displayEnumLabelFileName: config_1.displayEnumLabelFileName,
+            isDisplayTypeLabel: this.config.isDisplayTypeLabel && !(0, lodash_1.isEmpty)(displayTypeLabels),
+            displayTypeLabelFileName: config_1.displayTypeLabelFileName,
+        });
         // 打印日志
         (0, log_1.default)('✅ 成功生成 api 文件');
     }

package/dist/index.d.ts

@@ -56,6 +56,10 @@ export type GenerateServiceProps = {
      * mock目录
      */
     mockFolder?: string;
+    /**
+     * 文档权限凭证
+     */
+    authorization?: string;
     /**
      * 默认为false，true时使用null代替可选值
      */
@@ -135,4 +139,4 @@ export type GenerateServiceProps = {
         customFileNames?: (operationObject: OperationObject, apiPath: string, apiMethod: string) => string[] | null;
     };
 };
-export declare function generateService({ requestLibPath, schemaPath, mockFolder, allowedTags, isTranslateToEnglishTag, ...rest }: GenerateServiceProps): Promise<void>;
+export declare function generateService({ requestLibPath, schemaPath, mockFolder, allowedTags, authorization, isTranslateToEnglishTag, ...rest }: GenerateServiceProps): Promise<void>;

package/dist/index.js

@@ -9,11 +9,11 @@ const util_1 = require("./util");
 tslib_1.__exportStar(require("./generator/patchSchema"), exports);
 function generateService(_a) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        var { requestLibPath, schemaPath, mockFolder, allowedTags, isTranslateToEnglishTag } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "allowedTags", "isTranslateToEnglishTag"]);
+        var { requestLibPath, schemaPath, mockFolder, allowedTags, authorization, isTranslateToEnglishTag } = _a, rest = tslib_1.__rest(_a, ["requestLibPath", "schemaPath", "mockFolder", "allowedTags", "authorization", "isTranslateToEnglishTag"]);
         if (!schemaPath) {
             return;
         }
-        const openAPI = (yield (0, util_1.getOpenAPIConfig)(schemaPath));
+        const openAPI = (yield (0, util_1.getOpenAPIConfig)(schemaPath, authorization));
         if ((0, lodash_1.isEmpty)(openAPI)) {
             return;
         }

package/dist/util.d.ts

@@ -1,6 +1,6 @@
 import { OpenAPI } from 'openapi-types';
 import { OpenAPIObject } from './type';
 export declare const getImportStatement: (requestLibPath: string) => string;
-export declare const getOpenAPIConfig: (schemaPath: string) => Promise<OpenAPI.Document<{}>>;
+export declare const getOpenAPIConfig: (schemaPath: string, authorization?: string) => Promise<OpenAPI.Document<{}>>;
 export declare function parseSwaggerOrOpenapi(content: string | OpenAPI.Document): Promise<OpenAPI.Document<{}>>;
 export declare function translateChineseModuleNodeToEnglish(openAPI: OpenAPIObject): Promise<unknown>;

package/dist/util.js

@@ -23,7 +23,7 @@ const getImportStatement = (requestLibPath) => {
     return `import request from 'axios';`;
 };
 exports.getImportStatement = getImportStatement;
-function getSchema(schemaPath) {
+function getSchema(schemaPath, authorization) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         if (schemaPath.startsWith('http')) {
             const isHttps = schemaPath.startsWith('https:');
@@ -34,7 +34,7 @@ function getSchema(schemaPath) {
                 });
                 const config = isHttps ? { httpsAgent: agent } : { httpAgent: agent };
                 const json = yield axios_1.default
-                    .get(schemaPath, config)
+                    .get(schemaPath, Object.assign(Object.assign({}, config), { headers: { authorization } }))
                     .then((res) => res.data);
                 return json;
             }
@@ -80,8 +80,8 @@ function converterSwaggerToOpenApi(swagger) {
         });
     });
 }
-const getOpenAPIConfig = (schemaPath) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-    const schema = yield getSchema(schemaPath);
+const getOpenAPIConfig = (schemaPath, authorization) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const schema = yield getSchema(schemaPath, authorization);
     if (!schema) {
         return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "repository": {
     "type": "git",
@@ -60,7 +60,7 @@
     "husky": "^9.0.11",
     "lint-staged": "^15.2.5",
     "openapi-types": "^12.1.3",
-    "typescript": "5.6.2"
+    "typescript": "5.6.3"
   },
   "keywords": [
     "openapi",

package/templates/interface.njk

@@ -52,5 +52,5 @@
     {%- endif %}
   {% endfor %}
 {%- else %}
-  export default {}
+  export {}
 {%- endif %}

package/templates/schema.njk

@@ -3,6 +3,4 @@
   export const {{ type.typeName }} = {{ type.type }}
 
   {% endfor -%}
-{%- else %}
-  export default {}
 {%- endif %}

package/templates/serviceIndex.njk

@@ -1,6 +1,12 @@
 /* eslint-disable */
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
+{%- if isDisplayEnumLabel %}
+import * as displayEnumLabels from './{{ displayEnumLabelFileName }}';
+{%- endif %}
+{%- if isDisplayTypeLabel %}
+import * as displayTypeLabels from './{{ displayTypeLabelFileName }}';
+{%- endif %}
 {%- if isGenJsonSchemas %}
 import * as schemas from './{{ schemaFileName }}';
 {%- endif %}
@@ -8,11 +14,17 @@ import * as schemas from './{{ schemaFileName }}';
 import * as {{ api.controllerName }} from './{{ api.fileName }}';
 {% endfor -%}
 
-export default {
+export {
+  {{ namespace }},
+  {%- if isDisplayEnumLabel %}
+  displayEnumLabels,
+  {%- endif %}
+  {%- if isDisplayTypeLabel %}
+  displayTypeLabels,
+  {%- endif %}
   {%- if isGenJsonSchemas %}
   schemas,
   {%- endif %}
-  {{ namespace }},
   {% for api in list -%}
   {{ api.controllerName }},
   {% endfor -%}