@ahoo-wang/fetcher-decorator 0.9.5 → 0.9.8

package/README.md

@@ -284,6 +284,51 @@ class UserService {
 }
 ```
 
+### Result Extractors
+
+Result extractors are used to process and extract data from different types of responses or results in the application.
+They allow you to customize how the response from an HTTP request is processed and returned.
+
+#### Available Result Extractors
+
+- **ExchangeResultExtractor**: Returns the original FetchExchange object
+- **ResponseResultExtractor**: Returns the response object from FetchExchange (default)
+- **JsonResultExtractor**: Parses the response content as JSON format
+- **TextResultExtractor**: Parses the response content as text format
+- **ServerSentEventStreamResultExtractor**: Extracts server-sent event stream from FetchExchange
+- **CommandResultEventStreamResultExtractor**: Extracts command result event stream from FetchExchange
+
+#### Using Result Extractors
+
+You can specify a result extractor at the class level or method level:
+
+```typescript
+import { ResultExtractors } from '@ahoo-wang/fetcher-decorator';
+
+@api('/users', { resultExtractor: ResultExtractors.Json })
+class UserService {
+  // Uses class-level JSON result extractor
+  @get('/{id}')
+  getUser(@path() id: number): Promise<User> {
+    throw new Error('Implementation will be generated automatically.');
+  }
+
+  // Overrides with ServerSentEventStream result extractor
+  @get('/events', { resultExtractor: ResultExtractors.ServerSentEventStream })
+  getUserEvents(): Promise<ServerSentEventStream> {
+    throw new Error('Implementation will be generated automatically.');
+  }
+
+  // Uses CommandResultEventStream result extractor for command handling
+  @post('/commands', {
+    resultExtractor: ResultExtractors.CommandResultEventStream,
+  })
+  executeCommand(@body() command: Command): Promise<CommandResultEventStream> {
+    throw new Error('Implementation will be generated automatically.');
+  }
+}
+```
+
 ## 🧪 Testing
 
 ```bash

package/README.zh-CN.md

@@ -277,6 +277,51 @@ class UserService {
 }
 ```
 
+### 结果提取器
+
+结果提取器用于处理和提取应用程序中不同类型响应或结果的数据。
+它们允许您自定义如何处理和返回 HTTP 请求的响应。
+
+#### 可用的结果提取器
+
+- **ExchangeResultExtractor**: 返回原始的 FetchExchange 对象
+- **ResponseResultExtractor**: 返回 FetchExchange 中的响应对象（默认）
+- **JsonResultExtractor**: 将响应内容解析为 JSON 格式
+- **TextResultExtractor**: 将响应内容解析为文本格式
+- **ServerSentEventStreamResultExtractor**: 从 FetchExchange 中提取服务器发送事件流
+- **CommandResultEventStreamResultExtractor**: 从 FetchExchange 中提取命令结果事件流
+
+#### 使用结果提取器
+
+您可以在类级别或方法级别指定结果提取器：
+
+```typescript
+import { ResultExtractors } from '@ahoo-wang/fetcher-decorator';
+
+@api('/users', { resultExtractor: ResultExtractors.Json })
+class UserService {
+  // 使用类级别的 JSON 结果提取器
+  @get('/{id}')
+  getUser(@path() id: number): Promise<User> {
+    throw new Error('实现将自动生成');
+  }
+
+  // 使用 ServerSentEventStream 结果提取器覆盖
+  @get('/events', { resultExtractor: ResultExtractors.ServerSentEventStream })
+  getUserEvents(): Promise<ServerSentEventStream> {
+    throw new Error('实现将自动生成');
+  }
+
+  // 使用 CommandResultEventStream 结果提取器处理命令
+  @post('/commands', {
+    resultExtractor: ResultExtractors.CommandResultEventStream,
+  })
+  executeCommand(@body() command: Command): Promise<CommandResultEventStream> {
+    throw new Error('实现将自动生成');
+  }
+}
+```
+
 ## 🧪 测试
 
 ```bash

package/dist/apiDecorator.d.ts

@@ -1,4 +1,6 @@
-import { RequestHeaders, RequestHeadersCapable, TimeoutCapable } from '@ahoo-wang/fetcher';
+import { Fetcher, RequestHeaders, RequestHeadersCapable, TimeoutCapable } from '@ahoo-wang/fetcher';
+import { ResultExtractorCapable } from './resultExtractor';
+import { FetcherCapable } from './fetcherCapable';
 /**
  * Metadata for class-level API configuration.
  *
@@ -6,7 +8,7 @@ import { RequestHeaders, RequestHeadersCapable, TimeoutCapable } from '@ahoo-wan
  * These settings will be used as defaults for all endpoints within the class unless overridden
  * at the method level.
  */
