takomo 4.6.1 → 5.0.0-alpha.1

package/dist/takomo-stacks-hooks/execute.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeHooks = void 0;
+/**
+ * @hidden
+ */
+const executeHooks = async ({ ctx, stack, variables, hooks, operation, stage, logger, status, }) => {
+    logger.debug(`About to execute hooks (operation: ${operation}, stage: ${stage}, status: ${status})`);
+    const input = {
+        ctx,
+        stack,
+        variables,
+        stage,
+        operation,
+        status,
+        logger,
+    };
+    const hooksToExecute = hooks.filter((h) => h.match(input));
+    logger.debug(`Found ${hooksToExecute.length} matching hook(s)`);
+    for (const hook of hooksToExecute) {
+        logger.debug(`Execute hook (name: ${hook.config.name}, type: ${hook.config.type})`);
+        try {
+            const output = await hook.execute({
+                ...input,
+                logger: logger.childLogger(`hook:${stage}:${hook.config.name}`),
+            });
+            logger.debug(`Hook (name: ${hook.config.name}, type: ${hook.config.type}) executed with success: ${output.success}, skip: ${output.skip} message: ${output.message}`);
+            variables.hooks[hook.config.name] = output.value;
+            if (!output.success) {
+                return {
+                    message: output.message ?? "Failed",
+                    result: "abort",
+                    error: output.error,
+                };
+            }
+            if (output.skip === true) {
+                return {
+                    message: output.message ?? "Skip",
+                    result: "skip",
+                };
+            }
+        }
+        catch (error) {
+            logger.error(`An error occurred while executing hook (name: ${hook.config.name}, type: ${hook.config.type})`, error);
+            return {
+                error,
+                result: "abort",
+                message: error.message ?? "Error",
+            };
+        }
+    }
+    return {
+        message: "Success",
+        result: "continue",
+    };
+};
+exports.executeHooks = executeHooks;
+//# sourceMappingURL=execute.js.map

package/dist/takomo-stacks-hooks/execute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.js","sourceRoot":"","sources":["../../src/takomo-stacks-hooks/execute.ts"],"names":[],"mappings":";;;AAuBA;;GAEG;AACI,MAAM,YAAY,GAAG,KAAK,EAAE,EACjC,GAAG,EACH,KAAK,EACL,SAAS,EACT,KAAK,EACL,SAAS,EACT,KAAK,EACL,MAAM,EACN,MAAM,GACY,EAAiC,EAAE;IACrD,MAAM,CAAC,KAAK,CACV,sCAAsC,SAAS,YAAY,KAAK,aAAa,MAAM,GAAG,CACvF,CAAA;IAED,MAAM,KAAK,GAAG;QACZ,GAAG;QACH,KAAK;QACL,SAAS;QACT,KAAK;QACL,SAAS;QACT,MAAM;QACN,MAAM;KACP,CAAA;IAED,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAA;IAE1D,MAAM,CAAC,KAAK,CAAC,SAAS,cAAc,CAAC,MAAM,mBAAmB,CAAC,CAAA;IAE/D,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE;QACjC,MAAM,CAAC,KAAK,CACV,uBAAuB,IAAI,CAAC,MAAM,CAAC,IAAI,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CACtE,CAAA;QAED,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;gBAChC,GAAG,KAAK;gBACR,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;aAChE,CAAC,CAAA;YAEF,MAAM,CAAC,KAAK,CACV,eAAe,IAAI,CAAC,MAAM,CAAC,IAAI,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,4BAA4B,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC,IAAI,aAAa,MAAM,CAAC,OAAO,EAAE,CACxJ,CAAA;YAED,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;YAEhD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;gBACnB,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,QAAQ;oBACnC,MAAM,EAAE,OAAO;oBACf,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAA;aACF;YAED,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE;gBACxB,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,MAAM;oBACjC,MAAM,EAAE,MAAM;iBACf,CAAA;aACF;SACF;QAAC,OAAO,KAAU,EAAE;YACnB,MAAM,CAAC,KAAK,CACV,iDAAiD,IAAI,CAAC,MAAM,CAAC,IAAI,WAAW,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,EAC/F,KAAK,CACN,CAAA;YACD,OAAO;gBACL,KAAK;gBACL,MAAM,EAAE,OAAO;gBACf,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,OAAO;aAClC,CAAA;SACF;KACF;IAED,OAAO;QACL,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,UAAU;KACnB,CAAA;AACH,CAAC,CAAA;AA5EY,QAAA,YAAY,gBA4ExB"}

