@constructive-io/s3-streamer 2.44.6 → 2.45.0

package/README.md

@@ -35,7 +35,7 @@ Stream uploads to S3
 
 ```js
 import Streamer from '@constructive-io/s3-streamer';
-const streamer = new Streamer(opts)
+const streamer = new Streamer({ client, defaultBucket })
 const readStream = createReadStream(filename);
 const results = await streamer.upload({
     readStream,
@@ -91,8 +91,9 @@ The upload methods return a detailed payload with upload results and file metada
 If you don't want to use the `Streamer` class you can use the utils directly:
 
 ```js
-import { getClient, upload } from '@constructive-io/s3-streamer';
-const client = getClient(opts)
+import { createS3Client } from '@constructive-io/s3-utils';
+import { upload } from '@constructive-io/s3-streamer';
+const client = createS3Client(opts)
 const readStream = createReadStream(filename);
 const results = await upload({
     client,
@@ -110,9 +111,12 @@ const results = await upload({
 ```js
 const streamer = new Streamer({
   defaultBucket: 'my-bucket',
-  awsRegion: 'us-east-1',
-  awsSecretKey: process.env.AWS_SECRET_ACCESS_KEY,
-  awsAccessKey: process.env.AWS_ACCESS_KEY_ID
+  client: createS3Client({
+    provider: 's3',
+    region: 'us-east-1',
+    accessKeyId: process.env.STORAGE_ACCESS_KEY_ID,
+    secretAccessKey: process.env.STORAGE_SECRET_ACCESS_KEY
+  })
 });
 ```
 
@@ -121,10 +125,13 @@ const streamer = new Streamer({
 ```js
 const streamer = new Streamer({
   defaultBucket: 'my-bucket',
-  awsRegion: 'us-east-1',
-  awsSecretKey: 'minio-secret',
-  awsAccessKey: 'minio-access',
-  minioEndpoint: 'http://localhost:9000'
+  client: createS3Client({
+    provider: 'minio',
+    region: 'us-east-1',
+    accessKeyId: process.env.STORAGE_ACCESS_KEY_ID,
+    secretAccessKey: process.env.STORAGE_SECRET_ACCESS_KEY,
+    endpoint: 'http://localhost:9000'
+  })
 });
 ```
 
@@ -135,12 +142,9 @@ const streamer = new Streamer({
 #### Constructor Options
 
 ```typescript
-interface StreamerOptions {
-  awsRegion: string;        // AWS region (e.g., 'us-east-1')
-  awsSecretKey: string;     // AWS secret access key
-  awsAccessKey: string;     // AWS access key ID
-  minioEndpoint?: string;   // Optional: MinIO/S3-compatible endpoint
-  defaultBucket: string;    // Default bucket for uploads
+{
+  client: S3Client;         // S3 client for the resolved object store (see createS3Client in @constructive-io/s3-utils)
+  defaultBucket?: string;   // Bucket used when a call names none
 }
 ```
 
@@ -172,14 +176,16 @@ streamer.destroy();
 If you prefer functional programming over classes:
 
 ```js
-import { getClient, upload } from '@constructive-io/s3-streamer';
+import { createS3Client } from '@constructive-io/s3-utils';
+import { upload } from '@constructive-io/s3-streamer';
 
 // Create S3 client
-const client = getClient({
-  awsRegion: 'us-east-1',
-  awsSecretKey: process.env.AWS_SECRET_ACCESS_KEY,
-  awsAccessKey: process.env.AWS_ACCESS_KEY_ID,
-  minioEndpoint: 'http://localhost:9000' // optional
+const client = createS3Client({
+  provider: 'minio',
+  region: 'us-east-1',
+  accessKeyId: process.env.STORAGE_ACCESS_KEY_ID,
+  secretAccessKey: process.env.STORAGE_SECRET_ACCESS_KEY,
+  endpoint: 'http://localhost:9000' // omit for AWS S3
 });
 
 // Upload file

package/esm/index.js

@@ -1,6 +1,4 @@
-import getClient from './s3';
 import Streamer from './streamer';
 export * from './utils';
-export { getClient };
 export { Streamer };
 export default Streamer;

package/esm/streamer.js

@@ -1,17 +1,10 @@
 import { streamContentType } from '@constructive-io/content-type-stream';
-import getS3 from './s3';
 import { upload as streamUpload, uploadWithContentType as streamUploadWithContentType, } from './utils';
 export class Streamer {
     s3;
     defaultBucket;
-    constructor({ awsRegion, awsSecretKey, awsAccessKey, endpoint, provider, defaultBucket }) {
-        this.s3 = getS3({
-            awsRegion,
-            awsSecretKey,
-            awsAccessKey,
-            endpoint,
-            provider
-        });
+    constructor({ client, defaultBucket }) {
+        this.s3 = client;
         this.defaultBucket = defaultBucket;
     }
     async upload({ readStream, filename, key, bucket = this.defaultBucket }) {

package/index.d.ts

@@ -1,6 +1,4 @@
-import getClient from './s3';
 import Streamer from './streamer';
 export * from './utils';
-export { getClient };
 export { Streamer };
 export default Streamer;

package/index.js

@@ -17,9 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Streamer = exports.getClient = void 0;
-const s3_1 = __importDefault(require("./s3"));
-exports.getClient = s3_1.default;
+exports.Streamer = void 0;
 const streamer_1 = __importDefault(require("./streamer"));
 exports.Streamer = streamer_1.default;
 __exportStar(require("./utils"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/s3-streamer",
-  "version": "2.44.6",
+  "version": "2.45.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "stream files to s3",
   "main": "index.js",
@@ -29,7 +29,7 @@
     "test:watch": "jest --watch"
   },
   "devDependencies": {
-    "@pgpmjs/env": "^2.46.3",
+    "@pgpmjs/env": "^2.47.0",
     "glob": "^13.0.6",
     "makage": "^0.8.0"
   },
@@ -37,8 +37,7 @@
     "@aws-sdk/client-s3": "^3.1052.0",
     "@aws-sdk/lib-storage": "^3.1052.0",
     "@constructive-io/content-type-stream": "^2.32.0",
-    "@constructive-io/s3-utils": "^2.34.0",
-    "@pgpmjs/types": "^2.56.3"
+    "@constructive-io/s3-utils": "^2.34.0"
   },
   "keywords": [
     "s3",
@@ -48,5 +47,5 @@
     "minio",
     "constructive"
   ],
-  "gitHead": "a95137c03998f4ef18aaba770bdeb598077e5b51"
+  "gitHead": "1f3501d518e175803a1a3372cf9249922d82bfe5"
 }

package/streamer.d.ts

@@ -1,13 +1,10 @@
+import { S3Client } from '@aws-sdk/client-s3';
 import { streamContentType } from '@constructive-io/content-type-stream';
-import type { BucketProvider } from '@pgpmjs/types';
 import type { Readable } from 'stream';
 import { type AsyncUploadResult } from './utils';
 interface StreamerOptions {
-    awsRegion: string;
-    awsSecretKey: string;
-    awsAccessKey: string;
-    endpoint?: string;
-    provider?: BucketProvider;
+    /** Client for the object store the caller resolved (see `createS3Client` in `@constructive-io/s3-utils`). */
+    client: S3Client;
     /**
      * Bucket used when a call does not name one. Optional: a caller that resolves
      * the bucket per upload (tenant-resolved storage) has no deployment-wide
@@ -35,7 +32,7 @@ interface UploadWithContentTypeParams {
 export declare class Streamer {
     private s3;
     private defaultBucket?;
-    constructor({ awsRegion, awsSecretKey, awsAccessKey, endpoint, provider, defaultBucket }: StreamerOptions);
+    constructor({ client, defaultBucket }: StreamerOptions);
     upload({ readStream, filename, key, bucket }: UploadParams): Promise<AsyncUploadResult>;
     uploadWithContentType({ readStream, contentType, key, bucket, magic, }: UploadWithContentTypeParams): Promise<AsyncUploadResult>;
     detectContentType({ readStream, filename, peekBytes, }: {

package/streamer.js

@@ -1,23 +1,13 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Streamer = void 0;
 const content_type_stream_1 = require("@constructive-io/content-type-stream");
-const s3_1 = __importDefault(require("./s3"));
 const utils_1 = require("./utils");
 class Streamer {
     s3;
     defaultBucket;
-    constructor({ awsRegion, awsSecretKey, awsAccessKey, endpoint, provider, defaultBucket }) {
-        this.s3 = (0, s3_1.default)({
-            awsRegion,
-            awsSecretKey,
-            awsAccessKey,
-            endpoint,
-            provider
-        });
+    constructor({ client, defaultBucket }) {
+        this.s3 = client;
         this.defaultBucket = defaultBucket;
     }
     async upload({ readStream, filename, key, bucket = this.defaultBucket }) {

package/esm/s3.js

@@ -1,10 +0,0 @@
-import { createS3Client } from '@constructive-io/s3-utils';
-export default function getS3(opts) {
-    return createS3Client({
-        provider: opts.provider || 'minio',
-        region: opts.awsRegion,
-        accessKeyId: opts.awsAccessKey,
-        secretAccessKey: opts.awsSecretKey,
-        ...(opts.endpoint ? { endpoint: opts.endpoint } : {}),
-    });
-}

package/s3.d.ts

@@ -1,11 +0,0 @@
-import type { S3Client } from '@aws-sdk/client-s3';
-import type { BucketProvider } from '@pgpmjs/types';
-interface S3Options {
-    awsAccessKey: string;
-    awsSecretKey: string;
-    awsRegion: string;
-    endpoint?: string;
-    provider?: BucketProvider;
-}
-export default function getS3(opts: S3Options): S3Client;
-export {};

package/s3.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = getS3;
-const s3_utils_1 = require("@constructive-io/s3-utils");
-function getS3(opts) {
-    return (0, s3_utils_1.createS3Client)({
-        provider: opts.provider || 'minio',
-        region: opts.awsRegion,
-        accessKeyId: opts.awsAccessKey,
-        secretAccessKey: opts.awsSecretKey,
-        ...(opts.endpoint ? { endpoint: opts.endpoint } : {}),
-    });
-}