dynamo-document-builder 0.6.0 → 0.7.0

package/dist/core/entity.mjs

@@ -2,6 +2,11 @@ import { __classPrivateFieldSet, __classPrivateFieldGet, __awaiter, __asyncGener
 import { DocumentBuilderError } from '../errors.mjs';
 
 var _DynamoEntity_table, _DynamoEntity_schema, _DynamoEntity_pk, _DynamoEntity_sk, _DynamoEntity_gsi, _DynamoEntity_lsi;
+/**
+ * Core class that represents a DynamoDB entity.
+ *
+ * @template Schema - The Zod schema representing the entity's structure.
+ */
 class DynamoEntity {
     constructor(config) {
         var _a, _b;
@@ -18,26 +23,46 @@ class DynamoEntity {
         __classPrivateFieldSet(this, _DynamoEntity_gsi, (_a = config.globalSecondaryIndexes) !== null && _a !== void 0 ? _a : {}, "f");
         __classPrivateFieldSet(this, _DynamoEntity_lsi, (_b = config.localSecondaryIndexes) !== null && _b !== void 0 ? _b : {}, "f");
     }
+    /**
+     * Gets the DynamoDB table associated with this entity.
+     */
     get table() {
         return __classPrivateFieldGet(this, _DynamoEntity_table, "f");
     }
+    /**
+     * Gets the Zod schema defining the structure of this entity.
+     */
     get schema() {
         return __classPrivateFieldGet(this, _DynamoEntity_schema, "f");
     }
+    /**
+     * Gets the key builders for the secondary indexes defined on this entity.
+     */
     get secondaryIndexKeyBuilders() {
         return {
             gsi: __classPrivateFieldGet(this, _DynamoEntity_gsi, "f"),
             lsi: __classPrivateFieldGet(this, _DynamoEntity_lsi, "f"),
         };
     }
+    /**
+     * Builds the partition key for the given item using the entity's partition key builder.
+     */
     buildPartitionKey(item) {
         var _a;
         return (_a = __classPrivateFieldGet(this, _DynamoEntity_pk, "f")) === null || _a === void 0 ? void 0 : _a.call(this, item);
     }
+    /**
+     * Builds the sort key for the given item using the entity's sort key builder.
+     */
     buildSortKey(item) {
         var _a;
         return (_a = __classPrivateFieldGet(this, _DynamoEntity_sk, "f")) === null || _a === void 0 ? void 0 : _a.call(this, item);
     }
+    /**
+     * Builds the primary key for the given item, including both partition and sort keys if defined.
+     *
+     * If the entity does not have partition or sort key builders defined, the item is returned as-is.
+     */
     buildPrimaryKey(item) {
         if (!__classPrivateFieldGet(this, _DynamoEntity_pk, "f") && !__classPrivateFieldGet(this, _DynamoEntity_sk, "f")) {
             return item;
@@ -57,6 +82,12 @@ class DynamoEntity {
         }
         return key;
     }
+    /**
+     * Builds the key for a global secondary index for the given item.
+     *
+     * If the specified index does not exist or its key builders are not defined,
+     * the item is returned as-is.
+     */
     buildGlobalSecondaryIndexKey(indexName, item) {
         const gsiKeyBuilder = __classPrivateFieldGet(this, _DynamoEntity_gsi, "f")[indexName];
         const gsiKeyNames = this.table.globalSecondaryIndexKeyNames[indexName];
@@ -81,6 +112,12 @@ class DynamoEntity {
         }
         return key;
     }
+    /**
+     * Builds the key for a local secondary index for the given item.
+     *
+     * If the specified index does not exist or its key builders are not defined,
+     * the item is returned as-is.
+     */
     buildLocalSecondaryIndexKey(indexName, item) {
         const lsiKeyBuilder = __classPrivateFieldGet(this, _DynamoEntity_lsi, "f")[indexName];
         const lsiKeyNames = this.table.localSecondaryIndexKeyNames[indexName];
@@ -96,6 +133,17 @@ class DynamoEntity {
         }
         return key;
     }
+    /**
+     * Builds either a primary key or a secondary index key based on the provided input.
+     *
+     * If the input contains a `key`, the primary key is built.
+     * If the input contains an `index`, the corresponding secondary index key is built.
+     *
+     * Works similarly to the other key building methods and will pass-through the key or index
+     * input if the entity does not have the necessary key builders defined.
+     *
+     * @throws DocumentBuilderError if the index name is missing or not defined on the entity.
+     */
     buildPrimaryOrIndexKey(keyInput) {
         if ('key' in keyInput) {
             return this.buildPrimaryKey(keyInput.key);
@@ -116,6 +164,9 @@ class DynamoEntity {
         }
         throw new DocumentBuilderError(`Index "${indexName}" is not defined on entity`);
     }
+    /**
+     * Builds all keys (primary and secondary index keys) for the given item.
+     */
     buildAllKeys(item) {
         const allKeys = this.buildPrimaryKey(item);
         for (const indexName of Object.keys(__classPrivateFieldGet(this, _DynamoEntity_gsi, "f"))) {
@@ -126,11 +177,17 @@ class DynamoEntity {
         }
         return allKeys;
     }
+    /**
+     * Sends a command to be executed against this entity's table.
+     */
     send(command) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield command.execute(this);
         });
     }
+    /**
+     * Paginates through results of a paginatable command for this entity's table.
+     */
     paginate(paginatable) {
         return __asyncGenerator(this, arguments, function* paginate_1() {
             var _a, e_1, _b, _c;
@@ -151,6 +208,120 @@ class DynamoEntity {
             }
         });
     }
+    prepare(input) {
+        var _a;
+        // WriteTransactable[] — array of transact write operations
+        if (Array.isArray(input)) {
+            return {
+                entity: this,
+                writes: input,
+            };
+        }
+        // BatchWritePreparable — has items and/or deletes, no keys
+        if ('items' in input || ('deletes' in input && !('keys' in input))) {
+            const batchWrite = input;
+            return {
+                entity: this,
+                buildRequests: (skipValidation, abortSignal) => __awaiter(this, void 0, void 0, function* () {
+                    const putRequests = [];
+                    const deleteRequests = [];
+                    if (batchWrite.items && batchWrite.items.length > 0) {
+                        for (const item of batchWrite.items) {
+                            if (skipValidation) {
+                                putRequests.push({
+                                    PutRequest: {
+                                        Item: Object.assign(Object.assign({}, item), this.buildAllKeys(item)),
+                                    },
+                                });
+                            }
+                            else {
+                                const encodedData = yield __classPrivateFieldGet(this, _DynamoEntity_schema, "f").encodeAsync(item);
+                                putRequests.push({
+                                    PutRequest: {
+                                        Item: Object.assign(Object.assign({}, encodedData), this.buildAllKeys(item)),
+                                    },
+                                });
+                            }
+                        }
+                    }
+                    if (batchWrite.deletes && batchWrite.deletes.length > 0) {
+                        for (const deleteKey of batchWrite.deletes) {
+                            deleteRequests.push({
+                                DeleteRequest: {
+                                    Key: this.buildPrimaryKey(deleteKey),
+                                },
+                            });
+                        }
+                    }
+                    return [...putRequests, ...deleteRequests];
+                }),
+                matchUnprocessedPut: (item) => {
+                    if (!batchWrite.items)
+                        return undefined;
+                    const itemPrimaryKey = this.buildPrimaryKey(item);
+                    return batchWrite.items.find(original => {
+                        const originalKey = this.buildPrimaryKey(original);
+                        return JSON.stringify(originalKey) === JSON.stringify(itemPrimaryKey);
+                    });
+                },
+                matchUnprocessedDelete: (key) => {
+                    if (!batchWrite.deletes)
+                        return undefined;
+                    const keyStr = JSON.stringify(key);
+                    return batchWrite.deletes.find(original => {
+                        const originalKey = this.buildPrimaryKey(original);
+                        return JSON.stringify(originalKey) === keyStr;
+                    });
+                },
+            };
+        }
+        // BatchGetPreparable — has keys as entity partials plus consistent flag
+        if ('consistent' in input) {
+            const batchGet = input;
+            const builtKeys = batchGet.keys.map(k => this.buildPrimaryKey(k));
+            return {
+                entity: this,
+                keys: builtKeys,
+                consistent: (_a = batchGet.consistent) !== null && _a !== void 0 ? _a : false,
+                matchItem: (item) => {
+                    const itemKey = this.buildPrimaryKey(item);
+                    const itemKeyStr = JSON.stringify(itemKey);
+                    return builtKeys.some(k => JSON.stringify(k) === itemKeyStr);
+                },
+                parseResults: (items, skipValidation) => __awaiter(this, void 0, void 0, function* () {
+                    return yield Promise.all(items.map((item) => __awaiter(this, void 0, void 0, function* () {
+                        if (skipValidation)
+                            return item;
+                        return yield __classPrivateFieldGet(this, _DynamoEntity_schema, "f").parseAsync(item);
+                    })));
+                }),
+                matchUnprocessedKey: (key) => {
+                    const keyStr = JSON.stringify(key);
+                    return batchGet.keys.find(original => {
+                        const originalKey = this.buildPrimaryKey(original);
+                        return JSON.stringify(originalKey) === keyStr;
+                    });
+                },
+            };
+        }
+        // GetTransactable — has keys as entity partials, no consistent flag
+        return {
+            entity: this,
+            keys: input.keys.map(key => ({
+                TableName: __classPrivateFieldGet(this, _DynamoEntity_table, "f").tableName,
+                Key: this.buildPrimaryKey(key),
+            })),
+            parseResults: (items, skipValidation) => __awaiter(this, void 0, void 0, function* () {
+                return yield Promise.all(items.map((item) => __awaiter(this, void 0, void 0, function* () {
+                    if (item === undefined || item === null)
+                        return undefined;
+                    if (skipValidation)
+                        return item;
+                    return yield __classPrivateFieldGet(this, _DynamoEntity_schema, "f").parseAsync(item);
+                })));
+            }),
+        };
+    }
 }
 _DynamoEntity_table = new WeakMap(), _DynamoEntity_schema = new WeakMap(), _DynamoEntity_pk = new WeakMap(), _DynamoEntity_sk = new WeakMap(), _DynamoEntity_gsi = new WeakMap(), _DynamoEntity_lsi = new WeakMap();
 

package/dist/core/entity.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"entity.mjs","sources":["../../src/core/entity.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;MAiCa,YAAY,CAAA;AAUvB,IAAA,WAAA,CAAY,MAAkC,EAAA;;QAT9C,mBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,oBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QAEA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QAEA,iBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,iBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAU,MAAM,CAAC,KAAK,MAAA;AAC1B,QAAA,sBAAA,CAAA,IAAI,EAAA,oBAAA,EAAW,MAAM,CAAC,MAAM,MAAA;AAE5B,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,YAAY,MAAA;AAC9B,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,OAAO,MAAA;QAEzB,sBAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;QAC/C,sBAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAChD;AAEA,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAO;IACpB;AAEA,IAAA,IAAW,MAAM,GAAA;QACf,OAAO,sBAAA,CAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ;IACrB;AAEA,IAAA,IAAW,yBAAyB,GAAA;QAIlC,OAAO;YACL,GAAG,EAAE,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;YACd,GAAG,EAAE,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;SACf;IACH;AAEO,IAAA,iBAAiB,CAAC,IAAmC,EAAA;;QAC1D,OAAO,CAAA,EAAA,GAAA,uBAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEO,IAAA,YAAY,CAAC,IAAmC,EAAA;;QACrD,OAAO,CAAA,EAAA,GAAA,uBAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEO,IAAA,eAAe,CAAC,IAAmC,EAAA;QACxD,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;AAC1B,YAAA,OAAO,IAAiB;QAC1B;QACA,MAAM,GAAG,GAAc,EAAE;AACzB,QAAA,IAAI,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;YACZ,MAAM,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;AACvC,YAAA,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE;YACvC;QACF;AACA,QAAA,IAAI,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,EAAE;YAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AAClC,YAAA,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;YAClC;QACF;AACA,QAAA,OAAO,GAAG;IACZ;IAEO,4BAA4B,CACjC,SAAiB,EACjB,IAAmC,EAAA;QAEnC,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC;AAEtE,QAAA,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW,EAAE;AAClC,YAAA,OAAO,IAAsB;QAC/B;QAEA,MAAM,GAAG,GAAmB,EAAE;AAC9B,QAAA,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5B,MAAM,KAAK,GAAG,aAAa,CAAC,YAAY,CAAC,IAA4B,CAAC;AACtE,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,KAAK;YACvC;AAAO,iBAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AAC9B,gBAAA,OAAO,EAAE;YACX;QACF;QACA,IAAI,aAAa,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE;YAChD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,IAA4B,CAAC;AACjE,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK;YAClC;QACF;AACA,QAAA,OAAO,GAAG;IACZ;IAEO,2BAA2B,CAChC,SAAiB,EACjB,IAAmC,EAAA;QAEnC,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,SAAS,CAAC;QAErE,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW,EAAE;AAC/C,YAAA,OAAO,IAAsB;QAC/B;AAEA,QAAA,MAAM,GAAG,GAAmB;AAC1B,YAAA,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAE;SAC7D;QACD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,IAA4B,CAAC;AACjE,QAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,YAAA,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK;QAClC;AACA,QAAA,OAAO,GAAG;IACZ;AAEO,IAAA,sBAAsB,CAC3B,QAA8C,EAAA;AAE9C,QAAA,IAAI,KAAK,IAAI,QAAQ,EAAE;YACrB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC3C;QACA,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AAC9C,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3B,YAAA,MAAM,IAAI,oBAAoB,CAAC,2CAA2C,CAAC;QAC7E;AAAO,aAAA,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;AAChC,YAAA,MAAM,IAAI,oBAAoB,CAAC,oDAAoD,CAAC;QACtF;AACA,QAAA,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAE;AAChC,QAAA,IAAI,uBAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,SAAS,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;QACjF;AACA,QAAA,IAAI,uBAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,SAAS,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;QAChF;AACA,QAAA,MAAM,IAAI,oBAAoB,CAAC,UAAU,SAAS,CAAA,0BAAA,CAA4B,CAAC;IACjF;AAEO,IAAA,YAAY,CAAC,IAAmC,EAAA;QACrD,MAAM,OAAO,GAAc,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;AACrD,QAAA,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,EAAE;AAC9C,YAAA,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5E;AACA,QAAA,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,EAAE;AAC9C,YAAA,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC3E;AACA,QAAA,OAAO,OAAO;IAChB;AAEa,IAAA,IAAI,CACf,OAA2C,EAAA;;AAE3C,YAAA,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpC,CAAC,CAAA;AAAA,IAAA;AAEa,IAAA,QAAQ,CACpB,WAAmD,EAAA;;;;AAEnD,gBAAA,KAAyB,IAAA,EAAA,GAAA,IAAA,EAAA,EAAA,GAAA,aAAA,CAAA,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA,EAAA,EAAA,EAAA,EAAA,GAAA,MAAA,OAAA,CAAA,EAAA,CAAA,IAAA,EAAA,CAAA,EAAA,EAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA,EAAA,EAAA,EAAA,GAAA,IAAA,EAAE;oBAApC,EAAA,GAAA,EAAA,CAAA,KAAA;oBAAA,EAAA,GAAA,KAAA;oBAAd,MAAM,IAAI,KAAA;oBACnB,MAAA,MAAA,OAAA,CAAM,IAAI,CAAA;gBACZ;;;;;;;;;QACF,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"entity.mjs","sources":["../../src/core/entity.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AA8DA;;;;AAIG;MACU,YAAY,CAAA;AAUvB,IAAA,WAAA,CAAY,MAAkC,EAAA;;QAT9C,mBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,oBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QAEA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QAEA,iBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,iBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAU,MAAM,CAAC,KAAK,MAAA;AAC1B,QAAA,sBAAA,CAAA,IAAI,EAAA,oBAAA,EAAW,MAAM,CAAC,MAAM,MAAA;AAE5B,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,YAAY,MAAA;AAC9B,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,OAAO,MAAA;QAEzB,sBAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;QAC/C,sBAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAChD;AAEA;;AAEG;AACH,IAAA,IAAW,KAAK,GAAA;QACd,OAAO,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAO;IACpB;AAEA;;AAEG;AACH,IAAA,IAAW,MAAM,GAAA;QACf,OAAO,sBAAA,CAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ;IACrB;AAEA;;AAEG;AACH,IAAA,IAAW,yBAAyB,GAAA;QAIlC,OAAO;YACL,GAAG,EAAE,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;YACd,GAAG,EAAE,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;SACf;IACH;AAEA;;AAEG;AACI,IAAA,iBAAiB,CAAC,IAAmC,EAAA;;QAC1D,OAAO,CAAA,EAAA,GAAA,uBAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEA;;AAEG;AACI,IAAA,YAAY,CAAC,IAAmC,EAAA;;QACrD,OAAO,CAAA,EAAA,GAAA,uBAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEA;;;;AAIG;AACI,IAAA,eAAe,CAAC,IAAmC,EAAA;QACxD,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;AAC1B,YAAA,OAAO,IAAiB;QAC1B;QACA,MAAM,GAAG,GAAc,EAAE;AACzB,QAAA,IAAI,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;YACZ,MAAM,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;AACvC,YAAA,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,EAAE;YACvC;QACF;AACA,QAAA,IAAI,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,EAAE;YAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;AAClC,YAAA,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;YAClC;QACF;AACA,QAAA,OAAO,GAAG;IACZ;AAEA;;;;;AAKG;IACI,4BAA4B,CACjC,SAAoB,EACpB,IAAmC,EAAA;QAEnC,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,4BAA4B,CAAC,SAAS,CAAC;AAEtE,QAAA,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW,EAAE;AAClC,YAAA,OAAO,IAAsB;QAC/B;QAEA,MAAM,GAAG,GAAmB,EAAE;AAC9B,QAAA,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5B,MAAM,KAAK,GAAG,aAAa,CAAC,YAAY,CAAC,IAA4B,CAAC;AACtE,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,KAAK;YACvC;AAAO,iBAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AAC9B,gBAAA,OAAO,EAAE;YACX;QACF;QACA,IAAI,aAAa,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE;YAChD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,IAA4B,CAAC;AACjE,YAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,gBAAA,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK;YAClC;QACF;AACA,QAAA,OAAO,GAAG;IACZ;AAEA;;;;;AAKG;IACI,2BAA2B,CAChC,SAAoB,EACpB,IAAmC,EAAA;QAEnC,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,SAAS,CAAC;QAErE,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAAC,aAAa,IAAI,CAAC,WAAW,EAAE;AAC/C,YAAA,OAAO,IAAsB;QAC/B;AAEA,QAAA,MAAM,GAAG,GAAmB;AAC1B,YAAA,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAE;SAC7D;QACD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,IAA4B,CAAC;AACjE,QAAA,IAAI,KAAK,KAAK,SAAS,EAAE;AACvB,YAAA,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,KAAK;QAClC;AACA,QAAA,OAAO,GAAG;IACZ;AAEA;;;;;;;;;;AAUG;AACI,IAAA,sBAAsB,CAC3B,QAA8C,EAAA;AAE9C,QAAA,IAAI,KAAK,IAAI,QAAQ,EAAE;YACrB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC3C;QACA,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AAC9C,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;AAC3B,YAAA,MAAM,IAAI,oBAAoB,CAAC,2CAA2C,CAAC;QAC7E;AAAO,aAAA,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;AAChC,YAAA,MAAM,IAAI,oBAAoB,CAAC,oDAAoD,CAAC;QACtF;AACA,QAAA,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAE;AAChC,QAAA,IAAI,uBAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,SAAS,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;QACjF;AACA,QAAA,IAAI,uBAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,SAAS,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;QAChF;AACA,QAAA,MAAM,IAAI,oBAAoB,CAAC,UAAU,SAAS,CAAA,0BAAA,CAA4B,CAAC;IACjF;AAEA;;AAEG;AACI,IAAA,YAAY,CAAC,IAAmC,EAAA;QACrD,MAAM,OAAO,GAAc,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;AACrD,QAAA,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,EAAE;AAC9C,YAAA,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5E;AACA,QAAA,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,sBAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK,CAAC,EAAE;AAC9C,YAAA,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,2BAA2B,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC3E;AACA,QAAA,OAAO,OAAO;IAChB;AAEA;;AAEG;AACU,IAAA,IAAI,CACf,OAA2C,EAAA;;AAE3C,YAAA,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpC,CAAC,CAAA;AAAA,IAAA;AAED;;AAEG;AACW,IAAA,QAAQ,CACpB,WAAmD,EAAA;;;;AAEnD,gBAAA,KAAyB,IAAA,EAAA,GAAA,IAAA,EAAA,EAAA,GAAA,aAAA,CAAA,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA,EAAA,EAAA,EAAA,EAAA,GAAA,MAAA,OAAA,CAAA,EAAA,CAAA,IAAA,EAAA,CAAA,EAAA,EAAA,GAAA,EAAA,CAAA,IAAA,EAAA,CAAA,EAAA,EAAA,EAAA,GAAA,IAAA,EAAE;oBAApC,EAAA,GAAA,EAAA,CAAA,KAAA;oBAAA,EAAA,GAAA,KAAA;oBAAd,MAAM,IAAI,KAAA;oBACnB,MAAA,MAAA,OAAA,CAAM,IAAI,CAAA;gBACZ;;;;;;;;;QACF,CAAC,CAAA;AAAA,IAAA;AA0BM,IAAA,OAAO,CACZ,KAI8B,EAAA;;;AAO9B,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO;AACL,gBAAA,MAAM,EAAE,IAAI;AACZ,gBAAA,MAAM,EAAE,KAAK;aAC6B;QAC9C;;AAGA,QAAA,IAAI,OAAO,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE;YAClE,MAAM,UAAU,GAAG,KAAqC;YACxD,OAAO;AACL,gBAAA,MAAM,EAAE,IAAI;AACZ,gBAAA,aAAa,EAAE,CAAO,cAAuB,EAAE,WAAyB,KAAI,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;oBAC1E,MAAM,WAAW,GAA6D,EAAE;oBAChF,MAAM,cAAc,GAAiD,EAAE;AAEvE,oBAAA,IAAI,UAAU,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AACnD,wBAAA,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,KAAK,EAAE;4BACnC,IAAI,cAAc,EAAE;gCAClB,WAAW,CAAC,IAAI,CAAC;AACf,oCAAA,UAAU,EAAE;wCACV,IAAI,EAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EACC,IAAI,CAAA,EACJ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAC3B;AACF,qCAAA;AACF,iCAAA,CAAC;4BACJ;iCAAO;gCACL,MAAM,WAAW,GAAG,MAAM,sBAAA,CAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ,CAAC,WAAW,CAAC,IAAI,CAAC;gCACxD,WAAW,CAAC,IAAI,CAAC;AACf,oCAAA,UAAU,EAAE;wCACV,IAAI,EAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAAA,EACC,WAAW,CAAA,EACX,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAC3B;AACF,qCAAA;AACF,iCAAA,CAAC;4BACJ;wBAEF;oBACF;AAEA,oBAAA,IAAI,UAAU,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACvD,wBAAA,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,OAAO,EAAE;4BAC1C,cAAc,CAAC,IAAI,CAAC;AAClB,gCAAA,aAAa,EAAE;AACb,oCAAA,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;AACrC,iCAAA;AACF,6BAAA,CAAC;wBACJ;oBACF;AAEA,oBAAA,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,cAAc,CAAC;AAC5C,gBAAA,CAAC,CAAA;AACD,gBAAA,mBAAmB,EAAE,CAAC,IAA6B,KAAI;oBACrD,IAAI,CAAC,UAAU,CAAC,KAAK;AAAE,wBAAA,OAAO,SAAS;oBACvC,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,IAAqC,CAAC;oBAClF,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAG;wBACtC,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;AAClD,wBAAA,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;AACvE,oBAAA,CAAC,CAAC;gBACJ,CAAC;AACD,gBAAA,sBAAsB,EAAE,CAAC,GAA4B,KAAI;oBACvD,IAAI,CAAC,UAAU,CAAC,OAAO;AAAE,wBAAA,OAAO,SAAS;oBACzC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;oBAClC,OAAO,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAG;wBACxC,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;wBAClD,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,MAAM;AAC/C,oBAAA,CAAC,CAAC;gBACJ,CAAC;aACmC;QACxC;;AAGA,QAAA,IAAI,YAAY,IAAI,KAAK,EAAE;YACzB,MAAM,QAAQ,GAAG,KAAmC;AACpD,YAAA,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACjE,OAAO;AACL,gBAAA,MAAM,EAAE,IAAI;AACZ,gBAAA,IAAI,EAAE,SAAS;AACf,gBAAA,UAAU,EAAE,CAAA,EAAA,GAAA,QAAQ,CAAC,UAAU,mCAAI,KAAK;AACxC,gBAAA,SAAS,EAAE,CAAC,IAA6B,KAAI;oBAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,IAAqC,CAAC;oBAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;AAC1C,oBAAA,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC;gBAC9D,CAAC;AACD,gBAAA,YAAY,EAAE,CAAO,KAAgB,EAAE,cAAuB,KAAI,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AAChE,oBAAA,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,KAAG,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACrB,wBAAA,IAAI,cAAc;AAAE,4BAAA,OAAO,IAA4B;wBACvD,OAAO,MAAM,uBAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;oBAC5C,CAAC,CAAA,CAAC,CACH;AACH,gBAAA,CAAC,CAAA;AACD,gBAAA,mBAAmB,EAAE,CAAC,GAA4B,KAAI;oBACpD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;oBAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAG;wBACnC,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;wBAClD,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,MAAM;AAC/C,oBAAA,CAAC,CAAC;gBACJ,CAAC;aACiC;QACtC;;QAGA,OAAO;AACL,YAAA,MAAM,EAAE,IAAI;YACZ,IAAI,EAAG,KAAiC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK;AACxD,gBAAA,SAAS,EAAE,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAO,CAAC,SAAS;AAChC,gBAAA,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC;AAC/B,aAAA,CAAC,CAAC;AACH,YAAA,YAAY,EAAE,CAAO,KAAgB,EAAE,cAAuB,KAAI,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AAChE,gBAAA,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,KAAG,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACrB,oBAAA,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;AAAE,wBAAA,OAAO,SAAS;AACzD,oBAAA,IAAI,cAAc;AAAE,wBAAA,OAAO,IAA4B;oBACvD,OAAO,MAAM,uBAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC5C,CAAC,CAAA,CAAC,CACH;AACH,YAAA,CAAC,CAAA;SACuC;IAC5C;AACD;;;;;"}

package/dist/core/index.d.ts

@@ -1,4 +1,141 @@
-export { EncodedEntity, EncodedEntitySchema, Entity, EntitySchema, GlobalSecondaryIndexKeyName, IndexName, LocalSecondaryIndexKeyName, NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames, TransactWriteOperation } from './core-types.js';
-export { DynamoEntity, DynamoEntityConfig, EntityKeyInput } from './entity.js';
+import { DynamoEntity } from './entity.js';
+export { DynamoEntityConfig, EntityKeyInput } from './entity.js';
 export { DynamoIndexKey, DynamoIndexKeyBuilder, DynamoIndexKeyableValue, DynamoKey, DynamoKeyBuilder, DynamoKeyableValue, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders, indexKey, key } from './key.js';
 export { DynamoTable, DynamoTableConfig } from './table.js';
+import { ZodObject, output, input } from 'zod/v4';
+import { TransactWriteItem, ConditionCheck, Put, Delete, Update } from '@aws-sdk/client-dynamodb';
+import { NativeAttributeValue } from '@aws-sdk/lib-dynamodb';
+
+/**
+ * Utility type used to derive the type from the Zod schema definition. Mainly for internal use.
+ *
+ * To get the schema type from an entity use [`Entity<E>`](/api-reference/type-aliases/entity) instead.
+ */
+type EntitySchema<Schema extends ZodObject> = output<Schema>;
+/**
+ * Utility type used to derive the input type from the Zod schema definition. Mainly for internal use.
+ *
+ * To get the input schema type from an entity use [`EncodedEntity<E>`](/api-reference/type-aliases/encodedentity) instead.
+ */
+type EncodedEntitySchema<Schema extends ZodObject> = input<Schema>;
+/**
+ * Utility type to derive the type of a DynamoEntity's schema.
+ *
+ * This is the Zod *output* type of a Zod schema (the type after a codec has been applied).
+ * It is the equivalent of `z.infer<typeof entity.schema>` or `z.output<typeof entity.schema>`.
+ *
+ * @example
+ * ```ts
+ * import { DynamoTable, DynamoEntity, type Entity } from 'dynamo-document-builder';
+ * import { z } from 'zod';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     id: z.string(),
+ *     name: z.string(),
+ *     age: z.number().optional(),
+ *   }),
+ *   partitionKey: user => key('USER', user.id),
+ *   sortKey: user => 'USER',
+ * });
+ *
+ * type User = Entity<typeof userEntity>;
+ */
+type Entity<E extends DynamoEntity<any>> = output<E['schema']>;
+/**
+ * Utility type to derive the input type of a DynamoEntity's schema.
+ *
+ * This is the Zod *input* type of a Zod schema (the type before a codec has been applied).
+ * It is the equivalent of `z.input<typeof entity.schema>`.
+ *
+ * @example
+ * ```ts
+ * import { DynamoTable, DynamoEntity, type EncodedEntity } from 'dynamo-document-builder';
+ * import { z } from 'zod';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const isoDatetimeToDate = z.codec(z.iso.datetime(), z.date(), {
+ *   decode: isoString => new Date(isoString),
+ *   encode: date => date.toISOString(),
+ * });
+ *
+ * const checkinEntity = new DynamoEntity({
+ *  table,
+ *  schema: z.object({
+ *    id: z.string(),
+ *    timestamp: isoDatetimeToDate,
+ *  }),
+ * });
+ *
+ * type EncodedUser = EncodedEntity<typeof userEntity>;
+ *
+ * // EncodedUser is:
+ * // {
+ * //   id: string;
+ * //   timestamp: string; // ISO datetime string
+ * // }
+ * ```
+ */
+type EncodedEntity<E extends DynamoEntity<any>> = input<E['schema']>;
+/**
+ * Type used to indicate the name of a DynamoDB secondary index.
+ */
+type IndexName = string;
+/**
+ * Type representing the key names for a **global** secondary index.
+ */
+type GlobalSecondaryIndexKeyName = {
+    partitionKey: string;
+    sortKey?: string;
+};
+/**
+ * Type representing the key names for a **local** secondary index.
+ */
+type LocalSecondaryIndexKeyName = {
+    sortKey: string;
+};
+/**
+ * Type mapping index names to their corresponding global secondary index key names.
+ */
+type NamedGlobalSecondaryIndexKeyNames = Record<IndexName, GlobalSecondaryIndexKeyName>;
+/**
+ * Type mapping index names to their corresponding local secondary index key names.
+ */
+type NamedLocalSecondaryIndexKeyNames = Record<IndexName, LocalSecondaryIndexKeyName>;
+/**
+ * A modified version of TransactWriteItem that uses NativeAttributeValue for keys and items
+ * (dynamodb-lib doesnt export this type for some reason).
+ *
+ * See: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-lib-dynamodb/TypeAlias/TransactWriteCommandInput/
+ */
+type TransactWriteOperation = Omit<TransactWriteItem, 'ConditionCheck' | 'Put' | 'Delete' | 'Update'> & {
+    ConditionCheck?: (Omit<ConditionCheck, 'Key' | 'ExpressionAttributeValues'> & {
+        Key: Record<string, NativeAttributeValue> | undefined;
+        ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+    }) | undefined;
+    Put?: (Omit<Put, 'Item' | 'ExpressionAttributeValues'> & {
+        Item: Record<string, NativeAttributeValue> | undefined;
+        ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+    }) | undefined;
+    Delete?: (Omit<Delete, 'Key' | 'ExpressionAttributeValues'> & {
+        Key: Record<string, NativeAttributeValue> | undefined;
+        ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+    }) | undefined;
+    Update?: (Omit<Update, 'Key' | 'ExpressionAttributeValues'> & {
+        Key: Record<string, NativeAttributeValue> | undefined;
+        ExpressionAttributeValues?: Record<string, NativeAttributeValue> | undefined;
+    }) | undefined;
+};
+
+export { DynamoEntity };
+export type { EncodedEntity, EncodedEntitySchema, Entity, EntitySchema, GlobalSecondaryIndexKeyName, IndexName, LocalSecondaryIndexKeyName, NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames, TransactWriteOperation };

package/dist/core/key.cjs

@@ -3,7 +3,7 @@
 var errors = require('../errors.cjs');
 
 /**
- * Builds a DynamoDB key from the given parts by concatenating them with a '#' separator.
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
  * At least one part must be provided, or a DocumentBuilderError will be thrown.
  *
  * @param parts - The parts to combine into a key.

package/dist/core/key.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"key.cjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":["DocumentBuilderError"],"mappings":";;;;AA2BA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAIA,2BAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;;"}
+{"version":3,"file":"key.cjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":["DocumentBuilderError"],"mappings":";;;;AAsDA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAIA,2BAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;;"}

package/dist/core/key.d.ts

@@ -1,20 +1,44 @@
-import { IndexName } from './core-types.js';
+import { IndexName } from './index.js';
 
+/**
+ * Represents a value that can be used as a DynamoDB primary key.
+ */
 type DynamoKeyableValue = string | number | Buffer;
+/**
+ * Represents a value that can be used as a DynamoDB secondary index key.
+ */
 type DynamoIndexKeyableValue = string | number | Buffer | undefined;
+/**
+ * A function that builds a DynamoDB primary key from an item.
+ */
 type DynamoKeyBuilder<Item> = (item: Item) => DynamoKeyableValue;
+/**
+ * A function that builds a DynamoDB secondary index key from an item.
+ */
 type DynamoIndexKeyBuilder<Item> = (item: Item) => DynamoIndexKeyableValue;
+/**
+ * A mapping type of global secondary index names to their key builders.
+ */
 type GlobalSecondaryIndexKeyBuilders<Item> = Record<IndexName, {
     partitionKey: DynamoIndexKeyBuilder<Item>;
     sortKey?: DynamoIndexKeyBuilder<Item>;
 }>;
+/**
+ * A mapping type of local secondary index names to their key builders.
+ */
 type LocalSecondaryIndexKeyBuilders<Item> = Record<IndexName, {
     sortKey: DynamoIndexKeyBuilder<Item>;
 }>;
+/**
+ * Record type representing a DynamoDB primary key.
+ */
 type DynamoKey = Record<string, DynamoKeyableValue>;
+/**
+ * Record type representing a DynamoDB secondary index key.
+ */
 type DynamoIndexKey = Record<string, DynamoIndexKeyableValue>;
 /**
- * Builds a DynamoDB key from the given parts by concatenating them with a '#' separator.
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
  * At least one part must be provided, or a DocumentBuilderError will be thrown.
  *
  * @param parts - The parts to combine into a key.

package/dist/core/key.mjs

@@ -1,7 +1,7 @@
 import { DocumentBuilderError } from '../errors.mjs';
 
 /**
- * Builds a DynamoDB key from the given parts by concatenating them with a '#' separator.
+ * Builds a DynamoDB key from the given parts by concatenating them with a `#` separator.
  * At least one part must be provided, or a DocumentBuilderError will be thrown.
  *
  * @param parts - The parts to combine into a key.

package/dist/core/key.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"key.mjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":[],"mappings":";;AA2BA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAI,oBAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;"}
+{"version":3,"file":"key.mjs","sources":["../../src/core/key.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAsDA;;;;;;;;;;;;AAYG;AACG,SAAU,GAAG,CAAC,GAAG,KAA2B,EAAA;AAChD,IAAA,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;AACjB,QAAA,MAAM,IAAI,oBAAoB,CAAC,wCAAwC,CAAC;IAC1E;AACA,IAAA,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;AACxB;AAEA;;;;;;;;;;;;;;;;;;AAkBG;AACG,SAAU,QAAQ,CAAC,GAAG,KAAgC,EAAA;IAC1D,IAAI,GAAG,GAAW,EAAE;AACpB,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;AACxB,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,OAAO,SAAS;QAClB;AACA,QAAA,GAAG,IAAI,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAE,GAAG,IAAI;IAChC;AACA,IAAA,OAAO,GAAG;AACZ;;;;"}

package/dist/core/table.cjs

@@ -3,6 +3,9 @@
 var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
 
 var _DynamoTable_tableName, _DynamoTable_documentClient, _DynamoTable_pk, _DynamoTable_sk, _DynamoTable_gsi, _DynamoTable_lsi;
+/**
+ * Core class that represents a DynamoDB table.
+ */
 class DynamoTable {
     constructor(config) {
         var _a, _b, _c, _d, _e, _f;
@@ -23,24 +26,51 @@ class DynamoTable {
         tslib_es6.__classPrivateFieldSet(this, _DynamoTable_gsi, (_d = (_c = config.keyNames) === null || _c === void 0 ? void 0 : _c.globalSecondaryIndexes) !== null && _d !== void 0 ? _d : {}, "f");
         tslib_es6.__classPrivateFieldSet(this, _DynamoTable_lsi, (_f = (_e = config.keyNames) === null || _e === void 0 ? void 0 : _e.localSecondaryIndexes) !== null && _f !== void 0 ? _f : {}, "f");
     }
+    /**
+     * The name of the DynamoDB table.
+     */
     get tableName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_tableName, "f");
     }
+    /**
+     * The DynamoDB Document Client instance used for operations.
+     */
     get documentClient() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_documentClient, "f");
     }
+    /**
+     * The name of the partition key for the table.
+     */
     get partitionKeyName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_pk, "f");
     }