package/dist/takomo-stacks-hooks/hook-registry.d.ts

@@ -0,0 +1,13 @@
+import { Hook, HookConfig, HookProvider, HookType } from "../takomo-stacks-model";
+import { FilePath, TkmLogger } from "../takomo-util";
+export interface HookRegistry {
+    readonly initHook: (props: HookConfig) => Promise<Hook>;
+    readonly hasProvider: (type: HookType) => boolean;
+    readonly registerBuiltInProvider: (provider: HookProvider) => Promise<void>;
+    readonly registerProviderFromFile: (pathToResolverFile: FilePath) => Promise<void>;
+}
+interface CreateHookRegistryProps {
+    readonly logger: TkmLogger;
+}
+export declare const createHookRegistry: ({ logger, }: CreateHookRegistryProps) => HookRegistry;
+export {};

package/dist/takomo-stacks-hooks/hook-registry.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHookRegistry = void 0;
+const takomo_util_1 = require("../takomo-util");
+class InvalidHookProviderConfigurationError extends takomo_util_1.TakomoError {
+    constructor(sourceDescription, details, options) {
+        super(`Invalid hook provider configuration in ${sourceDescription}:\n\n${details}`, options);
+    }
+}
+const createHookRegistry = ({ logger, }) => {
+    const providers = new Map();
+    const hasProvider = (type) => providers.has(type);
+    const registerProvider = async (provider, sourceDescription) => {
+        logger.debug(`Register hook provider from ${sourceDescription}`);
+        if (provider.type === undefined || provider.type === null) {
+            throw new InvalidHookProviderConfigurationError(sourceDescription, "type property not defined", {
+                info: "type property defines the type for the hook. " +
+                    "It must be a string",
+            });
+        }
+        if (provider.init === undefined || provider.init === null) {
+            throw new InvalidHookProviderConfigurationError(sourceDescription, "init function not defined");
+        }
+        if (typeof provider.init !== "function") {
+            throw new InvalidHookProviderConfigurationError(sourceDescription, "init is not a function");
+        }
+        if (typeof provider.type !== "string") {
+            throw new InvalidHookProviderConfigurationError(sourceDescription, "type property has invalid type", {
+                info: "type property defines the type for the hook. " +
+                    "It must be a string",
+            });
+        }
+        if (hasProvider(provider.type)) {
+            throw new InvalidHookProviderConfigurationError(sourceDescription, `Hook provider already registered with type '${provider.type}'`);
+        }
+        logger.debug(`Registered hook provider from ${sourceDescription} with type '${provider.type}'`);
+        providers.set(provider.type, provider);
+    };
+    const getProvider = (type) => {
+        const provider = providers.get(type);
+        if (!provider) {
+            throw new Error(`No provider found for hook with type '${type}'`);
+        }
+        return provider;
+    };
+    const initHook = async (props) => {
+        const provider = getProvider(props.type);
+        return provider.init(props);
+    };
+    const registerBuiltInProvider = (provider) => registerProvider(provider, "built-in providers");
+    const registerProviderFromFile = async (pathToFile) => {
+        // eslint-disable-next-line
+        const provider = require(pathToFile);
+        return registerProvider(provider, `file: ${pathToFile}`);
+    };
+    return {
+        registerBuiltInProvider,
+        registerProviderFromFile,
+        initHook,
+        hasProvider,
+    };
+};
+exports.createHookRegistry = createHookRegistry;
+//# sourceMappingURL=hook-registry.js.map

