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

package/docs/reference/classes/Engine.md

@@ -51,3 +51,523 @@ Runtime name for the class.
 #### Overrides
 
 `EngineCore.CLASS_NAME`
+
+***
+
+### LOGGING\_COMPONENT\_TYPE\_NAME
+
+> `readonly` `static` **LOGGING\_COMPONENT\_TYPE\_NAME**: `string`
+
+Name for the engine logger component, used for direct console logging.
+
+#### Inherited from
+
+`EngineCore.LOGGING_COMPONENT_TYPE_NAME`
+
+***
+
+### LOGGING\_CONNECTOR\_TYPE\_NAME
+
+> `readonly` `static` **LOGGING\_CONNECTOR\_TYPE\_NAME**: `string`
+
+Name for the engine logger connector, used for direct console logging.
+
+#### Inherited from
+
+`EngineCore.LOGGING_CONNECTOR_TYPE_NAME`
+
+***
+
+### \_context
+
+> `protected` **\_context**: `IEngineCoreContext`\<`C`, `S`\>
+
+The core context.
+
+#### Inherited from
+
+`EngineCore._context`
+
+***
+
+### \_contextIdKeys
+
+> `protected` `readonly` **\_contextIdKeys**: `string`[]
+
+The context ID keys.
+
+#### Inherited from
+
+`EngineCore._contextIdKeys`
+
+***
+
+### \_contextIds?
+
+> `protected` `optional` **\_contextIds**: `IContextIds`
+
+The context IDs.
+
+#### Inherited from
+
+`EngineCore._contextIds`
+
+## Methods
+
+### addTypeInitialiser()
+
+> **addTypeInitialiser**(`type`, `module`, `method`): `void`
+
+Add a type initialiser.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to add the initialiser for.
+
+##### module
+
+`string`
+
+The name of the module which contains the initialiser method.
+
+##### method
+
+`string`
+
+The name of the method to call.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`EngineCore.addTypeInitialiser`
+
+***
+
+### getTypeConfig()
+
+> **getTypeConfig**(`type`): `undefined` \| `IEngineCoreTypeConfig`[]
+
+Get the type config for a specific type.
+
+#### Parameters
+
+##### type
+
+`string`
+
+The type to get the config for.
+
+#### Returns
+
+`undefined` \| `IEngineCoreTypeConfig`[]
+
+The type config or undefined if not found.
+
+#### Inherited from
+
+`EngineCore.getTypeConfig`
+
+***
+
+### addContextIdKey()
+
+> **addContextIdKey**(`key`): `void`
+
+Add a context ID key to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`EngineCore.addContextIdKey`
+
+***
+
+### getContextIdKeys()
+
+> **getContextIdKeys**(): `string`[]
+
+Get the context ID keys for the engine.
+
+#### Returns
+
+`string`[]
+
+The context IDs keys.
+
+#### Inherited from
+
+`EngineCore.getContextIdKeys`
+
+***
+
+### addContextId()
+
+> **addContextId**(`key`, `value`): `void`
+
+Add a context ID to the engine.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The context ID key.
+
+##### value
+
+`string`
+
+The context ID value.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`EngineCore.addContextId`
+
+***
+
+### getContextIds()
+
+> **getContextIds**(): `undefined` \| `IContextIds`
+
+Get the context IDs for the engine.
+
+#### Returns
+
+`undefined` \| `IContextIds`
+
+The context IDs or undefined if none are set.
+
+#### Inherited from
+
+`EngineCore.getContextIds`
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`boolean`\>
+
+Start the engine core.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the start was successful.
+
+#### Inherited from
+
+`EngineCore.start`
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the engine core.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`EngineCore.stop`
+
+***
+
+### isStarted()
+
+> **isStarted**(): `boolean`
+
+Is the engine started.
+
+#### Returns
+
+`boolean`
+
+True if the engine is started.
+
+#### Inherited from
+
+`EngineCore.isStarted`
+
+***
+
+### isPrimary()
+
+> **isPrimary**(): `boolean`
+
+Is this the primary engine instance.
+
+#### Returns
+
+`boolean`
+
+True if the engine is the primary instance.
+
+#### Inherited from
+
+`EngineCore.isPrimary`
+
+***
+
+### isClone()
+
+> **isClone**(): `boolean`
+
+Is this engine instance a clone.
+
+#### Returns
+
+`boolean`
+
+True if the engine instance is a clone.
+
+#### Inherited from
+
+`EngineCore.isClone`
+
+***
+
+### logInfo()
+
+> **logInfo**(`message`): `Promise`\<`void`\>
+
+Log info.
+
+#### Parameters
+
+##### message
+
+`string`
+
+The message to log.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`EngineCore.logInfo`
+
+***
+
+### logError()
+
+> **logError**(`error`): `Promise`\<`void`\>
+
+Log error.
+
+#### Parameters
+
+##### error
+
+`IError`
+
+The error to log.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`EngineCore.logError`
+
+***
+
+### getConfig()
+
+> **getConfig**(): `C`
+
+Get the config for the engine.
+
+#### Returns
+
+`C`
+
+The config for the engine.
+
+#### Inherited from
+
+`EngineCore.getConfig`
+
+***
+
+### getState()
+
+> **getState**(): `S`
+
+Get the state of the engine.
+
+#### Returns
+
+`S`
+
+The state of the engine.
+
+#### Inherited from
+
+`EngineCore.getState`
+
+***
+
+### getRegisteredInstances()
+
+> **getRegisteredInstances**(): `object`
+
+Get all the registered instances.
+
+#### Returns
+
+`object`
+
+The registered instances.
+
+#### Inherited from
+
+`EngineCore.getRegisteredInstances`
+
+***
+
+### getRegisteredInstanceType()
+
+> **getRegisteredInstanceType**(`componentConnectorType`, `features?`): `string`
+
+Get the registered instance type for the component/connector.
+
+#### Parameters
+
+##### componentConnectorType
+
+`string`
+
+The type of the component/connector.
+
+##### features?
+
+`string`[]
+
+The requested features of the component, if not specified the default entry will be retrieved.
+
+#### Returns
+
+`string`
+
+The instance type matching the criteria if one is registered.
+
+#### Throws
+
+If a matching instance was not found.
+
+#### Inherited from
+
+`EngineCore.getRegisteredInstanceType`
+
+***
+
+### getRegisteredInstanceTypeOptional()
+
+> **getRegisteredInstanceTypeOptional**(`componentConnectorType`, `features?`): `undefined` \| `string`
+
+Get the registered instance type for the component/connector if it exists.
+
+#### Parameters
+
+##### componentConnectorType
+
+`string`
+
+The type of the component/connector.
+
+##### features?
+
+`string`[]
+
+The requested features of the component, if not specified the default entry will be retrieved.
+
+#### Returns
+
+`undefined` \| `string`
+
+The instance type matching the criteria if one is registered.
+
+#### Inherited from
+
+`EngineCore.getRegisteredInstanceTypeOptional`
+
+***
+
+### getCloneData()
+
+> **getCloneData**(): `IEngineCoreClone`\<`C`, `S`\>
+
+Get the data required to create a clone of the engine.
+
+#### Returns
+
+`IEngineCoreClone`\<`C`, `S`\>
+
+The clone data.
+
+#### Inherited from
+
+`EngineCore.getCloneData`
+
+***
+
+### populateClone()
+
+> **populateClone**(`cloneData`, `silent?`): `void`
+
+Populate the engine from the clone data.
+
+#### Parameters
+
+##### cloneData
+
+`IEngineCoreClone`\<`C`, `S`\>
+
+The clone data to populate from.
+
+##### silent?
+
+`boolean`
+
+Should the clone be silent.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`EngineCore.populateClone`

