@ahoo-wang/wow-client 9.2.0-rc.0

package/dist/model/function.d.ts

@@ -0,0 +1,41 @@
+import { Named, NamedBoundedContext } from './naming.js';
+/**
+ * Function kind enum
+ *
+ * Represents the different types of functions in the system.
+ */
+export declare enum FunctionKind {
+    /**
+     * Command function kind
+     */
+    COMMAND = "COMMAND",
+    /**
+     * Error function kind
+     */
+    ERROR = "ERROR",
+    /**
+     * Event function kind
+     */
+    EVENT = "EVENT",
+    /**
+     * Sourcing function kind
+     */
+    SOURCING = "SOURCING",
+    /**
+     * State event function kind
+     */
+    STATE_EVENT = "STATE_EVENT"
+}
+/**
+ * Interface for function information.
+ */
+export interface FunctionInfo extends NamedBoundedContext, Named {
+    functionKind: FunctionKind;
+    processorName: string;
+}
+/**
+ * Interface for objects that have function information.
+ */
+export interface FunctionInfoCapable {
+    function: FunctionInfo;
+}

package/dist/model/function.es.js

@@ -0,0 +1,8 @@
+//#region src/model/function.ts
+var e = /* @__PURE__ */ function(e) {
+	return e.COMMAND = "COMMAND", e.ERROR = "ERROR", e.EVENT = "EVENT", e.SOURCING = "SOURCING", e.STATE_EVENT = "STATE_EVENT", e;
+}({});
+//#endregion
+export { e as FunctionKind };
+
+//# sourceMappingURL=function.es.js.map

package/dist/model/function.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function.es.js","names":["FunctionKind","\"COMMAND\"","\"ERROR\"","\"EVENT\"","\"SOURCING\"","\"STATE_EVENT\""],"sources":["../../src/model/function.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Named, NamedBoundedContext } from './naming.js';\n\n/**\n * Function kind enum\n *\n * Represents the different types of functions in the system.\n */\nexport enum FunctionKind {\n  /**\n   * Command function kind\n   */\n  COMMAND = 'COMMAND',\n\n  /**\n   * Error function kind\n   */\n  ERROR = 'ERROR',\n\n  /**\n   * Event function kind\n   */\n  EVENT = 'EVENT',\n\n  /**\n   * Sourcing function kind\n   */\n  SOURCING = 'SOURCING',\n\n  /**\n   * State event function kind\n   */\n  STATE_EVENT = 'STATE_EVENT',\n}\n\n/**\n * Interface for function information.\n */\nexport interface FunctionInfo extends NamedBoundedContext, Named {\n  functionKind: FunctionKind;\n  processorName: string;\n}\n\n/**\n * Interface for objects that have function information.\n */\nexport interface FunctionInfoCapable {\n  function: FunctionInfo;\n}\n"],"mappings":";AAoBA,IAAYA,IAAL,yBAAA,GAAA;QAIL,EAAAC,UAAA,WAKA,EAAAC,QAAA,SAKA,EAAAC,QAAA,SAKA,EAAAC,WAAA,YAKA,EAAAC,cAAA;AACF,EAAA,CAAA,CAAA"}

package/dist/model/index.d.cts

@@ -0,0 +1,22 @@
+/**
+ * The Wow domain model as it crosses the wire: the mixin interfaces of
+ * Kotlin's `wow-api` (`*Capable`, `TenantId`, `AggregateId`, …) and the
+ * command results a client receives.
+ *
+ * The names follow `wow-api` one for one, and wow-generator maps the server's
+ * schemas to them by name, so they keep Kotlin's two conventions: a name like
+ * `TenantId`, `OwnerId`, `CommandId` or `RequestId` is an object holding that
+ * field (`{ tenantId: string }`), not the value itself, and an object holding
+ * a composite is `XxxCapable` (`AggregateIdCapable` holds an `AggregateId`).
+ *
+ * Types only, apart from the wire enums: nothing here imports a client, the
+ * transport or a fetcher package.
+ */
+export * from './abac.cjs';
+export * from './bi.cjs';
+export * from './command.cjs';
+export * from './common.cjs';
+export * from './function.cjs';
+export * from './messaging.cjs';
+export * from './modeling.cjs';
+export * from './naming.cjs';

