@spine-event-engine/storage 2.0.0-snapshot.2 → 2.0.0-snapshot.20

package/dist/memory/in-memory-entity-history.d.ts

@@ -27,6 +27,8 @@ export declare class MemoryEntityStorageFactory {
     /**
      * Creates one scoped entity-storage handle.
      *
+     * @typeParam I Entity identifier type used by this storage scope.
+     * @typeParam S Generated Entity state message type.
      * @param input Supplies the entity storage configuration.
      * @returns Returns the scoped in-memory entity storage.
      */
@@ -34,6 +36,8 @@ export declare class MemoryEntityStorageFactory {
     /**
      * Opens the provider-owned maps used by an atomic in-memory commit.
      *
+     * @typeParam I Entity identifier type used by this storage scope.
+     * @typeParam S Generated Entity state message type.
      * @param input Supplies the Entity storage configuration.
      * @returns The compatible backend maps for this Entity scope.
      */
@@ -41,6 +45,9 @@ export declare class MemoryEntityStorageFactory {
 }
 /**
  * One scoped in-memory current/state/event storage handle.
+ *
+ * @typeParam I Entity identifier type used by this storage scope.
+ * @typeParam S Generated Entity state message type.
  */
 export declare class InMemoryEntityStorage<I, S extends Message> {
     /**
@@ -69,6 +76,9 @@ export declare class InMemoryEntityStorage<I, S extends Message> {
 }
 /**
  * Configures one in-memory entity storage scope.
+ *
+ * @typeParam I Entity identifier type used by this storage scope.
+ * @typeParam S Generated Entity state message type.
  */
 export interface EntityStorageInput<I, S extends Message> {
     /**
@@ -114,6 +124,8 @@ export interface EntityStorageInput<I, S extends Message> {
 }
 /**
  * Internal provider ID canonicalization and clone contract.
+ *
+ * @typeParam I Entity identifier type encoded by this codec.
  */
 export interface EntityIdCodec<I> {
     /**
@@ -164,6 +176,8 @@ export interface EntityBackend {
 export declare const ENTITY_SCOPE_MUTATION_KEY = "entity-storage-scope";
 /**
  * In-memory latest-state storage used by all entity families.
+ *
+ * @typeParam I Entity identifier type accepted by this adapter.
  */
 export declare class MemoryEntityRecordStorage<I> implements EntityRecordStorage<I> {
     #private;
@@ -195,7 +209,7 @@ export declare class MemoryEntityRecordStorage<I> implements EntityRecordStorage
      */
     write(record: EntityRecord): Promise<void>;
     /**
-     * Returns non-deleted current records matching the normalized plan.
+     * Returns matching current records; exhaustive plans may select deleted records.
      *
      * @param plan Supplies the normalized record-query plan.
      * @returns Resolves to ordered matching current-record entries.
@@ -204,6 +218,8 @@ export declare class MemoryEntityRecordStorage<I> implements EntityRecordStorage
 }
 /**
  * In-memory immutable diagnostic event-history adapter.
+ *
+ * @typeParam I Producer Entity identifier type used to select events.
  */
 export declare class MemoryEntityEventHistory<I> implements EntityEventHistoryPort<I> {
     #private;
@@ -251,17 +267,62 @@ export declare class MemoryEntityEventHistory<I> implements EntityEventHistoryPo
      * @returns Returns true while the adapter is open.
      */
     isOpen(): boolean;
+    /**
+     * Returns a nonempty generated event ID or throws.
+     *
+     * @param event Event inspected for its ID.
+     * @returns Present generated event ID.
+     */
     private eventIdIn;
+    /**
+     * Decodes the producer Entity ID from an event context.
+     *
+     * @param event Event whose producer is inspected.
+     * @returns Entity ID matching the configured codec.
+     */
     private producerIdIn;
+    /**
+     * Validates required event history fields and removes transient enrichment.
+     *
+     * @param event Event proposed for durable history.
+     * @returns Cloned event without context enrichment.
+     */
     private validatedEvent;
+    /**
+     * Rejects an operation after this event-history handle closes.
+     */
     private requireOpen;
+    /**
+     * Invokes the maintenance selection hook and checks that the handle remains open.
+     *
+     * @returns Completes after the selection hook.
+     */
     private afterSelection;
+    /**
+     * Reads the configured maintenance deletion chunk size.
+     *
+     * @returns Configured or default chunk size.
+     */
     private batchSize;
+    /**
+     * Reads the configured history query page size.
+     *
+     * @returns Configured or default page size.
+     */
     private pageSize;
+    /**
+     * Deletes selected event IDs in bounded maintenance chunks.
+     *
+     * @param entries Event IDs selected for deletion.
+     * @returns Completes after all chunks have been deleted.
+     */
     private deleteEntries;
 }
 /**
  * In-memory immutable, versioned state-history adapter.
+ *
+ * @typeParam I Entity identifier type used to select state records.
+ * @typeParam S Generated Entity state message type decoded from records.
  */
 export declare class InMemoryEntityHistory<I, S extends Message> implements EntityStateHistoryPort<I, S> {
     #private;
@@ -326,15 +387,67 @@ export declare class InMemoryEntityHistory<I, S extends Message> implements Enti
      * @returns Returns true while the adapter is open.
      */
     isOpen(): boolean;
+    /**
+     * Deletes selected state-record keys in bounded maintenance chunks.
+     *
+     * @param entries State-record keys selected for deletion.
+     * @returns Completes after all chunks have been deleted.
+     */
     private deleteEntries;
+    /**
+     * Builds a state-history key from an Entity ID and version.
+     *
+     * @param record Generated Entity record to identify.
+     * @returns Composite state-history key.
+     */
     private keyFor;
+    /**
+     * Decodes the Entity ID stored in a generated record.
+     *
+     * @param record Generated Entity record to inspect.
+     * @returns Entity ID matching the configured codec.
+     */
     private entityIdIn;
+    /**
+     * Checks an Entity record's ID, timestamp, and state schema before storage.
+     *
+     * @param record Generated Entity record proposed for history.
+     */
     private validateRecord;
+    /**
+     * Decodes a state whose type URL matches the configured state schema.
+     *
+     * @param record Generated Entity record containing a packed state.
+     * @returns Frozen decoded Entity state.
+     */
     private unpackState;
+    /**
+     * Rejects an operation after this state-history handle closes.
+     */
     private requireOpen;
+    /**
+     * Invokes the maintenance selection hook and checks that the handle remains open.
+     *
+     * @returns Completes after the selection hook.
+     */
     private afterSelection;
+    /**
+     * Invokes the maintenance chunk hook and checks that the handle remains open.
+     *
+     * @returns Completes after the chunk hook.
+     */
     private afterMaintenanceChunk;
+    /**
+     * Reads the configured maintenance deletion chunk size.
+     *
+     * @returns Configured or default chunk size.
+     */
     private batchSize;
+    /**
+     * Reads the configured history query page size.
+     *
+     * @returns Configured or default page size.
+     */
     private pageSize;
 }
 /**
@@ -370,6 +483,7 @@ export declare class KeyedSerialQueue {
     /**
      * Queues an operation after earlier operations with the same key finish.
      *
+     * @typeParam T Result type returned by the queued operation.
      * @param key Identifies the serialized operation sequence.
      * @param operation Supplies the operation to run.
      * @returns Resolves to the operation result.

package/dist/memory/in-memory-entity-history.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"in-memory-entity-history.d.ts","sourceRoot":"","sources":["../../src/memory/in-memory-entity-history.ts"],"names":[],"mappings":"AAcA,OAAO,EAAuC,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEvD,OAAO,EAEL,KAAK,YAAY,EAClB,MAAM,sEAAsE,CAAC;AAC9E,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,yEAAyE,CAAC;AAEjF,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,qCAAqC,CAAC;AAK7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAGjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAMxF;;GAEG;AACH,qBAAa,0BAA0B;;IAGrC;;;;OAIG;gBACS,OAAO,GAAE,sBAAqD;IAI1E;;;;;OAKG;IACH,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IAI1F;;;;;OAKG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa;CAc9E;AAED;;GAEG;AACH,qBAAa,qBAAqB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO;IAGrD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE9C;;;;;OAKG;gBACS,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa;IA4BnE;;OAEG;IACH,KAAK,IAAI,IAAI;CAId;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO;IAGtD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAE3E;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC,OAAO,2BAA2B,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;CAClG;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAG9B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC;IAE9B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAE9E;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAG5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC;CAC1C;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,yBAAyB,CAAC;AAuBhE;;GAEG;AACH,qBAAa,yBAAyB,CAAC,CAAC,CAAE,YAAW,mBAAmB,CAAC,CAAC,CAAC;;IAQzE;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC;QAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC7C,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAChF,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;QACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IASD;;;;;OAKG;IACH,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAO9C;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1C;;;;;OAKG;IACH,KAAK,CACH,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC3B,OAAO,CACR,SAAS,OAAO,6BAA6B,EAAE,oBAAoB,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CACvF;CAuCF;AAED;;GAEG;AACH,qBAAa,wBAAwB,CAAC,CAAC,CAAE,YAAW,sBAAsB,CAAC,CAAC,CAAC;;IAM3E;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,2BAA2B,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;QAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IASD;;;;;OAKG;IACG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB1C;;;;;;;OAOG;IACG,QAAQ,CACZ,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,MAAM,EACb,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC;IA+C5B;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,cAAc;IAetB,OAAO,CAAC,WAAW;YAIL,cAAc;IAK5B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,QAAQ;YAIF,aAAa;CAU5B;AAED;;GAEG;AACH,qBAAa,qBAAqB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,CAAE,YAAW,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC;;IAO9F;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QAC9D,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;QAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IAUD;;;;;OAKG;IACG,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAcjD;;;;;;;OAOG;IACG,QAAQ,CACZ,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,MAAM,EACb,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC;IAmCnC;;;;;;OAMG;IACG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA2BnE;;;;;;OAMG;IACG,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B9D;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;OAIG;IACH,MAAM,IAAI,OAAO;YAIH,aAAa;IAS3B,OAAO,CAAC,MAAM;IAUd,OAAO,CAAC,UAAU;IAWlB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,WAAW;YAIL,cAAc;YAKd,qBAAqB;IAKnC,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,QAAQ;CAGjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAGlC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,gBAAgB;;IAG3B;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAenE"}
+{"version":3,"file":"in-memory-entity-history.d.ts","sourceRoot":"","sources":["../../src/memory/in-memory-entity-history.ts"],"names":[],"mappings":"AAcA,OAAO,EAAuC,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEvD,OAAO,EAEL,KAAK,YAAY,EAClB,MAAM,sEAAsE,CAAC;AAC9E,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,yEAAyE,CAAC;AAEjF,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACvB,MAAM,qCAAqC,CAAC;AAK7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAGjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAaxF;;GAEG;AACH,qBAAa,0BAA0B;;IAGrC;;;;OAIG;gBACS,OAAO,GAAE,sBAAqD;IAI1E;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IAI1F;;;;;;;OAOG;IACH,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa;CAc9E;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO;IAGrD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE9C;;;;;OAKG;gBACS,KAAK,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,aAAa;IA4BnE;;OAEG;IACH,KAAK,IAAI,IAAI;CAId;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO;IAGtD;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;IAExD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IAE3E;;OAEG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,aAAa,CAAC,OAAO,2BAA2B,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;CAClG;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAG9B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC;IAE9B;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAE9E;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAG5B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAAC;CAC1C;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,yBAAyB,CAAC;AA8BhE;;;;GAIG;AACH,qBAAa,yBAAyB,CAAC,CAAC,CAAE,YAAW,mBAAmB,CAAC,CAAC,CAAC;;IAazE;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,MAAM,CAAC;QAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAC7C,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QAChF,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,CAAC,YAAY,CAAC,EAAE,CAAC;QACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IASD;;;;;OAKG;IACH,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAO9C;;;;;OAKG;IACH,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1C;;;;;OAKG;IACG,KAAK,CACT,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC3B,OAAO,CACR,SAAS,OAAO,6BAA6B,EAAE,oBAAoB,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,CACvF;CA4BF;AAED;;;;GAIG;AACH,qBAAa,wBAAwB,CAAC,CAAC,CAAE,YAAW,sBAAsB,CAAC,CAAC,CAAC;;IAS3E;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,2BAA2B,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACpF,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;QAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IASD;;;;;OAKG;IACG,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB1C;;;;;;;OAOG;IACG,QAAQ,CACZ,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,MAAM,EACb,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC;IA+C5B;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAOjB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAWpB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAetB;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;;;OAIG;YACW,cAAc;IAK5B;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAIjB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;;;OAKG;YACW,aAAa;CAU5B;AAED;;;;;GAKG;AACH,qBAAa,qBAAqB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,CAAE,YAAW,sBAAsB,CAAC,CAAC,EAAE,CAAC,CAAC;;IAW9F;;;;OAIG;gBACS,KAAK,EAAE;QACjB,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QAC9D,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;QACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC;QAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC;KACnC;IAUD;;;;;OAKG;IACG,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAcjD;;;;;;;OAOG;IACG,QAAQ,CACZ,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,MAAM,EACb,mBAAmB,CAAC,EAAE,MAAM,GAC3B,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC;IAmCnC;;;;;;OAMG;IACG,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA2BnE;;;;;;OAMG;IACG,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA4B9D;;;;;OAKG;IACG,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BnD;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;;OAKG;YACW,aAAa;IAS3B;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IAUd;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAWlB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAUtB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAUnB;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;;;OAIG;YACW,cAAc;IAK5B;;;;OAIG;YACW,qBAAqB;IAKnC;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAIjB;;;;OAIG;IACH,OAAO,CAAC,QAAQ;CAGjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAGlC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,gBAAgB;;IAG3B;;;;;;;OAOG;IACG,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAenE"}

package/dist/memory/in-memory-entity-history.js

@@ -40,6 +40,8 @@ export class MemoryEntityStorageFactory {
     /**
      * Creates one scoped entity-storage handle.
      *
+     * @typeParam I Entity identifier type used by this storage scope.
+     * @typeParam S Generated Entity state message type.
      * @param input Supplies the entity storage configuration.
      * @returns Returns the scoped in-memory entity storage.
      */
@@ -49,6 +51,8 @@ export class MemoryEntityStorageFactory {
     /**
      * Opens the provider-owned maps used by an atomic in-memory commit.
      *
+     * @typeParam I Entity identifier type used by this storage scope.
+     * @typeParam S Generated Entity state message type.
      * @param input Supplies the Entity storage configuration.
      * @returns The compatible backend maps for this Entity scope.
      */
@@ -62,6 +66,9 @@ export class MemoryEntityStorageFactory {
 }
 /**
  * One scoped in-memory current/state/event storage handle.
+ *
+ * @typeParam I Entity identifier type used by this storage scope.
+ * @typeParam S Generated Entity state message type.
  */
 export class InMemoryEntityStorage {
     // prettier-ignore
@@ -128,13 +135,20 @@ export const ENTITY_SCOPE_MUTATION_KEY = "entity-storage-scope";
 const EntitySnapshots = {
     // prettier-ignore
     /**
-     * Clones one entity ID with the platform structured-clone operation.
+     * Copies one entity ID with the platform structured-clone operation.
+     *
+     * @typeParam I Entity identifier type to clone.
+     * @param id Entity identifier to copy.
+     * @returns Independent identifier copy.
      */
     cloneId(id) {
         return storageHost.structuredClone(id);
     },
     /**
      * Copies an immutable latest-state record.
+     *
+     * @param record Generated current-state record to copy.
+     * @returns Independent generated record.
      */
     copyCurrent(record) {
         return clone(EntityRecordSchema, record);
@@ -142,6 +156,8 @@ const EntitySnapshots = {
 };
 /**
  * In-memory latest-state storage used by all entity families.
+ *
+ * @typeParam I Entity identifier type accepted by this adapter.
  */
 export class MemoryEntityRecordStorage {
     #idKey;
@@ -194,55 +210,46 @@ export class MemoryEntityRecordStorage {
             : this.#queue.run(ENTITY_SCOPE_MUTATION_KEY, write);
     }
     /**
-     * Returns non-deleted current records matching the normalized plan.
+     * Returns matching current records; exhaustive plans may select deleted records.
      *
      * @param plan Supplies the normalized record-query plan.
      * @returns Resolves to ordered matching current-record entries.
      */
-    query(plan) {
-        return Promise.resolve().then(() => {
-            StorageQueryPolicy.validate(plan, {
-                comparisons: ["equal", "greaterThan", "lessThan", "greaterOrEqual", "lessOrEqual"],
-                features: ["either", "nested", "order", "mask", "limit"],
-            });
-            const limit = plan.candidateLimit ?? 10_000;
-            const candidates = [];
-            for (const record of this.#records.values()) {
-                if (record.lifecycleFlags?.deleted)
-                    continue;
-                candidates.push(record);
-                if (candidates.length > limit)
-                    break;
-            }
-            if (candidates.length > limit) {
-                throw new Error(`Storage query exceeded the candidate limit of ${String(limit)}.`);
-            }
-            const entries = candidates.flatMap((record) => {
-                const copied = EntitySnapshots.copyCurrent(record);
-                const id = copied.entityId === undefined ? undefined : this.#unpackId(copied.entityId);
-                if (id === undefined)
-                    throw new Error("Entity current record ID does not match its Entity ID schema.");
-                return copied.lifecycleFlags?.deleted
-                    ? []
-                    : [
-                        {
-                            id: this.#idClone(id),
-                            record: copied,
-                            columns: new Map([
-                                ...this.#columns.map((column) => [
-                                    column.name,
-                                    column.valueIn(copied),
-                                ]),
-                            ]),
-                        },
-                    ];
-            });
-            return StorageQueryEvaluator.evaluate(entries, plan);
+    async query(plan) {
+        StorageQueryPolicy.validate(plan, {
+            comparisons: ["equal", "greaterThan", "lessThan", "greaterOrEqual", "lessOrEqual"],
+            features: ["either", "nested", "order", "limit"],
         });
+        const limit = plan.exhaustive ? Number.POSITIVE_INFINITY : (plan.candidateLimit ?? 10_000);
+        const candidates = [];
+        for (const record of this.#records.values()) {
+            if (!plan.exhaustive && record.lifecycleFlags?.deleted)
+                continue;
+            candidates.push(record);
+            if (candidates.length > limit)
+                break;
+        }
+        if (candidates.length > limit) {
+            throw new Error(`Storage query exceeded the candidate limit of ${String(limit)}.`);
+        }
+        const entries = candidates.map((record) => {
+            const copied = EntitySnapshots.copyCurrent(record);
+            const id = copied.entityId === undefined ? undefined : this.#unpackId(copied.entityId);
+            if (id === undefined)
+                throw new Error("Entity current record ID does not match its Entity ID schema.");
+            return {
+                id: this.#idClone(id),
+                record: copied,
+                columns: new Map(this.#columns.map((column) => [column.name, column.valueIn(copied)])),
+            };
+        });
+        return await Promise.resolve(StorageQueryEvaluator.evaluate(entries, plan));
     }
 }
 /**
  * In-memory immutable diagnostic event-history adapter.
+ *
+ * @typeParam I Producer Entity identifier type used to select events.
  */
 export class MemoryEntityEventHistory {
     #id;
@@ -357,12 +364,24 @@ export class MemoryEntityEventHistory {
     isOpen() {
         return this.#records.isOpen();
     }
+    /**
+     * Returns a nonempty generated event ID or throws.
+     *
+     * @param event Event inspected for its ID.
+     * @returns Present generated event ID.
+     */
     eventIdIn(event) {
         if (event.id === undefined || event.id.value.trim().length === 0) {
             throw new Error("Event history requires an event ID.");
         }
         return event.id;
     }
+    /**
+     * Decodes the producer Entity ID from an event context.
+     *
+     * @param event Event whose producer is inspected.
+     * @returns Entity ID matching the configured codec.
+     */
     producerIdIn(event) {
         const producerId = event.context?.producerId;
         if (producerId === undefined)
@@ -373,6 +392,12 @@ export class MemoryEntityEventHistory {
         }
         return entityId;
     }
+    /**
+     * Validates required event history fields and removes transient enrichment.
+     *
+     * @param event Event proposed for durable history.
+     * @returns Cloned event without context enrichment.
+     */
     validatedEvent(event) {
         this.eventIdIn(event);
         this.producerIdIn(event);
@@ -388,20 +413,44 @@ export class MemoryEntityEventHistory {
             stored.context.enrichment = undefined;
         return stored;
     }
+    /**
+     * Rejects an operation after this event-history handle closes.
+     */
     requireOpen() {
         if (!this.isOpen())
             throw new Error("Entity history storage is closed.");
     }
+    /**
+     * Invokes the maintenance selection hook and checks that the handle remains open.
+     *
+     * @returns Completes after the selection hook.
+     */
     async afterSelection() {
         await this.#maintenance?.afterSelection?.();
         this.requireOpen();
     }
+    /**
+     * Reads the configured maintenance deletion chunk size.
+     *
+     * @returns Configured or default chunk size.
+     */
     batchSize() {
         return this.#maintenance?.batchSize ?? MAINTENANCE_BATCH_SIZE;
     }
+    /**
+     * Reads the configured history query page size.
+     *
+     * @returns Configured or default page size.
+     */
     pageSize() {
         return this.#maintenance?.pageSize ?? HISTORY_PAGE_SIZE;
     }
+    /**
+     * Deletes selected event IDs in bounded maintenance chunks.
+     *
+     * @param entries Event IDs selected for deletion.
+     * @returns Completes after all chunks have been deleted.
+     */
     async deleteEntries(entries) {
         for (let start = 0; start < entries.length; start += this.batchSize()) {
             for (const entry of entries.slice(start, start + this.batchSize()))
@@ -413,6 +462,9 @@ export class MemoryEntityEventHistory {
 }
 /**
  * In-memory immutable, versioned state-history adapter.
+ *
+ * @typeParam I Entity identifier type used to select state records.
+ * @typeParam S Generated Entity state message type decoded from records.
  */
 export class InMemoryEntityHistory {
     #id;
@@ -575,6 +627,12 @@ export class InMemoryEntityHistory {
     isOpen() {
         return this.#records.isOpen();
     }
+    /**
+     * Deletes selected state-record keys in bounded maintenance chunks.
+     *
+     * @param entries State-record keys selected for deletion.
+     * @returns Completes after all chunks have been deleted.
+     */
     async deleteEntries(entries) {
         for (let start = 0; start < entries.length; start += this.batchSize()) {
             for (const entry of entries.slice(start, start + this.batchSize())) {
@@ -583,6 +641,12 @@ export class InMemoryEntityHistory {
             await this.afterMaintenanceChunk();
         }
     }
+    /**
+     * Builds a state-history key from an Entity ID and version.
+     *
+     * @param record Generated Entity record to identify.
+     * @returns Composite state-history key.
+     */
     keyFor(record) {
         if (record.entityId === undefined || record.version === undefined) {
             throw new Error("State history requires EntityRecord.entityId and EntityRecord.version.");
@@ -592,6 +656,12 @@ export class InMemoryEntityHistory {
             version: record.version.number,
         });
     }
+    /**
+     * Decodes the Entity ID stored in a generated record.
+     *
+     * @param record Generated Entity record to inspect.
+     * @returns Entity ID matching the configured codec.
+     */
     entityIdIn(record) {
         if (record.entityId === undefined) {
             throw new Error("State history requires EntityRecord.entityId.");
@@ -602,6 +672,11 @@ export class InMemoryEntityHistory {
         }
         return entityId;
     }
+    /**
+     * Checks an Entity record's ID, timestamp, and state schema before storage.
+     *
+     * @param record Generated Entity record proposed for history.
+     */
     validateRecord(record) {
         this.entityIdIn(record);
         if (record.version?.timestamp === undefined) {
@@ -609,6 +684,12 @@ export class InMemoryEntityHistory {
         }
         this.unpackState(record);
     }
+    /**
+     * Decodes a state whose type URL matches the configured state schema.
+     *
+     * @param record Generated Entity record containing a packed state.
+     * @returns Frozen decoded Entity state.
+     */
     unpackState(record) {
         const state = record.state;
         if (!state?.typeUrl.endsWith(`/${this.#stateSchema.typeName}`)) {
@@ -616,21 +697,44 @@ export class InMemoryEntityHistory {
         }
         return Object.freeze(fromBinary(this.#stateSchema, state.value));
     }
+    /**
+     * Rejects an operation after this state-history handle closes.
+     */
     requireOpen() {
         if (!this.isOpen())
             throw new Error("Entity history storage is closed.");
     }
+    /**
+     * Invokes the maintenance selection hook and checks that the handle remains open.
+     *
+     * @returns Completes after the selection hook.
+     */
     async afterSelection() {
         await this.#maintenance?.afterSelection?.();
         this.requireOpen();
     }
+    /**
+     * Invokes the maintenance chunk hook and checks that the handle remains open.
+     *
+     * @returns Completes after the chunk hook.
+     */
     async afterMaintenanceChunk() {
         await this.#maintenance?.onChunk?.();
         this.requireOpen();
     }
+    /**
+     * Reads the configured maintenance deletion chunk size.
+     *
+     * @returns Configured or default chunk size.
+     */
     batchSize() {
         return this.#maintenance?.batchSize ?? MAINTENANCE_BATCH_SIZE;
     }
+    /**
+     * Reads the configured history query page size.
+     *
+     * @returns Configured or default page size.
+     */
     pageSize() {
         return this.#maintenance?.pageSize ?? HISTORY_PAGE_SIZE;
     }
@@ -643,6 +747,7 @@ export class KeyedSerialQueue {
     /**
      * Queues an operation after earlier operations with the same key finish.
      *
+     * @typeParam T Result type returned by the queued operation.
      * @param key Identifies the serialized operation sequence.
      * @param operation Supplies the operation to run.
      * @returns Resolves to the operation result.
@@ -673,6 +778,10 @@ const HistoryOrdering = {
     // prettier-ignore
     /**
      * Compares timestamps by seconds and nanos.
+     *
+     * @param left First timestamp to compare.
+     * @param right Second timestamp to compare.
+     * @returns Signed chronological comparison.
      */
     compareTime(left, right) {
         return Number(left.seconds - right.seconds) || left.nanos - right.nanos;
@@ -682,6 +791,19 @@ const HistoryOrdering = {
  * Traverses finite RecordStorage windows with an exact stable keyset continuation.
  */
 const HistoryPaging = {
+    /**
+     * Reads finite record pages and visits each page using stable keyset continuation.
+     *
+     * @typeParam I Record identifier type used by the storage query.
+     * @typeParam R Generated record message type in each page.
+     * @param records Storage queried in pages.
+     * @param query Filters applied to every page.
+     * @param sort Stable field order used by the continuation.
+     * @param pageSize Maximum records requested per page.
+     * @param valueIn Reads an ordered field from a record.
+     * @param visit Processes a page and returns whether scanning should continue.
+     * @returns Completes after all pages or an early visitor stop.
+     */
     async scan(records, query, sort, pageSize, valueIn, visit) {
         let after;
         do {
@@ -714,6 +836,10 @@ const HistoryIdentity = {
     // prettier-ignore
     /**
      * Determines whether two generated Entity records have identical binary content.
+     *
+     * @param left First generated Entity record.
+     * @param right Second generated Entity record.
+     * @returns True when their serialized bytes match.
      */
     sameEntityRecord(left, right) {
         return CanonicalBytes.equal(toBinary(EntityRecordSchema, left), toBinary(EntityRecordSchema, right));
@@ -723,16 +849,31 @@ const HistoryIdentity = {
  * Validates bounded history requests.
  */
 const HistoryLimits = {
+    /**
+     * Rejects a history depth that is not a positive safe integer.
+     *
+     * @param depth Requested number of history entries.
+     */
     requireDepth(depth) {
         if (!Number.isSafeInteger(depth) || depth <= 0) {
             throw new Error("History depth must be a positive safe integer.");
         }
     },
+    /**
+     * Rejects an invalid optional maintenance deletion chunk size.
+     *
+     * @param batchSize Requested records per deletion chunk.
+     */
     requireBatchSize(batchSize) {
         if (batchSize !== undefined && (!Number.isSafeInteger(batchSize) || batchSize <= 0)) {
             throw new Error("In-memory maintenance batch size must be a positive safe integer.");
         }
     },
+    /**
+     * Rejects an invalid optional history query page size.
+     *
+     * @param pageSize Requested records per query page.
+     */
     requirePageSize(pageSize) {
         if (pageSize !== undefined && (!Number.isSafeInteger(pageSize) || pageSize <= 0)) {
             throw new Error("In-memory history page size must be a positive safe integer.");
@@ -748,6 +889,10 @@ const CanonicalBytes = {
     // prettier-ignore
     /**
      * Compares two durable byte sequences.
+     *
+     * @param left First byte sequence.
+     * @param right Second byte sequence.
+     * @returns True when lengths and bytes match.
      */
     equal(left, right) {
         return left.length === right.length && left.every((value, index) => value === right[index]);