@eresearchqut/ddb-repository 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [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)
+
+
+### Bug Fixes
+
+* Fix scope of internal methods ([c652753](https://github.com/eresearchqut/ddb-repository/commit/c652753156662fa08b818e0df068fbb2702881c9))
+
 # [1.4.0](https://github.com/eresearchqut/ddb-repository/compare/v1.3.0...v1.4.0) (2025-11-20)
 
 

package/dist/DynamoDbRepository.js

@@ -27,11 +27,10 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DynamoDbRepository = exports.consumedCapacityMiddleware = exports.mapFilterExpressions = exports.mapFilterExpression = exports.FilterOperator = void 0;
+exports.DynamoDbRepository = exports.FilterOperator = void 0;
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
 const lodash_1 = require("lodash");
-const expressionAttributeKey = (key) => (0, lodash_1.replace)(key, /-/g, "_");
 var FilterOperator;
 (function (FilterOperator) {
     FilterOperator["EQUALS"] = "=";
@@ -43,6 +42,7 @@ var FilterOperator;
     FilterOperator["IN"] = "IN";
     FilterOperator["BETWEEN"] = "BETWEEN";
 })(FilterOperator || (exports.FilterOperator = FilterOperator = {}));
+const expressionAttributeKey = (key) => (0, lodash_1.replace)(key, /-/g, "_");
 const mapInKeys = (filterExpression) => Array.isArray(filterExpression.value)
     ? filterExpression.value.map((_, index) => `:${filterExpression.attribute}${index}`)
     : `:${filterExpression.attribute}`;
@@ -59,13 +59,11 @@ const mapFilterExpression = (filterExpression) => {
                 `:${expressionAttributeKey(filterExpression.attribute)}`);
     }
 };
-exports.mapFilterExpression = mapFilterExpression;
 const mapFilterExpressions = (filterExpressions) => filterExpressions
     .map((filterExpression) => filterExpression.negate
-    ? `NOT ${(0, exports.mapFilterExpression)(filterExpression)}`
-    : (0, exports.mapFilterExpression)(filterExpression))
+    ? `NOT ${mapFilterExpression(filterExpression)}`
+    : mapFilterExpression(filterExpression))
     .join(" AND ");
-exports.mapFilterExpressions = mapFilterExpressions;
 const mapFilterExpressionValues = (filterExpression) => Array.isArray(filterExpression.value)
     ? filterExpression.value.reduce((reduction, value, index) => (Object.assign(Object.assign({}, reduction), { [`:${expressionAttributeKey(filterExpression.attribute)}${index}`]: value })), Object.assign({}))
     : {
@@ -79,28 +77,9 @@ const paginate = (array, pageSize) => {
         return acc;
     }, []);
 };
