@twin.org/engine-core 0.0.1-next.1

package/docs/reference/classes/FileStateStorage.md

@@ -0,0 +1,89 @@
+# Class: FileStateStorage
+
+Store state in a file.
+
+## Implements
+
+- `IEngineStateStorage`
+
+## Constructors
+
+### new FileStateStorage()
+
+> **new FileStateStorage**(`filename`, `readonlyMode`): [`FileStateStorage`](FileStateStorage.md)
+
+Create a new instance of FileStateStorage.
+
+#### Parameters
+
+• **filename**: `string`
+
+The filename to store the state.
+
+• **readonlyMode**: `boolean` = `false`
+
+Whether the file is in read-only mode.
+
+#### Returns
+
+[`FileStateStorage`](FileStateStorage.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### load()
+
+> **load**(`engineCore`): `Promise`\<`undefined` \| `IEngineState`\>
+
+Method for loading the state.
+
+#### Parameters
+
+• **engineCore**: `IEngineCore`
+
+The engine core to load the state for.
+
+#### Returns
+
+`Promise`\<`undefined` \| `IEngineState`\>
+
+The state of the engine or undefined if it doesn't exist.
+
+#### Implementation of
+
+`IEngineStateStorage.load`
+
+***
+
+### save()
+
+> **save**(`engineCore`, `state`): `Promise`\<`void`\>
+
+Method for saving the state.
+
+#### Parameters
+
+• **engineCore**: `IEngineCore`
+
+The engine core to save the state for.
+
+• **state**: `IEngineState`
+
+The state of the engine to save.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEngineStateStorage.save`

package/docs/reference/classes/MemoryStateStorage.md

@@ -0,0 +1,85 @@
+# Class: MemoryStateStorage
+
+Store state in memory.
+
+## Implements
+
+- `IEngineStateStorage`
+
+## Constructors
+
+### new MemoryStateStorage()
+
+> **new MemoryStateStorage**(`readonlyMode`): [`MemoryStateStorage`](MemoryStateStorage.md)
+
+Create a new instance of MemoryStateStorage.
+
+#### Parameters
+
+• **readonlyMode**: `boolean` = `false`
+
+Whether the file is in read-only mode.
+
+#### Returns
+
+[`MemoryStateStorage`](MemoryStateStorage.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### load()
+
+> **load**(`engineCore`): `Promise`\<`undefined` \| `IEngineState`\>
+
+Method for loading the state.
+
+#### Parameters
+
+• **engineCore**: `IEngineCore`
+
+The engine core to load the state for.
+
+#### Returns
+
+`Promise`\<`undefined` \| `IEngineState`\>
+
+The state of the engine or undefined if it doesn't exist.
+
+#### Implementation of
+
+`IEngineStateStorage.load`
+
+***
+
+### save()
+
+> **save**(`engineCore`, `state`): `Promise`\<`void`\>
+
+Method for saving the state.
+
+#### Parameters
+
+• **engineCore**: `IEngineCore`
+
+The engine core to save the state for.
+
+• **state**: `IEngineState`
+
+The state of the engine to save.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEngineStateStorage.save`

package/docs/reference/functions/initialiseEntityStorageConnector.md

@@ -0,0 +1,31 @@
+# Function: initialiseEntityStorageConnector()
+
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`): `void`
+
+Initialise the entity storage connector.
+
+## Parameters
+
+• **engineCore**: `IEngineCore`
+
+The engine core.
+
+• **context**: `IEngineCoreContext`
+
+The context for the engine.
+
+• **typeCustom**: `undefined` \| `string`
+
+Override the type of connector to use instead of default configuration.
+
+• **schema**: `string`
+
+The schema for the entity storage.
+
+## Returns
+
+`void`
+
+## Throws
+
+GeneralError if the connector type is unknown.

package/docs/reference/index.md

@@ -0,0 +1,15 @@
+# @twin.org/engine-core
+
+## Classes
+
+- [EngineCore](classes/EngineCore.md)
+- [FileStateStorage](classes/FileStateStorage.md)
+- [MemoryStateStorage](classes/MemoryStateStorage.md)
+
+## Interfaces
+
+- [IEngineCoreOptions](interfaces/IEngineCoreOptions.md)
+
+## Functions
+
+- [initialiseEntityStorageConnector](functions/initialiseEntityStorageConnector.md)

package/docs/reference/interfaces/IEngineCoreOptions.md

@@ -0,0 +1,45 @@
+# Interface: IEngineCoreOptions
+
+The options for creating engine core.
+
+## Properties
+
+### config?
+
+> `optional` **config**: `IEngineCoreConfig`
+
+The engine core config.
+
+***
+
+### stateStorage?
+
+> `optional` **stateStorage**: `IEngineStateStorage`
+
+The state storage component.
+
+***
+
+### skipBootstrap?
+
+> `optional` **skipBootstrap**: `boolean`
+
+Skip the bootstrap process, useful for additional engine instances.
+
+***
+
+### customBootstrap()?
+
+> `optional` **customBootstrap**: (`engineCore`, `context`) => `Promise`\<`void`\>
+
+Custom bootstrap method for the engine.
+
+#### Parameters
+
+• **engineCore**: `IEngineCore`
+
+• **context**: `IEngineCoreContext`
+
+#### Returns
+
+`Promise`\<`void`\>

package/locales/en.json

@@ -0,0 +1,42 @@
+{
+	"error": {
+		"engineCore": {
+			"connectorUnknownType": "Unknown connector type \"{type}\" specified for \"{connectorType}\"",
+			"componentUnknownType": "Unknown component type \"{type}\" specified for \"{componentType}\"",
+			"entityStorageCustomMissing": "Entity storage custom \"{typeCustom}\" missing for component \"{storageName}\"",
+			"entityStorageMissing": "Entity storage configuration missing for component \"{storageName}\"",
+			"bootstrapFailed": "Bootstrap failed for component \"{component}\", please check the logs for more information",
+			"componentStopFailed": "Failed to stop component \"{component}\""
+		},
+		"fileStateStorage": {
+			"failedLoading": "Failed to load file state storage from \"{filename}\"",
+			"failedSaving": "Failed to save file state storage to \"{filename}\""
+		}
+	},
+	"engineCore": {
+		"debuggingEnabled": "Debugging is enabled",
+		"starting": "Engine is starting",
+		"started": "Engine has started",
+		"stopping": "Engine is stopping",
+		"stopped": "Engine has stopped",
+		"configuring": "Configuring {element}",
+		"configuringEntityStorage": "Configuring {element} with name \"{storageName}\" using \"{storageType}\" connector",
+		"bootstrapStarted": "Bootstrap started",
+		"bootstrapComplete": "Bootstrap complete",
+		"bootstrapping": "Bootstrap {element}",
+		"componentsStarting": "Components are starting",
+		"componentsComplete": "Components have started",
+		"componentsStopping": "Components are stopping",
+		"componentsStopped": "Components have stopped",
+		"componentStarting": "Starting {element}",
+		"componentStopping": "Stopping {element}"
+	},
+	"fileStateStorage": {
+		"loading": "Loading state from file storage with filename \"{filename}\"",
+		"saving": "Saving state to file storage with filename \"{filename}\""
+	},
+	"memoryStateStorage": {
+		"loading": "Loading state from memory",
+		"saving": "Saving state to memory"
+	}
+}

package/package.json

@@ -0,0 +1,102 @@
+{
+	"name": "@twin.org/engine-core",
+	"version": "0.0.1-next.1",
+	"description": "Engine implementation for a core.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/engine.git",
+		"directory": "packages/engine-core"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-auth-entity-storage-service": "next",
+		"@twin.org/api-core": "next",
+		"@twin.org/api-models": "next",
+		"@twin.org/api-processors": "next",
+		"@twin.org/api-server-fastify": "next",
+		"@twin.org/api-service": "next",
+		"@twin.org/attestation-connector-entity-storage": "next",
+		"@twin.org/attestation-connector-iota": "next",
+		"@twin.org/attestation-models": "next",
+		"@twin.org/attestation-service": "next",
+		"@twin.org/auditable-item-graph-models": "next",
+		"@twin.org/auditable-item-graph-service": "next",
+		"@twin.org/auditable-item-stream-models": "next",
+		"@twin.org/auditable-item-stream-service": "next",
+		"@twin.org/background-task-connector-entity-storage": "next",
+		"@twin.org/background-task-models": "next",
+		"@twin.org/blob-storage-connector-aws-s3": "next",
+		"@twin.org/blob-storage-connector-azure": "next",
+		"@twin.org/blob-storage-connector-file": "next",
+		"@twin.org/blob-storage-connector-gcp": "next",
+		"@twin.org/blob-storage-connector-ipfs": "next",
+		"@twin.org/blob-storage-connector-memory": "next",
+		"@twin.org/blob-storage-models": "next",
+		"@twin.org/blob-storage-service": "next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-schema-org": "next",
+		"@twin.org/engine-models": "0.0.1-next.1",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-connector-cosmosdb": "next",
+		"@twin.org/entity-storage-connector-dynamodb": "next",
+		"@twin.org/entity-storage-connector-file": "next",
+		"@twin.org/entity-storage-connector-gcp-firestore": "next",
+		"@twin.org/entity-storage-connector-memory": "next",
+		"@twin.org/entity-storage-connector-scylladb": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/entity-storage-service": "next",
+		"@twin.org/identity-connector-entity-storage": "next",
+		"@twin.org/identity-connector-iota": "next",
+		"@twin.org/identity-models": "next",
+		"@twin.org/identity-service": "next",
+		"@twin.org/immutable-proof-models": "next",
+		"@twin.org/immutable-proof-service": "next",
+		"@twin.org/immutable-storage-connector-entity-storage": "next",
+		"@twin.org/immutable-storage-connector-iota": "next",
+		"@twin.org/immutable-storage-models": "next",
+		"@twin.org/logging-connector-console": "next",
+		"@twin.org/logging-connector-entity-storage": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/logging-service": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/nft-connector-entity-storage": "next",
+		"@twin.org/nft-connector-iota": "next",
+		"@twin.org/nft-models": "next",
+		"@twin.org/nft-service": "next",
+		"@twin.org/telemetry-connector-entity-storage": "next",
+		"@twin.org/telemetry-models": "next",
+		"@twin.org/telemetry-service": "next",
+		"@twin.org/vault-connector-entity-storage": "next",
+		"@twin.org/vault-connector-hashicorp": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-connector-entity-storage": "next",
+		"@twin.org/wallet-connector-iota": "next",
+		"@twin.org/wallet-models": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}