openapi-ts-request 1.5.2 → 1.6.1

package/README.md

@@ -340,7 +340,7 @@ export default {
 1. 熟悉 [Pull Request]("https://help.github.com/articles/using-pull-requests") 规范
 2. fork 此仓库
 3. 开一个新分支修改代码：`git checkout -b my-branch main`
-4. 确保你的代码可以通过所有测试用例(新增功能需要添加新的功能测试用例)：`pnpm test`
+4. 确保你的代码可以通过所有测试用例(新增功能需要添加新的功能测试用例)：`pnpm test:unit`
 5. 创建 changeset 文件通过命令：`pnpm changeset`
 6. 使用 commit 提交你的修改(需遵循 commitlint 规范)
 7. 发起 Pull Request

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import { IReactQueryMode } from './type';
+import type { IReactQueryMode } from './type';
 export declare enum SchemaObjectFormat {
     int32 = "int32",
     int64 = "int64",

package/dist/generator/config.d.ts

@@ -1,5 +1,5 @@
-import { Dictionary } from 'lodash';
-import { IReactQueryMode, ParameterObject, SchemaObject } from '../type';
+import type { Dictionary } from 'lodash';
+import type { IReactQueryMode, ParameterObject, SchemaObject } from '../type';
 export declare const serviceEntryFileName = "index";
 export declare const interfaceFileName = "types";
 export declare const displayEnumLabelFileName = "displayEnumLabel";

package/dist/generator/mockGenarator.d.ts

@@ -1,4 +1,4 @@
-import { OpenAPIObject } from '../type';
+import type { OpenAPIObject } from '../type';
 export type genMockDataServerConfig = {
     openAPI: OpenAPIObject;
     mockFolder: string;

package/dist/generator/patchSchema.d.ts

@@ -1,2 +1,2 @@
-import { ComponentsObject, ISchemaObject } from '../type';
+import type { ComponentsObject, ISchemaObject } from '../type';
 export declare function patchSchema<T extends object>(schema: ISchemaObject, schemas: ComponentsObject['schemas']): T;

package/dist/generator/serviceGenarator.d.ts

@@ -1,6 +1,6 @@
 import type { GenerateServiceProps } from '../index';
-import { OpenAPIObject } from '../type';
-import { ControllerType, ISchemaItem, ITypeItem, TagAPIDataType } from './type';
+import type { OpenAPIObject } from '../type';
+import type { ControllerType, ISchemaItem, ITypeItem, TagAPIDataType } from './type';
 export default class ServiceGenerator {
     protected apiData: TagAPIDataType;
     protected classNameList: ControllerType[];

package/dist/generator/serviceGenarator.js

@@ -133,6 +133,7 @@ class ServiceGenerator {
         }
     }
     genFile() {
+        var _a, _b, _c, _d;
         if (this.config.full) {
             try {
                 (0, glob_1.globSync)(`${this.config.serversPath}/**/*`)
@@ -192,8 +193,12 @@ class ServiceGenerator {
         // 生成枚举翻译
         const enums = (0, lodash_1.filter)(this.interfaceTPConfigs, (item) => item.isEnum);
         if (!isGenJavaScript && !isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
+            const hookCustomTemplateService = (_b = (_a = this.config.hook) === null || _a === void 0 ? void 0 : _a.customTemplates) === null || _b === void 0 ? void 0 : _b[config_2.TypescriptFileType.displayEnumLabel];
             this.genFileFromTemplate(`${config_2.displayEnumLabelFileName}.ts`, config_2.TypescriptFileType.displayEnumLabel, {
-                list: enums,
+                customTemplate: !!hookCustomTemplateService,
+                list: hookCustomTemplateService
+                    ? hookCustomTemplateService(enums, this.config)
+                    : enums,
                 namespace: this.config.namespace,
                 interfaceFileName: config_2.interfaceFileName,
             });
@@ -204,8 +209,12 @@ class ServiceGenerator {
             !isOnlyGenTypeScriptType &&
             this.config.isDisplayTypeLabel &&
             !(0, lodash_1.isEmpty)(displayTypeLabels)) {
+            const hookCustomTemplateService = (_d = (_c = this.config.hook) === null || _c === void 0 ? void 0 : _c.customTemplates) === null || _d === void 0 ? void 0 : _d[config_2.TypescriptFileType.displayTypeLabel];
             this.genFileFromTemplate(`${config_2.displayTypeLabelFileName}.ts`, config_2.TypescriptFileType.displayTypeLabel, {
-                list: displayTypeLabels,
+                customTemplate: !!hookCustomTemplateService,
+                list: hookCustomTemplateService
+                    ? hookCustomTemplateService(enums, this.config)
+                    : displayTypeLabels,
                 namespace: this.config.namespace,
                 interfaceFileName: config_2.interfaceFileName,
             });
@@ -335,6 +344,7 @@ class ServiceGenerator {
                             isEnum: enumObj.isEnum,
                             displayLabelFuncName: (0, util_1.camelCase)(`display-${item.name}-Enum`),
                             enumLabelType: enumObj.enumLabelType,
+                            description: enumObj.description,
                         });
                     }
                 });
@@ -377,7 +387,8 @@ class ServiceGenerator {
                 const newApi = api;
                 try {
                     const params = this.getParamsTP(newApi.parameters, newApi.path) || {};
-                    const body = this.getBodyTP(newApi.requestBody);
+                    const body = this.getBodyTP(newApi.requestBody, this.config.namespace);
+                    const bodyWithoutNamespace = this.getBodyTP(newApi.requestBody);
                     const response = this.getResponseTP(newApi.responses);
                     const file = this.getFileTP(newApi.requestBody);
                     let formData = false;
@@ -395,7 +406,7 @@ class ServiceGenerator {
                         const bodyName = (0, lodash_1.upperFirst)(`${functionName}Body`);
                         this.interfaceTPConfigs.push({
                             typeName: bodyName,
-                            type: body === null || body === void 0 ? void 0 : body.type,
+                            type: bodyWithoutNamespace === null || bodyWithoutNamespace === void 0 ? void 0 : bodyWithoutNamespace.type,
                             isEnum: false,
                             props: [],
                         });
@@ -574,7 +585,7 @@ class ServiceGenerator {
         const typeName = ((_c = (_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.hook) === null || _b === void 0 ? void 0 : _b.customTypeName) === null || _c === void 0 ? void 0 : _c.call(_b, data)) || this.getFunctionName(data);
         return (0, util_2.resolveTypeName)(`${namespace}${typeName !== null && typeName !== void 0 ? typeName : data.operationId}Params`);
     }
-    getBodyTP(requestBody) {
+    getBodyTP(requestBody, namespace) {
         var _a;
         const reqBody = this.resolveRefObject(requestBody);
         if ((0, lodash_1.isEmpty)(reqBody)) {
@@ -594,14 +605,11 @@ class ServiceGenerator {
         const bodySchema = {
             mediaType,
             required,
-            type: this.getType(schema, this.config.namespace),
+            type: this.getType(schema, namespace),
             isAnonymous: false,
         };
-        // 具名 body 场景
-        if ((0, util_2.isReferenceObject)(schema)) {
-            bodySchema.type = `${this.config.namespace}.${bodySchema.type}`;
-        }
-        else {
+        // 匿名 body 场景
+        if (!(0, util_2.isReferenceObject)(schema)) {
             bodySchema.isAnonymous = true;
         }
         return bodySchema;
@@ -677,7 +685,7 @@ class ServiceGenerator {
                     resContent[mediaType].schema ||
                     config_2.DEFAULT_SCHEMA);
             }
-            responseSchema.type = `${this.config.namespace}.${this.getType(schema, this.config.namespace)}`;
+            responseSchema.type = this.getType(schema, this.config.namespace);
             return responseSchema;
         }
         if ((0, util_2.isSchemaObject)(schema)) {
@@ -842,6 +850,7 @@ class ServiceGenerator {
             isEnum: true,
             type: Array.isArray(enumArray) ? enumStr : 'string',
             enumLabelType: enumLabelTypeStr,
+            description: schemaObject.description,
         };
     }
     resolveAllOfObject(schemaObject) {

package/dist/generator/type.d.ts

@@ -1,6 +1,7 @@
 import type { ProjectOptions } from 'ts-morph';
-import { type MutuallyExclusive, OperationObject, ParameterObject, SchemaObject } from '../type';
-import { TypescriptFileType } from './config';
+import type { OperationObject, ParameterObject, SchemaObject } from '../type';
+import { type MutuallyExclusive } from '../type';
+import type { TypescriptFileType } from './config';
 export type ITypescriptFileType = keyof typeof TypescriptFileType;
 export interface APIDataType extends OperationObject {
     path: string;
@@ -25,6 +26,7 @@ export interface ITypeItem {
     isEnum: boolean;
     displayLabelFuncName?: string;
     enumLabelType?: string;
+    description?: string;
 }
 export type ICustomSchemaObject = SchemaObject & {
     isAllowed?: boolean;

package/dist/generator/util.d.ts

@@ -1,5 +1,5 @@
-import { ArraySchemaObject, BinaryArraySchemaObject, ComponentsObject, ISchemaObject, NonArraySchemaObject, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from '../type';
-import { ITypeItem } from './type';
+import type { ArraySchemaObject, BinaryArraySchemaObject, ComponentsObject, ISchemaObject, NonArraySchemaObject, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from '../type';
+import type { ITypeItem } from './type';
 export declare function stripDot(str: string): string;
 export declare function resolveTypeName(typeName: string): string;
 export declare function getRefName(refObject: ReferenceObject | string): string;

package/dist/generator/util.js

@@ -98,8 +98,8 @@ function getDefaultType(schemaObject, namespace = '', schemas) {
         return schemaObject;
     }
     if (isReferenceObject(schemaObject)) {
-        return getRefName(schemaObject);
-        // return [namespace, getRefName(schemaObject)].filter((s) => s).join('.');
+        // return getRefName(schemaObject);
+        return [namespace, getRefName(schemaObject)].filter((s) => s).join('.');
     }
     let type = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.type;
     const dateEnum = ['Date', 'date', 'dateTime', 'date-time', 'datetime'];

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import { TypescriptFileType } from './generator/config';
-import { APIDataType } from './generator/type';
-import { ComponentsObject, type GetSchemaByApifoxProps, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
+import type { TypescriptFileType } from './generator/config';
+import type { APIDataType, ITypeItem } from './generator/type';
+import type { ComponentsObject, IPriorityRule, IReactQueryMode, OpenAPIObject, OperationObject, ReferenceObject, SchemaObject } from './type';
+import { type GetSchemaByApifoxProps } from './type';
 export * from './generator/patchSchema';
 export type GenerateServiceProps = {
     /**
@@ -203,6 +204,14 @@ export type GenerateServiceProps = {
              * 自定义 serviceController 模板
              */
             [TypescriptFileType.serviceController]?: <T, U>(item: T, context: U) => string;
+            /**
+             * 自定义 displayEnumLabel 模板
+             */
+            [TypescriptFileType.displayEnumLabel]?: <T, U>(enums: T[], config: U) => ITypeItem[];
+            /**
+             * 自定义 displayTypeLabel 模板
+             */
+            [TypescriptFileType.displayTypeLabel]?: <T, U>(types: T[], config: U) => ITypeItem[];
         };
     };
 };

package/dist/index.js

@@ -4,7 +4,6 @@ exports.generateService = generateService;
 const tslib_1 = require("tslib");
 const lodash_1 = require("lodash");
 const config_1 = require("./config");
-const config_2 = require("./generator/config");
 const mockGenarator_1 = require("./generator/mockGenarator");
 const serviceGenarator_1 = tslib_1.__importDefault(require("./generator/serviceGenarator"));
 const util_1 = require("./util");

package/dist/parser-mock/index.d.ts

@@ -1,5 +1,5 @@
-import { OpenAPIV3 } from 'openapi-types';
-import { OpenAPIObject } from '../type';
+import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIObject } from '../type';
 export default class OpenAPIGeneratorMockJs {
     protected openAPI: OpenAPIObject;
     constructor(openAPI: OpenAPIObject);

package/dist/parser-mock/util.d.ts

@@ -1,5 +1,5 @@
-import { OpenAPIV3 } from 'openapi-types';
-import { OpenAPIObject, ParameterObject, ReferenceObject, SchemaObject } from '../type';
+import type { OpenAPIV3 } from 'openapi-types';
+import type { OpenAPIObject, ParameterObject, ReferenceObject, SchemaObject } from '../type';
 export declare function objectify<T>(thing: T): T;
 export declare function get(openAPI: OpenAPIObject, path: string): OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
 export declare function normalizeArray(arr: string[] | string): string[];

package/dist/type.d.ts

@@ -1,5 +1,5 @@
-import { OpenAPIV3 } from 'openapi-types';
-import { PriorityRule, ReactQueryMode, SchemaObjectFormat, SchemaObjectType } from './config';
+import type { OpenAPIV3 } from 'openapi-types';
+import type { PriorityRule, ReactQueryMode, SchemaObjectFormat, SchemaObjectType } from './config';
 export type MutuallyExclusive<T> = {
     [K in keyof T]: {
         [P in K]: T[K];

package/dist/util.d.ts

@@ -1,5 +1,6 @@
-import { OpenAPI } from 'openapi-types';
-import { type GetSchemaByApifoxProps, OpenAPIObject } from './type';
+import type { OpenAPI } from 'openapi-types';
+import type { OpenAPIObject } from './type';
+import { type GetSchemaByApifoxProps } from './type';
 export declare const getImportStatement: (requestLibPath: string) => string;
 export declare const getOpenAPIConfigByApifox: (props: GetSchemaByApifoxProps) => Promise<OpenAPI.Document<{}>>;
 export declare const getOpenAPIConfig: (schemaPath: string, authorization?: string, timeout?: number) => Promise<OpenAPI.Document<{}>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "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",
@@ -68,8 +68,10 @@
     "husky": "^9.0.11",
     "lint-staged": "^16.0.0",
     "openapi-types": "^12.1.3",
+    "sanitize-filename": "^1.6.3",
     "ts-node": "^10.9.2",
-    "typescript": "5.8.3"
+    "typescript": "5.8.3",
+    "vitest": "^3.2.4"
   },
   "keywords": [
     "openapi",
@@ -92,9 +94,7 @@
     "changeset": "changeset",
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
-    "test": "rm -rf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
-    "test:new": "npm run build && cd ./test && node ./test.js && cd ..",
-    "test:windows": "rimraf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
+    "test:unit": "vitest",
     "openapi-ts-request": "openapi-ts"
   }
 }

package/templates/displayEnumLabel.njk

@@ -2,9 +2,14 @@
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
 
+{% if customTemplate %}
+  {{ list }}
+{% else %}
+
 {% for type in list -%}
 export function {{ type.displayLabelFuncName }}(field: {{ namespace }}.{{ type.typeName }}) {
   return ({{ type.enumLabelType }})[field]
 }
 
-{% endfor -%}
+{% endfor -%}
+{%- endif %}

package/templates/displayTypeLabel.njk

@@ -2,6 +2,10 @@
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
 
+{% if customTemplate %}
+  {{ list }}
+{% else %}
+
 {% for type in list -%}
   {%- if type.props.length %}
     export function display{{ type.typeName }}(field: keyof {{ namespace }}.{{ type.typeName }}) {
@@ -20,7 +24,7 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
               display{{ p.type | safe }}(field as keyof {{ namespace }}.{{ p.type }})
             {%- else %}
               {{ p.name }}: '{{ p.desc if p.desc else p.name }}',
-            {%- endif %}   
+            {%- endif %}
           {%- endfor %}
         {%- if prop.length > 1 %}
           }[field]
@@ -39,4 +43,5 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
   }
   {%- endif %}
 
-{% endfor -%}
+{% endfor -%}
+{%- endif %}