@dotcom-tool-kit/serverless 3.2.9 → 3.3.0

package/.toolkitrc.yml

@@ -4,4 +4,6 @@ tasks:
   ServerlessProvision: './lib/tasks/provision'
   ServerlessTeardown: './lib/tasks/teardown'
 
+optionsSchema: './lib/schema'
+
 version: 2

package/lib/schema.d.ts

@@ -0,0 +1,39 @@
+import * as z from 'zod';
+declare const _default: z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>, z.objectOutputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>, z.objectOutputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    awsAccountId: z.ZodString;
+    systemCode: z.ZodString;
+    regions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    configPath: z.ZodOptional<z.ZodString>;
+}, z.ZodTypeAny, "passthrough">>;
+export default _default;
+//# sourceMappingURL=schema.d.ts.map

package/lib/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBxB,wBAqB0D"}

package/lib/schema.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const z = tslib_1.__importStar(require("zod"));
+const logger_1 = require("@dotcom-tool-kit/logger");
+const movedPluginOptions = (option, task, newName = option) => [
+    (options) => !(option in options),
+    {
+        message: `the option ${logger_1.styles.code(option)} has moved to ${logger_1.styles.code(`options.tasks.${logger_1.styles.task(task)}.${newName}`)}`
+    }
+];
+exports.default = z
+    .object({
+    awsAccountId: z
+        .string()
+        .describe('the ID of the AWS account you wish to deploy to (account IDs can be found at the [FT login page](https://awslogin.in.ft.com/))'),
+    systemCode: z.string().describe('the system code for your app'),
+    regions: z
+        .array(z.string())
+        .default(['eu-west-1'])
+        .describe('an array of AWS regions you want to deploy to'),
+    configPath: z
+        .string()
+        .optional()
+        .describe('path to your serverless config file. If this is not provided, Serverless defaults to `./serverless.yml` but [other config fomats are accepted](https://www.serverless.com/framework/docs/providers/aws/guide/intro#alternative-configuration-format)')
+})
+    .passthrough()
+    .refine(...movedPluginOptions('useVault', 'ServerlessRun', 'useDoppler'))
+    .refine(...movedPluginOptions('ports', 'ServerlessRun'));

package/lib/tasks/deploy.d.ts

@@ -1,8 +1,9 @@
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base';
-import { ServerlessSchema } from '@dotcom-tool-kit/schemas/lib/plugins/serverless';
+import type ServerlessSchema from '../schema';
 export default class ServerlessDeploy extends Task<{
     plugin: typeof ServerlessSchema;
 }> {
+    static description: string;
     run({ cwd }: TaskRunContext): Promise<void>;
 }
 //# sourceMappingURL=deploy.d.ts.map

package/lib/tasks/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/tasks/deploy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAA;AAGlF,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IAC/E,GAAG,CAAC,EAAC,GAAG,EAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CA2BhD"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/tasks/deploy.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAE5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAE7C,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACrF,MAAM,CAAC,WAAW,SAAiC;IAE7C,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CA2BlD"}

package/lib/tasks/deploy.js

