@twin.org/core 0.0.1-next.16 → 0.0.1-next.18

package/dist/cjs/index.cjs

@@ -1871,6 +1871,29 @@ class Factory {
         }
         return Factory._factories[typeName];
     }
+    /**
+     * Get all the factories.
+     * @returns All the factories.
+     */
+    static getFactories() {
+        return Factory._factories;
+    }
+    /**
+     * Reset all the factories, which removes any created instances, but not the registrations.
+     */
+    static resetFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].reset();
+        }
+    }
+    /**
+     * Clear all the factories, which removes anything registered with the factories.
+     */
+    static clearFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].clear();
+        }
+    }
     /**
      * Register a new generator.
      * @param name The name of the generator.

package/dist/esm/index.mjs

@@ -1869,6 +1869,29 @@ class Factory {
         }
         return Factory._factories[typeName];
     }
+    /**
+     * Get all the factories.
+     * @returns All the factories.
+     */
+    static getFactories() {
+        return Factory._factories;
+    }
+    /**
+     * Reset all the factories, which removes any created instances, but not the registrations.
+     */
+    static resetFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].reset();
+        }
+    }
+    /**
+     * Clear all the factories, which removes anything registered with the factories.
+     */
+    static clearFactories() {
+        for (const typeName in Factory._factories) {
+            Factory._factories[typeName].clear();
+        }
+    }
     /**
      * Register a new generator.
      * @param name The name of the generator.

package/dist/types/factories/factory.d.ts

@@ -10,6 +10,21 @@ export declare class Factory<T> {
      * @returns The factory instance.
      */
     static createFactory<U>(typeName: string, autoInstance?: boolean, matcher?: (names: string[], name: string) => string | undefined): Factory<U>;
+    /**
+     * Get all the factories.
+     * @returns All the factories.
+     */
+    static getFactories(): {
+        [typeName: string]: Factory<unknown>;
+    };
+    /**
+     * Reset all the factories, which removes any created instances, but not the registrations.
+     */
+    static resetFactories(): void;
+    /**
+     * Clear all the factories, which removes anything registered with the factories.
+     */
+    static clearFactories(): void;
     /**
      * Register a new generator.
      * @param name The name of the generator.

package/dist/types/models/IComponent.d.ts

@@ -9,21 +9,30 @@ export interface IComponent {
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by bootstrap.
      * @returns True if the bootstrapping process was successful.
      */
-    bootstrap?(nodeLoggingConnectorType?: string): Promise<boolean>;
+    bootstrap?(nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<boolean>;
     /**
      * The component needs to be started when the node is initialized.
      * @param nodeIdentity The identity of the node starting the component.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by bootstrap.
      * @returns Nothing.
      */
-    start?(nodeIdentity: string, nodeLoggingConnectorType?: string): Promise<void>;
+    start?(nodeIdentity: string, nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<void>;
     /**
      * The component needs to be stopped when the node is closed.
      * @param nodeIdentity The identity of the node stopping the component.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param componentState A persistent state which can be modified by bootstrap.
      * @returns Nothing.
      */
-    stop?(nodeIdentity: string, nodeLoggingConnectorType?: string): Promise<void>;
+    stop?(nodeIdentity: string, nodeLoggingConnectorType: string | undefined, componentState?: {
+        [id: string]: unknown;
+    }): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/core - Changelog
 
-## 0.0.1-next.16
+## 0.0.1-next.18
 
 - Initial Release

package/docs/reference/classes/Factory.md

@@ -40,6 +40,44 @@ The factory instance.
 
 ***
 
+### getFactories()
+
+> `static` **getFactories**(): `object`
+
+Get all the factories.
+
+#### Returns
+
+`object`
+
+All the factories.
+
+***
+
+### resetFactories()
+
+> `static` **resetFactories**(): `void`
+
+Reset all the factories, which removes any created instances, but not the registrations.
+
+#### Returns
+
+`void`
+
+***
+
+### clearFactories()
+
+> `static` **clearFactories**(): `void`
+
+Clear all the factories, which removes anything registered with the factories.
+
+#### Returns
+
+`void`
+
+***
+
 ### register()
 
 > **register**\<`U`\>(`name`, `generator`): `void`

package/docs/reference/interfaces/IComponent.md

@@ -14,16 +14,20 @@ The name of the component.
 
 ### bootstrap()?
 
-> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> `optional` **bootstrap**(`nodeLoggingConnectorType`, `componentState`?): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+• **nodeLoggingConnectorType**: `undefined` \| `string`
 
 The node logging connector type, defaults to "node-logging".
 
+• **componentState?**
+
+A persistent state which can be modified by bootstrap.
+
 #### Returns
 
 `Promise`\<`boolean`\>
@@ -34,7 +38,7 @@ True if the bootstrapping process was successful.
 
 ### start()?
 
-> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState`?): `Promise`\<`void`\>
 
 The component needs to be started when the node is initialized.
 
@@ -44,10 +48,14 @@ The component needs to be started when the node is initialized.
 
 The identity of the node starting the component.
 
-• **nodeLoggingConnectorType?**: `string`
+• **nodeLoggingConnectorType**: `undefined` \| `string`
 
 The node logging connector type, defaults to "node-logging".
 
+• **componentState?**
+
+A persistent state which can be modified by bootstrap.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -58,7 +66,7 @@ Nothing.
 
 ### stop()?
 
-> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
+> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState`?): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
@@ -68,10 +76,14 @@ The component needs to be stopped when the node is closed.
 
 The identity of the node stopping the component.
 
-• **nodeLoggingConnectorType?**: `string`
+• **nodeLoggingConnectorType**: `undefined` \| `string`
 
 The node logging connector type, defaults to "node-logging".
 
+• **componentState?**
+
+A persistent state which can be modified by bootstrap.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.1-next.16",
+	"version": "0.0.1-next.18",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",