@twin.org/engine 0.0.2-next.8 → 0.0.3-next.1

package/dist/es/data/coreTypeInitialisers.json

@@ -0,0 +1,267 @@
+[
+    {
+        "type": "loggingConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseLoggingConnector"
+    },
+    {
+        "type": "loggingComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseLoggingComponent"
+    },
+    {
+        "type": "backgroundTaskConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseBackgroundTaskConnector"
+    },
+    {
+        "type": "taskSchedulerComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseTaskSchedulerComponent"
+    },
+    {
+        "type": "eventBusConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseEventBusConnector"
+    },
+    {
+        "type": "eventBusComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseEventBusComponent"
+    },
+    {
+        "type": "telemetryConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseTelemetryConnector"
+    },
+    {
+        "type": "telemetryComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseTelemetryComponent"
+    },
+    {
+        "type": "messagingEmailConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseMessagingEmailConnector"
+    },
+    {
+        "type": "messagingSmsConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseMessagingSmsConnector"
+    },
+    {
+        "type": "messagingPushNotificationConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseMessagingPushNotificationConnector"
+    },
+    {
+        "type": "messagingAdminComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseMessagingAdminComponent"
+    },
+    {
+        "type": "messagingComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseMessagingComponent"
+    },
+    {
+        "type": "entityStorageComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseEntityStorageComponent"
+    },
+    {
+        "type": "vaultConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseVaultConnector"
+    },
+    {
+        "type": "blobStorageConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseBlobStorageConnector"
+    },
+    {
+        "type": "blobStorageComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseBlobStorageComponent"
+    },
+    {
+        "type": "verifiableStorageConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseVerifiableStorageConnector"
+    },
+    {
+        "type": "verifiableStorageComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseVerifiableStorageComponent"
+    },
+    {
+        "type": "faucetConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseFaucetConnector"
+    },
+    {
+        "type": "walletConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseWalletConnector"
+    },
+    {
+        "type": "identityConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityConnector"
+    },
+    {
+        "type": "identityComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityComponent"
+    },
+    {
+        "type": "identityResolverConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityResolverConnector"
+    },
+    {
+        "type": "identityResolverComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityResolverComponent"
+    },
+    {
+        "type": "identityProfileConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityProfileConnector"
+    },
+    {
+        "type": "identityProfileComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseIdentityProfileComponent"
+    },
+    {
+        "type": "nftConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseNftConnector"
+    },
+    {
+        "type": "nftComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseNftComponent"
+    },
+    {
+        "type": "immutableProofComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseImmutableProofComponent"
+    },
+    {
+        "type": "attestationConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseAttestationConnector"
+    },
+    {
+        "type": "attestationComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseAttestationComponent"
+    },
+    {
+        "type": "auditableItemGraphComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseAuditableItemGraphComponent"
+    },
+    {
+        "type": "auditableItemStreamComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseAuditableItemStreamComponent"
+    },
+    {
+        "type": "dataConverterConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseDataConverterConnector"
+    },
+    {
+        "type": "dataExtractorConnector",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseDataExtractorConnector"
+    },
+    {
+        "type": "dataProcessingComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseDataProcessingComponent"
+    },
+    {
+        "type": "documentManagementComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseDocumentManagementComponent"
+    },
+    {
+        "type": "authenticationGeneratorComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseAuthenticationGeneratorComponent"
+    },
+    {
+        "type": "rightsManagementPapComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPapComponent"
+    },
+    {
+        "type": "rightsManagementPmpComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPmpComponent"
+    },
+    {
+        "type": "rightsManagementPxpComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPxpComponent"
+    },
+    {
+        "type": "rightsManagementPipComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPipComponent"
+    },
+    {
+        "type": "rightsManagementPdpComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPdpComponent"
+    },
+    {
+        "type": "rightsManagementPepComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPepComponent"
+    },
+    {
+        "type": "rightsManagementPnapComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPnapComponent"
+    },
+    {
+        "type": "rightsManagementPnpComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementPnpComponent"
+    },
+    {
+        "type": "rightsManagementDapComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementDapComponent"
+    },
+    {
+        "type": "rightsManagementDarpComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseRightsManagementDarpComponent"
+    },
+    {
+        "type": "synchronisedStorageComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseSynchronisedStorageComponent"
+    },
+    {
+        "type": "federatedCatalogueComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseFederatedCatalogueComponent"
+    },
+    {
+        "type": "dataSpaceConnectorComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseDataSpaceConnectorComponent"
+    },
+    {
+        "type": "tenantAdminComponent",
+        "module": "@twin.org/engine-types",
+        "method": "initialiseTenantAdminComponent"
+    }
+]

package/dist/es/engine.js

@@ -0,0 +1,31 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { EngineCore } from "@twin.org/engine-core";
+import coreTypeInitialisers from "./data/coreTypeInitialisers.json" with { type: "json" };
+/**
+ * The engine with built in types.
+ */
+export class Engine extends EngineCore {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Engine";
+    /**
+     * Create a new instance of Engine.
+     * @param options The options for the engine.
+     */
+    constructor(options) {
+        super(options);
+        this.addCoreTypeInitialisers();
+    }
+    /**
+     * Add the core type initializers.
+     * @internal
+     */
+    addCoreTypeInitialisers() {
+        for (const initializer of coreTypeInitialisers) {
+            this.addTypeInitialiser(initializer.type, initializer.module, initializer.method);
+        }
+    }
+}
+//# sourceMappingURL=engine.js.map

