@moicky/dynamodb 1.2.1 → 1.2.3

package/dist/lib/helpers.d.ts

@@ -5,3 +5,6 @@ export declare function splitEvery<T>(items: T[], limit?: number): T[][];
 export declare function getAttributeValues(key: any, attributesToGet?: string[]): Record<string, any>;
 export declare function getAttributeNames(key: any, attributesToGet?: string[]): Record<string, string>;
 export declare function getAttributesFromExpression(expression: string, prefix?: string): string[];
+export declare function handleAliases(aliases: {
+    [attr: string]: string[];
+}, args?: Record<string, any>): Record<string, any>;

package/dist/lib/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAttributesFromExpression = exports.getAttributeNames = exports.getAttributeValues = exports.splitEvery = exports.stripKey = void 0;
+exports.handleAliases = exports.getAttributesFromExpression = exports.getAttributeNames = exports.getAttributeValues = exports.splitEvery = exports.stripKey = void 0;
 const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
 const client_1 = require("../lib/client");
 // Since dynamo only accepts key atrtributes which are described in table schema
@@ -42,3 +42,15 @@ function getAttributesFromExpression(expression, prefix = "#") {
         ?.map((attr) => attr.slice(1)) || []);
 }
 exports.getAttributesFromExpression = getAttributesFromExpression;
+function handleAliases(aliases, args = {}) {
+    Object.keys(aliases).forEach((key) => {
+        aliases[key].forEach((alias) => {
+            if (args[alias]) {
+                args[key] = args[alias];
+                delete args[alias];
+            }
+        });
+    });
+    return args;
+}
+exports.handleAliases = handleAliases;

package/dist/operations/query.d.ts

@@ -1,4 +1,9 @@
-import { QueryCommandInput, QueryCommandOutput } from "@aws-sdk/client-dynamodb";
+import { QueryCommandInput as _QueryCommandInput, QueryCommandOutput } from "@aws-sdk/client-dynamodb";
+type QueryCommandInput = {
+    GSI: _QueryCommandInput["IndexName"];
+    Index: _QueryCommandInput["IndexName"];
+} & _QueryCommandInput;
 export declare function query(keyCondition: string, key: any, args?: Partial<QueryCommandInput>): Promise<QueryCommandOutput>;
 export declare function queryItems(keyCondition: string, key: any, args?: Partial<QueryCommandInput>): Promise<Record<string, any>[]>;
 export declare function queryAllItems(keyCondition: string, key: any, args?: Partial<QueryCommandInput>): Promise<Record<string, any>[]>;
+export {};

package/dist/operations/query.js

@@ -5,7 +5,11 @@ const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
 const client_1 = require("../lib/client");
 const helpers_1 = require("../lib/helpers");
