dyno-table 0.2.0-0 → 1.0.0-alpha.1

package/dist/{table.cjs → index.cjs}

@@ -1,4 +1,50 @@
-'use strict';
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ConditionCheckBuilder: () => ConditionCheckBuilder,
+  DeleteBuilder: () => DeleteBuilder,
+  Paginator: () => Paginator,
+  PutBuilder: () => PutBuilder,
+  QueryBuilder: () => QueryBuilder,
+  Table: () => Table,
+  TransactionBuilder: () => TransactionBuilder,
+  UpdateBuilder: () => UpdateBuilder,
+  and: () => and,
+  attributeExists: () => attributeExists,
+  attributeNotExists: () => attributeNotExists,
+  beginsWith: () => beginsWith,
+  between: () => between,
+  contains: () => contains,
+  createComparisonCondition: () => createComparisonCondition,
+  eq: () => eq,
+  gt: () => gt,
+  gte: () => gte,
+  lt: () => lt,
+  lte: () => lte,
+  ne: () => ne,
+  not: () => not,
+  or: () => or
+});
+module.exports = __toCommonJS(index_exports);
 
 // src/conditions.ts
 var createComparisonCondition = (type) => (attr, value) => ({
@@ -863,14 +909,6 @@ var PutBuilder = class {
       returnValues: "NONE"
     };
   }
-  set(valuesOrPath, value) {
-    if (typeof valuesOrPath === "object") {
-      Object.assign(this.item, valuesOrPath);
-    } else {
-      this.item[valuesOrPath] = value;
-    }
-    return this;
-  }
   /**
    * Adds a condition that must be satisfied for the put operation to succeed.
    * Use this method when you need to:
@@ -1115,6 +1153,10 @@ var DeleteBuilder = class {
   }
   /**
    * Adds a condition that must be satisfied for the delete operation to succeed.
+   * Use this method when you need to:
+   * - Ensure safe removal conditions
+   * - Verify habitat status before deletion
+   * - Implement safety protocols
    *
    * @example
    * ```typescript
@@ -1166,6 +1208,10 @@ var DeleteBuilder = class {
   }
   /**
    * Sets whether to return the item's attribute values before deletion.
+   * Use this method when you need to:
+   * - Archive removed dinosaur data
+   * - Track habitat decommissioning history
+   * - Maintain removal audit logs
    *
    * @example
    * ```ts
@@ -1206,6 +1252,10 @@ var DeleteBuilder = class {
   }
   /**
    * Adds this delete operation to a transaction.
+   * Use this method when you need to:
+   * - Coordinate dinosaur transfers
+   * - Manage habitat decommissioning
+   * - Handle species relocations
    *
    * @example
    * ```ts
@@ -1256,6 +1306,11 @@ var DeleteBuilder = class {
   /**
    * Gets a human-readable representation of the delete command
    * with all expression placeholders replaced by their actual values.
+   * Use this method when you need to:
+   * - Debug complex deletion conditions
+   * - Verify safety checks
+   * - Log removal operations
+   * - Troubleshoot failed deletions
    *
    * @example
    * ```ts
@@ -1314,6 +1369,10 @@ var UpdateBuilder = class {
   }
   /**
    * Removes an attribute from the item.
+   * Use this method when you need to:
+   * - Delete attributes completely
+   * - Remove nested attributes
+   * - Clean up deprecated fields
    *
    * @example
    * ```typescript
@@ -1340,6 +1399,10 @@ var UpdateBuilder = class {
   }
   /**
    * Adds a value to a number attribute or adds elements to a set.
+   * Use this method when you need to:
+   * - Increment counters
+   * - Add elements to a set atomically
+   * - Update numerical statistics
    *
    * @example
    * ```typescript
@@ -1368,6 +1431,10 @@ var UpdateBuilder = class {
   }
   /**
    * Removes elements from a set attribute.
+   * Use this method when you need to:
+   * - Remove specific elements from a set
+   * - Update set-based attributes atomically
+   * - Maintain set membership
    *
    * @example
    * ```typescript
@@ -1377,7 +1444,7 @@ var UpdateBuilder = class {
    *   ['JUNGLE', 'COASTAL']
    * );
    *
-   * // Remove from sets using Set DynamoItems
+   * // Remove from sets using Set objects
    * builder.deleteElementsFromSet(
    *   'knownBehaviors',
    *   new Set(['NOCTURNAL', 'TERRITORIAL'])
@@ -1410,6 +1477,11 @@ var UpdateBuilder = class {
   }
   /**
    * Adds a condition that must be satisfied for the update to succeed.
+   * Use this method when you need to:
+   * - Implement optimistic locking
+   * - Ensure item state before update
+   * - Validate business rules
+   * - Prevent concurrent modifications
    *
    * @example
    * ```typescript
@@ -1441,7 +1513,7 @@ var UpdateBuilder = class {
    * );
    * ```
    *
-   * @param condition - Either a Condition DynamoItem or a callback function that builds the condition
+   * @param condition - Either a Condition object or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
   condition(condition) {
@@ -1470,6 +1542,11 @@ var UpdateBuilder = class {
   }
   /**
    * Sets which item attributes to include in the response.
+   * Use this method when you need to:
+   * - Get the complete updated item
+   * - Track changes to specific attributes
+   * - Compare old and new values
+   * - Monitor attribute modifications
    *
    * Available options:
    * - ALL_NEW: All attributes after the update
@@ -1597,6 +1674,10 @@ var UpdateBuilder = class {
   }
   /**
    * Adds this update operation to a transaction.
+   * Use this method when you need to:
+   * - Update items as part of a larger transaction
+   * - Ensure multiple updates are atomic
+   * - Coordinate updates across multiple items
    *
    * @example
    * ```typescript
@@ -1626,6 +1707,11 @@ var UpdateBuilder = class {
   }
   /**
    * Gets a human-readable representation of the update command.
+   * Use this method when you need to:
+   * - Debug complex update expressions
+   * - Verify attribute names and values
+   * - Log update operations
+   * - Troubleshoot condition expressions
    *
    * @example
    * ```typescript
@@ -1652,6 +1738,10 @@ var UpdateBuilder = class {
   }
   /**
    * Executes the update operation against DynamoDB.
+   * Use this method when you need to:
+   * - Apply updates immediately
+   * - Get the updated item values
+   * - Handle conditional update failures
    *
    * @example
    * ```typescript
@@ -1686,7 +1776,7 @@ var UpdateBuilder = class {
    * }
    * ```
    *
-   * @returns A promise that resolves to an DynamoItem containing the updated item (if returnValues is set)
+   * @returns A promise that resolves to an object containing the updated item (if returnValues is set)
    * @throws {ConditionalCheckFailedException} If the condition check fails
    * @throws {Error} If the update operation fails for other reasons
    */
@@ -1740,7 +1830,7 @@ var TransactionBuilder = class {
    */
   checkForDuplicateItem(tableName, newItem) {
     const pkName = this.indexConfig.partitionKey;
-    const skName = this.indexConfig.sortKey ?? "";
+    const skName = this.indexConfig.sortKey || "";
     const pkValue = newItem[pkName];
     const skValue = skName ? newItem[skName] : void 0;
     if (!pkValue) {
@@ -1781,18 +1871,6 @@ var TransactionBuilder = class {
       );
     }
   }
-  createKeyForPrimaryIndex(key) {
-    const keyCondition = {
-      [this.indexConfig.partitionKey]: key.pk
-    };
-    if (this.indexConfig.sortKey) {
-      if (key.sk === void 0) {
-        throw new Error("Sort key is required for delete operation");
-      }
-      keyCondition[this.indexConfig.sortKey] = key.sk;
-    }
-    return keyCondition;
-  }
   /**
    * Adds a put operation to the transaction.
    * Use this method when you need to:
@@ -1932,13 +2010,15 @@ var TransactionBuilder = class {
    * @throws {Error} If a duplicate item is detected in the transaction
    */
   delete(tableName, key, condition) {
-    const keyCondition = this.createKeyForPrimaryIndex(key);
-    this.checkForDuplicateItem(tableName, keyCondition);
+    this.checkForDuplicateItem(tableName, key);
     const transactionItem = {
       type: "Delete",
       params: {
         tableName,
-        key: keyCondition
+        key: {
+          pk: key.pk,
+          sk: key.sk
+        }
       }
     };
     if (condition) {
@@ -1980,14 +2060,10 @@ var TransactionBuilder = class {
    * @see DeleteBuilder for creating delete commands
    */
   deleteWithCommand(command) {
-    const keyCondition = this.createKeyForPrimaryIndex(command.key);
-    this.checkForDuplicateItem(command.tableName, keyCondition);
+    this.checkForDuplicateItem(command.tableName, command.key);
     const transactionItem = {
       type: "Delete",
-      params: {
-        ...command,
-        key: keyCondition
-      }
+      params: command
     };
     this.items.push(transactionItem);
     return this;
@@ -2047,13 +2123,15 @@ var TransactionBuilder = class {
    * @throws {Error} If a duplicate item is detected in the transaction
    */
   update(tableName, key, updateExpression, expressionAttributeNames, expressionAttributeValues, condition) {
-    const keyCondition = this.createKeyForPrimaryIndex(key);
-    this.checkForDuplicateItem(tableName, keyCondition);
+    this.checkForDuplicateItem(tableName, key);
     const transactionItem = {
       type: "Update",
       params: {
         tableName,
-        key: keyCondition,
+        key: {
+          pk: key.pk,
+          sk: key.sk
+        },
         updateExpression,
         expressionAttributeNames,
         expressionAttributeValues
@@ -2107,14 +2185,10 @@ var TransactionBuilder = class {
    * @see UpdateBuilder for creating update commands
    */
   updateWithCommand(command) {
-    const keyCondition = this.createKeyForPrimaryIndex(command.key);
-    this.checkForDuplicateItem(command.tableName, keyCondition);
+    this.checkForDuplicateItem(command.tableName, command.key);
     const transactionItem = {
       type: "Update",
-      params: {
-        ...command,
-        key: keyCondition
-      }
+      params: command
     };
     this.items.push(transactionItem);
     return this;
@@ -2171,8 +2245,7 @@ var TransactionBuilder = class {
    * @throws {Error} If condition expression generation fails
    */
   conditionCheck(tableName, key, condition) {
-    const keyCondition = this.createKeyForPrimaryIndex(key);
-    this.checkForDuplicateItem(tableName, keyCondition);
+    this.checkForDuplicateItem(tableName, key);
     const { expression, names, values } = prepareExpressionParams(condition);
     if (!expression) {
       throw new Error("Failed to generate condition expression");
@@ -2181,7 +2254,10 @@ var TransactionBuilder = class {
       type: "ConditionCheck",
       params: {
         tableName,
-        key: keyCondition,
+        key: {
+          pk: key.pk,
+          sk: key.sk
+        },
         conditionExpression: expression,
         expressionAttributeNames: names,
         expressionAttributeValues: values
@@ -2221,14 +2297,10 @@ var TransactionBuilder = class {
    * @see ConditionCheckBuilder for creating condition check commands
    */
   conditionCheckWithCommand(command) {
-    const keyCondition = this.createKeyForPrimaryIndex(command.key);
-    this.checkForDuplicateItem(command.tableName, keyCondition);
+    this.checkForDuplicateItem(command.tableName, command.key);
     const transactionItem = {
       type: "ConditionCheck",
-      params: {
-        ...command,
-        key: keyCondition
-      }
+      params: command
     };
     this.items.push(transactionItem);
     return this;
@@ -2461,7 +2533,7 @@ var ConditionCheckBuilder = class {
    * );
    * ```
    *
-   * @param condition - Either a Condition DynamoItem or a callback function that builds the condition
+   * @param condition - Either a Condition object or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
   condition(condition) {
@@ -2687,18 +2759,18 @@ var GetBuilder = class {
    *          - item: The retrieved dinosaur or undefined if not found
    */
   async execute() {
-    const expressionParams = {
-      expressionAttributeNames: {},
-      expressionAttributeValues: {},
-      valueCounter: { count: 0 }
-    };
-    const projectionExpression = Array.from(this.selectedFields).map((p) => generateAttributeName(expressionParams, p)).join(", ");
-    const { expressionAttributeNames } = expressionParams;
-    return this.executor({
-      ...this.params,
-      projectionExpression: projectionExpression.length > 0 ? projectionExpression : void 0,
-      expressionAttributeNames: Object.keys(expressionAttributeNames).length > 0 ? expressionAttributeNames : void 0
-    });
+    if (this.selectedFields.size > 0) {
+      const expressionAttributeNames = {};
+      const projectionParts = [];
+      for (const path of this.selectedFields) {
+        const attrName = `#attr${projectionParts.length}`;
+        expressionAttributeNames[attrName] = path;
+        projectionParts.push(attrName);
+      }
+      this.params.projectionExpression = projectionParts.join(", ");
+      this.params.expressionAttributeNames = expressionAttributeNames;
+    }
+    return this.executor(this.params);
   }
 };
 
@@ -2793,16 +2865,6 @@ var Table = class {
     this.sortKey = config.indexes.sortKey;
     this.gsis = config.indexes.gsis || {};
   }
-  createKeyForPrimaryIndex(keyCondition) {
-    const primaryCondition = { [this.partitionKey]: keyCondition.pk };
-    if (this.sortKey) {
-      if (!keyCondition.sk) {
-        throw new Error("Sort key has not been provided but the Table has a sort key");
-      }
-      primaryCondition[this.sortKey] = keyCondition.sk;
-    }
-    return primaryCondition;
-  }
   /**
    * Creates a new item in the table, it will fail if the item already exists
    *
@@ -2817,7 +2879,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.get({
           TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
+          Key: params.key,
           ProjectionExpression: params.projectionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
           ConsistentRead: params.consistentRead
@@ -2852,12 +2914,13 @@ var Table = class {
           ReturnValues: params.returnValues === "CONSISTENT" ? "NONE" : params.returnValues
         });
         if (params.returnValues === "CONSISTENT") {
+          const key = {
+            pk: params.item[this.partitionKey],
+            ...this.sortKey && { sk: params.item[this.sortKey] }
+          };
           const getResult = await this.dynamoClient.get({
             TableName: params.tableName,
-            Key: this.createKeyForPrimaryIndex({
-              pk: params.item[this.partitionKey],
-              ...this.sortKey && { sk: params.item[this.sortKey] }
-            }),
+            Key: key,
             ConsistentRead: true
           });
           return getResult.Item;
@@ -3041,7 +3104,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.delete({
           TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
+          Key: params.key,
           ConditionExpression: params.conditionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
           ExpressionAttributeValues: params.expressionAttributeValues,
@@ -3068,7 +3131,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.update({
           TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
+          Key: params.key,
           UpdateExpression: params.updateExpression,
           ConditionExpression: params.conditionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
@@ -3196,7 +3259,10 @@ var Table = class {
         }
         return {
           DeleteRequest: {
-            Key: this.createKeyForPrimaryIndex(operation.key)
+            Key: {
+              [this.partitionKey]: operation.key.pk,
+              ...this.sortKey ? { [this.sortKey]: operation.key.sk } : {}
+            }
           }
         };
       });
@@ -3239,7 +3305,29 @@ var Table = class {
     };
   }
 };
-
-exports.Table = Table;
-//# sourceMappingURL=table.cjs.map
-//# sourceMappingURL=table.cjs.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConditionCheckBuilder,
+  DeleteBuilder,
+  Paginator,
+  PutBuilder,
+  QueryBuilder,
+  Table,
+  TransactionBuilder,
+  UpdateBuilder,
+  and,
+  attributeExists,
+  attributeNotExists,
+  beginsWith,
+  between,
+  contains,
+  createComparisonCondition,
+  eq,
+  gt,
+  gte,
+  lt,
+  lte,
+  ne,
+  not,
+  or
+});