package/dist/takomo-stacks-hooks/hook-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hook-registry.js","sourceRoot":"","sources":["../../src/takomo-stacks-hooks/hook-registry.ts"],"names":[],"mappings":";;;AAMA,gDAKuB;AAEvB,MAAM,qCAAsC,SAAQ,yBAAW;IAC7D,YACE,iBAAyB,EACzB,OAAe,EACf,OAA0B;QAE1B,KAAK,CACH,0CAA0C,iBAAiB,QAAQ,OAAO,EAAE,EAC5E,OAAO,CACR,CAAA;IACH,CAAC;CACF;AAeM,MAAM,kBAAkB,GAAG,CAAC,EACjC,MAAM,GACkB,EAAgB,EAAE;IAC1C,MAAM,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAA;IAEnD,MAAM,WAAW,GAAG,CAAC,IAAc,EAAW,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAEpE,MAAM,gBAAgB,GAAG,KAAK,EAC5B,QAAa,EACb,iBAAyB,EACV,EAAE;QACjB,MAAM,CAAC,KAAK,CAAC,+BAA+B,iBAAiB,EAAE,CAAC,CAAA;QAEhE,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE;YACzD,MAAM,IAAI,qCAAqC,CAC7C,iBAAiB,EACjB,2BAA2B,EAC3B;gBACE,IAAI,EACF,+CAA+C;oBAC/C,qBAAqB;aACxB,CACF,CAAA;SACF;QAED,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE;YACzD,MAAM,IAAI,qCAAqC,CAC7C,iBAAiB,EACjB,2BAA2B,CAC5B,CAAA;SACF;QAED,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;YACvC,MAAM,IAAI,qCAAqC,CAC7C,iBAAiB,EACjB,wBAAwB,CACzB,CAAA;SACF;QAED,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE;YACrC,MAAM,IAAI,qCAAqC,CAC7C,iBAAiB,EACjB,gCAAgC,EAChC;gBACE,IAAI,EACF,+CAA+C;oBAC/C,qBAAqB;aACxB,CACF,CAAA;SACF;QAED,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,qCAAqC,CAC7C,iBAAiB,EACjB,+CAA+C,QAAQ,CAAC,IAAI,GAAG,CAChE,CAAA;SACF;QAED,MAAM,CAAC,KAAK,CACV,iCAAiC,iBAAiB,eAAe,QAAQ,CAAC,IAAI,GAAG,CAClF,CAAA;QAED,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACxC,CAAC,CAAA;IAED,MAAM,WAAW,GAAG,CAAC,IAAc,EAAgB,EAAE;QACnD,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACpC,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,GAAG,CAAC,CAAA;SAClE;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,EAAE,KAAiB,EAAiB,EAAE;QAC1D,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC,CAAA;IAED,MAAM,uBAAuB,GAAG,CAAC,QAAsB,EAAiB,EAAE,CACxE,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAA;IAElD,MAAM,wBAAwB,GAAG,KAAK,EACpC,UAAoB,EACL,EAAE;QACjB,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;QACpC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,SAAS,UAAU,EAAE,CAAC,CAAA;IAC1D,CAAC,CAAA;IAED,OAAO;QACL,uBAAuB;QACvB,wBAAwB;QACxB,QAAQ;QACR,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAhGY,QAAA,kBAAkB,sBAgG9B"}

package/dist/takomo-stacks-hooks/index.d.ts

@@ -0,0 +1,4 @@
+export { ChecksumHook } from "./checksum-hook";
+export { CmdHook } from "./cmd-hook";
+export { executeHooks } from "./execute";
+export { createHookRegistry, HookRegistry } from "./hook-registry";

package/dist/takomo-stacks-hooks/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHookRegistry = exports.executeHooks = exports.CmdHook = exports.ChecksumHook = void 0;
+var checksum_hook_1 = require("./checksum-hook");
+Object.defineProperty(exports, "ChecksumHook", { enumerable: true, get: function () { return checksum_hook_1.ChecksumHook; } });
+var cmd_hook_1 = require("./cmd-hook");
+Object.defineProperty(exports, "CmdHook", { enumerable: true, get: function () { return cmd_hook_1.CmdHook; } });
+var execute_1 = require("./execute");
+Object.defineProperty(exports, "executeHooks", { enumerable: true, get: function () { return execute_1.executeHooks; } });
+var hook_registry_1 = require("./hook-registry");
+Object.defineProperty(exports, "createHookRegistry", { enumerable: true, get: function () { return hook_registry_1.createHookRegistry; } });
+//# sourceMappingURL=index.js.map

package/dist/takomo-stacks-hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/takomo-stacks-hooks/index.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAArC,6GAAA,YAAY,OAAA;AACrB,uCAAoC;AAA3B,mGAAA,OAAO,OAAA;AAChB,qCAAwC;AAA/B,uGAAA,YAAY,OAAA;AACrB,iDAAkE;AAAzD,mHAAA,kBAAkB,OAAA"}

package/dist/takomo-stacks-model/command.d.ts

