@composurecdk/cloudwatch 0.8.3 → 0.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,13 +7,15 @@ declare const alarmNameBrand: unique symbol;
7
7
  export type AlarmName = string & {
8
8
  readonly [alarmNameBrand]: true;
9
9
  };
10
+ /** Validates a CloudWatch alarm name against {@link ALARM_NAME}. @throws on invalid input. */
11
+ export declare function validateAlarmName(value: string): void;
10
12
  /**
11
- * Validates and brands a string as an {@link AlarmName}. The string is used
12
- * verbatim no sanitisation — so what the caller writes is exactly what
13
- * appears in CloudWatch.
13
+ * Validates and brands a string as an {@link AlarmName}. Surrounding whitespace
14
+ * is trimmed, then the value is used verbatim — so what the caller writes is
15
+ * exactly what appears in CloudWatch.
14
16
  *
15
17
  * @throws If the input is empty, exceeds 255 chars, or contains characters
16
- * outside CloudWatch's allowed set: `[A-Za-z0-9-_./#:()+ =@]`.
18
+ * outside CloudWatch's allowed set.
17
19
  */
18
20
  export declare function alarmName(input: string): AlarmName;
19
21
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"alarm-name.d.ts","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAKrE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAclD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,SAAS,CAG/E;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C"}
1
+ {"version":3,"file":"alarm-name.d.ts","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AAEA,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAiBrE,8FAA8F;AAC9F,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAErD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAIlD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,SAAS,CAG/E;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C"}
@@ -1,29 +1,38 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateAlarmName = validateAlarmName;
3
4
  exports.alarmName = alarmName;
4
5
  exports.joinAlarmName = joinAlarmName;
5
6
  exports.kebab = kebab;
6
- const VALID_CHARS = /^[A-Za-z0-9\-_./#:()+ =@]+$/;
7
- const MAX_LEN = 255;
7
+ const cloudformation_1 = require("@composurecdk/cloudformation");
8
8
  /**
9
- * Validates and brands a string as an {@link AlarmName}. The string is used
10
- * verbatim no sanitisation so what the caller writes is exactly what
11
- * appears in CloudWatch.
9
+ * The CloudWatch AlarmName constraint. Its character set is exactly the shared
10
+ * `charSets.ALNUM` + `charSets.AWS_NAME_PUNCT` spine with no property-specific
11
+ * tail a clean reuse of the catalogue fragments. See ADR-0010.
12
+ */
13
+ const ALARM_NAME = (0, cloudformation_1.stringConstraint)({
14
+ name: "CloudWatch AlarmName",
15
+ charClass: `${cloudformation_1.charSets.ALNUM}${cloudformation_1.charSets.AWS_NAME_PUNCT}`,
16
+ minLength: 1,
17
+ maxLength: 255,
18
+ allowed: "A-Z a-z 0-9 space and - _ . / # : ( ) + = @",
19
+ source: "https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html",
20
+ });
21
+ /** Validates a CloudWatch alarm name against {@link ALARM_NAME}. @throws on invalid input. */
22
+ function validateAlarmName(value) {
23
+ (0, cloudformation_1.validateString)(value, ALARM_NAME);
24
+ }
25
+ /**
26
+ * Validates and brands a string as an {@link AlarmName}. Surrounding whitespace
27
+ * is trimmed, then the value is used verbatim — so what the caller writes is
28
+ * exactly what appears in CloudWatch.
12
29
  *
13
30
  * @throws If the input is empty, exceeds 255 chars, or contains characters
14
- * outside CloudWatch's allowed set: `[A-Za-z0-9-_./#:()+ =@]`.
31
+ * outside CloudWatch's allowed set.
15
32
  */
16
33
  function alarmName(input) {
17
34
  const trimmed = input.trim();
18
- if (trimmed.length === 0) {
19
- throw new Error("alarm name cannot be empty");
20
- }
21
- if (trimmed.length > MAX_LEN) {
22
- throw new Error(`alarm name exceeds ${String(MAX_LEN)} chars: "${trimmed}"`);
23
- }
24
- if (!VALID_CHARS.test(trimmed)) {
25
- throw new Error(`alarm name contains invalid characters (allowed: A-Z a-z 0-9 - _ . / # : ( ) + = @ space): "${trimmed}"`);
26
- }
35
+ validateAlarmName(trimmed);
27
36
  return trimmed;
28
37
  }
29
38
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"alarm-name.js","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":";;AAoBA,8BAcC;AAQD,sCAGC;AAMD,sBAQC;AAlDD,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAClD,MAAM,OAAO,GAAG,GAAG,CAAC;AAEpB;;;;;;;GAOG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,CAAC,OAAO,CAAC,YAAY,OAAO,GAAG,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,+FAA+F,OAAO,GAAG,CAC1G,CAAC;IACJ,CAAC;IACD,OAAO,OAAoB,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,QAA2B,EAAE,GAAG,GAAG,GAAG;IAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9D,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,KAAa;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE,CAAC;AACnB,CAAC"}
1
+ {"version":3,"file":"alarm-name.js","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":";;AA2BA,8CAEC;AAUD,8BAIC;AAQD,sCAGC;AAMD,sBAQC;AApED,iEAA0F;AAW1F;;;;GAIG;AACH,MAAM,UAAU,GAAG,IAAA,iCAAgB,EAAC;IAClC,IAAI,EAAE,sBAAsB;IAC5B,SAAS,EAAE,GAAG,yBAAQ,CAAC,KAAK,GAAG,yBAAQ,CAAC,cAAc,EAAE;IACxD,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,GAAG;IACd,OAAO,EAAE,6CAA6C;IACtD,MAAM,EACJ,0FAA0F;CAC7F,CAAC,CAAC;AAEH,8FAA8F;AAC9F,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,IAAA,+BAAc,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO,OAAoB,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,QAA2B,EAAE,GAAG,GAAG,GAAG;IAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9D,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CAAC,KAAa;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE,CAAC;AACnB,CAAC"}
@@ -1,3 +1,4 @@
1
+ import { validateAlarmName } from "./alarm-name.js";
1
2
  export type { AlarmConfig, AlarmConfigDefaults } from "./alarm-config.js";
