@xube/kit-aws 0.0.85 → 0.0.86

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./resources/cognito/authenticate";
 export * from "./resources/cognito/register";
+export * from "./resources/dynamodb/batch";
 export * from "./resources/dynamodb/get";
 export * from "./resources/dynamodb/put";
 export * from "./resources/dynamodb/query";

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./resources/cognito/authenticate"), exports);
 __exportStar(require("./resources/cognito/register"), exports);
+__exportStar(require("./resources/dynamodb/batch"), exports);
 __exportStar(require("./resources/dynamodb/get"), exports);
 __exportStar(require("./resources/dynamodb/put"), exports);
 __exportStar(require("./resources/dynamodb/query"), exports);

package/dist/resources/dynamodb/batch.d.ts

@@ -0,0 +1,16 @@
+import { WriteRequest } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+import { TableKey } from "@xube/kit-aws-schema";
+export interface BatchPutPropsOutput {
+    success: boolean;
+    unprocessed?: Record<string, WriteRequest[]>;
+}
+export type UnprocessedItems = TableKey[];
+export declare const putItems: <T extends {
+    id: string;
+    PK: string;
+    SK: string;
+    type: string;
+    s: number;
+    us?: number | undefined;
+}>(tableName: string, items: T[], ddbDocClient?: DynamoDBDocumentClient) => Promise<BatchPutPropsOutput>;

package/dist/resources/dynamodb/batch.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.putItems = void 0;
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const client_1 = require("./client");
+const kit_aws_schema_1 = require("@xube/kit-aws-schema");
+const putItems = async (tableName, items, ddbDocClient = (0, client_1.getDynamodbClient)()) => {
+    let unprocessedItems = {};
+    try {
+        for (let i = 0; i < items.length; i += kit_aws_schema_1.MAX_NUMBER_BATCH_WRITES) {
+            const currentBatchPutItemsBatch = items.slice(i, Math.min(kit_aws_schema_1.MAX_NUMBER_BATCH_WRITES, items.length));
+            const batchPutItemsCommand = new lib_dynamodb_1.BatchWriteCommand({
+                RequestItems: {
+                    [tableName]: currentBatchPutItemsBatch.map((currentBatchPutItemProps) => ({
+                        PutRequest: {
+                            Item: {
+                                ...currentBatchPutItemProps,
+                            },
+                        },
+                    })),
+                },
+            });
+            const batchPutItemsCommandOutput = await ddbDocClient.send(batchPutItemsCommand);
+            if (batchPutItemsCommandOutput.UnprocessedItems &&
+                Object.keys(batchPutItemsCommandOutput.UnprocessedItems).length) {
+                if (batchPutItemsCommandOutput.UnprocessedItems &&
+                    Object.keys(batchPutItemsCommandOutput).length) {
+                    unprocessedItems = {
+                        ...unprocessedItems,
+                        ...batchPutItemsCommandOutput.UnprocessedItems,
+                    };
+                }
+            }
+        }
+        if (Object.keys(unprocessedItems).length > 0) {
+            console.error(`There were ${Object.keys(unprocessedItems).length} unprocessed items when attempting to batch put items: ${JSON.stringify(unprocessedItems, null, 2)}`);
+            return {
+                success: false,
+                unprocessed: unprocessedItems,
+            };
+        }
+        return {
+            success: true,
+        };
+    }
+    catch (e) {
+        console.error("Error occurred when batch writing items. " + JSON.stringify(e));
+        return { success: false };
+    }
+};
+exports.putItems = putItems;

package/dist/resources/dynamodb/client.d.ts

@@ -0,0 +1,4 @@
+import { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+export declare const getDynamodbClientConfig: () => DynamoDBClientConfig;
+export declare const getDynamodbClient: () => DynamoDBDocumentClient;

package/dist/resources/dynamodb/client.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDynamodbClient = exports.getDynamodbClientConfig = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const getDynamodbClientConfig = () => ({
+    region: process.env.AWS_REGION,
+});
+exports.getDynamodbClientConfig = getDynamodbClientConfig;
+const ddbClient = new client_dynamodb_1.DynamoDBClient((0, exports.getDynamodbClientConfig)());
+const ddbDocClient = lib_dynamodb_1.DynamoDBDocumentClient.from(ddbClient, {
+    marshallOptions: {
+        removeUndefinedValues: true,
+        convertClassInstanceToMap: true,
+    },
+});
+const getDynamodbClient = () => {
+    return ddbDocClient;
+};
+exports.getDynamodbClient = getDynamodbClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xube/kit-aws",
-  "version": "0.0.85",
+  "version": "0.0.86",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -18,7 +18,7 @@
   "homepage": "https://github.com/XubeLtd/dev-kit#readme",
   "devDependencies": {
     "@types/aws-lambda": "^8.10.119",
-    "@xube/kit-build": "^0.0.85"
+    "@xube/kit-build": "^0.0.86"
   },
   "dependencies": {
     "@aws-sdk/client-cognito-identity-provider": "^3.433.0",
@@ -26,10 +26,10 @@
     "@aws-sdk/client-ssm": "^3.433.0",
     "@aws-sdk/lib-dynamodb": "^3.433.0",
     "@aws-sdk/util-dynamodb": "^3.433.0",
-    "@xube/kit-aws-schema": "^0.0.85",
-    "@xube/kit-log": "^0.0.85",
-    "@xube/kit-request": "^0.0.85",
-    "@xube/kit-schema": "^0.0.85",
+    "@xube/kit-aws-schema": "^0.0.86",
+    "@xube/kit-log": "^0.0.86",
+    "@xube/kit-request": "^0.0.86",
+    "@xube/kit-schema": "^0.0.86",
     "zod": "^3.22.4"
   }
 }

