@composurecdk/cloudformation 0.6.0 → 0.8.0

package/dist/commonjs/tagged-builder.d.ts

@@ -0,0 +1,112 @@
+/**
+ * The `name` attached to the `process.emitWarning` call when `.tag(k, v)` /
+ * `.tags({...})` overwrites an existing key. Exported so callers with
+ * layered configuration (a base builder plus per-environment refinements
+ * that intentionally override) can filter via
+ * `process.on("warning", w => { if (w.name !== TAG_OVERRIDE_WARNING_NAME) ... })`
+ * or the Node 21.3+ `--disable-warning=ComposureCDKTagOverride` CLI flag.
+ */
+export declare const TAG_OVERRIDE_WARNING_NAME = "ComposureCDKTagOverride";
+type Constructor<T> = new () => T;
+interface ObjectWithProps<Props extends object> {
+    props: Partial<Props>;
+}
+/**
+ * A fluent builder extended with tag-accumulating methods. Returned by
+ * {@link taggedBuilder}.
+ *
+ * Mirrors `IBuilder<Props, T>` from `@composurecdk/core` but rewrites every
+ * chainable return type to `ITaggedBuilder<Props, T>` so the augmenting
+ * `.tag()` / `.tags()` methods stay reachable after any prop setter or
+ * chainable method on `T`. {@link ITaggedBuilder.copy | `.copy()`} also
+ * returns a tagged builder so the chain survives variant authoring.
+ *
+ * Tags accumulated via {@link ITaggedBuilder.tag | .tag()} and
+ * {@link ITaggedBuilder.tags | .tags()} are applied to every construct in
+ * the build result — see {@link applyBuilderTags} for the exact walk.
+ *
+ * @typeParam Props - The configurable properties.
+ * @typeParam T - The target class the builder wraps.
+ */
+export type ITaggedBuilder<Props extends object, T> = {
+    [K in keyof Props]-?: ((arg: Props[K]) => ITaggedBuilder<Props, T>) & (() => Props[K]);
+} & {
+    [K in keyof T]: T[K] extends (...args: infer A) => T ? (...args: A) => ITaggedBuilder<Props, T> : T[K];
+} & {
+    /**
+     * Adds a single tag. Validates the key/value at call time and throws on
+     * AWS-rejected inputs (empty key, `aws:` prefix, oversize, disallowed
+     * characters).
+     *
+     * Repeated keys overwrite earlier values and emit a process warning so the
+     * override is visible at the call site.
+     *
+     * @param key - The tag key.
+     * @param value - The tag value.
+     * @returns The builder for chaining.
+     */
+    tag(key: string, value: string): ITaggedBuilder<Props, T>;
+    /**
+     * Adds many tags at once. Each entry is validated independently as if
+     * passed to {@link ITaggedBuilder.tag | .tag()}. Existing keys are
+     * overwritten with a process warning.
+     *
+     * @param values - A record of tag keys to values.
+     * @returns The builder for chaining.
+     */
+    tags(values: Record<string, string>): ITaggedBuilder<Props, T>;
+    /**
+     * Returns an independent tagged builder with the same configured props
+     * and a deep clone of the accumulated tags.
+     *
+     * Mirrors {@link IBuilder.copy} from `@composurecdk/core` but preserves
+     * the tagging surface. Mutations to the returned builder's tags do not
+     * affect the original, and vice versa.
+     */
+    copy(): ITaggedBuilder<Props, T>;
+};
+/**
+ * Wraps {@link Builder} to add the {@link ITaggedBuilder.tag | .tag()} and
+ * {@link ITaggedBuilder.tags | .tags()} accumulators and apply the
+ * collected tags to every construct in the build result.
+ *
+ * The wrapper maintains its own outer Proxy around the inner builder Proxy
+ * created by `@composurecdk/core`. The outer Proxy:
+ *
+ * 1. Intercepts `.tag(k, v)` and `.tags({...})` to validate inputs and
+ *    accumulate them in an insertion-ordered map. Repeated keys overwrite
+ *    earlier values and emit `process.emitWarning` so the override is
+ *    visible at the configuring call site.
+ * 2. Intercepts `build()` to call {@link applyBuilderTags} on the result
+ *    after the inner build completes.
+ * 3. Intercepts `copy()` so the returned builder is itself a tagged builder
+ *    with an independent clone of the accumulator. Without this, `.copy()`
+ *    on a tagged builder would surface the bare inner Proxy and silently
+ *    drop both the tag methods and the build-time walker.
+ * 4. Passes every other access through to the inner Proxy unchanged. Inner
+ *    methods that return the inner Proxy (chainable setters) are
+ *    re-wrapped so the chain returns the outer Proxy and the new tag
+ *    methods stay reachable.
+ *
+ * Each builder factory in the library opts in by calling `taggedBuilder()`
+ * instead of `Builder()`. Custom builders authored outside the library can
+ * use plain `Builder()` and forgo tagging.
+ *
+ * @typeParam Props - The configurable properties.
+ * @typeParam T - The target class the builder wraps.
+ *
+ * @example
+ * ```ts
+ * export function createBucketBuilder(): IBucketBuilder {
+ *   return taggedBuilder<BucketBuilderProps, BucketBuilder>(BucketBuilder);
+ * }
+ *
+ * createBucketBuilder()
+ *   .tag("Project", "claude-rig")
+ *   .tags({ Owner: "platform", Environment: "prod" })
+ *   .build(stack, "Bucket");
+ * ```
+ */
+export declare function taggedBuilder<Props extends object, T extends ObjectWithProps<Props>>(constructor: Constructor<T>): ITaggedBuilder<Props, T>;
+export {};
+//# sourceMappingURL=tagged-builder.d.ts.map

