dotcom-tool-kit 4.4.2 → 4.5.0

package/lib/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAUrC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAgBpF,eAAO,MAAM,YAAY,SAAU,MAAM,KAAG,SAgB1C,CAAA;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,WAAW,CA6FtE;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC5G,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAUrC,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAgBpF,eAAO,MAAM,YAAY,SAAU,MAAM,KAAG,SAgB1C,CAAA;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,kBAAkB,GAAG,WAAW,CA4FtE;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAC5G,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA"}

package/lib/config.js

@@ -103,7 +103,7 @@ async function loadConfig(logger, { validate = true, root }) {
     // start with options so we can substitute resolved values into other parts
     // of the config
     (0, plugin_1.resolvePluginOptions)(validRootPlugin, validPluginConfig);
-    const invalidOptions = (0, options_1.validatePluginOptions)(logger, validPluginConfig);
+    const invalidOptions = await (0, options_1.validatePluginOptions)(logger, validPluginConfig);
     if (invalidOptions.length > 0 && validate) {
         const error = new error_1.ToolKitError(`There are options in your ${logger_1.styles.filepath('.toolkitrc.yml')} that aren't what Tool Kit expected.`);
         error.details = (0, messages_1.formatInvalidPluginOptions)(invalidOptions);

package/lib/fetch.d.ts

@@ -1,3 +1,3 @@
-import { RootOptions } from '@dotcom-tool-kit/schemas/src/plugins/dotcom-tool-kit';
+import type { RootOptions } from '@dotcom-tool-kit/plugin/src/root-schema';
 export declare const shouldDisableNativeFetch: (options: RootOptions) => boolean;
 //# sourceMappingURL=fetch.d.ts.map

package/lib/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sDAAsD,CAAA;AAIlF,eAAO,MAAM,wBAAwB,YAAa,WAAW,KAAG,OAK/D,CAAA"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAA;AAI1E,eAAO,MAAM,wBAAwB,YAAa,WAAW,KAAG,OAK/D,CAAA"}

package/lib/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAWrC,wBAAsB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhF"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAarC,wBAAsB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKhF"}

package/lib/init.js

