@twin.org/engine-types 0.0.2-next.9 → 0.0.3-next.10

package/dist/es/components/identity.js

@@ -0,0 +1,75 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+import { EntityStorageIdentityConnector, initSchema as initSchemaIdentityStorage } from "@twin.org/identity-connector-entity-storage";
+import { IotaIdentityConnector } from "@twin.org/identity-connector-iota";
+import { IdentityConnectorFactory } from "@twin.org/identity-models";
+import { IdentityRestClient } from "@twin.org/identity-rest-client";
+import { IdentityService } from "@twin.org/identity-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { DltConfigType } from "../models/types/dltConfigType.js";
+import { IdentityComponentType } from "../models/types/identityComponentType.js";
+import { IdentityConnectorType } from "../models/types/identityConnectorType.js";
+import { EngineTypeHelper } from "../utils/engineTypeHelper.js";
+/**
+ * Initialise the identity connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityConnector(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === IdentityConnectorType.Iota) {
+        const dltConfig = EngineTypeHelper.getConfigOfType(engineCore.getConfig(), "dltConfig", DltConfigType.Iota);
+        component = new IotaIdentityConnector({
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            ...instanceConfig.options,
+            config: {
+                ...dltConfig?.options?.config,
+                ...instanceConfig.options.config
+            }
+        });
+        instanceType = IotaIdentityConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === IdentityConnectorType.EntityStorage) {
+        initSchemaIdentityStorage({ includeProfile: false });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.didDocumentEntityStorageType, "IdentityDocument", []);
+        component = new EntityStorageIdentityConnector({
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageIdentityConnector.NAMESPACE;
+    }
+    return {
+        component,
+        instanceType,
+        factory: IdentityConnectorFactory
+    };
+}
+/**
+ * Initialise the identity component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === IdentityComponentType.Service) {
+        component = new IdentityService(instanceConfig.options);
+        instanceType = "identity-service";
+    }
+    else if (instanceConfig.type === IdentityComponentType.RestClient) {
+        component = new IdentityRestClient(instanceConfig.options);
+        instanceType = "identity-rest-client";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=identity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../../src/components/identity.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EACN,8BAA8B,EAC9B,UAAU,IAAI,yBAAyB,EAEvC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EACN,wBAAwB,EAGxB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAKtE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAChD,UAAsC,EACtC,OAA0C,EAC1C,cAAuC;IAMvC,IAAI,SAAyC,CAAC;IAC9C,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACxD,MAAM,SAAS,GAAG,gBAAgB,CAAC,eAAe,CACjD,UAAU,CAAC,SAAS,EAAE,EACtB,WAAW,EACX,aAAa,CAAC,IAAI,CAClB,CAAC;QACF,SAAS,GAAG,IAAI,qBAAqB,CAAC;YACrC,kBAAkB,EAAE,UAAU,CAAC,yBAAyB,CAAC,gBAAgB,CAAC;YAC1E,GAAG,cAAc,CAAC,OAAO;YACzB,MAAM,EAAE;gBACP,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM;gBAC7B,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM;aAChC;SACD,CAAC,CAAC;QACH,YAAY,GAAG,qBAAqB,CAAC,SAAS,CAAC;IAChD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,qBAAqB,CAAC,aAAa,EAAE,CAAC;QACxE,yBAAyB,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACrD,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,4BAA4B,sBAEpD,EAAE,CACF,CAAC;QACF,SAAS,GAAG,IAAI,8BAA8B,CAAC;YAC9C,kBAAkB,EAAE,UAAU,CAAC,yBAAyB,CAAC,gBAAgB,CAAC;YAC1E,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,GAAG,8BAA8B,CAAC,SAAS,CAAC;IACzD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,wBAAwB;KACjC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAChD,UAAsC,EACtC,OAA0C,EAC1C,cAAuC;IAMvC,IAAI,SAAyC,CAAC;IAC9C,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,qBAAqB,CAAC,OAAO,EAAE,CAAC;QAC3D,SAAS,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACxD,YAAY,qBAAmC,CAAC;IACjD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,qBAAqB,CAAC,UAAU,EAAE,CAAC;QACrE,SAAS,GAAG,IAAI,kBAAkB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC3D,YAAY,yBAAsC,CAAC;IACpD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport {\n\tEntityStorageIdentityConnector,\n\tinitSchema as initSchemaIdentityStorage,\n\ttype IdentityDocument\n} from \"@twin.org/identity-connector-entity-storage\";\nimport { IotaIdentityConnector } from \"@twin.org/identity-connector-iota\";\nimport {\n\tIdentityConnectorFactory,\n\ttype IIdentityComponent,\n\ttype IIdentityConnector\n} from \"@twin.org/identity-models\";\nimport { IdentityRestClient } from \"@twin.org/identity-rest-client\";\nimport { IdentityService } from \"@twin.org/identity-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { DltConfig } from \"../models/config/dltConfig.js\";\nimport type { IdentityComponentConfig } from \"../models/config/identityComponentConfig.js\";\nimport type { IdentityConnectorConfig } from \"../models/config/identityConnectorConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { DltConfigType } from \"../models/types/dltConfigType.js\";\nimport { IdentityComponentType } from \"../models/types/identityComponentType.js\";\nimport { IdentityConnectorType } from \"../models/types/identityConnectorType.js\";\nimport { EngineTypeHelper } from \"../utils/engineTypeHelper.js\";\n\n/**\n * Initialise the identity connector.\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 async function initialiseIdentityConnector(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityConnectorConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof IdentityConnectorFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IIdentityConnector | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityConnectorType.Iota) {\n\t\tconst dltConfig = EngineTypeHelper.getConfigOfType<DltConfig>(\n\t\t\tengineCore.getConfig(),\n\t\t\t\"dltConfig\",\n\t\t\tDltConfigType.Iota\n\t\t);\n\t\tcomponent = new IotaIdentityConnector({\n\t\t\tvaultConnectorType: engineCore.getRegisteredInstanceType(\"vaultConnector\"),\n\t\t\t...instanceConfig.options,\n\t\t\tconfig: {\n\t\t\t\t...dltConfig?.options?.config,\n\t\t\t\t...instanceConfig.options.config\n\t\t\t}\n\t\t});\n\t\tinstanceType = IotaIdentityConnector.NAMESPACE;\n\t} else if (instanceConfig.type === IdentityConnectorType.EntityStorage) {\n\t\tinitSchemaIdentityStorage({ includeProfile: false });\n\t\tinitialiseEntityStorageConnector(\n\t\t\tengineCore,\n\t\t\tcontext,\n\t\t\tinstanceConfig.options?.didDocumentEntityStorageType,\n\t\t\tnameof<IdentityDocument>(),\n\t\t\t[]\n\t\t);\n\t\tcomponent = new EntityStorageIdentityConnector({\n\t\t\tvaultConnectorType: engineCore.getRegisteredInstanceType(\"vaultConnector\"),\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = EntityStorageIdentityConnector.NAMESPACE;\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: IdentityConnectorFactory\n\t};\n}\n\n/**\n * Initialise the identity 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 async function initialiseIdentityComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityComponentConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof ComponentFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IIdentityComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityComponentType.Service) {\n\t\tcomponent = new IdentityService(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(IdentityService);\n\t} else if (instanceConfig.type === IdentityComponentType.RestClient) {\n\t\tcomponent = new IdentityRestClient(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(IdentityRestClient);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/components/identityProfile.js

@@ -0,0 +1,64 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdHelper, ContextIdKeys } from "@twin.org/context";
+import { ComponentFactory } from "@twin.org/core";
+import { EntityStorageIdentityProfileConnector, initSchema as initSchemaIdentityStorage } from "@twin.org/identity-connector-entity-storage";
+import { IdentityProfileConnectorFactory } from "@twin.org/identity-models";
+import { IdentityProfileRestClient } from "@twin.org/identity-rest-client";
+import { IdentityProfileService } from "@twin.org/identity-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { IdentityProfileComponentType } from "../models/types/identityProfileComponentType.js";
+import { IdentityProfileConnectorType } from "../models/types/identityProfileConnectorType.js";
+/**
+ * Initialise the identity profile connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityProfileConnector(engineCore, context, instanceConfig) {
+    let connector;
+    let instanceType;
+    if (instanceConfig.type === IdentityProfileConnectorType.EntityStorage) {
+        initSchemaIdentityStorage({ includeDocument: false });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.profileEntityStorageType, "IdentityProfile", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        connector = new EntityStorageIdentityProfileConnector(instanceConfig.options);
+        instanceType = EntityStorageIdentityProfileConnector.NAMESPACE;
+    }
+    return {
+        component: connector,
+        instanceType,
+        factory: IdentityProfileConnectorFactory
+    };
+}
+/**
+ * Initialise the identity profile component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityProfileComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === IdentityProfileComponentType.Service) {
+        component = new IdentityProfileService({
+            profileEntityConnectorType: engineCore.getRegisteredInstanceType("identityProfileConnector"),
+            ...instanceConfig.options
+        });
+        instanceType = "identity-profile-service";
+    }
+    else if (instanceConfig.type === IdentityProfileComponentType.RestClient) {
+        component = new IdentityProfileRestClient(instanceConfig.options);
+        instanceType = "identity-profile-rest-client";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=identityProfile.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"identityProfile.js","sourceRoot":"","sources":["../../../src/components/identityProfile.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EACN,qCAAqC,EACrC,UAAU,IAAI,yBAAyB,EAEvC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACN,+BAA+B,EAG/B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAItE,OAAO,EAAE,4BAA4B,EAAE,MAAM,iDAAiD,CAAC;AAC/F,OAAO,EAAE,4BAA4B,EAAE,MAAM,iDAAiD,CAAC;AAE/F;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACvD,UAAsC,EACtC,OAA0C,EAC1C,cAA8C;IAM9C,IAAI,SAAgD,CAAC;IACrD,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,4BAA4B,CAAC,aAAa,EAAE,CAAC;QACxE,yBAAyB,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,wBAAwB,qBAEhD,eAAe,CAAC,qBAAqB,CAAC,UAAU,CAAC,gBAAgB,EAAE,EAAE;YACpE,aAAa,CAAC,IAAI;YAClB,aAAa,CAAC,MAAM;SACpB,CAAC,CACF,CAAC;QACF,SAAS,GAAG,IAAI,qCAAqC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9E,YAAY,GAAG,qCAAqC,CAAC,SAAS,CAAC;IAChE,CAAC;IAED,OAAO;QACN,SAAS,EAAE,SAAS;QACpB,YAAY;QACZ,OAAO,EAAE,+BAA+B;KACxC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACvD,UAAsC,EACtC,OAA0C,EAC1C,cAA8C;IAM9C,IAAI,SAAgD,CAAC;IACrD,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,4BAA4B,CAAC,OAAO,EAAE,CAAC;QAClE,SAAS,GAAG,IAAI,sBAAsB,CAAC;YACtC,0BAA0B,EAAE,UAAU,CAAC,yBAAyB,CAAC,0BAA0B,CAAC;YAC5F,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,6BAA0C,CAAC;IACxD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,4BAA4B,CAAC,UAAU,EAAE,CAAC;QAC5E,SAAS,GAAG,IAAI,yBAAyB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAClE,YAAY,iCAA6C,CAAC;IAC3D,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ContextIdHelper, ContextIdKeys } from \"@twin.org/context\";\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport {\n\tEntityStorageIdentityProfileConnector,\n\tinitSchema as initSchemaIdentityStorage,\n\ttype IdentityProfile\n} from \"@twin.org/identity-connector-entity-storage\";\nimport {\n\tIdentityProfileConnectorFactory,\n\ttype IIdentityProfileComponent,\n\ttype IIdentityProfileConnector\n} from \"@twin.org/identity-models\";\nimport { IdentityProfileRestClient } from \"@twin.org/identity-rest-client\";\nimport { IdentityProfileService } from \"@twin.org/identity-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { IdentityProfileComponentConfig } from \"../models/config/identityProfileComponentConfig.js\";\nimport type { IdentityProfileConnectorConfig } from \"../models/config/identityProfileConnectorConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { IdentityProfileComponentType } from \"../models/types/identityProfileComponentType.js\";\nimport { IdentityProfileConnectorType } from \"../models/types/identityProfileConnectorType.js\";\n\n/**\n * Initialise the identity profile connector.\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 async function initialiseIdentityProfileConnector(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityProfileConnectorConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof IdentityProfileConnectorFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet connector: IIdentityProfileConnector | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityProfileConnectorType.EntityStorage) {\n\t\tinitSchemaIdentityStorage({ includeDocument: false });\n\t\tinitialiseEntityStorageConnector(\n\t\t\tengineCore,\n\t\t\tcontext,\n\t\t\tinstanceConfig.options?.profileEntityStorageType,\n\t\t\tnameof<IdentityProfile>(),\n\t\t\tContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [\n\t\t\t\tContextIdKeys.Node,\n\t\t\t\tContextIdKeys.Tenant\n\t\t\t])\n\t\t);\n\t\tconnector = new EntityStorageIdentityProfileConnector(instanceConfig.options);\n\t\tinstanceType = EntityStorageIdentityProfileConnector.NAMESPACE;\n\t}\n\n\treturn {\n\t\tcomponent: connector,\n\t\tinstanceType,\n\t\tfactory: IdentityProfileConnectorFactory\n\t};\n}\n\n/**\n * Initialise the identity profile 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 async function initialiseIdentityProfileComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityProfileComponentConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof ComponentFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IIdentityProfileComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityProfileComponentType.Service) {\n\t\tcomponent = new IdentityProfileService({\n\t\t\tprofileEntityConnectorType: engineCore.getRegisteredInstanceType(\"identityProfileConnector\"),\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = nameofKebabCase(IdentityProfileService);\n\t} else if (instanceConfig.type === IdentityProfileComponentType.RestClient) {\n\t\tcomponent = new IdentityProfileRestClient(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(IdentityProfileRestClient);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/components/identityResolver.js

@@ -0,0 +1,87 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@twin.org/core";
+import { EntityStorageIdentityResolverConnector, initSchema as initSchemaIdentityStorage } from "@twin.org/identity-connector-entity-storage";
+import { IotaIdentityResolverConnector } from "@twin.org/identity-connector-iota";
+import { UniversalResolverConnector } from "@twin.org/identity-connector-universal";
+import { IdentityResolverConnectorFactory } from "@twin.org/identity-models";
+import { IdentityResolverRestClient } from "@twin.org/identity-rest-client";
+import { IdentityResolverService } from "@twin.org/identity-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { DltConfigType } from "../models/types/dltConfigType.js";
+import { IdentityResolverComponentType } from "../models/types/identityResolverComponentType.js";
+import { IdentityResolverConnectorType } from "../models/types/identityResolverConnectorType.js";
+import { EngineTypeHelper } from "../utils/engineTypeHelper.js";
+/**
+ * Initialise the identity resolver connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityResolverConnector(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === IdentityResolverConnectorType.Iota) {
+        const dltConfig = EngineTypeHelper.getConfigOfType(engineCore.getConfig(), "dltConfig", DltConfigType.Iota);
+        component = new IotaIdentityResolverConnector({
+            ...instanceConfig.options,
+            config: {
+                ...dltConfig?.options?.config,
+                ...instanceConfig.options.config
+            }
+        });
+        instanceType = IotaIdentityResolverConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === IdentityResolverConnectorType.EntityStorage) {
+        initSchemaIdentityStorage({ includeProfile: false });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.didDocumentEntityStorageType, "IdentityDocument", []);
+        component = new EntityStorageIdentityResolverConnector({
+            vaultConnectorType: engineCore.getRegisteredInstanceType("vaultConnector"),
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageIdentityResolverConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === IdentityResolverConnectorType.Universal) {
+        component = new UniversalResolverConnector({
+            ...instanceConfig.options
+        });
+        instanceType = UniversalResolverConnector.NAMESPACE;
+    }
+    return {
+        component,
+        instanceType,
+        factory: IdentityResolverConnectorFactory
+    };
+}
+/**
+ * Initialise the identity resolver component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseIdentityResolverComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === IdentityResolverComponentType.Service) {
+        const defaultIdentityResolverType = engineCore.getRegisteredInstanceType("identityResolverConnector");
+        component = new IdentityResolverService({
+            fallbackResolverConnectorType: defaultIdentityResolverType !== IdentityResolverConnectorType.Universal
+                ? IdentityResolverConnectorType.Universal
+                : undefined,
+            ...instanceConfig.options
+        });
+        instanceType = "identity-resolver-service";
+    }
+    else if (instanceConfig.type === IdentityResolverComponentType.RestClient) {
+        component = new IdentityResolverRestClient(instanceConfig.options);
+        instanceType = "identity-resolver-rest-client";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=identityResolver.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"identityResolver.js","sourceRoot":"","sources":["../../../src/components/identityResolver.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EACN,sCAAsC,EACtC,UAAU,IAAI,yBAAyB,EAEvC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EACN,gCAAgC,EAGhC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAKtE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kDAAkD,CAAC;AACjG,OAAO,EAAE,6BAA6B,EAAE,MAAM,kDAAkD,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mCAAmC,CACxD,UAAsC,EACtC,OAA0C,EAC1C,cAA+C;IAM/C,IAAI,SAAiD,CAAC;IACtD,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,6BAA6B,CAAC,IAAI,EAAE,CAAC;QAChE,MAAM,SAAS,GAAG,gBAAgB,CAAC,eAAe,CACjD,UAAU,CAAC,SAAS,EAAE,EACtB,WAAW,EACX,aAAa,CAAC,IAAI,CAClB,CAAC;QACF,SAAS,GAAG,IAAI,6BAA6B,CAAC;YAC7C,GAAG,cAAc,CAAC,OAAO;YACzB,MAAM,EAAE;gBACP,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM;gBAC7B,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM;aAChC;SACD,CAAC,CAAC;QACH,YAAY,GAAG,6BAA6B,CAAC,SAAS,CAAC;IACxD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,6BAA6B,CAAC,aAAa,EAAE,CAAC;QAChF,yBAAyB,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QACrD,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,4BAA4B,sBAEpD,EAAE,CACF,CAAC;QACF,SAAS,GAAG,IAAI,sCAAsC,CAAC;YACtD,kBAAkB,EAAE,UAAU,CAAC,yBAAyB,CAAC,gBAAgB,CAAC;YAC1E,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,GAAG,sCAAsC,CAAC,SAAS,CAAC;IACjE,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,6BAA6B,CAAC,SAAS,EAAE,CAAC;QAC5E,SAAS,GAAG,IAAI,0BAA0B,CAAC;YAC1C,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,GAAG,0BAA0B,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gCAAgC;KACzC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mCAAmC,CACxD,UAAsC,EACtC,OAA0C,EAC1C,cAA+C;IAM/C,IAAI,SAAiD,CAAC;IACtD,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,6BAA6B,CAAC,OAAO,EAAE,CAAC;QACnE,MAAM,2BAA2B,GAAG,UAAU,CAAC,yBAAyB,CACvE,2BAA2B,CAC3B,CAAC;QAEF,SAAS,GAAG,IAAI,uBAAuB,CAAC;YACvC,6BAA6B,EAC5B,2BAA2B,KAAK,6BAA6B,CAAC,SAAS;gBACtE,CAAC,CAAC,6BAA6B,CAAC,SAAS;gBACzC,CAAC,CAAC,SAAS;YACb,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,8BAA2C,CAAC;IACzD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,6BAA6B,CAAC,UAAU,EAAE,CAAC;QAC7E,SAAS,GAAG,IAAI,0BAA0B,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACnE,YAAY,kCAA8C,CAAC;IAC5D,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport {\n\tEntityStorageIdentityResolverConnector,\n\tinitSchema as initSchemaIdentityStorage,\n\ttype IdentityDocument\n} from \"@twin.org/identity-connector-entity-storage\";\nimport { IotaIdentityResolverConnector } from \"@twin.org/identity-connector-iota\";\nimport { UniversalResolverConnector } from \"@twin.org/identity-connector-universal\";\nimport {\n\tIdentityResolverConnectorFactory,\n\ttype IIdentityResolverComponent,\n\ttype IIdentityResolverConnector\n} from \"@twin.org/identity-models\";\nimport { IdentityResolverRestClient } from \"@twin.org/identity-rest-client\";\nimport { IdentityResolverService } from \"@twin.org/identity-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { DltConfig } from \"../models/config/dltConfig.js\";\nimport type { IdentityResolverComponentConfig } from \"../models/config/identityResolverComponentConfig.js\";\nimport type { IdentityResolverConnectorConfig } from \"../models/config/identityResolverConnectorConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { DltConfigType } from \"../models/types/dltConfigType.js\";\nimport { IdentityResolverComponentType } from \"../models/types/identityResolverComponentType.js\";\nimport { IdentityResolverConnectorType } from \"../models/types/identityResolverConnectorType.js\";\nimport { EngineTypeHelper } from \"../utils/engineTypeHelper.js\";\n\n/**\n * Initialise the identity resolver connector.\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 async function initialiseIdentityResolverConnector(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityResolverConnectorConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof IdentityResolverConnectorFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IIdentityResolverConnector | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityResolverConnectorType.Iota) {\n\t\tconst dltConfig = EngineTypeHelper.getConfigOfType<DltConfig>(\n\t\t\tengineCore.getConfig(),\n\t\t\t\"dltConfig\",\n\t\t\tDltConfigType.Iota\n\t\t);\n\t\tcomponent = new IotaIdentityResolverConnector({\n\t\t\t...instanceConfig.options,\n\t\t\tconfig: {\n\t\t\t\t...dltConfig?.options?.config,\n\t\t\t\t...instanceConfig.options.config\n\t\t\t}\n\t\t});\n\t\tinstanceType = IotaIdentityResolverConnector.NAMESPACE;\n\t} else if (instanceConfig.type === IdentityResolverConnectorType.EntityStorage) {\n\t\tinitSchemaIdentityStorage({ includeProfile: false });\n\t\tinitialiseEntityStorageConnector(\n\t\t\tengineCore,\n\t\t\tcontext,\n\t\t\tinstanceConfig.options?.didDocumentEntityStorageType,\n\t\t\tnameof<IdentityDocument>(),\n\t\t\t[]\n\t\t);\n\t\tcomponent = new EntityStorageIdentityResolverConnector({\n\t\t\tvaultConnectorType: engineCore.getRegisteredInstanceType(\"vaultConnector\"),\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = EntityStorageIdentityResolverConnector.NAMESPACE;\n\t} else if (instanceConfig.type === IdentityResolverConnectorType.Universal) {\n\t\tcomponent = new UniversalResolverConnector({\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = UniversalResolverConnector.NAMESPACE;\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: IdentityResolverConnectorFactory\n\t};\n}\n\n/**\n * Initialise the identity resolver 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 async function initialiseIdentityResolverComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: IdentityResolverComponentConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof ComponentFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IIdentityResolverComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === IdentityResolverComponentType.Service) {\n\t\tconst defaultIdentityResolverType = engineCore.getRegisteredInstanceType(\n\t\t\t\"identityResolverConnector\"\n\t\t);\n\n\t\tcomponent = new IdentityResolverService({\n\t\t\tfallbackResolverConnectorType:\n\t\t\t\tdefaultIdentityResolverType !== IdentityResolverConnectorType.Universal\n\t\t\t\t\t? IdentityResolverConnectorType.Universal\n\t\t\t\t\t: undefined,\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = nameofKebabCase(IdentityResolverService);\n\t} else if (instanceConfig.type === IdentityResolverComponentType.RestClient) {\n\t\tcomponent = new IdentityResolverRestClient(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(IdentityResolverRestClient);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/components/immutableProof.js

@@ -0,0 +1,45 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdHelper, ContextIdKeys } from "@twin.org/context";
+import { ComponentFactory } from "@twin.org/core";
+import { ImmutableProofRestClient } from "@twin.org/immutable-proof-rest-client";
+import { ImmutableProofService, initSchema as initSchemaImmutableProof } from "@twin.org/immutable-proof-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { ImmutableProofComponentType } from "../models/types/immutableProofComponentType.js";
+/**
+ * Initialise the immutable proof component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseImmutableProofComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === ImmutableProofComponentType.Service) {
+        initSchemaImmutableProof();
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.immutableProofEntityStorageType, "ImmutableProof", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        component = new ImmutableProofService({
+            verifiableStorageType: engineCore.getRegisteredInstanceType("verifiableStorageConnector"),
+            identityConnectorType: engineCore.getRegisteredInstanceType("identityConnector"),
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            backgroundTaskComponentType: engineCore.getRegisteredInstanceType("backgroundTaskComponent"),
+            eventBusComponentType: engineCore.getRegisteredInstanceTypeOptional("eventBusComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = "immutable-proof-service";
+    }
+    else if (instanceConfig.type === ImmutableProofComponentType.RestClient) {
+        component = new ImmutableProofRestClient(instanceConfig.options);
+        instanceType = "immutable-proof-rest-client";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=immutableProof.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProof.js","sourceRoot":"","sources":["../../../src/components/immutableProof.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAGnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAEN,qBAAqB,EACrB,UAAU,IAAI,wBAAwB,EACtC,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAGtE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAE7F;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iCAAiC,CACtD,UAAsC,EACtC,OAA0C,EAC1C,cAA6C;IAM7C,IAAI,SAA+C,CAAC;IACpD,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,2BAA2B,CAAC,OAAO,EAAE,CAAC;QACjE,wBAAwB,EAAE,CAAC;QAE3B,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,+BAA+B,oBAEvD,eAAe,CAAC,qBAAqB,CAAC,UAAU,CAAC,gBAAgB,EAAE,EAAE;YACpE,aAAa,CAAC,IAAI;YAClB,aAAa,CAAC,MAAM;SACpB,CAAC,CACF,CAAC;QAEF,SAAS,GAAG,IAAI,qBAAqB,CAAC;YACrC,qBAAqB,EAAE,UAAU,CAAC,yBAAyB,CAAC,4BAA4B,CAAC;YACzF,qBAAqB,EAAE,UAAU,CAAC,yBAAyB,CAAC,mBAAmB,CAAC;YAChF,oBAAoB,EAAE,UAAU,CAAC,yBAAyB,CAAC,kBAAkB,CAAC;YAC9E,2BAA2B,EAAE,UAAU,CAAC,yBAAyB,CAAC,yBAAyB,CAAC;YAC5F,qBAAqB,EAAE,UAAU,CAAC,iCAAiC,CAAC,mBAAmB,CAAC;YACxF,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,4BAAyC,CAAC;IACvD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,2BAA2B,CAAC,UAAU,EAAE,CAAC;QAC3E,SAAS,GAAG,IAAI,wBAAwB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACjE,YAAY,gCAA4C,CAAC;IAC1D,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ContextIdHelper, ContextIdKeys } from \"@twin.org/context\";\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport type { IImmutableProofComponent } from \"@twin.org/immutable-proof-models\";\nimport { ImmutableProofRestClient } from \"@twin.org/immutable-proof-rest-client\";\nimport {\n\ttype ImmutableProof,\n\tImmutableProofService,\n\tinitSchema as initSchemaImmutableProof\n} from \"@twin.org/immutable-proof-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { ImmutableProofComponentConfig } from \"../models/config/immutableProofComponentConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { ImmutableProofComponentType } from \"../models/types/immutableProofComponentType.js\";\n\n/**\n * Initialise the immutable proof 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 async function initialiseImmutableProofComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: ImmutableProofComponentConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof ComponentFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: IImmutableProofComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === ImmutableProofComponentType.Service) {\n\t\tinitSchemaImmutableProof();\n\n\t\tinitialiseEntityStorageConnector(\n\t\t\tengineCore,\n\t\t\tcontext,\n\t\t\tinstanceConfig.options?.immutableProofEntityStorageType,\n\t\t\tnameof<ImmutableProof>(),\n\t\t\tContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [\n\t\t\t\tContextIdKeys.Node,\n\t\t\t\tContextIdKeys.Tenant\n\t\t\t])\n\t\t);\n\n\t\tcomponent = new ImmutableProofService({\n\t\t\tverifiableStorageType: engineCore.getRegisteredInstanceType(\"verifiableStorageConnector\"),\n\t\t\tidentityConnectorType: engineCore.getRegisteredInstanceType(\"identityConnector\"),\n\t\t\tloggingComponentType: engineCore.getRegisteredInstanceType(\"loggingComponent\"),\n\t\t\tbackgroundTaskComponentType: engineCore.getRegisteredInstanceType(\"backgroundTaskComponent\"),\n\t\t\teventBusComponentType: engineCore.getRegisteredInstanceTypeOptional(\"eventBusComponent\"),\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = nameofKebabCase(ImmutableProofService);\n\t} else if (instanceConfig.type === ImmutableProofComponentType.RestClient) {\n\t\tcomponent = new ImmutableProofRestClient(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(ImmutableProofRestClient);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/components/logging.js

@@ -0,0 +1,73 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdHelper, ContextIdKeys } from "@twin.org/context";
+import { ComponentFactory } from "@twin.org/core";
+import { ConsoleLoggingConnector } from "@twin.org/logging-connector-console";
+import { EntityStorageLoggingConnector, initSchema as initSchemaLogging } from "@twin.org/logging-connector-entity-storage";
+import { LoggingConnectorFactory, MultiLoggingConnector } from "@twin.org/logging-models";
+import { LoggingRestClient } from "@twin.org/logging-rest-client";
+import { LoggingService } from "@twin.org/logging-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { LoggingComponentType } from "../models/types/loggingComponentType.js";
+import { LoggingConnectorType } from "../models/types/loggingConnectorType.js";
+/**
+ * Initialise the logging connector.
+ * @param engineCore The engine core.
+ * @param context The engine core context.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseLoggingConnector(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === LoggingConnectorType.Console) {
+        component = new ConsoleLoggingConnector(instanceConfig.options);
+        instanceType = ConsoleLoggingConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === LoggingConnectorType.EntityStorage) {
+        initSchemaLogging();
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.logEntryStorageConnectorType, "LogEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        component = new EntityStorageLoggingConnector(instanceConfig.options);
+        instanceType = EntityStorageLoggingConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === LoggingConnectorType.Multi) {
+        component = new MultiLoggingConnector(instanceConfig.options);
+        instanceType = MultiLoggingConnector.NAMESPACE;
+    }
+    return {
+        component,
+        instanceType,
+        factory: LoggingConnectorFactory
+    };
+}
+/**
+ * Initialise the logging component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseLoggingComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === LoggingComponentType.Service) {
+        component = new LoggingService({
+            loggingConnectorType: engineCore.getRegisteredInstanceType("loggingConnector"),
+            ...instanceConfig.options
+        });
+        instanceType = "logging-service";
+    }
+    else if (instanceConfig.type === LoggingComponentType.RestClient) {
+        component = new LoggingRestClient(instanceConfig.options);
+        instanceType = "logging-rest-client";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=logging.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../../src/components/logging.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAmB,MAAM,gBAAgB,CAAC;AAEnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EACN,6BAA6B,EAC7B,UAAU,IAAI,iBAAiB,EAE/B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EACN,uBAAuB,EACvB,qBAAqB,EAGrB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,OAAO,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAC;AAItE,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,UAAsC,EACtC,OAA0C,EAC1C,cAAsC;IAMtC,IAAI,SAAwC,CAAC;IAC7C,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAC1D,SAAS,GAAG,IAAI,uBAAuB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAChE,YAAY,GAAG,uBAAuB,CAAC,SAAS,CAAC;IAClD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,aAAa,EAAE,CAAC;QACvE,iBAAiB,EAAE,CAAC;QACpB,gCAAgC,CAC/B,UAAU,EACV,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,4BAA4B,cAEpD,eAAe,CAAC,qBAAqB,CAAC,UAAU,CAAC,gBAAgB,EAAE,EAAE;YACpE,aAAa,CAAC,IAAI;YAClB,aAAa,CAAC,MAAM;SACpB,CAAC,CACF,CAAC;QACF,SAAS,GAAG,IAAI,6BAA6B,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACtE,YAAY,GAAG,6BAA6B,CAAC,SAAS,CAAC;IACxD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,KAAK,EAAE,CAAC;QAC/D,SAAS,GAAG,IAAI,qBAAqB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC9D,YAAY,GAAG,qBAAqB,CAAC,SAAS,CAAC;IAChD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,uBAAuB;KAChC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,UAAsC,EACtC,OAA0C,EAC1C,cAAsC;IAMtC,IAAI,SAAwC,CAAC;IAC7C,IAAI,YAAgC,CAAC;IAErC,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,OAAO,EAAE,CAAC;QAC1D,SAAS,GAAG,IAAI,cAAc,CAAC;YAC9B,oBAAoB,EAAE,UAAU,CAAC,yBAAyB,CAAC,kBAAkB,CAAC;YAC9E,GAAG,cAAc,CAAC,OAAO;SACzB,CAAC,CAAC;QACH,YAAY,oBAAkC,CAAC;IAChD,CAAC;SAAM,IAAI,cAAc,CAAC,IAAI,KAAK,oBAAoB,CAAC,UAAU,EAAE,CAAC;QACpE,SAAS,GAAG,IAAI,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAC1D,YAAY,wBAAqC,CAAC;IACnD,CAAC;IAED,OAAO;QACN,SAAS;QACT,YAAY;QACZ,OAAO,EAAE,gBAAgB;KACzB,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ContextIdHelper, ContextIdKeys } from \"@twin.org/context\";\nimport { ComponentFactory, type IComponent } from \"@twin.org/core\";\nimport type { IEngineCore, IEngineCoreContext } from \"@twin.org/engine-models\";\nimport { ConsoleLoggingConnector } from \"@twin.org/logging-connector-console\";\nimport {\n\tEntityStorageLoggingConnector,\n\tinitSchema as initSchemaLogging,\n\ttype LogEntry\n} from \"@twin.org/logging-connector-entity-storage\";\nimport {\n\tLoggingConnectorFactory,\n\tMultiLoggingConnector,\n\ttype ILoggingComponent,\n\ttype ILoggingConnector\n} from \"@twin.org/logging-models\";\nimport { LoggingRestClient } from \"@twin.org/logging-rest-client\";\nimport { LoggingService } from \"@twin.org/logging-service\";\nimport { nameof, nameofKebabCase } from \"@twin.org/nameof\";\nimport { initialiseEntityStorageConnector } from \"./entityStorage.js\";\nimport type { LoggingComponentConfig } from \"../models/config/loggingComponentConfig.js\";\nimport type { LoggingConnectorConfig } from \"../models/config/loggingConnectorConfig.js\";\nimport type { IEngineConfig } from \"../models/IEngineConfig.js\";\nimport { LoggingComponentType } from \"../models/types/loggingComponentType.js\";\nimport { LoggingConnectorType } from \"../models/types/loggingConnectorType.js\";\n\n/**\n * Initialise the logging connector.\n * @param engineCore The engine core.\n * @param context The engine core context.\n * @param instanceConfig The instance config.\n * @returns The instance created and the factory for it.\n */\nexport async function initialiseLoggingConnector(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: LoggingConnectorConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof LoggingConnectorFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: ILoggingConnector | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === LoggingConnectorType.Console) {\n\t\tcomponent = new ConsoleLoggingConnector(instanceConfig.options);\n\t\tinstanceType = ConsoleLoggingConnector.NAMESPACE;\n\t} else if (instanceConfig.type === LoggingConnectorType.EntityStorage) {\n\t\tinitSchemaLogging();\n\t\tinitialiseEntityStorageConnector(\n\t\t\tengineCore,\n\t\t\tcontext,\n\t\t\tinstanceConfig.options?.logEntryStorageConnectorType,\n\t\t\tnameof<LogEntry>(),\n\t\t\tContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [\n\t\t\t\tContextIdKeys.Node,\n\t\t\t\tContextIdKeys.Tenant\n\t\t\t])\n\t\t);\n\t\tcomponent = new EntityStorageLoggingConnector(instanceConfig.options);\n\t\tinstanceType = EntityStorageLoggingConnector.NAMESPACE;\n\t} else if (instanceConfig.type === LoggingConnectorType.Multi) {\n\t\tcomponent = new MultiLoggingConnector(instanceConfig.options);\n\t\tinstanceType = MultiLoggingConnector.NAMESPACE;\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: LoggingConnectorFactory\n\t};\n}\n\n/**\n * Initialise the logging 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 async function initialiseLoggingComponent(\n\tengineCore: IEngineCore<IEngineConfig>,\n\tcontext: IEngineCoreContext<IEngineConfig>,\n\tinstanceConfig: LoggingComponentConfig\n): Promise<{\n\tinstanceType?: string;\n\tfactory?: typeof ComponentFactory;\n\tcomponent?: IComponent;\n}> {\n\tlet component: ILoggingComponent | undefined;\n\tlet instanceType: string | undefined;\n\n\tif (instanceConfig.type === LoggingComponentType.Service) {\n\t\tcomponent = new LoggingService({\n\t\t\tloggingConnectorType: engineCore.getRegisteredInstanceType(\"loggingConnector\"),\n\t\t\t...instanceConfig.options\n\t\t});\n\t\tinstanceType = nameofKebabCase(LoggingService);\n\t} else if (instanceConfig.type === LoggingComponentType.RestClient) {\n\t\tcomponent = new LoggingRestClient(instanceConfig.options);\n\t\tinstanceType = nameofKebabCase(LoggingRestClient);\n\t}\n\n\treturn {\n\t\tcomponent,\n\t\tinstanceType,\n\t\tfactory: ComponentFactory\n\t};\n}\n"]}

package/dist/es/components/messaging.js

@@ -0,0 +1,177 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdHelper, ContextIdKeys } from "@twin.org/context";
+import { ComponentFactory } from "@twin.org/core";
+import { AwsMessagingEmailConnector, AwsMessagingPushNotificationConnector, AwsMessagingSmsConnector } from "@twin.org/messaging-connector-aws";
+import { EntityStorageMessagingEmailConnector, EntityStorageMessagingPushNotificationConnector, EntityStorageMessagingSmsConnector, initSchema } from "@twin.org/messaging-connector-entity-storage";
+import { MessagingEmailConnectorFactory, MessagingPushNotificationsConnectorFactory, MessagingSmsConnectorFactory } from "@twin.org/messaging-models";
+import { initSchema as initSchemaMessagingService, MessagingAdminService, MessagingService } from "@twin.org/messaging-service";
+import { initialiseEntityStorageConnector } from "./entityStorage.js";
+import { MessagingAdminComponentType } from "../models/types/messagingAdminComponentType.js";
+import { MessagingComponentType } from "../models/types/messagingComponentType.js";
+import { MessagingEmailConnectorType } from "../models/types/messagingEmailConnectorType.js";
+import { MessagingPushNotificationConnectorType } from "../models/types/messagingPushNotificationConnectorType.js";
+import { MessagingSmsConnectorType } from "../models/types/messagingSmsConnectorType.js";
+/**
+ * Initialise a messaging email connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseMessagingEmailConnector(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === MessagingEmailConnectorType.EntityStorage) {
+        initSchema({ email: true, sms: false, pushNotification: false });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingEmailEntryStorageConnectorType, "EmailEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        component = new EntityStorageMessagingEmailConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageMessagingEmailConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === MessagingEmailConnectorType.Aws) {
+        component = new AwsMessagingEmailConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = AwsMessagingEmailConnector.NAMESPACE;
+    }
+    return {
+        component,
+        instanceType,
+        factory: MessagingEmailConnectorFactory
+    };
+}
+/**
+ * Initialise a messaging sms connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseMessagingSmsConnector(engineCore, context, instanceConfig) {
+    let connector;
+    let instanceType;
+    if (instanceConfig.type === MessagingSmsConnectorType.EntityStorage) {
+        initSchema({ email: false, sms: true, pushNotification: false });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingSmsEntryStorageConnectorType, "SmsEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        connector = new EntityStorageMessagingSmsConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageMessagingSmsConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === MessagingSmsConnectorType.Aws) {
+        connector = new AwsMessagingSmsConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = AwsMessagingSmsConnector.NAMESPACE;
+    }
+    return {
+        instanceType,
+        factory: MessagingSmsConnectorFactory,
+        component: connector
+    };
+}
+/**
+ * Initialise a messaging push notification connector.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseMessagingPushNotificationConnector(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === MessagingPushNotificationConnectorType.EntityStorage) {
+        initSchema({ email: false, sms: false, pushNotification: true });
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingDeviceEntryStorageConnectorType, "PushNotificationDeviceEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.messagingMessageEntryStorageConnectorType, "PushNotificationMessageEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        component = new EntityStorageMessagingPushNotificationConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = EntityStorageMessagingPushNotificationConnector.NAMESPACE;
+    }
+    else if (instanceConfig.type === MessagingPushNotificationConnectorType.Aws) {
+        component = new AwsMessagingPushNotificationConnector({
+            loggingComponentType: engineCore.getRegisteredInstanceType("loggingComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = AwsMessagingPushNotificationConnector.NAMESPACE;
+    }
+    return {
+        component,
+        instanceType,
+        factory: MessagingPushNotificationsConnectorFactory
+    };
+}
+/**
+ * Initialise the messaging component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseMessagingComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === MessagingComponentType.Service) {
+        component = new MessagingService({
+            messagingEmailConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingEmailConnector"),
+            messagingSmsConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingSmsConnector"),
+            messagingPushNotificationConnectorType: engineCore.getRegisteredInstanceTypeOptional("messagingNotificationConnector"),
+            messagingAdminComponentType: engineCore.getRegisteredInstanceTypeOptional("messagingAdminComponent"),
+            ...instanceConfig.options
+        });
+        instanceType = "messaging-service";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+/**
+ * Initialise the messaging admin component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @returns The instance created and the factory for it.
+ */
+export async function initialiseMessagingAdminComponent(engineCore, context, instanceConfig) {
+    let component;
+    let instanceType;
+    if (instanceConfig.type === MessagingAdminComponentType.Service) {
+        initSchemaMessagingService();
+        initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.templateEntryStorageConnectorType, "TemplateEntry", ContextIdHelper.pickKeysFromAvailable(engineCore.getContextIdKeys(), [
+            ContextIdKeys.Node,
+            ContextIdKeys.Tenant
+        ]));
+        component = new MessagingAdminService({
+            ...instanceConfig.options
+        });
+        instanceType = "messaging-admin-service";
+    }
+    return {
+        component,
+        instanceType,
+        factory: ComponentFactory
+    };
+}
+//# sourceMappingURL=messaging.js.map