@twin.org/engine-types 0.0.3-next.48 → 0.0.3-next.49

package/dist/es/components/schemaVersionMigration.js

@@ -1,8 +1,10 @@
 // Copyright 2026 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 import { ComponentFactory } from "@twin.org/core";
-import { EntityStorageConnectorFactory, SchemaVersion, SchemaVersionService, initSchema } from "@twin.org/entity-storage-models";
+import { SchemaVersionService, initSchema } from "@twin.org/entity-storage-service";
 import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { SchemaVersionMigrationComponentType } from "../models/types/schemaVersionMigrationComponentType.js";
+import { EngineTypeHelper } from "../utils/engineTypeHelper.js";
 /**
  * Initialise the schema version migration component.
  * @param engineCore The engine core.
@@ -11,18 +13,22 @@ import { initialiseEntityStorageConnector } from "./entityStorage.js";
  * @returns The instance created and the factory for it.
  */
 export function initialiseSchemaVersionMigrationComponent(engineCore, context, instanceConfig) {
-    const createComponent = () => {
-        initSchema();
-        // No partition keys ([] not [Node]) and no storage-type override: schema versions track
-        // entity type structure globally — there is no per-context versioning and no scenario
-        // where migrations should read from a different connector than the rest of entity storage.
-        initialiseEntityStorageConnector(engineCore, context, undefined, "SchemaVersion", []);
-        const versionConnector = EntityStorageConnectorFactory.get("schema-version");
-        return new SchemaVersionService(versionConnector);
-    };
+    let createComponent;
+    let instanceTypeName;
+    if (instanceConfig.type === SchemaVersionMigrationComponentType.Service) {
+        createComponent = (createConfig) => {
+            initSchema();
+            // No partition keys ([] not [Node]) schema versions track
+            // entity type structure globally — there is no per-context versioning and no scenario
+            // where migrations should read from a different connector than the rest of entity storage.
+            initialiseEntityStorageConnector(engineCore, context, createConfig.options?.schemaVersionStorageType, "SchemaVersion", []);
+            return new SchemaVersionService(EngineTypeHelper.mergeConfig(createConfig.options));
+        };
+        instanceTypeName = "schema-version-service";
+    }
     return {
         createComponent,
-        instanceTypeName: "schema-version-service",
+        instanceTypeName,
         factory: ComponentFactory
     };
 }

