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

package/dist/client/command/commandRequest.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandRequest.es.js","names":["STAGES","CommandStage","stageName","stage","label","integer","value","minimum","put","name","commandHeaders","headers","CommandHeaders","options","waitStrategy"],"sources":["../../../src/client/command/commandRequest.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 { RequestHeaders, UrlParams } from '@ahoo-wang/fetcher';\nimport { CommandHeaders } from './commandHeaders.js';\nimport type { UrlPathParams } from '../routing.js';\nimport type { ParameterRequest } from '@ahoo-wang/fetcher-decorator';\nimport { CommandStage } from '../../model/index.js';\nimport type { CommandBody } from './types.js';\n\n/** A command stage, as the enum member or as its name. */\nexport type CommandStageName = CommandStage | `${CommandStage}`;\n\n/**\n * The headers of a command request.\n *\n * Every command header is optional and typed by what the server parses:\n * a stage is a {@link CommandStage}, a version or a timeout is an integer,\n * `Local-First` is a boolean. Any other header (`Authorization`, a\n * `Command-Header-*` extension, …) is still allowed as a string. Build these\n * with {@link commandHeaders} and {@link waitStrategy} rather than by hand.\n *\n * @example\n * ```typescript\n * const headers: CommandRequestHeaders = {\n *   ...commandHeaders({ ownerId: 'user-1', requestId }),\n *   ...waitStrategy({ stage: CommandStage.SNAPSHOT, timeoutMs: 10_000 }),\n * };\n * ```\n */\nexport interface CommandRequestHeaders extends RequestHeaders {\n  /** Tenant of the command, when the route has no tenant path segment */\n  [CommandHeaders.TENANT_ID]?: string;\n  /** Owner of the command, when the route has no owner path segment */\n  [CommandHeaders.OWNER_ID]?: string;\n  /** Space of the command, `Wow-Space-Id` */\n  [CommandHeaders.SPACE_ID]?: string;\n  /** Aggregate the command targets, when the route has no id path segment */\n  [CommandHeaders.AGGREGATE_ID]?: string;\n  /** The aggregate version the command expects, an integer */\n  [CommandHeaders.AGGREGATE_VERSION]?: `${number}`;\n  /** How long the server waits, in whole milliseconds */\n  [CommandHeaders.WAIT_TIME_OUT]?: `${number}`;\n  /** The stage to wait for; `PROCESSED` when absent */\n  [CommandHeaders.WAIT_STAGE]?: CommandStageName;\n  /** The bounded context the wait stage refers to */\n  [CommandHeaders.WAIT_CONTEXT]?: string;\n  /** The processor the wait stage refers to */\n  [CommandHeaders.WAIT_PROCESSOR]?: string;\n  /** The function the wait stage refers to */\n  [CommandHeaders.WAIT_FUNCTION]?: string;\n  /** The stage of the wait-chain tail; only with a `SAGA_HANDLED` wait stage */\n  [CommandHeaders.WAIT_TAIL_STAGE]?: CommandStageName;\n  /** The bounded context of the wait-chain tail */\n  [CommandHeaders.WAIT_TAIL_CONTEXT]?: string;\n  /** The processor of the wait-chain tail */\n  [CommandHeaders.WAIT_TAIL_PROCESSOR]?: string;\n  /** The function of the wait-chain tail */\n  [CommandHeaders.WAIT_TAIL_FUNCTION]?: string;\n  /** Idempotency key of the command */\n  [CommandHeaders.REQUEST_ID]?: string;\n  /** Whether the server may process the command locally */\n  [CommandHeaders.LOCAL_FIRST]?: 'true' | 'false';\n  /** Bounded context of the aggregate, for `/wow/command/send` */\n  [CommandHeaders.COMMAND_AGGREGATE_CONTEXT]?: string;\n  /** Name of the aggregate, for `/wow/command/send` */\n  [CommandHeaders.COMMAND_AGGREGATE_NAME]?: string;\n  /** Fully qualified command type, for `/wow/command/send` */\n  [CommandHeaders.COMMAND_TYPE]?: string;\n}\n\n/** Who a command is for; each option sets one command header. */\nexport interface CommandHeaderOptions {\n  /** The tenant, `Command-Tenant-Id`; for a route without a tenant segment. */\n  tenantId?: string;\n  /** The owner, `Command-Owner-Id`; for a route without an owner segment. */\n  ownerId?: string;\n  /**\n   * The space, `Wow-Space-Id`; the tenant's default space when absent. Only a\n   * spaced aggregate reads it.\n   */\n  spaceId?: string;\n  /**\n   * The target aggregate, `Command-Aggregate-Id`; for a route without an id\n   * segment.\n   */\n  aggregateId?: string;\n  /** The aggregate version the command expects: a non-negative integer. */\n  aggregateVersion?: number;\n  /** Idempotency key; the server refuses a repeated one. */\n  requestId?: string;\n  /**\n   * Whether the server may process the command in its own process when it\n   * hosts the aggregate, `Command-Local-First`; it does unless this is `false`.\n   */\n  localFirst?: boolean;\n}\n\n/** The processing a wait stage refers to; blank means any. */\nexport interface WaitFunction {\n  context?: string;\n  processor?: string;\n  function?: string;\n}\n\n/** Wait for one stage of the command. */\nexport interface WaitStageOptions extends WaitFunction {\n  /** The stage to wait for. The server waits for `PROCESSED` when absent. */\n  stage?: CommandStageName;\n  /** How long the server waits, in whole milliseconds. */\n  timeoutMs?: number;\n  tail?: never;\n}\n\n/**\n * Wait for a saga to handle the command's events, and then for the command\n * that saga sends to reach `tail.stage` — Wow's wait chain.\n */\nexport interface WaitChainOptions extends WaitFunction {\n  stage: CommandStage.SAGA_HANDLED | 'SAGA_HANDLED';\n  tail: WaitFunction & { stage: CommandStageName };\n  /** How long the server waits, in whole milliseconds. */\n  timeoutMs?: number;\n}\n\n/** What {@link waitStrategy} takes: one stage, or a wait chain. */\nexport type WaitStrategyOptions = WaitStageOptions | WaitChainOptions;\n\nconst STAGES: ReadonlySet<string> = new Set(Object.values(CommandStage));\n\nfunction stageName(label: string, stage: string): CommandStageName {\n  if (!STAGES.has(stage)) {\n    throw new TypeError(\n      `${label} must be one of ${[...STAGES].join(', ')}, got [${stage}].`,\n    );\n  }\n  return stage as CommandStageName;\n}\n\nfunction integer(label: string, value: number, minimum: number): `${number}` {\n  if (!Number.isSafeInteger(value) || value < minimum) {\n    throw new TypeError(\n      `${label} must be an integer of at least ${minimum}, got [${value}].`,\n    );\n  }\n  return `${value}`;\n}\n\nfunction put(\n  headers: CommandRequestHeaders,\n  name: keyof CommandRequestHeaders,\n  value: string | undefined,\n): void {\n  if (value !== undefined) headers[name] = value as never;\n}\n\n/**\n * Builds the headers that say who a command is for. Options left out send\n * no header.\n *\n * @throws TypeError when `aggregateVersion` is not a non-negative integer.\n *\n * @example\n * ```typescript\n * await commandClient.send({\n *   path: 'owner/{ownerId}/cart/add_cart_item',\n *   method: 'POST',\n *   headers: commandHeaders({ spaceId: 'store-1', requestId: crypto.randomUUID() }),\n *   body: { productId: 'p-1', quantity: 1 },\n * });\n * ```\n */\nexport function commandHeaders(\n  options: CommandHeaderOptions,\n): CommandRequestHeaders {\n  const headers: CommandRequestHeaders = {};\n  put(headers, CommandHeaders.TENANT_ID, options.tenantId);\n  put(headers, CommandHeaders.OWNER_ID, options.ownerId);\n  put(headers, CommandHeaders.SPACE_ID, options.spaceId);\n  put(headers, CommandHeaders.AGGREGATE_ID, options.aggregateId);\n  if (options.aggregateVersion !== undefined) {\n    headers[CommandHeaders.AGGREGATE_VERSION] = integer(\n      'aggregateVersion',\n      options.aggregateVersion,\n      0,\n    );\n  }\n  put(headers, CommandHeaders.REQUEST_ID, options.requestId);\n  if (options.localFirst !== undefined) {\n    headers[CommandHeaders.LOCAL_FIRST] = options.localFirst ? 'true' : 'false';\n  }\n  return headers;\n}\n\n/**\n * Builds the headers that say how long, and for what, the server waits\n * before it answers a command — Kotlin's `WaitingFor`. Options left out send\n * no header, and the server's defaults apply: `PROCESSED` in the command's own\n * bounded context.\n *\n * @throws TypeError when a stage is not a `CommandStage`, when `timeoutMs` is\n *   not a positive integer, or when a `tail` is given with a stage other than\n *   `SAGA_HANDLED` (the server ignores the tail then).\n *\n * @example\n * ```typescript\n * // Answer once the snapshot is written, or after five seconds.\n * waitStrategy({ stage: CommandStage.SNAPSHOT, timeoutMs: 5_000 });\n *\n * // Answer once the saga's command has been processed.\n * waitStrategy({\n *   stage: 'SAGA_HANDLED',\n *   processor: 'TransferSaga',\n *   tail: { stage: 'PROCESSED', context: 'account' },\n * });\n * ```\n */\nexport function waitStrategy(\n  options: WaitStrategyOptions,\n): CommandRequestHeaders {\n  const headers: CommandRequestHeaders = {};\n  if (options.stage !== undefined) {\n    headers[CommandHeaders.WAIT_STAGE] = stageName('stage', options.stage);\n  }\n  put(headers, CommandHeaders.WAIT_CONTEXT, options.context);\n  put(headers, CommandHeaders.WAIT_PROCESSOR, options.processor);\n  put(headers, CommandHeaders.WAIT_FUNCTION, options.function);\n  if (options.tail !== undefined) {\n    if (options.stage !== CommandStage.SAGA_HANDLED) {\n      throw new TypeError('A wait tail needs the SAGA_HANDLED stage.');\n    }\n    headers[CommandHeaders.WAIT_TAIL_STAGE] = stageName(\n      'tail.stage',\n      options.tail.stage,\n    );\n    put(headers, CommandHeaders.WAIT_TAIL_CONTEXT, options.tail.context);\n    put(headers, CommandHeaders.WAIT_TAIL_PROCESSOR, options.tail.processor);\n    put(headers, CommandHeaders.WAIT_TAIL_FUNCTION, options.tail.function);\n  }\n  if (options.timeoutMs !== undefined) {\n    headers[CommandHeaders.WAIT_TIME_OUT] = integer(\n      'timeoutMs',\n      options.timeoutMs,\n      1,\n    );\n  }\n  return headers;\n}\n\n/**\n * The URL parameters of a {@link CommandRequest}: the values of the route's\n * path variables. A command takes no query string.\n */\nexport interface CommandUrlParams extends Omit<UrlParams, 'path' | 'query'> {\n  /** The path variables, such as `{ ownerId, id }`. */\n  path?: UrlPathParams;\n}\n\n/**\n * A command request: the path of the command route, its URL parameters, its\n * typed headers and its body.\n */\nexport interface CommandRequest<\n  C extends object = object,\n> extends ParameterRequest<CommandBody<C>> {\n  urlParams?: CommandUrlParams;\n  headers?: CommandRequestHeaders;\n  /**\n   * The body of the command request.\n   */\n  body?: CommandBody<C>;\n}\n"],"mappings":";;;AA0IA,IAAMA,IAA8B,IAAI,IAAI,OAAO,OAAOC,CAAY,CAAC;AAEvE,SAASC,EAAU,GAAe,GAAiC;CACjE,IAAI,CAACF,EAAO,IAAIG,CAAK,GACnB,MAAU,UACR,GAAGC,EAAM,kBAAkB,CAAC,GAAGJ,CAAM,CAAC,CAAC,KAAK,IAAI,EAAE,SAASG,EAAM,GACnE;CAEF,OAAOA;AACT;AAEA,SAASE,EAAQ,GAAe,GAAe,GAA8B;CAC3E,IAAI,CAAC,OAAO,cAAcC,CAAK,KAAKA,IAAQC,GAC1C,MAAU,UACR,GAAGH,EAAM,kCAAkCG,EAAQ,SAASD,EAAM,GACpE;CAEF,OAAO,GAAGA;AACZ;AAEA,SAASE,EACP,GACA,GACA,GACM;CACN,AAAIF,MAAU,KAAA,MAAW,EAAQG,KAAQH;AAC3C;AAkBA,SAAgBI,EACd,GACuB;CACvB,IAAMC,IAAiC,CAAC;CAgBxC,OAfAH,EAAIG,GAASC,EAAe,WAAWC,EAAQ,QAAQ,GACvDL,EAAIG,GAASC,EAAe,UAAUC,EAAQ,OAAO,GACrDL,EAAIG,GAASC,EAAe,UAAUC,EAAQ,OAAO,GACrDL,EAAIG,GAASC,EAAe,cAAcC,EAAQ,WAAW,GACzDA,EAAQ,qBAAqB,KAAA,MAC/B,EAAQD,EAAe,qBAAqBP,EAC1C,oBACAQ,EAAQ,kBACR,CACF,IAEFL,EAAIG,GAASC,EAAe,YAAYC,EAAQ,SAAS,GACrDA,EAAQ,eAAe,KAAA,MACzB,EAAQD,EAAe,eAAeC,EAAQ,aAAa,SAAS,UAE/DF;AACT;AAyBA,SAAgBG,EACd,GACuB;CACvB,IAAMH,IAAiC,CAAC;CAOxC,IANIE,EAAQ,UAAU,KAAA,MACpB,EAAQD,EAAe,cAAcV,EAAU,SAASW,EAAQ,KAAK,IAEvEL,EAAIG,GAASC,EAAe,cAAcC,EAAQ,OAAO,GACzDL,EAAIG,GAASC,EAAe,gBAAgBC,EAAQ,SAAS,GAC7DL,EAAIG,GAASC,EAAe,eAAeC,EAAQ,QAAQ,GACvDA,EAAQ,SAAS,KAAA,GAAW;EAC9B,IAAIA,EAAQ,UAAUZ,EAAa,cACjC,MAAU,UAAU,2CAA2C;EAQjE,AANA,EAAQW,EAAe,mBAAmBV,EACxC,cACAW,EAAQ,KAAK,KACf,GACAL,EAAIG,GAASC,EAAe,mBAAmBC,EAAQ,KAAK,OAAO,GACnEL,EAAIG,GAASC,EAAe,qBAAqBC,EAAQ,KAAK,SAAS,GACvEL,EAAIG,GAASC,EAAe,oBAAoBC,EAAQ,KAAK,QAAQ;CACvE;CAQA,OAPIA,EAAQ,cAAc,KAAA,MACxB,EAAQD,EAAe,iBAAiBP,EACtC,aACAQ,EAAQ,WACR,CACF,IAEKF;AACT"}

