@ahoo-wang/fetcher 1.2.3 → 1.2.5

package/README.md

@@ -12,8 +12,8 @@ The lightweight core that powers the entire Fetcher ecosystem. Ultra-lightweight
 
 ## 🌟 Features
 
-- **⚡ Ultra-Lightweight**: Only 2.7KiB min+gzip
-- **🧭 Path & Query Parameters**: Built-in support for path (`{id}`) and query parameters
+- **⚡ Ultra-Lightweight**: Only 2.8KiB min+gzip
+- **🧭 Path & Query Parameters**: Built-in support for path (`{id}`/`:id`) and query parameters
 - **🔗 Interceptor System**: Request, response, and error interceptors for middleware patterns
 - **⏱️ Timeout Control**: Configurable request timeouts with proper error handling
 - **🔄 Fetch API Compatible**: Fully compatible with the native Fetch API
@@ -63,6 +63,50 @@ const createUserResponse = await fetcher.post('/users', {
 });
 ```
 
+### URL Template Styles
+
+Fetcher supports different URL template styles for path parameters:
+
+1. **URI Template Style** (default): Uses curly braces, e.g., `/users/{id}/posts/{postId}`
+2. **Express Style**: Uses colons, e.g., `/users/:id/posts/:postId`
+
+You can configure the URL template style when creating a Fetcher instance:
+
+```typescript
+import { Fetcher, UrlTemplateStyle } from '@ahoo-wang/fetcher';
+
+// Default URI Template style
+const fetcher1 = new Fetcher({
+  baseURL: 'https://api.example.com'
+});
+
+// Explicit URI Template style
+const fetcher2 = new Fetcher({
+  baseURL: 'https://api.example.com',
+  urlTemplateStyle: UrlTemplateStyle.UriTemplate
+});
+
+// Express style
+const fetcher3 = new Fetcher({
+  baseURL: 'https://api.example.com',
+  urlTemplateStyle: UrlTemplateStyle.Express
+});
+
+// Usage with URI Template style
+const response1 = await fetcher1.get('/users/{id}', {
+  urlParams: {
+    path: { id: 123 }
+  }
+});
+
+// Usage with Express style
+const response2 = await fetcher3.get('/users/:id', {
+  urlParams: {
+    path: { id: 123 }
+  }
+});
+```
+
 ### Integration Test Example: Typicode API Integration
 
 The following example shows how to integrate with the JSONPlaceholder API, similar to the integration test in the
@@ -264,6 +308,7 @@ new Fetcher(options ? : FetcherOptions);
 - `timeout`: Request timeout in milliseconds
 - `headers`: Default request headers
 - `interceptors`: Interceptor collection for request, response, and error handling
+- `urlTemplateStyle`: URL template style for path parameter resolution (default: UriTemplate)
 
 #### Properties
 
@@ -395,4 +440,4 @@ This project is licensed under the [Apache-2.0 License](https://opensource.org/l
 
 <p align="center">
   Part of the <a href="https://github.com/Ahoo-Wang/fetcher">Fetcher</a> ecosystem
-</p>
+</p>

package/README.zh-CN.md

@@ -12,8 +12,8 @@
 
 ## 🌟 特性
 
-- **⚡ 超轻量级**：仅 2.7KiB min+gzip
-- **🧭 路径和查询参数**：内置支持路径（`{id}`）和查询参数
+- **⚡ 超轻量级**：仅 2.8KiB min+gzip
+- **🧭 路径和查询参数**：内置支持路径（`{id}`/`:id`）和查询参数
 - **🔗 拦截器系统**：请求、响应和错误拦截器的中间件模式
 - **⏱️ 超时控制**：可配置的请求超时和适当的错误处理
 - **🔄 Fetch API 兼容**：与原生 Fetch API 完全兼容
@@ -63,6 +63,50 @@ const createUserResponse = await fetcher.post('/users', {
 });
 ```
 