package/dist/es/components/schemaVersionMigration.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaVersionMigration.js","sourceRoot":"","sources":["../../../src/components/schemaVersionMigration.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAMnE,OAAO,EACN,6BAA6B,EAE7B,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAItE;;;;;;GAMG;AACH,MAAM,UAAU,yCAAyC,CACxD,UAAsC,EACtC,OAA0C,EAC1C,cAAqD;IAErD,MAAM,eAAe,GAAG,GAAe,EAAE;QACxC,UAAU,EAAE,CAAC;QACb,wFAAwF;QACxF,sFAAsF;QACtF,2FAA2F;QAC3F,gCAAgC,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,mBAA2B,EAAE,CAAC,CAAC;QAC9F,MAAM,gBAAgB,GAAG,6BAA6B,CAAC,GAAG,kBAEzB,CAAC;QAClC,OAAO,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;IACnD,CAAC,CAAC;IAEF,OAAO;QACN,eAAe;QACf,gBAAgB,0BAAuC;QACvD,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type {\n\tEngineTypeInitialiserReturn,\n\tIEngineCore,\n\tIEngineCoreContext\n} from \"@twin.org/engine-models\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector,\n\tSchemaVersion,\n\tSchemaVersionService,\n\tinitSchema\n} from \"@twin.org/entity-storage-models\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { SchemaVersionMigrationComponentConfig } from \"../models/config/schemaVersionMigrationComponentConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\n\n/**\n * Initialise the schema version migration component.\n * @param engineCore The engine core.\n * @param context The context for the engine.\n * @param instanceConfig The instance config.\n * @returns The instance created and the factory for it.\n */\nexport function initialiseSchemaVersionMigrationComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: SchemaVersionMigrationComponentConfig\n): EngineTypeInitialiserReturn<typeof instanceConfig, typeof ComponentFactory> {\n\tconst createComponent = (): IComponent => {\n\t\tinitSchema();\n\t\t// No partition keys ([] not [Node]) and no storage-type override: schema versions track\n\t\t// entity type structure globally — there is no per-context versioning and no scenario\n\t\t// where migrations should read from a different connector than the rest of entity storage.\n\t\tinitialiseEntityStorageConnector(engineCore, context, undefined, nameof<SchemaVersion>(), []);\n\t\tconst versionConnector = EntityStorageConnectorFactory.get<\n\t\t\tIEntityStorageConnector<SchemaVersion>\n\t\t>(nameofKebabCase(SchemaVersion));\n\t\treturn new SchemaVersionService(versionConnector);\n\t};\n\n\treturn {\n\t\tcreateComponent,\n\t\tinstanceTypeName: nameofKebabCase(SchemaVersionService),\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}
+{"version":3,"file":"schemaVersionMigration.js","sourceRoot":"","sources":["../../../src/components/schemaVersionMigration.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAMlD,OAAO,EAEN,oBAAoB,EACpB,UAAU,EACV,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAGtE,OAAO,EAAE,mCAAmC,EAAE,MAAM,wDAAwD,CAAC;AAC7G,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,UAAU,yCAAyC,CACxD,UAAsC,EACtC,OAA0C,EAC1C,cAAqD;IAErD,IAAI,eAAe,CAAC;IACpB,IAAI,gBAAgB,CAAC;IAErB,IAAI,cAAc,CAAC,IAAI,KAAK,mCAAmC,CAAC,OAAO,EAAE,CAAC;QACzE,eAAe,GAAG,CAAC,YAAmC,EAAE,EAAE;YACzD,UAAU,EAAE,CAAC;YAEb,0DAA0D;YAC1D,sFAAsF;YACtF,2FAA2F;YAC3F,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,YAAY,CAAC,OAAO,EAAE,wBAAwB,mBAE9C,EAAE,CACF,CAAC;YACF,OAAO,IAAI,oBAAoB,CAC9B,gBAAgB,CAAC,WAAW,CAAqC,YAAY,CAAC,OAAO,CAAC,CACtF,CAAC;QACH,CAAC,CAAC;QACF,gBAAgB,2BAAwC,CAAC;IAC1D,CAAC;IAED,OAAO;QACN,eAAe;QACf,gBAAgB;QAChB,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory } from \"@twin.org/core\";\nimport type {\n\tEngineTypeInitialiserReturn,\n\tIEngineCore,\n\tIEngineCoreContext\n} from \"@twin.org/engine-models\";\nimport {\n\ttype SchemaVersion,\n\tSchemaVersionService,\n\tinitSchema\n} from \"@twin.org/entity-storage-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { SchemaVersionMigrationComponentConfig } from \"../models/config/schemaVersionMigrationComponentConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { SchemaVersionMigrationComponentType } from \"../models/types/schemaVersionMigrationComponentType.js\";\nimport { EngineTypeHelper } from \"../utils/engineTypeHelper.js\";\n\n/**\n * Initialise the schema version migration component.\n * @param engineCore The engine core.\n * @param context The context for the engine.\n * @param instanceConfig The instance config.\n * @returns The instance created and the factory for it.\n */\nexport function initialiseSchemaVersionMigrationComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: SchemaVersionMigrationComponentConfig\n): EngineTypeInitialiserReturn<typeof instanceConfig, typeof ComponentFactory> {\n\tlet createComponent;\n\tlet instanceTypeName;\n\n\tif (instanceConfig.type === SchemaVersionMigrationComponentType.Service) {\n\t\tcreateComponent = (createConfig: typeof instanceConfig) => {\n\t\t\tinitSchema();\n\n\t\t\t// No partition keys ([] not [Node]) schema versions track\n\t\t\t// entity type structure globally — there is no per-context versioning and no scenario\n\t\t\t// where migrations should read from a different connector than the rest of entity storage.\n\t\t\tinitialiseEntityStorageConnector(\n\t\t\t\tengineCore,\n\t\t\t\tcontext,\n\t\t\t\tcreateConfig.options?.schemaVersionStorageType,\n\t\t\t\tnameof<SchemaVersion>(),\n\t\t\t\t[]\n\t\t\t);\n\t\t\treturn new SchemaVersionService(\n\t\t\t\tEngineTypeHelper.mergeConfig<(typeof instanceConfig)[\"options\"]>(createConfig.options)\n\t\t\t);\n\t\t};\n\t\tinstanceTypeName = nameofKebabCase(SchemaVersionService);\n\t}\n\n\treturn {\n\t\tcreateComponent,\n\t\tinstanceTypeName,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/models/config/schemaVersionMigrationComponentConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaVersionMigrationComponentConfig.js","sourceRoot":"","sources":["../../../../src/models/config/schemaVersionMigrationComponentConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SchemaVersionMigrationComponentType } from \"../types/schemaVersionMigrationComponentType.js\";\n\n/**\n * Schema version migration component config types.\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type SchemaVersionMigrationComponentConfig = {\n\ttype: typeof SchemaVersionMigrationComponentType.Service;\n};\n"]}
+{"version":3,"file":"schemaVersionMigrationComponentConfig.js","sourceRoot":"","sources":["../../../../src/models/config/schemaVersionMigrationComponentConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISchemaVersionServiceConstructorOptions } from \"@twin.org/entity-storage-service\";\nimport type { SchemaVersionMigrationComponentType } from \"../types/schemaVersionMigrationComponentType.js\";\n\n/**\n * Schema version migration component config types.\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type SchemaVersionMigrationComponentConfig = {\n\ttype: typeof SchemaVersionMigrationComponentType.Service;\n\toptions?: ISchemaVersionServiceConstructorOptions;\n};\n"]}

package/dist/types/models/config/schemaVersionMigrationComponentConfig.d.ts

@@ -1,7 +1,9 @@
+import type { ISchemaVersionServiceConstructorOptions } from "@twin.org/entity-storage-service";
 import type { SchemaVersionMigrationComponentType } from "../types/schemaVersionMigrationComponentType.js";
 /**
  * Schema version migration component config types.
  */
 export type SchemaVersionMigrationComponentConfig = {
     type: typeof SchemaVersionMigrationComponentType.Service;
+    options?: ISchemaVersionServiceConstructorOptions;
 };

package/docs/changelog.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.0.3-next.49](https://github.com/iotaledger/twin-engine/compare/engine-types-v0.0.3-next.48...engine-types-v0.0.3-next.49) (2026-06-09)
+
+
+### Features
+
+* schema migration ([#147](https://github.com/iotaledger/twin-engine/issues/147)) ([2026f19](https://github.com/iotaledger/twin-engine/commit/2026f195e7a8d930d20cd43c7ff8ac4d003e454d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-core bumped from 0.0.3-next.48 to 0.0.3-next.49
+    * @twin.org/engine-models bumped from 0.0.3-next.48 to 0.0.3-next.49
+
 ## [0.0.3-next.48](https://github.com/iotaledger/twin-engine/compare/engine-types-v0.0.3-next.47...engine-types-v0.0.3-next.48) (2026-06-08)
 
 

package/docs/reference/type-aliases/SchemaVersionMigrationComponentConfig.md

@@ -9,3 +9,9 @@ Schema version migration component config types.
 ### type {#type}
 
 > **type**: *typeof* [`Service`](../variables/SchemaVersionMigrationComponentType.md#service)
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `ISchemaVersionServiceConstructorOptions`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.3-next.48",
+	"version": "0.0.3-next.49",
 	"description": "Component and connector type definitions with configuration helpers for engine composition.",
 	"repository": {
 		"type": "git",
@@ -62,8 +62,8 @@
 		"@twin.org/document-management-models": "next",
 		"@twin.org/document-management-rest-client": "next",
 		"@twin.org/document-management-service": "next",
-		"@twin.org/engine-core": "0.0.3-next.48",
-		"@twin.org/engine-models": "0.0.3-next.48",
+		"@twin.org/engine-core": "0.0.3-next.49",
+		"@twin.org/engine-models": "0.0.3-next.49",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",