package/dist/es/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../../src/engine.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,UAAU,EAA2B,MAAM,uBAAuB,CAAC;AAI5E,OAAO,oBAAoB,MAAM,kCAAkC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE1F;;GAEG;AACH,MAAM,OAAO,MAGX,SAAQ,UAAgB;IACzB;;OAEG;IACI,MAAM,CAAU,UAAU,YAA4B;IAE7D;;;OAGG;IACH,YAAY,OAAkC;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,uBAAuB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACK,uBAAuB;QAC9B,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;YAChD,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QACnF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { EngineCore, type IEngineCoreOptions } from \"@twin.org/engine-core\";\nimport type { IEngineState } from \"@twin.org/engine-models\";\nimport type { IEngineConfig } from \"@twin.org/engine-types\";\nimport { nameof } from \"@twin.org/nameof\";\nimport coreTypeInitialisers from \"./data/coreTypeInitialisers.json\" with { type: \"json\" };\n\n/**\n * The engine with built in types.\n */\nexport class Engine<\n\tC extends IEngineConfig = IEngineConfig,\n\tS extends IEngineState = IEngineState\n> extends EngineCore<C, S> {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Engine>();\n\n\t/**\n\t * Create a new instance of Engine.\n\t * @param options The options for the engine.\n\t */\n\tconstructor(options?: IEngineCoreOptions<C, S>) {\n\t\tsuper(options);\n\n\t\tthis.addCoreTypeInitialisers();\n\t}\n\n\t/**\n\t * Add the core type initializers.\n\t * @internal\n\t */\n\tprivate addCoreTypeInitialisers(): void {\n\t\tfor (const initializer of coreTypeInitialisers) {\n\t\t\tthis.addTypeInitialiser(initializer.type, initializer.module, initializer.method);\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,5 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./engine.js";
+export * from "./utils/engineConfigHelper.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./engine.js\";\nexport * from \"./utils/engineConfigHelper.js\";\n"]}

package/dist/es/utils/engineConfigHelper.js

@@ -0,0 +1,40 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdKeys } from "@twin.org/context";
+import { Guards, Is, StringHelper } from "@twin.org/core";
+import { EntityStorageComponentType } from "@twin.org/engine-types";
+import { EntitySchemaFactory } from "@twin.org/entity";
+/**
+ * Helper methods for engine config.
+ */
+export class EngineConfigHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "EngineConfigHelper";
+    /**
+     * Add a custom entity storage to the engine configuration.
+     * @param engineConfig The engine configuration.
+     * @param entityTypeName The entity type name.
+     * @param entitySchema The entity schema.
+     * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
+     * @param partitionContextIds The context ids to use for partitioning.
+     */
+    static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, partitionContextIds) {
+        Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
+        Guards.stringValue(EngineConfigHelper.CLASS_NAME, "entityTypeName", entityTypeName);
+        Guards.object(EngineConfigHelper.CLASS_NAME, "entitySchema", entitySchema);
+        engineConfig.types.entityStorageComponent ??= [];
+        EntitySchemaFactory.register(entityTypeName, () => entitySchema);
+        engineConfig.types.entityStorageComponent.push({
+            type: EntityStorageComponentType.Service,
+            options: {
+                entityStorageType: entityTypeName,
+                partitionContextIds: partitionContextIds ?? [ContextIdKeys.Node, ContextIdKeys.Tenant]
+            },
+            overrideInstanceType: StringHelper.kebabCase(entityTypeName),
+            restPath: Is.stringValue(restPath) ? restPath : undefined
+        });
+    }
+}
+//# sourceMappingURL=engineConfigHelper.js.map

package/dist/es/utils/engineConfigHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineConfigHelper.js","sourceRoot":"","sources":["../../../src/utils/engineConfigHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAsB,MAAM,wBAAwB,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAsB,MAAM,kBAAkB,CAAC;AAG3E;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;;;;;OAOG;IACI,MAAM,CAAC,sBAAsB,CACnC,YAA2B,EAC3B,cAAsB,EACtB,YAA8B,EAC9B,QAAiB,EACjB,mBAA8B;QAE9B,MAAM,CAAC,MAAM,CAAgB,kBAAkB,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAChG,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,oBAA0B,cAAc,CAAC,CAAC;QAC1F,MAAM,CAAC,MAAM,CAAgB,kBAAkB,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAEhG,YAAY,CAAC,KAAK,CAAC,sBAAsB,KAAK,EAAE,CAAC;QAEjD,mBAAmB,CAAC,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,CAAC;QAEjE,YAAY,CAAC,KAAK,CAAC,sBAAsB,CAAC,IAAI,CAAC;YAC9C,IAAI,EAAE,0BAA0B,CAAC,OAAO;YACxC,OAAO,EAAE;gBACR,iBAAiB,EAAE,cAAc;gBACjC,mBAAmB,EAAE,mBAAmB,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;aACtF;YACD,oBAAoB,EAAE,YAAY,CAAC,SAAS,CAAC,cAAc,CAAC;YAC5D,QAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;SACzD,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ContextIdKeys } from \"@twin.org/context\";\nimport { Guards, Is, StringHelper } from \"@twin.org/core\";\nimport { EntityStorageComponentType, type IEngineConfig } from \"@twin.org/engine-types\";\nimport { EntitySchemaFactory, type IEntitySchema } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Helper methods for engine config.\n */\nexport class EngineConfigHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<EngineConfigHelper>();\n\n\t/**\n\t * Add a custom entity storage to the engine configuration.\n\t * @param engineConfig The engine configuration.\n\t * @param entityTypeName The entity type name.\n\t * @param entitySchema The entity schema.\n\t * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.\n\t * @param partitionContextIds The context ids to use for partitioning.\n\t */\n\tpublic static addCustomEntityStorage<T>(\n\t\tengineConfig: IEngineConfig,\n\t\tentityTypeName: string,\n\t\tentitySchema: IEntitySchema<T>,\n\t\trestPath?: string,\n\t\tpartitionContextIds?: string[]\n\t): void {\n\t\tGuards.object<IEngineConfig>(EngineConfigHelper.CLASS_NAME, nameof(engineConfig), engineConfig);\n\t\tGuards.stringValue(EngineConfigHelper.CLASS_NAME, nameof(entityTypeName), entityTypeName);\n\t\tGuards.object<IEntitySchema>(EngineConfigHelper.CLASS_NAME, nameof(entitySchema), entitySchema);\n\n\t\tengineConfig.types.entityStorageComponent ??= [];\n\n\t\tEntitySchemaFactory.register(entityTypeName, () => entitySchema);\n\n\t\tengineConfig.types.entityStorageComponent.push({\n\t\t\ttype: EntityStorageComponentType.Service,\n\t\t\toptions: {\n\t\t\t\tentityStorageType: entityTypeName,\n\t\t\t\tpartitionContextIds: partitionContextIds ?? [ContextIdKeys.Node, ContextIdKeys.Tenant]\n\t\t\t},\n\t\t\toverrideInstanceType: StringHelper.kebabCase(entityTypeName),\n\t\t\trestPath: Is.stringValue(restPath) ? restPath : undefined\n\t\t});\n\t}\n}\n"]}

