@eresearchqut/ddb-repository 1.4.1 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.5.0](https://github.com/eresearchqut/ddb-repository/compare/v1.4.1...v1.5.0) (2025-11-21)
+
+
+### Features
+
+* Initialise the repository using options ([e3a2f46](https://github.com/eresearchqut/ddb-repository/commit/e3a2f46d3a8fb0ca467409369eef505d0451b6b0))
+
 ## [1.4.1](https://github.com/eresearchqut/ddb-repository/compare/v1.4.0...v1.4.1) (2025-11-21)
 
 

package/dist/DynamoDbRepository.js

@@ -78,12 +78,8 @@ const paginate = (array, pageSize) => {
     }, []);
 };
 class DynamoDbRepository {
-    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;
+    constructor(options) {
+        var _a;
         this.getItem = (key) => __awaiter(this, void 0, void 0, function* () {
             return this.dynamoDBClient
                 .send(new client_dynamodb_1.GetItemCommand({
@@ -238,6 +234,11 @@ class DynamoDbRepository {
             }))))
                 .then((itemSets) => itemSets.flat());
         });
+        this.dynamoDBClient = options.client;
+        this.tableName = options.tableName;
+        this.hashKey = options.hashKey;
+        this.rangKey = options.rangeKey;
+        this.returnConsumedCapacity = (_a = options.returnConsumedCapacity) !== null && _a !== void 0 ? _a : client_dynamodb_1.ReturnConsumedCapacity.TOTAL;
     }
 }
 exports.DynamoDbRepository = DynamoDbRepository;

package/package.json

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

package/src/DynamoDbRepository.ts

@@ -118,16 +118,27 @@ const paginate = <T>(array: Array<T>, pageSize: number) => {
     }, [] as Array<Array<T>>);
 }
 
-export class DynamoDbRepository<K, T> {
+export interface DynamoDbRepositoryOptions {
+    client: DynamoDBClient;
+    tableName: string;
+    hashKey: string;
+    rangeKey?: string;
+    returnConsumedCapacity?: ReturnConsumedCapacity;
+}
 
-    constructor(
-        private readonly dynamoDBClient: DynamoDBClient,
-        private readonly tableName: string,
-        private readonly hashKey: string,
-        private readonly rangKey?: string,
-        private readonly returnConsumedCapacity: ReturnConsumedCapacity | undefined = ReturnConsumedCapacity.TOTAL,
-    ) {
+export class DynamoDbRepository<K, T> {
+    private readonly dynamoDBClient: DynamoDBClient;
+    private readonly tableName: string;
+    private readonly hashKey: string;
+    private readonly rangKey?: string;
+    private readonly returnConsumedCapacity: ReturnConsumedCapacity | undefined;
 
+    constructor(options: DynamoDbRepositoryOptions) {
+        this.dynamoDBClient = options.client;
+        this.tableName = options.tableName;
+        this.hashKey = options.hashKey;
+        this.rangKey = options.rangeKey;
+        this.returnConsumedCapacity = options.returnConsumedCapacity ?? ReturnConsumedCapacity.TOTAL;
     }
 
     getItem = async (key: K): Promise<T | undefined> => {

package/test/DynamoDbRepository.test.ts

@@ -120,9 +120,23 @@ describe('DynamoDbRepository Integration Tests', () => {
         }
 
         // Initialize repositories
-        repository = new DynamoDbRepository(dynamoDBClient, tableName, "id");
-        compositeRepository = new DynamoDbRepository(dynamoDBClient, compositeTableName, "userId", "itemId");
-        gsiRepository = new DynamoDbRepository(dynamoDBClient, gsiTableName, "userId", "itemId");
+        repository = new DynamoDbRepository({
+            client: dynamoDBClient,
+            tableName: tableName,
+            hashKey: "id"
+        });
+        compositeRepository = new DynamoDbRepository({
+            client: dynamoDBClient,
+            tableName: compositeTableName,
+            hashKey: "userId",
+            rangeKey: "itemId"
+        });
+        gsiRepository = new DynamoDbRepository({
+            client: dynamoDBClient,
+            tableName: gsiTableName,
+            hashKey: "userId",
+            rangeKey: "itemId"
+        });
     });
 
     beforeEach(async () => {