@aesop-fables/containr-dynamofx 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aesop
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+@aesop-fables/containr-dynamofx
+
+Provides a common bootstrapping configuration for using DynamoDB in your Typescript applications (i.e., `Triginta` microservices).
+
+## Sample Usage
+
+```typescript
+const container = createContainer([
+  useDynamo({
+    // optionally pass in anything you would to DynamoDB from @aws-sdk/client-dynamodb
+  })
+  myCustomModule,
+])
+```

package/lib/DynamoFactory.d.ts

@@ -0,0 +1,4 @@
+import { DynamoDB, DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
+export declare class DynamoFactory {
+    static createFullClient(configuration?: DynamoDBClientConfig): DynamoDB;
+}

package/lib/DynamoFactory.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamoFactory = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+class DynamoFactory {
+    static createFullClient(configuration) {
+        return new client_dynamodb_1.DynamoDB(configuration !== null && configuration !== void 0 ? configuration : {});
+    }
+}
+exports.DynamoFactory = DynamoFactory;

package/lib/DynamoServices.d.ts

@@ -0,0 +1,5 @@
+export declare const DynamoServices: {
+    Client: string;
+    DocClient: string;
+    Service: string;
+};

package/lib/DynamoServices.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamoServices = void 0;
+exports.DynamoServices = {
+    Client: 'dynamoClient',
+    DocClient: 'dynamoClient',
+    Service: 'dynamoService',
+};

package/lib/IDynamoOperation.d.ts

@@ -0,0 +1,3 @@
+export interface IDynamoOperation<Result = void, Params = any> {
+    execute(params: Params): Promise<Result>;
+}

package/lib/IDynamoOperation.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/IDynamoService.d.ts

@@ -0,0 +1,10 @@
+import { IServiceContainer, Newable } from '@aesop-fables/containr';
+import { IDynamoOperation } from './IDynamoOperation';
+export interface IDynamoService {
+    execute<Result, Params>(constructor: Newable<IDynamoOperation<Result, Params>>, params?: Params): Promise<Result>;
+}
+export declare class DynamoService implements IDynamoService {
+    private readonly container;
+    constructor(container: IServiceContainer);
+    execute<Result, Params>(constructor: Newable<IDynamoOperation<Result, Params>>, params?: Params | undefined): Promise<Result>;
+}

package/lib/IDynamoService.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamoService = void 0;
+class DynamoService {
+    constructor(container) {
+        this.container = container;
+    }
+    execute(constructor, params) {
+        const operation = this.container.resolve(constructor);
+        return operation.execute(params);
+    }
+}
+exports.DynamoService = DynamoService;

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+import { IServiceModule } from '@aesop-fables/containr';
+import { DynamoDBClientConfig } from '@aws-sdk/client-dynamodb';
+import { TranslateConfig } from '@aws-sdk/lib-dynamodb';
+import { DynamoFactory } from './DynamoFactory';
+import { DynamoServices } from './DynamoServices';
+import { DynamoService, IDynamoService } from './IDynamoService';
+export { IDynamoService, DynamoService, DynamoFactory, DynamoServices };
+export interface UseDynamoConfiguration {
+    core?: DynamoDBClientConfig;
+    documentTranslation?: TranslateConfig;
+}
+export declare const useDynamo: (options: UseDynamoConfiguration) => IServiceModule;

package/lib/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDynamo = exports.DynamoServices = exports.DynamoFactory = exports.DynamoService = void 0;
+const containr_1 = require("@aesop-fables/containr");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const DynamoFactory_1 = require("./DynamoFactory");
+Object.defineProperty(exports, "DynamoFactory", { enumerable: true, get: function () { return DynamoFactory_1.DynamoFactory; } });
+const DynamoServices_1 = require("./DynamoServices");
+Object.defineProperty(exports, "DynamoServices", { enumerable: true, get: function () { return DynamoServices_1.DynamoServices; } });
+const IDynamoService_1 = require("./IDynamoService");
+Object.defineProperty(exports, "DynamoService", { enumerable: true, get: function () { return IDynamoService_1.DynamoService; } });
+exports.useDynamo = (0, containr_1.createServiceModuleWithOptions)('useDynamo', (services, options) => {
+    const client = DynamoFactory_1.DynamoFactory.createFullClient(options.core);
+    services.register(DynamoServices_1.DynamoServices.Service, (container) => new IDynamoService_1.DynamoService(container));
+    services.register(DynamoServices_1.DynamoServices.Client, client);
+    services.register(DynamoServices_1.DynamoServices.DocClient, lib_dynamodb_1.DynamoDBDocumentClient.from(client, options === null || options === void 0 ? void 0 : options.documentTranslation));
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@aesop-fables/containr-dynamofx",
+  "version": "0.1.0",
+  "description": "A collection of services and utilities to make DynamoDb development easier",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "rimraf ./lib && tsc --p ./tsconfig.build.json",
+    "format": "prettier --write \"src/**/*.(js|ts)\"",
+    "lint": "eslint src --ext .js,.ts",
+    "lint:fix": "eslint src --fix --ext .js,.ts",
+    "test": "jest --config jest.config.js",
+    "prepublishOnly": "npm test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "dependencies": {
+    "@aesop-fables/containr": "^0.2.0",
+    "@aws-sdk/client-dynamodb": "^3.267.0",
+    "@aws-sdk/lib-dynamodb": "^3.267.0",
+    "@types/aws-lambda": "^8.10.110",
+    "aws-sdk": "^2.1311.0",
+    "reflect-metadata": "^0.1.13"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.4",
+    "@types/node": "^18.11.11",
+    "@typescript-eslint/eslint-plugin": "^5.45.1",
+    "@typescript-eslint/parser": "5.45.0",
+    "esbuild": "^0.16.2",
+    "eslint": "8.29.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "27.1.6",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "29.3.1",
+    "jest-environment-jsdom": "^29.3.1",
+    "prettier": "^2.8.1",
+    "ts-jest": "29.0.5",
+    "typescript": "4.9.3"
+  },
+  "files": [
+    "lib/**/*"
+  ]
+}