@@ -4,6 +4,7 @@ const logger_1 = require("@dotcom-tool-kit/logger");
 const base_1 = require("@dotcom-tool-kit/base");
 const child_process_1 = require("child_process");
 class ServerlessDeploy extends base_1.Task {
+    static description = 'Deploy a serverless function';
     async run({ cwd }) {
         const { configPath, regions, systemCode } = this.pluginOptions;
         for (const region of regions) {

package/lib/tasks/provision.d.ts

@@ -1,8 +1,9 @@
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base';
-import { ServerlessSchema } from '@dotcom-tool-kit/schemas/lib/plugins/serverless';
+import type ServerlessSchema from '../schema';
 export default class ServerlessProvision extends Task<{
     plugin: typeof ServerlessSchema;
 }> {
+    static description: string;
     run({ cwd }: TaskRunContext): Promise<void>;
 }
 //# sourceMappingURL=provision.d.ts.map

package/lib/tasks/provision.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provision.d.ts","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAA;AAIlF,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IAClF,GAAG,CAAC,EAAC,GAAG,EAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmDhD"}
+{"version":3,"file":"provision.d.ts","sourceRoot":"","sources":["../../src/tasks/provision.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAE7C,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACxF,MAAM,CAAC,WAAW,SAA2C;IAEvD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmDlD"}

package/lib/tasks/provision.js

@@ -6,6 +6,7 @@ const base_1 = require("@dotcom-tool-kit/base");
 const child_process_1 = require("child_process");
 const state_1 = require("@dotcom-tool-kit/state");
 class ServerlessProvision extends base_1.Task {
+    static description = 'Provision a review serverless function';
     async run({ cwd }) {
         const { configPath, systemCode, regions } = this.pluginOptions;
         const ciState = (0, state_1.readState)('ci');

package/lib/tasks/run.d.ts

@@ -1,6 +1,17 @@
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base';
-import { ServerlessSchema } from '@dotcom-tool-kit/schemas/lib/plugins/serverless';
-import { ServerlessRunSchema } from '@dotcom-tool-kit/schemas/src/tasks/serverless-run';
+import type ServerlessSchema from '../schema';
+import * as z from 'zod';
+declare const ServerlessRunSchema: z.ZodObject<{
+    ports: z.ZodDefault<z.ZodArray<z.ZodNumber, "many">>;
+    useDoppler: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    useDoppler: boolean;
+    ports: number[];
+}, {
+    useDoppler?: boolean | undefined;
+    ports?: number[] | undefined;
+}>;
+export { ServerlessRunSchema as schema };
 export default class ServerlessRun extends Task<{
     task: typeof ServerlessRunSchema;
     plugin: typeof ServerlessSchema;

package/lib/tasks/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/tasks/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAA;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,mDAAmD,CAAA;AAOvF,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,IAAI,CAAC;IAC9C,IAAI,EAAE,OAAO,mBAAmB,CAAA;IAChC,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAChC,CAAC;IACM,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CA6C1D"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/tasks/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAM7C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,QAAA,MAAM,mBAAmB;;;;;;;;;EAYsB,CAAA;AAC/C,OAAO,EAAE,mBAAmB,IAAI,MAAM,EAAE,CAAA;AAExC,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,IAAI,CAAC;IAC9C,IAAI,EAAE,OAAO,mBAAmB,CAAA;IAChC,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAChC,CAAC;IACM,GAAG,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAiD1D"}

package/lib/tasks/run.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
 const tslib_1 = require("tslib");
 const base_1 = require("@dotcom-tool-kit/base");
 const child_process_1 = require("child_process");
@@ -7,6 +8,21 @@ const doppler_1 = require("@dotcom-tool-kit/doppler");
 const logger_1 = require("@dotcom-tool-kit/logger");
 const get_port_1 = tslib_1.__importDefault(require("get-port"));
 const wait_port_1 = tslib_1.__importDefault(require("wait-port"));
+const z = tslib_1.__importStar(require("zod"));
+const ServerlessRunSchema = z
+    .object({
+    ports: z
+        .number()
+        .array()
+        .default([3001, 3002, 3003])
+        .describe('ports to try to bind to for this application'),
+    useDoppler: z
+        .boolean()
+        .default(true)
+        .describe('run the application with environment variables from Doppler')
+})
+    .describe('Run serverless functions locally');
+exports.schema = ServerlessRunSchema;
 class ServerlessRun extends base_1.Task {
     async run({ cwd, config }) {
         const { useDoppler, ports } = this.options;

package/lib/tasks/teardown.d.ts

@@ -1,8 +1,9 @@
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base';
-import { ServerlessSchema } from '@dotcom-tool-kit/schemas/lib/plugins/serverless';
+import type ServerlessSchema from '../schema';
 export default class ServerlessTeardown extends Task<{
     plugin: typeof ServerlessSchema;
 }> {
+    static description: string;
     run({ cwd }: TaskRunContext): Promise<void>;
 }
 //# sourceMappingURL=teardown.d.ts.map

package/lib/tasks/teardown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"teardown.d.ts","sourceRoot":"","sources":["../../src/tasks/teardown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAA;AAIlF,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACjF,GAAG,CAAC,EAAC,GAAG,EAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmChD"}
+{"version":3,"file":"teardown.d.ts","sourceRoot":"","sources":["../../src/tasks/teardown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAG5D,OAAO,KAAK,gBAAgB,MAAM,WAAW,CAAA;AAE7C,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,IAAI,CAAC;IAAE,MAAM,EAAE,OAAO,gBAAgB,CAAA;CAAE,CAAC;IACvF,MAAM,CAAC,WAAW,SAA4C;IAExD,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmClD"}

package/lib/tasks/teardown.js

@@ -6,6 +6,7 @@ const base_1 = require("@dotcom-tool-kit/base");
 const state_1 = require("@dotcom-tool-kit/state");
 const child_process_1 = require("child_process");
 class ServerlessTeardown extends base_1.Task {
+    static description = 'Tear down existing serverless functions';
     async run({ cwd }) {
         const { configPath, regions, systemCode } = this.pluginOptions;
         const reviewState = (0, state_1.readState)('review');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcom-tool-kit/serverless",
-  "version": "3.2.9",
+  "version": "3.3.0",
   "description": "a plugin to manage and deploy apps using AWS Serverless",
   "main": "lib",
   "scripts": {
@@ -25,18 +25,17 @@
     "serverless-offline": "^12.0.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "^1.1.9",
-    "@dotcom-tool-kit/doppler": "^2.1.7",
+    "@dotcom-tool-kit/base": "^1.1.10",
+    "@dotcom-tool-kit/doppler": "^2.2.0",
     "@dotcom-tool-kit/error": "^4.1.0",
+    "@dotcom-tool-kit/logger": "^4.1.1",
     "@dotcom-tool-kit/state": "^4.3.1",
     "get-port": "^5.1.1",
     "tslib": "^2.3.1",
-    "wait-port": "^0.2.9"
+    "wait-port": "^0.2.9",
+    "zod": "^3.24.1"
   },
   "engines": {
     "node": "18.x || 20.x || 22.x"
-  },
-  "devDependencies": {
-    "@dotcom-tool-kit/schemas": "^1.9.0"
   }
 }