@superdurable/dex 0.1.3 → 0.1.4

package/dist/src/context.d.ts

@@ -1,23 +1,103 @@
 import type { Attribute, AttributeMap } from "./persistence.js";
 import type { Channel, ChannelMap } from "./wait.js";
 import type { Codec } from "./codec.js";
+/**
+ * Exposes execution metadata and decision-local persistence operations.
+ * Dex supplies a Context to each Step or RPC handler; do not retain it afterward.
+ */
 export interface Context {
+    /** Stable application Flow ID shared across runs. */
     readonly flowId: string;
+    /** Current server-assigned run ID. */
     readonly runId: string;
+    /** UTC timestamp at which the current Flow run started. */
     readonly flowStartedAt: Date;
+    /** Current Step type and execution number encoded by Dex. */
     readonly stepExecutionId: string;
+    /** Predecessor Step execution ID, or an empty string at Flow start. */
     readonly fromStepExecutionId: string;
+    /** UTC timestamp of the first handler attempt. */
     readonly firstAttemptAt: Date;
+    /** One-based handler retry attempt number. */
     readonly attempt: number;
+    /**
+     * Reports whether a Timer made the current Wait ready.
+     * @param index - Optional zero-based Timer index; checks any Timer when omitted.
+     * @returns Whether the selected Timer fired.
+     */
     hasTimerFired(index?: number): boolean;
+    /**
+     * Reports whether `waitFor` failed before the current `execute` call.
+     * @returns Whether failure policy proceeded to execution.
+     */
     waitForMethodFailed(): boolean;
+    /**
+     * Stores process-local data for this Step execution; it is not durable.
+     * @typeParam T - Local value type.
+     * @param key - Non-empty execution-scoped key.
+     * @param value - Value retained in worker memory.
+     * @param codec - Codec used to serialize the local value when required.
+     */
     setStepExecutionLocal<T>(key: string, value: T, codec: Codec<T>): void;
+    /**
+     * Reads process-local data for this Step execution.
+     * @typeParam T - Expected local value type.
+     * @param key - Key used when storing the value.
+     * @param codec - Codec used to decode the value.
+     * @returns The value, or `undefined` after absence or worker restart.
+     */
     getStepExecutionLocal<T>(key: string, codec: Codec<T>): T | undefined;
+    /**
+     * Stages an application event in the current handler result.
+     * @typeParam T - Event payload type.
+     * @param name - Non-empty diagnostic event name.
+     * @param value - Event payload.
+     * @param codec - Payload codec.
+     */
     recordEvent<T>(name: string, value: T, codec: Codec<T>): void;
+    /**
+     * Reads a typed Attribute from decision state.
+     * @typeParam T - Attribute value type.
+     * @param attribute - Registered singleton or map definition.
+     * @param instance - Required AttributeMap instance; omitted for a singleton.
+     * @returns The decoded current value.
+     */
     getAttribute<T>(attribute: Attribute<T> | AttributeMap<T>, instance?: string): T;
+    /**
+     * Stages an Attribute write in the current decision.
+     * @typeParam T - Attribute value type.
+     * @param attribute - Registered singleton or map definition.
+     * @param value - Typed value to persist.
+     * @param instance - Required AttributeMap instance; omitted for a singleton.
+     */
     setAttribute<T>(attribute: Attribute<T> | AttributeMap<T>, value: T, instance?: string): void;
+    /**
+     * Stages deletion of an Attribute value.
+     * @param attribute - Registered singleton or map definition.
+     * @param instance - Required AttributeMap instance; omitted for a singleton.
+     */
     deleteAttribute(attribute: Attribute<unknown> | AttributeMap<unknown>, instance?: string): void;
+    /**
+     * Stages one typed Channel publication.
+     * @typeParam T - Channel element type.
+     * @param channel - Registered singleton or map definition.
+     * @param value - Value to append.
+     * @param instance - Required ChannelMap instance; omitted for a singleton.
+     */
     publish<T>(channel: Channel<T> | ChannelMap<T>, value: T, instance?: string): void;
+    /**
+     * Returns a Channel's current queued value count.
+     * @param channel - Registered singleton or map definition.
+     * @param instance - Required ChannelMap instance; omitted for a singleton.
+     * @returns Non-negative queued value count.
+     */
     channelSize(channel: Channel<unknown> | ChannelMap<unknown>, instance?: string): number;
+    /**
+     * Returns values selected by the satisfied Channel condition.
+     * @typeParam T - Channel element type.
+     * @param channel - Registered singleton or map definition.
+     * @param instance - Required ChannelMap instance; omitted for a singleton.
+     * @returns Ordered values for this Step execution.
+     */
     channelResults<T>(channel: Channel<T> | ChannelMap<T>, instance?: string): readonly T[];
 }