package/dist/client/command/commandResult.d.cts

@@ -0,0 +1,15 @@
+import { CommandResult } from '../../model/index.cjs';
+/**
+ * The stream `sendAndWaitStream` answers: one command result per stage the
+ * command reached, in order. It errors with a `WowError` when the server
+ * fails midway, so a `for await` over it throws.
+ *
+ * @example
+ * ```typescript
+ * declare const stream: CommandResultEventStream;
+ * for await (const result of stream) {
+ *   console.log(result.stage, result.errorCode);
+ * }
+ * ```
+ */
+export type CommandResultEventStream = ReadableStream<CommandResult>;

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

@@ -0,0 +1,15 @@
+import { CommandResult } from '../../model/index.js';
+/**
+ * The stream `sendAndWaitStream` answers: one command result per stage the
+ * command reached, in order. It errors with a `WowError` when the server
+ * fails midway, so a `for await` over it throws.
+ *
+ * @example
+ * ```typescript
+ * declare const stream: CommandResultEventStream;
+ * for await (const result of stream) {
+ *   console.log(result.stage, result.errorCode);
+ * }
+ * ```
+ */
+export type CommandResultEventStream = ReadableStream<CommandResult>;

package/dist/client/command/index.d.cts

@@ -0,0 +1,5 @@
+export * from './commandClient.cjs';
+export * from './commandHeaders.cjs';
+export * from './commandRequest.cjs';
+export * from './commandResult.cjs';
+export * from './types.cjs';

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

