@eresearchqut/ddb-repository 1.0.2 → 1.2.0

package/.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Publish
+name: Release
 
 on:
   push:

package/CHANGELOG.md

@@ -1,23 +1,13 @@
-## [1.0.2](https://github.com/eresearchqut/ddb-repository/compare/v1.0.1...v1.0.2) (2025-11-19)
+# [1.2.0](https://github.com/eresearchqut/ddb-repository/compare/v1.1.0...v1.2.0) (2025-11-19)
 
 
-### Bug Fixes
-
-* setting publish config access to public ([eed3a3b](https://github.com/eresearchqut/ddb-repository/commit/eed3a3b382153c457e3508d844e111b7f5b3123d))
-
-## [1.0.1](https://github.com/eresearchqut/ddb-repository/compare/v1.0.0...v1.0.1) (2025-11-19)
-
-
-### Bug Fixes
+### Features
 
-* remove npm registry url from the node setup as per comments on https://github.com/semantic-release/semantic-release/issues/2313 ([291d61b](https://github.com/eresearchqut/ddb-repository/commit/291d61b55c3c5c665623c264306c40e1c21977a2))
-* Repository and package are now public ([b07f151](https://github.com/eresearchqut/ddb-repository/commit/b07f151732f8a158a2b6f0a584e64ea9eb7f5825))
-* updated secret name for GITHUB_TOKEN ([7e00208](https://github.com/eresearchqut/ddb-repository/commit/7e00208f487f5987e72646c15a50fe78808f6ba4))
-* updated secret name for GITHUB_TOKEN ([6d3eff2](https://github.com/eresearchqut/ddb-repository/commit/6d3eff2fff43f0d0848cfc03b7e035d830a3ceb5))
+* return the consumed capacity for each operation ([3910953](https://github.com/eresearchqut/ddb-repository/commit/391095398381a950c3393f9103d97d355c119538))
 
-# 1.0.0 (2025-11-19)
+# [1.1.0](https://github.com/eresearchqut/ddb-repository/compare/v1.0.2...v1.1.0) (2025-11-19)
 
 
 ### Features
 
-* coverage badge ([0f3c9d1](https://github.com/eresearchqut/ddb-repository/commit/0f3c9d128b25466758062ea9e41d1c7d755c2191))
+* NPM Package Badge ([fecd958](https://github.com/eresearchqut/ddb-repository/commit/fecd958d0d3725e0fc19f43f36e00eb7e5437716))

package/README.md

@@ -1,5 +1,6 @@
 # DynamoDB Repository
 
+[![npm version](https://badge.fury.io/js/@eresearchqut%2Fddb-repository.svg)](https://badge.fury.io/js/@eresearchqut%2Fddb-repository)
 [![Coverage Status](https://coveralls.io/repos/github/eresearchqut/ddb-repository/badge.svg?branch=main)](https://coveralls.io/github/eresearchqut/ddb-repository?branch=main)
 
 A TypeScript library providing a generic repository pattern implementation for AWS DynamoDB, simplifying CRUD operations and common database interactions.

package/dist/DynamoDbRepository.js

@@ -80,16 +80,18 @@ const paginate = (array, pageSize) => {
     }, []);
 };
 class DynamoDbRepository {
-    constructor(dynamoDBClient, tableName, hashKey, rangKey) {
+    constructor(dynamoDBClient, tableName, hashKey, rangKey, returnConsumedCapacity = client_dynamodb_1.ReturnConsumedCapacity.TOTAL) {
         this.dynamoDBClient = dynamoDBClient;
         this.tableName = tableName;
         this.hashKey = hashKey;
         this.rangKey = rangKey;
+        this.returnConsumedCapacity = returnConsumedCapacity;
         this.getItem = (key) => __awaiter(this, void 0, void 0, function* () {
             return this.dynamoDBClient
                 .send(new client_dynamodb_1.GetItemCommand({
                 TableName: this.tableName,
                 Key: (0, util_dynamodb_1.marshall)(key, { removeUndefinedValues: true }),
+                ReturnConsumedCapacity: this.returnConsumedCapacity,
             }))
                 .then((result) => result.Item ? (0, util_dynamodb_1.unmarshall)(result.Item) : undefined);
         });
@@ -98,6 +100,7 @@ class DynamoDbRepository {
             return this.dynamoDBClient
                 .send(new client_dynamodb_1.PutItemCommand({
                 TableName: this.tableName,
+                ReturnConsumedCapacity: this.returnConsumedCapacity,
                 Item,
             }))
                 .then(() => this.getItem(key));
@@ -129,6 +132,7 @@ class DynamoDbRepository {
                     .filter(([, value]) => value !== undefined)
                     .reduce((acc, [key]) => (Object.assign(Object.assign({}, acc), { [`#${expressionAttributeKey(key)}`]: key })), Object.assign(removeAttributeNames)),
                 ExpressionAttributeValues: hasUpdates ? (0, util_dynamodb_1.marshall)(Object.entries(updates).reduce((acc, [key, value]) => (Object.assign(Object.assign({}, acc), { [`:${expressionAttributeKey(key)}`]: value })), Object.assign({})), { removeUndefinedValues: true }) : undefined,
+                ReturnConsumedCapacity: this.returnConsumedCapacity,
             };
             return this.dynamoDBClient
                 .send(new client_dynamodb_1.UpdateItemCommand(updateItemCommandInput))
@@ -160,6 +164,7 @@ class DynamoDbRepository {
                 : {};
             const queryCommandInput = {
                 TableName: this.tableName,
+                ReturnConsumedCapacity: this.returnConsumedCapacity,
                 IndexName: index,
                 KeyConditionExpression,
                 FilterExpression,
@@ -226,9 +231,10 @@ class DynamoDbRepository {
                         [this.tableName]: {
                             Keys: keyPage.map((key) => ((0, util_dynamodb_1.marshall)(key))),
                             ProjectionExpression,
-                            ExpressionAttributeNames
+                            ExpressionAttributeNames,
                         }
-                    }
+                    },
+                    ReturnConsumedCapacity: this.returnConsumedCapacity,
                 };
                 return this.dynamoDBClient.send(new client_dynamodb_1.BatchGetItemCommand(batchRequest)).then(result => { var _a; return (_a = result.Responses) === null || _a === void 0 ? void 0 : _a[this.tableName].map((item) => (0, util_dynamodb_1.unmarshall)(item)); });
             }))))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eresearchqut/ddb-repository",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/DynamoDbRepository.ts

@@ -7,6 +7,7 @@ import {
     paginateQuery,
     PutItemCommand,
     QueryCommandInput,
+    ReturnConsumedCapacity,
     UpdateItemCommand,
 } from "@aws-sdk/client-dynamodb";
 import {marshall, unmarshall} from "@aws-sdk/util-dynamodb";
@@ -125,6 +126,7 @@ export class DynamoDbRepository<K, T> {
         private readonly tableName: string,
         private readonly hashKey: string,
         private readonly rangKey?: string,
+        private readonly returnConsumedCapacity: ReturnConsumedCapacity | undefined = ReturnConsumedCapacity.TOTAL,
     ) {
 
     }
@@ -135,6 +137,7 @@ export class DynamoDbRepository<K, T> {
                 new GetItemCommand({
                     TableName: this.tableName,
                     Key: marshall(key, {removeUndefinedValues: true}),
+                    ReturnConsumedCapacity: this.returnConsumedCapacity,
                 }),
             )
             .then((result) =>
@@ -148,6 +151,7 @@ export class DynamoDbRepository<K, T> {
             .send(
                 new PutItemCommand({
                     TableName: this.tableName,
+                    ReturnConsumedCapacity: this.returnConsumedCapacity,
                     Item,
                 }),
             )
@@ -215,6 +219,7 @@ export class DynamoDbRepository<K, T> {
                 ),
                 {removeUndefinedValues: true},
             ) : undefined,
+            ReturnConsumedCapacity: this.returnConsumedCapacity,
         };
         return this.dynamoDBClient
             .send(new UpdateItemCommand(updateItemCommandInput))
@@ -275,6 +280,7 @@ export class DynamoDbRepository<K, T> {
             : {};
         const queryCommandInput: QueryCommandInput = {
             TableName: this.tableName,
+            ReturnConsumedCapacity: this.returnConsumedCapacity,
             IndexName: index,
             KeyConditionExpression,
             FilterExpression,
@@ -348,9 +354,10 @@ export class DynamoDbRepository<K, T> {
                     [this.tableName]: {
                         Keys: keyPage.map((key) => (marshall(key))),
                         ProjectionExpression,
-                        ExpressionAttributeNames
+                        ExpressionAttributeNames,
                     }
-                }
+                },
+                ReturnConsumedCapacity: this.returnConsumedCapacity,
             }
             return this.dynamoDBClient.send(new BatchGetItemCommand(batchRequest)).then(result =>
                 result.Responses?.[this.tableName].map((item) => unmarshall(item) as T));