@eresearchqut/ddb-repository 1.5.6 → 1.5.8

package/dist/DynamoDbRepository.d.ts

@@ -0,0 +1,50 @@
+import { DynamoDBClient, ReturnConsumedCapacity } from "@aws-sdk/client-dynamodb";
+export declare enum FilterOperator {
+    EQUALS = "=",
+    NOT_EQUALS = "<>",
+    GREATER_THAN_OR_EQUALS = ">=",
+    GREATER_THAN = ">",
+    LESS_THAN = "<",
+    LESS_THAN_OR_EQUALS = "<=",
+    IN = "IN",
+    BETWEEN = "BETWEEN"
+}
+export interface FilterExpression {
+    attribute: string;
+    value: string | number | boolean | Array<string | number> | [string, string] | [number, number];
+    operator: FilterOperator;
+    negate?: boolean;
+}
+export interface FilterableQuery {
+    filterExpressions: Array<FilterExpression>;
+}
+export interface ProjectedQuery {
+    projectedAttributes: string[];
+}
+export interface IndexedQuery {
+    index: string;
+}
+export interface Query extends Partial<FilterableQuery>, Partial<ProjectedQuery>, Partial<IndexedQuery> {
+    [key: string]: unknown;
+}
+export interface DynamoDbRepositoryOptions {
+    client: DynamoDBClient;
+    tableName: string;
+    hashKey: string;
+    rangeKey?: string;
+    returnConsumedCapacity?: ReturnConsumedCapacity;
+}
+export declare class DynamoDbRepository<K, T> {
+    private readonly dynamoDBClient;
+    private readonly tableName;
+    private readonly hashKey;
+    private readonly rangKey?;
+    private readonly returnConsumedCapacity;
+    constructor(options: DynamoDbRepositoryOptions);
+    getItem: (key: K) => Promise<T | undefined>;
+    putItem: (key: K, record: T) => Promise<T>;
+    deleteItem: (key: K) => Promise<Record<string, any> | undefined>;
+    updateItem: (key: K, updates: Partial<T>, remove?: string[]) => Promise<T | undefined>;
+    getItems: (query: Query) => Promise<Array<T> | undefined>;
+    batchGetItems: (keys: K[], projectedQuery?: ProjectedQuery) => Promise<Array<T | undefined>>;
+}

package/dist/consumed-capacity-middleware.d.ts

@@ -0,0 +1,10 @@
+import { ConsumedCapacity, ReturnConsumedCapacity } from "@aws-sdk/client-dynamodb";
+import { HandlerExecutionContext, InitializeHandler, MetadataBearer } from "@smithy/types";
+export interface ConsumedCapacityDetail {
+    ReturnConsumedCapacity: ReturnConsumedCapacity | undefined;
+    ConsumedCapacity: ConsumedCapacity | ConsumedCapacity[] | undefined;
+}
+export interface ConsumedCapacityMiddlewareConfig {
+    onConsumedCapacity: (consumedCapacity: ConsumedCapacityDetail) => Promise<unknown>;
+}
+export declare const consumedCapacityMiddleware: (consumedCapacityMiddlewareConfig: ConsumedCapacityMiddlewareConfig) => <Output extends MetadataBearer = MetadataBearer>(next: InitializeHandler<any, Output>, context: HandlerExecutionContext) => InitializeHandler<any, Output>;

package/dist/index.d.ts

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

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@eresearchqut/ddb-repository",
-  "version": "1.5.6",
+  "version": "1.5.8",
   "description": "A TypeScript library providing a generic repository pattern implementation for AWS DynamoDB, simplifying CRUD operations and common database interactions.",
-  "type": "commonjs",
-  "main": "dist/index.js",
+  "main": "dist/index",
+  "types": "dist/index",
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },

package/.github/workflows/build.yml

@@ -1,61 +0,0 @@
-name: Build
-
-on:
-  push:
-    branches: [ main, develop ]
-  pull_request:
-    branches: [ main, develop ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run linter
-        run: npm run lint
-
-      - name: Run tests with coverage
-        run: npm run test:coverage
-
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          file: ./coverage/lcov.info
-          flags: unittests
-          name: codecov-umbrella
-          fail_ci_if_error: false
-
-      - name: Upload coverage to Coveralls
-        uses: coverallsapp/github-action@v2
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          path-to-lcov: ./coverage/lcov.info
-        continue-on-error: true
-
-      - name: Build package
-        run: npm run build
-
-      - name: Upload build artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: dist
-          path: dist/
-          retention-days: 7
-
-      - name: Upload coverage artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: coverage-report
-          path: coverage/
-          retention-days: 7

package/.github/workflows/release.yml

@@ -1,34 +0,0 @@
-name: Release
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-      - name: Install dependencies
-        run: npm clean-install
-      - name: Build package
-        run: npm run build
-      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
-        run: npm audit signatures
-      - name: Semantic Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release

package/.releaserc.json

@@ -1,17 +0,0 @@
-{
-  "branches": ["main"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ],
-    "@semantic-release/github"
-  ]
-}

package/CHANGELOG.md

