dyno-table 0.1.3 → 0.1.5

package/README.md

@@ -72,19 +72,19 @@ const client = new DynamoDBClient({ region: "us-west-2" });
 const docClient = DynamoDBDocument.from(client);
 
 // Initialize table with single-table design schema
-const dinoTable = new Table(docClient, {
-  name: "DinosaurPark",
-  partitionKey: "pk",
-  sortKey: "sk",
-  gsis: [
-    {
-      name: "GSI1",
-      keySchema: {
-        pk: "GSI1PK",
-        sk: "GSI1SK",
+const dinoTable = new Table({
+  client: docClient,
+  tableName: "DinosaurPark",
+  indexes: {
+    partitionKey: "pk",
+    sortKey: "sk",
+    gsis: {
+      speciesId: {
+        partitionKey: "gsi1pk",
+        sortKey: "gsi1sk",
       },
     },
-  ],
+  },
 });
 ```
 

package/dist/index.d.ts

@@ -1551,22 +1551,6 @@ interface DeleteCommandParams extends DynamoCommandWithExpressions {
 type DeleteExecutor = (params: DeleteCommandParams) => Promise<{
     item?: Record<string, unknown>;
 }>;
-/**
- * Builder for creating DynamoDB delete operations.
- * Use this builder when you need to:
- * - Delete items from a DynamoDB table
- * - Conditionally delete items based on attribute values
- * - Delete items as part of a transaction
- * - Retrieve the old item values after deletion
- *
- * @example
- * ```ts
- * const result = await new DeleteBuilder(executor, 'myTable', { id: '123' })
- *   .condition(op => op.attributeExists('status'))
- *   .returnValues('ALL_OLD')
- *   .execute();
- * ```
- */
 /**
  * Builder for creating DynamoDB delete operations.
  * Use this builder when you need to:
@@ -1600,30 +1584,6 @@ declare class DeleteBuilder {
     private readonly tableName;
     private readonly key;
     constructor(executor: DeleteExecutor, tableName: string, key: PrimaryKeyWithoutExpression);
-    /**
-     * Adds a condition that must be satisfied for the delete operation to succeed.
-     * Use this method when you need to:
-     * - Implement optimistic locking (e.g., version check)
-     * - Ensure item exists before deletion
-     * - Validate item state before deletion
-     *
-     * @example
-     * ```ts
-     * // Simple condition
-     * builder.condition(op => op.attributeExists('id'))
-     *
-     * // Complex condition with version check
-     * builder.condition(op =>
-     *   op.and([
-     *     op.eq('version', 1),
-     *     op.eq('status', 'ACTIVE')
-     *   ])
-     * )
-     * ```
-     *
-     * @param condition - Either a Condition object or a callback function that builds the condition
-     * @returns The builder instance for method chaining
-     */
     /**
      * Adds a condition that must be satisfied for the delete operation to succeed.
      * Use this method when you need to:
@@ -2437,34 +2397,6 @@ interface PutCommandParams extends DynamoCommandWithExpressions {
     returnValues?: "ALL_OLD" | "NONE";
 }
 type PutExecutor<T extends Record<string, unknown>> = (params: PutCommandParams) => Promise<T>;
-/**
- * Builder for creating DynamoDB put operations.
- * Use this builder when you need to:
- * - Insert new items into a DynamoDB table
- * - Replace existing items completely
- * - Conditionally put items based on their current state
- * - Put items as part of a transaction
- *
- * The builder supports:
- * - Conditional puts with complex conditions
- * - Retrieving old item values
- * - Transaction integration
- *
- * @example
- * ```ts
- * // Simple put
- * const result = await new PutBuilder(executor, { id: '123', status: 'ACTIVE' }, 'myTable')
- *   .execute();
- *
- * // Conditional put with old value retrieval
- * const result = await new PutBuilder(executor, newItem, 'myTable')
- *   .condition(op => op.attributeNotExists('id'))
- *   .returnValues('ALL_OLD')
- *   .execute();
- * ```
- *
- * @typeParam T - The type of item being put into the table
- */
 /**
  * Builder for creating DynamoDB put operations.
  * Use this builder when you need to:

package/dist/index.js

@@ -1006,25 +1006,25 @@ var PutBuilder = class {
    * - Prevent duplicate dinosaur entries
    * - Ensure habitat requirements
    * - Validate security protocols
-   * 
+   *
    * @example
    * ```typescript
    * // Ensure unique dinosaur ID
-   * builder.condition(op => 
+   * builder.condition(op =>
    *   op.attributeNotExists('id')
    * );
-   * 
+   *
    * // Verify habitat requirements
-   * builder.condition(op => 
+   * builder.condition(op =>
    *   op.and([
    *     op.eq('securityStatus', 'READY'),
    *     op.attributeExists('lastInspection'),
    *     op.gt('securityLevel', 5)
    *   ])
    * );
-   * 
+   *
    * // Check breeding facility conditions
-   * builder.condition(op => 
+   * builder.condition(op =>
    *   op.and([
    *     op.between('temperature', 25, 30),
    *     op.between('humidity', 60, 80),
@@ -1032,7 +1032,7 @@ var PutBuilder = class {
    *   ])
    * );
    * ```
-   * 
+   *
    * @param condition - Either a Condition object or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
@@ -1066,14 +1066,14 @@ var PutBuilder = class {
    * - Track dinosaur profile updates
    * - Monitor habitat modifications
    * - Maintain change history
-   * 
+   *
    * @example
    * ```ts
    * // Get previous dinosaur state
    * const result = await builder
    *   .returnValues('ALL_OLD')
    *   .execute();
-   * 
+   *
    * if (result) {
    *   console.log('Previous profile:', {
    *     species: result.species,
@@ -1085,7 +1085,7 @@ var PutBuilder = class {
    *   });
    * }
    * ```
-   * 
+   *
    * @param returnValues - Use 'ALL_OLD' to return previous values, or 'NONE' (default)
    * @returns The builder instance for method chaining
    */
@@ -1113,11 +1113,11 @@ var PutBuilder = class {
    * - Transfer dinosaurs between habitats
    * - Initialize new breeding programs
    * - Update multiple facility records
-   * 
+   *
    * @example
    * ```ts
    * const transaction = new TransactionBuilder();
-   * 
+   *
    * // Add dinosaur to new habitat
    * new PutBuilder(executor, {
    *   id: 'TREX-002',
@@ -1126,17 +1126,17 @@ var PutBuilder = class {
    *   transferDate: new Date().toISOString()
    * }, 'dinosaurs')
    *   .withTransaction(transaction);
-   * 
+   *
    * // Update habitat records
    * new UpdateBuilder(executor, 'habitats', { id: 'PADDOCK-B' })
    *   .add('occupants', 1)
    *   .set('lastTransfer', new Date().toISOString())
    *   .withTransaction(transaction);
-   * 
+   *
    * // Execute transfer atomically
    * await transaction.execute();
    * ```
-   * 
+   *
    * @param transaction - The transaction builder to add this operation to
    * @returns The builder instance for method chaining
    */
@@ -1179,7 +1179,7 @@ var PutBuilder = class {
    * - Verify habitat assignments
    * - Log security protocols
    * - Troubleshoot breeding program conditions
-   * 
+   *
    * @example
    * ```ts
    * const debugInfo = new PutBuilder(executor, {
@@ -1200,10 +1200,10 @@ var PutBuilder = class {
    *     ])
    *   )
    *   .debug();
-   * 
+   *
    * console.log('Dinosaur transfer command:', debugInfo);
    * ```
-   * 
+   *
    * @returns A readable representation of the put command with resolved expressions
    */
   debug() {
@@ -1225,50 +1225,26 @@ var DeleteBuilder = class {
     this.tableName = tableName;
     this.key = key;
   }
-  /**
-   * Adds a condition that must be satisfied for the delete operation to succeed.
-   * Use this method when you need to:
-   * - Implement optimistic locking (e.g., version check)
-   * - Ensure item exists before deletion
-   * - Validate item state before deletion
-   *
-   * @example
-   * ```ts
-   * // Simple condition
-   * builder.condition(op => op.attributeExists('id'))
-   *
-   * // Complex condition with version check
-   * builder.condition(op =>
-   *   op.and([
-   *     op.eq('version', 1),
-   *     op.eq('status', 'ACTIVE')
-   *   ])
-   * )
-   * ```
-   *
-   * @param condition - Either a Condition object or a callback function that builds the condition
-   * @returns The builder instance for method chaining
-   */
   /**
    * 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
    * // Ensure dinosaur can be safely removed
-   * builder.condition(op => 
+   * builder.condition(op =>
    *   op.and([
    *     op.eq('status', 'SEDATED'),
    *     op.eq('location', 'MEDICAL_BAY'),
    *     op.attributeExists('lastCheckup')
    *   ])
    * );
-   * 
+   *
    * // Verify habitat is empty
-   * builder.condition(op => 
+   * builder.condition(op =>
    *   op.and([
    *     op.eq('occupants', 0),
    *     op.eq('maintenanceStatus', 'COMPLETE'),
@@ -1276,7 +1252,7 @@ var DeleteBuilder = class {
    *   ])
    * );
    * ```
-   * 
+   *
    * @param condition - Either a Condition object or a callback function that builds the condition
    * @returns The builder instance for method chaining
    */
@@ -1310,14 +1286,14 @@ var DeleteBuilder = class {
    * - Archive removed dinosaur data
    * - Track habitat decommissioning history
    * - Maintain removal audit logs
-   * 
+   *
    * @example
    * ```ts
    * // Archive dinosaur data before removal
    * const result = await builder
    *   .returnValues('ALL_OLD')
    *   .execute();
-   * 
+   *
    * if (result.item) {
    *   console.log('Removed dinosaur data:', {
    *     species: result.item.species,
@@ -1326,7 +1302,7 @@ var DeleteBuilder = class {
    *   });
    * }
    * ```
-   * 
+   *
    * @param returnValues - Use 'ALL_OLD' to return all attributes of the deleted item
    * @returns The builder instance for method chaining
    */
@@ -1409,7 +1385,7 @@ var DeleteBuilder = class {
    * - Verify safety checks
    * - Log removal operations
    * - Troubleshoot failed deletions
-   * 
+   *
    * @example
    * ```ts
    * const debugInfo = new DeleteBuilder(executor, 'dinosaurs', { id: 'TREX-001' })
@@ -2947,10 +2923,13 @@ var Table = class {
    * If useIndex is called on the returned QueryBuilder, it will use the GSI configuration
    */
   query(keyCondition) {
-    const pkAttributeName = "pk";
-    const skAttributeName = "sk";
+    const pkAttributeName = this.partitionKey;
+    const skAttributeName = this.sortKey;
     let keyConditionExpression = eq(pkAttributeName, keyCondition.pk);
     if (keyCondition.sk) {
+      if (!skAttributeName) {
+        throw new Error("Sort key is not defined for Index");
+      }
       const keyConditionOperator = {
         eq: (value) => eq(skAttributeName, value),
         lt: (value) => lt(skAttributeName, value),
@@ -3165,8 +3144,8 @@ var Table = class {
     const allUnprocessedKeys = [];
     for (const chunk of chunkArray(keys, DDB_BATCH_GET_LIMIT)) {
       const formattedKeys = chunk.map((key) => ({
-        pk: key.pk,
-        sk: key.sk
+        [this.partitionKey]: key.pk,
+        ...this.sortKey ? { [this.sortKey]: key.sk } : {}
       }));
       const params = {
         RequestItems: {
@@ -3182,8 +3161,8 @@ var Table = class {
         }
         const unprocessedKeysArray = result.UnprocessedKeys?.[this.tableName]?.Keys || [];
         const unprocessedKeys = unprocessedKeysArray.map((key) => ({
-          pk: key.pk,
-          sk: key.sk
+          pk: key[this.partitionKey],
+          sk: this.sortKey ? key[this.sortKey] : void 0
         }));
         if (unprocessedKeys.length > 0) {
           allUnprocessedKeys.push(...unprocessedKeys);
@@ -3218,8 +3197,8 @@ var Table = class {
         return {
           DeleteRequest: {
             Key: {
-              pk: operation.key.pk,
-              sk: operation.key.sk
+              [this.partitionKey]: operation.key.pk,
+              ...this.sortKey ? { [this.sortKey]: operation.key.sk } : {}
             }
           }
         };
@@ -3244,8 +3223,8 @@ var Table = class {
               return {
                 type: "delete",
                 key: {
-                  pk: request.DeleteRequest.Key.pk,
-                  sk: request.DeleteRequest.Key.sk
+                  pk: request.DeleteRequest.Key[this.partitionKey],
+                  sk: this.sortKey ? request.DeleteRequest.Key[this.sortKey] : void 0
                 }
               };
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyno-table",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "A TypeScript library to simplify working with DynamoDB",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",