@@ -0,0 +1,5 @@
+export * from './commandClient.js';
+export * from './commandHeaders.js';
+export * from './commandRequest.js';
+export * from './commandResult.js';
+export * from './types.js';

package/dist/client/command/types.d.cts

@@ -0,0 +1,71 @@
+import { ErrorInfo } from '../../error/index.cjs';
+import { ApplyAbacTags, FunctionInfoCapable, Identifier } from '../../model/index.cjs';
+import { PartialBy, RemoveReadonlyFields } from '@ahoo-wang/fetcher';
+/**
+ * Represents a target for compensation operations.
+ *
+ * This interface extends Identifier (with optional id) and FunctionInfoCapable to define
+ * the structure for objects that can be targeted for compensation operations. Compensation
+ * targets typically represent entities that can have operations reversed or corrected.
+ */
+export interface CompensationTarget extends PartialBy<Identifier, 'id'>, FunctionInfoCapable {
+}
+/**
+ * Represents a command to delete an aggregate.
+ *
+ * This interface defines the structure for commands that request the deletion of an aggregate.
+ * It is typically used in conjunction with other command interfaces to provide a complete
+ * command processing workflow.
+ */
+export interface DeleteAggregate {
+}
+/**
+ * The body a client sends for command `C`: its writable fields, with the
+ * `readonly` ones left out. `CommandRequest` and the generated command
+ * clients type their bodies with it.
+ */
+export type CommandBody<C> = RemoveReadonlyFields<C>;
+/**
+ * The body of Wow's built-in delete command, sent with `DELETE` to the
+ * aggregate's route.
+ */
+export type DeleteAggregateCommand = CommandBody<DeleteAggregate>;
+/**
+ * Represents a command to recover an aggregate.
+ *
+ * This interface defines the structure for commands that request the recovery of an aggregate,
+ * typically used in scenarios where an aggregate needs to be restored to a previous state
+ * or recovered from an error condition.
+ */
+export interface RecoverAggregate {
+}
+/**
+ * The body of Wow's built-in recover command, which restores a deleted
+ * aggregate; sent with `PUT` to the aggregate's `recover` route.
+ */
+export type RecoverAggregateCommand = CommandBody<RecoverAggregate>;
+/**
+ * Wow's built-in command that applies ABAC tags to an aggregate, sent with
+ * `PUT` to the aggregate's `tags` route; the server refuses a blank tag key.
+ */
+export interface ApplyResourceTags extends ApplyAbacTags {
+}
+/** The body of {@link ApplyResourceTags}. */
+export type ApplyResourceTagsCommand = CommandBody<ApplyResourceTags>;
+/**
+ * Represents the result of a batch operation, containing information about
+ * the pagination and error status of the operation.
+ *
+ * Extends ErrorInfo to include error details if the batch operation failed.
+ */
+export interface BatchResult extends ErrorInfo {
+    /**
+     * The cursor or identifier for the next item after the current batch.
+     * Used for pagination to continue fetching the next batch of items.
+     */
+    after: string;
+    /**
+     * The number of items in the current batch.
+     */
+    size: number;
+}

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

@@ -0,0 +1,71 @@
+import { ErrorInfo } from '../../error/index.js';
+import { ApplyAbacTags, FunctionInfoCapable, Identifier } from '../../model/index.js';
+import { PartialBy, RemoveReadonlyFields } from '@ahoo-wang/fetcher';
+/**
+ * Represents a target for compensation operations.
+ *
+ * This interface extends Identifier (with optional id) and FunctionInfoCapable to define
+ * the structure for objects that can be targeted for compensation operations. Compensation
+ * targets typically represent entities that can have operations reversed or corrected.
+ */
+export interface CompensationTarget extends PartialBy<Identifier, 'id'>, FunctionInfoCapable {
+}
+/**
+ * Represents a command to delete an aggregate.
+ *
+ * This interface defines the structure for commands that request the deletion of an aggregate.
+ * It is typically used in conjunction with other command interfaces to provide a complete
+ * command processing workflow.
+ */
+export interface DeleteAggregate {
+}
+/**
+ * The body a client sends for command `C`: its writable fields, with the
+ * `readonly` ones left out. `CommandRequest` and the generated command
+ * clients type their bodies with it.
+ */
+export type CommandBody<C> = RemoveReadonlyFields<C>;
+/**
+ * The body of Wow's built-in delete command, sent with `DELETE` to the
+ * aggregate's route.
+ */
+export type DeleteAggregateCommand = CommandBody<DeleteAggregate>;
+/**
+ * Represents a command to recover an aggregate.
+ *
+ * This interface defines the structure for commands that request the recovery of an aggregate,
+ * typically used in scenarios where an aggregate needs to be restored to a previous state
+ * or recovered from an error condition.
+ */
+export interface RecoverAggregate {
+}
+/**
+ * The body of Wow's built-in recover command, which restores a deleted
+ * aggregate; sent with `PUT` to the aggregate's `recover` route.
+ */
+export type RecoverAggregateCommand = CommandBody<RecoverAggregate>;
+/**
+ * Wow's built-in command that applies ABAC tags to an aggregate, sent with
+ * `PUT` to the aggregate's `tags` route; the server refuses a blank tag key.
+ */
+export interface ApplyResourceTags extends ApplyAbacTags {
+}
+/** The body of {@link ApplyResourceTags}. */
+export type ApplyResourceTagsCommand = CommandBody<ApplyResourceTags>;
+/**
+ * Represents the result of a batch operation, containing information about
+ * the pagination and error status of the operation.
+ *
+ * Extends ErrorInfo to include error details if the batch operation failed.
+ */
+export interface BatchResult extends ErrorInfo {
+    /**
+     * The cursor or identifier for the next item after the current batch.
+     * Used for pagination to continue fetching the next batch of items.
+     */
+    after: string;
+    /**
+     * The number of items in the current batch.
+     */
+    size: number;
+}

package/dist/client/metadata/index.d.cts

@@ -0,0 +1,2 @@
+export * from './wowMetadata.cjs';
+export * from './wowMetadataClient.cjs';