@@ -5,8 +5,8 @@ const base_1 = require("@dotcom-tool-kit/base");
 const validated_1 = require("@dotcom-tool-kit/validated");
 const entry_point_1 = require("./plugin/entry-point");
 const loadInitEntrypoints = async (logger, config) => {
-    const initClassResults = (0, validated_1.reduceValidated)(await Promise.all(config.inits.map((entryPoint) => (0, entry_point_1.importEntryPoint)(base_1.Init, entryPoint))));
-    return initClassResults.map((initClasses) => initClasses.map((initClass) => new initClass(logger)));
+    const initModuleResults = (0, validated_1.reduceValidated)(await Promise.all(config.inits.map((entryPoint) => (0, entry_point_1.importEntryPoint)(base_1.Init, entryPoint))));
+    return initModuleResults.map((initModules) => initModules.map((initModule) => new initModule.baseClass(logger)));
 };
 async function runInit(logger, config) {
     const initResults = await loadInitEntrypoints(logger, config);

package/lib/install.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAa,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AAyCvF,eAAO,MAAM,qBAAqB,WACxB,MAAM,UACN,WAAW,KAClB,QAAQ,UAAU,IAAI,EAAE,CAAC,CA2C3B,CAAA;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBrF;AAED,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAiD/E"}
+{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,IAAI,EAAa,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AA0CvF,eAAO,MAAM,qBAAqB,WACxB,MAAM,UACN,WAAW,KAClB,QAAQ,UAAU,IAAI,EAAE,CAAC,CAsC3B,CAAA;AAED,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBrF;AAED,wBAA8B,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAiD/E"}

package/lib/install.js

@@ -31,8 +31,8 @@ async function asyncFilter(items, predicate) {
 }
 const loadHookEntrypoints = async (logger, config) => {
     const hookResultEntries = (0, validated_1.reduceValidated)(await Promise.all(Object.entries(config.hooks).map(async ([hookName, entryPoint]) => {
-        const hookResult = await (0, entry_point_1.importEntryPoint)(base_1.Hook, entryPoint);
-        return hookResult.map((hookClass) => [hookName, hookClass]);
+        const hookModule = await (0, entry_point_1.importEntryPoint)(base_1.Hook, entryPoint);
+        return hookModule.map(({ baseClass, schema }) => [hookName, { hookClass: baseClass, schema }]);
     })));
     return hookResultEntries.map((hookEntries) => Object.fromEntries(hookEntries));
 };

package/lib/plugin/entry-point.d.ts

@@ -1,7 +1,12 @@
 import type { Base } from '@dotcom-tool-kit/base';
 import type { EntryPoint } from '@dotcom-tool-kit/plugin';
 import { Validated } from '@dotcom-tool-kit/validated';
+import type * as z from 'zod';
+export declare function importSchemaEntryPoint(entryPoint: EntryPoint, exportName?: string): Promise<Validated<z.ZodSchema>>;
 export declare function importEntryPoint<T extends {
     name: string;
-} & Omit<typeof Base, 'new'>>(type: T, entryPoint: EntryPoint): Promise<Validated<T>>;
+} & Omit<typeof Base, 'new'>>(type: T, entryPoint: EntryPoint): Promise<Validated<{
+    baseClass: T;
+    schema?: z.ZodSchema;
+}>>;
 //# sourceMappingURL=entry-point.d.ts.map

package/lib/plugin/entry-point.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAW,MAAM,4BAA4B,CAAA;AAS/D,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAwCvB"}
+{"version":3,"file":"entry-point.d.ts","sourceRoot":"","sources":["../../src/plugin/entry-point.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAkB,MAAM,4BAA4B,CAAA;AAEtE,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAA;AAsC7B,wBAAsB,sBAAsB,CAC1C,UAAU,EAAE,UAAU,EACtB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAYjC;AAID,wBAAsB,gBAAgB,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,CAAC,EAC1F,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,CAAC;IAAE,SAAS,EAAE,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAA;CAAE,CAAC,CAAC,CAiC5D"}

package/lib/plugin/entry-point.js

@@ -1,24 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.importEntryPoint = void 0;
+exports.importEntryPoint = exports.importSchemaEntryPoint = void 0;
 const logger_1 = require("@dotcom-tool-kit/logger");
 const validated_1 = require("@dotcom-tool-kit/validated");
-const lodash_1 = require("lodash");
 const tslib_1 = require("tslib");
 const messages_1 = require("../messages");
-const isPlainObjectGuard = (value) => (0, lodash_1.isPlainObject)(value);
-// the subclasses of Base have different constructor signatures so we need to omit
-// the constructor from the type bound here so you can actually pass in a subclass
-async function importEntryPoint(type, entryPoint) {
+function guessIsZodSchema(schema) {
+    return typeof schema === 'object' && schema !== null && '_def' in schema;
+}
+/* eslint-disable-next-line @typescript-eslint/no-explicit-any --
+ * We aren't confident on the most reliable way to ensure the returned modules
+ * are the correct shape right now so let's leave this as any and hope for the
+ * best.
+ **/
+async function requireEntrypoint(entryPoint) {
     const resolvedPath = require.resolve(entryPoint.modulePath, { paths: [entryPoint.plugin.root] });
     if (!resolvedPath) {
         return (0, validated_1.invalid)([
             `could not find entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}`
         ]);
     }
-    let pluginModule;
+    let requiredModule;
     try {
-        pluginModule = require(resolvedPath);
+        requiredModule = require(resolvedPath);
     }
     catch (e) {
         const err = e;
@@ -26,16 +30,47 @@ async function importEntryPoint(type, entryPoint) {
             `an error was thrown when loading entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}:\n  ${logger_1.styles.code((0, messages_1.indentReasons)(err.toString()))}`
         ]);
     }
-    const defaultExport = (0, tslib_1.__importDefault)(pluginModule).default;
-    if (typeof defaultExport === 'function') {
-        return type
-            .isCompatible(defaultExport)
-            .mapError((reasons) => [
-            `the ${type.name.toLowerCase()} ${logger_1.styles.hook(defaultExport.name)} is not a compatible instance of ${logger_1.styles.code(type.name)}:\n  - ${reasons.join('\n  -  ')}`
+    return (0, validated_1.valid)(requiredModule);
+}
+async function importSchemaEntryPoint(entryPoint, exportName) {
+    const schemaResult = await requireEntrypoint(entryPoint);
+    return schemaResult.flatMap((schemaModule) => {
+        const schema = exportName ? schemaModule[exportName] : (0, tslib_1.__importDefault)(schemaModule).default;
+        return guessIsZodSchema(schema)
+            ? (0, validated_1.valid)(schema)
+            : (0, validated_1.invalid)([
+                `found an invalid Zod schema when loading entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)}`
+            ]);
+    });
+}
+exports.importSchemaEntryPoint = importSchemaEntryPoint;
+// the subclasses of Base have different constructor signatures so we need to omit
+// the constructor from the type bound here so you can actually pass in a subclass
+async function importEntryPoint(type, entryPoint) {
+    const pluginModuleResult = await requireEntrypoint(entryPoint);
+    return pluginModuleResult.flatMap((pluginModule) => {
+        const defaultExport = (0, tslib_1.__importDefault)(pluginModule).default;
+        const schemaExport = pluginModule.schema;
+        if (typeof defaultExport === 'function') {
+            return type
+                .isCompatible(defaultExport)
+                .flatMap((baseClass) => {
+                if (schemaExport === undefined || guessIsZodSchema(schemaExport)) {
+                    return (0, validated_1.valid)({ baseClass, schema: schemaExport });
+                }
+                else {
+                    return (0, validated_1.invalid)([
+                        `found an invalid Zod schema exported as ${logger_1.styles.code('schema')} at the entrypoint ${logger_1.styles.filepath(pluginModule.modulePath)} in plugin ${logger_1.styles.plugin(pluginModule.plugin.id)}`
+                    ]);
+                }
+            })
+                .mapError((reasons) => [
+                `the ${type.name.toLowerCase()} ${logger_1.styles.hook(defaultExport.name)} is not a compatible instance of ${logger_1.styles.code(type.name)}:\n  - ${reasons.join('\n  -  ')}`
+            ]);
+        }
+        return (0, validated_1.invalid)([
+            `entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)} does not export a class as its ${logger_1.styles.code('default')} export or ${logger_1.styles.code('module.exports')}`
         ]);
-    }
-    return (0, validated_1.invalid)([
-        `entrypoint ${logger_1.styles.filepath(entryPoint.modulePath)} in plugin ${logger_1.styles.plugin(entryPoint.plugin.id)} does not export a class as its ${logger_1.styles.code('default')} export or ${logger_1.styles.code('module.exports')}`
-    ]);
+    });
 }
 exports.importEntryPoint = importEntryPoint;

package/lib/plugin/options.d.ts

@@ -2,6 +2,6 @@ import { ValidPluginsConfig } from '@dotcom-tool-kit/config';
 import { type Plugin } from '@dotcom-tool-kit/plugin';
 import type { Logger } from 'winston';
 import { InvalidOption } from '../messages';
-export declare const validatePluginOptions: (logger: Logger, config: ValidPluginsConfig) => InvalidOption[];
+export declare const validatePluginOptions: (logger: Logger, config: ValidPluginsConfig) => Promise<InvalidOption[]>;
 export declare const substituteOptionTags: (plugin: Plugin, config: ValidPluginsConfig) => void;
 //# sourceMappingURL=options.d.ts.map

package/lib/plugin/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/plugin/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,OAAO,EAA4B,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAI/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,eAAO,MAAM,qBAAqB,WAAY,MAAM,UAAU,kBAAkB,KAAG,aAAa,EAwD/F,CAAA;AAED,eAAO,MAAM,oBAAoB,WAAY,MAAM,UAAU,kBAAkB,KAAG,IAgHjF,CAAA"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/plugin/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAE5D,OAAO,EAA4B,KAAK,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAQ/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAKrC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAG3C,eAAO,MAAM,qBAAqB,WACxB,MAAM,UACN,kBAAkB,KACzB,QAAQ,aAAa,EAAE,CAkEzB,CAAA;AAED,eAAO,MAAM,oBAAoB,WAAY,MAAM,UAAU,kBAAkB,KAAG,IAgHjF,CAAA"}

package/lib/plugin/options.js

@@ -1,32 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.substituteOptionTags = exports.validatePluginOptions = void 0;
+const tslib_1 = require("tslib");
 const conflict_1 = require("@dotcom-tool-kit/conflict");
+const root_schema_1 = require("@dotcom-tool-kit/plugin/lib/root-schema");
+// HACK:IM:20250217 preserve backwards compatibility with older plugins without
+// a colocated schema by falling back to the now-deleted schemas library if no
+// schema found
 const schemas_1 = require("@dotcom-tool-kit/schemas");
 const validated_1 = require("@dotcom-tool-kit/validated");
-const zod_1 = require("zod");
+const z = tslib_1.__importStar(require("zod"));
 const logger_1 = require("@dotcom-tool-kit/logger");
 const rc_file_1 = require("../rc-file");
-const validatePluginOptions = (logger, config) => {
+const entry_point_1 = require("./entry-point");
+const validatePluginOptions = async (logger, config) => {
     const invalidOptions = [];
     for (const [id, plugin] of Object.entries(config.plugins)) {
-        const pluginId = id;
-        const pluginOptions = config.pluginOptions[pluginId];
+        const pluginOptions = config.pluginOptions[id];
         if (pluginOptions && (0, conflict_1.isConflict)(pluginOptions)) {
             continue;
         }
-        const pluginSchema = schemas_1.PluginSchemas[pluginId];
+        let pluginSchema;
+        const schemaEntrypoint = plugin.rcFile?.optionsSchema;
+        if (schemaEntrypoint) {
+            const schema = await (0, entry_point_1.importSchemaEntryPoint)({ plugin, modulePath: schemaEntrypoint });
+            if (!schema.valid) {
+                invalidOptions.push([id, new z.ZodError([])]);
+                continue;
+            }
+            pluginSchema = schema.value;
+        }
+        else if (id === 'app root') {
+            pluginSchema = root_schema_1.RootSchema;
+        }
+        else {
+            pluginSchema = schemas_1.PluginSchemas[id];
+        }
         if (!pluginSchema) {
-            logger.silly(`skipping validation of ${pluginId} plugin as no schema can be found`);
+            logger.silly(`skipping validation of ${id} plugin as no schema can be found`);
             // TODO:KB:20240412 remove legacyPluginOptions in a future major version
-            if (pluginOptions && pluginId in schemas_1.legacyPluginOptions) {
-                const movedToTask = schemas_1.legacyPluginOptions[pluginId];
+            if (pluginOptions && id in schemas_1.legacyPluginOptions) {
+                const movedToTask = schemas_1.legacyPluginOptions[id];
                 invalidOptions.push([
                     id,
-                    new zod_1.ZodError([
+                    new z.ZodError([
                         {
                             message: `options for the ${logger_1.styles.plugin(id)} plugin have moved to ${logger_1.styles.code(`options.tasks.${logger_1.styles.task(movedToTask)}`)}`,
-                            code: zod_1.ZodIssueCode.custom,
+                            code: z.ZodIssueCode.custom,
                             path: []
                         }
                     ])
@@ -39,7 +59,7 @@ const validatePluginOptions = (logger, config) => {
             // Set up options entry for plugins that don't have options specified
             // explicitly. They could still have default options that are set by zod.
             if (!pluginOptions) {
-                config.pluginOptions[pluginId] = {
+                config.pluginOptions[id] = {
                     options: result.data,
                     plugin: config.plugins['app root'],
                     forPlugin: plugin

package/lib/plugin/reduce-installations.d.ts

@@ -1,8 +1,13 @@
 import type { Logger } from 'winston';
+import * as z from 'zod';
 import type { HookClass, HookInstallation } from '@dotcom-tool-kit/base';
 import type { ValidConfig } from '@dotcom-tool-kit/config';
 import { Conflict } from '@dotcom-tool-kit/conflict';
 import type { Plugin } from '@dotcom-tool-kit/plugin';
 import { Validated } from '@dotcom-tool-kit/validated';
-export declare function reducePluginHookInstallations(logger: Logger, config: ValidConfig, hookClasses: Record<string, HookClass>, plugin: Plugin): Promise<Validated<(HookInstallation | Conflict<HookInstallation>)[]>>;
+export interface HookModule {
+    hookClass: HookClass;
+    schema?: z.ZodTypeAny;
+}
+export declare function reducePluginHookInstallations(logger: Logger, config: ValidConfig, hookModules: Record<string, HookModule>, plugin: Plugin): Promise<Validated<(HookInstallation | Conflict<HookInstallation>)[]>>;
 //# sourceMappingURL=reduce-installations.d.ts.map

package/lib/plugin/reduce-installations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reduce-installations.d.ts","sourceRoot":"","sources":["../../src/plugin/reduce-installations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAGrC,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AAiCvF,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,SAAS,CAAC,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAgEvE"}
+{"version":3,"file":"reduce-installations.d.ts","sourceRoot":"","sources":["../../src/plugin/reduce-installations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,OAAO,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAc,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,EAAE,SAAS,EAAmC,MAAM,4BAA4B,CAAA;AAIvF,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAA;CACtB;AA+BD,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EACvC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,SAAS,CAAC,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAkEvE"}

package/lib/plugin/reduce-installations.js

@@ -33,17 +33,17 @@ const extractForHook = (installation) => (0, conflict_1.isConflict)(installation
 //     the resulting installations and/or conflicts from `a`, `b`, and `c`
 //   - call `Hook.overrideChildInstallations` with the appropriate concrete Hook class, and
 //     the resulting installations and/or conflicts from `Hook.mergeChildInstallations` and `p`
-async function reducePluginHookInstallations(logger, config, hookClasses, plugin) {
+async function reducePluginHookInstallations(logger, config, hookModules, plugin) {
     if (!plugin.rcFile || config.resolutionTrackers.reducedInstallationPlugins.has(plugin.id)) {
         return (0, validated_1.valid)([]);
     }
     config.resolutionTrackers.reducedInstallationPlugins.add(plugin.id);
-    const rawChildInstallations = (0, validated_1.reduceValidated)(await Promise.all((plugin.children ?? []).map((child) => reducePluginHookInstallations(logger, config, hookClasses, child)))).map((installations) => installations.flat());
+    const rawChildInstallations = (0, validated_1.reduceValidated)(await Promise.all((plugin.children ?? []).map((child) => reducePluginHookInstallations(logger, config, hookModules, child)))).map((installations) => installations.flat());
     if (!rawChildInstallations.valid) {
         return rawChildInstallations;
     }
     const childInstallations = Object.entries((0, lodash_1.groupBy)(rawChildInstallations.value, extractForHook)).flatMap(([forHook, installations]) => {
-        const hookClass = hookClasses[forHook];
+        const { hookClass } = hookModules[forHook];
         return hookClass.mergeChildInstallations(plugin, installations);
     });
     if (plugin.rcFile.options.hooks.length === 0) {
@@ -51,14 +51,14 @@ async function reducePluginHookInstallations(logger, config, hookClasses, plugin
     }
     const unusedHookOptions = plugin.rcFile.options.hooks
         .flatMap(Object.keys)
-        .filter((hookId) => !(hookId in hookClasses))
+        .filter((hookId) => !(hookId in hookModules))
         .map((hookId) => logger_1.styles.hook(hookId));
     if (unusedHookOptions.length > 0) {
-        return (0, validated_1.invalid)([(0, messages_1.formatUnusedHookOptions)(unusedHookOptions, Object.keys(hookClasses))]);
+        return (0, validated_1.invalid)([(0, messages_1.formatUnusedHookOptions)(unusedHookOptions, Object.keys(hookModules))]);
     }
     const validatedInstallations = plugin.rcFile.options.hooks.flatMap((hookEntry) => Object.entries(hookEntry).map(([id, configHookOptions]) => {
-        const hookClass = hookClasses[id];
-        const parsedOptions = schemas_1.HookSchemas[id]?.safeParse(configHookOptions);
+        const hookModule = hookModules[id];
+        const parsedOptions = (hookModule.schema ?? schemas_1.HookSchemas[id])?.safeParse(configHookOptions);
         if (parsedOptions && !parsedOptions.success) {
             return (0, validated_1.invalid)([(0, messages_1.formatInvalidOption)([logger_1.styles.hook(id), parsedOptions.error])]);
         }
@@ -66,10 +66,10 @@ async function reducePluginHookInstallations(logger, config, hookClasses, plugin
             options: parsedOptions?.data ?? configHookOptions,
             plugin,
             forHook: id,
-            hookConstructor: hookClass
+            hookConstructor: hookModule.hookClass
         };
         const childInstallationsForHook = childInstallations.filter((childInstallation) => id === extractForHook(childInstallation));
-        return (0, validated_1.valid)(hookClass.overrideChildInstallations(plugin, installation, childInstallationsForHook));
+        return (0, validated_1.valid)(hookModule.hookClass.overrideChildInstallations(plugin, installation, childInstallationsForHook));
     }));
     return (0, validated_1.reduceValidated)(validatedInstallations).map((installations) => installations.flat());
 }

package/lib/rc-file.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AA0BrC,eAAO,MAAM,kBAAkB,uBAAuB,CAAA;AACtD,eAAO,MAAM,qBAAqB,2BAA2B,CAAA;AAoB7D,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAqEjF"}
+{"version":3,"file":"rc-file.d.ts","sourceRoot":"","sources":["../src/rc-file.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AA0BrC,eAAO,MAAM,kBAAkB,uBAAuB,CAAA;AACtD,eAAO,MAAM,qBAAqB,2BAA2B,CAAA;AAoB7D,wBAAsB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAsEjF"}

package/lib/rc-file.js

@@ -87,6 +87,7 @@ async function loadToolKitRC(logger, root) {
                 hooks: config.options.hooks ?? []
             }
             : { plugins: {}, tasks: {}, hooks: [] },
+        optionsSchema: config.optionsSchema ?? undefined,
         hooks: config.hooks ?? undefined,
         init: config.init ?? []
     };

package/lib/tasks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAuDrC,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CA8Df;AAED,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIlG"}
+{"version":3,"file":"tasks.d.ts","sourceRoot":"","sources":["../src/tasks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAG1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAyDrC,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAAC,IAAI,CAAC,CA8Df;AAED,wBAAsB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAIlG"}

package/lib/tasks.js

@@ -18,16 +18,15 @@ const loadTasks = async (logger, tasks, config) => {
     const taskResults = await Promise.all(tasks.map(async ({ task: taskId, options }) => {
         const entryPoint = config.tasks[taskId];
         const taskResult = await (0, entry_point_1.importEntryPoint)(base_1.Task, entryPoint);
-        return taskResult.flatMap((Task) => {
-            const taskSchema = schemas_1.TaskSchemas[taskId];
+        return taskResult.flatMap((taskModule) => {
             const configOptions = config.taskOptions[taskId]?.options ?? {};
             const mergedOptions = { ...configOptions, ...options };
-            const parsedOptions = taskSchema?.safeParse(mergedOptions) ?? {
+            const parsedOptions = (taskModule.schema ?? schemas_1.TaskSchemas[taskId])?.safeParse(mergedOptions) ?? {
                 success: true,
                 data: mergedOptions
             };
             if (parsedOptions.success) {
-                const task = new Task(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data);
+                const task = new taskModule.baseClass(logger, taskId, config.pluginOptions[entryPoint.plugin.id]?.options ?? {}, parsedOptions.data);
                 return (0, validated_1.valid)(task);
             }
             else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotcom-tool-kit",
-  "version": "4.4.2",
+  "version": "4.5.0",
   "description": "modern, maintainable, modular developer tooling for FT.com projects",
   "author": "FT.com Platforms Team <platforms-team.customer-products@ft.com>",
   "license": "MIT",
@@ -30,19 +30,21 @@
     "zod": "^3.22.4"
   },
   "dependencies": {
-    "@dotcom-tool-kit/base": "^1.1.9",
-    "@dotcom-tool-kit/config": "^1.0.12",
-    "@dotcom-tool-kit/conflict": "^1.0.0",
+    "@dotcom-tool-kit/base": "^1.1.10",
+    "@dotcom-tool-kit/config": "^1.1.0",
+    "@dotcom-tool-kit/conflict": "^1.0.1",
     "@dotcom-tool-kit/error": "^4.1.0",
     "@dotcom-tool-kit/logger": "^4.1.1",
-    "@dotcom-tool-kit/plugin": "^1.0.0",
-    "@dotcom-tool-kit/state": "^4.3.0",
+    "@dotcom-tool-kit/plugin": "^1.1.0",
+    "@dotcom-tool-kit/schemas": "^1.9.0",
+    "@dotcom-tool-kit/state": "^4.3.1",
     "@dotcom-tool-kit/validated": "^1.0.2",
     "@dotcom-tool-kit/wait-for-ok": "^4.1.0",
     "endent": "^2.1.0",
     "lodash": "^4.17.21",
     "minimist": "^1.2.5",
     "pluralize": "^8.0.0",
+    "pretty-format": "^29.7.0",
     "tslib": "^2.3.1",
     "yaml": "^2.4.1",
     "zod-validation-error": "^2.1.0"