-const consumedCapacityMiddleware = (consumedCapacityMiddlewareConfig) => (next, context) => (args) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        const { input } = args;
-        const { ReturnConsumedCapacity } = input;
-        const response = yield next(args);
-        const { output } = response;
-        const consumedCapacity = (0, lodash_1.get)(output, "ConsumedCapacity");
-        yield consumedCapacityMiddlewareConfig.onConsumedCapacity({ ReturnConsumedCapacity, ConsumedCapacity: consumedCapacity });
-        return response;
-    }
-    catch (error) {
-        throw error;
-    }
-});
-exports.consumedCapacityMiddleware = consumedCapacityMiddleware;
 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({
@@ -169,7 +148,7 @@ class DynamoDbRepository {
             const projectionAttributeNames = !index && projectedAttributes ? projectedAttributes.reduce((reduction, attribute) => (Object.assign(Object.assign({}, reduction), { [`#${expressionAttributeKey(attribute)}`]: attribute })), Object.assign({})) : {};
             const hasFilterExpressions = Array.isArray(filterExpressions) && filterExpressions.length > 0;
             const FilterExpression = hasFilterExpressions
-                ? (0, exports.mapFilterExpressions)(filterExpressions)
+                ? mapFilterExpressions(filterExpressions)
                 : undefined;
             const filterAttributeNames = hasFilterExpressions
                 ? filterExpressions.reduce((reduction, filterExpression) => (Object.assign(Object.assign({}, reduction), { [`#${expressionAttributeKey(filterExpression.attribute)}`]: filterExpression.attribute })), Object.assign({}))
@@ -255,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/dist/consumed-capacity-middleware.js

@@ -0,0 +1,25 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.consumedCapacityMiddleware = void 0;
+const lodash_1 = require("lodash");
+/* eslint-disable  @typescript-eslint/no-explicit-any  */
+/* eslint-disable  @typescript-eslint/no-unused-vars  */
+const consumedCapacityMiddleware = (consumedCapacityMiddlewareConfig) => (next, context) => (args) => __awaiter(void 0, void 0, void 0, function* () {
+    const { input } = args;
+    const { ReturnConsumedCapacity } = input;
+    const response = yield next(args);
+    const { output } = response;
+    const consumedCapacity = (0, lodash_1.get)(output, "ConsumedCapacity");
+    yield consumedCapacityMiddlewareConfig.onConsumedCapacity({ ReturnConsumedCapacity, ConsumedCapacity: consumedCapacity });
+    return response;
+});
+exports.consumedCapacityMiddleware = consumedCapacityMiddleware;

package/dist/index.js

@@ -1,17 +1,8 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./DynamoDbRepository"), exports);
+exports.consumedCapacityMiddleware = exports.DynamoDbRepository = exports.FilterOperator = void 0;
+var DynamoDbRepository_1 = require("./DynamoDbRepository");
+Object.defineProperty(exports, "FilterOperator", { enumerable: true, get: function () { return DynamoDbRepository_1.FilterOperator; } });
+Object.defineProperty(exports, "DynamoDbRepository", { enumerable: true, get: function () { return DynamoDbRepository_1.DynamoDbRepository; } });
+var consumed_capacity_middleware_1 = require("./consumed-capacity-middleware");
+Object.defineProperty(exports, "consumedCapacityMiddleware", { enumerable: true, get: function () { return consumed_capacity_middleware_1.consumedCapacityMiddleware; } });

package/package.json

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

package/src/DynamoDbRepository.ts

@@ -1,7 +1,6 @@
 import {
     BatchGetItemCommand,
     BatchGetItemCommandInput,
-    ConsumedCapacity,
     DeleteItemCommand,
     DynamoDBClient,
     GetItemCommand,
@@ -12,16 +11,7 @@ import {
     UpdateItemCommand,
 } from "@aws-sdk/client-dynamodb";
 import {marshall, unmarshall} from "@aws-sdk/util-dynamodb";
-import {replace, uniqWith, isEqual, pickBy, get} from "lodash";
-import {
-    HandlerExecutionContext,
-    InitializeHandler,
-    InitializeHandlerArguments,
-    InitializeHandlerOutput,
-    MetadataBearer
-} from "@smithy/types";
-
-const expressionAttributeKey = (key: string) => replace(key, /-/g, "_");
+import {replace, uniqWith, isEqual, pickBy} from "lodash";
 
 export enum FilterOperator {
     EQUALS = "=",
@@ -63,6 +53,7 @@ export interface Query extends Partial<FilterableQuery>, Partial<ProjectedQuery>
     [key: string]: unknown;
 }
 
+const expressionAttributeKey = (key: string) => replace(key, /-/g, "_");
 
 const mapInKeys = (filterExpression: FilterExpression) =>
     Array.isArray(filterExpression.value)
@@ -71,7 +62,7 @@ const mapInKeys = (filterExpression: FilterExpression) =>
         )
         : `:${filterExpression.attribute}`;
 
-export const mapFilterExpression = (filterExpression: FilterExpression) => {
+const mapFilterExpression = (filterExpression: FilterExpression) => {
     switch (filterExpression.operator) {
         case FilterOperator.IN:
             return (
@@ -91,7 +82,7 @@ export const mapFilterExpression = (filterExpression: FilterExpression) => {
     }
 };
 
-export const mapFilterExpressions = (
+const mapFilterExpressions = (
     filterExpressions: Array<FilterExpression>,
 ) =>
     filterExpressions
@@ -127,45 +118,27 @@ const paginate = <T>(array: Array<T>, pageSize: number) => {
     }, [] as Array<Array<T>>);
 }
 
-export interface ConsumedCapacityDetail {
-    ReturnConsumedCapacity: ReturnConsumedCapacity | undefined
-    ConsumedCapacity: ConsumedCapacity | ConsumedCapacity[] | undefined
-}
-
-export interface ConsumedCapacityMiddlewareConfig {
-    onConsumedCapacity: (consumedCapacity: ConsumedCapacityDetail) => Promise<unknown>;
+export interface DynamoDbRepositoryOptions {
+    client: DynamoDBClient;
+    tableName: string;
+    hashKey: string;
+    rangeKey?: string;
+    returnConsumedCapacity?: ReturnConsumedCapacity;
 }
 
-export const consumedCapacityMiddleware =
-    (consumedCapacityMiddlewareConfig: ConsumedCapacityMiddlewareConfig) =>
-        <Output extends MetadataBearer = MetadataBearer>(
-            next: InitializeHandler<any, Output>,
-            context: HandlerExecutionContext
-        ): InitializeHandler<any, Output> =>
-            async (args: InitializeHandlerArguments<any>): Promise<InitializeHandlerOutput<Output>> => {
-                try {
-                    const {input} = args;
-                    const {ReturnConsumedCapacity} = input;
-                    const response = await next(args);
-                    const {output} = response;
-                    const consumedCapacity = get(output, "ConsumedCapacity") as ConsumedCapacity | undefined;
-                    await consumedCapacityMiddlewareConfig.onConsumedCapacity({ReturnConsumedCapacity, ConsumedCapacity: consumedCapacity});
-                    return response;
-                } catch (error) {
-                    throw error;
-                }
-            };
-
 export class DynamoDbRepository<K, T> {
-
-    constructor(
-        private readonly dynamoDBClient: DynamoDBClient,
-        private readonly tableName: string,
-        private readonly hashKey: string,
-        private readonly rangKey?: string,
-        private readonly returnConsumedCapacity: ReturnConsumedCapacity | undefined = ReturnConsumedCapacity.TOTAL,
-    ) {
-
+    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> => {
@@ -402,6 +375,5 @@ export class DynamoDbRepository<K, T> {
             .then((itemSets) => itemSets.flat());
 
     };
-
 }
 

package/src/consumed-capacity-middleware.ts

@@ -0,0 +1,41 @@
+import {
+    ConsumedCapacity,
+    ReturnConsumedCapacity
+} from "@aws-sdk/client-dynamodb";
+
+import {
+    HandlerExecutionContext,
+    InitializeHandler,
+    InitializeHandlerArguments,
+    InitializeHandlerOutput,
+    MetadataBearer
+} from "@smithy/types";
+
+import {get} from "lodash";
+
+export interface ConsumedCapacityDetail {
+    ReturnConsumedCapacity: ReturnConsumedCapacity | undefined
+    ConsumedCapacity: ConsumedCapacity | ConsumedCapacity[] | undefined
+}
+
+export interface ConsumedCapacityMiddlewareConfig {
+    onConsumedCapacity: (consumedCapacity: ConsumedCapacityDetail) => Promise<unknown>;
+}
+
+/* eslint-disable  @typescript-eslint/no-explicit-any  */
+/* eslint-disable  @typescript-eslint/no-unused-vars  */
+export const consumedCapacityMiddleware =
+    (consumedCapacityMiddlewareConfig: ConsumedCapacityMiddlewareConfig) =>
+        <Output extends MetadataBearer = MetadataBearer>(
+            next: InitializeHandler<any, Output>,
+            context: HandlerExecutionContext
+        ): InitializeHandler<any, Output> =>
+            async (args: InitializeHandlerArguments<any>): Promise<InitializeHandlerOutput<Output>> => {
+                const {input} = args;
+                const {ReturnConsumedCapacity} = input;
+                const response = await next(args);
+                const {output} = response;
+                const consumedCapacity = get(output, "ConsumedCapacity") as ConsumedCapacity | ConsumedCapacity[] | undefined;
+                await consumedCapacityMiddlewareConfig.onConsumedCapacity({ReturnConsumedCapacity, ConsumedCapacity: consumedCapacity});
+                return response;
+            };

package/src/index.ts

@@ -1,3 +1,4 @@
-export * from "./DynamoDbRepository";
+export {Query, IndexedQuery, ProjectedQuery, FilterableQuery, FilterExpression, FilterOperator, DynamoDbRepository} from "./DynamoDbRepository";
+export {consumedCapacityMiddleware, ConsumedCapacityDetail, ConsumedCapacityMiddlewareConfig} from "./consumed-capacity-middleware"
 
 

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 () => {