package/dist/commonjs/tagged-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagged-builder.d.ts","sourceRoot":"","sources":["../../src/tagged-builder.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB,4BAA4B,CAAC;AAEnE,KAAK,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC;AAElC,UAAU,eAAe,CAAC,KAAK,SAAS,MAAM;IAC5C,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,IAAI;KACnD,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;CACvF,GAAG;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAChD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,GACxC,CAAC,CAAC,CAAC,CAAC;CACT,GAAG;IACF;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAE/D;;;;;;;OAOG;IACH,IAAI,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,aAAa,CAAC,KAAK,SAAS,MAAM,EAAE,CAAC,SAAS,eAAe,CAAC,KAAK,CAAC,EAClF,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,GAC1B,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAG1B"}

package/dist/commonjs/tagged-builder.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TAG_OVERRIDE_WARNING_NAME = void 0;
+exports.taggedBuilder = taggedBuilder;
+const core_1 = require("@composurecdk/core");
+const apply_builder_tags_js_1 = require("./apply-builder-tags.js");
+const tag_validator_js_1 = require("./tag-validator.js");
+/**
+ * The `name` attached to the `process.emitWarning` call when `.tag(k, v)` /
+ * `.tags({...})` overwrites an existing key. Exported so callers with
+ * layered configuration (a base builder plus per-environment refinements
+ * that intentionally override) can filter via
+ * `process.on("warning", w => { if (w.name !== TAG_OVERRIDE_WARNING_NAME) ... })`
+ * or the Node 21.3+ `--disable-warning=ComposureCDKTagOverride` CLI flag.
+ */
+exports.TAG_OVERRIDE_WARNING_NAME = "ComposureCDKTagOverride";
+/**
+ * Wraps {@link Builder} to add the {@link ITaggedBuilder.tag | .tag()} and
+ * {@link ITaggedBuilder.tags | .tags()} accumulators and apply the
+ * collected tags to every construct in the build result.
+ *
+ * The wrapper maintains its own outer Proxy around the inner builder Proxy
+ * created by `@composurecdk/core`. The outer Proxy:
+ *
+ * 1. Intercepts `.tag(k, v)` and `.tags({...})` to validate inputs and
+ *    accumulate them in an insertion-ordered map. Repeated keys overwrite
+ *    earlier values and emit `process.emitWarning` so the override is
+ *    visible at the configuring call site.
+ * 2. Intercepts `build()` to call {@link applyBuilderTags} on the result
+ *    after the inner build completes.
+ * 3. Intercepts `copy()` so the returned builder is itself a tagged builder
+ *    with an independent clone of the accumulator. Without this, `.copy()`
+ *    on a tagged builder would surface the bare inner Proxy and silently
+ *    drop both the tag methods and the build-time walker.
+ * 4. Passes every other access through to the inner Proxy unchanged. Inner
+ *    methods that return the inner Proxy (chainable setters) are
+ *    re-wrapped so the chain returns the outer Proxy and the new tag
+ *    methods stay reachable.
+ *
+ * Each builder factory in the library opts in by calling `taggedBuilder()`
+ * instead of `Builder()`. Custom builders authored outside the library can
+ * use plain `Builder()` and forgo tagging.
+ *
+ * @typeParam Props - The configurable properties.
+ * @typeParam T - The target class the builder wraps.
+ *
+ * @example
+ * ```ts
+ * export function createBucketBuilder(): IBucketBuilder {
+ *   return taggedBuilder<BucketBuilderProps, BucketBuilder>(BucketBuilder);
+ * }
+ *
+ * createBucketBuilder()
+ *   .tag("Project", "claude-rig")
+ *   .tags({ Owner: "platform", Environment: "prod" })
+ *   .build(stack, "Bucket");
+ * ```
+ */
+function taggedBuilder(constructor) {
+    const inner = (0, core_1.Builder)(constructor);
+    return wrapTagged(inner, new Map());
+}
+function wrapTagged(inner, accumulator) {
+    const recordTag = (key, value) => {
+        if (accumulator.has(key)) {
+            const previous = accumulator.get(key);
+            process.emitWarning(`Tag "${key}" was already set to "${previous ?? ""}" and is being overwritten with "${value}". ` +
+                "Last write wins; remove the duplicate to silence this warning.", { type: exports.TAG_OVERRIDE_WARNING_NAME });
+        }
+        accumulator.set(key, value);
+    };
+    const buildFn = (...args) => {
+        const target = inner;
+        const result = target.build(...args);
+        (0, apply_builder_tags_js_1.applyBuilderTags)(result, accumulator);
+        return result;
+    };
+    const copyFn = () => {
+        const innerCopy = inner;
+        return wrapTagged(innerCopy.copy(), new Map(accumulator));
+    };
+    // `tagFn` / `tagsFn` and `outer` form a cycle: the interceptors return
+    // `outer` for chaining, and `outer`'s `get` trap returns the interceptors.
+    // Resolved by Proxy laziness: the `get` trap closes over the names but
+    // does not read them until a property is accessed, by which point the
+    // `const`s below have initialised.
+    const outer = new Proxy(inner, {
+        get(target, prop, receiver) {
+            if (prop === "tag")
+                return tagFn;
+            if (prop === "tags")
+                return tagsFn;
+            if (prop === "build")
+                return buildFn;
+            if (prop === "copy")
+                return copyFn;
+            const value = Reflect.get(target, prop, receiver);
+            if (typeof value === "function") {
+                return (...args) => {
+                    const ret = value.apply(target, args);
+                    return ret === inner ? outer : ret;
+                };
+            }
+            return value;
+        },
+    });
+    const tagFn = (key, value) => {
+        (0, tag_validator_js_1.validateTag)(key, value);
+        recordTag(key, value);
+        return outer;
+    };
+    const tagsFn = (values) => {
+        (0, tag_validator_js_1.validateTagRecord)(values);
+        for (const [key, value] of Object.entries(values)) {
+            recordTag(key, value);
+        }
+        return outer;
+    };
+    return outer;
+}
+//# sourceMappingURL=tagged-builder.js.map

