dyno-table 2.6.0 → 2.6.2

package/dist/chunk-ZUBCW3LA.cjs

@@ -1,579 +0,0 @@
-'use strict';
-
-var chunk3DR6VOFW_cjs = require('./chunk-3DR6VOFW.cjs');
-var chunkELULXDSB_cjs = require('./chunk-ELULXDSB.cjs');
-var chunk7UJJ7JXM_cjs = require('./chunk-7UJJ7JXM.cjs');
-
-// src/utils/chunk-array.ts
-function* chunkArray(array, size) {
-  if (size <= 0) {
-    throw chunkELULXDSB_cjs.ConfigurationErrors.invalidChunkSize(size);
-  }
-  for (let i = 0; i < array.length; i += size) {
-    yield array.slice(i, i + size);
-  }
-}
-
-// src/table.ts
-var DDB_BATCH_WRITE_LIMIT = 25;
-var DDB_BATCH_GET_LIMIT = 100;
-var Table = class {
-  dynamoClient;
-  tableName;
-  /**
-   * The column name of the partitionKey for the Table
-   */
-  partitionKey;
-  /**
-   * The column name of the sortKey for the Table
-   */
-  sortKey;
-  /**
-   * The Global Secondary Indexes that are configured on this table
-   */
-  gsis;
-  constructor(config) {
-    this.dynamoClient = config.client;
-    this.tableName = config.tableName;
-    this.partitionKey = config.indexes.partitionKey;
-    this.sortKey = config.indexes.sortKey;
-    this.gsis = config.indexes.gsis || {};
-  }
-  getIndexAttributeNames() {
-    const names = /* @__PURE__ */ new Set();
-    for (const gsi of Object.values(this.gsis)) {
-      names.add(gsi.partitionKey);
-      if (gsi.sortKey) {
-        names.add(gsi.sortKey);
-      }
-    }
-    return Array.from(names);
-  }
-  createKeyForPrimaryIndex(keyCondition) {
-    const primaryCondition = { [this.partitionKey]: keyCondition.pk };
-    if (this.sortKey) {
-      if (!keyCondition.sk) {
-        throw chunkELULXDSB_cjs.ConfigurationErrors.sortKeyRequired(this.tableName, this.partitionKey, this.sortKey);
-      }
-      primaryCondition[this.sortKey] = keyCondition.sk;
-    }
-    return primaryCondition;
-  }
-  /**
-   * Creates a new item in the table, it will fail if the item already exists.
-   *
-   * By default, this method returns the input values passed to the create operation
-   * upon successful creation.
-   *
-   * You can customise the return behaviour by chaining the `.returnValues()` method:
-   *
-   * @param item The item to create
-   * @returns A PutBuilder instance for chaining additional conditions and executing the create operation
-   *
-   * @example
-   * ```ts
-   * // Create with default behavior (returns input values)
-   * const result = await table.create({
-   *   id: 'user-123',
-   *   name: 'John Doe',
-   *   email: 'john@example.com'
-   * }).execute();
-   * console.log(result); // Returns the input object
-   *
-   * // Create with no return value for better performance
-   * await table.create(userData).returnValues('NONE').execute();
-   *
-   * // Create and get fresh data from dynamodb using a strongly consistent read
-   * const freshData = await table.create(userData).returnValues('CONSISTENT').execute();
-   *
-   * // Create and get previous values (if the item was overwritten)
-   * const oldData = await table.create(userData).returnValues('ALL_OLD').execute();
-   * ```
-   */
-  create(item) {
-    return this.put(item).condition((op) => op.attributeNotExists(this.partitionKey)).returnValues("INPUT");
-  }
-  get(keyCondition) {
-    const indexAttributeNames = this.getIndexAttributeNames();
-    const executor = async (params) => {
-      try {
-        const result = await this.dynamoClient.get({
-          TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
-          ProjectionExpression: params.projectionExpression,
-          ExpressionAttributeNames: params.expressionAttributeNames,
-          ConsistentRead: params.consistentRead
-        });
-        return {
-          item: result.Item ? result.Item : void 0
-        };
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.getFailed(params.tableName, keyCondition, error instanceof Error ? error : void 0);
-      }
-    };
-    return new chunk3DR6VOFW_cjs.GetBuilder(executor, keyCondition, this.tableName, indexAttributeNames);
-  }
-  /**
-   * Updates an item in the table
-   *
-   * @param item The item to update
-   * @returns A PutBuilder instance for chaining conditions and executing the put operation
-   */
-  put(item) {
-    const executor = async (params) => {
-      try {
-        const result = await this.dynamoClient.put({
-          TableName: params.tableName,
-          Item: params.item,
-          ConditionExpression: params.conditionExpression,
-          ExpressionAttributeNames: params.expressionAttributeNames,
-          ExpressionAttributeValues: params.expressionAttributeValues,
-          // CONSISTENT and INPUT are not valid ReturnValues for DDB, so we set NONE as we are not interested in its
-          // response and will be handling these cases separately
-          ReturnValues: params.returnValues === "CONSISTENT" || params.returnValues === "INPUT" ? "NONE" : params.returnValues
-        });
-        if (params.returnValues === "INPUT") {
-          return params.item;
-        }
-        if (params.returnValues === "CONSISTENT") {
-          const getResult = await this.dynamoClient.get({
-            TableName: params.tableName,
-            Key: this.createKeyForPrimaryIndex({
-              pk: params.item[this.partitionKey],
-              ...this.sortKey && { sk: params.item[this.sortKey] }
-            }),
-            ConsistentRead: true
-          });
-          return getResult.Item;
-        }
-        return result.Attributes;
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.putFailed(params.tableName, params.item, error instanceof Error ? error : void 0);
-      }
-    };
-    return new chunk3DR6VOFW_cjs.PutBuilder(executor, item, this.tableName);
-  }
-  /**
-   * Creates a query builder for complex queries
-   * If useIndex is called on the returned QueryBuilder, it will use the GSI configuration
-   */
-  query(keyCondition) {
-    const indexAttributeNames = this.getIndexAttributeNames();
-    const pkAttributeName = this.partitionKey;
-    const skAttributeName = this.sortKey;
-    let keyConditionExpression = chunk7UJJ7JXM_cjs.eq(pkAttributeName, keyCondition.pk);
-    if (keyCondition.sk) {
-      if (!skAttributeName) {
-        throw chunkELULXDSB_cjs.ConfigurationErrors.sortKeyNotDefined(this.tableName, pkAttributeName);
-      }
-      const keyConditionOperator = {
-        eq: (value) => chunk7UJJ7JXM_cjs.eq(skAttributeName, value),
-        lt: (value) => chunk7UJJ7JXM_cjs.lt(skAttributeName, value),
-        lte: (value) => chunk7UJJ7JXM_cjs.lte(skAttributeName, value),
-        gt: (value) => chunk7UJJ7JXM_cjs.gt(skAttributeName, value),
-        gte: (value) => chunk7UJJ7JXM_cjs.gte(skAttributeName, value),
-        between: (lower, upper) => chunk7UJJ7JXM_cjs.between(skAttributeName, lower, upper),
-        beginsWith: (value) => chunk7UJJ7JXM_cjs.beginsWith(skAttributeName, value),
-        and: (...conditions) => chunk7UJJ7JXM_cjs.and(...conditions)
-      };
-      const skCondition = keyCondition.sk(keyConditionOperator);
-      keyConditionExpression = chunk7UJJ7JXM_cjs.and(chunk7UJJ7JXM_cjs.eq(pkAttributeName, keyCondition.pk), skCondition);
-    }
-    const executor = async (originalKeyCondition, options) => {
-      let finalKeyCondition = originalKeyCondition;
-      if (options.indexName) {
-        const gsiName = String(options.indexName);
-        const gsi = this.gsis[gsiName];
-        if (!gsi) {
-          throw chunkELULXDSB_cjs.ConfigurationErrors.gsiNotFound(gsiName, this.tableName, Object.keys(this.gsis));
-        }
-        const gsiPkAttributeName = gsi.partitionKey;
-        const gsiSkAttributeName = gsi.sortKey;
-        let pkValue;
-        let skValue;
-        let extractedSkCondition;
-        if (originalKeyCondition.type === "eq") {
-          pkValue = originalKeyCondition.value;
-        } else if (originalKeyCondition.type === "and" && originalKeyCondition.conditions) {
-          const pkCondition = originalKeyCondition.conditions.find(
-            (c) => c.type === "eq" && c.attr === pkAttributeName
-          );
-          if (pkCondition && pkCondition.type === "eq") {
-            pkValue = pkCondition.value;
-          }
-          const skConditions = originalKeyCondition.conditions.filter((c) => c.attr === skAttributeName);
-          if (skConditions.length > 0) {
-            if (skConditions.length === 1) {
-              extractedSkCondition = skConditions[0];
-              if (extractedSkCondition && extractedSkCondition.type === "eq") {
-                skValue = extractedSkCondition.value;
-              }
-            } else if (skConditions.length > 1) {
-              extractedSkCondition = chunk7UJJ7JXM_cjs.and(...skConditions);
-            }
-          }
-        }
-        if (!pkValue) {
-          throw chunkELULXDSB_cjs.ConfigurationErrors.pkExtractionFailed(this.tableName, options.indexName, originalKeyCondition);
-        }
-        let gsiKeyCondition = chunk7UJJ7JXM_cjs.eq(gsiPkAttributeName, pkValue);
-        if (skValue && gsiSkAttributeName) {
-          gsiKeyCondition = chunk7UJJ7JXM_cjs.and(gsiKeyCondition, chunk7UJJ7JXM_cjs.eq(gsiSkAttributeName, skValue));
-        } else if (extractedSkCondition && gsiSkAttributeName) {
-          if (extractedSkCondition.attr === skAttributeName) {
-            const updatedSkCondition = {
-              ...extractedSkCondition,
-              attr: gsiSkAttributeName
-            };
-            gsiKeyCondition = chunk7UJJ7JXM_cjs.and(gsiKeyCondition, updatedSkCondition);
-          } else {
-            gsiKeyCondition = chunk7UJJ7JXM_cjs.and(gsiKeyCondition, extractedSkCondition);
-          }
-        }
-        finalKeyCondition = gsiKeyCondition;
-      }
-      const expressionParams = {
-        expressionAttributeNames: {},
-        expressionAttributeValues: {},
-        valueCounter: { count: 0 }
-      };
-      const keyConditionExpression2 = chunk3DR6VOFW_cjs.buildExpression(finalKeyCondition, expressionParams);
-      let filterExpression;
-      if (options.filter) {
-        filterExpression = chunk3DR6VOFW_cjs.buildExpression(options.filter, expressionParams);
-      }
-      const projectionExpression = options.projection?.map((p) => chunk3DR6VOFW_cjs.generateAttributeName(expressionParams, p)).join(", ");
-      const { expressionAttributeNames, expressionAttributeValues } = expressionParams;
-      const { indexName, limit, consistentRead, scanIndexForward, lastEvaluatedKey } = options;
-      const params = {
-        TableName: this.tableName,
-        KeyConditionExpression: keyConditionExpression2,
-        FilterExpression: filterExpression,
-        ExpressionAttributeNames: expressionAttributeNames,
-        ExpressionAttributeValues: expressionAttributeValues,
-        IndexName: indexName,
-        Limit: limit,
-        ConsistentRead: consistentRead,
-        ScanIndexForward: scanIndexForward,
-        ProjectionExpression: projectionExpression,
-        ExclusiveStartKey: lastEvaluatedKey
-      };
-      try {
-        const result = await this.dynamoClient.query(params);
-        return {
-          items: result.Items,
-          lastEvaluatedKey: result.LastEvaluatedKey
-        };
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.queryFailed(
-          this.tableName,
-          { indexName, keyConditionExpression: keyConditionExpression2, filterExpression },
-          error instanceof Error ? error : void 0
-        );
-      }
-    };
-    return new chunk3DR6VOFW_cjs.QueryBuilder(executor, keyConditionExpression, indexAttributeNames);
-  }
-  /**
-   * Creates a scan builder for scanning the entire table
-   * Use this when you need to:
-   * - Process all items in a table
-   * - Apply filters to a large dataset
-   * - Use a GSI for scanning
-   *
-   * @returns A ScanBuilder instance for chaining operations
-   */
-  scan() {
-    const executor = async (options) => {
-      const expressionParams = {
-        expressionAttributeNames: {},
-        expressionAttributeValues: {},
-        valueCounter: { count: 0 }
-      };
-      let filterExpression;
-      if (options.filter) {
-        filterExpression = chunk3DR6VOFW_cjs.buildExpression(options.filter, expressionParams);
-      }
-      const projectionExpression = options.projection?.map((p) => chunk3DR6VOFW_cjs.generateAttributeName(expressionParams, p)).join(", ");
-      const { expressionAttributeNames, expressionAttributeValues } = expressionParams;
-      const { indexName, limit, consistentRead, lastEvaluatedKey } = options;
-      const params = {
-        TableName: this.tableName,
-        FilterExpression: filterExpression,
-        ExpressionAttributeNames: Object.keys(expressionAttributeNames).length > 0 ? expressionAttributeNames : void 0,
-        ExpressionAttributeValues: Object.keys(expressionAttributeValues).length > 0 ? expressionAttributeValues : void 0,
-        IndexName: indexName,
-        Limit: limit,
-        ConsistentRead: consistentRead,
-        ProjectionExpression: projectionExpression,
-        ExclusiveStartKey: lastEvaluatedKey
-      };
-      try {
-        const result = await this.dynamoClient.scan(params);
-        return {
-          items: result.Items,
-          lastEvaluatedKey: result.LastEvaluatedKey
-        };
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.scanFailed(
-          this.tableName,
-          { indexName: options.indexName, filterExpression },
-          error instanceof Error ? error : void 0
-        );
-      }
-    };
-    return new chunk3DR6VOFW_cjs.ScanBuilder(executor);
-  }
-  delete(keyCondition) {
-    const executor = async (params) => {
-      try {
-        const result = await this.dynamoClient.delete({
-          TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
-          ConditionExpression: params.conditionExpression,
-          ExpressionAttributeNames: params.expressionAttributeNames,
-          ExpressionAttributeValues: params.expressionAttributeValues,
-          ReturnValues: params.returnValues
-        });
-        return {
-          item: result.Attributes
-        };
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.deleteFailed(params.tableName, keyCondition, error instanceof Error ? error : void 0);
-      }
-    };
-    return new chunk3DR6VOFW_cjs.DeleteBuilder(executor, this.tableName, keyCondition);
-  }
-  /**
-   * Updates an item in the table
-   *
-   * @param keyCondition The primary key of the item to update
-   * @returns An UpdateBuilder instance for chaining update operations and conditions
-   */
-  update(keyCondition) {
-    const executor = async (params) => {
-      try {
-        const result = await this.dynamoClient.update({
-          TableName: params.tableName,
-          Key: this.createKeyForPrimaryIndex(keyCondition),
-          UpdateExpression: params.updateExpression,
-          ConditionExpression: params.conditionExpression,
-          ExpressionAttributeNames: params.expressionAttributeNames,
-          ExpressionAttributeValues: params.expressionAttributeValues,
-          ReturnValues: params.returnValues
-        });
-        return {
-          item: result.Attributes
-        };
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.updateFailed(params.tableName, keyCondition, error instanceof Error ? error : void 0);
-      }
-    };
-    return new chunk3DR6VOFW_cjs.UpdateBuilder(executor, this.tableName, keyCondition);
-  }
-  /**
-   * Creates a transaction builder for performing multiple operations atomically
-   */
-  transactionBuilder() {
-    const executor = async (params) => {
-      await this.dynamoClient.transactWrite(params);
-    };
-    return new chunk3DR6VOFW_cjs.TransactionBuilder(executor, {
-      partitionKey: this.partitionKey,
-      sortKey: this.sortKey
-    });
-  }
-  /**
-   * Creates a batch builder for performing multiple operations efficiently with optional type inference
-   *
-   * @example Basic Usage
-   * ```typescript
-   * const batch = table.batchBuilder();
-   *
-   * // Add operations
-   * userRepo.create(newUser).withBatch(batch);
-   * orderRepo.get({ id: 'order-1' }).withBatch(batch);
-   *
-   * // Execute operations
-   * const result = await batch.execute();
-   * ```
-   *
-   * @example Typed Usage
-   * ```typescript
-   * // Define entity types for the batch
-   * const batch = table.batchBuilder<{
-   *   User: UserEntity;
-   *   Order: OrderEntity;
-   *   Product: ProductEntity;
-   * }>();
-   *
-   * // Add operations with type information
-   * userRepo.create(newUser).withBatch(batch, 'User');
-   * orderRepo.get({ id: 'order-1' }).withBatch(batch, 'Order');
-   * productRepo.delete({ id: 'old-product' }).withBatch(batch, 'Product');
-   *
-   * // Execute and get typed results
-   * const result = await batch.execute();
-   * const users: UserEntity[] = result.reads.itemsByType.User;
-   * const orders: OrderEntity[] = result.reads.itemsByType.Order;
-   * ```
-   */
-  batchBuilder() {
-    const batchWriteExecutor = async (operations) => {
-      return this.batchWrite(operations);
-    };
-    const batchGetExecutor = async (keys) => {
-      return this.batchGet(keys);
-    };
-    return new chunk3DR6VOFW_cjs.BatchBuilder(batchWriteExecutor, batchGetExecutor, {
-      partitionKey: this.partitionKey,
-      sortKey: this.sortKey
-    });
-  }
-  /**
-   * Executes a transaction using a callback function
-   *
-   * @param callback A function that receives a transaction context and performs operations on it
-   * @param options Optional transaction options
-   * @returns A promise that resolves when the transaction is complete
-   */
-  async transaction(callback, options) {
-    const transactionExecutor = async (params) => {
-      await this.dynamoClient.transactWrite(params);
-    };
-    const transaction = new chunk3DR6VOFW_cjs.TransactionBuilder(transactionExecutor, {
-      partitionKey: this.partitionKey,
-      sortKey: this.sortKey
-    });
-    if (options) {
-      transaction.withOptions(options);
-    }
-    const result = await callback(transaction);
-    await transaction.execute();
-    return result;
-  }
-  /**
-   * Creates a condition check operation for use in transactions
-   *
-   * This is useful for when you require a transaction to succeed only when a specific condition is met on a
-   * a record within the database that you are not directly updating.
-   *
-   * For example, you are updating a record and you want to ensure that another record exists and/or has a specific value before proceeding.
-   */
-  conditionCheck(keyCondition) {
-    return new chunk3DR6VOFW_cjs.ConditionCheckBuilder(this.tableName, keyCondition);
-  }
-  /**
-   * Performs a batch get operation to retrieve multiple items at once
-   *
-   * @param keys Array of primary keys to retrieve
-   * @returns A promise that resolves to the retrieved items
-   */
-  async batchGet(keys) {
-    const allItems = [];
-    const allUnprocessedKeys = [];
-    for (const chunk of chunkArray(keys, DDB_BATCH_GET_LIMIT)) {
-      const formattedKeys = chunk.map((key) => ({
-        [this.partitionKey]: key.pk,
-        ...this.sortKey ? { [this.sortKey]: key.sk } : {}
-      }));
-      const params = {
-        RequestItems: {
-          [this.tableName]: {
-            Keys: formattedKeys
-          }
-        }
-      };
-      try {
-        const result = await this.dynamoClient.batchGet(params);
-        if (result.Responses?.[this.tableName]) {
-          allItems.push(...result.Responses[this.tableName]);
-        }
-        const unprocessedKeysArray = result.UnprocessedKeys?.[this.tableName]?.Keys || [];
-        const unprocessedKeys = unprocessedKeysArray.map((key) => ({
-          pk: key[this.partitionKey],
-          sk: this.sortKey ? key[this.sortKey] : void 0
-        }));
-        if (unprocessedKeys.length > 0) {
-          allUnprocessedKeys.push(...unprocessedKeys);
-        }
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.batchGetFailed(
-          this.tableName,
-          { requestedKeys: keys.length },
-          error instanceof Error ? error : void 0
-        );
-      }
-    }
-    return {
-      items: allItems,
-      unprocessedKeys: allUnprocessedKeys
-    };
-  }
-  /**
-   * Performs a batch write operation to put or delete multiple items at once
-   *
-   * @param operations Array of put or delete operations
-   * @returns A promise that resolves to any unprocessed operations
-   */
-  async batchWrite(operations) {
-    const allUnprocessedItems = [];
-    for (const chunk of chunkArray(operations, DDB_BATCH_WRITE_LIMIT)) {
-      const writeRequests = chunk.map((operation) => {
-        if (operation.type === "put") {
-          return {
-            PutRequest: {
-              Item: operation.item
-            }
-          };
-        }
-        return {
-          DeleteRequest: {
-            Key: this.createKeyForPrimaryIndex(operation.key)
-          }
-        };
-      });
-      const params = {
-        RequestItems: {
-          [this.tableName]: writeRequests
-        }
-      };
-      try {
-        const result = await this.dynamoClient.batchWrite(params);
-        const unprocessedRequestsArray = result.UnprocessedItems?.[this.tableName] || [];
-        if (unprocessedRequestsArray.length > 0) {
-          const unprocessedItems = unprocessedRequestsArray.map((request) => {
-            if (request?.PutRequest?.Item) {
-              return {
-                type: "put",
-                item: request.PutRequest.Item
-              };
-            }
-            if (request?.DeleteRequest?.Key) {
-              return {
-                type: "delete",
-                key: {
-                  pk: request.DeleteRequest.Key[this.partitionKey],
-                  sk: this.sortKey ? request.DeleteRequest.Key[this.sortKey] : void 0
-                }
-              };
-            }
-            throw new Error("Invalid unprocessed item format returned from DynamoDB");
-          });
-          allUnprocessedItems.push(...unprocessedItems);
-        }
-      } catch (error) {
-        throw chunkELULXDSB_cjs.OperationErrors.batchWriteFailed(
-          this.tableName,
-          { requestedOperations: operations.length },
-          error instanceof Error ? error : void 0
-        );
-      }
-    }
-    return {
-      unprocessedItems: allUnprocessedItems
-    };
-  }
-};
-
-exports.Table = Table;