+    /**
+     * The name of the sort key for the table, or `null` if the table does not have a sort key
+     * (`null` would indicate a "simple" primary key).
+     */
     get sortKeyName() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_sk, "f");
     }
+    /**
+     * The key names for the global secondary indexes defined on the table.
+     */
     get globalSecondaryIndexKeyNames() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_gsi, "f");
     }
+    /**
+     * The key names for the local secondary indexes defined on the table.
+     */
     get localSecondaryIndexKeyNames() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoTable_lsi, "f");
     }
+    /**
+     * Sends a table-level command to be executed against this table.
+     */
+    send(command) {
+        return tslib_es6.__awaiter(this, void 0, void 0, function* () {
+            return yield command.execute(this);
+        });
+    }
 }
 _DynamoTable_tableName = new WeakMap(), _DynamoTable_documentClient = new WeakMap(), _DynamoTable_pk = new WeakMap(), _DynamoTable_sk = new WeakMap(), _DynamoTable_gsi = new WeakMap(), _DynamoTable_lsi = new WeakMap();
 

package/dist/core/table.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"table.cjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet"],"mappings":";;;;;MAiBa,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAAA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA,IAAA,IAAW,SAAS,GAAA;QAClB,OAAOC,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA,IAAA,IAAW,cAAc,GAAA;QACvB,OAAOA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,WAAW,GAAA;QACpB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AACD;;;;;"}
+{"version":3,"file":"table.cjs","sources":["../../src/core/table.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet"],"mappings":";;;;;AA2BA;;AAEG;MACU,WAAW,CAAA;AAUtB,IAAA,WAAA,CAAY,MAAyB,EAAA;;QATrC,sBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,2BAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAEA,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAc,IAAI,CAAA;AAClB,QAAA,eAAA,CAAA,GAAA,CAAA,IAAA,EAAqB,IAAI,CAAA;QAEzB,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;QACA,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAc,MAAM,CAAC,SAAS,MAAA;AAClC,QAAAA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAmB,MAAM,CAAC,cAAc,MAAA;QAC5C,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,YAAY,MAAK,SAAS,EAAE;YAC/CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,MAAA;QACzC;QACA,IAAI,CAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,MAAK,SAAS,EAAE;YAC1CA,gCAAA,CAAA,IAAI,mBAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,MAAA;QACpC;AACA,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;AACzD,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAQ,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAM,CAAC,QAAQ,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAE,qBAAqB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;IAC1D;AAEA;;AAEG;AACH,IAAA,IAAW,SAAS,GAAA;QAClB,OAAOC,gCAAA,CAAA,IAAI,EAAA,sBAAA,EAAA,GAAA,CAAW;IACxB;AAEA;;AAEG;AACH,IAAA,IAAW,cAAc,GAAA;QACvB,OAAOA,gCAAA,CAAA,IAAI,EAAA,2BAAA,EAAA,GAAA,CAAgB;IAC7B;AAEA;;AAEG;AACH,IAAA,IAAW,gBAAgB,GAAA;QACzB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;;AAGG;AACH,IAAA,IAAW,WAAW,GAAA;QACpB,OAAOA,gCAAA,CAAA,IAAI,EAAA,eAAA,EAAA,GAAA,CAAI;IACjB;AAEA;;AAEG;AACH,IAAA,IAAW,4BAA4B,GAAA;QACrC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA;;AAEG;AACH,IAAA,IAAW,2BAA2B,GAAA;QACpC,OAAOA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAK;IAClB;AAEA;;AAEG;AACU,IAAA,IAAI,CAAgB,OAAoC,EAAA;;AACnE,YAAA,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpC,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/core/table.d.ts

@@ -1,6 +1,19 @@
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import { NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames } from './core-types.js';
+import { NamedGlobalSecondaryIndexKeyNames, NamedLocalSecondaryIndexKeyNames } from './index.js';
+import { TableCommand } from '../commands/index.js';
 
+/**
+ * Configuration type for creating a DynamoTable.
+ *
+ * The table is assumed to have a primary key composed of a partition key named `"PK"` and
+ * a sort key named `"SK"` by default, unless overridden in the `keyNames` property.
+ *
+ * @template Schema - The Zod schema representing the entity's structure.
+ *
+ * @property tableName - The name of the DynamoDB table.
+ * @property documentClient - The DynamoDB Document Client instance to use for operations.
+ * @property keyNames - Key names object for the table's primary key and secondary indexes.
+ */
 type DynamoTableConfig = {
     tableName: string;
     documentClient: DynamoDBDocumentClient;
@@ -11,15 +24,41 @@ type DynamoTableConfig = {
         localSecondaryIndexes?: NamedLocalSecondaryIndexKeyNames;
     };
 };
+/**
+ * Core class that represents a DynamoDB table.
+ */
 declare class DynamoTable {
     #private;
     constructor(config: DynamoTableConfig);
+    /**
+     * The name of the DynamoDB table.
+     */
     get tableName(): string;
+    /**
+     * The DynamoDB Document Client instance used for operations.
+     */
     get documentClient(): DynamoDBDocumentClient;
+    /**
+     * The name of the partition key for the table.
+     */
     get partitionKeyName(): string;
+    /**
+     * The name of the sort key for the table, or `null` if the table does not have a sort key
+     * (`null` would indicate a "simple" primary key).
+     */
     get sortKeyName(): string | null;
+    /**
+     * The key names for the global secondary indexes defined on the table.
+     */
     get globalSecondaryIndexKeyNames(): NamedGlobalSecondaryIndexKeyNames;
+    /**
+     * The key names for the local secondary indexes defined on the table.
+     */
     get localSecondaryIndexKeyNames(): NamedLocalSecondaryIndexKeyNames;
+    /**
+     * Sends a table-level command to be executed against this table.
+     */
+    send<CommandOutput>(command: TableCommand<CommandOutput>): Promise<CommandOutput>;
 }
 
 export { DynamoTable };