@ahoo-wang/fetcher-wow 1.1.0 → 1.2.1

package/dist/command/commandClient.d.ts

@@ -0,0 +1,146 @@
+import { CommandResult, CommandResultEventStream } from './commandResult';
+import { ResultExtractor } from '@ahoo-wang/fetcher-decorator';
+import { CommandRequest } from './commandRequest';
+import { ClientOptions } from '../types';
+/**
+ * HTTP client for sending commands to a remote service.
+ * Provides methods for sending commands and handling command results,
+ * including support for streaming responses.
+ *
+ * @example
+ * ```typescript
+ * // Create a fetcher instance
+ * const wowFetcher = new Fetcher({
+ *   baseURL: 'http://localhost:8080/',
+ * });
+ *
+ * // Add interceptor to handle URL parameters if needed
+ * wowFetcher.interceptors.request.use({
+ *   name: 'UrlParamsInterceptor',
+ *   order: URL_RESOLVE_INTERCEPTOR_ORDER - 1,
+ *   intercept(exchange) {
+ *     exchange.request.urlParams = {
+ *       path: {
+ *         ...exchange.request.urlParams?.path,
+ *       },
+ *       query: exchange.request.urlParams?.query,
+ *     };
+ *   },
+ * });
+ *
+ * // Create CommandClient instance
+ * const CommandClient = new CommandClient({
+ *   fetcher: wowFetcher,
+ *   basePath: 'owner/{ownerId}/cart'
+ * });
+ *
+ * // Send a command
+ * const command = {
+ *   method: HttpMethod.POST,
+ *   headers: {
+ *     [CommandHeaders.WAIT_STAGE]: CommandStage.SNAPSHOT,
+ *   },
+ *   urlParams: {
+ *     path: {
+ *       ownerId: 'ownerId',
+ *     },
+ *   },
+ *   body: {
+ *     productId: 'productId',
+ *     quantity: 1,
+ *   },
+ * };
+ *
+ * const result = await CommandClient.send('add_cart_item', command);
+ * ```
+ */
+export declare class CommandClient {
+    protected readonly options: ClientOptions;
+    /**
+     * Creates a new CommandClient instance.
+     * @param options - The client configuration options including the fetcher and base path
+     *
+     * @example
+     * ```typescript
+     * const CommandClient = new CommandClient({
+     *   fetcher: wowFetcher,
+     *   basePath: 'owner/{ownerId}/cart'
+     * });
+     * ```
+     */
+    constructor(options: ClientOptions);
+    /**
+     * Sends a command to the specified path and returns the result.
+     * This is a protected generic method that handles the common logic for sending commands.
+     * @template R The type of the result to be returned
+     * @param path - The endpoint path to send the command to
+     * @param commandHttpRequest - The command HTTP request containing headers, method, and body
+     * @param extractor - Function to extract the result from the response, defaults to JSON extractor
+     * @returns A promise that resolves to the extracted result of type R
+     */
+    protected sendCommand<R>(path: string, commandHttpRequest: CommandRequest, extractor?: ResultExtractor): Promise<R>;
+    /**
+     * Sends a command to the specified path and waits for a response.
+     *
+     * @param path - The endpoint path to send the command to
+     * @param commandHttpRequest - The command HTTP request containing headers, method, and body
+     * @returns A promise that resolves to a CommandResult
+     *
+     * @example
+     * ```typescript
+     * const command = {
+     *   method: HttpMethod.POST,
+     *   headers: {
+     *     [CommandHeaders.WAIT_STAGE]: CommandStage.SNAPSHOT,
+     *   },
+     *   urlParams: {
+     *     path: {
+     *       ownerId: 'ownerId',
+     *     },
+     *   },
+     *   body: {
+     *     productId: 'productId',
+     *     quantity: 1,
+     *   },
+     * };
+     *
+     * const result = await CommandClient.send('add_cart_item', command);
+     * console.log('Command result:', result);
+     * ```
+     */
+    send(path: string, commandHttpRequest: CommandRequest): Promise<CommandResult>;
+    /**
+     * Sends a command to the specified path and waits for a streaming response.
+     * Sets the Accept header to text/event-stream to indicate that the response should be streamed.
+     *
+     * @param path - The endpoint path to send the command to
+     * @param commandHttpRequest - The command HTTP request containing headers, method, and body
+     * @returns A promise that resolves to a CommandResultEventStream for handling streaming responses
+     *
+     * @example
+     * ```typescript
+     * const command = {
+     *   method: HttpMethod.POST,
+     *   headers: {
+     *     [CommandHeaders.WAIT_STAGE]: CommandStage.SNAPSHOT,
+     *   },
+     *   urlParams: {
+     *     path: {
+     *       ownerId: 'ownerId',
+     *     },
+     *   },
+     *   body: {
+     *     productId: 'productId',
+     *     quantity: 1,
+     *   },
+     * };
+     *
+     * const commandResultStream = await CommandClient.sendAndWaitStream('add_cart_item', command);
+     * for await (const commandResultEvent of commandResultStream) {
+     *   console.log('Received:', commandResultEvent.data);
+     * }
+     * ```
+     */
+    sendAndWaitStream(path: string, commandHttpRequest: CommandRequest): Promise<CommandResultEventStream>;
+}
+//# sourceMappingURL=commandClient.d.ts.map

