@spine-event-engine/server 2.0.0-snapshot.11

package/dist/entity/entity.d.ts

@@ -0,0 +1,605 @@
+import { type Message, type MessageShape } from "@bufbuild/protobuf";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import { type EntityColumn, type EntityColumnOperator, type EntityQueryMaskPath, type EntityQueryIdentifier, type EntityQueryPredicateFor, type EntityPredicate, type EntityQueryBuilder } from "@spine-event-engine/core";
+import type { EntityQueryPlan } from "@spine-event-engine/core/spi/entity-query-plan";
+import { type ConstraintViolation, type Event, type ActorContext } from "@spine-event-engine/proto";
+import type { Query } from "@spine-event-engine/proto/client";
+import type { EntityEventStorage, EntityStateHistoryStorage } from "@spine-event-engine/storage";
+import { type DescriptorMessageSchema, type EntityMetadata } from "./entity-metadata.js";
+import { type EntityTransactionCommitResult, type EntityTransactionLifecycleFlags, type EntityTransactionRejectedCommit, type EntityTransactionRollbackResult, type EntityTransactionMutator, type EntityTransactionVersionMetadata } from "./entity-transaction.js";
+type ProcessManagerQueryColumns<Schema extends DescriptorMessageSchema> = Readonly<Record<string, EntityColumn<Schema>>>;
+interface ProcessManagerQueryCapability {
+    readonly actorContext: ActorContext;
+    readonly execute: <Schema extends DescriptorMessageSchema>(plan: EntityQueryPlan, schema: Schema, query: Query) => Promise<readonly MessageShape<Schema>[]>;
+    active: boolean;
+}
+/**
+ * Binds the repository-scoped query capability for one Process Manager invocation.
+ *
+ * @internal
+ */
+export declare const processManagerQueryAccess: Readonly<{
+    bind(entity: object, execute: ProcessManagerQueryCapability["execute"], actorContext: ActorContext): () => void;
+    require(entity: object): ProcessManagerQueryCapability;
+}>;
+/**
+ * A repository-scoped, read-only Entity query issued by a Process Manager.
+ *
+ * @typeParam Schema State schema read by the query.
+ * @typeParam Columns Registered descriptor-backed columns for `Schema`.
+ */
+export declare class ProcessManagerQuery<Schema extends DescriptorMessageSchema, Columns extends ProcessManagerQueryColumns<Schema>> {
+    #private;
+    /**
+     * Creates the repository-scoped query facade.
+     *
+     * @internal
+     * @param entity Process Manager that owns this query capability.
+     * @param schema State schema read by this query.
+     * @param builder Typed query builder used to create the wire query.
+     */
+    constructor(entity: object, schema: Schema, builder: EntityQueryBuilder<Schema, Columns>);
+    /**
+     * Adds the supplied Entity IDs to the query target.
+     *
+     * @param ids Entity IDs to include.
+     * @returns This query for fluent configuration.
+     */
+    byId(...ids: readonly EntityQueryIdentifier<Schema>[]): this;
+    /**
+     * Adds a typed state predicate to the query.
+     *
+     * @param predicate Predicate evaluated against registered state columns.
+     * @returns This query for fluent configuration.
+     */
+    where<Predicate extends EntityPredicate>(predicate: EntityQueryPredicateFor<Schema, Columns, Predicate>): this;
+    /**
+     * Sets the state fields returned by the server.
+     *
+     * @param paths Generated state-field property names to include.
+     * @returns This query for fluent configuration.
+     */
+    mask(...paths: readonly EntityQueryMaskPath<Schema>[]): this;
+    /**
+     * Sets the ordering for matching states by one registered column.
+     *
+     * @param column Registered orderable column used for sorting.
+     * @param direction Optional sort direction, ascending by default.
+     * @returns This query for fluent configuration.
+     */
+    orderBy<Column extends Columns[keyof Columns]>(column: "greaterThan" extends EntityColumnOperator<Column> ? Column : never, direction?: "asc" | "desc"): this;
+    /**
+     * Sets the returned-state limit to at most 1,000 entries.
+     *
+     * @param value Maximum number of states to return.
+     * @returns This query for fluent configuration.
+     */
+    limit(value: number): this;
+    /**
+     * Reads matching state snapshots from the eventually consistent query projection.
+     *
+     * @returns Readonly state snapshots, subject to the configured result limit.
+     */
+    read(): Promise<readonly MessageShape<Schema>[]>;
+    /**
+     * Reads the first state snapshot for one Entity ID.
+     *
+     * @param id Entity ID to read.
+     * @returns The eventually consistent state snapshot, or `undefined` when it is absent.
+     */
+    findById(id: EntityQueryIdentifier<Schema>): Promise<MessageShape<Schema> | undefined>;
+    /**
+     * Reads every matching state snapshot within the configured result limit.
+     *
+     * This can be more expensive than an ID-targeted read because the projection must evaluate all
+     * matching states.
+     *
+     * @returns Readonly eventually consistent state snapshots.
+     */
+    all(): Promise<readonly MessageShape<Schema>[]>;
+}
+/**
+ * Lifecycle flags carried by a common entity shell.
+ */
+export interface EntityLifecycleFlags {
+    /**
+     * Whether the entity is archived.
+     */
+    readonly archived: boolean;
+    /**
+     * Whether the entity is deleted.
+     */
+    readonly deleted: boolean;
+}
+/**
+ * Reason a {@link TransactionalEntity} transaction-scope operation failed.
+ */
+export type EntityScopeReason = "duplicate" | "missing";
+/**
+ * Protected {@link TransactionalEntity} operation guarded by transaction scope.
+ */
+export type TransactionalEntityScopeOperation = "archiveDraft" | "commitTransaction" | "currentDraft" | "draftLifecycleFlags" | "draftVersionMetadata" | "markDraftDeleted" | "restoreDraft" | "rollbackTransaction" | "startTransaction" | "unarchiveDraft" | "tryUpdate" | "update" | "updateDraftVersionMetadata";
+/**
+ * Error thrown when a transactional entity draft helper is used outside its scope.
+ */
+export declare class TransactionalEntityScopeError extends Error {
+    /**
+     * Scope failure reason.
+     */
+    readonly reason: EntityScopeReason;
+    /**
+     * Operation rejected by the current transaction scope.
+     */
+    readonly operation: TransactionalEntityScopeOperation;
+    /**
+     * Creates a deterministic transaction-scope error.
+     *
+     * @param reason Scope failure reason.
+     * @param operation Operation rejected by the scope.
+     */
+    constructor(reason: EntityScopeReason, operation: TransactionalEntityScopeOperation);
+}
+type EntityVersionMetadataPrimitive = string | number | boolean | bigint | symbol | null | undefined;
+/**
+ * Plain snapshot data accepted as caller-owned entity version metadata.
+ */
+export type EntityVersionMetadata = EntityVersionMetadataPrimitive | readonly EntityVersionMetadata[] | object;
+type NonPlainVersion = Date | RegExp | Error | Promise<unknown> | Map<unknown, unknown> | Set<unknown> | WeakMap<object, unknown> | WeakSet<object> | ArrayBuffer | SharedArrayBuffer | DataView | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+/**
+ * Recursive type-level validator for caller-owned plain entity version metadata.
+ */
+export type PlainEntityVersionMetadata<Version> = PlainVersionAtDepth<Version, []>;
+type PlainVersionAtDepth<Version, Depth extends readonly unknown[]> = Depth["length"] extends 20 ? EntityVersionMetadata : Version extends EntityVersionMetadataPrimitive ? Version : Version extends (...args: never[]) => unknown ? never : Version extends NonPlainVersion ? never : Version extends readonly (infer Element)[] ? readonly PlainVersionAtDepth<Element, readonly [unknown, ...Depth]>[] : Version extends object ? {
+    readonly [Key in keyof Version]: PlainVersionAtDepth<Version[Key], readonly [unknown, ...Depth]>;
+} : never;
+type EntityVersionMetadataInput<Version> = [Version] extends [EntityVersionMetadata] ? [EntityVersionMetadata] extends [Version] ? Version : PlainEntityVersionMetadata<Version> : PlainEntityVersionMetadata<Version>;
+/**
+ * Initial values for constructing an {@link Entity}.
+ */
+export interface EntityOptions<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> {
+    /**
+     * Stable entity identifier owned by the caller/domain type.
+     */
+    readonly id: Id;
+    /**
+     * Generated Protobuf-ES schema describing the entity state.
+     */
+    readonly schema: Schema;
+    /**
+     * Initial entity state snapshot.
+     */
+    readonly state: MessageShape<Schema>;
+    /**
+     * Caller-owned plain version metadata snapshot.
+     */
+    readonly version: EntityVersionMetadataInput<Version>;
+    /**
+     * Initial lifecycle flags. Defaults to active, not deleted.
+     */
+    readonly lifecycle?: Partial<EntityLifecycleFlags>;
+}
+/**
+ * Public entity family marker exposed by Spine server entity base classes.
+ */
+export type EntityFamily = "aggregate" | "projection" | "process-manager";
+/**
+ * Common in-memory OOP shell for one server-side entity state.
+ *
+ * The shell exposes identity, descriptor-derived metadata, cloned state
+ * snapshots, caller-owned plain version metadata snapshots, and lifecycle flags. It does not
+ * invoke handlers, create transactions, write repositories or storage, dispatch
+ * messages, increment versions, route IDs, query read models, start buses, or
+ * mutate process-wide runtime state.
+ */
+export declare abstract class Entity<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> {
+    #private;
+    /**
+     * @hidden
+     */
+    protected static readonly spineTsEntityConstructor: true;
+    /**
+     * Creates an entity shell from caller-provided state and metadata inputs.
+     *
+     * @param options Identity, schema, state, version, and lifecycle inputs.
+     */
+    constructor(options: EntityOptions<Id, Schema, Version>);
+    /**
+     * Gets the stable entity identifier.
+     *
+     * @returns The caller-owned entity identifier.
+     */
+    get id(): Id;
+    /**
+     * Gets the generated Protobuf-ES schema describing this entity's state.
+     *
+     * @returns The generated state schema.
+     */
+    get schema(): Schema;
+    /**
+     * Gets descriptor-derived metadata for this entity's state schema.
+     *
+     * @returns The frozen descriptor metadata.
+     */
+    get metadata(): EntityMetadata<Schema>;
+    /**
+     * Gets the current entity state snapshot.
+     *
+     * @returns A cloned state snapshot.
+     */
+    get state(): MessageShape<Schema>;
+    /**
+     * Gets the caller-owned plain version metadata snapshot.
+     *
+     * @returns A validated clone of the version metadata.
+     */
+    get version(): Version;
+    /**
+     * Gets the current lifecycle flag snapshot.
+     *
+     * @returns The archived and deleted flags.
+     */
+    get lifecycle(): EntityLifecycleFlags;
+    /**
+     * Determines whether the entity is archived.
+     *
+     * @returns `true` when the entity is archived.
+     */
+    get isArchived(): boolean;
+    /**
+     * Determines whether the entity is deleted.
+     *
+     * @returns `true` when the entity is deleted.
+     */
+    get isDeleted(): boolean;
+    /**
+     * Determines whether neither lifecycle flag marks the entity inactive.
+     *
+     * @returns `true` when the entity is active.
+     */
+    get isActive(): boolean;
+    /**
+     * Determines whether lifecycle flags changed after construction.
+     *
+     * @returns `true` when lifecycle flags changed.
+     */
+    get lifecycleFlagsChanged(): boolean;
+    /**
+     * Replaces stored state from framework-owned subclass or runtime code.
+     *
+     * @param state Next entity state snapshot.
+     */
+    protected replaceState(state: MessageShape<Schema>): void;
+    /**
+     * Replaces caller-owned version metadata from framework-owned subclass or runtime code.
+     *
+     * @param version Next caller-owned version metadata.
+     */
+    protected replaceVersionMetadata(version: EntityVersionMetadataInput<Version>): void;
+    /**
+     * Replaces lifecycle flags from framework-owned subclass or runtime code.
+     *
+     * @param lifecycle Lifecycle flag changes to apply.
+     */
+    protected replaceLifecycleFlags(lifecycle: Partial<EntityLifecycleFlags>): void;
+    /**
+     * Reads the newest retained state at or before `time`.
+     *
+     * This diagnostic facility is repository-bound and is not a remote API.
+     *
+     * @param time Timestamp of the requested state snapshot.
+     * @returns The retained state snapshot, if one exists.
+     */
+    protected stateAt(time: Timestamp): Promise<Readonly<MessageShape<Schema>> | undefined>;
+    /**
+     * Reads retained states in descending version order.
+     *
+     * @param depth Maximum number of retained states to read.
+     * @returns Retained state snapshots in descending version order.
+     */
+    protected stateHistoryBackward(depth: number): Promise<readonly Readonly<MessageShape<Schema>>[]>;
+    /**
+     * Gets application-managed state-history retention.
+     *
+     * @returns State-history storage for this entity.
+     */
+    protected stateHistoryStorage(): EntityStateHistoryStorage<Id, MessageShape<Schema>>;
+}
+interface BoundEntityHistory {
+    readonly stateAt: (time: Timestamp) => Promise<unknown>;
+    readonly states: (depth: number) => Promise<readonly unknown[]>;
+    readonly events: (depth: number) => Promise<readonly Readonly<Event>[]>;
+    readonly stateMaintenance: EntityStateHistoryStorage<unknown, Message>;
+    readonly eventMaintenance: EntityEventStorage<unknown>;
+}
+interface EntityHistoryAccess {
+    bind(entity: object, binding: BoundEntityHistory): void;
+    stateAt(entity: object, time: Timestamp): Promise<unknown>;
+    states(entity: object, depth: number): Promise<readonly unknown[]>;
+    events(entity: object, depth: number): Promise<readonly Readonly<Event>[]>;
+    stateMaintenance(entity: object): EntityStateHistoryStorage<unknown, Message>;
+    eventMaintenance(entity: object): EntityEventStorage<unknown>;
+}
+/**
+ * Provides repository-only history binding.
+ *
+ * @internal
+ */
+export declare const entityHistoryAccess: EntityHistoryAccess;
+/**
+ * Common in-memory entity shell with a protected scoped transaction draft.
+ *
+ * The transaction scope is backed by {@link EntityTransaction}. Subclasses can
+ * start one active draft, mutate draft state/version/lifecycle through protected
+ * helpers, and then commit or roll back the scope. Accepted commits replace this
+ * entity's in-memory state, explicit version metadata, and lifecycle flags.
+ * Rejected commits leave the transaction active so subclass code can correct the
+ * draft or roll it back explicitly. This base does not write repositories,
+ * emit events, dispatch handlers, increment versions, or manage global
+ * transaction state.
+ */
+export declare abstract class TransactionalEntity<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> extends Entity<Id, Schema, Version> {
+    #private;
+    /**
+     * Determines whether accepted transaction state or lifecycle changes are visible.
+     *
+     * @returns `true` when the entity differs from its initial state.
+     */
+    get changed(): boolean;
+    /**
+     * Determines whether a protected transaction scope is currently active.
+     *
+     * @returns `true` when an active transaction scope exists.
+     */
+    protected isTransactionInProgress(): boolean;
+    /**
+     * Starts a protected draft transaction from the entity's current snapshots.
+     *
+     * @throws {@link TransactionalEntityScopeError} when another transaction is active.
+     */
+    protected startTransaction(): void;
+    /**
+     * Gets the current draft state snapshot.
+     *
+     * @returns A cloned current draft state snapshot.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected currentDraft(): MessageShape<Schema>;
+    /**
+     * Gets the current draft version metadata snapshot.
+     *
+     * @returns Cloned previous and draft version metadata.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected draftVersionMetadata(): EntityTransactionVersionMetadata<Version>;
+    /**
+     * Gets the current draft lifecycle flag snapshot.
+     *
+     * @returns Current archived and deleted draft flags.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected draftLifecycleFlags(): EntityTransactionLifecycleFlags;
+    /**
+     * Updates the buffered draft state in place.
+     *
+     * @param mutator Changes the active draft state.
+     * @returns A cloned snapshot of the updated draft state.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected update(mutator: EntityTransactionMutator<Schema>): MessageShape<Schema>;
+    /**
+     * Tries to update and validate a scratch draft, applying it only when valid.
+     *
+     * Validation failures return immutable constraint violations. Other errors
+     * propagate and leave the active draft unchanged.
+     *
+     * @param mutator Changes the scratch draft state.
+     * @returns Immutable constraint violations, or an empty array when the update applies.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected tryUpdate(mutator: EntityTransactionMutator<Schema>): readonly ConstraintViolation[];
+    /**
+     * Updates the buffered draft version metadata without computing version increments.
+     *
+     * @param draft Caller-owned version metadata for the active draft.
+     * @returns Cloned previous and draft version metadata.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected updateDraftVersionMetadata(draft: EntityVersionMetadataInput<Version>): EntityTransactionVersionMetadata<Version>;
+    /**
+     * Marks the buffered draft lifecycle as archived.
+     *
+     * @returns The archived and deleted draft flags.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected archiveDraft(): EntityTransactionLifecycleFlags;
+    /**
+     * Marks the buffered draft lifecycle as not archived.
+     *
+     * @returns The archived and deleted draft flags.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected unarchiveDraft(): EntityTransactionLifecycleFlags;
+    /**
+     * Marks the buffered draft lifecycle as deleted.
+     *
+     * @returns The archived and deleted draft flags.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected markDraftDeleted(): EntityTransactionLifecycleFlags;
+    /**
+     * Marks the buffered draft lifecycle as not deleted.
+     *
+     * @returns The archived and deleted draft flags.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected restoreDraft(): EntityTransactionLifecycleFlags;
+    /**
+     * Commits the active draft transaction.
+     *
+     * Accepted commits apply state, version metadata, and lifecycle flags to this
+     * entity and close the transaction. Rejected commits do not apply anything and
+     * keep the transaction active for correction or explicit rollback.
+     *
+     * @returns A cloned accepted or rejected transaction result.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected commitTransaction(): EntityTransactionCommitResult<Schema, Version>;
+    /**
+     * Rolls back the active draft without applying state, version, or lifecycle changes.
+     *
+     * @returns A cloned rollback result containing the discarded draft snapshots.
+     * @throws {@link TransactionalEntityScopeError} when no transaction is active.
+     */
+    protected rollbackTransaction(): EntityTransactionRollbackResult<Schema, Version>;
+}
+/**
+ * Framework-only transaction operations used by repository execution.
+ */
+export interface TransactionalEntityAccess {
+    /**
+     * Starts a framework-owned transaction scope for an entity.
+     *
+     * @param entity Transactional entity object to start.
+     */
+    start(entity: object): void;
+    /**
+     * Executes a framework-owned transaction commit for an entity.
+     *
+     * @param entity Transactional entity object to commit.
+     * @returns The transaction commit result.
+     */
+    commit(entity: object): EntityTransactionCommitResult<DescriptorMessageSchema>;
+    /**
+     * Executes a framework-owned transaction rollback for an entity, if possible.
+     *
+     * @param entity Transactional entity object to roll back.
+     */
+    rollback(entity: object): void;
+    /**
+     * Returns the last rejected transaction commit for this entity, if any.
+     *
+     * @param entity Transactional entity object to inspect.
+     * @returns A cloned rejected result, if one exists.
+     */
+    rejectedCommit(entity: object): EntityTransactionRejectedCommit<DescriptorMessageSchema> | undefined;
+}
+/**
+ * Exposes framework-only transaction operations for repository execution.
+ *
+ * @internal
+ */
+export declare const transactionalEntityAccess: TransactionalEntityAccess;
+/**
+ * Abstract aggregate family marker over the common transactional entity shell.
+ *
+ * This class intentionally adds only stable family identity. It does not add
+ * command dispatch, snapshots, repositories, idempotency guards, or handler
+ * invocation. Repository-bound diagnostic event-history reads are declared
+ * below for the Aggregate family.
+ */
+export declare abstract class Aggregate<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> extends TransactionalEntity<Id, Schema, Version> {
+    /**
+     * Stable server entity family identity.
+     */
+    readonly entityFamily: "aggregate";
+    /**
+     * Creates an aggregate family shell from caller-provided state and metadata inputs.
+     *
+     * @param options Identity, schema, state, version, and lifecycle inputs.
+     */
+    constructor(options: EntityOptions<Id, Schema, Version>);
+    /**
+     * Reads retained diagnostic events in descending producer-version order.
+     *
+     * @param depth Maximum number of retained events to read.
+     * @returns Retained events in descending producer-version order.
+     */
+    protected eventHistoryBackward(depth: number): Promise<readonly Readonly<Event>[]>;
+    /**
+     * Tests retained diagnostic events in descending producer-version order.
+     *
+     * @param depth Maximum number of retained events to inspect.
+     * @param predicate Tests each retained event.
+     * @returns `true` when a retained event matches the predicate.
+     */
+    protected eventHistoryContains(depth: number, predicate: (event: Readonly<Event>) => boolean): Promise<boolean>;
+    /**
+     * Gets application-managed diagnostic event-history retention.
+     *
+     * @returns Event-history storage for this entity.
+     */
+    protected eventStorage(): EntityEventStorage<Id>;
+}
+/**
+ * Abstract projection family marker over the common transactional entity shell.
+ *
+ * This class intentionally adds only stable family identity. It does not add
+ * event subscriptions, event playing, repositories, version columns, query
+ * clients, or handler invocation.
+ */
+export declare abstract class Projection<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> extends TransactionalEntity<Id, Schema, Version> {
+    /**
+     * Stable server entity family identity.
+     */
+    readonly entityFamily: "projection";
+    /**
+     * Creates a projection family shell from caller-provided state and metadata inputs.
+     *
+     * @param options Identity, schema, state, version, and lifecycle inputs.
+     */
+    constructor(options: EntityOptions<Id, Schema, Version>);
+}
+/**
+ * Abstract process manager family marker over the common transactional entity shell.
+ *
+ * This class adds a protected, handler-scoped, read-only Projection query
+ * capability. It does not add command posting, repositories, bounded-context
+ * injection, or handler invocation.
+ */
+export declare abstract class ProcessManager<Id, Schema extends DescriptorMessageSchema, Version = EntityVersionMetadata> extends TransactionalEntity<Id, Schema, Version> {
+    /**
+     * Stable server entity family identity.
+     */
+    readonly entityFamily: "process-manager";
+    /**
+     * Creates a process manager family shell from caller-provided state and metadata inputs.
+     *
+     * @param options Identity, schema, state, version, and lifecycle inputs.
+     */
+    constructor(options: EntityOptions<Id, Schema, Version>);
+    /**
+     * Reads retained diagnostic events when this repository enabled Process Manager event history.
+     *
+     * @param depth Maximum number of retained events to read.
+     * @returns Retained events in descending producer-version order.
+     */
+    protected eventHistoryBackward(depth: number): Promise<readonly Readonly<Event>[]>;
+    /**
+     * Tests retained diagnostic events when this repository enabled Process Manager event history.
+     *
+     * @param depth Maximum number of retained events to inspect.
+     * @param predicate Tests each retained event.
+     * @returns `true` when a retained event matches the predicate.
+     */
+    protected eventHistoryContains(depth: number, predicate: (event: Readonly<Event>) => boolean): Promise<boolean>;
+    /**
+     * Gets application-managed Process Manager diagnostic event-history retention.
+     *
+     * @returns Event-history storage for this Process Manager.
+     */
+    protected eventStorage(): EntityEventStorage<Id>;
+    /**
+     * Starts a typed, eventually consistent read-side query during handler execution.
+     *
+     * The repository binds this capability only while it invokes a Process Manager
+     * handler. Reads use that signal's actor and tenant; they cannot mutate state
+     * or select a different tenant.
+     *
+     * @param schema Projection state schema to query.
+     * @param columns Generated descriptor-backed columns for `schema`.
+     * @returns A read-only Entity query.
+     */
+    protected select<QuerySchema extends DescriptorMessageSchema, Columns extends ProcessManagerQueryColumns<QuerySchema>>(schema: QuerySchema, columns: Columns): ProcessManagerQuery<QuerySchema, Columns>;
+}
+export {};
+//# sourceMappingURL=entity.d.ts.map