package/dist/commonjs/tagged-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagged-builder.js","sourceRoot":"","sources":["../../src/tagged-builder.ts"],"names":[],"mappings":";;;AAyHA,sCAKC;AA9HD,6CAA4D;AAC5D,mEAA2D;AAC3D,yDAAoE;AAEpE;;;;;;;GAOG;AACU,QAAA,yBAAyB,GAAG,yBAAyB,CAAC;AAmEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,SAAgB,aAAa,CAC3B,WAA2B;IAE3B,MAAM,KAAK,GAAG,IAAA,cAAO,EAAW,WAAW,CAAC,CAAC;IAC7C,OAAO,UAAU,CAAW,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,UAAU,CACjB,KAAyB,EACzB,WAAgC;IAEhC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,KAAa,EAAQ,EAAE;QACrD,IAAI,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,CAAC,WAAW,CACjB,QAAQ,GAAG,yBAAyB,QAAQ,IAAI,EAAE,oCAAoC,KAAK,KAAK;gBAC9F,gEAAgE,EAClE,EAAE,IAAI,EAAE,iCAAyB,EAAE,CACpC,CAAC;QACJ,CAAC;QACD,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC9B,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAG,IAAe,EAAU,EAAE;QAC7C,MAAM,MAAM,GAAG,KAA0D,CAAC;QAC1E,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;QACrC,IAAA,wCAAgB,EAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,GAA6B,EAAE;QAC5C,MAAM,SAAS,GAAG,KAAsD,CAAC;QACzE,OAAO,UAAU,CAAW,SAAS,CAAC,IAAI,EAAE,EAAE,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IACtE,CAAC,CAAC;IAEF,uEAAuE;IACvE,2EAA2E;IAC3E,uEAAuE;IACvE,sEAAsE;IACtE,mCAAmC;IACnC,MAAM,KAAK,GAA6B,IAAI,KAAK,CAAC,KAAK,EAAE;QACvD,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACxB,IAAI,IAAI,KAAK,KAAK;gBAAE,OAAO,KAAK,CAAC;YACjC,IAAI,IAAI,KAAK,MAAM;gBAAE,OAAO,MAAM,CAAC;YACnC,IAAI,IAAI,KAAK,OAAO;gBAAE,OAAO,OAAO,CAAC;YACrC,IAAI,IAAI,KAAK,MAAM;gBAAE,OAAO,MAAM,CAAC;YAEnC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAY,CAAC;YAC7D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;gBAChC,OAAO,CAAC,GAAG,IAAe,EAAE,EAAE;oBAC5B,MAAM,GAAG,GAAI,KAAsC,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBACxE,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;gBACrC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAA6B,CAAC;IAE/B,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,KAAa,EAA4B,EAAE;QACrE,IAAA,8BAAW,EAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxB,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,MAAM,GAAG,CAAC,MAA8B,EAA4B,EAAE;QAC1E,IAAA,oCAAiB,EAAC,MAAM,CAAC,CAAC;QAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/commonjs/tags.d.ts

