openapi-ts-request 0.1.3 → 0.2.0

package/README.md

@@ -9,7 +9,7 @@
 ## Features
 
 * supports Swagger2.0/OpenAPI 3.0,3.1 specifications
-* generate TypeScript Interfaces, Reuquest clients, Request Mock Service, Enum, Display Field Babel
+* generate TypeScript Interfaces, Reuquest clients, Request Mock Service, Enum, Display Type Field Label
 * supports Custom Request Function, Fetch、Axios、Uniapp-Request、Node.js、XHR client available
 * supports filter specifications by tags
 * supports JSON specifications
@@ -108,6 +108,7 @@ npm run openapi
 | requestOptionsType  | 否 | 自定义请求方法 options 参数类型 | string | '{ [key: string]: unknown }' |
 | requestImportStatement  | 否 | 自定义请求方法表达式，例如：'@/request' | string | - |
 | apiPrefix  | 否 | api 的前缀，例如：'api'(动态变量), 指定字符串("'api'") | string | - |
+| isDisplayTypeLabel | 否 | 是否生成 type 对应的label | boolean | false |
 | dataFields | 否 | 定义 response 中数据字段类型 | string[] | - |
 | mockFolder  | 否 | mock目录 | string | './mocks' |
 | nullable | 否 | 使用null代替可选 | boolean | false |

package/dist/generator/config.d.ts

@@ -3,11 +3,13 @@ import { ParameterObject, SchemaObject } from '../type';
 export declare const serviceEntryFileName = "index";
 export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";
+export declare const displayTypeLabelFileName = "displayTypeLabel";
 export declare enum TypescriptFileType {
     interface = "interface",
     serviceController = "serviceController",
     serviceIndex = "serviceIndex",
-    displayEnumLabel = "displayEnumLabel"
+    displayEnumLabel = "displayEnumLabel",
+    displayTypeLabel = "displayTypeLabel"
 }
 export declare const DEFAULT_SCHEMA: SchemaObject;
 export declare const DEFAULT_PATH_PARAM: ParameterObject & Dictionary<unknown>;
@@ -27,3 +29,4 @@ export declare enum parametersInsEnum {
 }
 export declare const parametersIn: string[];
 export declare const numberEnum: string[];
+export declare const lineBreakReg: RegExp;

package/dist/generator/config.js

@@ -1,15 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
+exports.lineBreakReg = exports.numberEnum = exports.parametersIn = exports.parametersInsEnum = exports.methods = exports.DEFAULT_PATH_PARAM = exports.DEFAULT_SCHEMA = exports.TypescriptFileType = exports.displayTypeLabelFileName = exports.displayEnumLabelFileName = exports.interfaceFileName = exports.serviceEntryFileName = void 0;
 exports.serviceEntryFileName = 'index';
 exports.interfaceFileName = 'types';
 exports.displayEnumLabelFileName = 'displayEnumLabel';
+exports.displayTypeLabelFileName = 'displayTypeLabel';
 var TypescriptFileType;
 (function (TypescriptFileType) {
     TypescriptFileType["interface"] = "interface";
     TypescriptFileType["serviceController"] = "serviceController";
     TypescriptFileType["serviceIndex"] = "serviceIndex";
     TypescriptFileType["displayEnumLabel"] = "displayEnumLabel";
+    TypescriptFileType["displayTypeLabel"] = "displayTypeLabel";
 })(TypescriptFileType || (exports.TypescriptFileType = TypescriptFileType = {}));
 exports.DEFAULT_SCHEMA = {
     type: 'object',
@@ -55,3 +57,5 @@ exports.numberEnum = [
     'int32',
     'int64',
 ];
+// 匹配换行符的正则
+exports.lineBreakReg = /[\r\n]+/g;

package/dist/generator/serviceGenarator.js

@@ -82,6 +82,14 @@ class ServiceGenerator {
             namespace: this.config.namespace,
             interfaceFileName: config_1.interfaceFileName,
         });