@@ -0,0 +1,47 @@
+import { StackEvent } from "../takomo-aws-model";
+import { CommandStatus, Variables } from "../takomo-core";
+import { Timer } from "../takomo-util";
+import { InternalStack, StackPath } from "./stack";
+import { StackGroupPath } from "./stack-group";
+/**
+ * Command path.
+ */
+export declare type CommandPath = StackGroupPath | StackPath;
+/**
+ * @hidden
+ */
+export declare type DeploymentOperation = "deploy" | "undeploy";
+/**
+ * @hidden
+ */
+export declare const defaultCapabilities: string[];
+export interface HookOutputValues {
+    [hookName: string]: any;
+}
+/**
+ * A mutable copy of the current command variables during a stack operation.
+ */
+export interface StackOperationVariables extends Variables {
+    /**
+     * Hook output values
+     */
+    readonly hooks: HookOutputValues;
+}
+/**
+ * @hidden
+ */
+export interface StackResult {
+    readonly stack: InternalStack;
+    readonly message: string;
+    readonly status: CommandStatus;
+    readonly events: ReadonlyArray<StackEvent>;
+    readonly success: boolean;
+    readonly timer: Timer;
+    readonly operationType: StackOperationType;
+    readonly stackExistedBeforeOperation: boolean;
+    readonly error?: Error;
+}
+/**
+ * @hidden
+ */
+export declare type StackOperationType = "CREATE" | "RECREATE" | "UPDATE" | "DELETE";

package/dist/takomo-stacks-model/command.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCapabilities = void 0;
+/**
+ * @hidden
+ */
+exports.defaultCapabilities = [
+    "CAPABILITY_IAM",
+    "CAPABILITY_NAMED_IAM",
+    "CAPABILITY_AUTO_EXPAND",
+];
+//# sourceMappingURL=command.js.map

package/dist/takomo-stacks-model/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/command.ts"],"names":[],"mappings":";;;AAgBA;;GAEG;AACU,QAAA,mBAAmB,GAAG;IACjC,gBAAgB;IAChB,sBAAsB;IACtB,wBAAwB;CACzB,CAAA"}

package/dist/takomo-stacks-model/common.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @hidden
+ */
+export interface TimeoutConfig {
+    readonly create: number;
+    readonly update: number;
+}
+/**
+ * @hidden
+ */
+export interface TemplateBucketConfig {
+    readonly name: string;
+    readonly keyPrefix?: string;
+}

package/dist/takomo-stacks-model/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/dist/takomo-stacks-model/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/common.ts"],"names":[],"mappings":""}

package/dist/takomo-stacks-model/constants.d.ts

@@ -0,0 +1,9 @@
+import { TemplateBucketConfig, TimeoutConfig } from "./common";
+import { StackPath } from "./stack";
+export declare const ROOT_STACK_GROUP_PATH = "/";
+export declare const StackPropertyDefaults: {
+    inheritTags: () => boolean;
+    depends: () => ReadonlyArray<StackPath>;
+    timeout: () => TimeoutConfig;
+    templateBucket: () => TemplateBucketConfig | undefined;
+};

package/dist/takomo-stacks-model/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StackPropertyDefaults = exports.ROOT_STACK_GROUP_PATH = void 0;
+exports.ROOT_STACK_GROUP_PATH = "/";
+exports.StackPropertyDefaults = {
+    inheritTags: () => true,
+    depends: () => [],
+    timeout: () => ({ create: 0, update: 0 }),
+    templateBucket: () => undefined,
+};
+//# sourceMappingURL=constants.js.map

package/dist/takomo-stacks-model/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/constants.ts"],"names":[],"mappings":";;;AAGa,QAAA,qBAAqB,GAAG,GAAG,CAAA;AAE3B,QAAA,qBAAqB,GAAG;IACnC,WAAW,EAAE,GAAY,EAAE,CAAC,IAAI;IAChC,OAAO,EAAE,GAA6B,EAAE,CAAC,EAAE;IAC3C,OAAO,EAAE,GAAkB,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACxD,cAAc,EAAE,GAAqC,EAAE,CAAC,SAAS;CAClE,CAAA"}

package/dist/takomo-stacks-model/context.d.ts

