@moicky/dynamodb 2.5.9 → 2.6.0

package/dist/lib/client.js

@@ -2,9 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getClient = exports.initClient = void 0;
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const credential_providers_1 = require("@aws-sdk/credential-providers");
 const schemas_1 = require("./schemas");
 let client = new client_dynamodb_1.DynamoDBClient({
     region: process.env.AWS_REGION || "eu-central-1",
+    ...(process.env.DYNAMODB_ASSUME_ROLE && {
+        credentials: (0, credential_providers_1.fromTemporaryCredentials)({
+            params: {
+                RoleArn: process.env.DYNAMODB_ASSUME_ROLE,
+                RoleSessionName: "@moicky/dynamodb",
+            },
+        }),
+    }),
 });
 const defaultTable = process.env.DYNAMODB_TABLE;
 if (defaultTable) {

package/dist/operations/get.js

@@ -143,11 +143,17 @@ exports.getItems = getItems;
  */
 async function getAllItems(args = {}) {
     args = (0, lib_1.withFixes)((0, lib_1.withDefaults)(args, "getAllItems"));
-    return (0, lib_1.getClient)()
-        .send(new client_dynamodb_1.ScanCommand({
-        ...args,
-        TableName: args?.TableName || (0, lib_1.getDefaultTable)(),
-    }))
-        .then((res) => res.Items.map((item) => (0, lib_1.unmarshallWithOptions)(item)));
+    let items = [];
+    let lastEvaluatedKey;
+    do {
+        const response = await (0, lib_1.getClient)().send(new client_dynamodb_1.ScanCommand({
+            ...args,
+            TableName: args?.TableName || (0, lib_1.getDefaultTable)(),
+            ExclusiveStartKey: lastEvaluatedKey,
+        }));
+        items = items.concat(response.Items.map((item) => (0, lib_1.unmarshallWithOptions)(item)));
+        lastEvaluatedKey = response.LastEvaluatedKey;
+    } while (lastEvaluatedKey);
+    return items;
 }
 exports.getAllItems = getAllItems;

package/dist/operations/query.js

@@ -25,6 +25,7 @@ async function _query(keyCondition, key, args = {}) {
             attributesToGet: [
                 ...(0, lib_1.getAttributesFromExpression)(keyCondition),
                 ...(0, lib_1.getAttributesFromExpression)(args?.FilterExpression || ""),
+                ...(0, lib_1.getAttributesFromExpression)(args?.ProjectionExpression || ""),
             ],
         }),
         ...args,
@@ -124,6 +125,9 @@ async function queryAllItems(keyCondition, key, args = {}) {
             break;
         }
     }
+    if (args.Limit && data.Items.length > args.Limit) {
+        data.Items = data.Items.slice(0, args.Limit);
+    }
     return (data?.Items || [])
         .map((item) => item && (0, lib_1.unmarshallWithOptions)(item))
         .filter(Boolean);

package/dist/operations/transactWriteItems.d.ts

@@ -29,5 +29,49 @@ type TransactWriteItemsInput = Partial<Omit<TransactWriteItemsCommandInput, "Tra
 type ResponseItem = Pick<ItemCollectionMetrics, "SizeEstimateRangeGB"> & {
     Key: Record<string, any>;
 };
+/**
+ * Performs a TransactWriteItems operation against DynamoDB. This allows you to perform multiple write operations in a single transaction.
+ * @param transactItems - Array of items to transact. Each item can be a Put, Update, Delete, or ConditionCheck operation.
+ * @param args - The additional arguments to override or specify for {@link TransactWriteItemsCommandInput}
+ * @returns A promise that resolves to a record of response items
+ *
+ * @example
+ * Perform a TransactWriteItems operation
+ * ```javascript
+ * const response = await transactWriteItems([
+ *   {
+ *     Put: {
+ *       item: {
+ *         PK: "User/1",
+ *         SK: "Book/1",
+ *         title: "The Great Gatsby",
+ *         author: "F. Scott Fitzgerald",
+ *         released: 1925,
+ *       },
+ *     },
+ *   },
+ *   {
+ *     Update: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *       updateData: { title: "The Great Gatsby - Updated" },
+ *     },
+ *   },
+ *   {
+ *     Delete: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *     },
+ *   },
+ *   {
+ *     ConditionCheck: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *       ConditionExpression: "#title = :title",
+ *       conditionData: { title: "The Great Gatsby" },
+ *     },
+ *   },
+ * ]);
+ *
+ * console.log(response);
+ * ```
+ */
 export declare function transactWriteItems(transactItems: TransactItem[], args?: TransactWriteItemsInput): Promise<Record<string, ResponseItem[]>>;
 export {};

