@bubltec/mycota-dynamo 1.2.0 → 1.4.0

package/dist/aws-client-defaults.d.ts

@@ -0,0 +1,21 @@
+/** Resilience knobs for AWS SDK clients. Every field is optional; see the defaults below. */
+export interface AwsClientSettings {
+    /** Total attempts per call, including the first. Default 3. */
+    maxAttempts?: number;
+    /** Max time to open a connection. Default 3000. */
+    connectionTimeoutMs?: number;
+    /** Max time to wait for a response on an open connection. Default 10000. */
+    requestTimeoutMs?: number;
+}
+/**
+ * Settings to spread into an AWS SDK client config. The SDK retries 3 times by default but
+ * has no request or connection timeout, so a hung socket would otherwise block forever.
+ */
+export declare function awsClientDefaults(settings?: AwsClientSettings, fallbackRequestTimeoutMs?: number): {
+    maxAttempts: number;
+    requestHandler: {
+        connectionTimeout: number;
+        requestTimeout: number;
+    };
+};
+//# sourceMappingURL=aws-client-defaults.d.ts.map

package/dist/aws-client-defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-client-defaults.d.ts","sourceRoot":"","sources":["../src/aws-client-defaults.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,MAAM,WAAW,iBAAiB;IAChC,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,GAAE,iBAAsB,EAAE,wBAAwB,SAAS;IAEjG,WAAW;IACX,cAAc;QACZ,iBAAiB;QACjB,cAAc;;EAGnB"}

package/dist/aws-client-defaults.js

@@ -0,0 +1,14 @@
+/**
+ * Settings to spread into an AWS SDK client config. The SDK retries 3 times by default but
+ * has no request or connection timeout, so a hung socket would otherwise block forever.
+ */
+export function awsClientDefaults(settings = {}, fallbackRequestTimeoutMs = 10_000) {
+    return {
+        maxAttempts: settings.maxAttempts ?? 3,
+        requestHandler: {
+            connectionTimeout: settings.connectionTimeoutMs ?? 3_000,
+            requestTimeout: settings.requestTimeoutMs ?? fallbackRequestTimeoutMs,
+        },
+    };
+}
+//# sourceMappingURL=aws-client-defaults.js.map

package/dist/aws-client-defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-client-defaults.js","sourceRoot":"","sources":["../src/aws-client-defaults.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAQ,GAAsB,EAAE,EAAE,wBAAwB,GAAG,MAAM;IACnG,OAAO;QACL,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,CAAC;QACtC,cAAc,EAAE;YACd,iBAAiB,EAAE,QAAQ,CAAC,mBAAmB,IAAI,KAAK;YACxD,cAAc,EAAE,QAAQ,CAAC,gBAAgB,IAAI,wBAAwB;SACtE;KACF,CAAC;AACJ,CAAC"}

package/dist/dynamo.module.d.ts

@@ -1,7 +1,15 @@
+import { type DynamicModule } from '@nestjs/common';
+import { type AwsClientSettings } from './aws-client-defaults.js';
+export interface DynamoModuleOptions {
+    /** Timeout and retry settings for the DynamoDB client. */
+    aws?: AwsClientSettings;
+}
 /**
  * Points at DynamoDB Local when DYNAMODB_ENDPOINT is set (local dev), or real
- * DynamoDB via the Lambda execution role otherwise.
+ * DynamoDB via the Lambda execution role otherwise. Import `DynamoModule` for the
+ * defaults, or `DynamoModule.forRoot({ aws })` to tune timeouts and retries.
  */
 export declare class DynamoModule {
+    static forRoot(options?: DynamoModuleOptions): DynamicModule;
 }
 //# sourceMappingURL=dynamo.module.d.ts.map