package/dist/entity/entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/entity/entity.ts"],"names":[],"mappings":"AAcA,OAAO,EAA+B,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,KAAK,EAEV,KAAK,YAAY,EAElB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAC;AAC9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAEjG,OAAO,EAEL,KAAK,uBAAuB,EAC5B,KAAK,cAAc,EACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAEL,KAAK,6BAA6B,EAClC,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,EAC7B,KAAK,gCAAgC,EACtC,MAAM,yBAAyB,CAAC;AAQjC,KAAK,0BAA0B,CAAC,MAAM,SAAS,uBAAuB,IAAI,QAAQ,CAChF,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CACrC,CAAC;AAEF,UAAU,6BAA6B;IACrC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,SAAS,uBAAuB,EACvD,IAAI,EAAE,eAAe,EACrB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,KACT,OAAO,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC9C,MAAM,EAAE,OAAO,CAAC;CACjB;AAID;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,EAAE,QAAQ,CAAC;IAC/C,IAAI,CACF,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,6BAA6B,CAAC,SAAS,CAAC,EACjD,YAAY,EAAE,YAAY,GACzB,MAAM,IAAI,CAAC;IACd,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACxD,CA2BC,CAAC;AAEH;;;;;GAKG;AACH,qBAAa,mBAAmB,CAC9B,MAAM,SAAS,uBAAuB,EACtC,OAAO,SAAS,0BAA0B,CAAC,MAAM,CAAC;;IAMlD;;;;;;;OAOG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC;IAMxF;;;;;OAKG;IACH,IAAI,CAAC,GAAG,GAAG,EAAE,SAAS,qBAAqB,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI;IAK5D;;;;;OAKG;IACH,KAAK,CAAC,SAAS,SAAS,eAAe,EACrC,SAAS,EAAE,uBAAuB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,GAC7D,IAAI;IAKP;;;;;OAKG;IACH,IAAI,CAAC,GAAG,KAAK,EAAE,SAAS,mBAAmB,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI;IAK5D;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,SAAS,OAAO,CAAC,MAAM,OAAO,CAAC,EAC3C,MAAM,EAAE,aAAa,SAAS,oBAAoB,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,EAC3E,SAAS,GAAE,KAAK,GAAG,MAAc,GAChC,IAAI;IAKP;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ1B;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;IAUtD;;;;;OAKG;IACG,QAAQ,CAAC,EAAE,EAAE,qBAAqB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAK5F;;;;;;;OAOG;IACG,GAAG,IAAI,OAAO,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;CAGtD;AAID;;GAEG;AACH,MAAM,WAAW,oBAAoB;IAGnC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,SAAS,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACzC,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,qBAAqB,GACrB,sBAAsB,GACtB,kBAAkB,GAClB,cAAc,GACd,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,WAAW,GACX,QAAQ,GACR,4BAA4B,CAAC;AAEjC;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IAGtD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,iCAAiC,CAAC;IAEtD;;;;;OAKG;gBACS,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,iCAAiC;CAWpF;AAED,KAAK,8BAA8B,GACjC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC/B,8BAA8B,GAAG,SAAS,qBAAqB,EAAE,GAAG,MAAM,CAAC;AAE7E,KAAK,eAAe,GAChB,IAAI,GACJ,MAAM,GACN,KAAK,GACL,OAAO,CAAC,OAAO,CAAC,GAChB,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GACrB,GAAG,CAAC,OAAO,CAAC,GACZ,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GACxB,OAAO,CAAC,MAAM,CAAC,GACf,WAAW,GACX,iBAAiB,GACjB,QAAQ,GACR,SAAS,GACT,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,0BAA0B,CAAC,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAEnF,KAAK,mBAAmB,CAAC,OAAO,EAAE,KAAK,SAAS,SAAS,OAAO,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,GAC5F,qBAAqB,GACrB,OAAO,SAAS,8BAA8B,GAC5C,OAAO,GACP,OAAO,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,GAC3C,KAAK,GACL,OAAO,SAAS,eAAe,GAC7B,KAAK,GACL,OAAO,SAAS,SAAS,CAAC,MAAM,OAAO,CAAC,EAAE,GACxC,SAAS,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,EAAE,GACrE,OAAO,SAAS,MAAM,GACpB;IACE,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,GAAG,mBAAmB,CAClD,OAAO,CAAC,GAAG,CAAC,EACZ,SAAS,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,CAC7B;CACF,GACD,KAAK,CAAC;AAEpB,KAAK,0BAA0B,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,GAChF,CAAC,qBAAqB,CAAC,SAAS,CAAC,OAAO,CAAC,GACvC,OAAO,GACP,0BAA0B,CAAC,OAAO,CAAC,GACrC,0BAA0B,CAAC,OAAO,CAAC,CAAC;AAYxC;;GAEG;AACH,MAAM,WAAW,aAAa,CAC5B,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB;IAI/B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAE1E;;;;;;;;GAQG;AACH,8BAAsB,MAAM,CAC1B,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB;;IAI/B;;OAEG;IACH,0BAAkC,wBAAwB,EAAE,IAAI,CAAC;IAUjE;;;;OAIG;gBACS,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAYvD;;;;OAIG;IACH,IAAI,EAAE,IAAI,EAAE,CAEX;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,cAAc,CAAC,MAAM,CAAC,CAErC;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,YAAY,CAAC,MAAM,CAAC,CAEhC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,oBAAoB,CAKpC;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;OAIG;IACH,IAAI,qBAAqB,IAAI,OAAO,CAEnC;IAED;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,IAAI;IAIzD;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,GAAG,IAAI;IAIpF;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI;IAY/E;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAMvF;;;;;OAKG;IACH,SAAS,CAAC,oBAAoB,CAC5B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAMrD;;;;OAIG;IACH,SAAS,CAAC,mBAAmB,IAAI,yBAAyB,CAAC,EAAE,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;CAMrF;AAED,UAAU,kBAAkB;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;IAChE,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxE,QAAQ,CAAC,gBAAgB,EAAE,yBAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvE,QAAQ,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC;CACxD;AAID,UAAU,mBAAmB;IAC3B,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACxD,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;IACnE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3E,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,yBAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9E,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,mBAmBhC,CAAC;AAsBH;;;;;;;;;;;GAWG;AACH,8BAAsB,mBAAmB,CACvC,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB,CAC/B,SAAQ,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;;IAInC;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,IAAI,OAAO;IAI5C;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,IAAI,IAAI;IAiBlC;;;;;OAKG;IACH,SAAS,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,CAAC;IAI9C;;;;;OAKG;IACH,SAAS,CAAC,oBAAoB,IAAI,gCAAgC,CAAC,OAAO,CAAC;IAS3E;;;;;OAKG;IACH,SAAS,CAAC,mBAAmB,IAAI,+BAA+B;IAIhE;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC;IAIjF;;;;;;;;;OASG;IACH,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAAG,SAAS,mBAAmB,EAAE;IAI9F;;;;;;OAMG;IACH,SAAS,CAAC,0BAA0B,CAClC,KAAK,EAAE,0BAA0B,CAAC,OAAO,CAAC,GACzC,gCAAgC,CAAC,OAAO,CAAC;IAQ5C;;;;;OAKG;IACH,SAAS,CAAC,YAAY,IAAI,+BAA+B;IAIzD;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,+BAA+B;IAI3D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,+BAA+B;IAI7D;;;;;OAKG;IACH,SAAS,CAAC,YAAY,IAAI,+BAA+B;IAIzD;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,IAAI,6BAA6B,CAAC,MAAM,EAAE,OAAO,CAAC;IAuB7E;;;;;OAKG;IACH,SAAS,CAAC,mBAAmB,IAAI,+BAA+B,CAAC,MAAM,EAAE,OAAO,CAAC;CAiBlF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IAGxC;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,6BAA6B,CAAC,uBAAuB,CAAC,CAAC;IAE/E;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;;OAKG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,GACb,+BAA+B,CAAC,uBAAuB,CAAC,GAAG,SAAS,CAAC;CACzE;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,EAAE,yBA8BtC,CAAC;AAqBH;;;;;;;GAOG;AACH,8BAAsB,SAAS,CAC7B,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB,CAC/B,SAAQ,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAGhD;;OAEG;IACH,SAAiB,YAAY,EAAE,WAAW,CAAC;IAE3C;;;;OAIG;gBACS,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAKvD;;;;;OAKG;IACH,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IAIlF;;;;;;OAMG;cACa,oBAAoB,CAClC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,GAC7C,OAAO,CAAC,OAAO,CAAC;IAInB;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,kBAAkB,CAAC,EAAE,CAAC;CAGjD;AAED;;;;;;GAMG;AACH,8BAAsB,UAAU,CAC9B,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB,CAC/B,SAAQ,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAGhD;;OAEG;IACH,SAAiB,YAAY,EAAE,YAAY,CAAC;IAE5C;;;;OAIG;gBACS,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;CAIxD;AAED;;;;;;GAMG;AACH,8BAAsB,cAAc,CAClC,EAAE,EACF,MAAM,SAAS,uBAAuB,EACtC,OAAO,GAAG,qBAAqB,CAC/B,SAAQ,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAGhD;;OAEG;IACH,SAAiB,YAAY,EAAE,iBAAiB,CAAC;IAEjD;;;;OAIG;gBACS,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IAKvD;;;;;OAKG;IACH,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IAIlF;;;;;;OAMG;cACa,oBAAoB,CAClC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,GAC7C,OAAO,CAAC,OAAO,CAAC;IAInB;;;;OAIG;IACH,SAAS,CAAC,YAAY,IAAI,kBAAkB,CAAC,EAAE,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,CACd,WAAW,SAAS,uBAAuB,EAC3C,OAAO,SAAS,0BAA0B,CAAC,WAAW,CAAC,EACvD,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,mBAAmB,CAAC,WAAW,EAAE,OAAO,CAAC;CAQpF"}