@@ -0,0 +1,91 @@
+import { type AfterBuildHook } from "@composurecdk/core";
+/**
+ * Configures cross-cutting tag application against a composed system.
+ *
+ * - `system` tags reach every construct under the top-level scope passed
+ *   to `build(scope, id)` — useful for ownership, environment, and cost
+ *   allocation tags that should apply to every resource the system creates.
+ * - `byComponent` tags reach only the scope a named component was built
+ *   into. Under {@link ComposedSystem.withStacks} or
+ *   {@link ComposedSystem.withStackStrategy}, components may live in
+ *   different stacks — `byComponent` routes the tag to whichever scope
+ *   that component received.
+ *
+ * Component keys in `byComponent` are statically typed against the
+ * composed system's component keys, matching the pattern `outputs()` uses
+ * for its `scope` field, so a typo on a component name is a compile-time
+ * error.
+ *
+ * Builder-level tags applied via `.tag()` / `.tags()` always take
+ * precedence on key conflict because they target a closer scope; CDK's
+ * native tag priority resolves the collision automatically.
+ *
+ * @typeParam T - The composed system's build result type. Inferred from
+ * the surrounding `compose(...).afterBuild(tags(...))` chain.
+ */
+export interface TagDefinitions<T extends object = object> {
+    /**
+     * Tags applied to every construct under the top-level scope. Each
+     * key/value pair is validated against the AWS tag character set; invalid
+     * inputs throw at configuration time.
+     */
+    system?: Record<string, string>;
+    /**
+     * Tags applied only to constructs under a specific component's scope.
+     * Component keys are statically checked against the composed system's
+     * component keys. Each key/value pair is validated identically to
+     * `system`.
+     */
+    byComponent?: Partial<Record<keyof T & string, Record<string, string>>>;
+}
+/**
+ * Returns an {@link AfterBuildHook} that applies cross-cutting tags to a
+ * composed system. Modelled on {@link outputs} — both share the same
+ * `(scope, id, results, componentScopes)` shape and live alongside the
+ * other CloudFormation-flavoured composition helpers in this package.
+ *
+ * The hook walks the supplied {@link TagDefinitions} once per build:
+ *
+ * - `system` entries are applied to the top-level `scope` via
+ *   `Tags.of(scope).add(...)`. CDK's tag aspect propagates each tag
+ *   through the construct subtree to every taggable descendant.
+ * - `byComponent` entries are applied to `componentScopes[key]` —
+ *   each component's own scope, which under
+ *   {@link ComposedSystem.withStacks} or
+ *   {@link ComposedSystem.withStackStrategy} may be a per-component
+ *   stack rather than the top-level scope.
+ *
+ * Tag keys and values are validated synchronously inside the hook before
+ * any `Tags.of(...).add(...)` call. Invalid tags throw and surface at the
+ * `compose(...).afterBuild(tags({...}))` site rather than at deploy time.
+ *
+ * Builder-level tags (set via `.tag()` / `.tags()` on individual builders)
+ * land on closer-scoped constructs and therefore win on key collision —
+ * CDK's tag priority resolves the collision automatically. Use builder
+ * tags for selector tags that must match exactly one resource type;
+ * use this helper for system-wide concerns like ownership, environment,
+ * and cost-allocation dimensions.
+ *
+ * @param defs - System-wide and per-component tag definitions.
+ * @returns An `AfterBuildHook` to pass to {@link ComposedSystem.afterBuild}.
+ *
+ * @example
+ * ```ts
+ * import { compose } from "@composurecdk/core";
+ * import { tags } from "@composurecdk/cloudformation";
+ *
+ * compose(
+ *   { agent: createInstanceBuilder(), bucket: createBucketBuilder() },
+ *   { agent: [], bucket: [] },
+ * )
+ *   .afterBuild(
+ *     tags({
+ *       system: { Owner: "platform", Environment: "prod" },
+ *       byComponent: { agent: { Project: "claude-rig" } },
+ *     }),
+ *   )
+ *   .build(stack, "MySystem");
+ * ```
+ */
+export declare function tags<T extends object = object>(defs: TagDefinitions<T>): AfterBuildHook<T>;
+//# sourceMappingURL=tags.d.ts.map