package/dist/command/commandClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandClient.d.ts","sourceRoot":"","sources":["../../src/command/commandClient.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EACL,eAAe,EAEhB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,qBAAa,aAAa;IAaZ,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa;IAZrD;;;;;;;;;;;OAWG;gBAC4B,OAAO,EAAE,aAAa;IAGrD;;;;;;;;OAQG;cACa,WAAW,CAAC,CAAC,EAC3B,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,cAAc,EAClC,SAAS,GAAE,eAAuC,GACjD,OAAO,CAAC,CAAC,CAAC;IAUb;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,cAAc,GACjC,OAAO,CAAC,aAAa,CAAC;IAIzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,iBAAiB,CACrB,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,cAAc,GACjC,OAAO,CAAC,wBAAwB,CAAC;CAWrC"}

package/dist/command/{commandHeaders.d.ts → commandHttpHeaders.d.ts}

@@ -8,17 +8,16 @@
  * ```typescript
  * // Using header constants in a request
  * const request = {
- *   method: 'POST',
  *   headers: {
- *     [CommandHeaders.TENANT_ID]: 'tenant-123',
- *     [CommandHeaders.AGGREGATE_ID]: 'aggregate-456',
- *     [CommandHeaders.REQUEST_ID]: 'request-789'
+ *     [CommandHttpHeaders.TENANT_ID]: 'tenant-123',
+ *     [CommandHttpHeaders.AGGREGATE_ID]: 'aggregate-456',
+ *     [CommandHttpHeaders.REQUEST_ID]: 'request-789'
  *   },
- *   body: JSON.stringify(command)
+ *   body: command
  * };
  * ```
  */