package/dist/types/engine.d.ts

@@ -8,7 +8,7 @@ export declare class Engine<C extends IEngineConfig = IEngineConfig, S extends I
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of Engine.
      * @param options The options for the engine.

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./engine";
-export * from "./utils/engineConfigHelper";
+export * from "./engine.js";
+export * from "./utils/engineConfigHelper.js";

package/dist/types/utils/engineConfigHelper.d.ts

@@ -14,10 +14,7 @@ export declare class EngineConfigHelper {
      * @param entityTypeName The entity type name.
      * @param entitySchema The entity schema.
      * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
-     * @param options Additional options.
-     * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
+     * @param partitionContextIds The context ids to use for partitioning.
      */
-    static addCustomEntityStorage<T>(engineConfig: IEngineConfig, entityTypeName: string, entitySchema: IEntitySchema<T>, restPath?: string, options?: {
-        partitionPerUser?: boolean;
-    }): void;
+    static addCustomEntityStorage<T>(engineConfig: IEngineConfig, entityTypeName: string, entitySchema: IEntitySchema<T>, restPath?: string, partitionContextIds?: string[]): void;
 }

package/docs/changelog.md

@@ -1,5 +1,339 @@
 # @twin.org/engine - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/engine/compare/engine-v0.0.3-next.0...engine-v0.0.3-next.1) (2025-11-13)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add context id features ([#51](https://github.com/twinfoundation/engine/issues/51)) ([eaef180](https://github.com/twinfoundation/engine/commit/eaef1807397a907bc7655ef1545a151a710ca2f1))