package/dist/src/errors.d.ts

@@ -2,43 +2,159 @@ import type { status } from "@grpc/grpc-js";
 import type { Codec } from "./codec.js";
 import type { Value } from "./gen/dex.js";
 import type { FlowStatus } from "./options.js";
+/** Indicates that an API is intentionally unavailable in the current SDK phase. */
 export declare class PhaseNotImplementedError extends Error {
 }
+/** Provides stable Dex-specific classifications beyond gRPC status codes. */
 export declare const ErrorSubStatus: Readonly<{
+    /** Dex returned no more specific classification. */
     readonly UNCATEGORIZED: "uncategorized";
+    /** A start request conflicted with an existing Flow ID. */
     readonly FLOW_ALREADY_STARTED: "flowAlreadyStarted";
+    /** No Flow exists for the requested ID. */
     readonly FLOW_NOT_EXISTS: "flowNotExists";
+    /** A nested application Worker invocation failed. */
     readonly WORKER_API_ERROR: "workerApiError";
+    /** A retryable long poll ended without observing its condition. */
     readonly LONG_POLL_TIMEOUT: "longPollTimeout";
 }>;
+/** Represents a value from {@link ErrorSubStatus}. */
 export type ErrorSubStatus = (typeof ErrorSubStatus)[keyof typeof ErrorSubStatus];
+/** Provides terminal Flow failure categories returned by Dex. */
 export declare const FlowErrorType: Readonly<{
+    /** A Step decision could not be applied. */
     readonly STEP_DECISION_FAILED: "stepDecisionFailed";
+    /** A Client-originated operation failed the Flow. */
     readonly CLIENT_API_FAILED: "clientApiFailed";
+    /** Worker dispatch or application handler execution failed. */
     readonly WORKER_API_FAILED: "workerApiFailed";
+    /** Application Flow code returned an invalid definition or result. */
     readonly INVALID_USER_FLOW_CODE: "invalidUserFlowCode";
+    /** Dex encountered an internal invariant or infrastructure failure. */
     readonly INTERNAL: "internal";
 }>;
+/** Represents a value from {@link FlowErrorType}. */
 export type FlowErrorType = (typeof FlowErrorType)[keyof typeof FlowErrorType];
