@moicky/dynamodb 3.0.0 → 3.0.2

package/dist/operations/get.d.ts

@@ -59,7 +59,14 @@ type GetItemsArgs = Partial<BatchGetItemCommandInput & {
  * );
  * ```
  */
-export declare function getItems<T extends DynamoDBItem = DynamoDBItem>(keys: Partial<T>[], args?: GetItemsArgs, retry?: number): Promise<Array<T | undefined>>;
+export declare function getItems<T extends DynamoDBItem>(keys: Partial<T>[], args?: GetItemsArgs, retry?: number): Promise<Array<T | undefined>>;
+export declare function getItems<T extends [DynamoDBItem, ...DynamoDBItem[]]>(keys: {
+    [K in keyof T]: Partial<T[K]>;
+} & {
+    length: T["length"];
+}, args?: GetItemsArgs, retry?: number): Promise<{
+    [K in keyof T]: T[K] | undefined;
+}>;
 /**
  * Retrieves all items from the DynamoDB table.
  * @param args - The additional arguments to override or specify for {@link ScanCommandInput}

package/dist/operations/get.js

@@ -40,35 +40,6 @@ async function getItem(key, args = {}) {
         .then((res) => res?.Item ? (0, lib_1.unmarshallWithOptions)(res.Item) : undefined);
 }
 exports.getItem = getItem;
-/**
- * Retrieves multiple items from the DynamoDB table using their key schema.
- * @param keys - The items with at least the partition key and the sort key (if applicable) of the items to get.
- * @param args - The additional arguments to override or specify for {@link GetItemsArgs}
- * @returns A promise that resolves to an array of unmarshalled items
- *
- * @example
- * Get items in default table
- * ```javascript
- * await getItems([
- *   { PK: "User/1", SK: "Book/1", title: "The Great Gatsby", released: 1925 },
- *   { PK: "User/1", SK: "Book/2" },
- *   { PK: "User/1", SK: "Book/3" },
- *   // ... infinite more items (will be grouped into batches of 100 due to aws limit) and retried up to 3 times
- * ]);
- * ```
- * @example
- * Get items in a different table
- * ```javascript
- * await getItems(
- *   [
- *     { PK: "User/1", SK: "Book/1", title: "The Great Gatsby", released: 1925 },
- *     { PK: "User/1", SK: "Book/2" },
- *     { PK: "User/1", SK: "Book/3" },
- *   ],
- *   { TableName: "AnotherTable" }
- * );
- * ```
- */
 async function getItems(keys, args = {}, retry = 0) {
     args = (0, lib_1.withDefaults)(args, "getItems");
     // creates batches of 100 items each and performs batchGet on every batch.

package/dist/transactions/index.d.ts

@@ -10,10 +10,12 @@ export declare class Transaction {
     private createdAt;
     private updatedAt;
     private operations;
-    constructor({ tableName, createdAt, updatedAt, }?: {
+    private shouldSplitTransactions;
+    constructor({ tableName, createdAt, updatedAt, shouldSplitTransactions, }?: {
         tableName?: string;
         createdAt?: any;
         updatedAt?: any;
+        shouldSplitTransactions?: boolean;
     });
     private getItemKey;
     create<T extends ItemWithKey>(item: WithoutReferences<T>, args?: CreateOperation["args"]): CreateOperations<T>;

package/dist/transactions/index.js

@@ -11,10 +11,15 @@ class Transaction {
     createdAt;
     updatedAt;
     operations = {};
-    constructor({ tableName = (0, __1.getDefaultTable)(), createdAt = (0, __1.getItemModificationTimestamp)("createdAt"), updatedAt = (0, __1.getItemModificationTimestamp)("updatedAt"), } = {}) {
-        this.tableName = tableName;
+    shouldSplitTransactions;
+    constructor({ tableName, createdAt, updatedAt, shouldSplitTransactions, } = {}) {
+        this.tableName = tableName ?? (0, __1.getDefaultTable)();
         this.createdAt = createdAt ?? (0, __1.getItemModificationTimestamp)("createdAt");
         this.updatedAt = updatedAt ?? (0, __1.getItemModificationTimestamp)("updatedAt");
+        this.shouldSplitTransactions =
+            shouldSplitTransactions ??
+                (0, __1.getConfig)().splitTransactionsIfAboveLimit ??
+                false;
     }
     getItemKey(item, tableName) {
         return (0, __1.getItemKey)(item, { TableName: tableName || this.tableName });
@@ -127,10 +132,10 @@ class Transaction {
     async execute(args) {
         args = (0, __1.withDefaults)(args, "transactWriteItems");
         return new Promise(async (resolve, reject) => {
-            const shouldSplitTransactions = (0, __1.getConfig)().splitTransactionsIfAboveLimit ?? false;
             const operations = Object.values(this.operations);
             if (operations.length === 0 ||
-                (operations.length > OPERATIONS_LIMIT && !shouldSplitTransactions)) {
+                (operations.length > OPERATIONS_LIMIT &&
+                    !this.shouldSplitTransactions)) {
                 reject(new Error("[@moicky/dynamodb]: Invalid number of operations"));
             }
             const conditionCheckItems = operations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moicky/dynamodb",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Contains a collection of convenience functions for working with AWS DynamoDB",
@@ -25,12 +25,12 @@
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.338.0",
     "@aws-sdk/util-dynamodb": "^3.338.0",
-    "aws-crt": "^1.15.20"
+    "aws-crt": "^1.15.20",
+    "@vercel/functions": "^2.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.1",
     "@types/node": "^20.2.4",
-    "@vercel/functions": "^2.0.0",
     "dotenv": "^16.0.3",
     "jest": "^29.5.0",
     "typescript": "^5.0.4"

package/readme.md

@@ -108,7 +108,7 @@ await putItems([
 ```ts
 import { getItem, getItems, getAllItems } from "@moicky/dynamodb";
 
-// Passing more than just the key is possible, but will be removed to avoid errors
+// Passing more than just the key is possible, but will be discarded under the hood before forwarding to AWS
 
 // Get single item
 await getItem({
@@ -126,7 +126,7 @@ await getItems([
   {
     PK: "User/1",
     SK: "Book/1",
-    title: "The Great Gatsby", // additional fields will be removed before sending
+    title: "The Great Gatsby", // additional fields will be discarded before sending
     author: "F. Scott Fitzgerald",
     released: 1925,
   },
@@ -146,7 +146,7 @@ import { deleteItem, deleteItems } from "@moicky/dynamodb";
 await deleteItem({
   PK: "User/1",
   SK: "Book/1",
-  title: "The Great Gatsby", // additional fields will be removed before sending to avoid errors
+  title: "The Great Gatsby", // additional fields will be discarded before sending to AWS
   author: "F. Scott Fitzgerald",
   released: 1925,
 });