package/dist/model/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The Wow domain model as it crosses the wire: the mixin interfaces of
+ * Kotlin's `wow-api` (`*Capable`, `TenantId`, `AggregateId`, …) and the
+ * command results a client receives.
+ *
+ * The names follow `wow-api` one for one, and wow-generator maps the server's
+ * schemas to them by name, so they keep Kotlin's two conventions: a name like
+ * `TenantId`, `OwnerId`, `CommandId` or `RequestId` is an object holding that
+ * field (`{ tenantId: string }`), not the value itself, and an object holding
+ * a composite is `XxxCapable` (`AggregateIdCapable` holds an `AggregateId`).
+ *
+ * Types only, apart from the wire enums: nothing here imports a client, the
+ * transport or a fetcher package.
+ */
+export * from './abac.js';
+export * from './bi.js';
+export * from './command.js';
+export * from './common.js';
+export * from './function.js';
+export * from './messaging.js';
+export * from './modeling.js';
+export * from './naming.js';

package/dist/model/messaging.d.cts

@@ -0,0 +1,5 @@
+/** A message with a body, such as a domain event or a command message. */
+export interface BodyCapable<T> {
+    /** The body. */
+    body: T;
+}

package/dist/model/messaging.d.ts

@@ -0,0 +1,5 @@
+/** A message with a body, such as a domain event or a command message. */
+export interface BodyCapable<T> {
+    /** The body. */
+    body: T;
+}

package/dist/model/modeling.d.cts