+        // 生成 type 翻译
+        if (this.config.isDisplayTypeLabel) {
+            this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
+                list: (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum),
+                namespace: this.config.namespace,
+                interfaceFileName: config_1.interfaceFileName,
+            });
+        }
         const prettierError = [];
         // 生成 service controller 文件
         this.getServiceTPConfigs().forEach((tp) => {
@@ -129,7 +137,7 @@ class ServiceGenerator {
                     var _a;
                     props.push({
                         name: parameter.name,
-                        desc: (_a = parameter.description) !== null && _a !== void 0 ? _a : '',
+                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_1.lineBreakReg, ''),
                         required: parameter.required || false,
                         type: this.getType(parameter.schema),
                     });
@@ -139,7 +147,7 @@ class ServiceGenerator {
                     var _a;
                     props.push({
                         name: parameter.name,
-                        desc: (_a = parameter.description) !== null && _a !== void 0 ? _a : '',
+                        desc: ((_a = parameter.description) !== null && _a !== void 0 ? _a : '').replace(config_1.lineBreakReg, ''),
                         required: parameter.required,
                         type: this.getType(parameter.schema),
                     });
@@ -279,7 +287,7 @@ class ServiceGenerator {
                             : functionName, typeName: this.getTypeName(newApi), path: getPrefixPath(), pathInComment: formattedPath.replace(/\*/g, '*'), hasPathVariables: formattedPath.includes('{'), hasApiPrefix: !!this.config.apiPrefix, method: newApi.method, 
                         // 如果 functionName 和 summary 相同，则不显示 summary
                         desc: functionName === newApi.summary
-                            ? newApi.description
+                            ? (newApi.description || '').replace(config_1.lineBreakReg, '')
                             : [
                                 newApi.summary,
                                 newApi.description,
@@ -288,7 +296,8 @@ class ServiceGenerator {
                                     : '',
                             ]
                                 .filter((s) => s)
-                                .join(' '), 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,
+                                .join(' ')
+                                .replace(config_1.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,
                         file, hasFormData: formData, response });
                 }
                 catch (error) {
@@ -325,7 +334,7 @@ class ServiceGenerator {
             nunjucks_1.default.configure({
                 autoescape: false,
             });
-            return (0, file_1.writeFile)(this.config.serversPath, fileName, nunjucks_1.default.renderString(template, Object.assign({ ddisableTypeCheck: false }, params)));
+            return (0, file_1.writeFile)(this.config.serversPath, fileName, nunjucks_1.default.renderString(template, Object.assign({ disableTypeCheck: false }, params)));
         }
         catch (error) {
             console.error('[GenSDK] file gen fail:', fileName, 'type:', type);
@@ -612,7 +621,8 @@ class ServiceGenerator {
             // 复用 schema 部分字段
             return Object.assign(Object.assign({}, schema), { name: propKey, type: this.getType(schema), desc: [schema.title, schema.description]
                     .filter((item) => item)
-                    .join(' '), 
+                    .join(' ')
+                    .replace(config_1.lineBreakReg, ''), 
                 // 如果没有 required 信息，默认全部是非必填
                 required: requiredPropKeys
                     ? requiredPropKeys.some((key) => key === propKey)

package/dist/index.d.ts

@@ -38,6 +38,10 @@ export type GenerateServiceProps = {
         namespace: string;
         functionName: string;
     }) => string);
+    /**
+     * 是否生成 type 对应的label, 默认: false
+     */
+    isDisplayTypeLabel?: boolean;
     /**
      * response中数据字段
      * example: ['result', 'res']

package/dist/index.js

@@ -17,7 +17,7 @@ function generateService(_a) {
             return;
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, allowedTags: allowedTags
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, allowedTags: allowedTags
                 ? (0, lodash_1.map)(allowedTags, (item) => item.toLowerCase())
                 : null }, rest), openAPI);
         serviceGenerator.genFile();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, Request Client, Request Mock Service, Enum, Display Field Label",
   "repository": {
     "type": "git",

package/templates/displayTypeLabel.njk

@@ -0,0 +1,42 @@
+/* eslint-disable */
+// @ts-ignore
+import * as {{ namespace }} from './{{ interfaceFileName }}';
+
+{% for type in list -%}
+  {%- if type.props.length %}
+    export function display{{ type.typeName }}(field: keyof {{ namespace }}.{{ type.typeName }}) {
+      return (
+        {%- for prop in type.props %}
+        {%- if prop.length > 1 %}
+          {
+        {%- endif %}
+        {%- if prop.length == 1 %}
+          {%- if not prop[0].$ref or prop[0].name %}
+          {
+          {%- endif %}
+        {%- endif %}
+          {%- for p in prop %}
+            {%- if p["$ref"] and not p.name %}
+              display{{ p.type | safe }}(field as keyof {{ namespace }}.{{ p.type }})
+            {%- else %}
+              {{ p.name }}: '{{ p.desc if p.desc else p.name }}',
+            {%- endif %}   
+          {%- endfor %}
+        {%- if prop.length > 1 %}
+          }[field]
+        {%- endif %}
+        {%- if prop.length == 1 %}
+          {%- if not prop[0].$ref or prop[0].name %}
+          }[field]
+          {%- endif %}
+        {%- endif %}
+        {%- if prop.length == 0 %}
+          {}
+        {%- endif %}
+        {{ '' if loop.last === true else ' || '  }}
+      {%- endfor %}
+    )
+  }
+  {%- endif %}
+
+{% endfor -%}