package/dist/dynamo.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamo.module.d.ts","sourceRoot":"","sources":["../src/dynamo.module.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,qBAqBa,YAAY;CAAG"}
+{"version":3,"file":"dynamo.module.d.ts","sourceRoot":"","sources":["../src/dynamo.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAGrF,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAgBD;;;;GAIG;AACH,qBAKa,YAAY;IACvB,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,mBAAwB,GAAG,aAAa,CAO/D;CACF"}

package/dist/dynamo.module.js

@@ -4,36 +4,44 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var DynamoModule_1;
 import { Global, Module } from '@nestjs/common';
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { awsClientDefaults } from './aws-client-defaults.js';
 import { DYNAMO_DOC_CLIENT } from './dynamo.constants.js';
+function createDocClient(options = {}) {
+    const endpoint = process.env.DYNAMODB_ENDPOINT;
+    const client = new DynamoDBClient({
+        region: process.env.AWS_REGION ?? 'us-east-1',
+        ...awsClientDefaults(options.aws),
+        ...(endpoint
+            ? { endpoint, credentials: { accessKeyId: 'local', secretAccessKey: 'local' } }
+            : {}),
+    });
+    return DynamoDBDocumentClient.from(client, {
+        marshallOptions: { removeUndefinedValues: true },
+    });
+}
 /**
  * Points at DynamoDB Local when DYNAMODB_ENDPOINT is set (local dev), or real
- * DynamoDB via the Lambda execution role otherwise.
+ * DynamoDB via the Lambda execution role otherwise. Import `DynamoModule` for the
+ * defaults, or `DynamoModule.forRoot({ aws })` to tune timeouts and retries.
  */
-let DynamoModule = class DynamoModule {
+let DynamoModule = DynamoModule_1 = class DynamoModule {
+    static forRoot(options = {}) {
+        return {
+            module: DynamoModule_1,
+            global: true,
+            providers: [{ provide: DYNAMO_DOC_CLIENT, useFactory: () => createDocClient(options) }],
+            exports: [DYNAMO_DOC_CLIENT],
+        };
+    }
 };
-DynamoModule = __decorate([
+DynamoModule = DynamoModule_1 = __decorate([
     Global(),
     Module({
-        providers: [
-            {
-                provide: DYNAMO_DOC_CLIENT,
-                useFactory: () => {
-                    const endpoint = process.env.DYNAMODB_ENDPOINT;
-                    const client = new DynamoDBClient({
-                        region: process.env.AWS_REGION ?? 'us-east-1',
-                        ...(endpoint
-                            ? { endpoint, credentials: { accessKeyId: 'local', secretAccessKey: 'local' } }
-                            : {}),
-                    });
-                    return DynamoDBDocumentClient.from(client, {
-                        marshallOptions: { removeUndefinedValues: true },
-                    });
-                },
-            },
-        ],
+        providers: [{ provide: DYNAMO_DOC_CLIENT, useFactory: () => createDocClient() }],
         exports: [DYNAMO_DOC_CLIENT],
     })
 ], DynamoModule);

package/dist/dynamo.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"dynamo.module.js","sourceRoot":"","sources":["../src/dynamo.module.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;;GAGG;AAsBI,IAAM,YAAY,GAAlB,MAAM,YAAY;CAAG,CAAA;AAAf,YAAY;IArBxB,MAAM,EAAE;IACR,MAAM,CAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,iBAAiB;gBAC1B,UAAU,EAAE,GAAG,EAAE;oBACf,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;oBAC/C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;wBAChC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;wBAC7C,GAAG,CAAC,QAAQ;4BACV,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,EAAE;4BAC/E,CAAC,CAAC,EAAE,CAAC;qBACR,CAAC,CAAC;oBACH,OAAO,sBAAsB,CAAC,IAAI,CAAC,MAAM,EAAE;wBACzC,eAAe,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE;qBACjD,CAAC,CAAC;gBACL,CAAC;aACF;SACF;QACD,OAAO,EAAE,CAAC,iBAAiB,CAAC;KAC7B,CAAC;GACW,YAAY,CAAG"}
+{"version":3,"file":"dynamo.module.js","sourceRoot":"","sources":["../src/dynamo.module.ts"],"names":[],"mappings":";;;;;;;AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAsB,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAA0B,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAO1D,SAAS,eAAe,CAAC,OAAO,GAAwB,EAAE;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;QAChC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;QAC7C,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC;QACjC,GAAG,CAAC,QAAQ;YACV,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,EAAE;YAC/E,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;IACH,OAAO,sBAAsB,CAAC,IAAI,CAAC,MAAM,EAAE;QACzC,eAAe,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE;KACjD,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AAMI,IAAM,YAAY,oBAAlB,MAAM,YAAY;IAChB,AAAP,MAAM,CAAC,OAAO,CAAC,OAAO,GAAwB,EAAE;QAC9C,OAAO;YACL,MAAM,gBAAc;YACpB,MAAM,EAAE,IAAI;YACZ,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;YACvF,OAAO,EAAE,CAAC,iBAAiB,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF,CAAA;AATY,YAAY;IALxB,MAAM,EAAE;IACR,MAAM,CAAC;QACN,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC;QAChF,OAAO,EAAE,CAAC,iBAAiB,CAAC;KAC7B,CAAC;GACW,YAAY,CASxB"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { DynamoModule } from './dynamo.module.js';
+export { DynamoModule, type DynamoModuleOptions } from './dynamo.module.js';
 export { DYNAMO_DOC_CLIENT } from './dynamo.constants.js';
 export { stripDynamoKeys } from './dynamo.utils.js';
+export { awsClientDefaults, type AwsClientSettings } from './aws-client-defaults.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export { DynamoModule } from './dynamo.module.js';
 export { DYNAMO_DOC_CLIENT } from './dynamo.constants.js';
 export { stripDynamoKeys } from './dynamo.utils.js';
+export { awsClientDefaults } from './aws-client-defaults.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA4B,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAA0B,MAAM,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bubltec/mycota-dynamo",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",