@lafken/bucket 0.14.4 → 0.15.0

package/README.md

@@ -216,6 +216,25 @@ for (const object of result.Contents) {
 }
 ```
 
+#### Custom Client
+
+By default every repository shares an `S3Client` built from the ambient AWS SDK configuration (the region, credentials and endpoint the SDK resolves from the environment). Pass a `client` to reach a bucket on a different region, account or endpoint, such as a local S3-compatible instance during development:
+
+```typescript
+import { S3Client } from '@aws-sdk/client-s3';
+import { createRepository } from '@lafken/bucket/service';
+
+const client = new S3Client({
+  endpoint: 'http://localhost:9000',
+  region: 'us-east-1',
+  forcePathStyle: true,
+});
+
+export const docsRepository = createRepository(DocumentBucket, { client });
+```
+
+Reuse the same instance across your buckets instead of creating one per repository, so they share a single connection pool.
+
 ### X-Ray Tracing
 
 Enable `tracing` in the `@Bucket` decorator to instrument all repository operations with AWS X-Ray:

package/lib/service/repository/repository.d.ts

@@ -1,3 +1,3 @@
 import type { ClassResource } from '@lafken/common';
-import type { RepositoryReturn } from './repository.types';
-export declare const createRepository: <E extends ClassResource>(bucket: E) => RepositoryReturn<E>;
+import type { RepositoryOptions, RepositoryReturn } from './repository.types';
+export declare const createRepository: <E extends ClassResource>(bucket: E, options?: RepositoryOptions) => RepositoryReturn<E>;

package/lib/service/repository/repository.js

@@ -4,9 +4,9 @@ exports.createRepository = void 0;
 const client_s3_1 = require("@aws-sdk/client-s3");
 const client_1 = require("../client/client");
 const repository_utils_1 = require("./repository.utils");
-const createRepository = (bucket) => {
+const createRepository = (bucket, options = {}) => {
     const { name } = (0, repository_utils_1.getBucketInformation)(bucket);
-    const bucketClient = client_1.client;
+    const bucketClient = options.client ?? client_1.client;
     return {
         putObject(props) {
             const command = new client_s3_1.PutObjectCommand({

package/lib/service/repository/repository.types.d.ts

@@ -1,6 +1,17 @@
-import type { _Object, CopyObjectCommandInput, CopyObjectCommandOutput, DeleteObjectCommandInput, DeleteObjectCommandOutput, GetObjectCommandInput, GetObjectCommandOutput, ListObjectsV2CommandInput, PutObjectCommandInput, PutObjectCommandOutput } from '@aws-sdk/client-s3';
+import type { _Object, CopyObjectCommandInput, CopyObjectCommandOutput, DeleteObjectCommandInput, DeleteObjectCommandOutput, GetObjectCommandInput, GetObjectCommandOutput, ListObjectsV2CommandInput, PutObjectCommandInput, PutObjectCommandOutput, S3Client } from '@aws-sdk/client-s3';
 import type { ClassResource } from '@lafken/common';
 export type InputWithoutBucket<T> = Omit<T, 'Bucket'>;
+export interface RepositoryOptions {
+    /**
+     * S3 client used by every operation of the repository.
+     *
+     * Injecting a client is the way to reach a bucket on a different region, account or endpoint,
+     * for example a local S3-compatible instance during development.
+     *
+     * @default The shared client built from the ambient AWS SDK configuration.
+     */
+    client?: S3Client;
+}
 export type RepositoryReturn<_E extends ClassResource> = {
     putObject(props: InputWithoutBucket<PutObjectCommandInput>): Promise<PutObjectCommandOutput>;
     getObject(props: InputWithoutBucket<GetObjectCommandInput>): Promise<GetObjectCommandOutput>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/bucket",
-  "version": "0.14.4",
+  "version": "0.15.0",
   "private": false,
   "description": "Define S3 buckets using TypeScript decorators - automatic infrastructure generation with Lafken",
   "keywords": [
@@ -57,7 +57,7 @@
   ],
   "dependencies": {
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.14.4"
+    "@lafken/resolver": "0.15.0"
   },
   "devDependencies": {
     "@aws-sdk/client-s3": "^3.1106.0",
@@ -71,16 +71,16 @@
     "typescript": "7.0.2",
     "unplugin-swc": "^1.5.10",
     "vitest": "^4.1.10",
-    "@lafken/common": "0.14.4"
+    "@lafken/common": "0.15.0"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": ">=10.7.0",
-    "@lafken/common": "0.14.4"
+    "@lafken/common": "0.15.0"
   },
   "engines": {
-    "node": ">=20.19"
+    "node": ">=22.13"
   },
   "publishConfig": {
     "access": "public"