2
3
  export type { AlarmDefinition, AlarmMetric } from "./alarm-definition.js";
3
4
  export { AlarmDefinitionBuilder } from "./alarm-definition-builder.js";
@@ -8,4 +9,17 @@ export { resolveAlarmConfig, type ResolvedAlarmConfig } from "./resolve-alarm-co
8
9
  export { alarmActionsPolicy } from "./policies/alarm-actions-policy.js";
9
10
  export type { AlarmActionsPolicyConfig, AlarmMatchContext, AlarmMatcher, } from "./policies/alarm-actions-policy.js";
10
11
  export { alarmNamePolicy, type AlarmNamePolicyConfig, type AlarmNameRule, type AlarmNameTransformContext, } from "./policies/alarm-name-policy.js";
12
+ /**
13
+ * This package's AWS-property constraints, grouped by application strategy.
14
+ * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical in
15
+ * every builder package; the underlying constraint definition stays
16
+ * module-private. The branded {@link alarmName} constructor layers on top of the
17
+ * same validation. See ADR-0010.
18
+ */
19
+ export declare const constraints: {
20
+ validate: {
21
+ alarmName: typeof validateAlarmName;
22
+ };
23
+ sanitize: {};
24
+ };
11
25
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,SAAS,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,YAAY,EACV,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,yBAAyB,GAC/B,MAAM,iCAAiC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,SAAS,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,YAAY,EACV,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,yBAAyB,GAC/B,MAAM,iCAAiC,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;CAGO,CAAC"}
@@ -1,10 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.alarmNamePolicy = exports.alarmActionsPolicy = exports.resolveAlarmConfig = exports.createAlarms = exports.defaultAlarmName = exports.alarmName = exports.AlarmDefinitionBuilder = void 0;
3
+ exports.constraints = exports.alarmNamePolicy = exports.alarmActionsPolicy = exports.resolveAlarmConfig = exports.createAlarms = exports.defaultAlarmName = exports.alarmName = exports.AlarmDefinitionBuilder = void 0;
4
+ const alarm_name_js_1 = require("./alarm-name.js");
4
5
  var alarm_definition_builder_js_1 = require("./alarm-definition-builder.js");
5
6
  Object.defineProperty(exports, "AlarmDefinitionBuilder", { enumerable: true, get: function () { return alarm_definition_builder_js_1.AlarmDefinitionBuilder; } });
