@directus/storage-driver-s3 9.22.0 → 9.22.3

package/dist/index.js

@@ -10,12 +10,16 @@ export class DriverS3 {
     acl;
     serverSideEncryption;
     constructor(config) {
-        const s3ClientConfig = {
-            credentials: {
+        const s3ClientConfig = {};
+        if ((config.key && !config.secret) || (config.secret && !config.key)) {
+            throw new Error('Both `key` and `secret` are required when defined');
+        }
+        if (config.key && config.secret) {
+            s3ClientConfig.credentials = {
                 accessKeyId: config.key,
                 secretAccessKey: config.secret,
-            },
-        };
+            };
+        }
         if (config.endpoint) {
             const protocol = config.endpoint.startsWith('https://') ? 'https:' : 'http:';
             const hostname = config.endpoint.replace('https://', '').replace('http://', '');
@@ -24,7 +28,12 @@ export class DriverS3 {
                 protocol,
                 path: '/',
             };
-            s3ClientConfig.forcePathStyle = true;
+        }
+        if (config.region) {
+            s3ClientConfig.region = config.region;
+        }
+        if (config.forcePathStyle !== undefined) {
+            s3ClientConfig.forcePathStyle = config.forcePathStyle;
         }
         this.client = new S3Client(s3ClientConfig);
         this.bucket = config.bucket;

package/dist/index.test.js

@@ -2,7 +2,7 @@ import { CopyObjectCommand, DeleteObjectCommand, GetObjectCommand, HeadObjectCom
 import { Upload } from '@aws-sdk/lib-storage';
 import { normalizePath } from '@directus/utils';
 import { isReadableStream } from '@directus/utils/node';
-import { randAlphaNumeric, randDirectoryPath, randDomainName, randFilePath, randFileType, randGitBranch as randBucket, randGitShortSha as randUnique, randNumber, randPastDate, randText, randWord, } from '@ngneat/falso';
+import { randAlphaNumeric, randBoolean, randDirectoryPath, randDomainName, randFilePath, randFileType, randGitBranch as randBucket, randGitShortSha as randUnique, randNumber, randPastDate, randText, randWord, } from '@ngneat/falso';
 import { join } from 'node:path';
 import { PassThrough, Readable } from 'node:stream';
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
@@ -24,6 +24,8 @@ beforeEach(() => {
             serverSideEncryption: randWord(),
             root: randDirectoryPath(),
             endpoint: randDomainName(),
+            region: randWord(),
+            forcePathStyle: randBoolean(),
         },
         path: {
             input: randUnique() + randFilePath(),
@@ -64,6 +66,29 @@ afterEach(() => {
     vi.resetAllMocks();
 });
 describe('#constructor', () => {
+    test('Throws error if key defined but secret missing', () => {
+        try {
+            new DriverS3({ key: 'key', bucket: 'bucket' });
+        }
+        catch (err) {
+            expect(err).toBeInstanceOf(Error);
+            expect(err.message).toBe('Both `key` and `secret` are required when defined');
+        }
+    });
+    test('Throws error if secret defined but key missing', () => {
+        try {
+            new DriverS3({ secret: 'secret', bucket: 'bucket' });
+        }
+        catch (err) {
+            expect(err).toBeInstanceOf(Error);
+            expect(err.message).toBe('Both `key` and `secret` are required when defined');
+        }
+    });
+    test('Creates S3Client without key / secret (based on machine config)', () => {
+        const driver = new DriverS3({ bucket: 'bucket' });
+        expect(S3Client).toHaveBeenCalledWith({});
+        expect(driver['client']).toBeInstanceOf(S3Client);
+    });
     test('Creates S3Client with key / secret configuration', () => {
         expect(S3Client).toHaveBeenCalledWith({
             credentials: {
@@ -107,7 +132,6 @@ describe('#constructor', () => {
             endpoint: sampleHttpEndpoint,
         });
         expect(S3Client).toHaveBeenCalledWith({
-            forcePathStyle: true,
             endpoint: {
                 hostname: sampleDomain,
                 protocol: 'http:',
@@ -129,7 +153,6 @@ describe('#constructor', () => {
             endpoint: sampleHttpEndpoint,
         });
         expect(S3Client).toHaveBeenCalledWith({
-            forcePathStyle: true,
             endpoint: {
                 hostname: sampleDomain,
                 protocol: 'https:',
@@ -141,6 +164,36 @@ describe('#constructor', () => {
             },
         });
     });
+    test('Sets region', () => {
+        new DriverS3({
+            key: sample.config.key,
+            secret: sample.config.secret,
+            bucket: sample.config.bucket,
+            region: sample.config.region,
+        });
+        expect(S3Client).toHaveBeenCalledWith({
+            region: sample.config.region,
+            credentials: {
+                accessKeyId: sample.config.key,
+                secretAccessKey: sample.config.secret,
+            },
+        });
+    });
+    test('Sets force path style', () => {
+        new DriverS3({
+            key: sample.config.key,
+            secret: sample.config.secret,
+            bucket: sample.config.bucket,
+            forcePathStyle: sample.config.forcePathStyle,
+        });
+        expect(S3Client).toHaveBeenCalledWith({
+            forcePathStyle: sample.config.forcePathStyle,
+            credentials: {
+                accessKeyId: sample.config.key,
+                secretAccessKey: sample.config.secret,
+            },
+        });
+    });
     test('Normalizes config path when root is given', () => {
         const mockRoot = randDirectoryPath();
         vi.mocked(normalizePath).mockReturnValue(mockRoot);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/storage-driver-s3",
-  "version": "9.22.0",
+  "version": "9.22.3",
   "type": "module",
   "description": "S3 file storage abstraction for `@directus/storage`",
   "repository": {
@@ -25,17 +25,17 @@
   },
   "dependencies": {
     "@aws-sdk/abort-controller": "3.226.0",
-    "@aws-sdk/client-s3": "3.224.0",
-    "@aws-sdk/lib-storage": "3.234.0",
-    "@directus/storage": "9.22.0",
-    "@directus/utils": "9.22.0"
+    "@aws-sdk/client-s3": "3.236.0",
+    "@aws-sdk/lib-storage": "3.236.0",
+    "@directus/storage": "9.22.3",
+    "@directus/utils": "9.22.3"
   },
   "devDependencies": {
     "@directus/tsconfig": "0.0.6",
-    "@ngneat/falso": "6.3.0",
-    "@vitest/coverage-c8": "0.25.3",
-    "typescript": "4.9.3",
-    "vitest": "0.25.3"
+    "@ngneat/falso": "6.3.2",
+    "@vitest/coverage-c8": "0.26.2",
+    "typescript": "4.9.4",
+    "vitest": "0.26.2"
   },
   "scripts": {
     "build": "tsc --build",