@ahoo-wang/fetcher-decorator 0.5.6 → 0.6.1

package/README.md

@@ -6,6 +6,7 @@
 [![License](https://img.shields.io/npm/l/@ahoo-wang/fetcher-decorator.svg)](https://github.com/Ahoo-Wang/fetcher/blob/main/LICENSE)
 [![npm downloads](https://img.shields.io/npm/dm/@ahoo-wang/fetcher-decorator.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-decorator)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40ahoo-wang%2Ffetcher-decorator)](https://www.npmjs.com/package/@ahoo-wang/fetcher-decorator)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Ahoo-Wang/fetcher)
 
 Decorator support for Fetcher HTTP client. Enables clean, declarative API service definitions using TypeScript
 decorators.
@@ -63,8 +64,8 @@ class UserService {
 
   @get('/{id}')
   getUser(
-    @path('id') id: number,
-    @query('include') include: string,
+    @path() id: number,
+    @query() include: string,
   ): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }
@@ -147,7 +148,7 @@ Defines an OPTIONS endpoint.
 ```typescript
 class UserService {
   @get('/{id}', { timeout: 3000 })
-  getUser(@path('id') id: number): Promise<Response> {
+  getUser(@path() id: number): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }
 
@@ -162,31 +163,34 @@ class UserService {
 
 #### `@path(name)`
 
-Defines a path parameter.
+Defines a path parameter. The name is optional - if not provided, it will be automatically extracted from the method
+parameter name.
 
 **Parameters:**
 
-- `name`: Name of the parameter (used in the path template)
+- `name`: Name of the parameter (used in the path template, optional - auto-extracted if not provided)
 
 #### `@query(name)`
 
-Defines a query parameter.
+Defines a query parameter. The name is optional - if not provided, it will be automatically extracted from the method
+parameter name.
 
 **Parameters:**
 
-- `name`: Name of the parameter (used in the query string)
+- `name`: Name of the parameter (used in the query string, optional - auto-extracted if not provided)
 
 #### `@body()`
 
-Defines a request body.
+Defines a request body. Body parameters don't have names since there's only one body per request.
 
 #### `@header(name)`
 
-Defines a header parameter.
+Defines a header parameter. The name is optional - if not provided, it will be automatically extracted from the method
+parameter name.
 
 **Parameters:**
 
-- `name`: Name of the header
+- `name`: Name of the header (optional - auto-extracted if not provided)
 
 **Example:**
 
@@ -195,14 +199,14 @@ class UserService {
   @get('/search')
   searchUsers(
     @query('q') query: string,
-    @query('limit') limit: number,
+    @query() limit: number,
     @header('Authorization') auth: string,
   ): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }
 
   @put('/{id}')
-  updateUser(@path('id') id: number, @body() user: User): Promise<Response> {
+  updateUser(@path() id: number, @body() user: User): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }
 }
@@ -224,7 +228,7 @@ class BaseService {
 @api('/users')
 class UserService extends BaseService {
   @get('/{id}')
-  getUser(@path('id') id: number): Promise<Response> {
+  getUser(@path() id: number): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }
 }
@@ -239,7 +243,7 @@ class ComplexService {
   batchOperation(
     @body() items: Item[],
     @header('X-Request-ID') requestId: string,
-    @query('dryRun') dryRun: boolean = false,
+    @query() dryRun: boolean = false,
   ): Promise<Response> {
     throw new Error('Implementation will be generated automatically.');
   }

package/README.zh-CN.md

@@ -6,6 +6,7 @@
 [![License](https://img.shields.io/npm/l/@ahoo-wang/fetcher-decorator.svg)](https://github.com/Ahoo-Wang/fetcher/blob/main/LICENSE)
 [![npm downloads](https://img.shields.io/npm/dm/@ahoo-wang/fetcher-decorator.svg)](https://www.npmjs.com/package/@ahoo-wang/fetcher-decorator)
 [![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40ahoo-wang%2Ffetcher-decorator)](https://www.npmjs.com/package/@ahoo-wang/fetcher-decorator)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Ahoo-Wang/fetcher)
 
 Fetcher HTTP 客户端的装饰器支持。使用 TypeScript 装饰器实现简洁、声明式的 API 服务定义。
 
@@ -62,8 +63,8 @@ class UserService {
 
   @get('/{id}')
   getUser(
-    @path('id') id: number,
-    @query('include') include: string,
+    @path() id: number,
+    @query() include: string,
   ): Promise<Response> {
     throw new Error('实现将自动生成');
   }
@@ -146,7 +147,7 @@ class ApiService {
 ```typescript
 class UserService {
   @get('/{id}', { timeout: 3000 })
-  getUser(@path('id') id: number): Promise<Response> {
+  getUser(@path() id: number): Promise<Response> {
     throw new Error('实现将自动生成');
   }
 
@@ -161,31 +162,31 @@ class UserService {
 
 #### `@path(name)`
 
-定义路径参数。
+定义路径参数。名称是可选的 - 如果未提供，将使用反射从方法参数名自动提取。
 
 **参数：**
 
-- `name`: 参数名称（在路径模板中使用）
+- `name`: 参数名称（在路径模板中使用，可选 - 如果未提供则自动提取）
 
 #### `@query(name)`
 
-定义查询参数。
+定义查询参数。名称是可选的 - 如果未提供，将使用反射从方法参数名自动提取。
 
 **参数：**
 
-- `name`: 参数名称（在查询字符串中使用）
+- `name`: 参数名称（在查询字符串中使用，可选 - 如果未提供则自动提取）
 
 #### `@body()`
 
-定义请求体。
+定义请求体。请求体参数没有名称，因为每个请求只有一个请求体。
 
 #### `@header(name)`
 
-定义头部参数。
+定义头部参数。名称是可选的 - 如果未提供，将使用反射从方法参数名自动提取。
 
 **参数：**
 
-- `name`: 头部名称
+- `name`: 头部名称（可选 - 如果未提供则自动提取）
 
 **示例：**
 
@@ -194,7 +195,7 @@ class UserService {
   @get('/search')
   searchUsers(
     @query('q') query: string,
-    @query('limit') limit: number,
+    @query() limit: number,
     @header('Authorization') auth: string,
   ): Promise<Response> {
     throw new Error('实现将自动生成');
@@ -223,7 +224,7 @@ class BaseService {
 @api('/users')
 class UserService extends BaseService {
   @get('/{id}')
-  getUser(@path('id') id: number): Promise<Response> {
+  getUser(@path() id: number): Promise<Response> {
     throw new Error('实现将自动生成');
   }
 }
@@ -238,7 +239,7 @@ class ComplexService {
   batchOperation(
     @body() items: Item[],
     @header('X-Request-ID') requestId: string,
-    @query('dryRun') dryRun: boolean = false,
+    @query() dryRun: boolean = false,
   ): Promise<Response> {
     throw new Error('实现将自动生成');
   }

package/dist/parameterDecorator.d.ts

@@ -94,20 +94,104 @@ export declare const PARAMETER_METADATA_KEY: unique symbol;
  * This function creates a decorator that can be used to specify how a method parameter
  * should be handled in the HTTP request. It stores metadata about the parameter
  * that will be used during request execution.
+ * The name is optional - if not provided, it will be automatically extracted
+ * from the method parameter name using reflection.
  *
  * @param type - The type of parameter (PATH, QUERY, HEADER, or BODY)
- * @param name - The name of the parameter (used for path, query, and header parameters)
+ * @param name - The name of the parameter (used for path, query, and header parameters, optional - auto-extracted if not provided)
  * @returns A parameter decorator function
  *
  * @example
  * ```typescript
+ * // With explicit name
  * @get('/users/{id}')
  * getUser(@parameter(ParameterType.PATH, 'id') userId: string): Promise<Response>
+ *
+ * // With auto-extracted name
+ * @get('/users/{userId}')
+ * getUser(@parameter(ParameterType.PATH) userId: string): Promise<Response>
  * ```
  */
 export declare function parameter(type: ParameterType, name?: string): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+/**
+ * Path parameter decorator
+ *
+ * Defines a path parameter that will be inserted into the URL path.
+ * The name is optional - if not provided, it will be automatically extracted
+ * from the method parameter name using reflection.
+ *
+ * @param name - The name of the path parameter (optional, auto-extracted if not provided)
+ * @returns A parameter decorator function
+ *
+ * @example
+ * ```typescript
+ * // With explicit name
+ * @get('/users/{id}')
+ * getUser(@path('id') userId: string): Promise<Response>
+ *
+ * // With auto-extracted name
+ * @get('/users/{userId}')
+ * getUser(@path() userId: string): Promise<Response>
+ * ```
+ */
 export declare function path(name?: string): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+/**
+ * Query parameter decorator
+ *
+ * Defines a query parameter that will be appended to the URL query string.
+ * The name is optional - if not provided, it will be automatically extracted
+ * from the method parameter name using reflection.
+ *
+ * @param name - The name of the query parameter (optional, auto-extracted if not provided)
+ * @returns A parameter decorator function
+ *
+ * @example
+ * ```typescript
+ * // With explicit name
+ * @get('/users')
+ * getUsers(@query('limit') limit: number): Promise<Response>
+ *
+ * // With auto-extracted name
+ * @get('/users')
+ * getUsers(@query() limit: number): Promise<Response>
+ * ```
+ */
 export declare function query(name?: string): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+/**
+ * Header parameter decorator
+ *
+ * Defines a header parameter that will be added to the request headers.
+ * The name is optional - if not provided, it will be automatically extracted
+ * from the method parameter name using reflection.
+ *
+ * @param name - The name of the header parameter (optional, auto-extracted if not provided)
+ * @returns A parameter decorator function
+ *
+ * @example
+ * ```typescript
+ * // With explicit name
+ * @get('/users')
+ * getUsers(@header('Authorization') token: string): Promise<Response>
+ *
+ * // With auto-extracted name
+ * @get('/users')
+ * getUsers(@header() authorization: string): Promise<Response>
+ * ```
+ */
 export declare function header(name?: string): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+/**
+ * Body parameter decorator
+ *
+ * Defines a body parameter that will be sent as the request body.
+ * Note that body parameters don't have names since there's only one body per request.
+ *
+ * @returns A parameter decorator function
+ *
+ * @example
+ * ```typescript
+ * @post('/users')
+ * createUser(@body() user: User): Promise<Response>
+ * ```
+ */
 export declare function body(): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
 //# sourceMappingURL=parameterDecorator.d.ts.map

package/dist/parameterDecorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameterDecorator.d.ts","sourceRoot":"","sources":["../src/parameterDecorator.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC;AAE1B;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB;;;;;;;;;;;OAWG;IACH,IAAI,SAAS;IAEb;;;;;;;;;;;OAWG;IACH,KAAK,UAAU;IAEf;;;;;;;;;;;OAWG;IACH,MAAM,WAAW;IAEjB;;;;;;;;;;;OAWG;IACH,IAAI,SAAS;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,sBAAsB,eAA+B,CAAC;AAEnE;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,GAAE,MAAW,IAE5D,QAAQ,MAAM,EACd,aAAa,MAAM,GAAG,MAAM,EAC5B,gBAAgB,MAAM,UAyBzB;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,YA7B1B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UA6BzB;AAED,wBAAgB,KAAK,CAAC,IAAI,GAAE,MAAW,YAjC3B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAiCzB;AAED,wBAAgB,MAAM,CAAC,IAAI,GAAE,MAAW,YArC5B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAqCzB;AAED,wBAAgB,IAAI,aAzCR,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAyCzB"}
+{"version":3,"file":"parameterDecorator.d.ts","sourceRoot":"","sources":["../src/parameterDecorator.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC;AAE1B;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB;;;;;;;;;;;OAWG;IACH,IAAI,SAAS;IAEb;;;;;;;;;;;OAWG;IACH,KAAK,UAAU;IAEf;;;;;;;;;;;OAWG;IACH,MAAM,WAAW;IAEjB;;;;;;;;;;;OAWG;IACH,IAAI,SAAS;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,IAAI,EAAE,aAAa,CAAC;IAEpB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,sBAAsB,eAA+B,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,GAAE,MAAW,IAE5D,QAAQ,MAAM,EACd,aAAa,MAAM,GAAG,MAAM,EAC5B,gBAAgB,MAAM,UAyBzB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,YAlD1B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAkDzB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,MAAW,YA3E3B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UA2EzB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,MAAM,CAAC,IAAI,GAAE,MAAW,YApG5B,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAoGzB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,IAAI,aAtHR,MAAM,eACD,MAAM,GAAG,MAAM,kBACZ,MAAM,UAsHzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-decorator",
-  "version": "0.5.6",
+  "version": "0.6.1",
   "description": "TypeScript decorators for clean API service definitions with Fetcher HTTP client",
   "keywords": [
     "fetch",
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "reflect-metadata": "^0.2.2",
-    "@ahoo-wang/fetcher": "0.5.6"
+    "@ahoo-wang/fetcher": "0.6.1"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",