@kensio/yulin 0.43.0 → 0.45.0

package/dist/service/dynamodb/table/sim-dynamodb-table.js

@@ -1,59 +1,221 @@
-import { makeSimArn, } from "../../aws/arn.js";
+import { randomUUID } from "node:crypto";
 import { BackgroundTasks, } from "../../../util/background/background.js";
-import { DynamoDbTableCreateInput as DynamoDatabaseTableCreateInput } from "./dynamodb-table-create-input.js";
+import { SimDynamoDbTableExpiry } from "../time-to-live/sim-dynamodb-table-expiry.js";
+import { SimDynamoDbTimeToLive } from "../time-to-live/sim-dynamodb-time-to-live.js";
+import { SimDynamoDbGlobalSecondaryIndexes } from "../secondary-index/sim-dynamodb-global-secondary-indexes.js";
+import { SimDynamoDbItemCollection } from "./sim-dynamodb-item-collection.js";
+import { SimDynamoDbItemKey } from "./sim-dynamodb-item-key.js";
+import { describeSimDynamoDbTable } from "./sim-dynamodb-table-description.js";
+import { SimDynamoDbTableItems } from "./sim-dynamodb-table-items.js";
+import { SimDynamoDbTableLifecycle } from "./sim-dynamodb-table-lifecycle.js";
+import { SimDynamoDbTableScan } from "./sim-dynamodb-table-scan.js";
+import { SimDynamoDbTableTags } from "./sim-dynamodb-table-tags.js";
 /**
- * Simulated DynamoDB Table.
+ * One simulated DynamoDB Table.
+ *
+ * A table is built from values a request has already been checked against,
+ * rather than from the request itself, so anything that can produce those
+ * values can make one. That is what lets CloudFormation create a table without
+ * a CreateTable command to hand it.
  */
 export class SimDynamoDbTable {
     creationDateTime;
     tableName;
     arn;
-    background;
-    #keySchema;
-    #status = "CREATING";
-    items = new Map();
+    tableId;
+    keySchema;
+    attributeDefinitions;
+    billing;
+    /**
+     * The global secondary indexes this table carries.
+     *
+     * Which items an index holds is worked out when it is read rather than kept
+     * up to date on every write, so nothing here is more than what the index was
+     * declared as.
+     */
+    indexes;
+    tableClass;
+    deletionProtectionEnabled;
+    /**
+     * The tags this table carries.
+     *
+     * Tags are the table's own state rather than something a command holds, so
+     * TagResource, UntagResource and ListTagsOfResource all work through this.
+     */
+    tags;
+    items = new SimDynamoDbTableItems();
+    itemKey;
+    lifecycle;
+    timeToLive;
+    expiry;
     constructor(properties) {
-        const { tableCommand, arn = makeSimDynamoDbTableArn(), background = new BackgroundTasks(), } = properties;
-        const tableInput = new DynamoDatabaseTableCreateInput(tableCommand);
-        this.arn = arn;
-        this.background = background;
-        this.tableName = tableInput.tableName();
+        const { name, keySchema, attributeDefinitions, billing, indexes = SimDynamoDbGlobalSecondaryIndexes.none(), deletionProtectionEnabled = false, tags = SimDynamoDbTableTags.fromInput([]), background = new BackgroundTasks(), } = properties;
+        this.tableName = name.value;
+        this.arn = properties.arn;
+        this.tableId = randomUUID();
+        this.keySchema = keySchema;
+        this.attributeDefinitions = attributeDefinitions;
+        this.billing = billing;
+        this.indexes = indexes;
+        this.tableClass = properties.tableClass;
+        this.deletionProtectionEnabled = deletionProtectionEnabled;
+        this.tags = tags;
+        this.itemKey = new SimDynamoDbItemKey(keySchema, attributeDefinitions);
+        this.lifecycle = new SimDynamoDbTableLifecycle({
+            tableName: name.value,
+            deletionProtectionEnabled,
+        });
+        this.timeToLive = new SimDynamoDbTimeToLive(name.value);
+        this.expiry = new SimDynamoDbTableExpiry({
+            items: this.items,
+            timeToLive: this.timeToLive,
+            background,
+        });
         this.creationDateTime = background.now();
-        this.#keySchema = tableInput.keySchema();
+    }
+    /**
+     * Get the current table status.
+     */
+    get status() {
+        return this.lifecycle.status;
     }
     /**
      * Simulate the table entering ACTIVE status.
      */
     activate() {
-        this.#status = "ACTIVE";
+        this.lifecycle.activate();
         return Promise.resolve();
     }
     /**
-     * Get the current table status.
+     * Refuse a delete this table is not in a state to take.
      */
-    get status() {
-        return this.#status;
+    assertDeletable() {
+        this.lifecycle.assertDeletable();
+    }
+    /**
+     * Simulate the table entering DELETING status.
+     *
+     * The table is still there to describe while it is deleting, as it is on
+     * AWS. What removes it is the background task the delete schedules.
+     */
+    beginDeletion() {
+        this.lifecycle.beginDeletion();
     }
     /**
-     * Put an item into the table.
+     * Describe this table the way DynamoDB reports it.
+     */
+    toDescription() {
+        return describeSimDynamoDbTable(this);
+    }
+    /**
+     * Put an item into the table, and answer with whatever it replaced.
+     *
+     * The item is there by the time this returns. Real DynamoDB acknowledges a
+     * write once it is durable, so a read that follows it finds it.
      */
     putItem(item) {
-        const keyString = this.#keySchema.makeItemKey(item);
-        this.background.schedule(() => {
-            this.items.set(keyString, item);
-            return Promise.resolve();
-        });
+        const key = this.itemKey.of(item);
+        // An item need not carry an index's key attributes, since a global
+        // secondary index is sparse. Carrying one as a type the index did not
+        // declare is refused, since the index could never hold it.
+        this.indexes.assertItemKeyTypes(item, this.attributeDefinitions);
+        const replaced = this.items.put(key, item);
+        this.expiry.scheduleFor(key, item);
+        return replaced;
+    }
+    /**
+     * Take an UpdateTimeToLive on this table.
+     *
+     * Switching it on reaches the items already there as well as the ones written
+     * afterwards, since their TTL attributes were only inert while it was off.
+     */
+    updateTimeToLive(specification, at) {
+        this.timeToLive.update(specification, at);
+        this.expiry.scheduleForAll();
+    }
+    /**
+     * Finish an UpdateTimeToLive, moving it off ENABLING or DISABLING.
+     */
+    settleTimeToLive() {
+        this.timeToLive.settle();
         return Promise.resolve();
     }
-}
-/**
- * Generate a fake simulated DynamoDB Table ARN.
- */
-export function makeSimDynamoDbTableArn(overrides) {
-    return makeSimArn({
-        service: "dynamodb",
-        resourceType: "table",
-        ...overrides,
-    });
+    /**
+     * Describe this table's time to live the way DynamoDB reports it.
+     */
+    timeToLiveDescription() {
+        return this.timeToLive.description();
+    }
+    /**
+     * The item already stored under the same primary key as this one.
+     *
+     * A conditional write is checked against what is there before it, and what is
+     * there is found by the key inside the item rather than by a Key of its own.
+     * The key is read the same way a write reads it, so an item that could not be
+     * written does not quietly find nothing here either.
+     */
+    itemUnder(item) {
+        return this.items.get(this.itemKey.of(item));
+    }
+    /**
+     * The primary key an item is stored under, as this table marshals it.
+     *
+     * A batch write tells two operations on the same item apart by comparing
+     * these, which is why the key is readable rather than only usable. Reading it
+     * checks the item against the key schema, so a key a write would refuse is
+     * refused here too.
+     */
+    keyOfItem(item) {
+        return this.itemKey.of(item);
+    }
+    /**
+     * The primary key a request's Key names, as this table marshals it.
+     */
+    keyOfKey(key) {
+        return this.itemKey.ofKey(key);
+    }
+    /**
+     * Read the item a primary key names, if the table holds one.
+     *
+     * Every write has landed by the time it returns, so this reads the latest
+     * one. That is what real DynamoDB gives a strongly consistent read.
+     */
+    getItem(key) {
+        return this.items.get(this.itemKey.ofKey(key));
+    }
+    /**
+     * Remove the item a primary key names, and answer with whatever was removed.
+     */
+    deleteItem(key) {
+        return this.items.remove(this.itemKey.ofKey(key));
+    }
+    /**
+     * The items a key condition names, in sort key order.
+     *
+     * A Query reads a whole item collection rather than one key, so the items are
+     * reachable together as well as one at a time. The ordering belongs to the
+     * collection rather than to the command that reads it.
+     */
+    itemCollection(keyCondition) {
+        return new SimDynamoDbItemCollection({
+            items: this.items.entries().values(),
+            keySchema: this.keySchema,
+            keyCondition,
+        });
+    }
+    /**
+     * Every item this table holds, in the order a Scan reads them.
+     *
+     * A Scan needs no key knowledge, so unlike an item collection this is the
+     * whole table. The order and the parallel scan segments both belong to the
+     * scan rather than to the command that reads it.
+     */
+    scan() {
+        return new SimDynamoDbTableScan({
+            items: this.items.entries().values(),
+            keySchema: this.keySchema,
+            itemKey: this.itemKey,
+        });
+    }
 }
 //# sourceMappingURL=sim-dynamodb-table.js.map

package/dist/service/dynamodb/table/sim-dynamodb-table.js.map

@@ -1 +1 @@
-{"version":3,"file":"sim-dynamodb-table.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/table/sim-dynamodb-table.ts"],"names":[],"mappings":"AACA,OAAO,EACL,UAAU,GAGX,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAEL,eAAe,GAChB,MAAM,wCAAwC,CAAC;AAKhD,OAAO,EAAE,wBAAwB,IAAI,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAU9G;;GAEG;AACH,MAAM,OAAO,gBAAgB;IACX,gBAAgB,CAAO;IAEvB,SAAS,CAAoB;IAC7B,GAAG,CAAS;IAEX,UAAU,CAAsB;IACxC,UAAU,CAA0B;IAC7C,OAAO,GAAiC,UAAU,CAAC;IAElC,KAAK,GAAG,IAAI,GAAG,EAA8B,CAAC;IAE/D,YAAY,UAA4C;QACtD,MAAM,EACJ,YAAY,EACZ,GAAG,GAAG,uBAAuB,EAAE,EAC/B,UAAU,GAAG,IAAI,eAAe,EAAE,GACnC,GAAG,UAAU,CAAC;QACf,MAAM,UAAU,GAAG,IAAI,8BAA8B,CAAC,YAAY,CAAC,CAAC;QAEpE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;QACxC,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;QACxB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,IAAwB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAChC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,SAA0E;IAE1E,OAAO,UAAU,CAAC;QAChB,OAAO,EAAE,UAAU;QACnB,YAAY,EAAE,OAAO;QACrB,GAAG,SAAS;KACb,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"sim-dynamodb-table.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/table/sim-dynamodb-table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAEL,eAAe,GAChB,MAAM,wCAAwC,CAAC;AAQhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,8CAA8C,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8CAA8C,CAAC;AAGrF,OAAO,EAAE,iCAAiC,EAAE,MAAM,6DAA6D,CAAC;AAChH,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAsBpE;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAgB;IACX,gBAAgB,CAAO;IACvB,SAAS,CAAoB;IAC7B,GAAG,CAAS;IACZ,OAAO,CAAS;IAChB,SAAS,CAAuB;IAChC,oBAAoB,CAAkC;IACtD,OAAO,CAA0B;IAEjD;;;;;;OAMG;IACa,OAAO,CAAoC;IAE3C,UAAU,CAAoC;IAC9C,yBAAyB,CAAU;IAEnD;;;;;OAKG;IACa,IAAI,CAAuB;IAE1B,KAAK,GAAG,IAAI,qBAAqB,EAAE,CAAC;IACpC,OAAO,CAAqB;IAC5B,SAAS,CAA4B;IACrC,UAAU,CAAwB;IAClC,MAAM,CAAyB;IAEhD,YAAY,UAAsC;QAChD,MAAM,EACJ,IAAI,EACJ,SAAS,EACT,oBAAoB,EACpB,OAAO,EACP,OAAO,GAAG,iCAAiC,CAAC,IAAI,EAAE,EAClD,yBAAyB,GAAG,KAAK,EACjC,IAAI,GAAG,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC,EACzC,UAAU,GAAG,IAAI,eAAe,EAAE,GACnC,GAAG,UAAU,CAAC;QAEf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,UAAU,EAAE,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAkB,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,IAAI,yBAAyB,CAAC;YAC7C,SAAS,EAAE,IAAI,CAAC,KAAK;YACrB,yBAAyB;SAC1B,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAsB,CAAC;YACvC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU;SACX,CAAC,CAAC;QACH,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,eAAe;QACb,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,IAAqB;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAElC,mEAAmE;QACnE,sEAAsE;QACtE,2DAA2D;QAC3D,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAEnC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CACd,aAAiD,EACjD,EAAQ;QAER,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAEzB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,IAAqB;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,IAAqB;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,GAAoB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,GAAoB;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,GAAoB;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CACnB,YAAqC;QAErC,OAAO,IAAI,yBAAyB,CAAC;YACnC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE;YACpC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,IAAI;QACT,OAAO,IAAI,oBAAoB,CAAC;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE;YACpC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.d.ts

@@ -0,0 +1,31 @@
+import { AsyncMappedFactory } from "@kensio/part-factory";
+import type { SimAws } from "../../aws/sim-aws.js";
+import type { SimDynamoDbTable } from "../table/sim-dynamodb-table.js";
+/**
+ * What a test asks for when it wants a table that expires its items.
+ */
+export interface SimDynamoDbExpiringTableInput {
+    readonly tableName: string;
+    readonly partitionKeyName: string;
+    /**
+     * The attribute items expire by, holding epoch seconds in a Number.
+     */
+    readonly attributeName: string;
+}
+/**
+ * Creates a table with time to live already switched on.
+ *
+ * The table went through CreateTable and UpdateTimeToLive, so it is the table
+ * an application would have rather than one built around the commands. Both
+ * have settled by the time this answers: a test asking for an expiring table is
+ * asking for one that is already ENABLED.
+ *
+ * ```typescript
+ * const table = await simDynamoDbExpiringTableFactory.make(
+ *   { tableName: "Sessions", attributeName: "expiresAt" },
+ *   simAws,
+ * );
+ * ```
+ */
+export declare const simDynamoDbExpiringTableFactory: AsyncMappedFactory<SimDynamoDbExpiringTableInput, SimDynamoDbTable, SimAws>;
+//# sourceMappingURL=sim-dynamodb-expiring-table.factory.d.ts.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expiring-table.factory.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,+BAA+B,6EAgC3C,CAAC"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.js

@@ -0,0 +1,39 @@
+import { AsyncMappedFactory } from "@kensio/part-factory";
+import { simDynamoDbCreatedTableFactory } from "../table/sim-dynamodb-created-table.factory.js";
+/**
+ * Creates a table with time to live already switched on.
+ *
+ * The table went through CreateTable and UpdateTimeToLive, so it is the table
+ * an application would have rather than one built around the commands. Both
+ * have settled by the time this answers: a test asking for an expiring table is
+ * asking for one that is already ENABLED.
+ *
+ * ```typescript
+ * const table = await simDynamoDbExpiringTableFactory.make(
+ *   { tableName: "Sessions", attributeName: "expiresAt" },
+ *   simAws,
+ * );
+ * ```
+ */
+export const simDynamoDbExpiringTableFactory = new AsyncMappedFactory(() => ({
+    tableName: "Sessions",
+    partitionKeyName: "sessionId",
+    attributeName: "expiresAt",
+}), async (input, simAws) => {
+    const table = await simDynamoDbCreatedTableFactory.make({
+        tableName: input.tableName,
+        partitionKeyName: input.partitionKeyName,
+    }, simAws);
+    await simAws.dynamoDb().updateTimeToLive({
+        input: {
+            TableName: input.tableName,
+            TimeToLiveSpecification: {
+                Enabled: true,
+                AttributeName: input.attributeName,
+            },
+        },
+    });
+    await simAws.backgroundTasksComplete();
+    return table;
+});
+//# sourceMappingURL=sim-dynamodb-expiring-table.factory.js.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expiring-table.factory.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-expiring-table.factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,8BAA8B,EAAE,MAAM,gDAAgD,CAAC;AAgBhG;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,IAAI,kBAAkB,CAKnE,GAAG,EAAE,CAAC,CAAC;IACL,SAAS,EAAE,UAAU;IACrB,gBAAgB,EAAE,WAAW;IAC7B,aAAa,EAAE,WAAW;CAC3B,CAAC,EACF,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;IACtB,MAAM,KAAK,GAAG,MAAM,8BAA8B,CAAC,IAAI,CACrD;QACE,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;KACzC,EACD,MAAM,CACP,CAAC;IAEF,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,gBAAgB,CAAC;QACvC,KAAK,EAAE;YACL,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,uBAAuB,EAAE;gBACvB,OAAO,EAAE,IAAI;gBACb,aAAa,EAAE,KAAK,CAAC,aAAa;aACnC;SACF;KACF,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,uBAAuB,EAAE,CAAC;IAEvC,OAAO,KAAK,CAAC;AACf,CAAC,CACF,CAAC"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.d.ts

@@ -0,0 +1,12 @@
+import type { SimDynamoDbItem } from "../item/sim-dynamodb-item.js";
+/**
+ * When an item's TTL attribute says it should be deleted, if it says so at all.
+ *
+ * The attribute holds epoch seconds in a Number. An item without the attribute,
+ * or holding a String or anything else, never expires, and that is not an
+ * error: real DynamoDB skips it rather than refusing it. A number too large to
+ * stand for an instant is skipped the same way, and so is one more than five
+ * years before `at`.
+ */
+export declare function simDynamoDbItemDeletionInstant(item: SimDynamoDbItem, attributeName: string, at: Date): Date | undefined;
+//# sourceMappingURL=sim-dynamodb-item-expiry.d.ts.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-item-expiry.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAoCpE;;;;;;;;GAQG;AACH,wBAAgB,8BAA8B,CAC5C,IAAI,EAAE,eAAe,EACrB,aAAa,EAAE,MAAM,EACrB,EAAE,EAAE,IAAI,GACP,IAAI,GAAG,SAAS,CAuBlB"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.js

@@ -0,0 +1,59 @@
+/**
+ * How long after its TTL timestamp an expired item is deleted.
+ *
+ * Real DynamoDB does not delete on the timestamp. It marks the item expired and
+ * typically deletes it within 48 hours, and reads keep returning it until then,
+ * which is why the AWS docs tell you to filter expired items on read rather
+ * than trust they have gone.
+ *
+ * AWS promises a window rather than an instant, so a simulation has to pick a
+ * point in it. This picks the far end, because that is the longest an expired
+ * item can still be readable and so is the behaviour an application has to cope
+ * with. A test can rely on an item surviving its TTL timestamp, and on it being
+ * gone once the window has passed. It should not rely on one still being there
+ * partway through the window: real DynamoDB may well have collected it by then.
+ */
+const deletionWindowMilliseconds = 48 * 60 * 60 * 1000;
+/**
+ * How far back a TTL timestamp can be and still be acted on.
+ *
+ * Real DynamoDB leaves an item alone when its timestamp is more than five years
+ * in the past. The rule guards against a malformed value: epoch milliseconds
+ * written where epoch seconds belong lands far in the future, and the reverse
+ * mistake lands far in the past, and neither is what the application meant.
+ *
+ * Five calendar years vary in length, so this is 1825 days.
+ */
+const eligibilityWindowMilliseconds = 5 * 365 * 24 * 60 * 60 * 1000;
+/**
+ * The furthest instant a JavaScript Date reaches.
+ */
+const greatestInstantMilliseconds = 8_640_000_000_000_000;
+/**
+ * When an item's TTL attribute says it should be deleted, if it says so at all.
+ *
+ * The attribute holds epoch seconds in a Number. An item without the attribute,
+ * or holding a String or anything else, never expires, and that is not an
+ * error: real DynamoDB skips it rather than refusing it. A number too large to
+ * stand for an instant is skipped the same way, and so is one more than five
+ * years before `at`.
+ */
+export function simDynamoDbItemDeletionInstant(item, attributeName, at) {
+    const value = item.attribute(attributeName);
+    if (value?.kind !== "N") {
+        return undefined;
+    }
+    // Always a finite number: DynamoDB refuses anything outside its own range on
+    // the way in, which is far inside what a JavaScript number holds.
+    const seconds = Number(value.number.text);
+    const expiry = seconds * 1000;
+    if (at.getTime() - expiry > eligibilityWindowMilliseconds) {
+        return undefined;
+    }
+    const instant = expiry + deletionWindowMilliseconds;
+    if (Math.abs(instant) > greatestInstantMilliseconds) {
+        return undefined;
+    }
+    return new Date(instant);
+}
+//# sourceMappingURL=sim-dynamodb-item-expiry.js.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-item-expiry.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-item-expiry.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,MAAM,0BAA0B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,6BAA6B,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpE;;GAEG;AACH,MAAM,2BAA2B,GAAG,qBAAqB,CAAC;AAE1D;;;;;;;;GAQG;AACH,MAAM,UAAU,8BAA8B,CAC5C,IAAqB,EACrB,aAAqB,EACrB,EAAQ;IAER,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAE5C,IAAI,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,CAAC;QACxB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,6EAA6E;IAC7E,kEAAkE;IAClE,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAE9B,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,MAAM,GAAG,6BAA6B,EAAE,CAAC;QAC1D,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,GAAG,0BAA0B,CAAC;IAEpD,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,2BAA2B,EAAE,CAAC;QACpD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.d.ts

@@ -0,0 +1,55 @@
+import type { BackgroundScheduler } from "../../../util/background/background.js";
+import type { SimDynamoDbItem } from "../item/sim-dynamodb-item.js";
+import type { SimDynamoDbTableItems } from "../table/sim-dynamodb-table-items.js";
+import type { SimDynamoDbTimeToLive } from "./sim-dynamodb-time-to-live.js";
+interface SimDynamoDbTableExpiryProperties {
+    readonly items: SimDynamoDbTableItems;
+    readonly timeToLive: SimDynamoDbTimeToLive;
+    readonly background: BackgroundScheduler;
+}
+/**
+ * Removes a table's items once their time to live has run out.
+ *
+ * The removal is scheduled on the simulation's clock rather than the host's, so
+ * moving simulated time past an item's deletion window is what takes it away.
+ * That is what lets one `advanceBy` expire a table's sessions alongside
+ * whatever else the same advance causes elsewhere in the simulation, rather
+ * than the test having to ask for the expiry separately.
+ */
+export declare class SimDynamoDbTableExpiry {
+    private readonly items;
+    private readonly timeToLive;
+    private readonly background;
+    constructor(properties: SimDynamoDbTableExpiryProperties);
+    /**
+     * Arrange for an item to be gone once its deletion window runs out.
+     *
+     * An item whose window has already passed is scheduled for an instant behind
+     * the clock, which nothing dispatches until the clock next moves. So a read
+     * straight after writing an already expired item still finds it, as it would
+     * on AWS.
+     *
+     * The five year eligibility rule is read against the time of the write, which
+     * is when real DynamoDB would first look at the item.
+     */
+    scheduleFor(key: string, item: SimDynamoDbItem): void;
+    /**
+     * Arrange for every item already on the table to expire.
+     *
+     * Switching time to live on gives meaning to TTL attributes that were inert
+     * while it was off, so the items that already carry one are scheduled too.
+     */
+    scheduleForAll(): void;
+    /**
+     * Remove an item, if it is still the expired item that was scheduled.
+     *
+     * The deletion instant is worked out again from whatever is under the key
+     * now, against the time to live the table has now. One re-check covers
+     * everything that should call the removal off: the item was deleted,
+     * overwritten with a later TTL, or had its TTL attribute removed or changed
+     * to something that is not a Number, or time to live was switched off.
+     */
+    private removeIfExpired;
+}
+export {};
+//# sourceMappingURL=sim-dynamodb-table-expiry.d.ts.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-table-expiry.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAElF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E,UAAU,gCAAgC;IACxC,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;IAC3C,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;CAC1C;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwB;IAC9C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAwB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IAEjD,YAAY,UAAU,EAAE,gCAAgC,EAIvD;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,IAAI,CAsBpD;IAED;;;;;OAKG;IACH,cAAc,IAAI,IAAI,CAIrB;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,eAAe;CAsBxB"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.js

@@ -0,0 +1,82 @@
+import { simDynamoDbItemDeletionInstant } from "./sim-dynamodb-item-expiry.js";
+/**
+ * Removes a table's items once their time to live has run out.
+ *
+ * The removal is scheduled on the simulation's clock rather than the host's, so
+ * moving simulated time past an item's deletion window is what takes it away.
+ * That is what lets one `advanceBy` expire a table's sessions alongside
+ * whatever else the same advance causes elsewhere in the simulation, rather
+ * than the test having to ask for the expiry separately.
+ */
+export class SimDynamoDbTableExpiry {
+    items;
+    timeToLive;
+    background;
+    constructor(properties) {
+        this.items = properties.items;
+        this.timeToLive = properties.timeToLive;
+        this.background = properties.background;
+    }
+    /**
+     * Arrange for an item to be gone once its deletion window runs out.
+     *
+     * An item whose window has already passed is scheduled for an instant behind
+     * the clock, which nothing dispatches until the clock next moves. So a read
+     * straight after writing an already expired item still finds it, as it would
+     * on AWS.
+     *
+     * The five year eligibility rule is read against the time of the write, which
+     * is when real DynamoDB would first look at the item.
+     */
+    scheduleFor(key, item) {
+        const attributeName = this.timeToLive.enabledAttributeName();
+        if (attributeName === undefined) {
+            return;
+        }
+        const at = simDynamoDbItemDeletionInstant(item, attributeName, this.background.now());
+        if (at === undefined) {
+            return;
+        }
+        this.background.scheduleAt(at, () => {
+            this.removeIfExpired(key);
+            return Promise.resolve();
+        });
+    }
+    /**
+     * Arrange for every item already on the table to expire.
+     *
+     * Switching time to live on gives meaning to TTL attributes that were inert
+     * while it was off, so the items that already carry one are scheduled too.
+     */
+    scheduleForAll() {
+        for (const [key, item] of this.items.entries()) {
+            this.scheduleFor(key, item);
+        }
+    }
+    /**
+     * Remove an item, if it is still the expired item that was scheduled.
+     *
+     * The deletion instant is worked out again from whatever is under the key
+     * now, against the time to live the table has now. One re-check covers
+     * everything that should call the removal off: the item was deleted,
+     * overwritten with a later TTL, or had its TTL attribute removed or changed
+     * to something that is not a Number, or time to live was switched off.
+     */
+    removeIfExpired(key) {
+        const attributeName = this.timeToLive.enabledAttributeName();
+        if (attributeName === undefined) {
+            return;
+        }
+        const item = this.items.get(key);
+        if (item === undefined) {
+            return;
+        }
+        const now = this.background.now();
+        const at = simDynamoDbItemDeletionInstant(item, attributeName, now);
+        if (at === undefined || at.getTime() > now.getTime()) {
+            return;
+        }
+        this.items.remove(key);
+    }
+}
+//# sourceMappingURL=sim-dynamodb-table-expiry.js.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-table-expiry.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-table-expiry.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAS/E;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IAChB,KAAK,CAAwB;IAC7B,UAAU,CAAwB;IAClC,UAAU,CAAsB;IAEjD,YAAY,UAA4C;QACtD,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,GAAW,EAAE,IAAqB;QAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;QAE7D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,EAAE,GAAG,8BAA8B,CACvC,IAAI,EACJ,aAAa,EACb,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CACtB,CAAC;QAEF,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,EAAE,GAAkB,EAAE;YACjD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;YAE1B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACZ,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/C,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACK,eAAe,CAAC,GAAW;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC;QAE7D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,8BAA8B,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;QAEpE,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,OAAO;QACT,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;CACF"}

package/dist/service/dynamodb/time-to-live/sim-dynamodb-time-to-live-specification.d.ts

@@ -0,0 +1,26 @@
+import type { SimDynamoDbTimeToLiveSpecificationInput } from "../command/time-to-live/time-to-live.types.js";
+/**
+ * What an UpdateTimeToLive request asks for, once it has been checked.
+ *
+ * Real DynamoDB requires both fields, including when switching time to live
+ * off, so a request naming no attribute is refused rather than read as one
+ * asking to leave the attribute as it was.
+ */
+export declare class SimDynamoDbTimeToLiveSpecification {
+    readonly attributeName: string;
+    readonly enabled: boolean;
+    private constructor();
+    /**
+     * Read the specification a request carries.
+     */
+    static fromInput(input: SimDynamoDbTimeToLiveSpecificationInput | undefined): SimDynamoDbTimeToLiveSpecification;
+    /**
+     * The attribute items are expired by.
+     */
+    private static readAttributeName;
+    /**
+     * Whether the request is switching time to live on or off.
+     */
+    private static readEnabled;
+}
+//# sourceMappingURL=sim-dynamodb-time-to-live-specification.d.ts.map

package/dist/service/dynamodb/time-to-live/sim-dynamodb-time-to-live-specification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-time-to-live-specification.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/time-to-live/sim-dynamodb-time-to-live-specification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,+CAA+C,CAAC;AAQ7G;;;;;;GAMG;AACH,qBAAa,kCAAkC;IAC7C,SAAgB,aAAa,EAAE,MAAM,CAAC;IACtC,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC,OAAO,eAGN;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,uCAAuC,GAAG,SAAS,GACzD,kCAAkC,CAWpC;IAED;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAoBhC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;CAU3B"}