package/src/index.ts

@@ -1,7 +1,10 @@
 export * from "./resources/cognito/authenticate";
 export * from "./resources/cognito/register";
+
+export * from "./resources/dynamodb/batch";
 export * from "./resources/dynamodb/get";
 export * from "./resources/dynamodb/put";
 export * from "./resources/dynamodb/query";
 export * from "./resources/dynamodb/transform";
+
 export * from "./resources/parameter-store/get";

package/src/resources/dynamodb/batch.ts

@@ -0,0 +1,90 @@
+import { WriteRequest } from "@aws-sdk/client-dynamodb";
+import {
+  DynamoDBDocumentClient,
+  BatchWriteCommand,
+  BatchWriteCommandOutput,
+} from "@aws-sdk/lib-dynamodb";
+import { getDynamodbClient } from "./client";
+import {
+  MAX_NUMBER_BATCH_WRITES,
+  TableItem,
+  TableKey,
+} from "@xube/kit-aws-schema";
+
+export interface BatchPutPropsOutput {
+  success: boolean;
+  unprocessed?: Record<string, WriteRequest[]>;
+}
+
+export type UnprocessedItems = TableKey[];
+
+export const putItems = async <T extends TableItem>(
+  tableName: string,
+  items: T[],
+  ddbDocClient: DynamoDBDocumentClient = getDynamodbClient()
+): Promise<BatchPutPropsOutput> => {
+  let unprocessedItems: Record<string, WriteRequest[]> = {};
+  try {
+    for (let i = 0; i < items.length; i += MAX_NUMBER_BATCH_WRITES) {
+      const currentBatchPutItemsBatch: T[] = items.slice(
+        i,
+        Math.min(MAX_NUMBER_BATCH_WRITES, items.length)
+      );
+
+      const batchPutItemsCommand = new BatchWriteCommand({
+        RequestItems: {
+          [tableName]: currentBatchPutItemsBatch.map(
+            (currentBatchPutItemProps) => ({
+              PutRequest: {
+                Item: {
+                  ...currentBatchPutItemProps,
+                },
+              },
+            })
+          ),
+        },
+      });
+
+      const batchPutItemsCommandOutput: BatchWriteCommandOutput =
+        await ddbDocClient.send(batchPutItemsCommand);
+
+      if (
+        batchPutItemsCommandOutput.UnprocessedItems &&
+        Object.keys(batchPutItemsCommandOutput.UnprocessedItems).length
+      ) {
+        if (
+          batchPutItemsCommandOutput.UnprocessedItems &&
+          Object.keys(batchPutItemsCommandOutput).length
+        ) {
+          unprocessedItems = {
+            ...unprocessedItems,
+            ...batchPutItemsCommandOutput.UnprocessedItems,
+          };
+        }
+      }
+    }
+
+    if (Object.keys(unprocessedItems).length > 0) {
+      console.error(
+        `There were ${Object.keys(unprocessedItems).length} unprocessed items when attempting to batch put items: ${JSON.stringify(
+          unprocessedItems,
+          null,
+          2
+        )}`
+      );
+      return {
+        success: false,
+        unprocessed: unprocessedItems,
+      };
+    }
+
+    return {
+      success: true,
+    };
+  } catch (e) {
+    console.error(
+      "Error occurred when batch writing items. " + JSON.stringify(e)
+    );
+    return { success: false };
+  }
+};

package/src/resources/dynamodb/client.ts

@@ -0,0 +1,17 @@
+import { DynamoDBClient, DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+
+export const getDynamodbClientConfig = (): DynamoDBClientConfig => ({
+  region: process.env.AWS_REGION,
+});
+
+const ddbClient = new DynamoDBClient(getDynamodbClientConfig());
+const ddbDocClient = DynamoDBDocumentClient.from(ddbClient, {
+  marshallOptions: {
+    removeUndefinedValues: true,
+    convertClassInstanceToMap: true,
+  },
+});
+export const getDynamodbClient = () => {
+  return ddbDocClient;
+};