@@ -1,85 +0,0 @@
-## [1.5.6](https://github.com/eresearchqut/ddb-repository/compare/v1.5.5...v1.5.6) (2025-12-11)
-
-
-### Bug Fixes
-
-* Adding NPM Publish ([6112d68](https://github.com/eresearchqut/ddb-repository/commit/6112d680e693114315ebfe63b6f542760098c76d))
-
-## [1.5.5](https://github.com/eresearchqut/ddb-repository/compare/v1.5.4...v1.5.5) (2025-12-11)
-
-
-### Bug Fixes
-
-* Adding NPM Publish ([8246366](https://github.com/eresearchqut/ddb-repository/commit/824636610a803b8a0bc07f4b1227f9ddde997de7))
-
-## [1.5.4](https://github.com/eresearchqut/ddb-repository/compare/v1.5.3...v1.5.4) (2025-12-11)
-
-
-### Bug Fixes
-
-* adding build to release action ([a396d9f](https://github.com/eresearchqut/ddb-repository/commit/a396d9f507ec7da3ebac7664f1d0641f8897280d))
-
-## [1.5.3](https://github.com/eresearchqut/ddb-repository/compare/v1.5.2...v1.5.3) (2025-12-10)
-
-
-### Bug Fixes
-
-* adding repository to package.json ([94961d2](https://github.com/eresearchqut/ddb-repository/commit/94961d22bd371742b4ed4309cfe118e95ea09958))
-
-## [1.5.2](https://github.com/eresearchqut/ddb-repository/compare/v1.5.1...v1.5.2) (2025-12-10)
-
-
-### Bug Fixes
-
-* release to npm ([274ef77](https://github.com/eresearchqut/ddb-repository/commit/274ef77b079d644571066e5c05a9edf3e4cf7396))
-
-## [1.5.1](https://github.com/eresearchqut/ddb-repository/compare/v1.5.0...v1.5.1) (2025-12-10)
-
-
-### Bug Fixes
-
-* Module type ([52a2a07](https://github.com/eresearchqut/ddb-repository/commit/52a2a07295bafcfa8b621fd59d085d7dfd567402))
-* package updates ([79d5672](https://github.com/eresearchqut/ddb-repository/commit/79d56725628a6ea0216b86a5c2d8f158fc008de6))
-* Updated installation instructions ([282e1fd](https://github.com/eresearchqut/ddb-repository/commit/282e1fd0d6ffe24a3caefa5e2c1e7067a348a3ce))
-
-# [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)
-
-
-### Features
-
-* Add test for the tracking of the consumed capacity and rename test class ([d113a5a](https://github.com/eresearchqut/ddb-repository/commit/d113a5a948a7dffc80e9d3a65a11203c2249ed26))
-
-# [1.3.0](https://github.com/eresearchqut/ddb-repository/compare/v1.2.0...v1.3.0) (2025-11-20)
-
-
-### Features
-
-* Add test for the tracking of the consumed capacity ([4a1b23c](https://github.com/eresearchqut/ddb-repository/commit/4a1b23cadadbbb02d78507ca9d34715219fc952c))
-
-# [1.2.0](https://github.com/eresearchqut/ddb-repository/compare/v1.1.0...v1.2.0) (2025-11-19)
-
-
-### Features
-
-* return the consumed capacity for each operation ([3910953](https://github.com/eresearchqut/ddb-repository/commit/391095398381a950c3393f9103d97d355c119538))
-
-# [1.1.0](https://github.com/eresearchqut/ddb-repository/compare/v1.0.2...v1.1.0) (2025-11-19)
-
-
-### Features
-
-* NPM Package Badge ([fecd958](https://github.com/eresearchqut/ddb-repository/commit/fecd958d0d3725e0fc19f43f36e00eb7e5437716))

package/eslint.config.mjs

@@ -1,13 +0,0 @@
-import eslint from '@eslint/js';
-import { defineConfig, globalIgnores } from 'eslint/config';
-
-import tseslint from 'typescript-eslint';
-
-export default defineConfig([
-    globalIgnores([
-        "node_modules/*", // ignore its content
-        "dist/*",
-    ])],
-    eslint.configs.recommended,
-    tseslint.configs.recommended,
-);

package/jest.config.ts

@@ -1,28 +0,0 @@
-import type { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
-    roots: ['<rootDir>/src', '<rootDir>/test'],
-    testMatch: ['**/*.test.ts', '**/*.spec.ts'],
-    collectCoverage: false, // Set to true by default if you want coverage on every run
-    collectCoverageFrom: [
-        'src/**/*.ts',
-        '!src/**/*.d.ts',
-        '!src/**/*.interface.ts',
-        '!src/**/index.ts', // Typically just exports, can be excluded
-    ],
-    coverageDirectory: 'coverage',
-    coverageReporters: [
-        'text',           // Console output
-        'text-summary',   // Summary in console
-        'html',          // HTML report in coverage/
-        'lcov',          // For CI/CD tools
-        'json',          // JSON format
-    ],
-    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-    verbose: true,
-    testTimeout: 60000
-};
-
-export default config;