@twin.org/engine 0.0.3-next.26 → 0.0.3-next.27

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Engine
 
-Engine implementation.
+Engine provides a ready-to-use runtime that extends the core layer with built-in type initialisers. It helps applications start from a practical baseline while still allowing customisation of configuration and component selection.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,20 @@
-# @twin.org/engine - Changelog
+# Changelog
+
+## [0.0.3-next.27](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.26...engine-v0.0.3-next.27) (2026-03-20)
+
+
+### Features
+
+* update dependencies ([e6ebe42](https://github.com/twinfoundation/engine/commit/e6ebe42b9d61066227ad8b45dae14c8f8615b760))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/engine-models bumped from 0.0.3-next.26 to 0.0.3-next.27
+    * @twin.org/engine-types bumped from 0.0.3-next.26 to 0.0.3-next.27
 
 ## [0.0.3-next.26](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.25...engine-v0.0.3-next.26) (2026-03-05)
 

package/docs/examples.md

@@ -1,35 +1,68 @@
-# @twin.org/engine - Examples
+# Engine Examples
 
-## Environment Variables
+These examples show a practical way to configure and run an instance with built-in type initialisers and custom entity storage.
 
-The engine supports various environment variables for configuration. Here are some key examples:
+## Engine
 
-### IOTA DLT Configuration
+```typescript
+import { Engine } from '@twin.org/engine';
+import type { IEngineConfig } from '@twin.org/engine-types';
 
-Basic IOTA configuration:
+const config: IEngineConfig = {
+  debug: true,
+  silent: false,
+  types: {}
+};
 
-```bash
-# IOTA Node Configuration
-IOTA_NODE_ENDPOINT="https://api.devnet.iota.cafe"
-IOTA_FAUCET_ENDPOINT="https://faucet.devnet.iota.cafe"
-IOTA_EXPLORER_ENDPOINT="https://explorer.iota.org/"
-IOTA_NETWORK="devnet"
-IOTA_COIN_TYPE="4218"
-```
+const engine = new Engine({ config, skipBootstrap: true });
+
+engine.addContextIdKey('tenant', ['tenant']);
+engine.addContextId('tenant', 'tenant-a');
 
-### IOTA Gas Station Configuration (Optional)
+engine.addTypeInitialiser('loggingConnector', '@twin.org/engine-types', 'initLoggingConnector');
 
-The IOTA Gas Station pattern allows for sponsored transactions and improved UX:
+console.log(engine.getContextIdKeys()); // ["tenant"]
+console.log(engine.getContextIds()); // { tenant: "tenant-a" }
+console.log(engine.isStarted()); // false
 
-```bash
-# Gas Station Configuration
-IOTA_GAS_STATION_ENDPOINT="https://gas-station.example.com"
-IOTA_GAS_STATION_AUTH_TOKEN="your-auth-token"
+await engine.start(true);
+console.log(engine.isStarted()); // true
+
+await engine.stop();
+console.log(engine.isStarted()); // false
 ```
 
-**Configuration Options:**
+## EngineConfigHelper
+
+```typescript
+import { EngineConfigHelper } from '@twin.org/engine';
+import type { IEngineConfig } from '@twin.org/engine-types';
+import type { IEntitySchema } from '@twin.org/entity';
 
-- `IOTA_GAS_STATION_ENDPOINT`: The URL of the gas station service
-- `IOTA_GAS_STATION_AUTH_TOKEN`: Authentication token for the gas station
+interface Product {
+  id: string;
+  name: string;
+}
 
-When gas station is configured, all IOTA-related connectors (wallet, nft, verifiable-storage, identity, identity-resolver) will automatically use the centralized configuration and have access to gas station functionality.
+const config: IEngineConfig = {
+  debug: false,
+  silent: true,
+  types: {}
+};
+
+const productSchema = {
+  type: 'Product',
+  properties: {
+    id: { type: 'string', isPrimary: true },
+    name: { type: 'string' }
+  }
+} as IEntitySchema<Product>;
+
+EngineConfigHelper.addCustomEntityStorage(config, 'product', productSchema, '/products', [
+  'node',
+  'tenant'
+]);
+
+console.log(config.types.entityStorageComponent?.length ?? 0); // 1
+console.log(config.types.entityStorageComponent?.[0].restPath); // "/products"
+```

package/docs/reference/classes/Engine.md

@@ -42,7 +42,7 @@ The options for the engine.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -54,7 +54,7 @@ Runtime name for the class.
 
 ***
 
-### LOGGING\_COMPONENT\_TYPE\_NAME
+### LOGGING\_COMPONENT\_TYPE\_NAME {#logging_component_type_name}
 
 > `readonly` `static` **LOGGING\_COMPONENT\_TYPE\_NAME**: `string`
 
@@ -66,7 +66,7 @@ Name for the engine logger component, used for direct console logging.
 
 ***
 
-### LOGGING\_CONNECTOR\_TYPE\_NAME
+### LOGGING\_CONNECTOR\_TYPE\_NAME {#logging_connector_type_name}
 
 > `readonly` `static` **LOGGING\_CONNECTOR\_TYPE\_NAME**: `string`
 
@@ -78,7 +78,7 @@ Name for the engine logger connector, used for direct console logging.
 
 ***
 
-### \_context
+### \_context {#_context}
 
 > `protected` **\_context**: `IEngineCoreContext`\<`C`, `S`\>
 
@@ -90,7 +90,7 @@ The core context.
 
 ***
 
-### \_contextIdKeys
+### \_contextIdKeys {#_contextidkeys}
 
 > `protected` `readonly` **\_contextIdKeys**: `object`[]
 
@@ -110,9 +110,9 @@ The context ID keys.
 
 ***
 
-### \_contextIds?
+### \_contextIds? {#_contextids}
 
-> `protected` `optional` **\_contextIds**: `IContextIds`
+> `protected` `optional` **\_contextIds?**: `IContextIds`
 
 The context IDs.
 
@@ -122,7 +122,7 @@ The context IDs.
 
 ## Methods
 
-### addTypeInitialiser()
+### addTypeInitialiser() {#addtypeinitialiser}
 
 > **addTypeInitialiser**(`type`, `module`, `method`): `void`
 
@@ -158,7 +158,7 @@ The name of the method to call.
 
 ***
 
-### getTypeConfig()
+### getTypeConfig() {#gettypeconfig}
 
 > **getTypeConfig**(`type`): `IEngineCoreTypeConfig`[] \| `undefined`
 
@@ -184,7 +184,7 @@ The type config or undefined if not found.
 
 ***
 
-### addContextIdKey()
+### addContextIdKey() {#addcontextidkey}
 
 > **addContextIdKey**(`key`, `componentFeatures`): `void`
 
@@ -214,7 +214,7 @@ The component features for the context ID handler.
 
 ***
 
-### getContextIdKeys()
+### getContextIdKeys() {#getcontextidkeys}
 
 > **getContextIdKeys**(): `string`[]
 
@@ -232,7 +232,7 @@ The context IDs keys.
 
 ***
 
-### addContextId()
+### addContextId() {#addcontextid}
 
 > **addContextId**(`key`, `value`): `void`
 
@@ -262,7 +262,7 @@ The context ID value.
 
 ***
 
-### getContextIds()
+### getContextIds() {#getcontextids}
 
 > **getContextIds**(): `IContextIds` \| `undefined`
 
@@ -280,7 +280,7 @@ The context IDs or undefined if none are set.
 
 ***
 
-### start()
+### start() {#start}
 
 > **start**(`skipComponentStart?`): `Promise`\<`void`\>
 
@@ -306,7 +306,7 @@ Nothing.
 
 ***
 
-### stop()
+### stop() {#stop}
 
 > **stop**(): `Promise`\<`void`\>
 
@@ -324,7 +324,7 @@ Nothing.
 
 ***
 
-### isStarted()
+### isStarted() {#isstarted}
 
 > **isStarted**(): `boolean`
 
@@ -342,7 +342,7 @@ True if the engine is started.
 
 ***
 
-### isPrimary()
+### isPrimary() {#isprimary}
 
 > **isPrimary**(): `boolean`
 
@@ -360,7 +360,7 @@ True if the engine is the primary instance.
 
 ***
 
-### isClone()
+### isClone() {#isclone}
 
 > **isClone**(): `boolean`
 
@@ -378,7 +378,7 @@ True if the engine instance is a clone.
 
 ***
 
-### logInfo()
+### logInfo() {#loginfo}
 
 > **logInfo**(`message`): `Promise`\<`void`\>
 
@@ -402,7 +402,7 @@ The message to log.
 
 ***
 
-### logError()
+### logError() {#logerror}
 
 > **logError**(`error`): `Promise`\<`void`\>
 
@@ -426,7 +426,7 @@ The error to log.
 
 ***
 
-### getConfig()
+### getConfig() {#getconfig}
 
 > **getConfig**(): `C`
 
@@ -444,7 +444,7 @@ The config for the engine.
 
 ***
 
-### getState()
+### getState() {#getstate}
 
 > **getState**(): `S`
 
@@ -462,7 +462,7 @@ The state of the engine.
 
 ***
 
-### setStateDirty()
+### setStateDirty() {#setstatedirty}
 
 > **setStateDirty**(): `void`
 
@@ -478,7 +478,7 @@ Set the state to dirty so it gets saved.
 
 ***
 
-### getRegisteredInstances()
+### getRegisteredInstances() {#getregisteredinstances}
 
 > **getRegisteredInstances**(): `object`
 
@@ -496,7 +496,7 @@ The registered instances.
 
 ***
 
-### getRegisteredInstanceType()
+### getRegisteredInstanceType() {#getregisteredinstancetype}
 
 > **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
 
@@ -532,7 +532,7 @@ If a matching instance was not found.
 
 ***
 
-### getRegisteredInstanceTypeOptional()
+### getRegisteredInstanceTypeOptional() {#getregisteredinstancetypeoptional}
 
 > **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `string` \| `undefined`
 
@@ -564,7 +564,7 @@ The instance type matching the criteria if one is registered.
 
 ***
 
-### getCloneData()
+### getCloneData() {#getclonedata}
 
 > **getCloneData**(): `IEngineCoreClone`\<`C`, `S`\>
 
@@ -582,7 +582,7 @@ The clone data.
 
 ***
 
-### populateClone()
+### populateClone() {#populateclone}
 
 > **populateClone**(`cloneData`, `contextIds?`, `silent?`): `void`
 

package/docs/reference/classes/EngineConfigHelper.md

@@ -14,7 +14,7 @@ Helper methods for engine config.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### addCustomEntityStorage()
+### addCustomEntityStorage() {#addcustomentitystorage}
 
 > `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath?`, `partitionContextIds?`): `void`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/engine",
-	"version": "0.0.3-next.26",
-	"description": "Engine implementation.",
+	"version": "0.0.3-next.27",
+	"description": "Ready-to-use engine runtime that preloads built-in type initialisers.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/engine.git",
@@ -16,9 +16,9 @@
 	"dependencies": {
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.3-next.26",
-		"@twin.org/engine-models": "0.0.3-next.26",
-		"@twin.org/engine-types": "0.0.3-next.26",
+		"@twin.org/engine-core": "0.0.3-next.27",
+		"@twin.org/engine-models": "0.0.3-next.27",
+		"@twin.org/engine-types": "0.0.3-next.27",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},