+const aliases = {
+    IndexName: ["GSI", "Index"],
+};
 async function query(keyCondition, key, args = {}) {
+    args = (0, helpers_1.handleAliases)(aliases, args);
     return client_1.client.send(new client_dynamodb_1.QueryCommand({
         KeyConditionExpression: keyCondition,
         ExpressionAttributeValues: (0, helpers_1.getAttributeValues)(key, [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moicky/dynamodb",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Contains a collection of convenience functions for working with AWS DynamoDB",

package/readme.md

@@ -31,7 +31,7 @@ import { initSchema } from "@moicky/dynamodb";
 
 // Should be called once at the start of the runtime before any operation is executed
 initSchema({
-  // first one will be used if no TableName is specified
+  // first one will be used by default if no TableName is specified
   [process.env.DEFAULT_TABLE]: {
     hash: "PK",
     range: "SK",
@@ -146,8 +146,7 @@ await deleteItem({
 });
 
 // Delete multiple items
-// KeySchemas will be grouped into batches of 25 and will be retried up to 3 times if there are unprocessed items
-// Will only delete each keySchema only once, even if it is present multiple times in the array to improve performance
+// Will only delete each keySchema once, even if it is present multiple times in the array to improve performance and avoid aws errors
 await deleteItems([
   { PK: "User/1", SK: "Book/1" },
   // ... infinite more items (will be grouped into batches of 25 due to aws limit) and retried up to 3 times
@@ -161,13 +160,13 @@ import { updateItem, removeAttributes } from "@moicky/dynamodb";
 
 // Update the item and overwrite all supplied fields
 await updateItem(
-  { PK: "User/1", SK: "Book/1" },
-  { description: "A book about a rich guy", author: "F. Scott Fitzgerald" }
+  { PK: "User/1", SK: "Book/1" }, // reference to item
+  { description: "A book about a rich guy", author: "F. Scott Fitzgerald" } // fields to update
 );
 
 await updateItem(
   { PK: "User/1", SK: "Book/1" },
-  { released: 2000, maxReleased: 1950 }, // maxReleased will not be updated, since it is referenced inside the ConditionExpression
+  { released: 2000, maxReleased: 1950 }, // maxReleased will not be updated on the item, since it is referenced inside the ConditionExpression
   { ConditionExpression: "#released < :maxReleased" }
 );
 
@@ -187,7 +186,7 @@ await removeAttributes({ PK: "User/1", SK: "Book/1" }, ["description"]);
 import { query, queryItems, queryAllItems } from "@moicky/dynamodb";
 
 // You HAVE TO use placeholders for the keyCondition & filterExpression:
-// prefix the attributeNames with a hash (#) and the attributeValues with a colon (:)
+// Prefix the attributeNames with a hash (#) and the attributeValues with a colon (:)
 
 // Query only using keyCondition and retrieve complete response
 const booksResponse = await query("#PK = :PK and begins_with(#SK, :SK)", {
@@ -217,8 +216,8 @@ const booksWithFilter = await queryAllItems(
     from: 1950,
     to: 2000,
   },
-  // additional args with filterExpression
-  { FilterExpression: "#released BETWEEN :from AND :to" } // allows to override all args
+  // additional args with filterExpression for example
+  { FilterExpression: "#released BETWEEN :from AND :to" }
 );
 ```
 
@@ -229,6 +228,7 @@ import { itemExists, getAscendingId } from "@moicky/dynamodb";
 
 // Check if an item exists using keySchema
 const exists = await itemExists({ PK: "User/1", SK: "Book/1" });
+console.log(exists); // true / false
 
 // Generate ascending ID
 // Specify keySchemaHash and optionally item to start at using keySchemaRange
@@ -240,18 +240,18 @@ console.log(id1); // "00000010"
 
 // Example Structure 2: PK: "User/1", SK: "Book/{{ ASCENDING_ID }}"
 // Last item: { PK: "User/1", SK: "Book/00000009" }
-const id2 = await getAscendingId({ PK: "User/1", SKPrefix: "Book" });
+const id2 = await getAscendingId({ PK: "User/1", SK: "Book" });
 console.log(id2); // "00000010"
 
 // Specify length of ID
-const id3 = await getAscendingId({ PK: "User/1", SKPrefix: "Book", length: 4 });
+const id3 = await getAscendingId({ PK: "User/1", SK: "Book", length: 4 });
 console.log(id3); // "0010"
 
 // Example Structure 3: someKeySchemaHash: "User/1", SK: "Book/{{ ASCENDING_ID }}"
 // Last item: { someKeySchemaHash: "User/1", SK: "Book/00000009" }
 const id4 = await getAscendingId({
   someKeySchemaHash: "User/1",
-  SKPrefix: "Book",
+  SK: "Book",
 });
 console.log(id4); // "00000010"
 ```
@@ -376,8 +376,10 @@ const result = await updateItem(
 
 ### Setup
 
-Requires `DEFAULT_TABLE` and `SECOND_TABLE` to be present inside the environment (`.env file`)
-Can be deployed using the `template.yml` on aws:
+Requires environment variables to be present for the tests to successfully connect to dynamodb tables. You can find a list of required environment variables here:
+[./test/setup/setup-each.js](./test/setup/setup-each.js)
+
+They can be obtained using the **template.yml** which can be deployed on aws using:
 
 ```bash
 sam deploy