wormajs 0.0.2-beta.3 → 0.2.0

package/dist/template/presets/config/module/worma.config.js.handlebars

@@ -1,5 +1,5 @@
 import { defineConfig } from 'wormajs';
-import { platform, aiDoc{{#if templateImport}}, {{{templateImport}}}{{/if}} } from 'wormajs/plugin';
+import { swagger, aiDoc{{#if templateImport}}, {{{templateImport}}}{{/if}} } from 'wormajs/plugin';
 
 // For more config detailed visit:
 // https://github.com/alovajs/devtools

package/dist/template/presets/config/partials/generator-content.handlebars

@@ -1,45 +1,45 @@
-generator: [
-  {
-    /**
-      * file input. support:
-      * 1. openapi json file url
-      * 2. local file
-      * 3. string array — each URL will be tried in order, first success wins
-      */
-    input: 'http://localhost:3000',
-
-    /**
-      * output path of interface file and type file.
-      * Multiple generators cannot have the same address, otherwise the generated code will overwrite each other.
-      */
-    output: 'src/api',
-
-    /**
-      * platform plugin: auto-resolves OpenAPI file URLs from platform type.
-      * Uses config.input as base URL to construct candidate OpenAPI endpoints.
-      */
-    plugins: [platform('swagger'), aiDoc({ installSkill: true }), {{{templateCall}}}],
-
-    /**
-      * the mediaType of the generated response data. default is `application/json`
-      */
-    // responseMediaType: 'application/json',
-
-    /**
-      * the bodyMediaType of the generated request body data. default is `application/json`
-      */
-    // bodyMediaType: 'application/json',
-
-    /**
-      * type of generated code. The options are `auto/ts/typescript/module/commonjs`
-      */
-    // type: 'auto',
-
-    /**
-      * filter or convert the generated api information, return an apiDescriptor, if this function is not specified, the apiDescriptor object is not converted
-      */
-    // handleApi: apiDescriptor => {
-    //  return apiDescriptor;
-    // }
-  }
-]
+generator: [
+  {
+    /**
+      * file input. support:
+      * 1. openapi json file url
+      * 2. local file
+      * 3. string array — each URL will be tried in order, first success wins
+      */
+    // input: 'http://localhost:3000',
+
+    /**
+      * output path of interface file and type file.
+      * Multiple generators cannot have the same address, otherwise the generated code will overwrite each other.
+      */
+    output: 'src/api',
+
+    /**
+      * swagger platform plugin: auto-resolves OpenAPI file URLs from the base URL.
+      * The base URL is passed as the plugin argument (not config.input).
+      */
+    plugins: [swagger('http://localhost:3000'), aiDoc({ installSkill: true }), {{{templateCall}}}],
+
+    /**
+      * the mediaType of the generated response data. default is `application/json`
+      */
+    // responseMediaType: 'application/json',
+
+    /**
+      * the bodyMediaType of the generated request body data. default is `application/json`
+      */
+    // bodyMediaType: 'application/json',
+
+    /**
+      * type of generated code. The options are `auto/ts/typescript/module/commonjs`
+      */
+    // type: 'auto',
+
+    /**
+      * filter or convert the generated api information, return an apiDescriptor, if this function is not specified, the apiDescriptor object is not converted
+      */
+    // handleApi: apiDescriptor => {
+    //  return apiDescriptor;
+    // }
+  }
+]

package/dist/template/presets/config/typescript/worma.config.ts.handlebars

@@ -1,5 +1,5 @@
 import { defineConfig } from 'wormajs';
-import { platform, aiDoc{{#if templateImport}}, {{{templateImport}}}{{/if}} } from 'wormajs/plugin';
+import { swagger, aiDoc{{#if templateImport}}, {{{templateImport}}}{{/if}} } from 'wormajs/plugin';
 
 // For more config detailed visit:
 // https://github.com/alovajs/devtools

package/dist/template/presets/fetch/partials/dts-types.handlebars

@@ -1,7 +1,7 @@
-type {{{name}}}Response = {{processType response @root.componentNames}};
+type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 type {{{name}}}ExtraConfig = Omit<RequestInit, 'body'> & {
-  {{#if pathParameters}}pathParams: {{processType pathParameters @root.componentNames}};
-  {{/if}}{{#if queryParameters}}params?: {{processType queryParameters @root.componentNames}};
-  {{/if}}{{#if requestBody}}body?: {{processType requestBody @root.componentNames}} | BodyInit;
+  {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
+  {{/if}}{{#if queryParameters}}params?: {{addNamespace queryParameters @root.componentNames}};
+  {{/if}}{{#if requestBody}}body?: {{addNamespace requestBody @root.componentNames}} | BodyInit;
   {{/if}}
 };

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

@@ -8,11 +8,11 @@ import { {{{tagName}}}DefaultConfig } from '.';
 
 {{#each tagedApis}}
 {{#each apis}}
-type {{{name}}}Response = {{processType response @root.componentNames}};
+type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 type {{{name}}}ExtraConfig = Omit<RequestInit, 'body'> & {
-  {{#if pathParameters}}pathParams: {{processType pathParameters @root.componentNames}};
-  {{/if}}{{#if queryParameters}}params?: {{processType queryParameters @root.componentNames}};
-  {{/if}}{{#if requestBody}}body?: {{processType requestBody @root.componentNames}};
+  {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
+  {{/if}}{{#if queryParameters}}params?: {{addNamespace queryParameters @root.componentNames}};
+  {{/if}}{{#if requestBody}}body?: {{addNamespace requestBody @root.componentNames}};
   {{/if}}
 };
 {{> api-jsdoc}}

package/dist/template/presets/ky/partials/dts-types.handlebars

@@ -1,9 +1,9 @@
-type {{{name}}}Response = {{processType response @root.componentNames}};
+type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 {{#or pathParameters queryParameters requestBody}}
 type {{{name}}}ExtraConfig = Options & {
-  {{#if pathParameters}}pathParams: {{processType pathParameters @root.componentNames}};
-  {{/if}}{{#if queryParameters}}searchParams: {{processType queryParameters @root.componentNames}};
-  {{/if}}{{#if requestBody}}json: {{processType requestBody @root.componentNames}};
+  {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
+  {{/if}}{{#if queryParameters}}searchParams: {{addNamespace queryParameters @root.componentNames}};
+  {{/if}}{{#if requestBody}}json: {{addNamespace requestBody @root.componentNames}};
   {{/if}}
 };
 {{/or}}

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

@@ -9,11 +9,11 @@ import { {{{tagName}}}DefaultConfig } from '.';
 
 {{#each tagedApis}}
 {{#each apis}}
-type {{{name}}}Response = {{processType response @root.componentNames}};
+type {{{name}}}Response = {{addNamespace response @root.componentNames}};
 type {{{name}}}ExtraConfig = Options & {
-  {{#if pathParameters}}pathParams: {{processType pathParameters @root.componentNames}};
-  {{/if}}{{#if queryParameters}}searchParams: {{processType queryParameters @root.componentNames}};
-  {{/if}}{{#if requestBody}}json: {{processType requestBody @root.componentNames}};
+  {{#if pathParameters}}pathParams: {{addNamespace pathParameters @root.componentNames}};
+  {{/if}}{{#if queryParameters}}searchParams: {{addNamespace queryParameters @root.componentNames}};
+  {{/if}}{{#if requestBody}}json: {{addNamespace requestBody @root.componentNames}};
   {{/if}}
 };
 {{> api-jsdoc}}

package/dist/tsconfig.build.tsbuildinfo

@@ -1 +1 @@
-{"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/platform.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/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"}
+{"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"}

package/dist/utils/template.js

@@ -76,6 +76,29 @@ function registerCommonHelpers(hbs) {
             return text;
         return text.split('\n').map(line => line.replace(/^\* ?/, '')).join('\n');
     });
+    /**
+     * Scan the type string for every PascalCase identifier that is in componentNames
+     * (and not already prefixed with `${importName}.`) and prefix it.
+     * Works uniformly for top-level names, generics, object literals, and arrays.
+     *
+     * @param typeStr       The type expression to process.
+     * @param componentNames The list of component schema names to prefix.
+     * @param importName     The imported namespace name to prefix with. Defaults to "ComponentTypes".
+     */
+    hbs.registerHelper('addNamespace', (typeStr, componentNames, importName) => {
+        const type = typeStr;
+        const names = componentNames;
+        const importPrefix = (typeof importName === 'string' && importName.length > 0) ? importName : 'ComponentTypes';
+        if (!type || !Array.isArray(names) || names.length === 0) {
+            return new hbs.SafeString(type || 'unknown');
+        }
+        const nameSet = new Set(names);
+        const escapedPrefix = importPrefix.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+        const result = type.replace(new RegExp(`(?<!${escapedPrefix}\\.)(\\b[A-Z]\\w*\\b)`, 'g'), (match) => {
+            return nameSet.has(match) ? `${importPrefix}.${match}` : match;
+        });
+        return new hbs.SafeString(result);
+    });
 }
 /**
  * Pass in text content and generate a custom file in the specified directory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wormajs",
-  "version": "0.0.2-beta.3",
+  "version": "0.2.0",
   "description": "A modern OpenAPI code generator - Generate type-safe API clients from OpenAPI specs",
   "author": "worma",
   "license": "MIT",

package/typings/index.d.ts

@@ -54,12 +54,14 @@ export interface ConfigHookParams {
 	projectPath: string;
 	reportProgress: ReportProgress;
 }
-export interface BeforeOpenapiParseHookParams {
+export interface BeforeSpecParseHookParams {
 	config: Readonly<GeneratorConfig>;
+	/** The raw OpenAPI specification text (JSON or YAML), before it is parsed. */
+	spec: string;
 	projectPath: string;
 	reportProgress: ReportProgress;
 }
-export interface OpenapiParsedHookParams {
+export interface SpecParsedHookParams {
 	config: Readonly<GeneratorConfig>;
 	document: OpenAPIDocument;
 	projectPath: string;
@@ -140,14 +142,16 @@ export interface ApiPlugin {
 	 */
 	config?: (params: ConfigHookParams) => MaybePromise<GeneratorConfig | undefined | null | void>;
 	/**
-	 * Called before parsing the OpenAPI file.
+	 * Called after the raw OpenAPI spec text is fetched but before it is parsed.
+	 * Return a (possibly modified) string to replace the spec text that will be
+	 * parsed. Returning nothing keeps the original spec text.
 	 */
-	beforeOpenapiParse?: (params: BeforeOpenapiParseHookParams) => void;
+	beforeSpecParse?: (params: BeforeSpecParseHookParams) => MaybePromise<string | undefined | null | void>;
 	/**
 	 * Manipulate the openapi document after parsing.
 	 * Returning null does NOT replacing anything.
 	 */
-	openapiParsed?: (params: OpenapiParsedHookParams) => MaybePromise<OpenAPIDocument | undefined | null | void>;
+	specParsed?: (params: SpecParsedHookParams) => MaybePromise<OpenAPIDocument | undefined | null | void>;
 	/**
 	 * Called before code generation. Mutate `params.data` directly to inject
 	 * configuration data (no longer returns a value).

package/typings/plugins.d.ts

@@ -42,12 +42,14 @@ export interface ConfigHookParams {
 	projectPath: string;
 	reportProgress: ReportProgress;
 }
-export interface BeforeOpenapiParseHookParams {
+export interface BeforeSpecParseHookParams {
 	config: Readonly<GeneratorConfig>;
+	/** The raw OpenAPI specification text (JSON or YAML), before it is parsed. */
+	spec: string;
 	projectPath: string;
 	reportProgress: ReportProgress;
 }
-export interface OpenapiParsedHookParams {
+export interface SpecParsedHookParams {
 	config: Readonly<GeneratorConfig>;
 	document: OpenAPIDocument;
 	projectPath: string;
@@ -128,14 +130,16 @@ export interface ApiPlugin {
 	 */
 	config?: (params: ConfigHookParams) => MaybePromise<GeneratorConfig | undefined | null | void>;
 	/**
-	 * Called before parsing the OpenAPI file.
+	 * Called after the raw OpenAPI spec text is fetched but before it is parsed.
+	 * Return a (possibly modified) string to replace the spec text that will be
+	 * parsed. Returning nothing keeps the original spec text.
 	 */
-	beforeOpenapiParse?: (params: BeforeOpenapiParseHookParams) => void;
+	beforeSpecParse?: (params: BeforeSpecParseHookParams) => MaybePromise<string | undefined | null | void>;
 	/**
 	 * Manipulate the openapi document after parsing.
 	 * Returning null does NOT replacing anything.
 	 */
-	openapiParsed?: (params: OpenapiParsedHookParams) => MaybePromise<OpenAPIDocument | undefined | null | void>;
+	specParsed?: (params: SpecParsedHookParams) => MaybePromise<OpenAPIDocument | undefined | null | void>;
 	/**
 	 * Called before code generation. Mutate `params.data` directly to inject
 	 * configuration data (no longer returns a value).
@@ -529,36 +533,29 @@ export interface ImportTypeOptions {
 export declare function importType(imports: Record<string, string[]>, options?: {
 	files?: string[];
 }): ApiPlugin;
-declare enum ModifierScope {
-	PARAMS = "params",
-	PATH_PARAMS = "pathParams",
-	DATA = "data",
-	RESPONSE = "response"
-}
-export type SchemaPrimitive = "number" | "string" | "boolean" | "undefined" | "null" | "unknown" | "any" | "never" | ({} & string);
+export type ModifierScope = "params" | "pathParams" | "data" | "response";
+export type SchemaPrimitive = "number" | "string" | "boolean" | "undefined" | "null" | "unknown" | "any" | "never";
 /**
- * 表示数组类型
+ * Array type: a native JS array whose elements are Schemas.
+ * e.g. ['string'] means string[]; ['string', 'number'] means the tuple [string, number]
  */
-export interface SchemaArray {
-	type: "array";
-	items: Schema | Schema[];
-}
+export type SchemaArray = Schema[];
 /**
- * 修改参数为引用类型
- * 在key末端添加上?表示为可选值
+ * Object/reference type.
+ * Append '?' to the end of a key to mark it optional.
  */
 export interface SchemaReference {
 	[attr: string]: Schema;
 }
 /**
- * 枚举类型表示
+ * Enum type representation.
  */
 export interface SchemaEnum {
 	enum: Array<string | number | boolean | null>;
 	type?: SchemaPrimitive;
 }
 /**
- * 组合类型表示（与/或/交叉）
+ * Composite types (oneOf / anyOf / allOf).
  */
 export interface SchemaOneOf {
 	oneOf: Schema[];
@@ -570,60 +567,149 @@ export interface SchemaAllOf {
 	allOf: Schema[];
 }
 /**
- * 数据Schema
- * SchemaArray表示类型数组，而数组表示“或”的意思
+ * Standalone primitive type that is itself optional (driven by the `type` field).
+ * Used in handler input/output to mean "this field is optional / make it optional".
+ */
+export interface SchemaOptional {
+	required: boolean;
+	type: Schema;
+}
+/**
+ * The data Schema.
+ * - SchemaArray is a native array (elements are Schemas)
+ * - composite types use { oneOf | anyOf | allOf: Schema[] }
+ * - optional object properties use a trailing '?' on the key;
+ *   a standalone optional primitive uses the SchemaOptional wrapper
  */
-export type Schema = SchemaPrimitive | SchemaReference | SchemaArray | SchemaEnum | SchemaOneOf | SchemaAnyOf | SchemaAllOf | Array<SchemaPrimitive | SchemaReference | SchemaArray | SchemaEnum>;
-export interface ModifierConfig<T extends Schema> {
+export type Schema = SchemaPrimitive | SchemaReference | SchemaArray | SchemaEnum | SchemaOneOf | SchemaAnyOf | SchemaAllOf | SchemaOptional;
+export interface ModifierConfig {
 	/**
-	 * 生效范围，表示处理哪个位置的参数
+	 * The scope the modifier applies to (which parameter location to process).
 	 */
 	scope: ModifierScope;
 	/**
-	 * 匹配规则，只有匹配到的才会进行转换，不指定则转换全部
-	 * string：原参数名包含此string；RegExp：原参数名匹配此正则；函数时接收key并返回是否匹配的boolean值
+	 * Match rule. Only matched fields are transformed; when omitted, all fields are transformed.
+	 * - string: the original field name contains this string
+	 * - RegExp: the original field name matches this pattern
+	 * - function: receives the key and returns a boolean indicating a match
 	 */
 	match?: string | RegExp | ((key: string) => boolean);
 	/**
-	 * handler用于灵活修改参数类型值
-	 * @param schema Schema中的一种，由用户自行定义
-	 * @returns 返回多种参数，具体为：Schema表示修改的类型；{ required: boolean, value: Schema }表示可将当前值修改为是否必填；void | null | undefined表示移除当前字段
+	 * handler flexibly modifies the parameter type value.
+	 * @param schema the original field type, already converted to the user-facing Schema representation.
+	 *               When the field itself is optional and is a primitive, it is passed as { required: false, type: 'string' }.
+	 *               Narrow the type inside handler if needed (e.g. with a cast).
+	 * @returns Schema to change the type; { required: boolean, type: Schema } to change requiredness (driven by `type`);
+	 *          void | null | undefined to remove the field.
 	 */
-	handler: (schema: T) => Schema | {
+	handler: (schema: Schema) => Schema | {
 		required: boolean;
-		value: Schema;
+		type: Schema;
 	} | void | null | undefined;
 }
-export type PayloadModifierConfig = ModifierConfig<Schema>;
+export type PayloadModifierConfig = ModifierConfig;
 export declare function payloadModifier(configs: PayloadModifierConfig[]): ApiPlugin;
 /**
- * Supported platform types
+ * FastAPI platform plugin.
+ *
+ * Pass the base URL of your FastAPI app; the plugin will try `/openapi.json`
+ * first, then fall back to the bare base URL.
+ *
+ * @param input - base URL string, or an array of base URLs
+ *
+ * @example
+ * ```ts
+ * plugins: [fastapi('http://fastapi-example.dokkuapp.com'), alovaGlobals()]
+ * ```
+ */
+export declare const fastapi: (input: string | string[]) => ApiPlugin;
+/**
+ * Knife4j platform plugin.
+ *
+ * Pass the base URL of your Knife4j instance; the plugin will try the OAS3
+ * endpoint (springdoc) first, then the Swagger2 endpoint (springfox), then the
+ * bare base URL.
+ *
+ * @param input - base URL string, or an array of base URLs
+ *
+ * @example
+ * ```ts
+ * plugins: [knife4j('https://openapi3.demo.knife4jnext.com'), alovaGlobals()]
+ * ```
+ */
+export declare const knife4j: (input: string | string[]) => ApiPlugin;
+/**
+ * Swagger platform plugin.
+ *
+ * Pass the base URL of your Swagger UI / server; the plugin will try several
+ * common OpenAPI document endpoints (OAS3 first, then Swagger2, then the bare
+ * base URL) and let the framework pick the first one that responds.
+ *
+ * @param input - base URL string, or an array of base URLs
+ *
+ * @example
+ * ```ts
+ * import { swagger, alovaGlobals } from 'wormajs/plugin';
+ *
+ * defineConfig({
+ *   generator: [{
+ *     plugins: [swagger('https://petstore3.swagger.io'), alovaGlobals()],
+ *     output: './src/api',
+ *   }]
+ * });
+ * ```
  */
-export type PlatformType = "swagger" | "knife4j" | "fastapi" | "yapi";
+export declare const swagger: (input: string | string[]) => ApiPlugin;
+export interface YapiOptions {
+	/** YApi 服务基础地址，例如 `https://yapi.xxx.com` */
+	url: string;
+	/** 项目 ID，必填，用于拼装导出地址 */
+	pid: string | number;
+	/** OpenAPI 类型，默认 `OpenAPIV2` */
+	type?: string;
+	/** 接口状态，默认 `all` */
+	status?: string;
+	/** 是否包含 wiki，默认 `true` */
+	isWiki?: boolean;
+	/** 登录 cookie。也可通过 fetchOptions.headers.cookie 传入 */
+	cookie?: string;
+	/** 额外的 fetch 超时（毫秒） */
+	timeout?: number;
+}
 /**
- * Platform plugin for auto-resolving OpenAPI file URLs.
+ * YApi platform plugin.
  *
- * Pass a platform type (e.g., `'swagger'`) and the plugin will use `config.input`
- * as the base URL to generate candidate OpenAPI file URLs. The framework will try
- * each URL in order and use the first successful response.
+ * YApi projects are private, so the OpenAPI document must be exported through
+ * YApi's own export endpoint, authenticated with your login cookie. The plugin
+ * builds the export URL from the server base URL (`url`) plus the required
+ * `pid` and the optional `type` / `status` / `isWiki` query params (which
+ * default to `OpenAPIV2`, `all`, and `true` respectively).
  *
- * @param platformType - The platform type: 'swagger' | 'knife4j' | 'fastapi' | 'yapi'
- * @returns ApiPlugin
+ * `url`, `pid` and `cookie` are required — the plugin throws a clear error when
+ * any is missing.
+ *
+ * @param options - `{ url, pid, cookie?, type?, status?, isWiki?, timeout? }`
  *
  * @example
  * ```ts
- * import { platform, alovaGlobals } from 'wormajs/plugin';
+ * import { yapi, alovaGlobals } from 'wormajs/plugin';
  *
  * defineConfig({
  *   generator: [{
- *     input: 'https://petstore3.swagger.io',
- *     plugins: [platform('swagger'), alovaGlobals()],
+ *     plugins: [
+ *       yapi({
+ *         url: 'https://yapi.xxx.com',
+ *         pid: 123,
+ *         cookie: '_yapi_token=xxx; _yapi_uid=yyy',
+ *       }),
+ *       alovaGlobals(),
+ *     ],
  *     output: './src/api',
  *   }]
  * });
  * ```
  */
-export declare function platform(platformType: PlatformType): ApiPlugin;
+export declare function yapi(options: YapiOptions): ApiPlugin;
 /**
  * Rename style options
  */
@@ -635,7 +721,7 @@ export interface RenameConfig {
 	/**
 	 * Target scope for renaming, defaults to 'url'
 	 */
-	scope?: "url" | "params" | "pathParams" | "data" | "response" | "refName";
+	scope?: "url" | "params" | "pathParams" | "data" | "response" | "refName" | "name";
 	/**
 	 * Matching rule for selective renaming:
 	 * - string: target contains this string
@@ -643,7 +729,7 @@ export interface RenameConfig {
 	 * - function: custom matching logic
 	 * If not specified, all targets will be processed
 	 */
-	match?: string | RegExp | ((key: string) => boolean);
+	match?: string | RegExp | ((key: string, level?: number) => boolean);
 	/**
 	 * Naming style to apply
 	 */

package/dist/plugins/presets/platform.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.platform = platform;
-const constant_1 = require("../../constant");
-/**
- * Generate OpenAPI file URLs based on platform type.
- * For Swagger and Knife4j, generates multiple URLs covering both OAS3 and Swagger2 endpoints.
- */
-function resolvePlatformUrls(baseUrl, platformType) {
-    // Normalize: remove trailing slash
-    const base = baseUrl.replace(/\/+$/, '');
-    switch (platformType) {
-        case 'swagger':
-            // Try OAS3 first, then Swagger2, then generic openapi.json
-            return [
-                `${base}/openapi.json`,
-                `${base}/v2/swagger.json`,
-                `${base}/api/v3/openapi.json`,
-                baseUrl,
-            ];
-        case 'knife4j':
-            // Try OAS3 first (springdoc), then Swagger2 (springfox)
-            return [
-                `${base}/v3/api-docs`,
-                `${base}/v2/api-docs`,
-                baseUrl,
-            ];
-        case 'fastapi':
-            return [`${base}/openapi.json`, baseUrl];
-        case 'yapi':
-            // YApi requires pid and token in URL, use input as-is
-            return [baseUrl];
-    }
-}
-/**
- * Platform plugin for auto-resolving OpenAPI file URLs.
- *
- * Pass a platform type (e.g., `'swagger'`) and the plugin will use `config.input`
- * as the base URL to generate candidate OpenAPI file URLs. The framework will try
- * each URL in order and use the first successful response.
- *
- * @param platformType - The platform type: 'swagger' | 'knife4j' | 'fastapi' | 'yapi'
- * @returns ApiPlugin
- *
- * @example
- * ```ts
- * import { platform, alovaGlobals } from 'wormajs/plugin';
- *
- * defineConfig({
- *   generator: [{
- *     input: 'https://petstore3.swagger.io',
- *     plugins: [platform('swagger'), alovaGlobals()],
- *     output: './src/api',
- *   }]
- * });
- * ```
- */
-function platform(platformType) {
-    return {
-        name: constant_1.PluginName.PLATFORM,
-        config({ config }) {
-            const raw = config.input;
-            if (!raw)
-                return config;
-            // Normalize to an array of base URLs, deduplicate
-            const inputs = Array.isArray(raw) ? [...new Set(raw)] : [raw];
-            // For each input, generate platform URLs, then flatten
-            config.input = inputs.flatMap(url => resolvePlatformUrls(url, platformType));
-            return config;
-        },
-    };
-}
-exports.default = platform;