@wx-sab/renkei 1.2.5 → 1.3.1

package/lib/core/utils.test.js

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const utils_1 = require("./utils");
+(0, vitest_1.describe)('utils', () => {
+    (0, vitest_1.describe)('generateConfig', () => {
+        (0, vitest_1.it)('should generate config with default values', () => {
+            const conf = {
+                serviceName: 'test-service'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.sourceType).toBe('apifox');
+            (0, vitest_1.expect)(result.output).toContain('src/services');
+            (0, vitest_1.expect)(result.name).toBe('model.d.ts');
+            (0, vitest_1.expect)(result.modular).toBe(false);
+            (0, vitest_1.expect)(result.modelNamespace).toBe('Model');
+            (0, vitest_1.expect)(result.requestTempalte).toBe(`import { request } from '@wx-sab/renkei'`);
+        });
+        (0, vitest_1.it)('should merge user config with default config', () => {
+            const conf = {
+                serviceName: 'test-service',
+                sourceType: 'swagger',
+                output: '/custom/output',
+                name: 'custom.d.ts',
+                modelNamespace: 'CustomModel'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.sourceType).toBe('swagger');
+            (0, vitest_1.expect)(result.output).toBe('/custom/output');
+            (0, vitest_1.expect)(result.name).toBe('custom.d.ts');
+            (0, vitest_1.expect)(result.modelNamespace).toBe('CustomModel');
+        });
+        (0, vitest_1.it)('should generate apifox source when sourceType is apifox', () => {
+            const conf = {
+                serviceName: 'test-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '12345'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.source).toContain('projectId=12345');
+            (0, vitest_1.expect)(result.source).toContain('127.0.0.1:4523');
+        });
+        (0, vitest_1.it)('should generate swagger source when sourceType is swagger', () => {
+            const conf = {
+                serviceName: 'my-service',
+                sourceType: 'swagger'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.source).toContain('my-service');
+            (0, vitest_1.expect)(result.source).toContain('api-docs');
+        });
+        (0, vitest_1.it)('should use custom source if provided', () => {
+            const conf = {
+                serviceName: 'test-service',
+                source: 'https://custom.api.com/swagger'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.source).toBe('https://custom.api.com/swagger');
+        });
+        (0, vitest_1.it)('should apply customResponseType function', () => {
+            const conf = {
+                serviceName: 'test-service',
+                customResponseType: (type) => `CustomResponse<${type}>`
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.customResponseType).toBeDefined();
+            (0, vitest_1.expect)(result.customResponseType('User')).toBe('CustomResponse<User>');
+        });
+        (0, vitest_1.it)('should apply customMockService function', () => {
+            const conf = {
+                serviceName: 'test-service',
+                apifoxProjectId: '12345',
+                customMockService: (config) => `https://mock.example.com/${config.apifoxProjectId}`
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.customMockService).toBeDefined();
+            (0, vitest_1.expect)(result.customMockService(result)).toBe('https://mock.example.com/12345');
+        });
+        (0, vitest_1.it)('should use default customResponseType when not provided', () => {
+            const conf = {
+                serviceName: 'test-service'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.customResponseType).toBeDefined();
+            (0, vitest_1.expect)(result.customResponseType('User')).toBe('AxiosResponse<User>');
+        });
+        (0, vitest_1.it)('should use default customMockService when apifoxProjectId is provided', () => {
+            const conf = {
+                serviceName: 'test-service',
+                apifoxProjectId: '12345'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.customMockService).toBeDefined();
+            (0, vitest_1.expect)(result.customMockService(result)).toContain('mock.apifox.cn');
+            (0, vitest_1.expect)(result.customMockService(result)).toContain('12345');
+        });
+        (0, vitest_1.it)('should return empty string for default customMockService without apifoxProjectId', () => {
+            const conf = {
+                serviceName: 'test-service'
+            };
+            const result = (0, utils_1.generateConfig)(conf);
+            (0, vitest_1.expect)(result.customMockService).toBeDefined();
+            (0, vitest_1.expect)(result.customMockService(result)).toBe('');
+        });
+    });
+    (0, vitest_1.describe)('generateRouteName', () => {
+        (0, vitest_1.it)('should generate route name from method and route', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/api/users');
+            (0, vitest_1.expect)(result).toBe('get_api_users');
+        });
+        (0, vitest_1.it)('should handle route with path parameters', () => {
+            const result = (0, utils_1.generateRouteName)('POST', '/api/users/{id}');
+            (0, vitest_1.expect)(result).toBe('post_api_users_$p');
+        });
+        (0, vitest_1.it)('should convert to lowercase', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/API/Users');
+            (0, vitest_1.expect)(result).toBe('get_api_users');
+        });
+        (0, vitest_1.it)('should replace hyphens with underscores', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/api/user-profiles');
+            (0, vitest_1.expect)(result).toBe('get_api_user_profiles');
+        });
+        (0, vitest_1.it)('should replace dots with underscores', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/api/user.profiles');
+            (0, vitest_1.expect)(result).toBe('get_api_user_profiles');
+        });
+        (0, vitest_1.it)('should replace asterisks with underscores', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/api/user*profiles');
+            (0, vitest_1.expect)(result).toBe('get_api_user_profiles');
+        });
+        (0, vitest_1.it)('should handle complex route patterns', () => {
+            const result = (0, utils_1.generateRouteName)('DELETE', '/api/users/{userId}/posts/{postId}');
+            (0, vitest_1.expect)(result).toBe('delete_api_users_$p_posts_$p');
+        });
+        (0, vitest_1.it)('should handle empty route segments', () => {
+            const result = (0, utils_1.generateRouteName)('GET', '/api//users');
+            (0, vitest_1.expect)(result).toBe('get_api_users');
+        });
+    });
+    (0, vitest_1.describe)('getValidName', () => {
+        (0, vitest_1.it)('should return null for empty string', () => {
+            const result = (0, utils_1.getValidName)('');
+            (0, vitest_1.expect)(result).toBeNull();
+        });
+        (0, vitest_1.it)('should return null for null/undefined', () => {
+            // 测试边界情况：null 和 undefined 输入
+            (0, vitest_1.expect)((0, utils_1.getValidName)(null)).toBeNull();
+            (0, vitest_1.expect)((0, utils_1.getValidName)(undefined)).toBeNull();
+        });
+        (0, vitest_1.it)('should return the same string if no special characters', () => {
+            const result = (0, utils_1.getValidName)('UserVO');
+            (0, vitest_1.expect)(result).toBe('UserVO');
+        });
+        (0, vitest_1.it)('should handle nested generic types', () => {
+            const result = (0, utils_1.getValidName)('ResponseVO«AgentTraceVO»');
+            (0, vitest_1.expect)(result).toBe('ResponseVOAgentTraceVO');
+        });
+        (0, vitest_1.it)('should handle path with slashes', () => {
+            const result = (0, utils_1.getValidName)('path/to/Component');
+            (0, vitest_1.expect)(result).toBe('Component');
+        });
+        (0, vitest_1.it)('should remove all non-word characters', () => {
+            const result = (0, utils_1.getValidName)('User@VO#Test');
+            (0, vitest_1.expect)(result).toBe('UserVOTest');
+        });
+        (0, vitest_1.it)('should handle complex nested types', () => {
+            const result = (0, utils_1.getValidName)('List«Map«String,Object»»');
+            (0, vitest_1.expect)(result).toBe('ListMapStringObject');
+        });
+    });
+    (0, vitest_1.describe)('defineConfig', () => {
+        (0, vitest_1.it)('should return single config', () => {
+            const config = {
+                serviceName: 'test-service',
+                sourceType: 'apifox',
+                apifoxProjectId: '12345'
+            };
+            const result = (0, utils_1.defineConfig)(config);
+            (0, vitest_1.expect)(result).toEqual(config);
+        });
+        (0, vitest_1.it)('should return array of configs', () => {
+            const configs = [
+                { serviceName: 'service1', sourceType: 'apifox', apifoxProjectId: '123' },
+                { serviceName: 'service2', sourceType: 'swagger' }
+            ];
+            const result = (0, utils_1.defineConfig)(configs);
+            (0, vitest_1.expect)(result).toEqual(configs);
+            (0, vitest_1.expect)(Array.isArray(result)).toBe(true);
+            (0, vitest_1.expect)(result).toHaveLength(2);
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wx-sab/renkei",
-  "version": "1.2.5",
+  "version": "1.3.1",
   "description": "解析swagger转为ts代码，日本动漫《游戏王》中的‘Renkei’，意为连携或协作。",
   "main": "./lib/index.js",
   "bin": {
@@ -11,7 +11,10 @@
     "clean": "rm -rf lib",
     "build": "npm run clean & tsc --outDir lib",
     "version:alpha": "npm version premajor --preid alpha",
-    "api": "ts-node --transpile-only ./src/cli.ts api"
+    "api": "ts-node --transpile-only ./src/cli.ts api",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest --coverage"
   },
   "repository": {
     "type": "git",
@@ -21,9 +24,13 @@
   "license": "ISC",
   "devDependencies": {
     "@types/cli-progress": "^3.11.5",
+    "@types/inquirer": "9.0.7",
     "@types/lodash": "^4.14.196",
     "@types/node": "^20.4.7",
-    "typescript": "^5.1.6"
+    "@vitest/coverage-v8": "^4.1.4",
+    "@vitest/ui": "^4.1.4",
+    "typescript": "^5.1.6",
+    "vitest": "^4.1.4"
   },
   "files": [
     "lib",
@@ -33,6 +40,7 @@
     "axios": "^1.4.0",
     "cli-progress": "^3.12.0",
     "commander": "^11.0.0",
+    "inquirer": "8.2.6",
     "lodash": "^4.17.21",
     "swagger-typescript-api": "13.0.3",
     "ts-node": "^10.9.1"

package/templates/api.ejs

@@ -1,5 +1,5 @@
 <%
-const { apiConfig, routes, utils, config, requestTemplate, modelNamespace, serviceName, namespace, requestTempalte, modelTypes } = it;
+const { apiConfig, routes, utils, config, requestTemplate, modelNamespace, serviceName, namespace, requestTempalte, modelTypes, SKIP_ROUTE_MARKER } = it;
 const { info, servers, externalDocs } = apiConfig;
 const { _, require, formatDescription } = utils;
 
@@ -92,9 +92,9 @@ export class <%~ serviceName %> {
 
   <% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
     <% routes.forEach((route) => { %>
-
+      <% if (route.routeName.usage !== SKIP_ROUTE_MARKER) { %>
         <%~ includeFile('./procedure-call.ejs', { ...it, route }) %>
-
+      <% } %>
     <% }) %>
   <% }) %>
 }