dynamo-document-builder 0.6.0 → 0.7.0

package/dist/conditions/not-exists.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"not-exists.mjs","sources":["../../src/conditions/not-exists.ts"],"sourcesContent":[null],"names":[],"mappings":";;SAGgB,SAAS,GAAA;IACvB,OAAO;AACL,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,GAAG,EAAE,IAAI;KACV;AACH;;;;"}
+{"version":3,"file":"not-exists.mjs","sources":["../../src/conditions/not-exists.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;SACa,SAAS,GAAA;IACvB,OAAO;AACL,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,GAAG,EAAE,IAAI;KACV;AACH;;;;"}

package/dist/conditions/not.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a NOT expression template that negates a given condition expression.
+ */
 function not(condition) {
     return {
         type: conditions_conditionSymbols.$not,

package/dist/conditions/not.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"not.cjs","sources":["../../src/conditions/not.ts"],"sourcesContent":[null],"names":["$not"],"mappings":";;;;AAGM,SAAU,GAAG,CAAC,SAAsC,EAAA;IACxD,OAAO;AACL,QAAA,IAAI,EAAEA,gCAAI;QACV,SAAS;KACV;AACH;;;;"}
+{"version":3,"file":"not.cjs","sources":["../../src/conditions/not.ts"],"sourcesContent":[null],"names":["$not"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,GAAG,CAAC,SAAsC,EAAA;IACxD,OAAO;AACL,QAAA,IAAI,EAAEA,gCAAI;QACV,SAAS;KACV;AACH;;;;"}

package/dist/conditions/not.d.ts

@@ -1,5 +1,8 @@
-import { ConditionExpressionTemplate, NotExpression } from './condition-types.js';
+import { ConditionExpressionTemplate, NotExpression } from './index.js';
 
+/**
+ * Creates a NOT expression template that negates a given condition expression.
+ */
 declare function not(condition: ConditionExpressionTemplate): NotExpression;
 
 export { not };

package/dist/conditions/not.mjs

@@ -1,5 +1,8 @@
 import { $not } from './condition-symbols.mjs';
 
+/**
+ * Creates a NOT expression template that negates a given condition expression.
+ */
 function not(condition) {
     return {
         type: $not,

package/dist/conditions/not.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"not.mjs","sources":["../../src/conditions/not.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,GAAG,CAAC,SAAsC,EAAA;IACxD,OAAO;AACL,QAAA,IAAI,EAAE,IAAI;QACV,SAAS;KACV;AACH;;;;"}
+{"version":3,"file":"not.mjs","sources":["../../src/conditions/not.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,GAAG,CAAC,SAAsC,EAAA;IACxD,OAAO;AACL,QAAA,IAAI,EAAE,IAAI;QACV,SAAS;KACV;AACH;;;;"}

package/dist/conditions/or.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates an OR logical expression template that combines multiple condition expressions.
+ */
 function or(firstCondition, secondCondition, ...additionalConditions) {
     return {
         type: conditions_conditionSymbols.$logical,

package/dist/conditions/or.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"or.cjs","sources":["../../src/conditions/or.ts"],"sourcesContent":[null],"names":["$logical"],"mappings":";;;;AAGM,SAAU,EAAE,CAChB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}
+{"version":3,"file":"or.cjs","sources":["../../src/conditions/or.ts"],"sourcesContent":[null],"names":["$logical"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,EAAE,CAChB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}

package/dist/conditions/or.d.ts

@@ -1,5 +1,8 @@
-import { ConditionExpressionTemplate, LogicalExpression } from './condition-types.js';
+import { ConditionExpressionTemplate, LogicalExpression } from './index.js';
 
+/**
+ * Creates an OR logical expression template that combines multiple condition expressions.
+ */
 declare function or(firstCondition: ConditionExpressionTemplate, secondCondition: ConditionExpressionTemplate, ...additionalConditions: ConditionExpressionTemplate[]): LogicalExpression;
 
 export { or };

package/dist/conditions/or.mjs

@@ -1,5 +1,8 @@
 import { $logical } from './condition-symbols.mjs';
 
+/**
+ * Creates an OR logical expression template that combines multiple condition expressions.
+ */
 function or(firstCondition, secondCondition, ...additionalConditions) {
     return {
         type: $logical,

package/dist/conditions/or.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"or.mjs","sources":["../../src/conditions/or.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,EAAE,CAChB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}
+{"version":3,"file":"or.mjs","sources":["../../src/conditions/or.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,EAAE,CAChB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}

package/dist/conditions/size.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a SIZE condition expression template.
+ */
 function size(valueOrComparison) {
     if (typeof valueOrComparison === 'number') {
         return {

package/dist/conditions/size.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"size.cjs","sources":["../../src/conditions/size.ts"],"sourcesContent":[null],"names":["$size"],"mappings":";;;;AAMM,SAAU,IAAI,CAClB,iBAAwD,EAAA;AAExD,IAAA,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO;AACL,YAAA,IAAI,EAAEA,iCAAK;AACX,YAAA,QAAQ,EAAE,GAAG;AACb,YAAA,KAAK,EAAE,iBAAiB;SACzB;IACH;IAEA,OAAO;AACL,QAAA,IAAI,EAAEA,iCAAK;QACX,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;KAC/B;AACH;;;;"}
+{"version":3,"file":"size.cjs","sources":["../../src/conditions/size.ts"],"sourcesContent":[null],"names":["$size"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,IAAI,CAClB,iBAAwD,EAAA;AAExD,IAAA,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO;AACL,YAAA,IAAI,EAAEA,iCAAK;AACX,YAAA,QAAQ,EAAE,GAAG;AACb,YAAA,KAAK,EAAE,iBAAiB;SACzB;IACH;IAEA,OAAO;AACL,QAAA,IAAI,EAAEA,iCAAK;QACX,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;KAC/B;AACH;;;;"}

package/dist/conditions/size.d.ts

@@ -1,5 +1,8 @@
-import { ComparisonExpressionTemplate, SizeConditionExpressionTemplate } from './condition-types.js';
+import { ComparisonExpressionTemplate, SizeConditionExpressionTemplate } from './index.js';
 
+/**
+ * Creates a SIZE condition expression template.
+ */
 declare function size(valueOrComparison: number | ComparisonExpressionTemplate): SizeConditionExpressionTemplate;
 
 export { size };

package/dist/conditions/size.mjs

@@ -1,5 +1,8 @@
 import { $size } from './condition-symbols.mjs';
 
+/**
+ * Creates a SIZE condition expression template.
+ */
 function size(valueOrComparison) {
     if (typeof valueOrComparison === 'number') {
         return {

package/dist/conditions/size.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"size.mjs","sources":["../../src/conditions/size.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAMM,SAAU,IAAI,CAClB,iBAAwD,EAAA;AAExD,IAAA,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO;AACL,YAAA,IAAI,EAAE,KAAK;AACX,YAAA,QAAQ,EAAE,GAAG;AACb,YAAA,KAAK,EAAE,iBAAiB;SACzB;IACH;IAEA,OAAO;AACL,QAAA,IAAI,EAAE,KAAK;QACX,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;KAC/B;AACH;;;;"}
+{"version":3,"file":"size.mjs","sources":["../../src/conditions/size.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,IAAI,CAClB,iBAAwD,EAAA;AAExD,IAAA,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;QACzC,OAAO;AACL,YAAA,IAAI,EAAE,KAAK;AACX,YAAA,QAAQ,EAAE,GAAG;AACb,YAAA,KAAK,EAAE,iBAAiB;SACzB;IACH;IAEA,OAAO;AACL,QAAA,IAAI,EAAE,KAAK;QACX,QAAQ,EAAE,iBAAiB,CAAC,QAAQ;QACpC,KAAK,EAAE,iBAAiB,CAAC,KAAK;KAC/B;AACH;;;;"}

package/dist/conditions/type-is.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a type check expression template for the specified DynamoDB attribute type.
+ */
 function typeIs(type) {
     return {
         type: conditions_conditionSymbols.$type,

package/dist/conditions/type-is.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"type-is.cjs","sources":["../../src/conditions/type-is.ts"],"sourcesContent":[null],"names":["$type"],"mappings":";;;;AAGM,SAAU,MAAM,CAAC,IAAyB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAEA,iCAAK;AACX,QAAA,aAAa,EAAE,IAAI;KACpB;AACH;;;;"}
+{"version":3,"file":"type-is.cjs","sources":["../../src/conditions/type-is.ts"],"sourcesContent":[null],"names":["$type"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,MAAM,CAAC,IAAyB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAEA,iCAAK;AACX,QAAA,aAAa,EAAE,IAAI;KACpB;AACH;;;;"}

package/dist/conditions/type-is.d.ts

@@ -1,5 +1,8 @@
-import { DynamoAttributeType, TypeCheckExpressionTemplate } from './condition-types.js';
+import { DynamoAttributeType, TypeCheckExpressionTemplate } from './index.js';
 
+/**
+ * Creates a type check expression template for the specified DynamoDB attribute type.
+ */
 declare function typeIs(type: DynamoAttributeType): TypeCheckExpressionTemplate;
 
 export { typeIs };

package/dist/conditions/type-is.mjs

@@ -1,5 +1,8 @@
 import { $type } from './condition-symbols.mjs';
 
+/**
+ * Creates a type check expression template for the specified DynamoDB attribute type.
+ */
 function typeIs(type) {
     return {
         type: $type,

package/dist/conditions/type-is.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"type-is.mjs","sources":["../../src/conditions/type-is.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,MAAM,CAAC,IAAyB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAE,KAAK;AACX,QAAA,aAAa,EAAE,IAAI;KACpB;AACH;;;;"}
+{"version":3,"file":"type-is.mjs","sources":["../../src/conditions/type-is.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,MAAM,CAAC,IAAyB,EAAA;IAC9C,OAAO;AACL,QAAA,IAAI,EAAE,KAAK;AACX,QAAA,aAAa,EAAE,IAAI;KACpB;AACH;;;;"}

package/dist/core/entity.cjs

@@ -4,6 +4,11 @@ var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
 var errors = require('../errors.cjs');
 
 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;
@@ -20,26 +25,46 @@ class DynamoEntity {
         tslib_es6.__classPrivateFieldSet(this, _DynamoEntity_gsi, (_a = config.globalSecondaryIndexes) !== null && _a !== void 0 ? _a : {}, "f");
         tslib_es6.__classPrivateFieldSet(this, _DynamoEntity_lsi, (_b = config.localSecondaryIndexes) !== null && _b !== void 0 ? _b : {}, "f");
     }
+    /**
+     * Gets the DynamoDB table associated with this entity.
+     */
     get table() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_table, "f");
     }
+    /**
+     * Gets the Zod schema defining the structure of this entity.
+     */
     get schema() {
         return tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_schema, "f");
     }
+    /**
+     * Gets the key builders for the secondary indexes defined on this entity.
+     */
     get secondaryIndexKeyBuilders() {
         return {
             gsi: tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_gsi, "f"),
             lsi: tslib_es6.__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 = tslib_es6.__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 = tslib_es6.__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 (!tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_pk, "f") && !tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_sk, "f")) {
             return item;
@@ -59,6 +84,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 = tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_gsi, "f")[indexName];
         const gsiKeyNames = this.table.globalSecondaryIndexKeyNames[indexName];
@@ -83,6 +114,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 = tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_lsi, "f")[indexName];
         const lsiKeyNames = this.table.localSecondaryIndexKeyNames[indexName];
@@ -98,6 +135,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);
@@ -118,6 +166,9 @@ class DynamoEntity {
         }
         throw new errors.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(tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_gsi, "f"))) {
@@ -128,11 +179,17 @@ class DynamoEntity {
         }
         return allKeys;
     }
+    /**
+     * Sends a command to be executed against this entity's table.
+     */
     send(command) {
         return tslib_es6.__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 tslib_es6.__asyncGenerator(this, arguments, function* paginate_1() {
             var _a, e_1, _b, _c;
@@ -153,6 +210,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) => tslib_es6.__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 tslib_es6.__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) => tslib_es6.__awaiter(this, void 0, void 0, function* () {
+                    return yield Promise.all(items.map((item) => tslib_es6.__awaiter(this, void 0, void 0, function* () {
+                        if (skipValidation)
+                            return item;
+                        return yield tslib_es6.__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: tslib_es6.__classPrivateFieldGet(this, _DynamoEntity_table, "f").tableName,
+                Key: this.buildPrimaryKey(key),
+            })),
+            parseResults: (items, skipValidation) => tslib_es6.__awaiter(this, void 0, void 0, function* () {
+                return yield Promise.all(items.map((item) => tslib_es6.__awaiter(this, void 0, void 0, function* () {
+                    if (item === undefined || item === null)
+                        return undefined;
+                    if (skipValidation)
+                        return item;
+                    return yield tslib_es6.__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.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"entity.cjs","sources":["../../src/core/entity.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet","DocumentBuilderError","__asyncValues","__await"],"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,QAAAA,gCAAA,CAAA,IAAI,EAAA,mBAAA,EAAU,MAAM,CAAC,KAAK,MAAA;AAC1B,QAAAA,gCAAA,CAAA,IAAI,EAAA,oBAAA,EAAW,MAAM,CAAC,MAAM,MAAA;AAE5B,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,YAAY,MAAA;AAC9B,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,OAAO,MAAA;QAEzBA,gCAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;QAC/CA,gCAAA,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,OAAOC,gCAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAO;IACpB;AAEA,IAAA,IAAW,MAAM,GAAA;QACf,OAAOA,gCAAA,CAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ;IACrB;AAEA,IAAA,IAAW,yBAAyB,GAAA;QAIlC,OAAO;YACL,GAAG,EAAEA,gCAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;YACd,GAAG,EAAEA,gCAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;SACf;IACH;AAEO,IAAA,iBAAiB,CAAC,IAAmC,EAAA;;QAC1D,OAAO,CAAA,EAAA,GAAAA,iCAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEO,IAAA,YAAY,CAAC,IAAmC,EAAA;;QACrD,OAAO,CAAA,EAAA,GAAAA,iCAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEO,IAAA,eAAe,CAAC,IAAmC,EAAA;QACxD,IAAI,CAACA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAACA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;AAC1B,YAAA,OAAO,IAAiB;QAC1B;QACA,MAAM,GAAG,GAAc,EAAE;AACzB,QAAA,IAAIA,gCAAA,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,IAAIA,gCAAA,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,GAAGA,gCAAA,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,GAAGA,gCAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,SAAS,CAAC;QAErE,IAAI,CAACA,gCAAA,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,IAAIC,2BAAoB,CAAC,2CAA2C,CAAC;QAC7E;AAAO,aAAA,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;AAChC,YAAA,MAAM,IAAIA,2BAAoB,CAAC,oDAAoD,CAAC;QACtF;AACA,QAAA,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAE;AAChC,QAAA,IAAID,iCAAA,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,IAAIA,iCAAA,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,IAAIC,2BAAoB,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,CAACD,gCAAA,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,CAACA,gCAAA,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,GAAAE,uBAAA,CAAA,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA,EAAA,EAAA,EAAA,EAAA,GAAA,MAAAC,iBAAA,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,MAAAA,iBAAA,CAAM,IAAI,CAAA;gBACZ;;;;;;;;;QACF,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"entity.cjs","sources":["../../src/core/entity.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet","DocumentBuilderError","__asyncValues","__await","__awaiter"],"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,QAAAA,gCAAA,CAAA,IAAI,EAAA,mBAAA,EAAU,MAAM,CAAC,KAAK,MAAA;AAC1B,QAAAA,gCAAA,CAAA,IAAI,EAAA,oBAAA,EAAW,MAAM,CAAC,MAAM,MAAA;AAE5B,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,YAAY,MAAA;AAC9B,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAO,MAAM,CAAC,OAAO,MAAA;QAEzBA,gCAAA,CAAA,IAAI,qBAAQ,CAAA,EAAA,GAAA,MAAM,CAAC,sBAAsB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE,EAAA,GAAA,CAAA;QAC/CA,gCAAA,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,OAAOC,gCAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAO;IACpB;AAEA;;AAEG;AACH,IAAA,IAAW,MAAM,GAAA;QACf,OAAOA,gCAAA,CAAA,IAAI,EAAA,oBAAA,EAAA,GAAA,CAAQ;IACrB;AAEA;;AAEG;AACH,IAAA,IAAW,yBAAyB,GAAA;QAIlC,OAAO;YACL,GAAG,EAAEA,gCAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;YACd,GAAG,EAAEA,gCAAA,CAAA,IAAI,EAAA,iBAAA,EAAA,GAAA,CAAK;SACf;IACH;AAEA;;AAEG;AACI,IAAA,iBAAiB,CAAC,IAAmC,EAAA;;QAC1D,OAAO,CAAA,EAAA,GAAAA,iCAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEA;;AAEG;AACI,IAAA,YAAY,CAAC,IAAmC,EAAA;;QACrD,OAAO,CAAA,EAAA,GAAAA,iCAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,+CAAR,IAAI,EAAO,IAA4B,CAAC;IACjD;AAEA;;;;AAIG;AACI,IAAA,eAAe,CAAC,IAAmC,EAAA;QACxD,IAAI,CAACA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,IAAI,CAACA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAI,EAAE;AAC1B,YAAA,OAAO,IAAiB;QAC1B;QACA,MAAM,GAAG,GAAc,EAAE;AACzB,QAAA,IAAIA,gCAAA,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,IAAIA,gCAAA,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,GAAGA,gCAAA,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,GAAGA,gCAAA,CAAA,IAAI,yBAAK,CAAC,SAAS,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,SAAS,CAAC;QAErE,IAAI,CAACA,gCAAA,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,IAAIC,2BAAoB,CAAC,2CAA2C,CAAC;QAC7E;AAAO,aAAA,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;AAChC,YAAA,MAAM,IAAIA,2BAAoB,CAAC,oDAAoD,CAAC;QACtF;AACA,QAAA,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAE;AAChC,QAAA,IAAID,iCAAA,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,IAAIA,iCAAA,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,IAAIC,2BAAoB,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,CAACD,gCAAA,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,CAACA,gCAAA,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,GAAAE,uBAAA,CAAA,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA,EAAA,EAAA,EAAA,EAAA,GAAA,MAAAC,iBAAA,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,MAAAA,iBAAA,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,KAAIC,mBAAA,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,MAAMJ,gCAAA,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,KAAII,mBAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AAChE,oBAAA,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,KAAGA,mBAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACrB,wBAAA,IAAI,cAAc;AAAE,4BAAA,OAAO,IAA4B;wBACvD,OAAO,MAAMJ,iCAAA,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,EAAEA,gCAAA,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,KAAII,mBAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AAChE,gBAAA,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,KAAGA,mBAAA,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,MAAMJ,iCAAA,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/entity.d.ts

@@ -1,9 +1,21 @@
-import { BaseCommand, BasePaginatable } from '../commands/base-command.js';
+import { BaseCommand, BasePaginatable, WriteTransactable, PreparedWriteTransaction, BatchWritePreparable, PreparedBatchWrite, BatchGetPreparable, PreparedBatchGet, GetTransactable, PreparedGetTransaction } from '../commands/index.js';
 import { DynamoKeyBuilder, GlobalSecondaryIndexKeyBuilders, LocalSecondaryIndexKeyBuilders, DynamoKeyableValue, DynamoKey, DynamoIndexKey } from './key.js';
 import { DynamoTable } from './table.js';
 import { ZodObject } from 'zod/v4';
-import { EntitySchema } from './core-types.js';
+import { EntitySchema, IndexName } from './index.js';
 
+/**
+ * Configuration type for creating a DynamoEntity.
+ *
+ * @template Schema - The Zod schema representing the entity's structure.
+ *
+ * @property table - The DynamoTable instance associated with the entity.
+ * @property schema - The Zod schema defining the entity's structure.
+ * @property partitionKey - Key builder function to build the partition key from an entity item.
+ * @property sortKey - Key builder function to build the sort key from an entity item.
+ * @property globalSecondaryIndexes - Mapping of global secondary index names to their key builders.
+ * @property localSecondaryIndexes - Mapping of local secondary index names to their key builders.
+ */
 type DynamoEntityConfig<Schema extends ZodObject> = {
     table: DynamoTable;
     schema: Schema;
@@ -12,6 +24,12 @@ type DynamoEntityConfig<Schema extends ZodObject> = {
     globalSecondaryIndexes?: GlobalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;
     localSecondaryIndexes?: LocalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;
 };
+/**
+ * Input type for building *either* a DynamoDB primary key or secondary index key.
+ *
+ * This is used in cases where the user may want to specify either a full primary key
+ * or a secondary index key to identify an item.
+ */
 type EntityKeyInput<Item> = {
     key: Partial<Item>;
 } | {
@@ -19,24 +37,101 @@ type EntityKeyInput<Item> = {
         [index: IndexName]: Partial<Item>;
     };
 };
+/**
+ * Core class that represents a DynamoDB entity.
+ *
+ * @template Schema - The Zod schema representing the entity's structure.
+ */
 declare class DynamoEntity<Schema extends ZodObject> {
     #private;
     constructor(config: DynamoEntityConfig<Schema>);
+    /**
+     * Gets the DynamoDB table associated with this entity.
+     */
     get table(): DynamoTable;
+    /**
+     * Gets the Zod schema defining the structure of this entity.
+     */
     get schema(): Schema;
+    /**
+     * Gets the key builders for the secondary indexes defined on this entity.
+     */
     get secondaryIndexKeyBuilders(): {
         gsi: GlobalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;
         lsi: LocalSecondaryIndexKeyBuilders<EntitySchema<Schema>>;
     };
+    /**
+     * Builds the partition key for the given item using the entity's partition key builder.
+     */
     buildPartitionKey(item: Partial<EntitySchema<Schema>>): DynamoKeyableValue | undefined;
+    /**
+     * Builds the sort key for the given item using the entity's sort key builder.
+     */
     buildSortKey(item: Partial<EntitySchema<Schema>>): DynamoKeyableValue | undefined;
+    /**
+     * 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: Partial<EntitySchema<Schema>>): DynamoKey;
-    buildGlobalSecondaryIndexKey(indexName: string, item: Partial<EntitySchema<Schema>>): DynamoIndexKey;
-    buildLocalSecondaryIndexKey(indexName: string, item: Partial<EntitySchema<Schema>>): DynamoIndexKey;
+    /**
+     * 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: IndexName, item: Partial<EntitySchema<Schema>>): DynamoIndexKey;
+    /**
+     * 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: IndexName, item: Partial<EntitySchema<Schema>>): DynamoIndexKey;
+    /**
+     * 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: EntityKeyInput<EntitySchema<Schema>>): DynamoKey | DynamoIndexKey;
+    /**
+     * Builds all keys (primary and secondary index keys) for the given item.
+     */
     buildAllKeys(item: Partial<EntitySchema<Schema>>): DynamoKey;
+    /**
+     * Sends a command to be executed against this entity's table.
+     */
     send<CommandOutput>(command: BaseCommand<CommandOutput, Schema>): Promise<CommandOutput>;
+    /**
+     * Paginates through results of a paginatable command for this entity's table.
+     */
     paginate<CommandOutput>(paginatable: BasePaginatable<CommandOutput, Schema>): AsyncGenerator<CommandOutput, void, unknown>;
+    /**
+     * Prepares a set of write operations bound to this entity for use in a table-level
+     * `TableTransactWrite` command.
+     */
+    prepare(writes: WriteTransactable<Schema>[]): PreparedWriteTransaction<Schema>;
+    /**
+     * Prepares a batch write command bound to this entity for use in a table-level
+     * `TableBatchWrite` command.
+     */
+    prepare(batchWrite: BatchWritePreparable<Schema>): PreparedBatchWrite<Schema>;
+    /**
+     * Prepares a batch get command bound to this entity for use in a table-level
+     * `TableBatchGet` command.
+     */
+    prepare(batchGet: BatchGetPreparable<Schema>): PreparedBatchGet<Schema>;
+    /**
+     * Prepares a get command bound to this entity for use in a table-level
+     * `TableTransactGet` command.
+     */
+    prepare(get: GetTransactable<Schema>): PreparedGetTransaction<Schema>;
 }
 
 export { DynamoEntity };