-export declare class CommandHeaders {
+export declare class CommandHttpHeaders {
     /**
      * Prefix for all command-related headers
      */
@@ -127,4 +126,4 @@ export declare class CommandHeaders {
      */
     static readonly COMMAND_HEADER_X_PREFIX: string;
 }
-//# sourceMappingURL=commandHeaders.d.ts.map
+//# sourceMappingURL=commandHttpHeaders.d.ts.map

package/dist/command/commandHttpHeaders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandHttpHeaders.d.ts","sourceRoot":"","sources":["../../src/command/commandHttpHeaders.ts"],"names":[],"mappings":"AAaA;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,cAAc;IAEpD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,SAA2D;IAEpF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAQ,SAA0D;IAElF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,SAA8D;IAE1F;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAmE;IAEpG;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,SAAuD;IAElF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA8C;IAG3E;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,SAA4C;IAEtE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,SAA8C;IAE1E;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,SAAgD;IAE9E;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,SAA+C;IAI5E;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,SAA4C;IAE5E;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,eAAe,SAAiD;IAEhF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,SAAmD;IAEpF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,mBAAmB,SAAqD;IAExF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,SAAoD;IAGtF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,SAA4D;IAEtF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,SAA6D;IAExF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,yBAAyB,SAAmE;IAE5G;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,sBAAsB,SAAgE;IAEtG;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,SAAsD;IAElF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,uBAAuB,SAAyD;CACjG"}

package/dist/command/commandRequest.d.ts

@@ -1,74 +1,38 @@
-import { NullableAggregateVersionCapable } from './types';
-import { HttpMethod, RequestHeaders } from '@ahoo-wang/fetcher';
+import { FetchRequestInit, RequestHeaders, UrlParams } from '@ahoo-wang/fetcher';
+import { PathParams } from '../types/endpoints';
 /**
- * Command request interface
+ * Command Request Headers Interface
  *
- * Represents a command request with all necessary metadata for execution.
- * This interface extends NullableAggregateVersionCapable to include optional aggregate version information.
+ * Defines the HTTP header fields used in command processing within the Wow framework.
+ * This interface extends RequestHeaders to provide type-safe access to all command-related headers.
  *
  * @example
  * ```typescript
- * const commandRequest: CommandRequest = {
- *   path: '/commands/user/CreateUser',
- *   method: HttpMethod.POST,
- *   headers: {
- *     [CommandHeaders.TENANT_ID]: 'tenant-123',
- *     [CommandHeaders.REQUEST_ID]: 'req-' + Date.now()
- *   },
- *   body: {
- *     name: 'John Doe',
- *     email: 'john@example.com'
- *   },
- *   timeout: 10000,
- *   localFirst: true,
- *   stream: false
+ * // Using CommandRequestHeaders in a request
+ * const headers: CommandRequestHeaders = {
+ *   [CommandHeaders.TENANT_ID]: 'tenant-123',
+ *   [CommandHeaders.AGGREGATE_ID]: 'aggregate-456',
+ *   [CommandHeaders.REQUEST_ID]: 'request-789'
  * };
  * ```
  */
-export interface CommandRequest extends NullableAggregateVersionCapable {
-    /**
-     * The path for the command request
-     */
-    path: string;
-    /**
-     * Path parameters for the command request
-     */
-    pathParams?: Record<string, any>;
-    /**
-     * HTTP method for the command request
-     */
-    method: HttpMethod;
-    /**
-     * HTTP headers for the command request
-     */
-    headers: RequestHeaders;
-    /**
-     * Request body containing the command data
-     */
-    body: Record<string, any>;
-    /**
-     * Command timeout period in milliseconds
-     */
-    timeout?: number;
-    /**
-     * Aggregate ID for the command
-     */
-    aggregateId?: string;
-    /**
-     * The version of the target aggregate, which is used to control version conflicts
-     */
-    aggregateVersion?: number;
-    /**
-     * The request ID of the command message, which is used to check the idempotency of the command message
-     */
-    requestId?: string;
-    /**
-     * Whether to enable local priority mode, if false, it will be turned off, and the default is true.
-     */
-    localFirst?: boolean;
+export interface CommandRequestHeaders extends RequestHeaders {
+}
+export interface CommandUrlParams extends Omit<UrlParams, 'path' | 'query'> {
+    path?: PathParams;
+}
+/**
+ * Command HTTP Request Interface
+ *
+ * Extends RequestHeaders to provide type-safe access to command-related HTTP headers.
+ * This interface includes only the essential command headers commonly used in HTTP requests.
+ */
+export interface CommandRequest<C extends object = object> extends FetchRequestInit {
+    urlParams?: CommandUrlParams;
+    headers?: CommandRequestHeaders;
     /**
-     * Whether to enable event stream mode, if true, it will be turned on, and the default is false.
+     * The body of the command request.
      */
-    stream?: boolean;
+    body: C;
 }
 //# sourceMappingURL=commandRequest.d.ts.map

package/dist/command/commandRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commandRequest.d.ts","sourceRoot":"","sources":["../../src/command/commandRequest.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,cAAe,SAAQ,+BAA+B;IACrE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"commandRequest.d.ts","sourceRoot":"","sources":["../../src/command/commandRequest.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,SAAS,EACV,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;CA4G5D;AAED,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IACzE,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IACjF,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;CACT"}

package/dist/command/index.d.ts

@@ -1,6 +1,5 @@
-export * from './commandHeaders';
-export * from './commandHttpClient';
-export * from './commandHttpRequest';
+export * from './commandClient';
+export * from './commandHttpHeaders';
 export * from './commandRequest';
 export * from './commandResult';
 export * from './types';

package/dist/command/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/command/index.ts"],"names":[],"mappings":"AAaA,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/command/index.ts"],"names":[],"mappings":"AAaA,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}