@dotcom-tool-kit/upload-assets-to-s3 2.0.13 → 2.1.0

package/.toolkitrc.yml

@@ -1,10 +1,2 @@
 hooks:
   'release:remote': UploadAssetsToS3
-
-options:
-  '@dotcom-tool-kit/upload-static-assets':
-    directory: 'public'
-    bucket: 'ft-next-hashed-assets-prod'
-    destination: 'hashed-assets/uploaded'
-    extensions: 'js,css,map,gz,br,png,jpg,jpeg,gif,webp,svg,ico,json'
-    cacheControl: 'public, max-age=31536000, stale-while-revalidate=60, stale-if-error=3600'

package/README.md

@@ -21,13 +21,14 @@ plugins:
 ## Options
 | Key | Description | Default value |
 |-|-|-|
-| `accessKeyIdEnvVar` | variable name of the project's aws access key id | no default value - for backwards compatability the plugin falls back to the default value for `accessKeyId` |
+| `accessKeyIdEnvVar` | variable name of the project's aws access key id. If uploading to multiple buckets the same credentials will need to work for all. | no default value - for backwards compatability the plugin falls back to the default value for `accessKeyId` |
 | `secretAccessKeyEnvVar` | variable name of the project's aws secret access key | no default value - for backwards compatability the plugin falls back to the default value for `secretAccessKey` |
 | `accessKeyId` | **DEPRECATED** variable name of the project's aws access key id | 'aws_access_hashed_assets' |
 | `secretAccessKey` | **DEPRECATED** variable name of the project's aws secret access key | 'aws_secret_hashed_assets' |
 | `directory` | the folder in the project whose contents will be uploaded to S3 | 'public' |
-| `reviewBucket` | the development or test S3 bucket | ['ft-next-hashed-assets-preview'] |
-| `prodBucket` | production S3 bucket/s; an array of strings. The same files will be uploaded to each | ['ft-next-hashed-assets-prod', 'ft-next-hashed-assets-prod-us'] |
+| `reviewBucket` | the development or test S3 bucket | `['ft-next-hashed-assets-preview']` |
+| `prodBucket` | production S3 bucket/s; an array of strings. The same files will be uploaded to each. _Note: most Customer Products buckets that have a `prod` and `prod-us` version are already configured in AWS to replicate file changes from one to the other so you don't need to specify both here. Also, if multiple buckets are specified the same credentials will need to be valid for both for the upload to be successful_ | `['ft-next-hashed-assets-prod']` |
+| `region` | the AWS region your buckets are stored in (let the Platforms team know if you need to upload to multiple buckets in multiple regions) | eu-west-1 |
 | `destination` | the destination folder for uploaded assets. Set to `''` to upload assets to the top level of the bucket | 'hashed-assets/page-kit' |
 | `extensions` | file extensions to be uploaded to S3 | 'js,css,map,gz,br,png,jpg,jpeg,gif,webp,svg,ico,json' |
 | `cacheControl` | header that controls how long your files stay in a CloudFront cache before CloudFront forwards another request to your origin | 'public, max-age=31536000, stale-while-revalidate=60, stale-if-error=3600' |
@@ -38,7 +39,7 @@ Example:
   '@dotcom-tool-kit/upload-assets-to-s3':
     accessKeyId: AWS_ACCESS
     secretAccessKey: AWS_KEY