+### URL 模板样式
+
+Fetcher 支持不同的 URL 模板样式来处理路径参数：
+
+1. **URI 模板样式**（默认）：使用花括号，例如 `/users/{id}/posts/{postId}`
+2. **Express 样式**：使用冒号，例如 `/users/:id/posts/:postId`
+
+您可以在创建 Fetcher 实例时配置 URL 模板样式：
+
+```typescript
+import { Fetcher, UrlTemplateStyle } from '@ahoo-wang/fetcher';
+
+// 默认 URI 模板样式
+const fetcher1 = new Fetcher({
+  baseURL: 'https://api.example.com'
+});
+
+// 显式指定 URI 模板样式
+const fetcher2 = new Fetcher({
+  baseURL: 'https://api.example.com',
+  urlTemplateStyle: UrlTemplateStyle.UriTemplate
+});
+
+// Express 样式
+const fetcher3 = new Fetcher({
+  baseURL: 'https://api.example.com',
+  urlTemplateStyle: UrlTemplateStyle.Express
+});
+
+// 使用 URI 模板样式
+const response1 = await fetcher1.get('/users/{id}', {
+  urlParams: {
+    path: { id: 123 }
+  }
+});
+
+// 使用 Express 样式
+const response2 = await fetcher3.get('/users/:id', {
+  urlParams: {
+    path: { id: 123 }
+  }
+});
+```
+
 ### 集成测试示例：Typicode API 集成
 
 以下示例展示了如何与 JSONPlaceholder API 集成，类似于 Fetcher
@@ -253,6 +297,7 @@ new Fetcher(options ? : FetcherOptions);
 - `timeout`：请求超时时间（毫秒）
 - `headers`：默认请求头部
 - `interceptors`：用于请求、响应和错误处理的拦截器集合
+- `urlTemplateStyle`：用于路径参数解析的 URL 模板样式（默认：UriTemplate）
 
 #### 属性
 
@@ -381,4 +426,4 @@ Fetcher 拦截器集合，包括请求、响应和错误拦截器管理器。
 
 <p align="center">
   Fetcher 生态系统的一部分
-</p>
+</p>

package/dist/fetcher.d.ts

@@ -3,6 +3,7 @@ import { TimeoutCapable } from './timeout';
 import { FetchExchange } from './fetchExchange';
 import { BaseURLCapable, FetchRequest, FetchRequestInit, RequestHeaders, RequestHeadersCapable } from './fetchRequest';
 import { InterceptorManager } from './interceptorManager';
+import { UrlTemplateStyle } from './urlTemplateResolver';
 /**
  * Configuration options for the Fetcher client.
  *
@@ -12,6 +13,7 @@ import { InterceptorManager } from './interceptorManager';
  * @example
  * ```typescript
  * const options: FetcherOptions = {
+ *   urlTemplateStyle: UrlTemplateStyle.UriTemplate,
  *   baseURL: 'https://api.example.com',
  *   headers: { 'Content-Type': 'application/json' },
  *   timeout: 5000,
@@ -20,6 +22,7 @@ import { InterceptorManager } from './interceptorManager';
  * ```
  */
 export interface FetcherOptions extends BaseURLCapable, RequestHeadersCapable, TimeoutCapable {
+    urlTemplateStyle?: UrlTemplateStyle;
     interceptors?: InterceptorManager;
 }
 export declare const DEFAULT_OPTIONS: FetcherOptions;

package/dist/fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAkB,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,gBAAgB,EAEhB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IACnE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAmB;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAE1C;;;;;;;OAOG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;;;;;OAUG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO3E;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAgB5D;;;;;;;;;;OAUG;YACW,WAAW;IAWzB;;;;;;;;;OASG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;CAGrB"}
+{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAkB,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,gBAAgB,EAEhB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IACnE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAmB;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAE1C;;;;;;;OAOG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;;;;;OAUG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO3E;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAgB5D;;;;;;;;;;OAUG;YACW,WAAW;IAWzB;;;;;;;;;OASG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;CAGrB"}

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export * from './types';
 export * from './urlBuilder';
 export * from './urlResolveInterceptor';
 export * from './urls';
+export * from './urlTemplateResolver';
 export * from './utils';
 export * from './validateStatusInterceptor';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,6BAA6B,CAAC"}