package/dist/client/metadata/index.d.ts

@@ -0,0 +1,2 @@
+export * from './wowMetadata.js';
+export * from './wowMetadataClient.js';

package/dist/client/metadata/wowMetadata.d.cts

@@ -0,0 +1,48 @@
+import { DescriptionCapable } from '../../model/index.cjs';
+/** Something that owns packages, by package name prefix. */
+export interface ScopesCapable {
+    /** The packages that belong to it. */
+    scopes: string[];
+}
+/** One aggregate of a {@link BoundedContext} in {@link WowMetadata}. */
+export interface Aggregate extends ScopesCapable {
+    /**
+     * Aggregate type fully qualified name
+     */
+    type: string | null;
+    /**
+     * Static tenant ID
+     */
+    tenantId: string | null;
+    /**
+     * Custom ID generator name
+     */
+    id: string | null;
+    /**
+     * The packages of the commands the aggregate handles
+     */
+    commands: string[];
+    /**
+     * The packages of the domain events the aggregate raises
+     */
+    events: string[];
+}
+/** One bounded context of {@link WowMetadata}. */
+export interface BoundedContext extends ScopesCapable, DescriptionCapable {
+    /**
+     * The context's short name, unique across the server, which Wow uses in
+     * route paths and schema names in place of the context name; `null` when
+     * the context has none.
+     */
+    alias: string | null;
+    /** The context's aggregates, by aggregate name. */
+    aggregates: Record<string, Aggregate>;
+}
+/**
+ * What a Wow server declares about itself: its bounded contexts and their
+ * aggregates, as `WowMetadataClient` reads it from `GET /wow/metadata`.
+ */
+export interface WowMetadata extends DescriptionCapable {
+    /** The bounded contexts, by context name. */
+    contexts: Record<string, BoundedContext>;
+}

package/dist/client/metadata/wowMetadata.d.ts

@@ -0,0 +1,48 @@
+import { DescriptionCapable } from '../../model/index.js';
+/** Something that owns packages, by package name prefix. */
+export interface ScopesCapable {
+    /** The packages that belong to it. */
+    scopes: string[];
+}
+/** One aggregate of a {@link BoundedContext} in {@link WowMetadata}. */
+export interface Aggregate extends ScopesCapable {
+    /**
+     * Aggregate type fully qualified name
+     */
+    type: string | null;
+    /**
+     * Static tenant ID
+     */
+    tenantId: string | null;
+    /**
+     * Custom ID generator name
+     */
+    id: string | null;
+    /**
+     * The packages of the commands the aggregate handles
+     */
+    commands: string[];
+    /**
+     * The packages of the domain events the aggregate raises
+     */
+    events: string[];
+}
+/** One bounded context of {@link WowMetadata}. */
+export interface BoundedContext extends ScopesCapable, DescriptionCapable {
+    /**
+     * The context's short name, unique across the server, which Wow uses in
+     * route paths and schema names in place of the context name; `null` when
+     * the context has none.
+     */
+    alias: string | null;
+    /** The context's aggregates, by aggregate name. */
+    aggregates: Record<string, Aggregate>;
+}
+/**
+ * What a Wow server declares about itself: its bounded contexts and their
+ * aggregates, as `WowMetadataClient` reads it from `GET /wow/metadata`.
+ */
+export interface WowMetadata extends DescriptionCapable {
+    /** The bounded contexts, by context name. */
+    contexts: Record<string, BoundedContext>;
+}

package/dist/client/metadata/wowMetadataClient.cjs

@@ -0,0 +1,2 @@
+const e=require("../bindMethods.cjs"),t=require("../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateMetadata.cjs"),n=require("../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateParam.cjs"),r=require("../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorate.cjs");let i=require("@ahoo-wang/fetcher-decorator");var a=class{constructor(t){this.apiMetadata=t,e.bindMethods(this)}metadata(e,t){throw(0,i.autoGeneratedError)(e,t)}};r.default([(0,i.get)(`/wow/metadata`),n.default(0,(0,i.attribute)()),t.default(`design:type`,Function),t.default(`design:paramtypes`,[typeof Record>`u`?Object:Record,Object]),t.default(`design:returntype`,typeof Promise>`u`?Object:Promise)],a.prototype,`metadata`,null),a=r.default([(0,i.api)(),t.default(`design:paramtypes`,[Object])],a),Object.defineProperty(exports,"WowMetadataClient",{enumerable:!0,get:function(){return a}});
+//# sourceMappingURL=wowMetadataClient.cjs.map

package/dist/client/metadata/wowMetadataClient.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"wowMetadataClient.cjs","names":["autoGeneratedError","_decorate","get","_decorateParam","attribute","_decorateMetadata","api","require_bindMethods","require_decorateMetadata","require_decorateParam","require_decorate","_ahoo_wang_fetcher_decorator","WowMetadataClient","apiMetadata","attributes","abort"],"sources":["../../../src/client/metadata/wowMetadataClient.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 {\n  ApiMetadata,\n  ApiMetadataCapable,\n} from '@ahoo-wang/fetcher-decorator';\nimport {\n  api,\n  attribute,\n  autoGeneratedError,\n  get,\n} from '@ahoo-wang/fetcher-decorator';\nimport type { WowMetadata } from './wowMetadata.js';\nimport { bindMethods } from '../bindMethods.js';\n\n/**\n * Reads the server's `WowMetadata`: its bounded contexts, their aggregates,\n * and each aggregate's commands and events. `GET /wow/metadata`, relative to\n * the fetcher's base URL: construct it without a `basePath`, which would be\n * put in front of the path.\n *\n * @example\n * ```typescript\n * const metadata = await new WowMetadataClient().metadata();\n * Object.keys(metadata.contexts); // ['example-service', …]\n * ```\n */\n@api()\nexport class WowMetadataClient implements ApiMetadataCapable {\n  constructor(public readonly apiMetadata?: ApiMetadata) {\n    bindMethods(this);\n  }\n\n  /**\n   * @param attributes - Optional shared attributes for the interceptors\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   */\n  @get('/wow/metadata')\n  /* v8 ignore start */\n  metadata(\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<WowMetadata> {\n    throw autoGeneratedError(attributes, abort);\n  }\n  /* v8 ignore stop */\n}\n"],"mappings":"0VAuCO,IAAMY,EAAN,KAAsD,CAC3D,YAAY,EAA2C,CAA3B,KAAA,YAAAC,EAC1BN,EAAA,YAAY,IAAI,CAClB,CAMA,SAGE,EACA,EACsB,CACtB,MAAA,EAAMP,EAAAA,mBAAAA,CAAmBc,EAAYC,CAAK,CAC5C,CAEF,cATGb,EAAAA,EAAAA,IAAAA,CAAI,eAAe,EAGjBC,EAAAA,QAAA,GAAA,EAAAC,EAAAA,UAAAA,CAAU,CAAA,2MAbd,EAAAH,EAAAA,QAAA,EAAA,EAAAK,EAAAA,IAAAA,CAAI,EAAAD,EAAAA,QAAA,oBAAA,CAAA,MAAA,CAAA,CAAA,EAAAO,CAAA"}

package/dist/client/metadata/wowMetadataClient.d.cts

