wormajs 0.2.5 → 0.2.7

package/dist/template/presets/fetch/typescript/helper.ts.handlebars

@@ -1,4 +1,5 @@
 {{> comment}}
+
 export function buildPayload(url: string, defaultConfig: Record<string, any>, apiName: string, config: any) {
   const mergedConfig: any = { ...defaultConfig[apiName], ...config };
   const pathParams = mergedConfig.pathParams;
@@ -24,15 +25,19 @@ export function buildPayload(url: string, defaultConfig: Record<string, any>, ap
 
 export type ServicesMap = {
 {{#each tagedApis}}
-  {{{tagName}}}: typeof import('./services/{{{tagName}}}');
+  {{{tag}}}: typeof import('./services/{{{tag}}}');
 {{/each}}
 };
 
-export const setDefaultConfig = <
+export function setDefaultConfig<
   T extends keyof ServicesMap,
   TagedMap extends Record<string, (config: any) => any> = ServicesMap[T],
   ConfigMap = { [K in keyof TagedMap]?: Partial<Parameters<TagedMap[K]>[0]> }
->(
-  _: T,
-  configMap: ConfigMap
-) => configMap;
+>(_: T, configMap: ConfigMap): ConfigMap {
+  return configMap;
+}
+
+export function resolveTagDefaultConfig<C extends object, Key extends string>(defaultConfig: C, tagName: Key) {
+  const raw = (defaultConfig as any)[tagName];
+  return (raw || {}) as C extends { [K in Key]: infer V } ? V : {};
+}

package/dist/template/presets/fetch/typescript/services/#index.ts.handlebars

@@ -2,5 +2,5 @@
 import { setDefaultConfig } from '../helper';
 
 {{#each tagedApis}}
-export const {{{tagName}}}DefaultConfig = setDefaultConfig('{{{tagName}}}', {});
+export const {{{tag}}}DefaultConfig = setDefaultConfig('{{{tag}}}', {});
 {{/each}}

package/dist/template/presets/fetch/typescript/services/{tag}.ts.handlebars

@@ -1,13 +1,12 @@
 {{> comment}}
 import { fetchClient } from '../index';
-import { buildPayload } from '../helper';
+import { buildPayload, resolveTagDefaultConfig } from '../helper';
+import * as defaultConfig from './index';
 import type * as ComponentTypes from '../components';
-{{#each tagedApis}}
-import { {{{tagName}}}DefaultConfig } from '.';
-{{/each}}
 
-{{#each tagedApis}}
-{{#each apis}}
+const {{{currentTag.tag}}}DefaultConfig = resolveTagDefaultConfig(defaultConfig, '{{{currentTag.tag}}}DefaultConfig');
+
+{{#each currentTag.apis}}
 type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 type {{{name}}}ExtraConfig = Omit<RequestInit, 'body'> & {
   {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
@@ -17,9 +16,8 @@ type {{{name}}}ExtraConfig = Omit<RequestInit, 'body'> & {
 };
 {{> api-jsdoc}}
 export async function {{{name}}}(config{{#or pathParameters queryParameters requestBody }}{{else}}?{{/or}}: {{{name}}}ExtraConfig): Promise<{{{name}}}Response> {
-  const { url, mergedConfig } = buildPayload('{{{path}}}', {{{tag}}}DefaultConfig, {{{name}}}.name, config);
+  const { url, mergedConfig } = buildPayload('{{{path}}}', {{../currentTag.tag}}DefaultConfig, {{{name}}}.name, config);
   return fetchClient.request(url, { method: '{{method}}', ...mergedConfig{{#if (eq response "Blob")}}, blob: true{{/if}} }) as Promise<{{{name}}}Response>;
 }
 
 {{/each}}
-{{/each}}

package/dist/template/presets/ky/module/helper.js.handlebars

@@ -1,4 +1,5 @@
 {{> comment}}
+
 export function buildPayload(url, defaultConfig, apiName, config) {
   const mergedConfig = { ...defaultConfig[apiName], ...config };
   const pathParams = mergedConfig.pathParams;
@@ -27,7 +28,7 @@ export function buildPayload(url, defaultConfig, apiName, config) {
 /**
  * @typedef {{#raw "{{" }}{{/raw}}
 {{#each tagedApis}}
- *  {{{tagName}}}: typeof import('./services/{{{tagName}}}')
+ *  {{{tag}}}: typeof import('./services/{{{tag}}}')
 {{/each}}
  * {{#raw "}}" }}{{/raw}} ServicesMap
  */
@@ -40,4 +41,18 @@ export function buildPayload(url, defaultConfig, apiName, config) {
  * @param {ConfigMap} configMap
  * @returns {ConfigMap}
  */
-export const setDefaultConfig = (_, configMap) => configMap;
+export function setDefaultConfig(_, configMap) {
+  return configMap;
+}
+
+/**
+ * @template {object} C
+ * @template {string} Key
+ * @param {C} defaultConfig
+ * @param {Key} tagName
+ * @returns {C extends { [K in Key]: infer V } ? V : {}}
+ */
+export function resolveTagDefaultConfig(defaultConfig, tagName) {
+  const raw = defaultConfig[tagName];
+  return raw || {};
+}

package/dist/template/presets/ky/module/services/#index.js.handlebars

@@ -1,6 +1,6 @@
 {{> comment}}
-import { setDefaultConfig } from '../helper';
+import { setDefaultConfig } from '../helper.js';
 
 {{#each tagedApis}}
-export const {{{tagName}}}DefaultConfig = setDefaultConfig('{{{tagName}}}', {});
+export const {{{tag}}}DefaultConfig = setDefaultConfig('{{{tag}}}', {});
 {{/each}}

package/dist/template/presets/ky/module/services/{tag}.d.ts.handlebars

@@ -1,11 +1,9 @@
 import type { Options } from 'ky';
 import type * as ComponentTypes from '../components';
 
-{{#each tagedApis}}
-{{#each apis}}
+{{#each currentTag.apis}}
 {{> dts-types}}
 {{> api-jsdoc}}
 {{> dts-fn-declare}}
 
 {{/each}}
-{{/each}}

package/dist/template/presets/ky/module/services/{tag}.js.handlebars

@@ -1,13 +1,14 @@
 {{> comment}}
 import { kyInstance } from '../index.js';
-import { buildPayload } from '../helper.js';
-import { {{currentTag.tagName}}DefaultConfig } from './index.js';
+import { buildPayload, resolveTagDefaultConfig } from '../helper.js';
+import * as defaultConfig from './index.js';
 
-{{#each tagedApis}}
-{{#each apis}}
+const {{currentTag.tag}}DefaultConfig = resolveTagDefaultConfig(defaultConfig, '{{currentTag.tag}}DefaultConfig');
+
+{{#each currentTag.apis}}
 {{> api-jsdoc}}
 export function {{{name}}}(config = {}) {
-  const { url, mergedConfig } = buildPayload('{{{path}}}', {{{tag}}}DefaultConfig, {{{name}}}.name, config);
+  const { url, mergedConfig } = buildPayload('{{{path}}}', {{../currentTag.tag}}DefaultConfig, {{{name}}}.name, config);
   const resolvedPath = url.replace(/^\//, '');
   return kyInstance(resolvedPath, {
     method: '{{method}}',
@@ -16,4 +17,3 @@ export function {{{name}}}(config = {}) {
 }
 
 {{/each}}
-{{/each}}

package/dist/template/presets/ky/partials/comment.handlebars

@@ -1,5 +1,9 @@
-/* tslint:disable */
 /* eslint-disable */
+/* biome-ignore-all */
+/* stylelint-disable */
+/* editorconfig-checker-disable-file */
+/* oxlint-disable */
+/* oxcformat-ignore */
 /**
  * {{title}} - version {{version}}
  *
@@ -13,7 +17,12 @@
  *
  * NOTE: This file is auto generated by the alova's vscode plugin.
  *
- * https://alova.js.org/devtools/vscode
+ * https://worma.js.org
  *
+{{#if noOverwrite}}
+ * NOTE: This file is generated only once and will NOT be overwritten on regeneration.
+ * You can safely customize it to fit your needs.
+{{else}}
  * **Do not edit the file manually.**
+{{/if}}
  */

package/dist/template/presets/ky/typescript/helper.ts.handlebars

@@ -1,4 +1,5 @@
 {{> comment}}
+
 export function buildPayload(url: string, defaultConfig: Record<string, any>, apiName: string, config: any) {
   const mergedConfig: any = { ...defaultConfig[apiName], ...config };
   const pathParams = mergedConfig.pathParams;
@@ -26,15 +27,19 @@ export function buildPayload(url: string, defaultConfig: Record<string, any>, ap
 
 export type ServicesMap = {
 {{#each tagedApis}}
-  {{{tagName}}}: typeof import('./services/{{{tagName}}}');
+  {{{tag}}}: typeof import('./services/{{{tag}}}');
 {{/each}}
 };
 
-export const setDefaultConfig = <
+export function setDefaultConfig<
   T extends keyof ServicesMap,
   TagedMap extends Record<string, (config: any) => any> = ServicesMap[T],
   ConfigMap = { [K in keyof TagedMap]?: Partial<Parameters<TagedMap[K]>[0]> }
->(
-  _: T,
-  configMap: ConfigMap
-) => configMap;
+>(_: T, configMap: ConfigMap): ConfigMap {
+  return configMap;
+}
+
+export function resolveTagDefaultConfig<C extends object, Key extends string>(defaultConfig: C, tagName: Key) {
+  const raw = (defaultConfig as any)[tagName];
+  return (raw || {}) as C extends { [K in Key]: infer V } ? V : {};
+}

package/dist/template/presets/ky/typescript/services/#index.ts.handlebars

@@ -2,5 +2,5 @@
 import { setDefaultConfig } from '../helper';
 
 {{#each tagedApis}}
-export const {{{tagName}}}DefaultConfig = setDefaultConfig('{{{tagName}}}', {});
+export const {{{tag}}}DefaultConfig = setDefaultConfig('{{{tag}}}', {});
 {{/each}}

package/dist/template/presets/ky/typescript/services/{tag}.ts.handlebars

@@ -1,14 +1,13 @@
 {{> comment}}
 import type { Options } from 'ky';
 import { kyInstance } from '../index';
-import { buildPayload } from '../helper';
+import { buildPayload, resolveTagDefaultConfig } from '../helper';
+import * as defaultConfig from './index';
 import type * as ComponentTypes from '../components';
-{{#each tagedApis}}
-import { {{{tagName}}}DefaultConfig } from '.';
-{{/each}}
 
-{{#each tagedApis}}
-{{#each apis}}
+const {{{currentTag.tag}}}DefaultConfig = resolveTagDefaultConfig(defaultConfig, '{{{currentTag.tag}}}DefaultConfig');
+
+{{#each currentTag.apis}}
 type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 type {{{name}}}ExtraConfig = Options & {
   {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
@@ -18,7 +17,7 @@ type {{{name}}}ExtraConfig = Options & {
 };
 {{> api-jsdoc}}
 export function {{{name}}}(config{{#or pathParameters queryParameters requestBody }}{{else}}?{{/or}}: {{{name}}}ExtraConfig): Promise<{{{name}}}Response> {
-  const { url, mergedConfig } = buildPayload('{{{path}}}', {{{tag}}}DefaultConfig, {{{name}}}.name, config);
+  const { url, mergedConfig } = buildPayload('{{{path}}}', {{../currentTag.tag}}DefaultConfig, {{{name}}}.name, config);
   const resolvedPath = url.replace(/^\//, '');
   return kyInstance(resolvedPath, {
     method: '{{method}}',
@@ -27,4 +26,3 @@ export function {{{name}}}(config{{#or pathParameters queryParameters requestBod
 }
 
 {{/each}}
-{{/each}}

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();
@@ -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);
@@ -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.5",
+  "version": "0.2.7",
   "description": "A modern OpenAPI code generator - Generate type-safe API clients from OpenAPI specs",
   "author": "worma",
   "license": "MIT",

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;