package/dist/commonjs/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIzD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACvD;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;CACzE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CA+B1F"}

package/dist/commonjs/tags.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tags = tags;
+const apply_builder_tags_js_1 = require("./apply-builder-tags.js");
+const tag_validator_js_1 = require("./tag-validator.js");
+/**
+ * Returns an {@link AfterBuildHook} that applies cross-cutting tags to a
+ * composed system. Modelled on {@link outputs} — both share the same
+ * `(scope, id, results, componentScopes)` shape and live alongside the
+ * other CloudFormation-flavoured composition helpers in this package.
+ *
+ * The hook walks the supplied {@link TagDefinitions} once per build:
+ *
+ * - `system` entries are applied to the top-level `scope` via
+ *   `Tags.of(scope).add(...)`. CDK's tag aspect propagates each tag
+ *   through the construct subtree to every taggable descendant.
+ * - `byComponent` entries are applied to `componentScopes[key]` —
+ *   each component's own scope, which under
+ *   {@link ComposedSystem.withStacks} or
+ *   {@link ComposedSystem.withStackStrategy} may be a per-component
+ *   stack rather than the top-level scope.
+ *
+ * Tag keys and values are validated synchronously inside the hook before
+ * any `Tags.of(...).add(...)` call. Invalid tags throw and surface at the
+ * `compose(...).afterBuild(tags({...}))` site rather than at deploy time.
+ *
+ * Builder-level tags (set via `.tag()` / `.tags()` on individual builders)
+ * land on closer-scoped constructs and therefore win on key collision —
+ * CDK's tag priority resolves the collision automatically. Use builder
+ * tags for selector tags that must match exactly one resource type;
+ * use this helper for system-wide concerns like ownership, environment,
+ * and cost-allocation dimensions.
+ *
+ * @param defs - System-wide and per-component tag definitions.
+ * @returns An `AfterBuildHook` to pass to {@link ComposedSystem.afterBuild}.
+ *
+ * @example
+ * ```ts
+ * import { compose } from "@composurecdk/core";
+ * import { tags } from "@composurecdk/cloudformation";
+ *
+ * compose(
+ *   { agent: createInstanceBuilder(), bucket: createBucketBuilder() },
+ *   { agent: [], bucket: [] },
+ * )
+ *   .afterBuild(
+ *     tags({
+ *       system: { Owner: "platform", Environment: "prod" },
+ *       byComponent: { agent: { Project: "claude-rig" } },
+ *     }),
+ *   )
+ *   .build(stack, "MySystem");
+ * ```
+ */
+function tags(defs) {
+    // Validate eagerly so configuration errors surface at the call site.
+    if (defs.system) {
+        (0, tag_validator_js_1.validateTagRecord)(defs.system);
+    }
+    const byComponent = defs.byComponent;
+    if (byComponent) {
+        for (const componentTags of Object.values(byComponent)) {
+            if (componentTags === undefined)
+                continue;
+            (0, tag_validator_js_1.validateTagRecord)(componentTags);
+        }
+    }
+    return (scope, _id, _results, componentScopes) => {
+        if (defs.system) {
+            (0, apply_builder_tags_js_1.applyTagsToConstruct)(scope, Object.entries(defs.system));
+        }
+        if (byComponent) {
+            const scopesByKey = componentScopes;
+            for (const [componentKey, componentTags] of Object.entries(byComponent)) {
+                if (componentTags === undefined)
+                    continue;
+                const target = scopesByKey[componentKey];
+                if (target === undefined) {
+                    throw new Error(`tags(): byComponent entry "${componentKey}" is not a known component.`);
+                }
+                (0, apply_builder_tags_js_1.applyTagsToConstruct)(target, Object.entries(componentTags));
+            }
+        }
+    };
+}
+//# sourceMappingURL=tags.js.map