@@ -0,0 +1,145 @@
+import { AliasBoundedContext, NamedBoundedContext } from './naming.cjs';
+/**
+ * Interface for classes that have a creation time.
+ */
+export interface CreateTimeCapable {
+    /**
+     * Gets the creation time in milliseconds since the Unix epoch.
+     */
+    createTime: number;
+}
+/**
+ * Interface for objects that track deletion status.
+ */
+export interface DeletedCapable {
+    /**
+     * Whether the aggregate is deleted.
+     */
+    deleted: boolean;
+}
+/**
+ * Interface for objects that track event IDs.
+ */
+export interface EventIdCapable {
+    /**
+     * The event id of the aggregate.
+     */
+    eventId: string;
+}
+/**
+ * Interface for objects that track event times.
+ */
+export interface EventTimeCapable {
+    /**
+     * The last event time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    eventTime: number;
+}
+/**
+ * Interface for objects that track the first event time.
+ */
+export interface FirstEventTimeCapable {
+    /**
+     * The first event time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    firstEventTime: number;
+}
+/**
+ * Interface for objects that track the first operator.
+ */
+export interface FirstOperatorCapable {
+    /**
+     * The first operator of the aggregate.
+     */
+    firstOperator: string;
+}
+/**
+ * Interface for objects that have an aggregate name.
+ */
+export interface AggregateNameCapable {
+    /**
+     * The name of the aggregate.
+     */
+    aggregateName: string;
+}
+/**
+ * Interface for named aggregates that belong to a bounded context.
+ */
+export interface NamedAggregate extends NamedBoundedContext, AggregateNameCapable {
+}
+/**
+ * An aggregate named by its bounded context's alias rather than its context
+ * name, as in a client's route (`QueryClientFactory`'s `contextAlias` and
+ * `aggregateName`).
+ */
+export interface AliasAggregate extends AliasBoundedContext, AggregateNameCapable {
+}
+/**
+ * Interface for aggregate IDs that combine tenant and named aggregate information.
+ */
+export interface AggregateId extends TenantId, NamedAggregate {
+    aggregateId: string;
+}
+/**
+ * Interface that provides the capability to contain an aggregate identifier.
+ *
+ * This interface is implemented by objects that need to reference an aggregate instance
+ * through its unique identifier, which includes tenant, context, aggregate name and the
+ * actual aggregate ID.
+ */
+export interface AggregateIdCapable {
+    /**
+     * The unique identifier of the aggregate instance.
+     *
+     * Contains information about the tenant, bounded context, aggregate name and the
+     * actual aggregate ID string.
+     */
+    aggregateId: AggregateId;
+}
+/**
+ * Interface for objects that track the last operator.
+ */
+export interface OperatorCapable {
+    /**
+     * The last operator of the aggregate.
+     */
+    operator: string;
+}
+/**
+ * Interface for identifying resource owners.
+ */
+export interface OwnerId {
+    /**
+     * Unique identifier of the resource owner.
+     */
+    ownerId: string;
+}
+/**
+ * Something that lives in a space: a partition of data under a tenant, which
+ * commands and queries select with the `Wow-Space-Id` header.
+ */
+export interface SpaceIdCapable {
+    /** The space; an empty string is the tenant's default space. */
+    spaceId: string;
+}
+/**
+ * Interface for objects that track snapshot times.
+ */
+export interface SnapshotTimeCapable {
+    /**
+     * The snapshot time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    snapshotTime: number;
+}
+/**
+ * Interface for objects that have a tenant ID.
+ */
+export interface TenantId {
+    tenantId: string;
+}
+/**
+ * Interface for objects that hold state.
+ */
+export interface StateCapable<S> {
+    state: S;
+}

package/dist/model/modeling.d.ts

@@ -0,0 +1,145 @@
+import { AliasBoundedContext, NamedBoundedContext } from './naming.js';
+/**
+ * Interface for classes that have a creation time.
+ */
+export interface CreateTimeCapable {
+    /**
+     * Gets the creation time in milliseconds since the Unix epoch.
+     */
+    createTime: number;
+}
+/**
+ * Interface for objects that track deletion status.
+ */
+export interface DeletedCapable {
+    /**
+     * Whether the aggregate is deleted.
+     */
+    deleted: boolean;
+}
+/**
+ * Interface for objects that track event IDs.
+ */
+export interface EventIdCapable {
+    /**
+     * The event id of the aggregate.
+     */
+    eventId: string;
+}
+/**
+ * Interface for objects that track event times.
+ */
+export interface EventTimeCapable {
+    /**
+     * The last event time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    eventTime: number;
+}
+/**
+ * Interface for objects that track the first event time.
+ */
+export interface FirstEventTimeCapable {
+    /**
+     * The first event time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    firstEventTime: number;
+}
+/**
+ * Interface for objects that track the first operator.
+ */
+export interface FirstOperatorCapable {
+    /**
+     * The first operator of the aggregate.
+     */
+    firstOperator: string;
+}
+/**
+ * Interface for objects that have an aggregate name.
+ */
+export interface AggregateNameCapable {
+    /**
+     * The name of the aggregate.
+     */
+    aggregateName: string;
+}
+/**
+ * Interface for named aggregates that belong to a bounded context.
+ */
+export interface NamedAggregate extends NamedBoundedContext, AggregateNameCapable {
+}
+/**
+ * An aggregate named by its bounded context's alias rather than its context
+ * name, as in a client's route (`QueryClientFactory`'s `contextAlias` and
+ * `aggregateName`).
+ */
+export interface AliasAggregate extends AliasBoundedContext, AggregateNameCapable {
+}
+/**
+ * Interface for aggregate IDs that combine tenant and named aggregate information.
+ */
+export interface AggregateId extends TenantId, NamedAggregate {
+    aggregateId: string;
+}
+/**
+ * Interface that provides the capability to contain an aggregate identifier.
+ *
+ * This interface is implemented by objects that need to reference an aggregate instance
+ * through its unique identifier, which includes tenant, context, aggregate name and the
+ * actual aggregate ID.
+ */
+export interface AggregateIdCapable {
+    /**
+     * The unique identifier of the aggregate instance.
+     *
+     * Contains information about the tenant, bounded context, aggregate name and the
+     * actual aggregate ID string.
+     */
+    aggregateId: AggregateId;
+}
+/**
+ * Interface for objects that track the last operator.
+ */
+export interface OperatorCapable {
+    /**
+     * The last operator of the aggregate.
+     */
+    operator: string;
+}
+/**
+ * Interface for identifying resource owners.
+ */
+export interface OwnerId {
+    /**
+     * Unique identifier of the resource owner.
+     */
+    ownerId: string;
+}
+/**
+ * Something that lives in a space: a partition of data under a tenant, which
+ * commands and queries select with the `Wow-Space-Id` header.
+ */
+export interface SpaceIdCapable {
+    /** The space; an empty string is the tenant's default space. */
+    spaceId: string;
+}
+/**
+ * Interface for objects that track snapshot times.
+ */
+export interface SnapshotTimeCapable {
+    /**
+     * The snapshot time of the aggregate, represented as a Unix timestamp in milliseconds.
+     */
+    snapshotTime: number;
+}
+/**
+ * Interface for objects that have a tenant ID.
+ */
+export interface TenantId {
+    tenantId: string;
+}
+/**
+ * Interface for objects that hold state.
+ */
+export interface StateCapable<S> {
+    state: S;
+}

package/dist/model/naming.d.cts

@@ -0,0 +1,27 @@
+/**
+ * Interface for named bounded contexts.
+ */
+export interface NamedBoundedContext {
+    contextName: string;
+}
+/** A bounded context named by its alias; see `BoundedContext.alias`. */
+export interface AliasBoundedContext {
+    /** The alias of the bounded context. */
+    contextAlias: string;
+}
+/**
+ * Interface for named entities.
+ */
+export interface Named {
+    name: string;
+}
+/**
+ * Interface for entities that have a description.
+ *
+ * This interface defines a contract for objects that can provide a descriptive text.
+ * It is commonly used in conjunction with other naming interfaces to provide additional
+ * context or information about an entity.
+ */
+export interface DescriptionCapable {
+    description: string;
+}

package/dist/model/naming.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Interface for named bounded contexts.
+ */
+export interface NamedBoundedContext {
+    contextName: string;
+}
+/** A bounded context named by its alias; see `BoundedContext.alias`. */
+export interface AliasBoundedContext {
+    /** The alias of the bounded context. */
+    contextAlias: string;
+}
+/**
+ * Interface for named entities.
+ */
+export interface Named {
+    name: string;
+}
+/**
+ * Interface for entities that have a description.
+ *
+ * This interface defines a contract for objects that can provide a descriptive text.
+ * It is commonly used in conjunction with other naming interfaces to provide additional
+ * context or information about an entity.
+ */
+export interface DescriptionCapable {
+    description: string;
+}

package/dist/transport/endpoints.cjs

@@ -0,0 +1,2 @@
+const e=require("./eventStreams.cjs");let t=require("@ahoo-wang/fetcher");var n=Object.freeze({headers:Object.freeze({Accept:t.ContentTypeValues.TEXT_EVENT_STREAM}),resultExtractor:e.CommandResultEventStreamResultExtractor}),r=Object.freeze({headers:Object.freeze({Accept:t.ContentTypeValues.TEXT_EVENT_STREAM}),resultExtractor:e.QueryEventStreamResultExtractor});exports.COMMAND_STREAM_ENDPOINT=n,exports.QUERY_STREAM_ENDPOINT=r;
+//# sourceMappingURL=endpoints.cjs.map

package/dist/transport/endpoints.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.cjs","names":["ContentTypeValues","CommandResultEventStreamResultExtractor","QueryEventStreamResultExtractor","require_eventStreams","_ahoo_wang_fetcher","COMMAND_STREAM_ENDPOINT","QUERY_STREAM_ENDPOINT"],"sources":["../../src/transport/endpoints.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ContentTypeValues, type ResultExtractor } from '@ahoo-wang/fetcher';\nimport type { CommandResult } from '../model/command.js';\nimport {\n  CommandResultEventStreamResultExtractor,\n  QueryEventStreamResultExtractor,\n} from './eventStreams.js';\n\n/**\n * The endpoint options of a command whose answer is a server-sent event\n * stream: `Accept: text/event-stream`, and a result extractor that answers\n * the command results, one per stage the command reached, and errors the\n * stream with a {@link WowError} at the server's error event.\n * `CommandClient.sendAndWaitStream` uses it.\n *\n * A decorated command client that streams, hand-written or generated, takes\n * it whole instead of spelling out the header and the extractor, so the\n * transport is defined in one place. It fits both `@api` and the endpoint\n * decorators. It is frozen; spread it to add options.\n *\n * @example\n * ```typescript\n * import { api, autoGeneratedError, post, request } from '@ahoo-wang/fetcher-decorator';\n *\n * interface AddCartItem {\n *   productId: string;\n * }\n *\n * // Every endpoint of the class streams.\n * @api('cart', COMMAND_STREAM_ENDPOINT)\n * class CartStreamCommandClient {\n *   @post('add_cart_item')\n *   addCartItem(\n *     @request() command: CommandRequest<AddCartItem>,\n *   ): Promise<CommandResultEventStream> {\n *     throw autoGeneratedError(command);\n *   }\n * }\n *\n * // One endpoint streams.\n * @api('cart')\n * class CartCommandClient {\n *   @post('add_cart_item', COMMAND_STREAM_ENDPOINT)\n *   addCartItemStream(\n *     @request() command: CommandRequest<AddCartItem>,\n *   ): Promise<CommandResultEventStream> {\n *     throw autoGeneratedError(command);\n *   }\n * }\n * ```\n */\nexport const COMMAND_STREAM_ENDPOINT: {\n  readonly headers: { readonly Accept: 'text/event-stream' };\n  readonly resultExtractor: ResultExtractor<ReadableStream<CommandResult>>;\n} = Object.freeze({\n  headers: Object.freeze({ Accept: ContentTypeValues.TEXT_EVENT_STREAM }),\n  resultExtractor: CommandResultEventStreamResultExtractor,\n});\n\n/**\n * The endpoint options of a query whose answer is a server-sent event\n * stream: `Accept: text/event-stream`, and a result extractor that answers\n * the rows, one per event, and errors the stream with a {@link WowError} at\n * the server's error event. The `*Stream` methods of the query clients use\n * it. Frozen, like {@link COMMAND_STREAM_ENDPOINT}.\n *\n * @example\n * ```typescript\n * import { api, autoGeneratedError, body, post } from '@ahoo-wang/fetcher-decorator';\n *\n * @api('cart')\n * class CartReportClient {\n *   @post('report/list', QUERY_STREAM_ENDPOINT)\n *   listStream(\n *     @body() query: FilterListQuery,\n *   ): Promise<ReadableStream<{ total: number }>> {\n *     throw autoGeneratedError(query);\n *   }\n * }\n * ```\n */\nexport const QUERY_STREAM_ENDPOINT: {\n  readonly headers: { readonly Accept: 'text/event-stream' };\n  readonly resultExtractor: ResultExtractor<ReadableStream<unknown>>;\n} = Object.freeze({\n  headers: Object.freeze({ Accept: ContentTypeValues.TEXT_EVENT_STREAM }),\n  resultExtractor: QueryEventStreamResultExtractor,\n});\n"],"mappings":"0EA+DA,IAAaK,EAGT,OAAO,OAAO,CAChB,QAAS,OAAO,OAAO,CAAE,OAAQL,EAAAA,kBAAkB,iBAAkB,CAAC,EACtE,gBAAiBC,EAAAA,uCACnB,CAAC,EAwBYK,EAGT,OAAO,OAAO,CAChB,QAAS,OAAO,OAAO,CAAE,OAAQN,EAAAA,kBAAkB,iBAAkB,CAAC,EACtE,gBAAiBE,EAAAA,+BACnB,CAAC"}

package/dist/transport/endpoints.d.cts

@@ -0,0 +1,79 @@
+import { ResultExtractor } from '@ahoo-wang/fetcher';
+import { CommandResult } from '../model/command.cjs';
+/**
+ * The endpoint options of a command whose answer is a server-sent event
+ * stream: `Accept: text/event-stream`, and a result extractor that answers
+ * the command results, one per stage the command reached, and errors the
+ * stream with a {@link WowError} at the server's error event.
+ * `CommandClient.sendAndWaitStream` uses it.
+ *
+ * A decorated command client that streams, hand-written or generated, takes
+ * it whole instead of spelling out the header and the extractor, so the
+ * transport is defined in one place. It fits both `@api` and the endpoint
+ * decorators. It is frozen; spread it to add options.
+ *
+ * @example
+ * ```typescript
+ * import { api, autoGeneratedError, post, request } from '@ahoo-wang/fetcher-decorator';
+ *
+ * interface AddCartItem {
+ *   productId: string;
+ * }
+ *
+ * // Every endpoint of the class streams.
+ * @api('cart', COMMAND_STREAM_ENDPOINT)
+ * class CartStreamCommandClient {
+ *   @post('add_cart_item')
+ *   addCartItem(
+ *     @request() command: CommandRequest<AddCartItem>,
+ *   ): Promise<CommandResultEventStream> {
+ *     throw autoGeneratedError(command);
+ *   }
+ * }
+ *
+ * // One endpoint streams.
+ * @api('cart')
+ * class CartCommandClient {
+ *   @post('add_cart_item', COMMAND_STREAM_ENDPOINT)
+ *   addCartItemStream(
+ *     @request() command: CommandRequest<AddCartItem>,
+ *   ): Promise<CommandResultEventStream> {
+ *     throw autoGeneratedError(command);
+ *   }
+ * }
+ * ```
+ */
+export declare const COMMAND_STREAM_ENDPOINT: {
+    readonly headers: {
+        readonly Accept: 'text/event-stream';
+    };
+    readonly resultExtractor: ResultExtractor<ReadableStream<CommandResult>>;
+};
+/**
+ * The endpoint options of a query whose answer is a server-sent event
+ * stream: `Accept: text/event-stream`, and a result extractor that answers
+ * the rows, one per event, and errors the stream with a {@link WowError} at
+ * the server's error event. The `*Stream` methods of the query clients use
+ * it. Frozen, like {@link COMMAND_STREAM_ENDPOINT}.
+ *
+ * @example
+ * ```typescript
+ * import { api, autoGeneratedError, body, post } from '@ahoo-wang/fetcher-decorator';
+ *
+ * @api('cart')
+ * class CartReportClient {
+ *   @post('report/list', QUERY_STREAM_ENDPOINT)
+ *   listStream(
+ *     @body() query: FilterListQuery,
+ *   ): Promise<ReadableStream<{ total: number }>> {
+ *     throw autoGeneratedError(query);
+ *   }
+ * }
+ * ```
+ */
+export declare const QUERY_STREAM_ENDPOINT: {
+    readonly headers: {
+        readonly Accept: 'text/event-stream';
+    };
+    readonly resultExtractor: ResultExtractor<ReadableStream<unknown>>;
+};

package/dist/transport/endpoints.d.ts

@@ -0,0 +1,79 @@
+import { ResultExtractor } from '@ahoo-wang/fetcher';
+import { CommandResult } from '../model/command.js';
+/**
+ * The endpoint options of a command whose answer is a server-sent event
+ * stream: `Accept: text/event-stream`, and a result extractor that answers
+ * the command results, one per stage the command reached, and errors the
+ * stream with a {@link WowError} at the server's error event.
+ * `CommandClient.sendAndWaitStream` uses it.
+ *
+ * A decorated command client that streams, hand-written or generated, takes
+ * it whole instead of spelling out the header and the extractor, so the
+ * transport is defined in one place. It fits both `@api` and the endpoint
+ * decorators. It is frozen; spread it to add options.
+ *
+ * @example
+ * ```typescript
+ * import { api, autoGeneratedError, post, request } from '@ahoo-wang/fetcher-decorator';
+ *
+ * interface AddCartItem {
+ *   productId: string;
+ * }
+ *
+ * // Every endpoint of the class streams.
+ * @api('cart', COMMAND_STREAM_ENDPOINT)
+ * class CartStreamCommandClient {
+ *   @post('add_cart_item')
+ *   addCartItem(
+ *     @request() command: CommandRequest<AddCartItem>,
+ *   ): Promise<CommandResultEventStream> {
+ *     throw autoGeneratedError(command);
+ *   }
+ * }
+ *
+ * // One endpoint streams.
+ * @api('cart')
+ * class CartCommandClient {
+ *   @post('add_cart_item', COMMAND_STREAM_ENDPOINT)
+ *   addCartItemStream(
+ *     @request() command: CommandRequest<AddCartItem>,
+ *   ): Promise<CommandResultEventStream> {
+ *     throw autoGeneratedError(command);
+ *   }
+ * }
+ * ```
+ */
+export declare const COMMAND_STREAM_ENDPOINT: {
+    readonly headers: {
+        readonly Accept: 'text/event-stream';
+    };
+    readonly resultExtractor: ResultExtractor<ReadableStream<CommandResult>>;
+};
+/**
+ * The endpoint options of a query whose answer is a server-sent event
+ * stream: `Accept: text/event-stream`, and a result extractor that answers
+ * the rows, one per event, and errors the stream with a {@link WowError} at
+ * the server's error event. The `*Stream` methods of the query clients use
+ * it. Frozen, like {@link COMMAND_STREAM_ENDPOINT}.
+ *
+ * @example
+ * ```typescript
+ * import { api, autoGeneratedError, body, post } from '@ahoo-wang/fetcher-decorator';
+ *
+ * @api('cart')
+ * class CartReportClient {
+ *   @post('report/list', QUERY_STREAM_ENDPOINT)
+ *   listStream(
+ *     @body() query: FilterListQuery,
+ *   ): Promise<ReadableStream<{ total: number }>> {
+ *     throw autoGeneratedError(query);
+ *   }
+ * }
+ * ```
+ */
+export declare const QUERY_STREAM_ENDPOINT: {
+    readonly headers: {
+        readonly Accept: 'text/event-stream';
+    };
+    readonly resultExtractor: ResultExtractor<ReadableStream<unknown>>;
+};

package/dist/transport/endpoints.es.js

@@ -0,0 +1,14 @@
+import { CommandResultEventStreamResultExtractor as e, QueryEventStreamResultExtractor as t } from "./eventStreams.es.js";
+import { ContentTypeValues as n } from "@ahoo-wang/fetcher";
+//#region src/transport/endpoints.ts
+var r = Object.freeze({
+	headers: Object.freeze({ Accept: n.TEXT_EVENT_STREAM }),
+	resultExtractor: e
+}), i = Object.freeze({
+	headers: Object.freeze({ Accept: n.TEXT_EVENT_STREAM }),
+	resultExtractor: t
+});
+//#endregion
+export { r as COMMAND_STREAM_ENDPOINT, i as QUERY_STREAM_ENDPOINT };
+
+//# sourceMappingURL=endpoints.es.js.map

package/dist/transport/endpoints.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.es.js","names":["COMMAND_STREAM_ENDPOINT","ContentTypeValues","CommandResultEventStreamResultExtractor","QUERY_STREAM_ENDPOINT","QueryEventStreamResultExtractor"],"sources":["../../src/transport/endpoints.ts"],"sourcesContent":["/*\n * Copyright [2021-present] [ahoo wang <ahoowang@qq.com> (https://github.com/Ahoo-Wang)].\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *      http://www.apache.org/licenses/LICENSE-2.0\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ContentTypeValues, type ResultExtractor } from '@ahoo-wang/fetcher';\nimport type { CommandResult } from '../model/command.js';\nimport {\n  CommandResultEventStreamResultExtractor,\n  QueryEventStreamResultExtractor,\n} from './eventStreams.js';\n\n/**\n * The endpoint options of a command whose answer is a server-sent event\n * stream: `Accept: text/event-stream`, and a result extractor that answers\n * the command results, one per stage the command reached, and errors the\n * stream with a {@link WowError} at the server's error event.\n * `CommandClient.sendAndWaitStream` uses it.\n *\n * A decorated command client that streams, hand-written or generated, takes\n * it whole instead of spelling out the header and the extractor, so the\n * transport is defined in one place. It fits both `@api` and the endpoint\n * decorators. It is frozen; spread it to add options.\n *\n * @example\n * ```typescript\n * import { api, autoGeneratedError, post, request } from '@ahoo-wang/fetcher-decorator';\n *\n * interface AddCartItem {\n *   productId: string;\n * }\n *\n * // Every endpoint of the class streams.\n * @api('cart', COMMAND_STREAM_ENDPOINT)\n * class CartStreamCommandClient {\n *   @post('add_cart_item')\n *   addCartItem(\n *     @request() command: CommandRequest<AddCartItem>,\n *   ): Promise<CommandResultEventStream> {\n *     throw autoGeneratedError(command);\n *   }\n * }\n *\n * // One endpoint streams.\n * @api('cart')\n * class CartCommandClient {\n *   @post('add_cart_item', COMMAND_STREAM_ENDPOINT)\n *   addCartItemStream(\n *     @request() command: CommandRequest<AddCartItem>,\n *   ): Promise<CommandResultEventStream> {\n *     throw autoGeneratedError(command);\n *   }\n * }\n * ```\n */\nexport const COMMAND_STREAM_ENDPOINT: {\n  readonly headers: { readonly Accept: 'text/event-stream' };\n  readonly resultExtractor: ResultExtractor<ReadableStream<CommandResult>>;\n} = Object.freeze({\n  headers: Object.freeze({ Accept: ContentTypeValues.TEXT_EVENT_STREAM }),\n  resultExtractor: CommandResultEventStreamResultExtractor,\n});\n\n/**\n * The endpoint options of a query whose answer is a server-sent event\n * stream: `Accept: text/event-stream`, and a result extractor that answers\n * the rows, one per event, and errors the stream with a {@link WowError} at\n * the server's error event. The `*Stream` methods of the query clients use\n * it. Frozen, like {@link COMMAND_STREAM_ENDPOINT}.\n *\n * @example\n * ```typescript\n * import { api, autoGeneratedError, body, post } from '@ahoo-wang/fetcher-decorator';\n *\n * @api('cart')\n * class CartReportClient {\n *   @post('report/list', QUERY_STREAM_ENDPOINT)\n *   listStream(\n *     @body() query: FilterListQuery,\n *   ): Promise<ReadableStream<{ total: number }>> {\n *     throw autoGeneratedError(query);\n *   }\n * }\n * ```\n */\nexport const QUERY_STREAM_ENDPOINT: {\n  readonly headers: { readonly Accept: 'text/event-stream' };\n  readonly resultExtractor: ResultExtractor<ReadableStream<unknown>>;\n} = Object.freeze({\n  headers: Object.freeze({ Accept: ContentTypeValues.TEXT_EVENT_STREAM }),\n  resultExtractor: QueryEventStreamResultExtractor,\n});\n"],"mappings":";;;AA+DA,IAAaA,IAGT,OAAO,OAAO;CAChB,SAAS,OAAO,OAAO,EAAE,QAAQC,EAAkB,kBAAkB,CAAC;CACtE,iBAAiBC;AACnB,CAAC,GAwBYC,IAGT,OAAO,OAAO;CAChB,SAAS,OAAO,OAAO,EAAE,QAAQF,EAAkB,kBAAkB,CAAC;CACtE,iBAAiBG;AACnB,CAAC"}

package/dist/transport/eventStreams.cjs

@@ -0,0 +1,2 @@
+const e=require("../error/wowError.cjs"),t=require("../model/command.cjs");let n=require("@ahoo-wang/fetcher-eventstream");var r=`message`,i=new Set(Object.values(t.CommandStage));function a(t){return new TransformStream({transform(n,r){if(t(n.event)){r.enqueue(n.data);return}r.error(new e.WowError(e.isErrorInfo(n.data)?n.data:{errorCode:n.event,errorMsg:``}))}})}var o=async e=>(await(0,n.JsonEventStreamResultExtractor)(e)).pipeThrough(a(e=>e===r)),s=async e=>(await(0,n.JsonEventStreamResultExtractor)(e)).pipeThrough(a(e=>i.has(e)));exports.CommandResultEventStreamResultExtractor=s,exports.QueryEventStreamResultExtractor=o;
+//# sourceMappingURL=eventStreams.cjs.map