-export declare class DexError extends Error {
+/** Exposes structured metadata returned by a failed FlowService operation. */
+export declare class DexServiceError extends Error {
     readonly code: status;
-    readonly subStatus: ErrorSubStatus | undefined;
+    readonly subStatus: ErrorSubStatus;
     readonly detail: string;
+    readonly operation: string;
+    readonly flowId: string | undefined;
+    /**
+     * Creates a structured service error.
+     * @param code - Outer gRPC status code.
+     * @param subStatus - Stable Dex-specific classification.
+     * @param detail - Human-readable service detail.
+     * @param operation - Client operation that failed.
+     * @param flowId - Target Flow ID, or `undefined` for service-wide calls.
+     * @param options - Standard Error construction options.
+     */
+    constructor(code: status, subStatus: ErrorSubStatus, detail: string, operation: string, flowId: string | undefined, options?: ErrorOptions);
+}
+/** Indicates that `startFlow` conflicts with an existing Flow ID. */
+export declare class FlowAlreadyStartedError extends DexServiceError {
+}
+/** Indicates that an operation targeted a Flow ID that does not exist. */
+export declare class FlowNotFoundError extends DexServiceError {
+}
+/** Indicates that an operation requires an active but already closed Flow. */
+export declare class FlowNotActiveError extends DexServiceError {
+}
+/** Exposes both outer FlowService and nested WorkerService failure details. */
+export declare class WorkerInvocationError extends DexServiceError {
+    readonly workerCode: status | undefined;
     readonly workerErrorType: string;
     readonly workerErrorDetail: string;
-    constructor(code: status, subStatus: ErrorSubStatus | undefined, detail: string, workerErrorType: string, workerErrorDetail: string, options?: ErrorOptions);
+    /**
+     * Creates an error from outer and nested Worker metadata.
+     * @param code - Outer FlowService gRPC status.
+     * @param subStatus - Dex-specific classification.
+     * @param detail - Outer human-readable detail.
+     * @param operation - Client operation that invoked the Worker.
+     * @param flowId - Target Flow ID, when available.
+     * @param workerCode - Nested Worker gRPC status, when available.
+     * @param workerErrorType - Worker-reported application error type.
+     * @param workerErrorDetail - Worker-reported human-readable detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(code: status, subStatus: ErrorSubStatus, detail: string, operation: string, flowId: string | undefined, workerCode: status | undefined, workerErrorType: string, workerErrorDetail: string, options?: ErrorOptions);
+}
+/** Indicates that an RPC could not acquire all requested Attribute locks. */
+export declare class RpcLockConflictError extends DexServiceError {
+}
+/** Indicates that a retryable long poll ended before its condition was observed. */
+export declare class LongPollTimeoutError extends DexServiceError {
+}
+/** Indicates that Registry construction found an invalid Flow definition. */
+export declare class FlowDefinitionError extends Error {
+    /**
+     * Creates a Flow definition error.
+     * @param message - Precise validation failure detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(message: string, options?: ErrorOptions);
+}
+/** Identifies a Step or RPC result that violates the SDK contract. */
+export declare class InvalidStepResultError extends FlowDefinitionError {
+    readonly flowType: string;
+    readonly stepType: string | undefined;
+    readonly method: "waitFor" | "execute" | "rpc";
+    /**
+     * Creates an invalid-handler-result error.
+     * @param flowType - Containing Flow type.
+     * @param stepType - Step type, or `undefined` for an RPC.
+     * @param method - Handler method that returned the invalid value.
+     * @param detail - Precise contract violation.
+     * @param options - Standard Error construction options.
+     */
+    constructor(flowType: string, stepType: string | undefined, method: "waitFor" | "execute" | "rpc", detail: string, options?: ErrorOptions);
 }
-export declare class LongPollTimeoutError extends Error {
-    readonly flowId: string;
-    constructor(flowId: string, options?: ErrorOptions);
+/** Reports an application value encoding, decoding, or hydration failure. */
+export declare class ValueMappingError extends Error {
+    readonly operation: "encode" | "decode" | "hydrate";
+    /**
+     * Creates a value-mapping error.
+     * @param operation - Mapping phase that failed.
+     * @param detail - Incompatible type, wire kind, or malformed payload detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(operation: "encode" | "decode" | "hydrate", detail: string, options?: ErrorOptions);
 }
+/** Reports that `waitForFlow` observed a non-successful terminal status. */
 export declare class FlowUncompletedError extends Error {
     readonly runId: string;
     readonly status: FlowStatus;
     readonly errorType: FlowErrorType | undefined;
     private readonly results;
+    /**
+     * Creates an error that keeps completed Step outputs for typed decoding.
+     * @param runId - Terminal server-assigned run ID.
+     * @param status - Non-completed terminal status.
+     * @param errorType - Terminal failure category, when available.
+     * @param message - Human-readable terminal detail.
+     * @param results - Hydrated Step outputs in server order.
+     */
     constructor(runId: string, status: FlowStatus, errorType: FlowErrorType | undefined, message: string | undefined, results: readonly Value[]);
+    /**
+     * Returns the number of retained Step completion outputs.
+     * @returns A non-negative result count.
+     */
     get resultCount(): number;
+    /**
+     * Decodes one completed Step output.
+     * @typeParam T - Expected output type.
+     * @param index - Zero-based output position.
+     * @param codec - Codec for the expected output type.
+     * @returns The decoded Step output.
+     * @throws {@link RangeError} when the index is outside the retained outputs.
+     */
     getResult<T>(index: number, codec: Codec<T>): T;
 }
+/**
+ * Creates a consistent error for an API planned in a later implementation phase.
+ * @param component - Human-readable unavailable component name.
+ * @returns A new PhaseNotImplementedError.
+ */
 export declare function laterPhase(component: string): PhaseNotImplementedError;

package/dist/src/errors.js

@@ -6,49 +6,162 @@
 //
 // SPDX-License-Identifier: LicenseRef-Super-Durable-1.0
 import { decodeValue } from "./value-mapper.js";
+/** Indicates that an API is intentionally unavailable in the current SDK phase. */
 export class PhaseNotImplementedError extends Error {
 }
+/** Provides stable Dex-specific classifications beyond gRPC status codes. */
 export const ErrorSubStatus = Object.freeze({
+    /** Dex returned no more specific classification. */
     UNCATEGORIZED: "uncategorized",
+    /** A start request conflicted with an existing Flow ID. */
     FLOW_ALREADY_STARTED: "flowAlreadyStarted",
+    /** No Flow exists for the requested ID. */
     FLOW_NOT_EXISTS: "flowNotExists",
+    /** A nested application Worker invocation failed. */
     WORKER_API_ERROR: "workerApiError",
+    /** A retryable long poll ended without observing its condition. */
     LONG_POLL_TIMEOUT: "longPollTimeout",
 });
+/** Provides terminal Flow failure categories returned by Dex. */
 export const FlowErrorType = Object.freeze({
+    /** A Step decision could not be applied. */
     STEP_DECISION_FAILED: "stepDecisionFailed",
+    /** A Client-originated operation failed the Flow. */
     CLIENT_API_FAILED: "clientApiFailed",
+    /** Worker dispatch or application handler execution failed. */
     WORKER_API_FAILED: "workerApiFailed",
+    /** Application Flow code returned an invalid definition or result. */
     INVALID_USER_FLOW_CODE: "invalidUserFlowCode",
+    /** Dex encountered an internal invariant or infrastructure failure. */
     INTERNAL: "internal",
 });
-export class DexError extends Error {
+/** Exposes structured metadata returned by a failed FlowService operation. */
+export class DexServiceError extends Error {
     code;
     subStatus;
     detail;
-    workerErrorType;
-    workerErrorDetail;
-    constructor(code, subStatus, detail, workerErrorType, workerErrorDetail, options) {
+    operation;
+    flowId;
+    /**
+     * Creates a structured service error.
+     * @param code - Outer gRPC status code.
+     * @param subStatus - Stable Dex-specific classification.
+     * @param detail - Human-readable service detail.
+     * @param operation - Client operation that failed.
+     * @param flowId - Target Flow ID, or `undefined` for service-wide calls.
+     * @param options - Standard Error construction options.
+     */
+    constructor(code, subStatus, detail, operation, flowId, options) {
         super(detail, options);
         this.code = code;
         this.subStatus = subStatus;
         this.detail = detail;
+        this.operation = operation;
+        this.flowId = flowId;
+        this.name = new.target.name;
+    }
+}
+/** Indicates that `startFlow` conflicts with an existing Flow ID. */
+export class FlowAlreadyStartedError extends DexServiceError {
+}
+/** Indicates that an operation targeted a Flow ID that does not exist. */
+export class FlowNotFoundError extends DexServiceError {
+}
+/** Indicates that an operation requires an active but already closed Flow. */
+export class FlowNotActiveError extends DexServiceError {
+}
+/** Exposes both outer FlowService and nested WorkerService failure details. */
+export class WorkerInvocationError extends DexServiceError {
+    workerCode;
+    workerErrorType;
+    workerErrorDetail;
+    /**
+     * Creates an error from outer and nested Worker metadata.
+     * @param code - Outer FlowService gRPC status.
+     * @param subStatus - Dex-specific classification.
+     * @param detail - Outer human-readable detail.
+     * @param operation - Client operation that invoked the Worker.
+     * @param flowId - Target Flow ID, when available.
+     * @param workerCode - Nested Worker gRPC status, when available.
+     * @param workerErrorType - Worker-reported application error type.
+     * @param workerErrorDetail - Worker-reported human-readable detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(code, subStatus, detail, operation, flowId, workerCode, workerErrorType, workerErrorDetail, options) {
+        super(code, subStatus, detail, operation, flowId, options);
+        this.workerCode = workerCode;
         this.workerErrorType = workerErrorType;
         this.workerErrorDetail = workerErrorDetail;
     }
 }
-export class LongPollTimeoutError extends Error {
-    flowId;
-    constructor(flowId, options) {
-        super(`Flow is still running: ${flowId}`, options);
-        this.flowId = flowId;
+/** Indicates that an RPC could not acquire all requested Attribute locks. */
+export class RpcLockConflictError extends DexServiceError {
+}
+/** Indicates that a retryable long poll ended before its condition was observed. */
+export class LongPollTimeoutError extends DexServiceError {
+}
+/** Indicates that Registry construction found an invalid Flow definition. */
+export class FlowDefinitionError extends Error {
+    /**
+     * Creates a Flow definition error.
+     * @param message - Precise validation failure detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(message, options) {
+        super(message, options);
+        this.name = new.target.name;
+    }
+}
+/** Identifies a Step or RPC result that violates the SDK contract. */
+export class InvalidStepResultError extends FlowDefinitionError {
+    flowType;
+    stepType;
+    method;
+    /**
+     * Creates an invalid-handler-result error.
+     * @param flowType - Containing Flow type.
+     * @param stepType - Step type, or `undefined` for an RPC.
+     * @param method - Handler method that returned the invalid value.
+     * @param detail - Precise contract violation.
+     * @param options - Standard Error construction options.
+     */
+    constructor(flowType, stepType, method, detail, options) {
+        const target = stepType === undefined ? `RPC in Flow ${flowType}` : `Flow ${flowType} Step ${stepType}`;
+        super(`${target} ${method} returned an invalid result: ${detail}`, options);
+        this.flowType = flowType;
+        this.stepType = stepType;
+        this.method = method;
+    }
+}
+/** Reports an application value encoding, decoding, or hydration failure. */
+export class ValueMappingError extends Error {
+    operation;
+    /**
+     * Creates a value-mapping error.
+     * @param operation - Mapping phase that failed.
+     * @param detail - Incompatible type, wire kind, or malformed payload detail.
+     * @param options - Standard Error construction options.
+     */
+    constructor(operation, detail, options) {
+        super(`Cannot ${operation} Dex Value: ${detail}`, options);
+        this.operation = operation;
+        this.name = new.target.name;
     }
 }
+/** Reports that `waitForFlow` observed a non-successful terminal status. */
 export class FlowUncompletedError extends Error {
     runId;
     status;
     errorType;
     results;
+    /**
+     * Creates an error that keeps completed Step outputs for typed decoding.
+     * @param runId - Terminal server-assigned run ID.
+     * @param status - Non-completed terminal status.
+     * @param errorType - Terminal failure category, when available.
+     * @param message - Human-readable terminal detail.
+     * @param results - Hydrated Step outputs in server order.
+     */
     constructor(runId, status, errorType, message, results) {
         super(message);
         this.runId = runId;
@@ -56,9 +169,21 @@ export class FlowUncompletedError extends Error {
         this.errorType = errorType;
         this.results = results;
     }
+    /**
+     * Returns the number of retained Step completion outputs.
+     * @returns A non-negative result count.
+     */
     get resultCount() {
         return this.results.length;
     }
+    /**
+     * Decodes one completed Step output.
+     * @typeParam T - Expected output type.
+     * @param index - Zero-based output position.
+     * @param codec - Codec for the expected output type.
+     * @returns The decoded Step output.
+     * @throws {@link RangeError} when the index is outside the retained outputs.
+     */
     getResult(index, codec) {
         const value = this.results[index];
         if (value === undefined) {
@@ -67,6 +192,11 @@ export class FlowUncompletedError extends Error {
         return decodeValue(codec, value);
     }
 }
+/**
+ * Creates a consistent error for an API planned in a later implementation phase.
+ * @param component - Human-readable unavailable component name.
+ * @returns A new PhaseNotImplementedError.
+ */
 export function laterPhase(component) {
     return new PhaseNotImplementedError(`${component} belongs to a later phase`);
 }

package/dist/src/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,EAAE;AACF,uDAAuD;AACvD,mEAAmE;AACnE,+CAA+C;AAC/C,EAAE;AACF,wDAAwD;AAOxD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,OAAO,wBAAyB,SAAQ,KAAK;CAAG;AAEtD,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,aAAa,EAAE,eAAe;IAC9B,oBAAoB,EAAE,oBAAoB;IAC1C,eAAe,EAAE,eAAe;IAChC,gBAAgB,EAAE,gBAAgB;IAClC,iBAAiB,EAAE,iBAAiB;CAC5B,CAAC,CAAC;AAIZ,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,oBAAoB,EAAE,oBAAoB;IAC1C,iBAAiB,EAAE,iBAAiB;IACpC,iBAAiB,EAAE,iBAAiB;IACpC,sBAAsB,EAAE,qBAAqB;IAC7C,QAAQ,EAAE,UAAU;CACZ,CAAC,CAAC;AAIZ,MAAM,OAAO,QAAS,SAAQ,KAAK;IAEf;IACA;IACA;IACA;IACA;IALlB,YACkB,IAAY,EACZ,SAAqC,EACrC,MAAc,EACd,eAAuB,EACvB,iBAAyB,EACzC,OAAsB;QAEtB,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAPP,SAAI,GAAJ,IAAI,CAAQ;QACZ,cAAS,GAAT,SAAS,CAA4B;QACrC,WAAM,GAAN,MAAM,CAAQ;QACd,oBAAe,GAAf,eAAe,CAAQ;QACvB,sBAAiB,GAAjB,iBAAiB,CAAQ;IAI3C,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAE3B;IADlB,YACkB,MAAc,EAC9B,OAAsB;QAEtB,KAAK,CAAC,0BAA0B,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAHnC,WAAM,GAAN,MAAM,CAAQ;IAIhC,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAE3B;IACA;IACA;IAEC;IALnB,YACkB,KAAa,EACb,MAAkB,EAClB,SAAoC,EACpD,OAA2B,EACV,OAAyB;QAE1C,KAAK,CAAC,OAAO,CAAC,CAAC;QANC,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAAY;QAClB,cAAS,GAAT,SAAS,CAA2B;QAEnC,YAAO,GAAP,OAAO,CAAkB;IAG5C,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAEM,SAAS,CAAI,KAAa,EAAE,KAAe;QAChD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,gBAAgB,KAAK,kBAAkB,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,UAAU,UAAU,CAAC,SAAiB;IAC1C,OAAO,IAAI,wBAAwB,CAAC,GAAG,SAAS,2BAA2B,CAAC,CAAC;AAC/E,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,EAAE;AACF,uDAAuD;AACvD,mEAAmE;AACnE,+CAA+C;AAC/C,EAAE;AACF,wDAAwD;AAOxD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,mFAAmF;AACnF,MAAM,OAAO,wBAAyB,SAAQ,KAAK;CAAG;AAEtD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,oDAAoD;IACpD,aAAa,EAAE,eAAe;IAC9B,2DAA2D;IAC3D,oBAAoB,EAAE,oBAAoB;IAC1C,2CAA2C;IAC3C,eAAe,EAAE,eAAe;IAChC,qDAAqD;IACrD,gBAAgB,EAAE,gBAAgB;IAClC,mEAAmE;IACnE,iBAAiB,EAAE,iBAAiB;CAC5B,CAAC,CAAC;AAKZ,iEAAiE;AACjE,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,4CAA4C;IAC5C,oBAAoB,EAAE,oBAAoB;IAC1C,qDAAqD;IACrD,iBAAiB,EAAE,iBAAiB;IACpC,+DAA+D;IAC/D,iBAAiB,EAAE,iBAAiB;IACpC,sEAAsE;IACtE,sBAAsB,EAAE,qBAAqB;IAC7C,uEAAuE;IACvE,QAAQ,EAAE,UAAU;CACZ,CAAC,CAAC;AAKZ,8EAA8E;AAC9E,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAWtB;IACA;IACA;IACA;IACA;IAdlB;;;;;;;;OAQG;IACH,YACkB,IAAY,EACZ,SAAyB,EACzB,MAAc,EACd,SAAiB,EACjB,MAA0B,EAC1C,OAAsB;QAEtB,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAPP,SAAI,GAAJ,IAAI,CAAQ;QACZ,cAAS,GAAT,SAAS,CAAgB;QACzB,WAAM,GAAN,MAAM,CAAQ;QACd,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAoB;QAI1C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;CACF;AAED,qEAAqE;AACrE,MAAM,OAAO,uBAAwB,SAAQ,eAAe;CAAG;AAE/D,0EAA0E;AAC1E,MAAM,OAAO,iBAAkB,SAAQ,eAAe;CAAG;AAEzD,8EAA8E;AAC9E,MAAM,OAAO,kBAAmB,SAAQ,eAAe;CAAG;AAE1D,+EAA+E;AAC/E,MAAM,OAAO,qBAAsB,SAAQ,eAAe;IAmBtC;IACA;IACA;IApBlB;;;;;;;;;;;OAWG;IACH,YACE,IAAY,EACZ,SAAyB,EACzB,MAAc,EACd,SAAiB,EACjB,MAA0B,EACV,UAA8B,EAC9B,eAAuB,EACvB,iBAAyB,EACzC,OAAsB;QAEtB,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAL3C,eAAU,GAAV,UAAU,CAAoB;QAC9B,oBAAe,GAAf,eAAe,CAAQ;QACvB,sBAAiB,GAAjB,iBAAiB,CAAQ;IAI3C,CAAC;CACF;AAED,6EAA6E;AAC7E,MAAM,OAAO,oBAAqB,SAAQ,eAAe;CAAG;AAE5D,oFAAoF;AACpF,MAAM,OAAO,oBAAqB,SAAQ,eAAe;CAAG;AAE5D,6EAA6E;AAC7E,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C;;;;OAIG;IACH,YAAmB,OAAe,EAAE,OAAsB;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;CACF;AAED,sEAAsE;AACtE,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAU3C;IACA;IACA;IAXlB;;;;;;;OAOG;IACH,YACkB,QAAgB,EAChB,QAA4B,EAC5B,MAAqC,EACrD,MAAc,EACd,OAAsB;QAEtB,MAAM,MAAM,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,QAAQ,SAAS,QAAQ,EAAE,CAAC;QACxG,KAAK,CAAC,GAAG,MAAM,IAAI,MAAM,gCAAgC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAP5D,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAoB;QAC5B,WAAM,GAAN,MAAM,CAA+B;IAMvD,CAAC;CACF;AAED,6EAA6E;AAC7E,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAQxB;IAPlB;;;;;OAKG;IACH,YACkB,SAA0C,EAC1D,MAAc,EACd,OAAsB;QAEtB,KAAK,CAAC,UAAU,SAAS,eAAe,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAJ3C,cAAS,GAAT,SAAS,CAAiC;QAK1D,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC9B,CAAC;CACF;AAED,4EAA4E;AAC5E,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAU3B;IACA;IACA;IAEC;IAbnB;;;;;;;OAOG;IACH,YACkB,KAAa,EACb,MAAkB,EAClB,SAAoC,EACpD,OAA2B,EACV,OAAyB;QAE1C,KAAK,CAAC,OAAO,CAAC,CAAC;QANC,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAAY;QAClB,cAAS,GAAT,SAAS,CAA2B;QAEnC,YAAO,GAAP,OAAO,CAAkB;IAG5C,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAI,KAAa,EAAE,KAAe;QAChD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,gBAAgB,KAAK,kBAAkB,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,SAAiB;IAC1C,OAAO,IAAI,wBAAwB,CAAC,GAAG,SAAS,2BAA2B,CAAC,CAAC;AAC/E,CAAC"}

package/dist/src/flow.d.ts

@@ -1,14 +1,48 @@
-import type { Attribute, AttributeMap, PersistenceSchema } from "./persistence.js";
+import { AttributeMap, type Attribute, type PersistenceSchema } from "./persistence.js";
+import { IndexType as ProtoIndexType } from "./gen/dex.js";
 import { type RegisteredRPC } from "./rpc.js";
 import { StepList, type Step } from "./step.js";
 import type { Channel, ChannelMap } from "./wait.js";
+/**
+ * Defines one durable application Flow and its registered API surface.
+ * @typeParam StartInput - Value accepted by the optional starting Step.
+ */
 export interface Flow<StartInput = void> {
+    /**
+     * Returns the protocol Flow type.
+     * @returns A non-empty Flow type unique within the Registry.
+     */
     getFlowType(): string;
+    /**
+     * Returns this Flow's Step definitions.
+     * @returns Zero or one starting Step plus all other registered Steps.
+     */
     getSteps(): StepList<StartInput>;
+    /**
+     * Returns this Flow's persistence definitions.
+     * @returns Attributes and Channels owned by this Flow. Flows without this method have none.
+     */
     getPersistenceSchema?(): PersistenceSchema;
 }
+/**
+ * Validates and stores Flow definitions shared by Client and Worker.
+ * Construction checks names, Step/RPC signatures, persistence definitions, locks,
+ * and Attribute indexes atomically.
+ *
+ * @example
+ * ```ts
+ * const orders = new OrdersFlow();
+ * const registry = new Registry([orders]);
+ * ```
+ */
 export declare class Registry {
+    /** Registered Flow instances in input order. */
     readonly flows: readonly Flow<any>[];
+    /**
+     * Creates a Registry.
+     * @param flows - Flow instances with unique Flow types.
+     * @throws {@link FlowDefinitionError} when any public definition is invalid.
+     */
     constructor(flows: readonly Flow<any>[]);
 }
 export interface RegisteredStep {
@@ -29,3 +63,4 @@ export declare function registeredRPC(registry: Registry, method: Function): Reg
 export declare function registeredFlowByName(registry: Registry, name: string): RegisteredFlow;
 export declare function registeredStep(flow: RegisteredFlow, name: string): RegisteredStep;
 export declare function registeredRPCByName(flow: RegisteredFlow, name: string): RegisteredRPC;
+export declare function registeredAttributeIndexes(registry: Registry): ReadonlyMap<string, ProtoIndexType>;