@moicky/dynamodb 2.3.3 → 2.3.5

package/dist/lib/fixes.d.ts

@@ -63,4 +63,4 @@ export declare const marshallWithOptions: (input: Parameters<typeof marshall>[0]
  * @returns The unmarshalled input
  * @private
  */
-export declare const unmarshallWithOptions: (input: Parameters<typeof unmarshall>[0]) => Record<string, any>;
+export declare const unmarshallWithOptions: <T extends Record<string, any> = Record<string, any>>(input: Parameters<typeof unmarshall>[0]) => T;

package/dist/operations/get.d.ts

@@ -25,7 +25,7 @@ import { BatchGetItemCommandInput, GetItemCommandInput, ScanCommandInput } from
  * );
  * ```
  */
-export declare function getItem(key: Record<string, any>, args?: Partial<GetItemCommandInput>): Promise<Record<string, any> | undefined>;
+export declare function getItem<T extends Record<string, any> = Record<string, any>>(key: Record<string, any>, args?: Partial<GetItemCommandInput>): Promise<T | undefined>;
 type GetItemsArgs = Partial<BatchGetItemCommandInput & {
     TableName?: string;
 }>;
@@ -58,7 +58,7 @@ type GetItemsArgs = Partial<BatchGetItemCommandInput & {
  * );
  * ```
  */
-export declare function getItems(keys: Record<string, any>[], args?: GetItemsArgs, retry?: number): Promise<Record<string, any>[]>;
+export declare function getItems<T extends Record<string, any> = Record<string, any>>(keys: Record<string, any>[], args?: GetItemsArgs, retry?: number): Promise<Array<T | undefined>>;
 /**
  * Retrieves all items from the DynamoDB table.
  * @param args - The additional arguments to override or specify for {@link ScanCommandInput}
@@ -77,5 +77,5 @@ export declare function getItems(keys: Record<string, any>[], args?: GetItemsArg
  * );
  * ```
  */
-export declare function getAllItems(args?: Partial<ScanCommandInput>): Promise<Record<string, any>[]>;
+export declare function getAllItems<T extends Record<string, any> = Record<string, any>>(args?: Partial<ScanCommandInput>): Promise<T[]>;
 export {};

package/dist/operations/put.d.ts

@@ -17,7 +17,7 @@ import { BatchWriteItemCommandInput, BatchWriteItemCommandOutput, PutItemCommand
  * });
  * ```
  */
-export declare function putItem(item: Record<string, any>, args?: Partial<PutItemCommandInput>): Promise<PutItemCommandOutput | Record<string, any>>;
+export declare function putItem<T extends Record<string, any> = Record<string, any>>(item: Record<string, any>, args?: Partial<PutItemCommandInput>): Promise<PutItemCommandOutput | T>;
 type PutItemsArgs = Partial<BatchWriteItemCommandInput & {
     TableName?: string;
 }>;

package/dist/operations/query.d.ts

@@ -32,7 +32,7 @@ export declare function query(keyCondition: string, key: Record<string, any>, ar
  * });
  * ```
  */
-export declare function queryItems(keyCondition: string, key: Record<string, any>, args?: Partial<QueryCommandInput>): Promise<Record<string, any>[]>;
+export declare function queryItems<T extends Record<string, any> = Record<string, any>>(keyCondition: string, key: Record<string, any>, args?: Partial<QueryCommandInput>): Promise<Array<T>>;
 /**
  * Query all items from the DynamoDB table using a key condition and unmarshalls the result.
  * This function retries until all items are retrieved due to the AWS limit of 1MB per query.
@@ -62,7 +62,7 @@ export declare function queryItems(keyCondition: string, key: Record<string, any
  * );
  * ```
  */
-export declare function queryAllItems(keyCondition: string, key: Record<string, any>, args?: Partial<QueryCommandInput>): Promise<Record<string, any>[]>;
+export declare function queryAllItems<T = Record<string, any>>(keyCondition: string, key: Record<string, any>, args?: Partial<QueryCommandInput>): Promise<Array<T>>;
 /**
  * The structure for the PaginationPage type.
  * @property number - The page number. Cannot be set manually.
@@ -81,8 +81,8 @@ export type PaginationPage = {
  * @property hasNextPage - Whether there is a next page.
  * @property currentPage - The current page.
  */