package/dist/commonjs/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":";;AA+FA,oBA+BC;AA5HD,mEAA+D;AAC/D,yDAAuD;AA2CvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,SAAgB,IAAI,CAA4B,IAAuB;IACrE,qEAAqE;IACrE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,IAAA,oCAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,WAAW,GAAG,IAAI,CAAC,WAEZ,CAAC;IACd,IAAI,WAAW,EAAE,CAAC;QAChB,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YACvD,IAAI,aAAa,KAAK,SAAS;gBAAE,SAAS;YAC1C,IAAA,oCAAiB,EAAC,aAAa,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,eAAe,EAAE,EAAE;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAA,4CAAoB,EAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,WAAW,GAAG,eAAmE,CAAC;YACxF,KAAK,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACxE,IAAI,aAAa,KAAK,SAAS;oBAAE,SAAS;gBAC1C,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;gBACzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CAAC,8BAA8B,YAAY,6BAA6B,CAAC,CAAC;gBAC3F,CAAC;gBACD,IAAA,4CAAoB,EAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/esm/apply-builder-tags.d.ts

@@ -0,0 +1,32 @@
+import { type IConstruct } from "constructs";
+/**
+ * Applies every accumulated tag to every {@link IConstruct} reachable in a
+ * builder result.
+ *
+ * Recursively descends through plain-object literals, tagging every
+ * `IConstruct` it finds. Stops at:
+ *
+ * - **Constructs** — tagged via `Tags.of(...).add(...)`. The CDK Aspect
+ *   schedules tag application across the construct's subtree at
+ *   synth-prepare time, so the walker does not recurse into the construct's
+ *   internals.
+ * - **Class instances that aren't constructs** (e.g. `PolicyDocument`) —
+ *   skipped. Plain-object detection requires `Object.prototype` as the
+ *   prototype, so class instances are opaque to the walker.
+ * - **Arrays and primitives** — skipped.
+ *
+ * The contract this implements: every construct exposed in a builder's
+ * result type is a tag target. Wrapper shapes such as
+ * `Record<string, { construct: ..., metadata: ... }>` are unwrapped
+ * naturally — the walker descends through the plain-object value and tags
+ * the construct field. Authors do not need an opt-in marker; if a construct
+ * appears in the result, it is tagged.
+ */
+export declare function applyBuilderTags(result: object, tags: ReadonlyMap<string, string>): void;
+/**
+ * Applies every entry of `tags` to `target` via `Tags.of(target).add(...)`.
+ * Accepts any iterable of `[key, value]` pairs so callers can pass `Map`,
+ * `Object.entries(record)`, or other compatible sources without copying.
+ */
+export declare function applyTagsToConstruct(target: IConstruct, tags: Iterable<[string, string]>): void;
+//# sourceMappingURL=apply-builder-tags.d.ts.map

package/dist/esm/apply-builder-tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-builder-tags.d.ts","sourceRoot":"","sources":["../../src/apply-builder-tags.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAMxD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAGxF;AAcD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,IAAI,CAK/F"}

package/dist/esm/apply-builder-tags.js