package/dist/operations/transactWriteItems.js

@@ -3,6 +3,50 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.transactWriteItems = void 0;
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const lib_1 = require("../lib");
+/**
+ * Performs a TransactWriteItems operation against DynamoDB. This allows you to perform multiple write operations in a single transaction.
+ * @param transactItems - Array of items to transact. Each item can be a Put, Update, Delete, or ConditionCheck operation.
+ * @param args - The additional arguments to override or specify for {@link TransactWriteItemsCommandInput}
+ * @returns A promise that resolves to a record of response items
+ *
+ * @example
+ * Perform a TransactWriteItems operation
+ * ```javascript
+ * const response = await transactWriteItems([
+ *   {
+ *     Put: {
+ *       item: {
+ *         PK: "User/1",
+ *         SK: "Book/1",
+ *         title: "The Great Gatsby",
+ *         author: "F. Scott Fitzgerald",
+ *         released: 1925,
+ *       },
+ *     },
+ *   },
+ *   {
+ *     Update: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *       updateData: { title: "The Great Gatsby - Updated" },
+ *     },
+ *   },
+ *   {
+ *     Delete: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *     },
+ *   },
+ *   {
+ *     ConditionCheck: {
+ *       key: { PK: "User/1", SK: "Book/1" },
+ *       ConditionExpression: "#title = :title",
+ *       conditionData: { title: "The Great Gatsby" },
+ *     },
+ *   },
+ * ]);
+ *
+ * console.log(response);
+ * ```
+ */
 async function transactWriteItems(transactItems, args = {}) {
     return new Promise(async (resolve, reject) => {
         args = (0, lib_1.withDefaults)(args, "transactWriteItems");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moicky/dynamodb",
-  "version": "2.5.9",
+  "version": "2.6.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Contains a collection of convenience functions for working with AWS DynamoDB",
@@ -24,6 +24,7 @@
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.338.0",
+    "@aws-sdk/credential-providers": "^3.744.0",
     "@aws-sdk/util-dynamodb": "^3.338.0",
     "aws-crt": "^1.15.20"
   },

package/readme.md

@@ -284,6 +284,62 @@ const id4 = await getAscendingId({
 console.log(id4); // "00000010"
 ```
 
+### TransactWriteItems
+
+```ts
+import { transactWriteItems } from "@moicky/dynamodb";
+
+// Perform a TransactWriteItems operation
+const response = await transactWriteItems([
+  {
+    Put: {
+      item: {
+        PK: "User/1",
+        SK: "Book/1",
+        title: "The Great Gatsby",
+        author: "F. Scott Fitzgerald",
+        released: 1925,
+      },
+    },
+  },
+  {
+    Update: {
+      key: { PK: "User/1", SK: "Book/1" },
+      updateData: { title: "The Great Gatsby - Updated" },
+    },
+  },
+  {
+    Delete: {
+      key: { PK: "User/1", SK: "Book/1" },
+    },
+  },
+  {
+    ConditionCheck: {
+      key: { PK: "User/1", SK: "Book/1" },
+      ConditionExpression: "#title = :title",
+      conditionData: { title: "The Great Gatsby" },
+    },
+  },
+]);
+
+console.log(response);
+```
+
+### TransactGetItems
+
+```ts
+import { transactGetItems } from "@moicky/dynamodb";
+
+// Perform a TransactGetItems operation
+const items = await transactGetItems([
+  { key: { PK: "User/1", SK: "Book/1" } },
+  { key: { PK: "User/1", SK: "Book/2" } },
+  { key: { PK: "User/1", SK: "Book/3" } },
+]);
+
+console.log(items);
+```
+
 ## Configuring global defaults
 
 Global defaults can be configured using the `initDefaults` function. This allows to provide but still override every property of the `args` parameter.