package/docs/reference/classes/EngineConfigHelper.md

@@ -24,7 +24,7 @@ Runtime name for the class.
 
 ### addCustomEntityStorage()
 
-> `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath?`, `options?`): `void`
+> `static` **addCustomEntityStorage**\<`T`\>(`engineConfig`, `entityTypeName`, `entitySchema`, `restPath?`, `partitionContextIds?`): `void`
 
 Add a custom entity storage to the engine configuration.
 
@@ -60,15 +60,11 @@ The entity schema.
 
 The rest path to serve the entity storage from, leave undefined for no endpoints.
 
-##### options?
+##### partitionContextIds?
 
-Additional options.
+`string`[]
 
-###### partitionPerUser?
-
-`boolean`
-
-Whether to partition the user identity in the data, defaults to false.
+The context ids to use for partitioning.
 
 #### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine",
-	"version": "0.0.2-next.26",
+	"version": "0.0.2-next.27",
 	"description": "Engine implementation.",
 	"repository": {
 		"type": "git",
@@ -13,7 +13,22 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"dev": "nodemon --watch src --ext ts --exec \"npm run build\"",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"test:build": "tspc -p ./tests/tsconfig.json --noEmit",
+		"validate-locales": "validate-locales",
+		"test:coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run validate-locales && npm run test:build && npm run test && npm run docs",
+		"dist:no-test": "npm run clean && npm run build && npm run test:build && npm run docs"
+	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/engine-core": "0.0.2-next.26",
 		"@twin.org/engine-models": "0.0.2-next.26",
@@ -21,20 +36,33 @@
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@twin.org/nameof-vitest-plugin": "next",
+		"@twin.org/validate-locales": "next",
+		"@twin.org/ts-to-openapi": "next",
+		"@vitest/coverage-v8": "3.2.4",
+		"copyfiles": "2.4.1",
+		"nodemon": "3.1.10",
+		"rimraf": "6.0.1",
+		"ts-patch": "3.3.0",
+		"typedoc": "0.28.13",
+		"typedoc-plugin-markdown": "4.9.0",
+		"typescript": "5.9.3",
+		"vitest": "3.2.4"
+	},
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"