@@ -0,0 +1,65 @@
+import { Tags } from "aws-cdk-lib";
+import { Construct } from "constructs";
+function isConstruct(value) {
+    return value !== null && typeof value === "object" && Construct.isConstruct(value);
+}
+/**
+ * Applies every accumulated tag to every {@link IConstruct} reachable in a
+ * builder result.
+ *
+ * Recursively descends through plain-object literals, tagging every
+ * `IConstruct` it finds. Stops at:
+ *
+ * - **Constructs** — tagged via `Tags.of(...).add(...)`. The CDK Aspect
+ *   schedules tag application across the construct's subtree at
+ *   synth-prepare time, so the walker does not recurse into the construct's
+ *   internals.
+ * - **Class instances that aren't constructs** (e.g. `PolicyDocument`) —
+ *   skipped. Plain-object detection requires `Object.prototype` as the
+ *   prototype, so class instances are opaque to the walker.
+ * - **Arrays and primitives** — skipped.
+ *
+ * The contract this implements: every construct exposed in a builder's
+ * result type is a tag target. Wrapper shapes such as
+ * `Record<string, { construct: ..., metadata: ... }>` are unwrapped
+ * naturally — the walker descends through the plain-object value and tags
+ * the construct field. Authors do not need an opt-in marker; if a construct
+ * appears in the result, it is tagged.
+ */
+export function applyBuilderTags(result, tags) {
+    if (tags.size === 0)
+        return;
+    walkAndTag(result, tags);
+}
+function walkAndTag(value, tags) {
+    if (isConstruct(value)) {
+        applyTagsToConstruct(value, tags);
+        return;
+    }
+    if (isPlainObject(value)) {
+        for (const inner of Object.values(value)) {
+            walkAndTag(inner, tags);
+        }
+    }
+}
+/**
+ * Applies every entry of `tags` to `target` via `Tags.of(target).add(...)`.
+ * Accepts any iterable of `[key, value]` pairs so callers can pass `Map`,
+ * `Object.entries(record)`, or other compatible sources without copying.
+ */
+export function applyTagsToConstruct(target, tags) {
+    const t = Tags.of(target);
+    for (const [key, value] of tags) {
+        t.add(key, value);
+    }
+}
+function isPlainObject(value) {
+    if (value === null || typeof value !== "object" || Array.isArray(value))
+        return false;
+    // Accept both `{...}` literals and `Object.create(null)` dictionaries — the
+    // latter is a common idiom for prototype-pollution-safe key/value maps and
+    // would otherwise be silently skipped here.
+    const proto = Object.getPrototypeOf(value);
+    return proto === null || proto === Object.prototype;
+}
+//# sourceMappingURL=apply-builder-tags.js.map

package/dist/esm/apply-builder-tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-builder-tags.js","sourceRoot":"","sources":["../../src/apply-builder-tags.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,SAAS,EAAmB,MAAM,YAAY,CAAC;AAExD,SAAS,WAAW,CAAC,KAAc;IACjC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;AACrF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,IAAiC;IAChF,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO;IAC5B,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,UAAU,CAAC,KAAc,EAAE,IAAiC;IACnE,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO;IACT,CAAC;IACD,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACzC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAkB,EAAE,IAAgC;IACvF,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACtF,4EAA4E;IAC5E,2EAA2E;IAC3E,4CAA4C;IAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAkB,CAAC;IAC5D,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACtD,CAAC"}

package/dist/esm/index.d.ts

@@ -0,0 +1,8 @@
+export { createStackBuilder, type IStackBuilder, type StackBuilderResult, } from "./stack-builder.js";
+export { singleStack, groupedStacks } from "./strategies.js";
+export { outputs, type OutputDefinition, type OutputDefinitions } from "./outputs.js";
+export { taggedBuilder, type ITaggedBuilder, TAG_OVERRIDE_WARNING_NAME } from "./tagged-builder.js";
+export { applyBuilderTags } from "./apply-builder-tags.js";
+export { validateTag } from "./tag-validator.js";
+export { tags, type TagDefinitions } from "./tags.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,8 @@
+export { createStackBuilder, } from "./stack-builder.js";
+export { singleStack, groupedStacks } from "./strategies.js";
+export { outputs } from "./outputs.js";
+export { taggedBuilder, TAG_OVERRIDE_WARNING_NAME } from "./tagged-builder.js";
+export { applyBuilderTags } from "./apply-builder-tags.js";
+export { validateTag } from "./tag-validator.js";
+export { tags } from "./tags.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,GAGnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAiD,MAAM,cAAc,CAAC;AACtF,OAAO,EAAE,aAAa,EAAuB,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAuB,MAAM,WAAW,CAAC"}

