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

package/dist/cjs/index.cjs

@@ -1,340 +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');
-
-var coreTypeInitialisers = [
-	{
-		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"
-	}
-];
-
-// 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.
-     */
-    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);
-        }
-    }
-}
-
-// 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,337 +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';
-
-var coreTypeInitialisers = [
-	{
-		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"
-	}
-];
-
-// 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.
-     */
-    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);
-        }
-    }
-}
-
-// 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 };