+* add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
+* add default logging component for web server ([8ad94f0](https://github.com/twinfoundation/engine/commit/8ad94f0d2d9a5241a8854b1e59fb9a55ce310142))
+* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+* add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
+* add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+* addCustomEntityStorage optional rest path ([55f42c5](https://github.com/twinfoundation/engine/commit/55f42c568945f010eb8883e27fb385d2c30eebff))
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+* gas station integration ([#17](https://github.com/twinfoundation/engine/issues/17)) ([a3f844a](https://github.com/twinfoundation/engine/commit/a3f844a7fc58c43b4d0700d8d4351062045e66e1))
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+* move environment variable processing to node level ([2223c12](https://github.com/twinfoundation/engine/commit/2223c12f49f3d34051ecec9687351aa5dd094e54))
+* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+* update includeUserIdentity usage ([d34f597](https://github.com/twinfoundation/engine/commit/d34f597a61f9645a029411d2911bbda20ddc9eb9))
+* update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
+* update rights management config ([d447575](https://github.com/twinfoundation/engine/commit/d447575cd5cdf3cdf1fe92087e90188ec97516f5))
+* update rights management dependencies ([14d06fb](https://github.com/twinfoundation/engine/commit/14d06fb6604ad04e4094da7b51b61a01a0280b8b))
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Bug Fixes
+
+* blob storage encryption settings ([63ee879](https://github.com/twinfoundation/engine/commit/63ee87904d2be205d8fe2fa11b536790a0d22082))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.0 to 0.0.3-next.1
+    * @twin.org/engine-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+    * @twin.org/engine-types bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.26](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.25...engine-v0.0.2-next.26) (2025-10-09)
+
+
+### Miscellaneous Chores
+
+* **engine:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.25 to 0.0.2-next.26
+    * @twin.org/engine-models bumped from 0.0.2-next.25 to 0.0.2-next.26
+    * @twin.org/engine-types bumped from 0.0.2-next.25 to 0.0.2-next.26
+
+## [0.0.2-next.25](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.24...engine-v0.0.2-next.25) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([b92ea09](https://github.com/twinfoundation/engine/commit/b92ea09dbcfe35225271a51f24d231f59e2d363e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.24 to 0.0.2-next.25
+    * @twin.org/engine-models bumped from 0.0.2-next.24 to 0.0.2-next.25
+    * @twin.org/engine-types bumped from 0.0.2-next.24 to 0.0.2-next.25
+
+## [0.0.2-next.24](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.23...engine-v0.0.2-next.24) (2025-10-08)
+
+
+### Features
+
+* maintain isDefault flag for registered instances ([2ac5bee](https://github.com/twinfoundation/engine/commit/2ac5bee094bef42b396cc82b0d18bb6aebe27352))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.23 to 0.0.2-next.24
+    * @twin.org/engine-models bumped from 0.0.2-next.23 to 0.0.2-next.24
+    * @twin.org/engine-types bumped from 0.0.2-next.23 to 0.0.2-next.24
+
+## [0.0.2-next.23](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.22...engine-v0.0.2-next.23) (2025-10-07)
+
+
+### Features
+
+* override type initialisers with new registrations ([5b4ff56](https://github.com/twinfoundation/engine/commit/5b4ff561d06b6513c870a72bb20ba23c0653cfe8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.22 to 0.0.2-next.23
+    * @twin.org/engine-models bumped from 0.0.2-next.22 to 0.0.2-next.23
+    * @twin.org/engine-types bumped from 0.0.2-next.22 to 0.0.2-next.23
+
+## [0.0.2-next.22](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.21...engine-v0.0.2-next.22) (2025-10-07)
+
+
+### Miscellaneous Chores
+
+* **engine:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/engine-models bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/engine-types bumped from 0.0.2-next.21 to 0.0.2-next.22
+
+## [0.0.2-next.21](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.20...engine-v0.0.2-next.21) (2025-10-07)
+
+
+### Features
+
+* use peer dependencies ([69dd744](https://github.com/twinfoundation/engine/commit/69dd7449010b8e6f5f35e7fad201ad4c1cab400c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/engine-models bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/engine-types bumped from 0.0.2-next.20 to 0.0.2-next.21
+
+## [0.0.2-next.20](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.19...engine-v0.0.2-next.20) (2025-10-06)
+
+
+### Features
+
+* standardised engine logging naming ([0dbf857](https://github.com/twinfoundation/engine/commit/0dbf857587641f86ddf010143519d0e8333489ff))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.19 to 0.0.2-next.20
+    * @twin.org/engine-models bumped from 0.0.2-next.19 to 0.0.2-next.20
+    * @twin.org/engine-types bumped from 0.0.2-next.19 to 0.0.2-next.20
+
+## [0.0.2-next.19](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.18...engine-v0.0.2-next.19) (2025-10-02)
+
+
+### Features
+
+* simplify config building ([732c871](https://github.com/twinfoundation/engine/commit/732c871c5aca236759168f4bc15aeffd98a330a8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/engine-models bumped from 0.0.2-next.18 to 0.0.2-next.19
+    * @twin.org/engine-types bumped from 0.0.2-next.18 to 0.0.2-next.19
+
+## [0.0.2-next.18](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.17...engine-v0.0.2-next.18) (2025-09-29)
+
+
+### Features
+
+* upgrade framework components ([efd52e8](https://github.com/twinfoundation/engine/commit/efd52e80564fff29c3897bfa09b6305b3a322812))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/engine-models bumped from 0.0.2-next.17 to 0.0.2-next.18
+    * @twin.org/engine-types bumped from 0.0.2-next.17 to 0.0.2-next.18
+
+## [0.0.2-next.17](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.16...engine-v0.0.2-next.17) (2025-09-26)
+
+
+### Features
+
+* add engine type helper for config lookups ([a20a398](https://github.com/twinfoundation/engine/commit/a20a3987016c48351178ab8410bc05b0fba0f2c1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.16 to 0.0.2-next.17
+    * @twin.org/engine-models bumped from 0.0.2-next.16 to 0.0.2-next.17
+    * @twin.org/engine-types bumped from 0.0.2-next.16 to 0.0.2-next.17
+
+## [0.0.2-next.16](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.15...engine-v0.0.2-next.16) (2025-09-25)
+
+
+### Miscellaneous Chores
+
+* **engine:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.15 to 0.0.2-next.16
+    * @twin.org/engine-types bumped from 0.0.2-next.15 to 0.0.2-next.16
+
+## [0.0.2-next.15](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.14...engine-v0.0.2-next.15) (2025-09-24)
+
+
+### Features
+
+* update rights management and add authentication generators ([f728a1e](https://github.com/twinfoundation/engine/commit/f728a1efea15ada8d10cfbe17cafe7e2b252f527))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.14 to 0.0.2-next.15
+    * @twin.org/engine-types bumped from 0.0.2-next.14 to 0.0.2-next.15
+
+## [0.0.2-next.14](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.13...engine-v0.0.2-next.14) (2025-09-19)
+
+
+### Features
+
+* add latest rights management components ([2d305c8](https://github.com/twinfoundation/engine/commit/2d305c8c85c77bb4f5694c76422db4a11efc1a40))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.13 to 0.0.2-next.14
+    * @twin.org/engine-types bumped from 0.0.2-next.13 to 0.0.2-next.14
+
+## [0.0.2-next.13](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.12...engine-v0.0.2-next.13) (2025-09-08)
+
+
+### Features
+
+* update rights management dependencies ([14d06fb](https://github.com/twinfoundation/engine/commit/14d06fb6604ad04e4094da7b51b61a01a0280b8b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.12 to 0.0.2-next.13
+    * @twin.org/engine-types bumped from 0.0.2-next.12 to 0.0.2-next.13
+
+## [0.0.2-next.12](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.11...engine-v0.0.2-next.12) (2025-09-05)
+
+
+### Features
+
+* add rights management negotiation ([84ef46b](https://github.com/twinfoundation/engine/commit/84ef46bff110611a19512793425c8c873ee2a590))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.11 to 0.0.2-next.12
+    * @twin.org/engine-types bumped from 0.0.2-next.11 to 0.0.2-next.12
+
+## [0.0.2-next.11](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.10...engine-v0.0.2-next.11) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([6b978da](https://github.com/twinfoundation/engine/commit/6b978daf777a615d7758b63c3df57d5a376f6dfb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.10 to 0.0.2-next.11
+    * @twin.org/engine-types bumped from 0.0.2-next.10 to 0.0.2-next.11
+
+## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.9...engine-v0.0.2-next.10) (2025-08-26)
+
+
+### Features
+
+* add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.9 to 0.0.2-next.10
+    * @twin.org/engine-types bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.8...engine-v0.0.2-next.9) (2025-08-25)
+
+
+### Features
+
+* add isPrimary and isClone methods ([a7c63e9](https://github.com/twinfoundation/engine/commit/a7c63e97f54c95b104cc81e66d3fa42c6607bdc1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.2-next.8 to 0.0.2-next.9
+    * @twin.org/engine-types bumped from 0.0.2-next.8 to 0.0.2-next.9
+
 ## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-v0.0.2-next.7...engine-v0.0.2-next.8) (2025-08-22)
 
 

package/docs/reference/classes/Engine.md

@@ -44,6 +44,10 @@ The options for the engine.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
+
+#### Overrides
+
+`EngineCore.CLASS_NAME`

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/locales/en.json

@@ -1,43 +1 @@
-{
-	"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}\"",
-			"moduleMethodFailed": "Failed to load method \"{method}\" from module \"{module}\""
-		},
-		"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

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine",
-	"version": "0.0.2-next.8",
+	"version": "0.0.3-next.1",
 	"description": "Engine implementation.",
 	"repository": {
 		"type": "git",
@@ -14,28 +14,40 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/engine-core": "0.0.2-next.8",
-		"@twin.org/engine-types": "0.0.2-next.8",
+		"@twin.org/engine-core": "0.0.3-next.1",
+		"@twin.org/engine-models": "0.0.3-next.1",
+		"@twin.org/engine-types": "0.0.3-next.1",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"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"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"engine"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/engine/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,121 +0,0 @@
-'use strict';
-
-var engineCore = require('@twin.org/engine-core');
-var core = require('@twin.org/core');
-var engineTypes = require('@twin.org/engine-types');
-var entity = require('@twin.org/entity');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The engine with built in types.
- */
-class Engine extends engineCore.EngineCore {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "Engine";
-    /**
-     * Create a new instance of Engine.
-     * @param options The options for the engine.
-     */
-    constructor(options) {
-        super(options);
-        this.addCoreTypeInitialisers();
-    }
-    /**
-     * Add the core type initializers.
-     * @internal
-     */
-    addCoreTypeInitialisers() {
-        this.addTypeInitialiser("loggingConnector", this._context.config.types.loggingConnector, "@twin.org/engine-types", "initialiseLoggingConnector");
-        this.addTypeInitialiser("loggingComponent", this._context.config.types.loggingComponent, "@twin.org/engine-types", "initialiseLoggingComponent");
-        this.addTypeInitialiser("backgroundTaskConnector", this._context.config.types.backgroundTaskConnector, "@twin.org/engine-types", "initialiseBackgroundTaskConnector");
-        this.addTypeInitialiser("taskSchedulerComponent", this._context.config.types.taskSchedulerComponent, "@twin.org/engine-types", "initialiseTaskSchedulerComponent");
-        this.addTypeInitialiser("eventBusConnector", this._context.config.types.eventBusConnector, "@twin.org/engine-types", "initialiseEventBusConnector");
-        this.addTypeInitialiser("eventBusComponent", this._context.config.types.eventBusComponent, "@twin.org/engine-types", "initialiseEventBusComponent");
-        this.addTypeInitialiser("telemetryConnector", this._context.config.types.telemetryConnector, "@twin.org/engine-types", "initialiseTelemetryConnector");
-        this.addTypeInitialiser("telemetryComponent", this._context.config.types.telemetryComponent, "@twin.org/engine-types", "initialiseTelemetryComponent");
-        this.addTypeInitialiser("messagingEmailConnector", this._context.config.types.messagingEmailConnector, "@twin.org/engine-types", "initialiseMessagingEmailConnector");
-        this.addTypeInitialiser("messagingSmsConnector", this._context.config.types.messagingSmsConnector, "@twin.org/engine-types", "initialiseMessagingSmsConnector");
-        this.addTypeInitialiser("messagingPushNotificationConnector", this._context.config.types.messagingPushNotificationConnector, "@twin.org/engine-types", "initialiseMessagingPushNotificationConnector");
-        this.addTypeInitialiser("messagingComponent", this._context.config.types.messagingComponent, "@twin.org/engine-types", "initialiseMessagingComponent");
-        this.addTypeInitialiser("entityStorageComponent", this._context.config.types.entityStorageComponent, "@twin.org/engine-types", "initialiseEntityStorageComponent");
-        this.addTypeInitialiser("vaultConnector", this._context.config.types.vaultConnector, "@twin.org/engine-types", "initialiseVaultConnector");
-        this.addTypeInitialiser("blobStorageConnector", this._context.config.types.blobStorageConnector, "@twin.org/engine-types", "initialiseBlobStorageConnector");
-        this.addTypeInitialiser("blobStorageComponent", this._context.config.types.blobStorageComponent, "@twin.org/engine-types", "initialiseBlobStorageComponent");
-        this.addTypeInitialiser("verifiableStorageConnector", this._context.config.types.verifiableStorageConnector, "@twin.org/engine-types", "initialiseVerifiableStorageConnector");
-        this.addTypeInitialiser("verifiableStorageComponent", this._context.config.types.verifiableStorageComponent, "@twin.org/engine-types", "initialiseVerifiableStorageComponent");
-        this.addTypeInitialiser("walletConnector", this._context.config.types.walletConnector, "@twin.org/engine-types", "initialiseWalletStorage");
-        this.addTypeInitialiser("faucetConnector", this._context.config.types.faucetConnector, "@twin.org/engine-types", "initialiseFaucetConnector");
-        this.addTypeInitialiser("walletConnector", this._context.config.types.walletConnector, "@twin.org/engine-types", "initialiseWalletConnector");
-        this.addTypeInitialiser("identityConnector", this._context.config.types.identityConnector, "@twin.org/engine-types", "initialiseIdentityConnector");
-        this.addTypeInitialiser("identityComponent", this._context.config.types.identityComponent, "@twin.org/engine-types", "initialiseIdentityComponent");
-        this.addTypeInitialiser("identityResolverConnector", this._context.config.types.identityResolverConnector, "@twin.org/engine-types", "initialiseIdentityResolverConnector");
-        this.addTypeInitialiser("identityResolverComponent", this._context.config.types.identityResolverComponent, "@twin.org/engine-types", "initialiseIdentityResolverComponent");
-        this.addTypeInitialiser("identityProfileConnector", this._context.config.types.identityProfileConnector, "@twin.org/engine-types", "initialiseIdentityProfileConnector");
-        this.addTypeInitialiser("identityProfileComponent", this._context.config.types.identityProfileComponent, "@twin.org/engine-types", "initialiseIdentityProfileComponent");
-        this.addTypeInitialiser("nftConnector", this._context.config.types.nftConnector, "@twin.org/engine-types", "initialiseNftConnector");
-        this.addTypeInitialiser("nftComponent", this._context.config.types.nftComponent, "@twin.org/engine-types", "initialiseNftComponent");
-        this.addTypeInitialiser("immutableProofComponent", this._context.config.types.immutableProofComponent, "@twin.org/engine-types", "initialiseImmutableProofComponent");
-        this.addTypeInitialiser("attestationConnector", this._context.config.types.attestationConnector, "@twin.org/engine-types", "initialiseAttestationConnector");
-        this.addTypeInitialiser("attestationComponent", this._context.config.types.attestationComponent, "@twin.org/engine-types", "initialiseAttestationComponent");
-        this.addTypeInitialiser("auditableItemGraphComponent", this._context.config.types.auditableItemGraphComponent, "@twin.org/engine-types", "initialiseAuditableItemGraphComponent");
-        this.addTypeInitialiser("auditableItemStreamComponent", this._context.config.types.auditableItemStreamComponent, "@twin.org/engine-types", "initialiseAuditableItemStreamComponent");
-        this.addTypeInitialiser("dataConverterConnector", this._context.config.types.dataConverterConnector, "@twin.org/engine-types", "initialiseDataConverterConnector");
-        this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
-        this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
-        this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
-        this.addTypeInitialiser("rightsManagementPapComponent", this._context.config.types.rightsManagementPapComponent, "@twin.org/engine-types", "initialiseRightsManagementPapComponent");
-        this.addTypeInitialiser("rightsManagementPmpComponent", this._context.config.types.rightsManagementPmpComponent, "@twin.org/engine-types", "initialiseRightsManagementPmpComponent");
-        this.addTypeInitialiser("rightsManagementPxpComponent", this._context.config.types.rightsManagementPxpComponent, "@twin.org/engine-types", "initialiseRightsManagementPxpComponent");
-        this.addTypeInitialiser("rightsManagementPipComponent", this._context.config.types.rightsManagementPipComponent, "@twin.org/engine-types", "initialiseRightsManagementPipComponent");
-        this.addTypeInitialiser("rightsManagementPdpComponent", this._context.config.types.rightsManagementPdpComponent, "@twin.org/engine-types", "initialiseRightsManagementPdpComponent");
-        this.addTypeInitialiser("rightsManagementPepComponent", this._context.config.types.rightsManagementPepComponent, "@twin.org/engine-types", "initialiseRightsManagementPepComponent");
-        this.addTypeInitialiser("rightsManagementComponent", this._context.config.types.rightsManagementComponent, "@twin.org/engine-types", "initialiseRightsManagementComponent");
-        this.addTypeInitialiser("synchronisedStorageComponent", this._context.config.types.synchronisedStorageComponent, "@twin.org/engine-types", "initialiseSynchronisedStorageComponent");
-        this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper methods for engine config.
- */
-class EngineConfigHelper {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EngineConfigHelper";
-    /**
-     * Add a custom entity storage to the engine configuration.
-     * @param engineConfig The engine configuration.
-     * @param entityTypeName The entity type name.
-     * @param entitySchema The entity schema.
-     * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
-     * @param options Additional options.
-     * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
-     */
-    static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
-        core.Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
-        core.Guards.stringValue(EngineConfigHelper.CLASS_NAME, "entityTypeName", entityTypeName);
-        core.Guards.object(EngineConfigHelper.CLASS_NAME, "entitySchema", entitySchema);
-        engineConfig.types.entityStorageComponent ??= [];
-        entity.EntitySchemaFactory.register(entityTypeName, () => entitySchema);
-        engineConfig.types.entityStorageComponent.push({
-            type: engineTypes.EntityStorageComponentType.Service,
-            options: {
-                entityStorageType: entityTypeName,
-                config: {
-                    partitionPerUser: options?.partitionPerUser
-                }
-            },
-            overrideInstanceType: core.StringHelper.kebabCase(entityTypeName),
-            restPath: core.Is.stringValue(restPath) ? restPath : undefined
-        });
-    }
-}
-
-exports.Engine = Engine;
-exports.EngineConfigHelper = EngineConfigHelper;

package/dist/esm/index.mjs

@@ -1,118 +0,0 @@
-import { EngineCore } from '@twin.org/engine-core';
-import { Guards, StringHelper, Is } from '@twin.org/core';
-import { EntityStorageComponentType } from '@twin.org/engine-types';
-import { EntitySchemaFactory } from '@twin.org/entity';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The engine with built in types.
- */
-class Engine extends EngineCore {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "Engine";
-    /**
-     * Create a new instance of Engine.
-     * @param options The options for the engine.
-     */
-    constructor(options) {
-        super(options);
-        this.addCoreTypeInitialisers();
-    }
-    /**
-     * Add the core type initializers.
-     * @internal
-     */
-    addCoreTypeInitialisers() {
-        this.addTypeInitialiser("loggingConnector", this._context.config.types.loggingConnector, "@twin.org/engine-types", "initialiseLoggingConnector");
-        this.addTypeInitialiser("loggingComponent", this._context.config.types.loggingComponent, "@twin.org/engine-types", "initialiseLoggingComponent");
-        this.addTypeInitialiser("backgroundTaskConnector", this._context.config.types.backgroundTaskConnector, "@twin.org/engine-types", "initialiseBackgroundTaskConnector");
-        this.addTypeInitialiser("taskSchedulerComponent", this._context.config.types.taskSchedulerComponent, "@twin.org/engine-types", "initialiseTaskSchedulerComponent");
-        this.addTypeInitialiser("eventBusConnector", this._context.config.types.eventBusConnector, "@twin.org/engine-types", "initialiseEventBusConnector");
-        this.addTypeInitialiser("eventBusComponent", this._context.config.types.eventBusComponent, "@twin.org/engine-types", "initialiseEventBusComponent");
-        this.addTypeInitialiser("telemetryConnector", this._context.config.types.telemetryConnector, "@twin.org/engine-types", "initialiseTelemetryConnector");
-        this.addTypeInitialiser("telemetryComponent", this._context.config.types.telemetryComponent, "@twin.org/engine-types", "initialiseTelemetryComponent");
-        this.addTypeInitialiser("messagingEmailConnector", this._context.config.types.messagingEmailConnector, "@twin.org/engine-types", "initialiseMessagingEmailConnector");
-        this.addTypeInitialiser("messagingSmsConnector", this._context.config.types.messagingSmsConnector, "@twin.org/engine-types", "initialiseMessagingSmsConnector");
-        this.addTypeInitialiser("messagingPushNotificationConnector", this._context.config.types.messagingPushNotificationConnector, "@twin.org/engine-types", "initialiseMessagingPushNotificationConnector");
-        this.addTypeInitialiser("messagingComponent", this._context.config.types.messagingComponent, "@twin.org/engine-types", "initialiseMessagingComponent");
-        this.addTypeInitialiser("entityStorageComponent", this._context.config.types.entityStorageComponent, "@twin.org/engine-types", "initialiseEntityStorageComponent");
-        this.addTypeInitialiser("vaultConnector", this._context.config.types.vaultConnector, "@twin.org/engine-types", "initialiseVaultConnector");
-        this.addTypeInitialiser("blobStorageConnector", this._context.config.types.blobStorageConnector, "@twin.org/engine-types", "initialiseBlobStorageConnector");
-        this.addTypeInitialiser("blobStorageComponent", this._context.config.types.blobStorageComponent, "@twin.org/engine-types", "initialiseBlobStorageComponent");
-        this.addTypeInitialiser("verifiableStorageConnector", this._context.config.types.verifiableStorageConnector, "@twin.org/engine-types", "initialiseVerifiableStorageConnector");
-        this.addTypeInitialiser("verifiableStorageComponent", this._context.config.types.verifiableStorageComponent, "@twin.org/engine-types", "initialiseVerifiableStorageComponent");
-        this.addTypeInitialiser("walletConnector", this._context.config.types.walletConnector, "@twin.org/engine-types", "initialiseWalletStorage");
-        this.addTypeInitialiser("faucetConnector", this._context.config.types.faucetConnector, "@twin.org/engine-types", "initialiseFaucetConnector");
-        this.addTypeInitialiser("walletConnector", this._context.config.types.walletConnector, "@twin.org/engine-types", "initialiseWalletConnector");
-        this.addTypeInitialiser("identityConnector", this._context.config.types.identityConnector, "@twin.org/engine-types", "initialiseIdentityConnector");
-        this.addTypeInitialiser("identityComponent", this._context.config.types.identityComponent, "@twin.org/engine-types", "initialiseIdentityComponent");
-        this.addTypeInitialiser("identityResolverConnector", this._context.config.types.identityResolverConnector, "@twin.org/engine-types", "initialiseIdentityResolverConnector");
-        this.addTypeInitialiser("identityResolverComponent", this._context.config.types.identityResolverComponent, "@twin.org/engine-types", "initialiseIdentityResolverComponent");
-        this.addTypeInitialiser("identityProfileConnector", this._context.config.types.identityProfileConnector, "@twin.org/engine-types", "initialiseIdentityProfileConnector");
-        this.addTypeInitialiser("identityProfileComponent", this._context.config.types.identityProfileComponent, "@twin.org/engine-types", "initialiseIdentityProfileComponent");
-        this.addTypeInitialiser("nftConnector", this._context.config.types.nftConnector, "@twin.org/engine-types", "initialiseNftConnector");
-        this.addTypeInitialiser("nftComponent", this._context.config.types.nftComponent, "@twin.org/engine-types", "initialiseNftComponent");
-        this.addTypeInitialiser("immutableProofComponent", this._context.config.types.immutableProofComponent, "@twin.org/engine-types", "initialiseImmutableProofComponent");
-        this.addTypeInitialiser("attestationConnector", this._context.config.types.attestationConnector, "@twin.org/engine-types", "initialiseAttestationConnector");
-        this.addTypeInitialiser("attestationComponent", this._context.config.types.attestationComponent, "@twin.org/engine-types", "initialiseAttestationComponent");
-        this.addTypeInitialiser("auditableItemGraphComponent", this._context.config.types.auditableItemGraphComponent, "@twin.org/engine-types", "initialiseAuditableItemGraphComponent");
-        this.addTypeInitialiser("auditableItemStreamComponent", this._context.config.types.auditableItemStreamComponent, "@twin.org/engine-types", "initialiseAuditableItemStreamComponent");
-        this.addTypeInitialiser("dataConverterConnector", this._context.config.types.dataConverterConnector, "@twin.org/engine-types", "initialiseDataConverterConnector");
-        this.addTypeInitialiser("dataExtractorConnector", this._context.config.types.dataExtractorConnector, "@twin.org/engine-types", "initialiseDataExtractorConnector");
-        this.addTypeInitialiser("dataProcessingComponent", this._context.config.types.dataProcessingComponent, "@twin.org/engine-types", "initialiseDataProcessingComponent");
-        this.addTypeInitialiser("documentManagementComponent", this._context.config.types.documentManagementComponent, "@twin.org/engine-types", "initialiseDocumentManagementComponent");
-        this.addTypeInitialiser("rightsManagementPapComponent", this._context.config.types.rightsManagementPapComponent, "@twin.org/engine-types", "initialiseRightsManagementPapComponent");
-        this.addTypeInitialiser("rightsManagementPmpComponent", this._context.config.types.rightsManagementPmpComponent, "@twin.org/engine-types", "initialiseRightsManagementPmpComponent");
-        this.addTypeInitialiser("rightsManagementPxpComponent", this._context.config.types.rightsManagementPxpComponent, "@twin.org/engine-types", "initialiseRightsManagementPxpComponent");
-        this.addTypeInitialiser("rightsManagementPipComponent", this._context.config.types.rightsManagementPipComponent, "@twin.org/engine-types", "initialiseRightsManagementPipComponent");
-        this.addTypeInitialiser("rightsManagementPdpComponent", this._context.config.types.rightsManagementPdpComponent, "@twin.org/engine-types", "initialiseRightsManagementPdpComponent");
-        this.addTypeInitialiser("rightsManagementPepComponent", this._context.config.types.rightsManagementPepComponent, "@twin.org/engine-types", "initialiseRightsManagementPepComponent");
-        this.addTypeInitialiser("rightsManagementComponent", this._context.config.types.rightsManagementComponent, "@twin.org/engine-types", "initialiseRightsManagementComponent");
-        this.addTypeInitialiser("synchronisedStorageComponent", this._context.config.types.synchronisedStorageComponent, "@twin.org/engine-types", "initialiseSynchronisedStorageComponent");
-        this.addTypeInitialiser("federatedCatalogueComponent", this._context.config.types.federatedCatalogueComponent, "@twin.org/engine-types", "initialiseFederatedCatalogueComponent");
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper methods for engine config.
- */
-class EngineConfigHelper {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EngineConfigHelper";
-    /**
-     * Add a custom entity storage to the engine configuration.
-     * @param engineConfig The engine configuration.
-     * @param entityTypeName The entity type name.
-     * @param entitySchema The entity schema.
-     * @param restPath The rest path to serve the entity storage from, leave undefined for no endpoints.
-     * @param options Additional options.
-     * @param options.partitionPerUser Whether to partition the user identity in the data, defaults to false.
-     */
-    static addCustomEntityStorage(engineConfig, entityTypeName, entitySchema, restPath, options) {
-        Guards.object(EngineConfigHelper.CLASS_NAME, "engineConfig", engineConfig);
-        Guards.stringValue(EngineConfigHelper.CLASS_NAME, "entityTypeName", entityTypeName);
-        Guards.object(EngineConfigHelper.CLASS_NAME, "entitySchema", entitySchema);
-        engineConfig.types.entityStorageComponent ??= [];
-        EntitySchemaFactory.register(entityTypeName, () => entitySchema);
-        engineConfig.types.entityStorageComponent.push({
-            type: EntityStorageComponentType.Service,
-            options: {
-                entityStorageType: entityTypeName,
-                config: {
-                    partitionPerUser: options?.partitionPerUser
-                }
-            },
-            overrideInstanceType: StringHelper.kebabCase(entityTypeName),
-            restPath: Is.stringValue(restPath) ? restPath : undefined
-        });
-    }
-}
-
-export { Engine, EngineConfigHelper };