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

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/IComponent.js.map +1 -1
  2. package/dist/types/models/IComponent.d.ts +6 -0
  3. package/docs/changelog.md +43 -8
  4. package/docs/reference/interfaces/IComponent.md +22 -0
  5. package/package.json +4 -4
package/dist/es/models/IComponent.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IComponent.js","sourceRoot":"","sources":["../../../src/models/IComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHealth } from \"./IHealth.js\";\n\n/**\n * Interface describing a component which can be bootstrapped, started and stopped.\n */\nexport interface IComponent {\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tclassName(): string;\n\n\t/**\n\t * Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t */\n\tbootstrap?(nodeLoggingComponentType?: string): Promise<boolean>;\n\n\t/**\n\t * The component needs to be started when the node is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstart?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstop?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * Returns the health status of the component.\n\t * @returns The health status of the component, can return multiple entries for elements within the component.\n\t */\n\thealth?(): Promise<IHealth[]>;\n}\n"]}
1
+ {"version":3,"file":"IComponent.js","sourceRoot":"","sources":["../../../src/models/IComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHealth } from \"./IHealth.js\";\n\n/**\n * Interface describing a component which can be bootstrapped, started and stopped.\n */\nexport interface IComponent {\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tclassName(): string;\n\n\t/**\n\t * Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t */\n\tbootstrap?(nodeLoggingComponentType?: string): Promise<boolean>;\n\n\t/**\n\t * Teardown the component by releasing any resources it holds.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the teardown process was successful.\n\t */\n\tteardown?(nodeLoggingComponentType?: string): Promise<boolean>;\n\n\t/**\n\t * The component needs to be started when the node is initialized.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstart?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tstop?(nodeLoggingComponentType?: string): Promise<void>;\n\n\t/**\n\t * Returns the health status of the component.\n\t * @returns The health status of the component, can return multiple entries for elements within the component.\n\t */\n\thealth?(): Promise<IHealth[]>;\n}\n"]}
package/dist/types/models/IComponent.d.ts CHANGED
@@ -14,6 +14,12 @@ export interface IComponent {
14
14
  * @returns True if the bootstrapping process was successful.
15
15
  */
16
16
  bootstrap?(nodeLoggingComponentType?: string): Promise<boolean>;
17
+ /**
18
+ * Teardown the component by releasing any resources it holds.
19
+ * @param nodeLoggingComponentType The node logging component type.
20
+ * @returns True if the teardown process was successful.
21
+ */
22
+ teardown?(nodeLoggingComponentType?: string): Promise<boolean>;
17
23
  /**
18
24
  * The component needs to be started when the node is initialized.
19
25
  * @param nodeLoggingComponentType The node logging component type.
package/docs/changelog.md CHANGED
@@ -1,11 +1,46 @@
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)
3
+ ## [0.0.3-next.37](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.36...core-v0.0.3-next.37) (2026-05-07)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **core:** Synchronize repo versions
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/nameof bumped from 0.0.3-next.36 to 0.0.3-next.37
16
+ * devDependencies
17
+ * @twin.org/nameof-transformer bumped from 0.0.3-next.36 to 0.0.3-next.37
18
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.36 to 0.0.3-next.37
19
+
20
+ ## [0.0.3-next.36](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.35...core-v0.0.3-next.36) (2026-05-07)
21
+
22
+
23
+ ### Features
24
+
25
+ * add teardown to IComponent interface ([32c173c](https://github.com/iotaledger/twin-framework/commit/32c173cda115c20d3b4cee14b8a29cdc08e91555))
26
+ * add teardown to IComponent interface ([98ce864](https://github.com/iotaledger/twin-framework/commit/98ce8648e709310c4435de334825b381fb4e32cb))
27
+
28
+
29
+ ### Dependencies
30
+
31
+ * The following workspace dependencies were updated
32
+ * dependencies
33
+ * @twin.org/nameof bumped from 0.0.3-next.35 to 0.0.3-next.36
34
+ * devDependencies
35
+ * @twin.org/nameof-transformer bumped from 0.0.3-next.35 to 0.0.3-next.36
36
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.35 to 0.0.3-next.36
37
+
38
+ ## [0.0.3-next.35](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.34...core-v0.0.3-next.35) (2026-05-06)
4
39
 
5
40
 
6
41
  ### Features
7
42
 
8
- * add support for health i18n validation ([7a286dd](https://github.com/twinfoundation/twin-framework/commit/7a286ddb0c1bfa498bf3a77126cd589042bad6de))
43
+ * add support for health i18n validation ([7a286dd](https://github.com/iotaledger/twin-framework/commit/7a286ddb0c1bfa498bf3a77126cd589042bad6de))
9
44
 
10
45
 
11
46
  ### Dependencies
@@ -17,12 +52,12 @@
17
52
  * @twin.org/nameof-transformer bumped from 0.0.3-next.34 to 0.0.3-next.35
18
53
  * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.34 to 0.0.3-next.35
19
54
 
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)
55
+ ## [0.0.3-next.34](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.33...core-v0.0.3-next.34) (2026-05-06)
21
56
 
22
57
 
23
58
  ### Features
24
59
 
25
- * health status grouping ([5007c29](https://github.com/twinfoundation/twin-framework/commit/5007c29fe4123fe56f754450b993dbe5dc32a057))
60
+ * health status grouping ([5007c29](https://github.com/iotaledger/twin-framework/commit/5007c29fe4123fe56f754450b993dbe5dc32a057))
26
61
 
27
62
 
28
63
  ### Dependencies
@@ -34,17 +69,17 @@
34
69
  * @twin.org/nameof-transformer bumped from 0.0.3-next.33 to 0.0.3-next.34
35
70
  * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.33 to 0.0.3-next.34
36
71
 
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)
72
+ ## [0.0.3-next.33](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.32...core-v0.0.3-next.33) (2026-05-05)
38
73
 
39
74
 
40
75
  ### Features
41
76
 
42
- * add health method to components ([a88016d](https://github.com/twinfoundation/twin-framework/commit/a88016d90d172413e5bc5238dc1b3e35f82fcc2c))
77
+ * add health method to components ([a88016d](https://github.com/iotaledger/twin-framework/commit/a88016d90d172413e5bc5238dc1b3e35f82fcc2c))
43
78
 
44
79
 
45
80
  ### Bug Fixes
46
81
 
47
- * improve jsdoc comments ([f7c8e43](https://github.com/twinfoundation/twin-framework/commit/f7c8e43fab9803dffa6461950d5b9979e25bcd24))
82
+ * improve jsdoc comments ([f7c8e43](https://github.com/iotaledger/twin-framework/commit/f7c8e43fab9803dffa6461950d5b9979e25bcd24))
48
83
 
49
84
 
50
85
  ### Dependencies
@@ -56,7 +91,7 @@
56
91
  * @twin.org/nameof-transformer bumped from 0.0.3-next.32 to 0.0.3-next.33
57
92
  * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.32 to 0.0.3-next.33
58
93
 
59
- ## [0.0.3-next.32](https://github.com/twinfoundation/twin-framework/compare/core-v0.0.3-next.31...core-v0.0.3-next.32) (2026-04-30)
94
+ ## [0.0.3-next.32](https://github.com/iotaledger/twin-framework/compare/core-v0.0.3-next.31...core-v0.0.3-next.32) (2026-04-30)
60
95
 
61
96
 
62
97
  ### Miscellaneous Chores
package/docs/reference/interfaces/IComponent.md CHANGED
@@ -40,6 +40,28 @@ True if the bootstrapping process was successful.
40
40
 
41
41
  ***
42
42
 
43
+ ### teardown()? {#teardown}
44
+
45
+ > `optional` **teardown**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
46
+
47
+ Teardown the component by releasing any resources it holds.
48
+
49
+ #### Parameters
50
+
51
+ ##### nodeLoggingComponentType?
52
+
53
+ `string`
54
+
55
+ The node logging component type.
56
+
57
+ #### Returns
58
+
59
+ `Promise`\<`boolean`\>
60
+
61
+ True if the teardown process was successful.
62
+
63
+ ***
64
+
43
65
  ### start()? {#start}
44
66
 
45
67
  > `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/core",
3
- "version": "0.0.3-next.35",
3
+ "version": "0.0.3-next.37",
4
4
  "description": "Helper methods/classes for data type checking/validation/guarding/error handling",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/framework.git",
7
+ "url": "git+https://github.com/iotaledger/framework.git",
8
8
  "directory": "packages/core"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,7 +14,7 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/nameof": "0.0.3-next.35",
17
+ "@twin.org/nameof": "0.0.3-next.37",
18
18
  "intl-messageformat": "11.2.0",
19
19
  "rfc6902": "5.2.0"
20
20
  },
@@ -45,7 +45,7 @@
45
45
  "utilities"
46
46
  ],
47
47
  "bugs": {
48
- "url": "git+https://github.com/twinfoundation/framework/issues"
48
+ "url": "git+https://github.com/iotaledger/framework/issues"
49
49
  },
50
50
  "homepage": "https://twindev.org"
51
51
  }