-export interface ApiMetadata extends TimeoutCapable, RequestHeadersCapable {
+export interface ApiMetadata extends TimeoutCapable, RequestHeadersCapable, ResultExtractorCapable, FetcherCapable {
     /**
      * Base path for all endpoints in the class.
      *
@@ -35,7 +37,7 @@ export interface ApiMetadata extends TimeoutCapable, RequestHeadersCapable {
      * This allows you to specify which fetcher instance should be used for requests
      * from this API class. The fetcher must be registered with the FetcherRegistrar.
      */
-    fetcher?: string;
+    fetcher?: string | Fetcher;
 }
 export declare const API_METADATA_KEY: unique symbol;
 export declare function api(basePath?: string, metadata?: Omit<ApiMetadata, 'basePath'>): <T extends new (...args: any[]) => any>(constructor: T) => T;

package/dist/apiDecorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"apiDecorator.d.ts","sourceRoot":"","sources":["../src/apiDecorator.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,cAAc,EACf,MAAM,oBAAoB,CAAC;AAI5B,OAAO,kBAAkB,CAAC;AAE1B;;;;;;GAMG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc,EAAE,qBAAqB;IACxE;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,gBAAgB,eAAyB,CAAC;AAwDvD,wBAAgB,GAAG,CACjB,QAAQ,GAAE,MAAW,EACrB,QAAQ,GAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAM,IAE3B,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,aAAa,CAAC,KAAG,CAAC,CAgB3E"}
+{"version":3,"file":"apiDecorator.d.ts","sourceRoot":"","sources":["../src/apiDecorator.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,OAAO,EACP,cAAc,EACd,qBAAqB,EACrB,cAAc,EACf,MAAM,oBAAoB,CAAC;AAI5B,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,cAAc;IAChH;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED,eAAO,MAAM,gBAAgB,eAAyB,CAAC;AAwDvD,wBAAgB,GAAG,CACjB,QAAQ,GAAE,MAAW,EACrB,QAAQ,GAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAM,IAE3B,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,aAAa,CAAC,KAAG,CAAC,CAgB3E"}

package/dist/endpointDecorator.d.ts

@@ -1,12 +1,13 @@
 import { HttpMethod } from '@ahoo-wang/fetcher';
 import { ApiMetadata } from './apiDecorator';
+import { ResultExtractorCapable } from './resultExtractor';
 /**
  * Metadata for HTTP endpoints.
  *
  * Defines the configuration options for individual HTTP endpoints (methods).
  * These settings will override any corresponding class-level settings from ApiMetadata.
  */
-export interface EndpointMetadata extends ApiMetadata {
+export interface EndpointMetadata extends ApiMetadata, ResultExtractorCapable {
     /**
      * HTTP method for the endpoint.
      *

package/dist/endpointDecorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"endpointDecorator.d.ts","sourceRoot":"","sources":["../src/endpointDecorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,kBAAkB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,qBAAqB,eAA8B,CAAC;AAEjE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,IAEpB,QAAQ,MAAM,EAAE,aAAa,MAAM,GAAG,MAAM,KAAG,IAAI,CAcrE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAhBjD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAkBrE;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YApBlD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAsBrE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAxBjD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CA0BrE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YA5BjD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CA8BrE;AAED,wBAAgB,KAAK,CACnB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,YAlCZ,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAqCrE;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAvClD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAyCrE;AAED,wBAAgB,OAAO,CACrB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,YA7CZ,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAgDrE"}
+{"version":3,"file":"endpointDecorator.d.ts","sourceRoot":"","sources":["../src/endpointDecorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAmB,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW,EAAE,sBAAsB;IAC3E;;;;OAIG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,eAAO,MAAM,qBAAqB,eAA8B,CAAC;AAEjE,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,UAAU,EAClB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,IAErB,QAAQ,MAAM,EAAE,aAAa,MAAM,GAAG,MAAM,KAAG,IAAI,CAcpE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAhBlD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAkBpE;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YApBnD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAsBpE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAxBlD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CA0BpE;AAED,wBAAgB,GAAG,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YA5BlD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CA8BpE;AAED,wBAAgB,KAAK,CACnB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,YAlCb,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAqCpE;AAED,wBAAgB,IAAI,CAAC,IAAI,GAAE,MAAW,EAAE,QAAQ,GAAE,sBAA2B,YAvCnD,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAyCpE;AAED,wBAAgB,OAAO,CACrB,IAAI,GAAE,MAAW,EACjB,QAAQ,GAAE,sBAA2B,YA7Cb,MAAM,eAAe,MAAM,GAAG,MAAM,KAAG,IAAI,CAgDpE"}

package/dist/fetcherCapable.d.ts

@@ -0,0 +1,21 @@
+import { Fetcher } from '@ahoo-wang/fetcher';
+/**
+ * Interface that defines a capability for objects that can have a fetcher.
+ * This interface is typically used to mark components or objects that can perform fetching operations
+ * and may need access to fetcher functionality.
+ */
+export interface FetcherCapable {
+    /**
+     * Optional fetcher property that can be either a string identifier or a Fetcher instance.
+     * When present, this property indicates the fetcher associated with the implementing object.
+     */
+    fetcher?: string | Fetcher;
+}
+/**
+ * Gets a Fetcher instance based on the provided fetcher parameter.
+ *
+ * @param fetcher - A string identifier or Fetcher instance to resolve
+ * @returns A Fetcher instance if found, undefined otherwise
+ */
+export declare function getFetcher(fetcher?: string | Fetcher): Fetcher | undefined;
+//# sourceMappingURL=fetcherCapable.d.ts.map

package/dist/fetcherCapable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherCapable.d.ts","sourceRoot":"","sources":["../src/fetcherCapable.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAoB,MAAM,oBAAoB,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAS1E"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './apiDecorator';
 export * from './endpointDecorator';
+export * from './fetcherCapable';
 export * from './parameterDecorator';
 export * from './reflection';
 export * from './requestExecutor';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC"}