-    prodBucket: ['ft-next-service-registry-prod', 'ft-next-service-registry-prod-us']
+    prodBucket: ['ft-next-service-registry-prod']
     reviewBucket: ['ft-next-service-registry-dev']
     destination: ''
 ```

package/lib/index.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tasks = void 0;
 const tslib_1 = require("tslib");
-const upload_assets_to_s3_1 = (0, tslib_1.__importDefault)(require("./tasks/upload-assets-to-s3"));
+const upload_assets_to_s3_1 = tslib_1.__importDefault(require("./tasks/upload-assets-to-s3"));
 exports.tasks = [upload_assets_to_s3_1.default];

package/lib/tasks/upload-assets-to-s3.d.ts

@@ -1,11 +1,10 @@
 import { Task } from '@dotcom-tool-kit/types';
-import aws from 'aws-sdk';
+import { S3Client } from '@aws-sdk/client-s3';
 import { UploadAssetsToS3Options, UploadAssetsToS3Schema } from '@dotcom-tool-kit/types/lib/schema/upload-assets-to-s3';
 export default class UploadAssetsToS3 extends Task<typeof UploadAssetsToS3Schema> {
     static description: string;
-    static defaultOptions: UploadAssetsToS3Options;
     run(): Promise<void>;
-    uploadFile(file: string, options: UploadAssetsToS3Options, s3: aws.S3): Promise<void>;
+    uploadFile(file: string, options: UploadAssetsToS3Options, s3: S3Client): Promise<void>;
     uploadAssetsToS3(options: UploadAssetsToS3Options): Promise<void>;
 }
 //# sourceMappingURL=upload-assets-to-s3.d.ts.map

package/lib/tasks/upload-assets-to-s3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upload-assets-to-s3.d.ts","sourceRoot":"","sources":["../../src/tasks/upload-assets-to-s3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAE7C,OAAO,GAAG,MAAM,SAAS,CAAA;AAMzB,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uDAAuD,CAAA;AAE9D,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC,OAAO,sBAAsB,CAAC;IAC/E,MAAM,CAAC,WAAW,SAAK;IAEvB,MAAM,CAAC,cAAc,EAAE,uBAAuB,CAS7C;IAEK,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAGpB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDrF,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBxE"}
+{"version":3,"file":"upload-assets-to-s3.d.ts","sourceRoot":"","sources":["../../src/tasks/upload-assets-to-s3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAE7C,OAAO,EAAE,QAAQ,EAAoB,MAAM,oBAAoB,CAAA;AAM/D,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,uDAAuD,CAAA;AAE9D,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC,OAAO,sBAAsB,CAAC;IAC/E,MAAM,CAAC,WAAW,SAAK;IAEjB,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAGpB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,EAAE,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDvF,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAyBxE"}

package/lib/tasks/upload-assets-to-s3.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const types_1 = require("@dotcom-tool-kit/types");
-const fs = (0, tslib_1.__importStar)(require("fs"));
-const aws_sdk_1 = (0, tslib_1.__importDefault)(require("aws-sdk"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
-const mime_1 = (0, tslib_1.__importDefault)(require("mime"));
+const fs = tslib_1.__importStar(require("fs"));
+const client_s3_1 = require("@aws-sdk/client-s3");
+const path_1 = tslib_1.__importDefault(require("path"));
+const mime_1 = tslib_1.__importDefault(require("mime"));
 const glob_1 = require("glob");
 const error_1 = require("@dotcom-tool-kit/error");
 const logger_1 = require("@dotcom-tool-kit/logger");
@@ -33,8 +33,8 @@ class UploadAssetsToS3 extends types_1.Task {
                     CacheControl: options.cacheControl
                 };
                 currentBucket = params.Bucket;
-                const data = await s3.upload(params).promise();
-                this.logger.info(`Uploaded ${logger_1.styles.filepath(filepath)} to ${logger_1.styles.URL(data.Location)}`);
+                await s3.send(new client_s3_1.PutObjectCommand(params));
+                this.logger.info(`Uploaded ${logger_1.styles.filepath(filepath)} to ${logger_1.styles.URL(currentBucket)}`);
             }
             else {
                 for (const bucket of bucketByEnv) {
@@ -48,8 +48,8 @@ class UploadAssetsToS3 extends types_1.Task {
                         CacheControl: options.cacheControl
                     };
                     currentBucket = params.Bucket;
-                    const data = await s3.upload(params).promise();
-                    this.logger.info(`Uploaded ${logger_1.styles.filepath(filepath)} to ${logger_1.styles.URL(data.Location)}`);
+                    await s3.send(new client_s3_1.PutObjectCommand(params));
+                    this.logger.info(`Uploaded ${logger_1.styles.filepath(filepath)} to ${logger_1.styles.URL(currentBucket)}`);
                 }
             }
         }
@@ -67,30 +67,26 @@ class UploadAssetsToS3 extends types_1.Task {
         const extensions = options.extensions.includes(',') ? `{${options.extensions}}` : options.extensions;
         const globFile = `**/*${extensions}`;
         const files = glob_1.glob.sync(globFile, { cwd: options.directory, nodir: true });
-        const s3 = new aws_sdk_1.default.S3({
+        if (files.length === 0) {
+            throw new error_1.ToolKitError(`no files found at the provided directory: ${options.directory}`);
+        }
+        const s3 = new client_s3_1.S3Client({
+            region: options.region,
             // fallback to default value for accessKeyId if neither accessKeyIdEnvVar or accessKeyId have been provided as options
-            accessKeyId: 
-            /* eslint-disable-next-line */
-            process.env[(_a = options.accessKeyIdEnvVar) !== null && _a !== void 0 ? _a : options.accessKeyId],
-            secretAccessKey: 
-            /* eslint-disable-next-line */
-            process.env[(_b = options.secretAccessKeyEnvVar) !== null && _b !== void 0 ? _b : options.secretAccessKey]
+            credentials: {
+                accessKeyId: 
+                /* eslint-disable-next-line */
+                process.env[(_a = options.accessKeyIdEnvVar) !== null && _a !== void 0 ? _a : options.accessKeyId],
+                secretAccessKey: 
+                /* eslint-disable-next-line */
+                process.env[(_b = options.secretAccessKeyEnvVar) !== null && _b !== void 0 ? _b : options.secretAccessKey]
+            }
         });
         await Promise.all(files.map((file) => this.uploadFile(file, options, s3)));
     }
 }
 exports.default = UploadAssetsToS3;
 UploadAssetsToS3.description = '';
-UploadAssetsToS3.defaultOptions = {
-    accessKeyId: 'aws_access_hashed_assets',
-    secretAccessKey: 'aws_secret_hashed_assets',
-    directory: 'public',
-    reviewBucket: ['ft-next-hashed-assets-preview'],
-    prodBucket: ['ft-next-hashed-assets-prod', 'ft-next-hashed-assets-prod-us'],
-    destination: 'hashed-assets/page-kit',
-    extensions: 'js,css,map,gz,br,png,jpg,jpeg,gif,webp,svg,ico,json',
-    cacheControl: 'public, max-age=31536000, stale-while-revalidate=60, stale-if-error=3600'
-};
 const getFileType = (filename) => {
     // We need to know the original file type so ignore any compression
     const originalFile = filename.replace(/\.(br|gz)$/, '');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/upload-assets-to-s3",
-  "version": "2.0.13",
+  "version": "2.1.0",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -10,10 +10,10 @@
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "ISC",
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.256.0",
     "@dotcom-tool-kit/error": "^2.0.1",
-    "@dotcom-tool-kit/logger": "^2.2.0",
-    "@dotcom-tool-kit/types": "^2.8.0",
-    "aws-sdk": "^2.901.0",
+    "@dotcom-tool-kit/logger": "^2.2.1",
+    "@dotcom-tool-kit/types": "^2.9.0",
     "glob": "^7.1.6",
     "mime": "^2.5.2",
     "tslib": "^2.3.1"
@@ -41,6 +41,6 @@
     "extends": "../../package.json"
   },
   "peerDependencies": {
-    "dotcom-tool-kit": "2.x"
+    "dotcom-tool-kit": "^2.6.0"
   }
 }