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

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/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;
 }