@@ -0,0 +1,43 @@
+import { CredentialManager } from "../takomo-aws-clients";
+import { CommandContext, InternalCommandContext } from "../takomo-core";
+import { TemplateEngine } from "../takomo-util";
+import { InternalStack, Stack, StackPath } from "./stack";
+import { StackGroup, StackGroupPath } from "./stack-group";
+/**
+ * Provides access to the current stack context and
+ * project configuration.
+ */
+export interface StacksContext extends CommandContext {
+    /**
+     * Credential manager that provides access to AWS credentials used
+     * to invoke the current operation.
+     */
+    readonly credentialManager: CredentialManager;
+    /**
+     * Template engine instance.
+     */
+    readonly templateEngine: TemplateEngine;
+    /**
+     * Return a stack by exact path or throw an error if no stack is found.
+     * The stack path can be relative if stackGroupPath is given.
+     */
+    readonly getStackByExactPath: (path: StackPath, stackGroupPath?: StackGroupPath) => Stack;
+    /**
+     * Return 0 or more stacks by path. The stack path can be relative if
+     * stackGroupPath is given.
+     */
+    readonly getStacksByPath: (path: StackPath, stackGroupPath?: StackGroupPath) => ReadonlyArray<Stack>;
+}
+/**
+ * @hidden
+ */
+export interface InternalStacksContext extends InternalCommandContext {
+    readonly concurrentStacks: number;
+    readonly credentialManager: CredentialManager;
+    readonly templateEngine: TemplateEngine;
+    readonly rootStackGroup: StackGroup;
+    readonly stacks: ReadonlyArray<InternalStack>;
+    readonly getStackGroup: (stackGroupPath: StackGroupPath) => StackGroup | undefined;
+    readonly getStackByExactPath: (path: StackPath, stackGroupPath?: StackGroupPath) => InternalStack;
+    readonly getStacksByPath: (path: StackPath, stackGroupPath?: StackGroupPath) => ReadonlyArray<InternalStack>;
+}

package/dist/takomo-stacks-model/context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context.js.map

package/dist/takomo-stacks-model/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/context.ts"],"names":[],"mappings":""}

package/dist/takomo-stacks-model/hook.d.ts

@@ -0,0 +1,133 @@
+import { TkmLogger } from "../takomo-util";
+import { StackOperationVariables } from "./command";
+import { StacksContext } from "./context";
+import { Stack } from "./stack";
+export declare type HookType = string;
+/**
+ * Specifies during which stack operation the hook should be executed.
+ */
+export declare type HookOperation = "create" | "update" | "delete";
+/**
+ * Specifies during which stack operation stage stage the hook should be executed.
+ */
+export declare type HookStage = "before" | "after";
+/**
+ * Specifies after which stack operation status the hook should be executed.
+ */
+export declare type HookStatus = "success" | "failed" | "skipped" | "cancelled";
+export declare type HookOutput = HookOutputObject | Error | boolean;
+/**
+ * @hidden
+ */
+export declare type HookExecutionResult = "continue" | "abort" | "skip";
+/**
+ * @hidden
+ */
+export interface HooksExecutionOutput {
+    /**
+     * Message describing the outcome of the action.
+     */
+    readonly message: string;
+    /**
+     * Hook execution result.
+     */
+    readonly result: HookExecutionResult;
+    /**
+     * If an error was thrown during execution it will be stored here.
+     */
+    readonly error?: Error;
+}
+/**
+ * Input for a life-cycle hook action.
+ */
+export interface HookInput {
+    readonly ctx: StacksContext;
+    readonly stack: Stack;
+    readonly variables: StackOperationVariables;
+    readonly stage: HookStage;
+    readonly operation: HookOperation;
+    readonly status?: HookStatus;
+    readonly logger: TkmLogger;
+}
+/**
+ * Output of a life-cycle hook action.
+ */
+export interface HookOutputObject {
+    /**
+     * Optional message describing the outcome of the action.
+     */
+    readonly message?: string;
+    /**
+     * Boolean describing if the action was successful.
+     */
+    readonly success: boolean;
+    /**
+     * Optional return value.
+     */
+    readonly value?: any;
+    /**
+     * Optional error.
+     */
+    readonly error?: Error;
+    /**
+     * Optional boolean that can be returned from hooks executed
+     * before the stack operation to indicate that the operation
+     * should be skipped and all the remaining before hooks should
+     * be ignored.
+     */
+    readonly skip?: boolean;
+}
+/**
+ * Life-cycle hook used to perform actions at different stages of stack deploy and undeploy commands.
+ */
+export interface Hook {
+    /**
+     * Perform the hook action.
+     *
+     * @param input Inputs for the action
+     * @returns Action output
+     */
+    execute: (input: HookInput) => Promise<HookOutput>;
+}
+/**
+ * @hidden
+ */
+export declare class HookExecutor implements Hook {
+    readonly config: HookConfig;
+    private readonly hook;
+    /**
+     * @param config Hook configuration
+     * @param hook Hook instance
+     */
+    constructor(config: HookConfig, hook: Hook);
+    /**
+     * @param input Hook input
+     * @returns Should the hook be executed
+     */
+    match: (input: HookInput) => boolean;
+    execute: (input: HookInput) => Promise<HookOutputObject>;
+}
+/**
+ * @hidden
+ */
+export interface HookConfig {
+    readonly name: string;
+    readonly type: string;
+    readonly stage?: ReadonlyArray<HookStage>;
+    readonly operation?: ReadonlyArray<HookOperation>;
+    readonly status?: ReadonlyArray<HookStatus>;
+}
+/**
+ * An interface to be implemented by objects that initialize {@linkcode Hook}
+ * objects.
+ */
+export interface HookProvider {
+    /**
+     * The name of the hook that this provider initializes.
+     */
+    readonly type: HookType;
+    /**
+     * Initialize a hook.
+     */
+    readonly init: (props: any) => Promise<Hook>;
+}

