@composurecdk/core 0.3.5 → 0.3.6

package/dist/construct-id.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Utilities for producing safe CDK construct IDs from arbitrary strings.
+ *
+ * The `constructs` library uses `/` as the path separator between construct
+ * IDs. When user-supplied strings (DNS names, ARNs, filesystem paths) are
+ * passed through to a construct ID, any embedded `/` silently gets rewritten
+ * to `--`, which produces unreadable CloudFormation logical IDs. Control
+ * characters are likewise unsafe.
+ *
+ * These helpers consolidate that sanitization in one place so every builder
+ * in the monorepo applies the same constraints.
+ */
+/**
+ * Return a construct-ID-safe copy of `raw` by replacing unsafe characters
+ * (`/` and control characters) with a single `-`.
+ *
+ * Does not touch other characters — CDK construct IDs are otherwise
+ * permissive, and collapsing further (e.g., to PascalCase) would destroy
+ * information a reader expects to see in the synthesised tree.
+ *
+ * @example
+ * ```ts
+ * sanitizeConstructId("a/b")       // "a-b"
+ * sanitizeConstructId("_sip._tcp") // "_sip._tcp" (unchanged)
+ * ```
+ */
+export declare function sanitizeConstructId(raw: string): string;
+/**
+ * Join the supplied parts into a single construct ID. Falsy parts are
+ * dropped; each remaining part is passed through {@link sanitizeConstructId}
+ * and the results are joined with `-`.
+ *
+ * Intended for composing IDs from a mix of static prefixes and user-supplied
+ * fragments — the sanitization step means callers don't have to reason about
+ * what characters their inputs might contain.
+ *
+ * @example
+ * ```ts
+ * constructId("records", "a", "api")   // "records-a-api"
+ * constructId("zone", undefined, "www") // "zone-www"
+ * constructId("records", "a/b")         // "records-a-b"
+ * ```
+ */
+export declare function constructId(...parts: readonly (string | undefined | null | false)[]): string;
+//# sourceMappingURL=construct-id.d.ts.map

package/dist/construct-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"construct-id.d.ts","sourceRoot":"","sources":["../src/construct-id.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,GAAG,KAAK,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC,EAAE,GAAG,MAAM,CAK5F"}

package/dist/construct-id.js

@@ -0,0 +1,54 @@
+/**
+ * Utilities for producing safe CDK construct IDs from arbitrary strings.
+ *
+ * The `constructs` library uses `/` as the path separator between construct
+ * IDs. When user-supplied strings (DNS names, ARNs, filesystem paths) are
+ * passed through to a construct ID, any embedded `/` silently gets rewritten
+ * to `--`, which produces unreadable CloudFormation logical IDs. Control
+ * characters are likewise unsafe.
+ *
+ * These helpers consolidate that sanitization in one place so every builder
+ * in the monorepo applies the same constraints.
+ */
+// eslint-disable-next-line no-control-regex
+const UNSAFE = /[/\x00-\x1f\x7f]/g;
+/**
+ * Return a construct-ID-safe copy of `raw` by replacing unsafe characters
+ * (`/` and control characters) with a single `-`.
+ *
+ * Does not touch other characters — CDK construct IDs are otherwise
+ * permissive, and collapsing further (e.g., to PascalCase) would destroy
+ * information a reader expects to see in the synthesised tree.
+ *
+ * @example
+ * ```ts
+ * sanitizeConstructId("a/b")       // "a-b"
+ * sanitizeConstructId("_sip._tcp") // "_sip._tcp" (unchanged)
+ * ```
+ */
+export function sanitizeConstructId(raw) {
+    return raw.replace(UNSAFE, "-");
+}
+/**
+ * Join the supplied parts into a single construct ID. Falsy parts are
+ * dropped; each remaining part is passed through {@link sanitizeConstructId}
+ * and the results are joined with `-`.
+ *
+ * Intended for composing IDs from a mix of static prefixes and user-supplied
+ * fragments — the sanitization step means callers don't have to reason about
+ * what characters their inputs might contain.
+ *
+ * @example
+ * ```ts
+ * constructId("records", "a", "api")   // "records-a-api"
+ * constructId("zone", undefined, "www") // "zone-www"
+ * constructId("records", "a/b")         // "records-a-b"
+ * ```
+ */
+export function constructId(...parts) {
+    return parts
+        .filter((p) => typeof p === "string" && p.length > 0)
+        .map(sanitizeConstructId)
+        .join("-");
+}
+//# sourceMappingURL=construct-id.js.map

package/dist/construct-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"construct-id.js","sourceRoot":"","sources":["../src/construct-id.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,4CAA4C;AAC5C,MAAM,MAAM,GAAG,mBAAmB,CAAC;AAEnC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAW;IAC7C,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAC,GAAG,KAAqD;IAClF,OAAO,KAAK;SACT,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;SACjE,GAAG,CAAC,mBAAmB,CAAC;SACxB,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { Builder, type IBuilder } from "./builder.js";
+export { constructId, sanitizeConstructId } from "./construct-id.js";
 export { compose, type ComposedSystem, type ConfiguredSystem, type AfterBuildHook, } from "./compose.js";
 export { CyclicDependencyError } from "./cyclic-dependency-error.js";
 export { type Lifecycle } from "./lifecycle.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,WAAW,EACX,aAAa,GACd,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,WAAW,EACX,aAAa,GACd,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
 export { Builder } from "./builder.js";
+export { constructId, sanitizeConstructId } from "./construct-id.js";
 export { compose, } from "./compose.js";
 export { CyclicDependencyError } from "./cyclic-dependency-error.js";
 export { Ref, ref, resolve, isRef } from "./ref.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,cAAc,CAAC;AACtD,OAAO,EACL,OAAO,GAIR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAmB,MAAM,UAAU,CAAC;AACrE,OAAO,EAGL,WAAW,EACX,aAAa,GACd,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,OAAO,GAIR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAmB,MAAM,UAAU,CAAC;AACrE,OAAO,EAGL,WAAW,EACX,aAAa,GACd,MAAM,qBAAqB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@composurecdk/core",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Composable CDK component system — lifecycle, dependency resolution, and builder pattern",
   "repository": {
     "type": "git",