6
- var alarm_name_js_1 = require("./alarm-name.js");
7
- Object.defineProperty(exports, "alarmName", { enumerable: true, get: function () { return alarm_name_js_1.alarmName; } });
7
+ var alarm_name_js_2 = require("./alarm-name.js");
8
+ Object.defineProperty(exports, "alarmName", { enumerable: true, get: function () { return alarm_name_js_2.alarmName; } });
8
9
  var default_alarm_name_js_1 = require("./default-alarm-name.js");
9
10
  Object.defineProperty(exports, "defaultAlarmName", { enumerable: true, get: function () { return default_alarm_name_js_1.defaultAlarmName; } });
10
11
  var create_alarms_js_1 = require("./create-alarms.js");
@@ -15,4 +16,15 @@ var alarm_actions_policy_js_1 = require("./policies/alarm-actions-policy.js");
15
16
  Object.defineProperty(exports, "alarmActionsPolicy", { enumerable: true, get: function () { return alarm_actions_policy_js_1.alarmActionsPolicy; } });
16
17
  var alarm_name_policy_js_1 = require("./policies/alarm-name-policy.js");
17
18
  Object.defineProperty(exports, "alarmNamePolicy", { enumerable: true, get: function () { return alarm_name_policy_js_1.alarmNamePolicy; } });
19
+ /**
20
+ * This package's AWS-property constraints, grouped by application strategy.
21
+ * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical in
22
+ * every builder package; the underlying constraint definition stays
23
+ * module-private. The branded {@link alarmName} constructor layers on top of the
24
+ * same validation. See ADR-0010.
25
+ */
26
+ exports.constraints = {
27
+ validate: { alarmName: alarm_name_js_1.validateAlarmName },
28
+ sanitize: {},
29
+ };
18
30
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAEA,6EAAuE;AAA9D,qIAAA,sBAAsB,OAAA;AAC/B,iDAA4D;AAAnC,0GAAA,SAAS,OAAA;AAClC,iEAA2D;AAAlD,yHAAA,gBAAgB,OAAA;AACzB,uDAAkD;AAAzC,gHAAA,YAAY,OAAA;AACrB,qEAAyF;AAAhF,6HAAA,kBAAkB,OAAA;AAC3B,8EAAwE;AAA/D,6HAAA,kBAAkB,OAAA;AAM3B,wEAKyC;AAJvC,uHAAA,eAAe,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,mDAAoD;AAIpD,6EAAuE;AAA9D,qIAAA,sBAAsB,OAAA;AAC/B,iDAA4D;AAAnC,0GAAA,SAAS,OAAA;AAClC,iEAA2D;AAAlD,yHAAA,gBAAgB,OAAA;AACzB,uDAAkD;AAAzC,gHAAA,YAAY,OAAA;AACrB,qEAAyF;AAAhF,6HAAA,kBAAkB,OAAA;AAC3B,8EAAwE;AAA/D,6HAAA,kBAAkB,OAAA;AAM3B,wEAKyC;AAJvC,uHAAA,eAAe,OAAA;AAMjB;;;;;;GAMG;AACU,QAAA,WAAW,GAAG;IACzB,QAAQ,EAAE,EAAE,SAAS,EAAE,iCAAiB,EAAE;IAC1C,QAAQ,EAAE,EAAE;CACiB,CAAC"}
@@ -7,13 +7,15 @@ declare const alarmNameBrand: unique symbol;
7
7
  export type AlarmName = string & {
8
8
  readonly [alarmNameBrand]: true;
9
9
  };
10
+ /** Validates a CloudWatch alarm name against {@link ALARM_NAME}. @throws on invalid input. */
11
+ export declare function validateAlarmName(value: string): void;
10
12
  /**
11
- * Validates and brands a string as an {@link AlarmName}. The string is used
12
- * verbatim no sanitisation — so what the caller writes is exactly what
13
- * appears in CloudWatch.
13
+ * Validates and brands a string as an {@link AlarmName}. Surrounding whitespace
14
+ * is trimmed, then the value is used verbatim — so what the caller writes is
15
+ * exactly what appears in CloudWatch.
14
16
  *
15
17
  * @throws If the input is empty, exceeds 255 chars, or contains characters
16
- * outside CloudWatch's allowed set: `[A-Za-z0-9-_./#:()+ =@]`.
18
+ * outside CloudWatch's allowed set.
17
19
  */