package/dist/takomo-stacks-model/hook.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HookExecutor = void 0;
+/**
+ * @hidden
+ */
+class HookExecutor {
+    /**
+     * @param config Hook configuration
+     * @param hook Hook instance
+     */
+    constructor(config, hook) {
+        /**
+         * @param input Hook input
+         * @returns Should the hook be executed
+         */
+        this.match = (input) => {
+            if (this.config.stage && !this.config.stage.includes(input.stage)) {
+                return false;
+            }
+            if (this.config.operation &&
+                !this.config.operation.includes(input.operation)) {
+                return false;
+            }
+            return !(input.status &&
+                this.config.status &&
+                !this.config.status.includes(input.status));
+        };
+        this.execute = async (input) => {
+            try {
+                const result = await this.hook.execute(input);
+                if (typeof result === "boolean") {
+                    return {
+                        message: result ? "Success" : "Failed",
+                        success: result,
+                        value: result,
+                    };
+                }
+                if (result instanceof Error) {
+                    return {
+                        message: result.message || "Error",
+                        success: false,
+                        value: result,
+                    };
+                }
+                return result;
+            }
+            catch (e) {
+                return {
+                    message: e.message ?? "Error",
+                    success: false,
+                };
+            }
+        };
+        this.config = config;
+        this.hook = hook;
+    }
+}
+exports.HookExecutor = HookExecutor;
+//# sourceMappingURL=hook.js.map

package/dist/takomo-stacks-model/hook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hook.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/hook.ts"],"names":[],"mappings":";;;AA4GA;;GAEG;AACH,MAAa,YAAY;IAIvB;;;OAGG;IACH,YAAY,MAAkB,EAAE,IAAU;QAK1C;;;WAGG;QACH,UAAK,GAAG,CAAC,KAAgB,EAAW,EAAE;YACpC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACjE,OAAO,KAAK,CAAA;aACb;YACD,IACE,IAAI,CAAC,MAAM,CAAC,SAAS;gBACrB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAChD;gBACA,OAAO,KAAK,CAAA;aACb;YACD,OAAO,CAAC,CACN,KAAK,CAAC,MAAM;gBACZ,IAAI,CAAC,MAAM,CAAC,MAAM;gBAClB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAC3C,CAAA;QACH,CAAC,CAAA;QAED,YAAO,GAAG,KAAK,EAAE,KAAgB,EAA6B,EAAE;YAC9D,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC7C,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;oBAC/B,OAAO;wBACL,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ;wBACtC,OAAO,EAAE,MAAM;wBACf,KAAK,EAAE,MAAM;qBACd,CAAA;iBACF;gBAED,IAAI,MAAM,YAAY,KAAK,EAAE;oBAC3B,OAAO;wBACL,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,OAAO;wBAClC,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,MAAM;qBACd,CAAA;iBACF;gBAED,OAAO,MAAM,CAAA;aACd;YAAC,OAAO,CAAM,EAAE;gBACf,OAAO;oBACL,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,OAAO;oBAC7B,OAAO,EAAE,KAAK;iBACf,CAAA;aACF;QACH,CAAC,CAAA;QAnDC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;CAkDF;AA7DD,oCA6DC"}

