wormajs 0.2.4 → 0.2.6

package/dist/utils/base.js

@@ -143,12 +143,12 @@ function strHashCode(str) {
     return hash;
 }
 function getType(value) {
-    // 处理 null 和 undefined
+    // handle null and undefined
     if (value === null)
         return 'null';
     if (value === undefined)
         return 'undefined';
-    // 基本类型
+    // primitive types
     const type = typeof value;
     if (type !== 'object' && type !== 'function') {
         if (type === 'number' && Number.isNaN(value))
@@ -161,7 +161,7 @@ function getType(value) {
         }
         return type;
     }
-    // 特殊对象类型
+    // special object types
     if (Array.isArray(value))
         return 'Array';
     if (value instanceof Date)
@@ -176,7 +176,7 @@ function getType(value) {
         return 'Promise';
     if (value instanceof Error)
         return 'Error';
-    // 函数类型
+    // function types
     if (typeof value === 'function') {
         if (value.constructor.name === 'AsyncFunction')
             return 'AsyncFunction';
@@ -184,19 +184,19 @@ function getType(value) {
             return 'GeneratorFunction';
         return 'Function';
     }
-    // 其他对象类型
+    // other object types
     const tag = Object.prototype.toString.call(value).slice(8, -1);
     if (tag !== 'Object')
         return tag;
-    // 自定义类实例
+    // custom class instances
     if (value.constructor && value.constructor !== Object) {
         return `Class (${value.constructor.name})`;
     }
-    // 普通对象
+    // plain object
     return 'Object';
 }
 /**
- * 获取用户已安装的依赖列表
+ * Get the list of dependencies installed by the user
  */
 async function getUserInstalledDependencies(projectPath) {
     const { readPackageJson } = await Promise.resolve().then(() => __importStar(require('../utils/readPackageJson')));
@@ -207,6 +207,6 @@ async function getUserInstalledDependencies(projectPath) {
     const dependencies = Object.keys(packageJson.dependencies || {});
     const devDependencies = Object.keys(packageJson.devDependencies || {});
     const peerDependencies = Object.keys(packageJson.peerDependencies || {});
-    // 合并所有依赖并去重
+    // merge all dependencies and deduplicate
     return [...new Set([...dependencies, ...devDependencies, ...peerDependencies])];
 }

package/dist/utils/openapi.js

@@ -127,11 +127,11 @@ function get$refName(path, toUpperCase = true) {
  * @returns Removed $ref object
  */
 /**
- * M2-B1: $ref 解引用缓存优化 —— 命中 searchMap 时跳过 cloneDeep
+ * M2-B1: $ref dereference cache optimization — skip cloneDeep when searchMap is hit
  */
 function removeAll$ref(schemaOrigin, openApi, optons) {
     const { searchMap = new Map(), refNameMap = new Map() } = optons ?? {};
-    // 先检查缓存，命中则直接返回（避免 cloneDeep 开销）
+    // check the cache first; return directly on hit (avoid cloneDeep overhead)
     if (isReferenceObject(schemaOrigin)) {
         if (searchMap.has(schemaOrigin.$ref)) {
             return searchMap.get(schemaOrigin.$ref);
@@ -148,7 +148,7 @@ function removeAll$ref(schemaOrigin, openApi, optons) {
         }
         return schema;
     }
-    // 非 $ref 节点：仍需 cloneDeep 防止污染原始文档，但子节点走 searchMap 去重
+    // non-$ref nodes: still cloneDeep to avoid mutating the original document, but children go through searchMap for deduplication
     const deepSchemaOrigin = (0, lodash_1.cloneDeep)(schemaOrigin);
     for (const key of Object.keys(deepSchemaOrigin)) {
         if (deepSchemaOrigin[key] && typeof deepSchemaOrigin[key] === 'object') {
@@ -234,10 +234,10 @@ function next$ref() {
     };
 }
 /**
- * 根据 usedRefs 优化 refsMap：
- * 1) 移除未使用的 key；
- * 2) 同组（相同 basePath+onlyName）内按版本升序将值左移，
- *    即剩余键依次接收原始值的前 N 个（N 为剩余键数量）。
+ * Optimize refsMap based on usedRefs:
+ * 1) remove unused keys;
+ * 2) within the same group (same basePath+onlyName), shift values left in ascending version order,
+ *    i.e. remaining keys receive the first N original values (N = number of remaining keys).
  */
 function optimizeRefsMap(refsMap, usedRefs) {
     const helper = next$ref();
@@ -271,7 +271,7 @@ function isCircular(obj) {
             }
             seenObjects.add(obj);
             for (const key in obj) {
-                if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                if (Object.hasOwn(obj, key)) {
                     if (detect(obj[key])) {
                         return true;
                     }
@@ -288,7 +288,7 @@ function hasBaseReferenceObject(obj) {
             return true;
         }
         for (const key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key)) {
+            if (Object.hasOwn(obj, key)) {
                 if (hasBaseReferenceObject(obj[key])) {
                     return true;
                 }
@@ -305,7 +305,7 @@ function removeBaseReference(obj, options) {
             return refObj;
         }
         for (const key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key) && hasBaseReferenceObject(obj[key])) {
+            if (Object.hasOwn(obj, key) && hasBaseReferenceObject(obj[key])) {
                 obj[key] = removeBaseReference(obj[key], { openApi, map, refNameMap });
             }
         }
@@ -327,7 +327,7 @@ function removeBaseReference(obj, options) {
         };
     }
     for (const key in obj) {
-        if (Object.prototype.hasOwnProperty.call(obj, key) && hasBaseReferenceObject(obj[key])) {
+        if (Object.hasOwn(obj, key) && hasBaseReferenceObject(obj[key])) {
             obj[key] = removeBaseReference(obj[key], { openApi, map, refNameMap });
         }
     }
@@ -336,7 +336,7 @@ function removeBaseReference(obj, options) {
 function unCircular(obj, options) {
     const { openApi, map = [], objPath = '$', seen = new WeakMap(), refNameMap = new Map() } = options;
     if (typeof obj !== 'object' || obj === null) {
-        return obj; // 原始值直接返回
+        return obj; // return the primitive value directly
     }
     if (seen.has(obj)) {
         return seen.get(obj);
@@ -364,7 +364,7 @@ function unCircular(obj, options) {
         seen.set(obj, { $ref: nextPath });
         map.push([nextPath, obj]);
         for (const key in obj) {
-            if (Object.prototype.hasOwnProperty.call(obj, key)) {
+            if (Object.hasOwn(obj, key)) {
                 obj[key] = unCircular(obj[key], { openApi, map, objPath: `${objPath}.${key}`, seen, refNameMap });
             }
         }
@@ -375,7 +375,7 @@ function unCircular(obj, options) {
     }
     map.push([$ref, obj]);
     for (const key in obj) {
-        if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        if (Object.hasOwn(obj, key)) {
             obj[key] = unCircular(obj[key], { openApi, map, objPath: `${objPath}.${key}`, seen, refNameMap });
         }
     }
@@ -402,7 +402,7 @@ function mergeObject(objValue, srcValue, options) {
         }
         return srcValue;
     }
-    // M2-B1: mergeWith 自身不污染首参（返回新对象），去掉冗余 cloneDeep
+    // M2-B1: mergeWith does not mutate the first argument (returns a new object), removed redundant cloneDeep
     return (0, lodash_1.mergeWith)(objValue, srcValue, customizer);
 }
 function getResponseSuccessKey(responsesObject) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wormajs",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "A modern OpenAPI code generator - Generate type-safe API clients from OpenAPI specs",
   "author": "worma",
   "license": "MIT",
@@ -80,7 +80,7 @@
   },
   "scripts": {
     "test": "vitest run",
-    "build": "run-s build:*",
+    "build": "run-s \"build:*\"",
     "build:ts": "tsc --build tsconfig.build.json && tsc-alias -p tsconfig.build.json",
     "build:dts": "dts-bundle-generator -o typings/index.d.ts src/index.ts --no-check --no-banner --project tsconfig.dts.json",
     "build:plugin-dts": "dts-bundle-generator -o typings/plugins.d.ts src/plugins/index.ts --no-check --no-banner --project tsconfig.dts.json",

package/typings/index.d.ts

@@ -348,7 +348,7 @@ export interface Api {
 }
 export interface ApiDoc {
 	apis: Api[];
-	tagName: string;
+	tag: string;
 }
 export type ApiDescriptor = Omit<OperationObject, "requestBody" | "parameters" | "responses"> & {
 	url: string;

package/typings/plugins.d.ts

@@ -368,7 +368,7 @@ export interface Api {
 }
 export interface ApiDoc {
 	apis: Api[];
-	tagName: string;
+	tag: string;
 }
 export type ApiDescriptor = Omit<OperationObject, "requestBody" | "parameters" | "responses"> & {
 	url: string;
@@ -589,6 +589,11 @@ export interface ModifierConfig {
 	 * The scope the modifier applies to (which parameter location to process).
 	 */
 	scope: ModifierScope;
+	/**
+	 * API path filter: this config applies only when `apiDescriptor.url` matches;
+	 * when omitted it applies to all APIs. Matching rules are the same as `match` (string substring / RegExp / function).
+	 */
+	path?: string | RegExp | ((url: string) => boolean);
 	/**
 	 * Match rule. Only matched fields are transformed; when omitted, all fields are transformed.
 	 * - string: the original field name contains this string
@@ -665,19 +670,19 @@ export declare const knife4j: (input: string | string[]) => ApiPlugin;
  */
 export declare const swagger: (input: string | string[]) => ApiPlugin;
 export interface YapiOptions {
-	/** YApi 服务基础地址，例如 `https://yapi.xxx.com` */
+	/** YApi server base address, e.g. `https://yapi.xxx.com` */
 	url: string;
-	/** 项目 ID，必填，用于拼装导出地址 */
+	/** Project ID, required, used to build the export address */
 	pid: string | number;
-	/** OpenAPI 类型，默认 `OpenAPIV2` */
+	/** OpenAPI type, defaults to `OpenAPIV2` */
 	type?: string;
-	/** 接口状态，默认 `all` */
+	/** API status, defaults to `all` */
 	status?: string;
-	/** 是否包含 wiki，默认 `true` */
+	/** Whether to include wiki, defaults to `true` */
 	isWiki?: boolean;
-	/** 登录 cookie。也可通过 fetchOptions.headers.cookie 传入 */
+	/** Login cookie. Can also be passed via fetchOptions.headers.cookie */
 	cookie?: string;
-	/** 额外的 fetch 超时（毫秒） */
+	/** Extra fetch timeout in milliseconds */
 	timeout?: number;
 }
 /**
@@ -726,6 +731,12 @@ export interface RenameConfig {
 	 * Target scope for renaming, defaults to 'url'
 	 */
 	scope?: "url" | "params" | "pathParams" | "data" | "response" | "refName" | "name";
+	/**
+	 * API path filter. When set, this config only takes effect on descriptors
+	 * whose `url` matches the rule; otherwise the descriptor is returned unchanged.
+	 * The rule can be a string (substring match), RegExp, or (url: string) => boolean.
+	 */
+	path?: string | RegExp | ((url: string) => boolean);
 	/**
 	 * Matching rule for selective renaming:
 	 * - string: target contains this string
@@ -789,32 +800,32 @@ export declare function processApiTags(apiDescriptor: ApiDescriptor, handler: Mo
  */
 export declare function tagModifier(handler: ModifierHandler): ApiPlugin;
 /**
- * worma.config 模板预设 - plugin mode
+ * worma.config template preset - plugin mode
  */
 export declare function config(): ApiPlugin;
 /**
- * globals 模板预设 - plugin mode
- * 全局模板，现有的全局模板，通过全局挂载的方式使用
+ * globals template preset - plugin mode
+ * Global template: an existing global template, used via global mounting
  */
 export declare function alovaGlobals(opts?: GlobalsTemplateOptions): ApiPlugin;
 /**
- * functional 模板预设 - plugin mode
- * 函数式模板，生成函数式API调用，支持tree-shaking，仅支持alova v3
+ * functional template preset - plugin mode
+ * Functional template that generates functional API calls, supports tree-shaking, only for alova v3
  */
 export declare function alova(opts?: FunctionalTemplateOptions): ApiPlugin;
 /**
- * axios 模板预设 - plugin mode
- * Axios相关模板
+ * axios template preset - plugin mode
+ * Axios-related template
  */
 export declare function axios(opts?: RequestLibTemplateOptions): ApiPlugin;
 /**
- * fetch 模板预设 - plugin mode
- * Fetch相关模板
+ * fetch template preset - plugin mode
+ * Fetch-related template
  */
 declare function fetch$1(opts?: RequestLibTemplateOptions): ApiPlugin;
 /**
- * ky 模板预设 - plugin mode
- * Ky相关模板
+ * ky template preset - plugin mode
+ * Ky-related template
  */
 export declare function ky(opts?: RequestLibTemplateOptions): ApiPlugin;
 

package/dist/tsconfig.build.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["../src/config.ts","../src/constant.ts","../src/createConfig.ts","../src/defineConfig.ts","../src/generate.ts","../src/index.ts","../src/readConfig.ts","../src/resolveWorkspaces.ts","../src/bin/actions.ts","../src/bin/cli.ts","../src/bin/progressRenderer.ts","../src/bin/renderer.ts","../src/bin/theme.ts","../src/core/WorkerPool.ts","../src/core/loader/index.ts","../src/core/loader/astLoader/helper.ts","../src/core/loader/astLoader/index.ts","../src/core/loader/astLoader/generates/array.ts","../src/core/loader/astLoader/generates/enum.ts","../src/core/loader/astLoader/generates/group.ts","../src/core/loader/astLoader/generates/index.ts","../src/core/loader/astLoader/generates/interface.ts","../src/core/loader/astLoader/generates/simple.ts","../src/core/loader/astLoader/generates/tuple.ts","../src/core/loader/astLoader/generates/type.ts","../src/core/loader/astLoader/generates/utils.ts","../src/core/loader/astLoader/normalize/index.ts","../src/core/loader/astLoader/normalize/normalizer.ts","../src/core/loader/astLoader/normalize/rules/convertTypeArray.ts","../src/core/loader/astLoader/normalize/rules/handleEmptyType.ts","../src/core/loader/astLoader/normalize/rules/inferType.ts","../src/core/loader/astLoader/normalize/rules/mergeAnyOf.ts","../src/core/loader/astLoader/normalize/rules/normalizeCombiningKeywords.ts","../src/core/loader/astLoader/normalize/rules/normalizeEnum.ts","../src/core/loader/astLoader/normalize/rules/normalizeNullType.ts","../src/core/loader/astLoader/normalize/rules/removeRedundantKeywords.ts","../src/core/loader/astLoader/normalize/rules/simplifySingleType.ts","../src/core/loader/astLoader/normalize/rules/validateSchema.ts","../src/core/loader/astLoader/parsers/array.ts","../src/core/loader/astLoader/parsers/const.ts","../src/core/loader/astLoader/parsers/enum.ts","../src/core/loader/astLoader/parsers/group.ts","../src/core/loader/astLoader/parsers/index.ts","../src/core/loader/astLoader/parsers/object.ts","../src/core/loader/astLoader/parsers/reference.ts","../src/core/loader/astLoader/parsers/simple.ts","../src/core/loader/astLoader/parsers/tuple.ts","../src/core/loader/astLoader/parsers/type.ts","../src/core/loader/astLoader/parsers/utils.ts","../src/core/loader/astLoader/parsers/forward/array.ts","../src/core/loader/astLoader/parsers/forward/const.ts","../src/core/loader/astLoader/parsers/forward/enum.ts","../src/core/loader/astLoader/parsers/forward/group.ts","../src/core/loader/astLoader/parsers/forward/index.ts","../src/core/loader/astLoader/parsers/forward/object.ts","../src/core/loader/astLoader/parsers/forward/tuple.ts","../src/core/loader/astLoader/parsers/forward/type.ts","../src/core/loader/callingCodeLoader/helper.ts","../src/core/loader/callingCodeLoader/index.ts","../src/core/loader/schemaLoader/index.ts","../src/core/loader/standardLoader/helper.ts","../src/core/loader/standardLoader/index.ts","../src/core/loader/standardLoader/standards.ts","../src/core/parser/index.ts","../src/core/parser/openApiParser/helper.ts","../src/core/parser/openApiParser/index.ts","../src/core/parser/templateParser/helper.ts","../src/core/parser/templateParser/index.ts","../src/core/workerPool/index.ts","../src/core/workerPool/poolManager.ts","../src/core/workerPool/swagger2Worker.ts","../src/core/workerPool/worker.ts","../src/functions/getAutoTemplateType.ts","../src/functions/getFrameworkTag.ts","../src/functions/prepareConfig.ts","../src/functions/readWormaRc.ts","../src/functions/wormaJson.ts","../src/helper/PluginDriver.ts","../src/helper/comment.ts","../src/helper/index.ts","../src/helper/progress.ts","../src/helper/config/ConfigHelper.ts","../src/helper/config/ConfigManager.ts","../src/helper/config/GeneratorHelper.ts","../src/helper/config/index.ts","../src/helper/config/type.ts","../src/helper/config/zType.ts","../src/helper/document/index.ts","../src/helper/logger/index.ts","../src/helper/template/index.ts","../src/plugins/createPlugin.ts","../src/plugins/index.ts","../src/plugins/presets/aiDoc.ts","../src/plugins/presets/apifox.ts","../src/plugins/presets/filterApi.ts","../src/plugins/presets/importType.ts","../src/plugins/presets/rename.ts","../src/plugins/presets/tagModifier.ts","../src/plugins/presets/utils.ts","../src/plugins/presets/payloadModifier/hepler.ts","../src/plugins/presets/payloadModifier/index.ts","../src/plugins/presets/payloadModifier/type.ts","../src/plugins/presets/platform/fastapi.ts","../src/plugins/presets/platform/index.ts","../src/plugins/presets/platform/knife4j.ts","../src/plugins/presets/platform/shared.ts","../src/plugins/presets/platform/swagger.ts","../src/plugins/presets/platform/yapi.ts","../src/template/index.ts","../src/type/api.ts","../src/type/ast.ts","../src/type/base.ts","../src/type/index.ts","../src/type/lib.ts","../src/type/openapi.ts","../src/utils/base.ts","../src/utils/format.ts","../src/utils/index.ts","../src/utils/openapi.ts","../src/utils/readPackageJson.ts","../src/utils/template.ts"],"version":"5.9.3"}