@onivoro/server-aws-credential-providers 24.33.16 → 24.33.17

package/README.md

@@ -132,9 +132,78 @@ aws_access_key_id = AKIAIOSFODNN7EXAMPLE2
 aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY2
 ```
 
+## AWS Client Provider Helper
+
+The `awsClientProvider` function eliminates boilerplate when registering AWS SDK v3 clients as NestJS providers. It creates a provider that injects `AwsCredentials` and instantiates the client with the correct region and credentials.
+
+```typescript
+import { awsClientProvider } from '@onivoro/server-aws-credential-providers';
+```
+
+### Basic usage
+
+```typescript
+import { Module } from '@nestjs/common';
+import { S3Client } from '@aws-sdk/client-s3';
+import { awsClientProvider, ServerAwsCredentialProvidersModule } from '@onivoro/server-aws-credential-providers';
+
+@Module({})
+export class ServerAwsS3Module {
+  static configure(config: ServerAwsS3Config) {
+    return {
+      module: ServerAwsS3Module,
+      imports: [ServerAwsCredentialProvidersModule.configure(config)],
+      providers: [
+        awsClientProvider(S3Client, config),
+        S3Service,
+      ],
+    };
+  }
+}
+```
+
+### Multiple clients in one module
+
+```typescript
+import { CloudWatchClient } from '@aws-sdk/client-cloudwatch';
+import { CloudWatchLogsClient } from '@aws-sdk/client-cloudwatch-logs';
+
+// ...
+providers: [
+  awsClientProvider(CloudWatchClient, config),
+  awsClientProvider(CloudWatchLogsClient, config),
+],
+```
+
+### Passing extra client options
+
+Use the optional third argument to pass additional properties to the client constructor:
+
+```typescript
+import { CognitoIdentityProviderClient } from '@aws-sdk/client-cognito-identity-provider';
+
+// ...
+providers: [
+  awsClientProvider(CognitoIdentityProviderClient, config, {
+    apiVersion: config.COGNITO_API_VERSION,
+  }),
+],
+```
+
+### Config requirements
+
+The `config` object must have an `AWS_REGION` property (and `AWS_PROFILE` if using profile-based credentials):
+
+```typescript
+export class ServerAwsS3Config {
+  AWS_REGION: string;
+  AWS_PROFILE?: string;
+}
+```
+
 ## Integration with AWS SDK
 
-Use the resolved credentials with AWS SDK v3:
+Use the resolved credentials directly with AWS SDK v3:
 
 ```typescript
 import { S3Client } from '@aws-sdk/client-s3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onivoro/server-aws-credential-providers",
-  "version": "24.33.16",
+  "version": "24.33.17",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from './lib/aws-client-provider.function';
 export * from './lib/aws-credentials.class';
 export * from './lib/resolve-aws-credential-providers-by-profile.function';
 export * from './lib/server-aws-credential-providers-config.class';

package/src/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/aws-client-provider.function"), exports);
 tslib_1.__exportStar(require("./lib/aws-credentials.class"), exports);
 tslib_1.__exportStar(require("./lib/resolve-aws-credential-providers-by-profile.function"), exports);
 tslib_1.__exportStar(require("./lib/server-aws-credential-providers-config.class"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/server/aws-credential-providers/src/index.ts"],"names":[],"mappings":";;;AAAA,sEAA4C;AAC5C,qGAA2E;AAC3E,6FAAmE;AACnE,uFAA6D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/server/aws-credential-providers/src/index.ts"],"names":[],"mappings":";;;AAAA,6EAAmD;AACnD,sEAA4C;AAC5C,qGAA2E;AAC3E,6FAAmE;AACnE,uFAA6D"}

package/src/lib/aws-client-provider.function.d.ts

@@ -0,0 +1,9 @@
+import { AwsCredentials } from './aws-credentials.class';
+export declare function awsClientProvider<T>(ClientClass: new (config: any) => T, config: {
+    AWS_REGION: string;
+}, extras?: Record<string, any>): {
+    provide: new (config: any) => T;
+    useFactory: (credentials: AwsCredentials) => T;
+    inject: (typeof AwsCredentials)[];
+};
+//# sourceMappingURL=aws-client-provider.function.d.ts.map

package/src/lib/aws-client-provider.function.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsClientProvider = awsClientProvider;
+const aws_credentials_class_1 = require("./aws-credentials.class");
+function awsClientProvider(ClientClass, config, extras) {
+    return {
+        provide: ClientClass,
+        useFactory: (credentials) => new ClientClass({
+            region: config.AWS_REGION,
+            credentials: credentials || undefined,
+            ...extras,
+        }),
+        inject: [aws_credentials_class_1.AwsCredentials],
+    };
+}
+//# sourceMappingURL=aws-client-provider.function.js.map

package/src/lib/aws-client-provider.function.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aws-client-provider.function.js","sourceRoot":"","sources":["../../../../../../libs/server/aws-credential-providers/src/lib/aws-client-provider.function.ts"],"names":[],"mappings":";;AAEA,8CAeC;AAjBD,mEAAyD;AAEzD,SAAgB,iBAAiB,CAC/B,WAAmC,EACnC,MAA8B,EAC9B,MAA4B;IAE5B,OAAO;QACL,OAAO,EAAE,WAAW;QACpB,UAAU,EAAE,CAAC,WAA2B,EAAE,EAAE,CAC1C,IAAI,WAAW,CAAC;YACd,MAAM,EAAE,MAAM,CAAC,UAAU;YACzB,WAAW,EAAE,WAAW,IAAI,SAAS;YACrC,GAAG,MAAM;SACV,CAAC;QACJ,MAAM,EAAE,CAAC,sCAAc,CAAC;KACzB,CAAC;AACJ,CAAC"}