package/dist/takomo-stacks-model/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./command";
+export * from "./common";
+export { ROOT_STACK_GROUP_PATH, StackPropertyDefaults } from "./constants";
+export { InternalStacksContext, StacksContext } from "./context";
+export * from "./hook";
+export * from "./resolver";
+export { createSchemaRegistry, defaultSchema, InitSchemaProps, SchemaName, SchemaProps, SchemaProvider, SchemaRegistry, Schemas, } from "./schemas";
+export { BlueprintPath, createStack, InternalStack, normalizeStackPath, RawTagValue, Stack, StackPath, StackProps, Template, } from "./stack";
+export { createStackGroup, StackGroup, StackGroupName, StackGroupPath, StackGroupProps, } from "./stack-group";
+export { getStackName, getStackNames, getStackPath, getStackPaths, isNotObsolete, isObsolete, isWithinCommandPath, } from "./util";

package/dist/takomo-stacks-model/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWithinCommandPath = exports.isObsolete = exports.isNotObsolete = exports.getStackPaths = exports.getStackPath = exports.getStackNames = exports.getStackName = exports.createStackGroup = exports.normalizeStackPath = exports.createStack = exports.defaultSchema = exports.createSchemaRegistry = exports.StackPropertyDefaults = exports.ROOT_STACK_GROUP_PATH = void 0;
+__exportStar(require("./command"), exports);
+__exportStar(require("./common"), exports);
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "ROOT_STACK_GROUP_PATH", { enumerable: true, get: function () { return constants_1.ROOT_STACK_GROUP_PATH; } });
+Object.defineProperty(exports, "StackPropertyDefaults", { enumerable: true, get: function () { return constants_1.StackPropertyDefaults; } });
+__exportStar(require("./hook"), exports);
+__exportStar(require("./resolver"), exports);
+var schemas_1 = require("./schemas");
+Object.defineProperty(exports, "createSchemaRegistry", { enumerable: true, get: function () { return schemas_1.createSchemaRegistry; } });
+Object.defineProperty(exports, "defaultSchema", { enumerable: true, get: function () { return schemas_1.defaultSchema; } });
+var stack_1 = require("./stack");
+Object.defineProperty(exports, "createStack", { enumerable: true, get: function () { return stack_1.createStack; } });
+Object.defineProperty(exports, "normalizeStackPath", { enumerable: true, get: function () { return stack_1.normalizeStackPath; } });
+var stack_group_1 = require("./stack-group");
+Object.defineProperty(exports, "createStackGroup", { enumerable: true, get: function () { return stack_group_1.createStackGroup; } });
+var util_1 = require("./util");
+Object.defineProperty(exports, "getStackName", { enumerable: true, get: function () { return util_1.getStackName; } });
+Object.defineProperty(exports, "getStackNames", { enumerable: true, get: function () { return util_1.getStackNames; } });
+Object.defineProperty(exports, "getStackPath", { enumerable: true, get: function () { return util_1.getStackPath; } });
+Object.defineProperty(exports, "getStackPaths", { enumerable: true, get: function () { return util_1.getStackPaths; } });
+Object.defineProperty(exports, "isNotObsolete", { enumerable: true, get: function () { return util_1.isNotObsolete; } });
+Object.defineProperty(exports, "isObsolete", { enumerable: true, get: function () { return util_1.isObsolete; } });
+Object.defineProperty(exports, "isWithinCommandPath", { enumerable: true, get: function () { return util_1.isWithinCommandPath; } });
+//# sourceMappingURL=index.js.map

package/dist/takomo-stacks-model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/takomo-stacks-model/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,2CAAwB;AACxB,yCAA0E;AAAjE,kHAAA,qBAAqB,OAAA;AAAE,kHAAA,qBAAqB,OAAA;AAErD,yCAAsB;AACtB,6CAA0B;AAC1B,qCASkB;AARhB,+GAAA,oBAAoB,OAAA;AACpB,wGAAA,aAAa,OAAA;AAQf,iCAUgB;AARd,oGAAA,WAAW,OAAA;AAEX,2GAAA,kBAAkB,OAAA;AAOpB,6CAMsB;AALpB,+GAAA,gBAAgB,OAAA;AAMlB,+BAQe;AAPb,oGAAA,YAAY,OAAA;AACZ,qGAAA,aAAa,OAAA;AACb,oGAAA,YAAY,OAAA;AACZ,qGAAA,aAAa,OAAA;AACb,qGAAA,aAAa,OAAA;AACb,kGAAA,UAAU,OAAA;AACV,2GAAA,mBAAmB,OAAA"}