@@ -0,0 +1,23 @@
+import { ApiMetadata, ApiMetadataCapable } from '@ahoo-wang/fetcher-decorator';
+import { WowMetadata } from './wowMetadata.cjs';
+/**
+ * Reads the server's `WowMetadata`: its bounded contexts, their aggregates,
+ * and each aggregate's commands and events. `GET /wow/metadata`, relative to
+ * the fetcher's base URL: construct it without a `basePath`, which would be
+ * put in front of the path.
+ *
+ * @example
+ * ```typescript
+ * const metadata = await new WowMetadataClient().metadata();
+ * Object.keys(metadata.contexts); // ['example-service', …]
+ * ```
+ */
+export declare class WowMetadataClient implements ApiMetadataCapable {
+    readonly apiMetadata?: ApiMetadata | undefined;
+    constructor(apiMetadata?: ApiMetadata | undefined);
+    /**
+     * @param attributes - Optional shared attributes for the interceptors
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     */
+    metadata(attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<WowMetadata>;
+}

package/dist/client/metadata/wowMetadataClient.d.ts

@@ -0,0 +1,23 @@
+import { ApiMetadata, ApiMetadataCapable } from '@ahoo-wang/fetcher-decorator';
+import { WowMetadata } from './wowMetadata.js';
+/**
+ * Reads the server's `WowMetadata`: its bounded contexts, their aggregates,
+ * and each aggregate's commands and events. `GET /wow/metadata`, relative to
+ * the fetcher's base URL: construct it without a `basePath`, which would be
+ * put in front of the path.
+ *
+ * @example
+ * ```typescript
+ * const metadata = await new WowMetadataClient().metadata();
+ * Object.keys(metadata.contexts); // ['example-service', …]
+ * ```
+ */
+export declare class WowMetadataClient implements ApiMetadataCapable {
+    readonly apiMetadata?: ApiMetadata | undefined;
+    constructor(apiMetadata?: ApiMetadata | undefined);
+    /**
+     * @param attributes - Optional shared attributes for the interceptors
+     * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.
+     */
+    metadata(attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<WowMetadata>;
+}

package/dist/client/metadata/wowMetadataClient.es.js

@@ -0,0 +1,25 @@
+import { bindMethods as e } from "../bindMethods.es.js";
+import t from "../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateMetadata.es.js";
+import n from "../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateParam.es.js";
+import r from "../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorate.es.js";
+import { api as i, attribute as a, autoGeneratedError as o, get as s } from "@ahoo-wang/fetcher-decorator";
+//#region src/client/metadata/wowMetadataClient.ts
+var c = class {
+	constructor(t) {
+		this.apiMetadata = t, e(this);
+	}
+	metadata(e, t) {
+		throw o(e, t);
+	}
+};
+r([
+	s("/wow/metadata"),
+	n(0, a()),
+	t("design:type", Function),
+	t("design:paramtypes", [typeof Record > "u" ? Object : Record, Object]),
+	t("design:returntype", typeof Promise > "u" ? Object : Promise)
+], c.prototype, "metadata", null), c = r([i(), t("design:paramtypes", [Object])], c);
+//#endregion
+export { c as WowMetadataClient };
+
+//# sourceMappingURL=wowMetadataClient.es.js.map

package/dist/client/metadata/wowMetadataClient.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wowMetadataClient.es.js","names":["_decorate","_decorateParam","_decorateMetadata","__decorateMetadata","__decorateParam","__decorate","WowMetadataClient","apiMetadata","bindMethods","autoGeneratedError","attributes","abort","get","attribute","api"],"sources":["../../../src/client/metadata/wowMetadataClient.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 {\n  ApiMetadata,\n  ApiMetadataCapable,\n} from '@ahoo-wang/fetcher-decorator';\nimport {\n  api,\n  attribute,\n  autoGeneratedError,\n  get,\n} from '@ahoo-wang/fetcher-decorator';\nimport type { WowMetadata } from './wowMetadata.js';\nimport { bindMethods } from '../bindMethods.js';\n\n/**\n * Reads the server's `WowMetadata`: its bounded contexts, their aggregates,\n * and each aggregate's commands and events. `GET /wow/metadata`, relative to\n * the fetcher's base URL: construct it without a `basePath`, which would be\n * put in front of the path.\n *\n * @example\n * ```typescript\n * const metadata = await new WowMetadataClient().metadata();\n * Object.keys(metadata.contexts); // ['example-service', …]\n * ```\n */\n@api()\nexport class WowMetadataClient implements ApiMetadataCapable {\n  constructor(public readonly apiMetadata?: ApiMetadata) {\n    bindMethods(this);\n  }\n\n  /**\n   * @param attributes - Optional shared attributes for the interceptors\n   * @param abort - Cancels the request: an `AbortController`, or an `AbortSignal` such as `AbortSignal.timeout(ms)` or the `signal` a data-fetching library passes.\n   */\n  @get('/wow/metadata')\n  /* v8 ignore start */\n  metadata(\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<WowMetadata> {\n    throw autoGeneratedError(attributes, abort);\n  }\n  /* v8 ignore stop */\n}\n"],"mappings":";;;;;;AAuCO,IAAMM,IAAN,MAAsD;CAC3D,YAAY,GAA2C;EACrD,AAD0B,KAAA,cAAAC,GAC1BC,EAAY,IAAI;CAClB;CAMA,SAGE,GACA,GACsB;EACtB,MAAMC,EAAmBC,GAAYC,CAAK;CAC5C;AAEF;;CATGC,EAAI,eAAe;CAGjBX,EAAA,GAAAY,EAAU,CAAA;;;;mCAbd,IAAAb,EAAA,CAAAc,EAAI,GAAAZ,EAAA,qBAAA,CAAA,MAAA,CAAA,CAAA,GAAAI,CAAA"}

package/dist/client/query/descriptor/descriptorEndpoints.cjs

@@ -0,0 +1,2 @@
+const e=require("../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateMetadata.cjs"),t=require("../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateParam.cjs"),n=require("../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorate.cjs"),r=require("./endpointPaths.cjs");let i=require("@ahoo-wang/fetcher"),a=require("@ahoo-wang/fetcher-decorator");var o=Object.freeze({resultExtractor:i.ExchangeResultExtractor,attributes:Object.freeze({[i.IGNORE_VALIDATE_STATUS]:!0})}),s=class{constructor(e){this.apiMetadata=e}snapshot(e,t,n){throw(0,a.autoGeneratedError)(e,t,n)}eventStream(e,t,n){throw(0,a.autoGeneratedError)(e,t,n)}};n.default([(0,a.get)(r.QueryDescriptorEndpointPaths.SNAPSHOT,o),t.default(0,(0,a.header)(`If-None-Match`)),t.default(1,(0,a.attribute)()),e.default(`design:type`,Function),e.default(`design:paramtypes`,[String,typeof Record>`u`?Object:Record,Object]),e.default(`design:returntype`,typeof Promise>`u`?Object:Promise)],s.prototype,`snapshot`,null),n.default([(0,a.get)(r.QueryDescriptorEndpointPaths.EVENT_STREAM,o),t.default(0,(0,a.header)(`If-None-Match`)),t.default(1,(0,a.attribute)()),e.default(`design:type`,Function),e.default(`design:paramtypes`,[String,typeof Record>`u`?Object:Record,Object]),e.default(`design:returntype`,typeof Promise>`u`?Object:Promise)],s.prototype,`eventStream`,null),s=n.default([(0,a.api)(),e.default(`design:paramtypes`,[Object])],s);function c(e){return e?.trim().replace(/^W\//,``).replace(/^"(.*)"$/,`$1`)||void 0}function l(e){return e===void 0?void 0:`"${e}"`}async function u(e,t){let n=e.requiredResponse;if(n.status===304&&t!==void 0)return{notModified:!0,version:t};if(!n.ok)throw new i.HttpStatusValidationError(e);let r=await n.json();return{notModified:!1,descriptor:r,version:r.version}}Object.defineProperty(exports,"QueryDescriptorEndpoints",{enumerable:!0,get:function(){return s}}),exports.descriptorVersion=c,exports.ifNoneMatch=l,exports.readDescriptor=u;
+//# sourceMappingURL=descriptorEndpoints.cjs.map

package/dist/client/query/descriptor/descriptorEndpoints.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptorEndpoints.cjs","names":["ExchangeResultExtractor","IGNORE_VALIDATE_STATUS","autoGeneratedError","_decorate","get","QueryDescriptorEndpointPaths","_decorateParam","header","attribute","_decorateMetadata","api","HttpStatusValidationError","require_decorateMetadata","require_decorateParam","require_decorate","require_endpointPaths","_ahoo_wang_fetcher","_ahoo_wang_fetcher_decorator","DESCRIPTOR_ENDPOINT","QueryDescriptorEndpoints","apiMetadata","ifNoneMatch","attributes","abort","descriptorVersion","previous","version","readDescriptor","response","exchange","descriptor"],"sources":["../../../../src/client/query/descriptor/descriptorEndpoints.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\n// Internal: the index of this folder does not re-export this file.\n\nimport {\n  ExchangeResultExtractor,\n  type FetchExchange,\n  HttpStatusValidationError,\n  IGNORE_VALIDATE_STATUS,\n} from '@ahoo-wang/fetcher';\nimport type {\n  ApiMetadata,\n  ApiMetadataCapable,\n} from '@ahoo-wang/fetcher-decorator';\nimport {\n  api,\n  attribute,\n  autoGeneratedError,\n  get,\n  header,\n} from '@ahoo-wang/fetcher-decorator';\nimport type { QueryModelDescriptor } from '../../../dsl/descriptor.js';\nimport type { QueryDescriptorResult } from './queryDescriptorApi.js';\nimport { QueryDescriptorEndpointPaths } from './endpointPaths.js';\n\n/**\n * The endpoints answer the exchange with its status unchecked, so a 304 is\n * not an error; {@link readDescriptor} checks the status instead.\n */\nconst DESCRIPTOR_ENDPOINT = Object.freeze({\n  resultExtractor: ExchangeResultExtractor,\n  attributes: Object.freeze({ [IGNORE_VALIDATE_STATUS]: true }),\n});\n\n/**\n * The decorated requests behind `QueryDescriptorClient`, which turns the\n * version it is given into an ETag before they run.\n */\n@api()\nexport class QueryDescriptorEndpoints implements ApiMetadataCapable {\n  constructor(public readonly apiMetadata?: ApiMetadata) {}\n\n  @get(QueryDescriptorEndpointPaths.SNAPSHOT, DESCRIPTOR_ENDPOINT)\n  /* v8 ignore start */\n  snapshot(\n    @header('If-None-Match') ifNoneMatch?: string,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<FetchExchange> {\n    throw autoGeneratedError(ifNoneMatch, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  @get(QueryDescriptorEndpointPaths.EVENT_STREAM, DESCRIPTOR_ENDPOINT)\n  /* v8 ignore start */\n  eventStream(\n    @header('If-None-Match') ifNoneMatch?: string,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<FetchExchange> {\n    throw autoGeneratedError(ifNoneMatch, attributes, abort);\n  }\n  /* v8 ignore stop */\n}\n\n/**\n * The version a descriptor version or an ETag names: `sha256:…`,\n * `\"sha256:…\"` and `W/\"sha256:…\"` all name `sha256:…`. `undefined` for\n * nothing, or only blanks.\n */\nexport function descriptorVersion(previous?: string): string | undefined {\n  const version = previous\n    ?.trim()\n    .replace(/^W\\//, '')\n    .replace(/^\"(.*)\"$/, '$1');\n  return version ? version : undefined;\n}\n\n/**\n * The `If-None-Match` value for `version`: the ETag the server sends, which it\n * compares as it is.\n */\nexport function ifNoneMatch(version?: string): string | undefined {\n  return version === undefined ? undefined : `\"${version}\"`;\n}\n\n/**\n * What an exchange answers: 304 means the version sent is current; any other\n * status outside 2xx rejects with the error the fetcher would have thrown.\n */\nexport async function readDescriptor(\n  exchange: FetchExchange,\n  version: string | undefined,\n): Promise<QueryDescriptorResult> {\n  const response = exchange.requiredResponse;\n  if (response.status === 304 && version !== undefined)\n    return { notModified: true, version };\n  if (!response.ok) throw new HttpStatusValidationError(exchange);\n  const descriptor = (await response.json()) as QueryModelDescriptor;\n  return { notModified: false, descriptor, version: descriptor.version };\n}\n"],"mappings":"oYAwCA,IAAMkB,EAAsB,OAAO,OAAO,CACxC,gBAAiBlB,EAAAA,wBACjB,WAAY,OAAO,OAAO,EAAGC,EAAAA,wBAAyB,EAAK,CAAC,CAC9D,CAAC,EAOYkB,EAAN,KAA6D,CAClE,YAAY,EAA2C,CAA3B,KAAA,YAAAC,CAA4B,CAExD,SAGE,EACA,EACA,EACwB,CACxB,MAAA,EAAMlB,EAAAA,mBAAAA,CAAmBmB,EAAaC,EAAYC,CAAK,CACzD,CAGA,YAGE,EACA,EACA,EACwB,CACxB,MAAA,EAAMrB,EAAAA,mBAAAA,CAAmBmB,EAAaC,EAAYC,CAAK,CACzD,CAEF,cArBGnB,EAAAA,EAAAA,IAAAA,CAAIC,EAAAA,6BAA6B,SAAUa,CAAmB,EAG5DZ,EAAAA,QAAA,GAAA,EAAAC,EAAAA,OAAAA,CAAO,eAAe,CAAA,EACtBD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,8NAOZJ,EAAAA,EAAAA,IAAAA,CAAIC,EAAAA,6BAA6B,aAAca,CAAmB,EAGhEZ,EAAAA,QAAA,GAAA,EAAAC,EAAAA,OAAAA,CAAO,eAAe,CAAA,EACtBD,EAAAA,QAAA,GAAA,EAAAE,EAAAA,UAAAA,CAAU,CAAA,qNAnBd,EAAAL,EAAAA,QAAA,EAAA,EAAAO,EAAAA,IAAAA,CAAI,EAAAD,EAAAA,QAAA,oBAAA,CAAA,MAAA,CAAA,CAAA,EAAAU,CAAA,EAgCL,SAAgBK,EAAkB,EAAuC,CAKvE,OAJgBC,GACZ,KAAK,CAAC,CACP,QAAQ,OAAQ,EAAE,CAAC,CACnB,QAAQ,WAAY,IAAI,GACA,IAAA,EAC7B,CAMA,SAAgBJ,EAAY,EAAsC,CAChE,OAAOK,IAAY,IAAA,GAAY,IAAA,GAAY,IAAIA,EAAQ,EACzD,CAMA,eAAsBC,EACpB,EACA,EACgC,CAChC,IAAMC,EAAWC,EAAS,iBAC1B,GAAID,EAAS,SAAW,KAAOF,IAAY,IAAA,GACzC,MAAO,CAAE,YAAa,GAAM,SAAQ,EACtC,GAAI,CAACE,EAAS,GAAI,MAAM,IAAIjB,EAAAA,0BAA0BkB,CAAQ,EAC9D,IAAMC,EAAc,MAAMF,EAAS,KAAK,EACxC,MAAO,CAAE,YAAa,GAAO,aAAY,QAASE,EAAW,OAAQ,CACvE"}

package/dist/client/query/descriptor/descriptorEndpoints.d.cts

@@ -0,0 +1,29 @@
+import { FetchExchange } from '@ahoo-wang/fetcher';
+import { ApiMetadata, ApiMetadataCapable } from '@ahoo-wang/fetcher-decorator';
+import { QueryDescriptorResult } from './queryDescriptorApi.cjs';
+/**
+ * The decorated requests behind `QueryDescriptorClient`, which turns the
+ * version it is given into an ETag before they run.
+ */
+export declare class QueryDescriptorEndpoints implements ApiMetadataCapable {
+    readonly apiMetadata?: ApiMetadata | undefined;
+    constructor(apiMetadata?: ApiMetadata | undefined);
+    snapshot(ifNoneMatch?: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<FetchExchange>;
+    eventStream(ifNoneMatch?: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<FetchExchange>;
+}
+/**
+ * The version a descriptor version or an ETag names: `sha256:…`,
+ * `"sha256:…"` and `W/"sha256:…"` all name `sha256:…`. `undefined` for
+ * nothing, or only blanks.
+ */
+export declare function descriptorVersion(previous?: string): string | undefined;
+/**
+ * The `If-None-Match` value for `version`: the ETag the server sends, which it
+ * compares as it is.
+ */
+export declare function ifNoneMatch(version?: string): string | undefined;
+/**
+ * What an exchange answers: 304 means the version sent is current; any other
+ * status outside 2xx rejects with the error the fetcher would have thrown.
+ */
+export declare function readDescriptor(exchange: FetchExchange, version: string | undefined): Promise<QueryDescriptorResult>;

package/dist/client/query/descriptor/descriptorEndpoints.d.ts

@@ -0,0 +1,29 @@
+import { FetchExchange } from '@ahoo-wang/fetcher';
+import { ApiMetadata, ApiMetadataCapable } from '@ahoo-wang/fetcher-decorator';
+import { QueryDescriptorResult } from './queryDescriptorApi.js';
+/**
+ * The decorated requests behind `QueryDescriptorClient`, which turns the
+ * version it is given into an ETag before they run.
+ */
+export declare class QueryDescriptorEndpoints implements ApiMetadataCapable {
+    readonly apiMetadata?: ApiMetadata | undefined;
+    constructor(apiMetadata?: ApiMetadata | undefined);
+    snapshot(ifNoneMatch?: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<FetchExchange>;
+    eventStream(ifNoneMatch?: string, attributes?: Record<string, unknown>, abort?: AbortController | AbortSignal): Promise<FetchExchange>;
+}
+/**
+ * The version a descriptor version or an ETag names: `sha256:…`,
+ * `"sha256:…"` and `W/"sha256:…"` all name `sha256:…`. `undefined` for
+ * nothing, or only blanks.
+ */
+export declare function descriptorVersion(previous?: string): string | undefined;
+/**
+ * The `If-None-Match` value for `version`: the ETag the server sends, which it
+ * compares as it is.
+ */
+export declare function ifNoneMatch(version?: string): string | undefined;
+/**
+ * What an exchange answers: 304 means the version sent is current; any other
+ * status outside 2xx rejects with the error the fetcher would have thrown.
+ */
+export declare function readDescriptor(exchange: FetchExchange, version: string | undefined): Promise<QueryDescriptorResult>;

package/dist/client/query/descriptor/descriptorEndpoints.es.js

@@ -0,0 +1,69 @@
+import e from "../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateMetadata.es.js";
+import t from "../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorateParam.es.js";
+import n from "../../../_virtual/_@oxc-project_runtime@0.151.0/helpers/esm/decorate.es.js";
+import { QueryDescriptorEndpointPaths as r } from "./endpointPaths.es.js";
+import { ExchangeResultExtractor as i, HttpStatusValidationError as a, IGNORE_VALIDATE_STATUS as o } from "@ahoo-wang/fetcher";
+import { api as s, attribute as c, autoGeneratedError as l, get as u, header as d } from "@ahoo-wang/fetcher-decorator";
+//#region src/client/query/descriptor/descriptorEndpoints.ts
+var f = Object.freeze({
+	resultExtractor: i,
+	attributes: Object.freeze({ [o]: !0 })
+}), p = class {
+	constructor(e) {
+		this.apiMetadata = e;
+	}
+	snapshot(e, t, n) {
+		throw l(e, t, n);
+	}
+	/* v8 ignore stop */
+	eventStream(e, t, n) {
+		throw l(e, t, n);
+	}
+};
+n([
+	u(r.SNAPSHOT, f),
+	t(0, d("If-None-Match")),
+	t(1, c()),
+	e("design:type", Function),
+	e("design:paramtypes", [
+		String,
+		typeof Record > "u" ? Object : Record,
+		Object
+	]),
+	e("design:returntype", typeof Promise > "u" ? Object : Promise)
+], p.prototype, "snapshot", null), n([
+	u(r.EVENT_STREAM, f),
+	t(0, d("If-None-Match")),
+	t(1, c()),
+	e("design:type", Function),
+	e("design:paramtypes", [
+		String,
+		typeof Record > "u" ? Object : Record,
+		Object
+	]),
+	e("design:returntype", typeof Promise > "u" ? Object : Promise)
+], p.prototype, "eventStream", null), p = n([s(), e("design:paramtypes", [Object])], p);
+function m(e) {
+	return e?.trim().replace(/^W\//, "").replace(/^"(.*)"$/, "$1") || void 0;
+}
+function h(e) {
+	return e === void 0 ? void 0 : `"${e}"`;
+}
+async function g(e, t) {
+	let n = e.requiredResponse;
+	if (n.status === 304 && t !== void 0) return {
+		notModified: !0,
+		version: t
+	};
+	if (!n.ok) throw new a(e);
+	let r = await n.json();
+	return {
+		notModified: !1,
+		descriptor: r,
+		version: r.version
+	};
+}
+//#endregion
+export { p as QueryDescriptorEndpoints, m as descriptorVersion, h as ifNoneMatch, g as readDescriptor };
+
+//# sourceMappingURL=descriptorEndpoints.es.js.map

package/dist/client/query/descriptor/descriptorEndpoints.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptorEndpoints.es.js","names":["_decorate","_decorateParam","_decorateMetadata","__decorateMetadata","__decorateParam","__decorate","DESCRIPTOR_ENDPOINT","ExchangeResultExtractor","IGNORE_VALIDATE_STATUS","QueryDescriptorEndpoints","apiMetadata","autoGeneratedError","ifNoneMatch","attributes","abort","get","QueryDescriptorEndpointPaths","header","attribute","api","descriptorVersion","previous","version","readDescriptor","response","exchange","HttpStatusValidationError","descriptor"],"sources":["../../../../src/client/query/descriptor/descriptorEndpoints.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\n// Internal: the index of this folder does not re-export this file.\n\nimport {\n  ExchangeResultExtractor,\n  type FetchExchange,\n  HttpStatusValidationError,\n  IGNORE_VALIDATE_STATUS,\n} from '@ahoo-wang/fetcher';\nimport type {\n  ApiMetadata,\n  ApiMetadataCapable,\n} from '@ahoo-wang/fetcher-decorator';\nimport {\n  api,\n  attribute,\n  autoGeneratedError,\n  get,\n  header,\n} from '@ahoo-wang/fetcher-decorator';\nimport type { QueryModelDescriptor } from '../../../dsl/descriptor.js';\nimport type { QueryDescriptorResult } from './queryDescriptorApi.js';\nimport { QueryDescriptorEndpointPaths } from './endpointPaths.js';\n\n/**\n * The endpoints answer the exchange with its status unchecked, so a 304 is\n * not an error; {@link readDescriptor} checks the status instead.\n */\nconst DESCRIPTOR_ENDPOINT = Object.freeze({\n  resultExtractor: ExchangeResultExtractor,\n  attributes: Object.freeze({ [IGNORE_VALIDATE_STATUS]: true }),\n});\n\n/**\n * The decorated requests behind `QueryDescriptorClient`, which turns the\n * version it is given into an ETag before they run.\n */\n@api()\nexport class QueryDescriptorEndpoints implements ApiMetadataCapable {\n  constructor(public readonly apiMetadata?: ApiMetadata) {}\n\n  @get(QueryDescriptorEndpointPaths.SNAPSHOT, DESCRIPTOR_ENDPOINT)\n  /* v8 ignore start */\n  snapshot(\n    @header('If-None-Match') ifNoneMatch?: string,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<FetchExchange> {\n    throw autoGeneratedError(ifNoneMatch, attributes, abort);\n  }\n  /* v8 ignore stop */\n\n  @get(QueryDescriptorEndpointPaths.EVENT_STREAM, DESCRIPTOR_ENDPOINT)\n  /* v8 ignore start */\n  eventStream(\n    @header('If-None-Match') ifNoneMatch?: string,\n    @attribute() attributes?: Record<string, unknown>,\n    abort?: AbortController | AbortSignal,\n  ): Promise<FetchExchange> {\n    throw autoGeneratedError(ifNoneMatch, attributes, abort);\n  }\n  /* v8 ignore stop */\n}\n\n/**\n * The version a descriptor version or an ETag names: `sha256:…`,\n * `\"sha256:…\"` and `W/\"sha256:…\"` all name `sha256:…`. `undefined` for\n * nothing, or only blanks.\n */\nexport function descriptorVersion(previous?: string): string | undefined {\n  const version = previous\n    ?.trim()\n    .replace(/^W\\//, '')\n    .replace(/^\"(.*)\"$/, '$1');\n  return version ? version : undefined;\n}\n\n/**\n * The `If-None-Match` value for `version`: the ETag the server sends, which it\n * compares as it is.\n */\nexport function ifNoneMatch(version?: string): string | undefined {\n  return version === undefined ? undefined : `\"${version}\"`;\n}\n\n/**\n * What an exchange answers: 304 means the version sent is current; any other\n * status outside 2xx rejects with the error the fetcher would have thrown.\n */\nexport async function readDescriptor(\n  exchange: FetchExchange,\n  version: string | undefined,\n): Promise<QueryDescriptorResult> {\n  const response = exchange.requiredResponse;\n  if (response.status === 304 && version !== undefined)\n    return { notModified: true, version };\n  if (!response.ok) throw new HttpStatusValidationError(exchange);\n  const descriptor = (await response.json()) as QueryModelDescriptor;\n  return { notModified: false, descriptor, version: descriptor.version };\n}\n"],"mappings":";;;;;;;AAwCA,IAAMM,IAAsB,OAAO,OAAO;CACxC,iBAAiBC;CACjB,YAAY,OAAO,OAAO,GAAGC,IAAyB,GAAK,CAAC;AAC9D,CAAC,GAOYC,IAAN,MAA6D;CAClE,YAAY,GAA2C;EAA3B,KAAA,cAAAC;CAA4B;CAExD,SAGE,GACA,GACA,GACwB;EACxB,MAAMC,EAAmBC,GAAaC,GAAYC,CAAK;CACzD;;CAGA,YAGE,GACA,GACA,GACwB;EACxB,MAAMH,EAAmBC,GAAaC,GAAYC,CAAK;CACzD;AAEF;;CArBGC,EAAIC,EAA6B,UAAUV,CAAmB;CAG5DL,EAAA,GAAAgB,EAAO,eAAe,CAAA;CACtBhB,EAAA,GAAAiB,EAAU,CAAA;;;;;;;;;CAOZH,EAAIC,EAA6B,cAAcV,CAAmB;CAGhEL,EAAA,GAAAgB,EAAO,eAAe,CAAA;CACtBhB,EAAA,GAAAiB,EAAU,CAAA;;;;;;;;sCAnBd,IAAAlB,EAAA,CAAAmB,EAAI,GAAAjB,EAAA,qBAAA,CAAA,MAAA,CAAA,CAAA,GAAAO,CAAA;AAgCL,SAAgBW,EAAkB,GAAuC;CAKvE,OAJgBC,GACZ,KAAK,CAAC,CACP,QAAQ,QAAQ,EAAE,CAAC,CACnB,QAAQ,YAAY,IAAI,KACA,KAAA;AAC7B;AAMA,SAAgBT,EAAY,GAAsC;CAChE,OAAOU,MAAY,KAAA,IAAY,KAAA,IAAY,IAAIA,EAAQ;AACzD;AAMA,eAAsBC,EACpB,GACA,GACgC;CAChC,IAAMC,IAAWC,EAAS;CAC1B,IAAID,EAAS,WAAW,OAAOF,MAAY,KAAA,GACzC,OAAO;EAAE,aAAa;EAAM;CAAQ;CACtC,IAAI,CAACE,EAAS,IAAI,MAAM,IAAIE,EAA0BD,CAAQ;CAC9D,IAAME,IAAc,MAAMH,EAAS,KAAK;CACxC,OAAO;EAAE,aAAa;EAAO;EAAY,SAASG,EAAW;CAAQ;AACvE"}

package/dist/client/query/descriptor/endpointPaths.cjs

@@ -0,0 +1,2 @@
+var e=Object.freeze({SNAPSHOT:`snapshot/schema`,EVENT_STREAM:`event/schema`});exports.QueryDescriptorEndpointPaths=e;
+//# sourceMappingURL=endpointPaths.cjs.map

package/dist/client/query/descriptor/endpointPaths.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpointPaths.cjs","names":["QueryDescriptorEndpointPaths"],"sources":["../../../../src/client/query/descriptor/endpointPaths.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\n// Internal: the index of this folder does not re-export this file. The\n// paths are relative to the client's base path, which names the aggregate\n// without a tenant or owner segment: the schema routes have neither.\nexport const QueryDescriptorEndpointPaths = Object.freeze({\n  SNAPSHOT: 'snapshot/schema',\n  EVENT_STREAM: 'event/schema',\n} as const);\n"],"mappings":"AAgBA,IAAaA,EAA+B,OAAO,OAAO,CACxD,SAAU,kBACV,aAAc,cAChB,CAAU"}

package/dist/client/query/descriptor/endpointPaths.d.cts

@@ -0,0 +1,4 @@
+export declare const QueryDescriptorEndpointPaths: Readonly<{
+    readonly SNAPSHOT: "snapshot/schema";
+    readonly EVENT_STREAM: "event/schema";
+}>;

package/dist/client/query/descriptor/endpointPaths.d.ts

@@ -0,0 +1,4 @@
+export declare const QueryDescriptorEndpointPaths: Readonly<{
+    readonly SNAPSHOT: "snapshot/schema";
+    readonly EVENT_STREAM: "event/schema";
+}>;

package/dist/client/query/descriptor/endpointPaths.es.js

@@ -0,0 +1,9 @@
+//#region src/client/query/descriptor/endpointPaths.ts
+var e = Object.freeze({
+	SNAPSHOT: "snapshot/schema",
+	EVENT_STREAM: "event/schema"
+});
+//#endregion
+export { e as QueryDescriptorEndpointPaths };
+
+//# sourceMappingURL=endpointPaths.es.js.map