-export type PaginationResult = {
-    items: Record<string, any>[];
+export type PaginationResult<T> = {
+    items: T[];
     hasPreviousPage: boolean;
     hasNextPage: boolean;
     currentPage: PaginationPage;
@@ -125,4 +125,4 @@ export interface PaginationArgs extends Partial<Omit<QueryCommandInput, "Limit">
  * // currentPage: { number: 2, firstKey: { ... }, lastKey: { ... } }
  * ```
  */
-export declare function queryPaginatedItems(keyCondition: string, key: Record<string, any>, args: PaginationArgs): Promise<PaginationResult>;
+export declare function queryPaginatedItems<T extends Record<string, any> = Record<string, any>>(keyCondition: string, key: Record<string, any>, args: PaginationArgs): Promise<PaginationResult<T>>;

package/dist/operations/query.js

@@ -66,8 +66,8 @@ exports.query = query;
 async function queryItems(keyCondition, key, args = {}) {
     args = (0, lib_1.withDefaults)(args, "queryItems");
     return _query(keyCondition, key, args).then((res) => (res?.Items || [])
-        .map((item) => item && (0, lib_1.unmarshallWithOptions)(item))
-        .filter((item) => item));
+        .map((item) => (0, lib_1.unmarshallWithOptions)(item))
+        .filter(Boolean));
 }
 exports.queryItems = queryItems;
 /**

package/dist/operations/transactGetItems.d.ts

@@ -34,9 +34,9 @@ import { Get, TransactGetItemsCommandInput } from "@aws-sdk/client-dynamodb";
  * );
  * ```
  */
-export declare function transactGetItems(keys: Array<Omit<Get, "TableName" | "Key"> & {
+export declare function transactGetItems<T extends Record<string, any> = Array<Record<string, any> | undefined>>(keys: Array<Omit<Get, "TableName" | "Key"> & {
     key: Record<string, any>;
     TableName?: string;
 }>, args?: Partial<TransactGetItemsCommandInput & {
     TableName?: string;
-}>): Promise<Array<Record<string, any> | undefined>>;
+}>): Promise<T[]>;

package/dist/operations/update.d.ts

@@ -31,7 +31,7 @@ import { UpdateItemCommandInput, UpdateItemCommandOutput } from "@aws-sdk/client
  * console.log(newItem); // { "PK": "User/1", "SK": "Book/1", "released": 2000 }
  * ```
  */
-export declare function updateItem(key: Record<string, any>, data: Record<string, any>, args?: Partial<UpdateItemCommandInput>): Promise<undefined | Record<string, any>>;
+export declare function updateItem<T extends Record<string, any> = Record<string, any>>(key: Record<string, any>, data: Record<string, any>, args?: Partial<UpdateItemCommandInput>): Promise<undefined | T>;
 /**
  * Removes specified attributes from an item in DynamoDB.
  *
@@ -46,4 +46,4 @@ export declare function updateItem(key: Record<string, any>, data: Record<string
  * await removeAttributes({ PK: "User/1", SK: "Book/1" }, ["description"]);
  * ```
  */
-export declare function removeAttributes(key: Record<string, any>, attributes: string[], args?: Partial<UpdateItemCommandInput>): Promise<UpdateItemCommandOutput>;
+export declare function removeAttributes<T extends Record<string, any> = Record<string, any>>(key: Record<string, any>, attributes: string[], args?: Partial<UpdateItemCommandInput>): Promise<UpdateItemCommandOutput | T>;

package/dist/operations/update.js

@@ -79,7 +79,8 @@ exports.updateItem = updateItem;
 async function removeAttributes(key, attributes, args = {}) {
     args = (0, lib_1.withDefaults)(args, "removeAttributes");
     const UpdateExpression = "REMOVE " + attributes.map((att) => `#${att}`).join(", ");
-    return (0, lib_1.getClient)().send(new client_dynamodb_1.UpdateItemCommand({
+    return (0, lib_1.getClient)()
+        .send(new client_dynamodb_1.UpdateItemCommand({
         Key: (0, lib_1.stripKey)(key, args),
         UpdateExpression,
         ExpressionAttributeNames: (0, lib_1.getAttributeNames)(attributes.reduce((acc, att) => {
@@ -88,6 +89,7 @@ async function removeAttributes(key, attributes, args = {}) {
         }, {})),
         ...args,
         TableName: args?.TableName || (0, lib_1.getDefaultTable)(),
-    }));
+    }))
+        .then((res) => args?.ReturnValues ? (0, lib_1.unmarshallWithOptions)(res.Attributes) : undefined);
 }
 exports.removeAttributes = removeAttributes;

package/package.json

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

package/readme.md

@@ -140,7 +140,7 @@ await getAllItems();
 ```ts
 import { deleteItem, deleteItems } from "@moicky/dynamodb";
 
-// Delete single item
+// Delete a single item
 await deleteItem({
   PK: "User/1",
   SK: "Book/1",