dyno-table 0.1.8 → 0.2.0-0

package/dist/table.cjs

@@ -863,6 +863,14 @@ 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:
@@ -1107,10 +1115,6 @@ 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
@@ -1162,10 +1166,6 @@ 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,10 +1206,6 @@ 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
@@ -1260,11 +1256,6 @@ 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
@@ -1323,10 +1314,6 @@ 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
@@ -1353,10 +1340,6 @@ 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
@@ -1385,10 +1368,6 @@ 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
@@ -1398,7 +1377,7 @@ var UpdateBuilder = class {
    *   ['JUNGLE', 'COASTAL']
    * );
    *
-   * // Remove from sets using Set objects
+   * // Remove from sets using Set DynamoItems
    * builder.deleteElementsFromSet(
    *   'knownBehaviors',
    *   new Set(['NOCTURNAL', 'TERRITORIAL'])
@@ -1431,11 +1410,6 @@ 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
@@ -1467,7 +1441,7 @@ var UpdateBuilder = class {
    * );
    * ```
    *
-   * @param condition - Either a Condition object or a callback function that builds the condition
+   * @param condition - Either a Condition DynamoItem or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
   condition(condition) {
@@ -1496,11 +1470,6 @@ 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
@@ -1628,10 +1597,6 @@ 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
@@ -1661,11 +1626,6 @@ 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
@@ -1692,10 +1652,6 @@ 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
@@ -1730,7 +1686,7 @@ var UpdateBuilder = class {
    * }
    * ```
    *
-   * @returns A promise that resolves to an object containing the updated item (if returnValues is set)
+   * @returns A promise that resolves to an DynamoItem 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
    */
@@ -1784,7 +1740,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) {
@@ -1825,6 +1781,18 @@ 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:
@@ -1964,15 +1932,13 @@ var TransactionBuilder = class {
    * @throws {Error} If a duplicate item is detected in the transaction
    */
   delete(tableName, key, condition) {
-    this.checkForDuplicateItem(tableName, key);
+    const keyCondition = this.createKeyForPrimaryIndex(key);
+    this.checkForDuplicateItem(tableName, keyCondition);
     const transactionItem = {
       type: "Delete",
       params: {
         tableName,
-        key: {
-          pk: key.pk,
-          sk: key.sk
-        }
+        key: keyCondition
       }
     };
     if (condition) {
@@ -2014,10 +1980,14 @@ var TransactionBuilder = class {
    * @see DeleteBuilder for creating delete commands
    */
   deleteWithCommand(command) {
-    this.checkForDuplicateItem(command.tableName, command.key);
+    const keyCondition = this.createKeyForPrimaryIndex(command.key);
+    this.checkForDuplicateItem(command.tableName, keyCondition);
     const transactionItem = {
       type: "Delete",
-      params: command
+      params: {
+        ...command,
+        key: keyCondition
+      }
     };
     this.items.push(transactionItem);
     return this;
@@ -2077,15 +2047,13 @@ var TransactionBuilder = class {
    * @throws {Error} If a duplicate item is detected in the transaction
    */
   update(tableName, key, updateExpression, expressionAttributeNames, expressionAttributeValues, condition) {
-    this.checkForDuplicateItem(tableName, key);
+    const keyCondition = this.createKeyForPrimaryIndex(key);
+    this.checkForDuplicateItem(tableName, keyCondition);
     const transactionItem = {
       type: "Update",
       params: {
         tableName,
-        key: {
-          pk: key.pk,
-          sk: key.sk
-        },
+        key: keyCondition,
         updateExpression,
         expressionAttributeNames,
         expressionAttributeValues
@@ -2139,10 +2107,14 @@ var TransactionBuilder = class {
    * @see UpdateBuilder for creating update commands
    */
   updateWithCommand(command) {
-    this.checkForDuplicateItem(command.tableName, command.key);
+    const keyCondition = this.createKeyForPrimaryIndex(command.key);
+    this.checkForDuplicateItem(command.tableName, keyCondition);
     const transactionItem = {
       type: "Update",
-      params: command
+      params: {
+        ...command,
+        key: keyCondition
+      }
     };
     this.items.push(transactionItem);
     return this;
@@ -2199,7 +2171,8 @@ var TransactionBuilder = class {
    * @throws {Error} If condition expression generation fails
    */
   conditionCheck(tableName, key, condition) {
-    this.checkForDuplicateItem(tableName, key);
+    const keyCondition = this.createKeyForPrimaryIndex(key);
+    this.checkForDuplicateItem(tableName, keyCondition);
     const { expression, names, values } = prepareExpressionParams(condition);
     if (!expression) {
       throw new Error("Failed to generate condition expression");
@@ -2208,10 +2181,7 @@ var TransactionBuilder = class {
       type: "ConditionCheck",
       params: {
         tableName,
-        key: {
-          pk: key.pk,
-          sk: key.sk
-        },
+        key: keyCondition,
         conditionExpression: expression,
         expressionAttributeNames: names,
         expressionAttributeValues: values
@@ -2251,10 +2221,14 @@ var TransactionBuilder = class {
    * @see ConditionCheckBuilder for creating condition check commands
    */
   conditionCheckWithCommand(command) {
-    this.checkForDuplicateItem(command.tableName, command.key);
+    const keyCondition = this.createKeyForPrimaryIndex(command.key);
+    this.checkForDuplicateItem(command.tableName, keyCondition);
     const transactionItem = {
       type: "ConditionCheck",
-      params: command
+      params: {
+        ...command,
+        key: keyCondition
+      }
     };
     this.items.push(transactionItem);
     return this;
@@ -2487,7 +2461,7 @@ var ConditionCheckBuilder = class {
    * );
    * ```
    *
-   * @param condition - Either a Condition object or a callback function that builds the condition
+   * @param condition - Either a Condition DynamoItem or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
   condition(condition) {
@@ -2713,18 +2687,18 @@ var GetBuilder = class {
    *          - item: The retrieved dinosaur or undefined if not found
    */
   async execute() {
-    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);
+    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
+    });
   }
 };
 
@@ -2819,6 +2793,16 @@ 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
    *
@@ -2833,7 +2817,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.get({
           TableName: params.tableName,
-          Key: params.key,
+          Key: this.createKeyForPrimaryIndex(keyCondition),
           ProjectionExpression: params.projectionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
           ConsistentRead: params.consistentRead
@@ -2868,13 +2852,12 @@ 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: key,
+            Key: this.createKeyForPrimaryIndex({
+              pk: params.item[this.partitionKey],
+              ...this.sortKey && { sk: params.item[this.sortKey] }
+            }),
             ConsistentRead: true
           });
           return getResult.Item;
@@ -3058,7 +3041,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.delete({
           TableName: params.tableName,
-          Key: params.key,
+          Key: this.createKeyForPrimaryIndex(keyCondition),
           ConditionExpression: params.conditionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
           ExpressionAttributeValues: params.expressionAttributeValues,
@@ -3085,7 +3068,7 @@ var Table = class {
       try {
         const result = await this.dynamoClient.update({
           TableName: params.tableName,
-          Key: params.key,
+          Key: this.createKeyForPrimaryIndex(keyCondition),
           UpdateExpression: params.updateExpression,
           ConditionExpression: params.conditionExpression,
           ExpressionAttributeNames: params.expressionAttributeNames,
@@ -3213,10 +3196,7 @@ var Table = class {
         }
         return {
           DeleteRequest: {
-            Key: {
-              [this.partitionKey]: operation.key.pk,
-              ...this.sortKey ? { [this.sortKey]: operation.key.sk } : {}
-            }
+            Key: this.createKeyForPrimaryIndex(operation.key)
           }
         };
       });