@ahoo-wang/fetcher-wow 0.10.0 → 0.11.1

package/README.md

@@ -124,30 +124,18 @@ const commandResult: CommandResult = {
 
 #### CommandResultEventStream
 
-Utilities for working with command result event streams:
+Type alias for a readable stream of CommandResult events:
 
 ```typescript
-import {
-  toCommandResultEventStream,
-  CommandResultEvent,
-} from '@ahoo-wang/fetcher-wow';
-import { fetchEventStream } from '@ahoo-wang/fetcher-eventstream';
-
-// Convert ServerSentEventStream to CommandResultEventStream
-const eventStream = fetchEventStream('/commands/stream');
-const commandResultStream = toCommandResultEventStream(eventStream);
+import { CommandResult } from '@ahoo-wang/fetcher-wow';
+import { JsonServerSentEventStream } from '@ahoo-wang/fetcher-eventstream';
 
-// Process command results as they arrive
-const reader = commandResultStream.getReader();
-while (true) {
-  const { done, value } = await reader.read();
-  if (done) break;
-
-  const commandResult: CommandResult = value.data;
-  console.log('Command result:', commandResult);
-}
+// CommandResultEventStream is a JsonServerSentEventStream of CommandResult
+type CommandResultEventStream = JsonServerSentEventStream<CommandResult>;
 ```
 
+````
+
 ### Query Module
 
 #### Condition Builder
@@ -196,7 +184,7 @@ const dateConditions = [
   thisWeek('updatedAt'),
   lastMonth('createdDate'),
 ];
-```
+````
 
 #### Operators
 
@@ -372,7 +360,6 @@ import {
   CommandHeaders,
   CommandResult,
   CommandStage,
-  toCommandResultEventStream,
 } from '@ahoo-wang/fetcher-wow';
 import { fetchEventStream } from '@ahoo-wang/fetcher-eventstream';
 
@@ -408,7 +395,7 @@ async function executeCommand(request: CommandRequest): Promise<CommandResult> {
 // 3. Stream command results in real-time
 async function streamCommandResults() {
   const eventStream = fetchEventStream('/commands/stream');
-  const commandResultStream = toCommandResultEventStream(eventStream);
+  const commandResultStream = eventStream as CommandResultEventStream;
 
   const reader = commandResultStream.getReader();
   try {

package/README.zh-CN.md

@@ -123,29 +123,25 @@ const commandResult: CommandResult = {
 
 #### CommandResultEventStream
 
-用于处理命令结果事件流的工具：
+命令结果事件流的类型别名：
 
 ```typescript
-import {
-  toCommandResultEventStream,
-  CommandResultEvent,
-} from '@ahoo-wang/fetcher-wow';
-import { fetchEventStream } from '@ahoo-wang/fetcher-eventstream';
+import { CommandResult } from '@ahoo-wang/fetcher-wow';
+import { JsonServerSentEventStream } from '@ahoo-wang/fetcher-eventstream';
 
-// 将 ServerSentEventStream 转换为 CommandResultEventStream
-const eventStream = fetchEventStream('/commands/stream');
-const commandResultStream = toCommandResultEventStream(eventStream);
+// CommandResultEventStream 是 CommandResult 的 JsonServerSentEventStream
+type CommandResultEventStream = JsonServerSentEventStream<CommandResult>;
+```
 
-// 处理实时到达的命令结果
-const reader = commandResultStream.getReader();
 while (true) {
-  const { done, value } = await reader.read();
-  if (done) break;
+const { done, value } = await reader.read();
+if (done) break;
 
-  const commandResult: CommandResult = value.data;
-  console.log('命令结果:', commandResult);
+const commandResult: CommandResult = value.data;
+console.log('命令结果:', commandResult);
 }
-```
+
+````
 
 ### 查询模块
 
@@ -195,7 +191,7 @@ const dateConditions = [
   thisWeek('updatedAt'),
   lastMonth('createdDate'),
 ];
-```
+````
 
 #### 操作符
 
@@ -371,7 +367,6 @@ import {
   CommandHeaders,
   CommandResult,
   CommandStage,
-  toCommandResultEventStream,
 } from '@ahoo-wang/fetcher-wow';
 import { fetchEventStream } from '@ahoo-wang/fetcher-eventstream';
 
@@ -407,7 +402,7 @@ async function executeCommand(request: CommandRequest): Promise<CommandResult> {
 // 3. 实时流式处理命令结果
 async function streamCommandResults() {
   const eventStream = fetchEventStream('/commands/stream');
-  const commandResultStream = toCommandResultEventStream(eventStream);
+  const commandResultStream = eventStream as CommandResultEventStream;
 
   const reader = commandResultStream.getReader();
   try {

package/dist/command/commandRequest.d.ts

@@ -1,15 +1,58 @@
 import { NullableAggregateVersionCapable } from './types';
 import { HttpMethod, RequestHeaders } from '@ahoo-wang/fetcher';
+/**
+ * Command request interface
+ *
+ * Represents a command request with all necessary metadata for execution.
+ * This interface extends NullableAggregateVersionCapable to include optional aggregate version information.
+ *
+ * @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
+ * };
+ * ```
+ */
 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. Milliseconds
+     * 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

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,MAAM,WAAW,cAAe,SAAQ,+BAA+B;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,cAAc,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
+{"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"}

package/dist/command/commandResult.d.ts

@@ -1,12 +1,39 @@
 import { AggregateId, AggregateNameCapable, ErrorInfo, FunctionInfoCapable, Identifier, NamedBoundedContext } from '../types';
 import { CommandId, CommandResultCapable, CommandStageCapable, NullableAggregateVersionCapable, RequestId, SignalTimeCapable, WaitCommandIdCapable } from './types';
+import { JsonServerSentEvent } from '@ahoo-wang/fetcher-eventstream';
+/**
+ * Command execution result interface
+ *
+ * Represents the result of a command execution, containing information about:
+ * - Command identification (commandId, requestId)
+ * - Execution context (bounded context, aggregate information)
+ * - Execution status and errors
+ * - Timing information (signalTime)
+ * - Version tracking (aggregateVersion)
+ */
 export interface CommandResult extends Identifier, WaitCommandIdCapable, CommandStageCapable, NamedBoundedContext, AggregateNameCapable, AggregateId, ErrorInfo, CommandId, RequestId, ErrorInfo, FunctionInfoCapable, CommandResultCapable, SignalTimeCapable, NullableAggregateVersionCapable {
     /**
-     * 聚合根版本号
-     * - 命令处理成功时,为聚合根完成命令处理后的版本号
-     * - 当命令在命令网关验证失败时，为 null
-     * - 当命令在命令处理器中执行失败时，为聚合根的当前版本号
+     * Aggregate root version number
+     * - When command processing succeeds, this is the version number after the aggregate root has completed command processing
+     * - When command validation fails at the command gateway, this is null
+     * - When command execution fails in the command handler, this is the current version number of the aggregate root
      */
     aggregateVersion?: number;
 }
+/**
+ * Command result event stream type
+ *
+ * A readable stream of JSON Server-Sent Events containing command execution results.
+ * This stream allows real-time consumption of command results as they are processed.
+ *
+ * @example
+ * ```typescript
+ * const eventStream: CommandResultEventStream = getCommandResultStream();
+ * for await (const event of eventStream) {
+ *   const commandResult: CommandResult = event.data;
+ *   console.log('Command result received:', commandResult);
+ * }
+ * ```
+ */
+export type CommandResultEventStream = ReadableStream<JsonServerSentEvent<CommandResult>>;
 //# sourceMappingURL=commandResult.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"commandResult.d.ts","sourceRoot":"","sources":["../../src/command/commandResult.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACpB,SAAS,EACT,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,mBAAmB,EACnB,+BAA+B,EAC/B,SAAS,EACT,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,SAAS,CAAC;AAEjB,MAAM,WAAW,aACf,SAAQ,UAAU,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,mBAAmB,EAChF,oBAAoB,EACpB,WAAW,EACX,SAAS,EACT,SAAS,EACT,SAAS,EAAE,SAAS,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,+BAA+B;IACrH;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAE3B"}
+{"version":3,"file":"commandResult.d.ts","sourceRoot":"","sources":["../../src/command/commandResult.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACpB,SAAS,EACT,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,mBAAmB,EACnB,+BAA+B,EAC/B,SAAS,EACT,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAErE;;;;;;;;;GASG;AACH,MAAM,WAAW,aACf,SAAQ,UAAU,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,+BAA+B;IACjC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,wBAAwB,GAAG,cAAc,CACnD,mBAAmB,CAAC,aAAa,CAAC,CACnC,CAAC"}

package/dist/command/index.d.ts

@@ -1,6 +1,5 @@
 export * from './commandHeaders';
 export * from './commandRequest';
 export * from './commandResult';
-export * from './commandResultEventStream';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

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,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/command/index.ts"],"names":[],"mappings":"AAaA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}

package/dist/command/types.d.ts

@@ -1,47 +1,87 @@
+/**
+ * Command identifier interface
+ *
+ * Represents the unique identifier for a command.
+ */
 export interface CommandId {
     commandId: string;
 }
+/**
+ * Wait command identifier capable interface
+ *
+ * Represents the identifier of the command being waited for.
+ */
 export interface WaitCommandIdCapable {
     waitCommandId: string;
 }
+/**
+ * Request identifier interface
+ *
+ * Represents the unique identifier for a request, used for idempotency control.
+ */
 export interface RequestId {
     requestId: string;
 }
+/**
+ * Command execution stage enum
+ *
+ * Represents the different stages of command execution lifecycle.
+ */
 export declare enum CommandStage {
     /**
-     * 当命令发布到命令总线/队列后，生成完成信号.
+     * When the command is published to the command bus/queue, a completion signal is generated.
      */
     SENT = "SENT",
     /**
-     * 当命令被聚合根处理完成后，生成完成信号.
+     * When the command is processed by the aggregate root, a completion signal is generated.
      */
     PROCESSED = "PROCESSED",
     /**
-     * 当快照被生成后，生成完成信号.
+     * When the snapshot is generated, a completion signal is generated.
      */
     SNAPSHOT = "SNAPSHOT",
     /**
-     * 当命令产生的事件*投影*完成后，生成完成信号.
+     * When the events generated by the command are *projected*, a completion signal is generated.
      */
     PROJECTED = "PROJECTED",
     /**
-     * 当命令产生的事件被*事件处理器*处理完成后，生成完成信号.
+     * When the events generated by the command are processed by *event handlers*, a completion signal is generated.
      */
     EVENT_HANDLED = "EVENT_HANDLED",
     /**
-     * 当命令产生的事件被*Saga*处理完成后，生成完成信号.
+     * When the events generated by the command are processed by *Saga*, a completion signal is generated.
      */
     SAGA_HANDLED = "SAGA_HANDLED"
 }
+/**
+ * Command stage capable interface
+ *
+ * Represents an object that has a command execution stage.
+ */
 export interface CommandStageCapable {
     stage: CommandStage;
 }
+/**
+ * Command result capable interface
+ *
+ * Represents an object that contains command execution results.
+ */
 export interface CommandResultCapable {
     result: Record<string, any>;
 }
+/**
+ * Signal time capable interface
+ *
+ * Represents an object that has a signal time (timestamp).
+ */
 export interface SignalTimeCapable {
     signalTime: number;
 }
+/**
+ * Nullable aggregate version capable interface
+ *
+ * Represents an object that may have an aggregate version for optimistic concurrency control.
+ */
 export interface NullableAggregateVersionCapable {
     /**
      * The aggregate version of the aggregate.

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/command/types.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,YAAY;IACtB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,aAAa,kBAAkB;IAE/B;;OAEG;IACH,YAAY,iBAAiB;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/command/types.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,IAAI,SAAS;IAEb;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,aAAa,kBAAkB;IAE/B;;OAEG;IACH,YAAY,iBAAiB;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}