18
20
  export declare function alarmName(input: string): AlarmName;
19
21
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"alarm-name.d.ts","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAKrE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAclD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,SAAS,CAG/E;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C"}
1
+ {"version":3,"file":"alarm-name.d.ts","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AAEA,OAAO,CAAC,MAAM,cAAc,EAAE,OAAO,MAAM,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,CAAC,cAAc,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAiBrE,8FAA8F;AAC9F,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAErD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAIlD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,SAAM,GAAG,SAAS,CAG/E;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQ3C"}
@@ -1,24 +1,32 @@
1
- const VALID_CHARS = /^[A-Za-z0-9\-_./#:()+ =@]+$/;
2
- const MAX_LEN = 255;
1
+ import { charSets, stringConstraint, validateString } from "@composurecdk/cloudformation";
3
2
  /**
4
- * Validates and brands a string as an {@link AlarmName}. The string is used
5
- * verbatim no sanitisation so what the caller writes is exactly what
6
- * appears in CloudWatch.
3
+ * The CloudWatch AlarmName constraint. Its character set is exactly the shared
4
+ * `charSets.ALNUM` + `charSets.AWS_NAME_PUNCT` spine with no property-specific
5
+ * tail a clean reuse of the catalogue fragments. See ADR-0010.
6
+ */
7
+ const ALARM_NAME = stringConstraint({
8
+ name: "CloudWatch AlarmName",
9
+ charClass: `${charSets.ALNUM}${charSets.AWS_NAME_PUNCT}`,
10
+ minLength: 1,
11
+ maxLength: 255,
12
+ allowed: "A-Z a-z 0-9 space and - _ . / # : ( ) + = @",
13
+ source: "https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html",
14
+ });
15
+ /** Validates a CloudWatch alarm name against {@link ALARM_NAME}. @throws on invalid input. */
16
+ export function validateAlarmName(value) {
17
+ validateString(value, ALARM_NAME);
18
+ }
19
+ /**
20
+ * Validates and brands a string as an {@link AlarmName}. Surrounding whitespace
21
+ * is trimmed, then the value is used verbatim — so what the caller writes is
22
+ * exactly what appears in CloudWatch.
7
23
  *
8
24
  * @throws If the input is empty, exceeds 255 chars, or contains characters
9
- * outside CloudWatch's allowed set: `[A-Za-z0-9-_./#:()+ =@]`.
25
+ * outside CloudWatch's allowed set.
10
26
  */
11
27
  export function alarmName(input) {
12
28
  const trimmed = input.trim();
13
- if (trimmed.length === 0) {
14
- throw new Error("alarm name cannot be empty");
15
- }
16
- if (trimmed.length > MAX_LEN) {
17
- throw new Error(`alarm name exceeds ${String(MAX_LEN)} chars: "${trimmed}"`);
18
- }
19
- if (!VALID_CHARS.test(trimmed)) {
20
- throw new Error(`alarm name contains invalid characters (allowed: A-Z a-z 0-9 - _ . / # : ( ) + = @ space): "${trimmed}"`);
21
- }
29
+ validateAlarmName(trimmed);
22
30
  return trimmed;
23
31
  }
24
32
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"alarm-name.js","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAClD,MAAM,OAAO,GAAG,GAAG,CAAC;AAEpB;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,sBAAsB,MAAM,CAAC,OAAO,CAAC,YAAY,OAAO,GAAG,CAAC,CAAC;IAC/E,CAAC;IACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,+FAA+F,OAAO,GAAG,CAC1G,CAAC;IACJ,CAAC;IACD,OAAO,OAAoB,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,QAA2B,EAAE,GAAG,GAAG,GAAG;IAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9D,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,KAAa;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE,CAAC;AACnB,CAAC"}
1
+ {"version":3,"file":"alarm-name.js","sourceRoot":"","sources":["../../src/alarm-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAW1F;;;;GAIG;AACH,MAAM,UAAU,GAAG,gBAAgB,CAAC;IAClC,IAAI,EAAE,sBAAsB;IAC5B,SAAS,EAAE,GAAG,QAAQ,CAAC,KAAK,GAAG,QAAQ,CAAC,cAAc,EAAE;IACxD,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,GAAG;IACd,OAAO,EAAE,6CAA6C;IACtD,MAAM,EACJ,0FAA0F;CAC7F,CAAC,CAAC;AAEH,8FAA8F;AAC9F,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC3B,OAAO,OAAoB,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,QAA2B,EAAE,GAAG,GAAG,GAAG;IAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9D,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,KAAa;IACjC,OAAO,KAAK;SACT,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,OAAO,CAAC,uBAAuB,EAAE,OAAO,CAAC;SACzC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE,CAAC;AACnB,CAAC"}
@@ -1,3 +1,4 @@
1
+ import { validateAlarmName } from "./alarm-name.js";
1
2
  export type { AlarmConfig, AlarmConfigDefaults } from "./alarm-config.js";
2
3
  export type { AlarmDefinition, AlarmMetric } from "./alarm-definition.js";
3
4
  export { AlarmDefinitionBuilder } from "./alarm-definition-builder.js";
@@ -8,4 +9,17 @@ export { resolveAlarmConfig, type ResolvedAlarmConfig } from "./resolve-alarm-co
8
9
  export { alarmActionsPolicy } from "./policies/alarm-actions-policy.js";
9
10
  export type { AlarmActionsPolicyConfig, AlarmMatchContext, AlarmMatcher, } from "./policies/alarm-actions-policy.js";
10
11
  export { alarmNamePolicy, type AlarmNamePolicyConfig, type AlarmNameRule, type AlarmNameTransformContext, } from "./policies/alarm-name-policy.js";
12
+ /**
13
+ * This package's AWS-property constraints, grouped by application strategy.
14
+ * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical in
15
+ * every builder package; the underlying constraint definition stays
16
+ * module-private. The branded {@link alarmName} constructor layers on top of the
17
+ * same validation. See ADR-0010.
18
+ */
19
+ export declare const constraints: {
20
+ validate: {
21
+ alarmName: typeof validateAlarmName;
22
+ };
23
+ sanitize: {};
24
+ };
11
25
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,SAAS,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,YAAY,EACV,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,yBAAyB,GAC/B,MAAM,iCAAiC,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,KAAK,SAAS,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,YAAY,EACV,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,GACb,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,eAAe,EACf,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,yBAAyB,GAC/B,MAAM,iCAAiC,CAAC;AAEzC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;CAGO,CAAC"}
package/dist/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { validateAlarmName } from "./alarm-name.js";
1
2
  export { AlarmDefinitionBuilder } from "./alarm-definition-builder.js";
2
3
  export { alarmName } from "./alarm-name.js";
3
4
  export { defaultAlarmName } from "./default-alarm-name.js";
@@ -5,4 +6,15 @@ export { createAlarms } from "./create-alarms.js";
5
6
  export { resolveAlarmConfig } from "./resolve-alarm-config.js";
6
7
  export { alarmActionsPolicy } from "./policies/alarm-actions-policy.js";
7
8
  export { alarmNamePolicy, } from "./policies/alarm-name-policy.js";
9
+ /**
10
+ * This package's AWS-property constraints, grouped by application strategy.
11
+ * The `constraints.validate.*` / `constraints.sanitize.*` shape is identical in
12
+ * every builder package; the underlying constraint definition stays
13
+ * module-private. The branded {@link alarmName} constructor layers on top of the
14
+ * same validation. See ADR-0010.
15
+ */
16
+ export const constraints = {
17
+ validate: { alarmName: validateAlarmName },
18
+ sanitize: {},
19
+ };
8
20
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAkB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAA4B,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAMxE,OAAO,EACL,eAAe,GAIhB,MAAM,iCAAiC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAIpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAkB,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAA4B,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AAMxE,OAAO,EACL,eAAe,GAIhB,MAAM,iCAAiC,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,EAAE,SAAS,EAAE,iBAAiB,EAAE;IAC1C,QAAQ,EAAE,EAAE;CACiB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@composurecdk/cloudwatch",
3
- "version": "0.8.3",
3
+ "version": "0.8.4",
4
4
  "description": "Composable CloudWatch alarm primitives for composureCDK resource packages",
5
5
  "repository": {
6
6
  "type": "git",
@@ -37,6 +37,7 @@
37
37
  }
38
38
  },
39
39
  "peerDependencies": {
40
+ "@composurecdk/cloudformation": "^0.8.0",
40
41
  "aws-cdk-lib": "^2.1.0",
41
42
  "constructs": "^10.0.0"
42
43
  },