@dotcom-tool-kit/upload-assets-to-s3 4.2.7 → 4.3.0

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

@@ -1,6 +1,38 @@
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base';
 import { S3Client } from '@aws-sdk/client-s3';
-import { UploadAssetsToS3Schema } from '@dotcom-tool-kit/schemas/lib/tasks/upload-assets-to-s3';
+import * as z from 'zod';
+export declare const UploadAssetsToS3Schema: z.ZodObject<{
+    accessKeyIdEnvVar: z.ZodDefault<z.ZodString>;
+    secretAccessKeyEnvVar: z.ZodDefault<z.ZodString>;
+    directory: z.ZodDefault<z.ZodString>;
+    reviewBucket: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    prodBucket: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    region: z.ZodDefault<z.ZodString>;
+    destination: z.ZodDefault<z.ZodString>;
+    extensions: z.ZodDefault<z.ZodString>;
+    cacheControl: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    accessKeyIdEnvVar: string;
+    secretAccessKeyEnvVar: string;
+    directory: string;
+    reviewBucket: string[];
+    prodBucket: string[];
+    region: string;
+    destination: string;
+    extensions: string;
+    cacheControl: string;
+}, {
+    accessKeyIdEnvVar?: string | undefined;
+    secretAccessKeyEnvVar?: string | undefined;
+    directory?: string | undefined;
+    reviewBucket?: string[] | undefined;
+    prodBucket?: string[] | undefined;
+    region?: string | undefined;
+    destination?: string | undefined;
+    extensions?: string | undefined;
+    cacheControl?: string | undefined;
+}>;
+export { UploadAssetsToS3Schema as schema };
 export default class UploadAssetsToS3 extends Task<{
     task: typeof UploadAssetsToS3Schema;
 }> {

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,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAE5D,OAAO,EAAE,QAAQ,EAAoB,MAAM,oBAAoB,CAAA;AAM/D,OAAO,EACL,sBAAsB,EACvB,MAAM,wDAAwD,CAAA;AAE/D,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,sBAAsB,CAAA;CAAE,CAAC;IACnF,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAiDrD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAuClD"}
+{"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,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAE5D,OAAO,EAAE,QAAQ,EAAoB,MAAM,oBAAoB,CAAA;AAM/D,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmDa,CAAA;AAChD,OAAO,EAAE,sBAAsB,IAAI,MAAM,EAAE,CAAA;AAE3C,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC;IAAE,IAAI,EAAE,OAAO,sBAAsB,CAAA;CAAE,CAAC;IACnF,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAkDrD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAyClD"}

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = exports.UploadAssetsToS3Schema = void 0;
 const tslib_1 = require("tslib");
 const base_1 = require("@dotcom-tool-kit/base");
 const fs = tslib_1.__importStar(require("fs"));
@@ -9,6 +10,50 @@ 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");
+const z = tslib_1.__importStar(require("zod"));
+exports.UploadAssetsToS3Schema = z
+    .object({
+    accessKeyIdEnvVar: z
+        .string()
+        .default('AWS_ACCESS_HASHED_ASSETS')
+        .describe("variable name of the project's aws access key id. If uploading to multiple buckets the same credentials will need to work for all"),
+    secretAccessKeyEnvVar: z
+        .string()
+        .default('AWS_SECRET_HASHED_ASSETS')
+        .describe("variable name of the project's aws secret access key"),
+    directory: z
+        .string()
+        .default('public')
+        .describe('the folder in the project whose contents will be uploaded to S3'),
+    reviewBucket: z
+        .string()
+        .array()
+        .default(['ft-next-hashed-assets-preview'])
+        .describe('the development or test S3 bucket'),
+    prodBucket: z
+        .string()
+        .array()
+        .default(['ft-next-hashed-assets-prod'])
+        .describe("production S3 bucket(s). 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."),
+    region: z
+        .string()
+        .default('eu-west-1')
+        .describe('the AWS region your buckets are stored in (let the Platforms team know if you need to upload to multiple buckets in multiple regions).'),
+    destination: z
+        .string()
+        .default('hashed-assets/page-kit')
+        .describe("the destination folder for uploaded assets. Set to `''` to upload assets to the top level of the bucket"),
+    extensions: z
+        .string()
+        .default('js,css,map,gz,br,png,jpg,jpeg,gif,webp,svg,ico,json')
+        .describe('file extensions to be uploaded to S3'),
+    cacheControl: z
+        .string()
+        .default('public, max-age=31536000, stale-while-revalidate=60, stale-if-error=3600')
+        .describe('header that controls how long your files stay in a CloudFront cache before CloudFront forwards another request to your origin')
+})
+    .describe('Upload files to an AWS S3 bucket.');
+exports.schema = exports.UploadAssetsToS3Schema;
 class UploadAssetsToS3 extends base_1.Task {
     async uploadFile(file, s3) {
         const type = getFileType(file);
@@ -60,7 +105,9 @@ class UploadAssetsToS3 extends base_1.Task {
     }
     async run({ cwd }) {
         // Wrap extensions in braces if there are multiple
-        const extensions = this.options.extensions.includes(',') ? `{${this.options.extensions}}` : this.options.extensions;
+        const extensions = this.options.extensions.includes(',')
+            ? `{${this.options.extensions}}`
+            : this.options.extensions;
         const globFile = `**/*${extensions}`;
         const resolvedDirectory = path_1.default.resolve(cwd, this.options.directory);
         const files = glob_1.glob.sync(globFile, { cwd: resolvedDirectory, nodir: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/upload-assets-to-s3",
-  "version": "4.2.7",
+  "version": "4.3.0",
   "description": "",
   "main": "lib",
   "scripts": {
@@ -11,12 +11,13 @@
   "license": "ISC",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.256.0",
-    "@dotcom-tool-kit/base": "^1.1.9",
+    "@dotcom-tool-kit/base": "^1.1.10",
     "@dotcom-tool-kit/error": "^4.1.0",
     "@dotcom-tool-kit/logger": "^4.1.1",
     "glob": "^7.1.6",
     "mime": "^2.5.2",
-    "tslib": "^2.3.1"
+    "tslib": "^2.3.1",
+    "zod": "^3.24.1"
   },
   "repository": {
     "type": "git",
@@ -27,7 +28,6 @@
   "homepage": "https://github.com/financial-times/dotcom-tool-kit/tree/main/plugins/upload-assets-to-s3",
   "devDependencies": {
     "@aws-sdk/types": "^3.13.1",
-    "@dotcom-tool-kit/schemas": "^1.9.0",
     "@jest/globals": "^27.4.6",
     "@types/glob": "^7.1.3",
     "@types/jest": "^27.4.0",