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

package/dist/es/models/IHealth.js.map

@@ -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 * 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\t/**\n\t * The grouped child components, if any.\n\t */\n\tgrouped?: IHealth[];\n}\n"]}
+{"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

@@ -4,9 +4,9 @@ import type { HealthStatus } from "./healthStatus.js";
  */
 export interface IHealth {
     /**
-     * The name of the component.
+     * The source of the health information.
      */
-    name: string;
+    source: string;
     /**
      * The description of the component as an i18n key.
      */
@@ -16,13 +16,13 @@ export interface IHealth {
      */
     status: HealthStatus;
     /**
-     * The details for the status if there are further details to provide as an i18n key.
+     * The message for the status if there are further details to provide as an i18n key.
      */
-    details?: string;
+    message?: string;
     /**
-     * Properties to substitute in the i18n key for the details.
+     * Data to substitute in the i18n key for the message.
      */
-    properties?: {
+    data?: {
         [id: string]: unknown;
     };
     /**

package/docs/changelog.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* add support for health i18n validation ([7a286dd](https://github.com/twinfoundation/twin-framework/commit/7a286ddb0c1bfa498bf3a77126cd589042bad6de))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nameof bumped from 0.0.3-next.34 to 0.0.3-next.35
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.34 to 0.0.3-next.35
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.34 to 0.0.3-next.35
+
 ## [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)
 
 

package/docs/reference/interfaces/IHealth.md

@@ -4,11 +4,11 @@ Provides health information for a component.
 
 ## Properties
 
-### name {#name}
+### source {#source}
 
-> **name**: `string`
+> **source**: `string`
 
-The name of the component.
+The source of the health information.
 
 ***
 
@@ -28,19 +28,19 @@ The overall status of the component, the entries can also report their own healt
 
 ***
 
-### details? {#details}
+### message? {#message}
 
-> `optional` **details?**: `string`
+> `optional` **message?**: `string`
 
-The details for the status if there are further details to provide as an i18n key.
+The message for the status if there are further details to provide as an i18n key.
 
 ***
 
-### properties? {#properties}
+### data? {#data}
 
-> `optional` **properties?**: `object`
+> `optional` **data?**: `object`
 
-Properties to substitute in the i18n key for the details.
+Data to substitute in the i18n key for the message.
 
 #### Index Signature
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.3-next.34",
+	"version": "0.0.3-next.35",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.3-next.34",
+		"@twin.org/nameof": "0.0.3-next.35",
 		"intl-messageformat": "11.2.0",
 		"rfc6902": "5.2.0"
 	},