@twin.org/core 0.0.3-next.33 → 0.0.3-next.35

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.
Files changed (5) hide show
  1. package/dist/es/models/IHealth.js.map +1 -1
  2. package/dist/types/models/IHealth.d.ts +10 -10
  3. package/docs/changelog.md +34 -0
  4. package/docs/reference/interfaces/IHealth.md +17 -17
  5. package/package.json +2 -2
package/dist/es/models/IHealth.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IHealth.js","sourceRoot":"","sources":["../../../src/models/IHealth.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * Provides health information for a component.\n */\nexport interface IHealth {\n\t/**\n\t * The name of the component.\n\t */\n\tname: string;\n\n\t/**\n\t * The description of the component as an i18n key.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Whether this entry is a child of another entry, the parent entry will report the overall status of the component.\n\t */\n\tisChild?: boolean;\n\n\t/**\n\t * The overall status of the component, the entries can also report their own health.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The details for the status if there are further details to provide as an i18n key.\n\t */\n\tdetails?: string;\n\n\t/**\n\t * Properties to substitute in the i18n key for the details.\n\t */\n\tproperties?: { [id: string]: unknown };\n}\n"]}
1
+ {"version":3,"file":"IHealth.js","sourceRoot":"","sources":["../../../src/models/IHealth.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * Provides health information for a component.\n */\nexport interface IHealth {\n\t/**\n\t * The source of the health information.\n\t */\n\tsource: string;\n\n\t/**\n\t * The description of the component as an i18n key.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * The overall status of the component, the entries can also report their own health.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The message for the status if there are further details to provide as an i18n key.\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Data to substitute in the i18n key for the message.\n\t */\n\tdata?: { [id: string]: unknown };\n\n\t/**\n\t * The grouped child components, if any.\n\t */\n\tgrouped?: IHealth[];\n}\n"]}
package/dist/types/models/IHealth.d.ts CHANGED
@@ -4,29 +4,29 @@ import type { HealthStatus } from "./healthStatus.js";
4
4
  */
5
5
  export interface IHealth {
6
6
  /**
7
- * The name of the component.
7
+ * The source of the health information.
8
8
  */
9
- name: string;
9
+ source: string;
10
10
  /**
11
11
  * The description of the component as an i18n key.
12
12
  */
13
13
  description?: string;
14
- /**
15
- * Whether this entry is a child of another entry, the parent entry will report the overall status of the component.
16
- */
17
- isChild?: boolean;
18
14
  /**
19
15
  * The overall status of the component, the entries can also report their own health.
20
16
  */
21
17
  status: HealthStatus;
22
18
  /**
23
- * The details for the status if there are further details to provide as an i18n key.
19
+ * The message for the status if there are further details to provide as an i18n key.
24
20
  */
25
- details?: string;
21
+ message?: string;
26
22
  /**
27
- * Properties to substitute in the i18n key for the details.
23
+ * Data to substitute in the i18n key for the message.
28
24
  */
29
- properties?: {
25
+ data?: {
30
26
  [id: string]: unknown;
31
27
  };
28
+ /**
29
+ * The grouped child components, if any.
30
+ */
31
+ grouped?: IHealth[];
32
32
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,39 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.35](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.34...core-v0.0.3-next.35) (2026-05-06)
4
+
5
+
6
+ ### Features
7
+
8
+ * add support for health i18n validation ([7a286dd](https://github.com/twinfoundation/twin-framework/commit/7a286ddb0c1bfa498bf3a77126cd589042bad6de))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/nameof bumped from 0.0.3-next.34 to 0.0.3-next.35
16
+ * devDependencies
17
+ * @twin.org/nameof-transformer bumped from 0.0.3-next.34 to 0.0.3-next.35
18
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.34 to 0.0.3-next.35
19
+
20
+ ## [0.0.3-next.34](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.33...core-v0.0.3-next.34) (2026-05-06)
21
+
22
+
23
+ ### Features
24
+
25
+ * health status grouping ([5007c29](https://github.com/twinfoundation/twin-framework/commit/5007c29fe4123fe56f754450b993dbe5dc32a057))
26
+
27
+
28
+ ### Dependencies
29
+
30
+ * The following workspace dependencies were updated
31
+ * dependencies
32
+ * @twin.org/nameof bumped from 0.0.3-next.33 to 0.0.3-next.34
33
+ * devDependencies
34
+ * @twin.org/nameof-transformer bumped from 0.0.3-next.33 to 0.0.3-next.34
35
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.33 to 0.0.3-next.34
36
+
3
37
  ## [0.0.3-next.33](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.32...core-v0.0.3-next.33) (2026-05-05)
4
38
 
5
39
 
package/docs/reference/interfaces/IHealth.md CHANGED
@@ -4,11 +4,11 @@ Provides health information for a component.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### name {#name}
7
+ ### source {#source}
8
8
 
9
- > **name**: `string`
9
+ > **source**: `string`
10
10
 
11
- The name of the component.
11
+ The source of the health information.
12
12
 
13
13
  ***
14
14
 
@@ -20,14 +20,6 @@ The description of the component as an i18n key.
20
20
 
21
21
  ***
22
22
 
23
- ### isChild? {#ischild}
24
-
25
- > `optional` **isChild?**: `boolean`
26
-
27
- Whether this entry is a child of another entry, the parent entry will report the overall status of the component.
28
-
29
- ***
30
-
31
23
  ### status {#status}
32
24
 
33
25
  > **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
@@ -36,20 +28,28 @@ The overall status of the component, the entries can also report their own healt
36
28
 
37
29
  ***
38
30
 
39
- ### details? {#details}
31
+ ### message? {#message}
40
32
 
41
- > `optional` **details?**: `string`
33
+ > `optional` **message?**: `string`
42
34
 
43
- The details for the status if there are further details to provide as an i18n key.
35
+ The message for the status if there are further details to provide as an i18n key.
44
36
 
45
37
  ***
46
38
 
47
- ### properties? {#properties}
39
+ ### data? {#data}
48
40
 
49
- > `optional` **properties?**: `object`
41
+ > `optional` **data?**: `object`
50
42
 
51
- Properties to substitute in the i18n key for the details.
43
+ Data to substitute in the i18n key for the message.
52
44
 
53
45
  #### Index Signature
54
46
 
55
47
  \[`id`: `string`\]: `unknown`
48
+
49
+ ***
50
+
51
+ ### grouped? {#grouped}
52
+
53
+ > `optional` **grouped?**: `IHealth`[]
54
+
55
+ The grouped child components, if any.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/core",
3
- "version": "0.0.3-next.33",
3
+ "version": "0.0.3-next.35",
4
4
  "description": "Helper methods/classes for data type checking/validation/guarding/error handling",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/nameof": "0.0.3-next.33",
17
+ "@twin.org/nameof": "0.0.3-next.35",
18
18
  "intl-messageformat": "11.2.0",
19
19
  "rfc6902": "5.2.0"
20
20
  },