package/dist/esm/outputs.d.ts

@@ -0,0 +1,84 @@
+import { type IConstruct } from "constructs";
+import { type AfterBuildHook, type Resolvable } from "@composurecdk/core";
+/**
+ * Defines a CloudFormation stack output with a value that can be a
+ * {@link Resolvable} — either a concrete string or a {@link Ref} that
+ * resolves against the system's build results at build time.
+ *
+ * @typeParam T - The composed system's build result type. When `outputs()`
+ * is passed to {@link ComposedSystem.afterBuild | .afterBuild()} the type
+ * is inferred, making `scope` component keys statically checked.
+ */
+export interface OutputDefinition<T extends object = object> {
+    /** The output value, or a Ref that resolves to one. */
+    value: Resolvable<string>;
+    /** A description of the output. */
+    description?: string;
+    /**
+     * The name under which the output is exported for cross-stack references.
+     * When set, this creates a CloudFormation Export.
+     */
+    exportName?: string;
+    /**
+     * The scope to attach this output to. Either an `IConstruct` (typically a
+     * Stack reference held by the caller — useful with
+     * {@link ComposedSystem.withStacks | .withStacks()}) or the string key of
+     * a component in the composed system, in which case the output lands in
+     * whichever scope that component was built into (useful with
+     * {@link ComposedSystem.withStackStrategy | .withStackStrategy()}).
+     *
+     * When omitted, the output falls back to the top-level scope passed to
+     * `build()` — the same scope the `AfterBuildHook` receives.
+     */
+    scope?: IConstruct | (keyof T & string);
+}
+/**
+ * A record of output definitions keyed by logical output name.
+ */
+export type OutputDefinitions<T extends object = object> = Record<string, OutputDefinition<T>>;
+/**
+ * Returns an {@link AfterBuildHook} that creates CloudFormation stack outputs
+ * from the composed system's build results.
+ *
+ * Each output definition's `value` can be a concrete string or a {@link Ref}
+ * that is resolved against the build results. An optional `scope` routes
+ * individual outputs to specific stacks — either as a direct `IConstruct`
+ * or as a component key string (statically typed against the composed
+ * system's component keys).
+ *
+ * Intended for use with {@link ComposedSystem.afterBuild}.
+ *
+ * @param defs - A record of output definitions keyed by logical name.
+ * @returns An {@link AfterBuildHook} that creates `CfnOutput` constructs.
+ *
+ * @example
+ * ```ts
+ * import { compose, ref } from "@composurecdk/core";
+ * import { outputs } from "@composurecdk/cloudformation";
+ *
+ * compose(
+ *   { site: createBucketBuilder(), cdn: createDistributionBuilder(), dns: createZoneBuilder() },
+ *   { site: [], cdn: ["site"], dns: [] },
+ * )
+ *   .withStacks({ site: siteStack, cdn: siteStack, dns: dnsStack })
+ *   .afterBuild(outputs({
+ *     DistributionUrl: {
+ *       value: ref("cdn", (r: DistributionBuilderResult) =>
+ *         `https://${r.distribution.distributionDomainName}`),
+ *       scope: "cdn",
+ *     },
+ *     BucketName: {
+ *       value: ref("site", (r: BucketBuilderResult) => r.bucket.bucketName),
+ *       scope: siteStack,
+ *     },
+ *     NameServers: {
+ *       value: ref("dns", (r: ZoneBuilderResult) =>
+ *         Fn.join(",", r.zone.hostedZoneNameServers!)),
+ *       scope: "dns",
+ *     },
+ *   }))
+ *   .build(app, "StaticWebsite");
+ * ```
+ */
+export declare function outputs<T extends object = object>(defs: OutputDefinitions<T>): AfterBuildHook<T>;
+//# sourceMappingURL=outputs.d.ts.map

package/dist/esm/outputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputs.d.ts","sourceRoot":"","sources":["../../src/outputs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,UAAU,EAAW,MAAM,oBAAoB,CAAC;AAEnF;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACzD,uDAAuD;IACvD,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAE1B,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CA0BhG"}