@twin.org/engine-types 0.0.1-next.52 → 0.0.1-next.53

package/dist/cjs/index.cjs

@@ -32,6 +32,7 @@ var dataProcessingConverters = require('@twin.org/data-processing-converters');
 var dataProcessingExtractors = require('@twin.org/data-processing-extractors');
 var dataProcessingModels = require('@twin.org/data-processing-models');
 var dataProcessingService = require('@twin.org/data-processing-service');
+var documentManagementService = require('@twin.org/document-management-service');
 var eventBusConnectorLocal = require('@twin.org/event-bus-connector-local');
 var eventBusModels = require('@twin.org/event-bus-models');
 var eventBusService = require('@twin.org/event-bus-service');
@@ -903,6 +904,61 @@ function initialiseDataProcessingComponent(engineCore, context, instanceConfig,
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Document management component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DocumentManagementComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Initialise the document management component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+function initialiseDocumentManagementComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
+        element: `Document Management Component: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === DocumentManagementComponentType.Service) {
+        component = new documentManagementService.DocumentManagementService({
+            auditableItemGraphComponentType: context.defaultTypes.auditableItemGraphComponent,
+            blobStorageComponentType: context.defaultTypes.blobStorageComponent,
+            attestationComponentType: context.defaultTypes.attestationComponent,
+            ...instanceConfig.options
+        });
+        instanceType = documentManagementService.DocumentManagementService.NAMESPACE;
+    }
+    else {
+        throw new core.GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "documentManagementComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    core.ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -2397,6 +2453,7 @@ exports.DataConverterConnectorType = DataConverterConnectorType;
 exports.DataExtractorConnectorType = DataExtractorConnectorType;
 exports.DataProcessingComponentType = DataProcessingComponentType;
 exports.DltConfigType = DltConfigType;
+exports.DocumentManagementComponentType = DocumentManagementComponentType;
 exports.EntityStorageComponentType = EntityStorageComponentType;
 exports.EntityStorageConnectorType = EntityStorageConnectorType;
 exports.EventBusComponentType = EventBusComponentType;
@@ -2433,6 +2490,7 @@ exports.initialiseBlobStorageConnector = initialiseBlobStorageConnector;
 exports.initialiseDataConverterConnector = initialiseDataConverterConnector;
 exports.initialiseDataExtractorConnector = initialiseDataExtractorConnector;
 exports.initialiseDataProcessingComponent = initialiseDataProcessingComponent;
+exports.initialiseDocumentManagementComponent = initialiseDocumentManagementComponent;
 exports.initialiseEntityStorageComponent = initialiseEntityStorageComponent;
 exports.initialiseEntityStorageConnector = initialiseEntityStorageConnector;
 exports.initialiseEventBusComponent = initialiseEventBusComponent;

package/dist/esm/index.mjs

@@ -30,6 +30,7 @@ import { JsonConverterConnector, XmlConverterConnector } from '@twin.org/data-pr
 import { JsonPathExtractorConnector } from '@twin.org/data-processing-extractors';
 import { DataConverterConnectorFactory, DataExtractorConnectorFactory } from '@twin.org/data-processing-models';
 import { initSchema as initSchema$4, DataProcessingService } from '@twin.org/data-processing-service';
+import { DocumentManagementService } from '@twin.org/document-management-service';
 import { LocalEventBusConnector } from '@twin.org/event-bus-connector-local';
 import { EventBusConnectorFactory } from '@twin.org/event-bus-models';
 import { EventBusService } from '@twin.org/event-bus-service';
@@ -901,6 +902,61 @@ function initialiseDataProcessingComponent(engineCore, context, instanceConfig,
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Document management component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DocumentManagementComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Initialise the document management component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+function initialiseDocumentManagementComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
+        element: `Document Management Component: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === DocumentManagementComponentType.Service) {
+        component = new DocumentManagementService({
+            auditableItemGraphComponentType: context.defaultTypes.auditableItemGraphComponent,
+            blobStorageComponentType: context.defaultTypes.blobStorageComponent,
+            attestationComponentType: context.defaultTypes.attestationComponent,
+            ...instanceConfig.options
+        });
+        instanceType = DocumentManagementService.NAMESPACE;
+    }
+    else {
+        throw new GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "documentManagementComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -2384,4 +2440,4 @@ const DltConfigType = {
     IotaStardust: "iota-stardust"
 };
 
-export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, ImmutableStorageComponentType, ImmutableStorageConnectorType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseImmutableStorageComponent, initialiseImmutableStorageConnector, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseWalletConnector, initialiseWalletStorage };
+export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, DocumentManagementComponentType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, ImmutableStorageComponentType, ImmutableStorageConnectorType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseDocumentManagementComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseImmutableStorageComponent, initialiseImmutableStorageConnector, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseWalletConnector, initialiseWalletStorage };

package/dist/types/components/documentManagement.d.ts

@@ -0,0 +1,13 @@
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { DocumentManagementComponentConfig } from "../models/config/documentManagementComponentConfig";
+import type { IEngineConfig } from "../models/IEngineConfig";
+/**
+ * Initialise the document management component.
+ * @param engineCore The engine core.
+ * @param context The context for the engine.
+ * @param instanceConfig The instance config.
+ * @param overrideInstanceType The instance type to override the default.
+ * @returns The name of the instance created.
+ * @throws GeneralError if the component type is unknown.
+ */
+export declare function initialiseDocumentManagementComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: DocumentManagementComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/index.d.ts

@@ -4,6 +4,7 @@ export * from "./components/auditableItemStream";
 export * from "./components/backgroundTask";
 export * from "./components/blobStorage";
 export * from "./components/dataProcessing";
+export * from "./components/documentManagement";
 export * from "./components/entityStorage";
 export * from "./components/eventBus";
 export * from "./components/faucet";
@@ -29,6 +30,7 @@ export * from "./models/config/dataConverterConnectorConfig";
 export * from "./models/config/dataExtractorConnectorConfig";
 export * from "./models/config/dataProcessingComponentConfig";
 export * from "./models/config/dltConfig";
+export * from "./models/config/documentManagementComponentConfig";
 export * from "./models/config/entityStorageComponentConfig";
 export * from "./models/config/entityStorageConnectorConfig";
 export * from "./models/config/eventBusComponentConfig";
@@ -67,6 +69,7 @@ export * from "./models/types/dataConverterConnectorType";
 export * from "./models/types/dataExtractorConnectorType";
 export * from "./models/types/dataProcessingComponentType";
 export * from "./models/types/dltConfigType";
+export * from "./models/types/documentManagementComponentType";
 export * from "./models/types/entityStorageComponentType";
 export * from "./models/types/entityStorageConnectorType";
 export * from "./models/types/eventBusComponentType";

package/dist/types/models/IEngineConfig.d.ts

@@ -10,6 +10,7 @@ import type { DataConverterConnectorConfig } from "./config/dataConverterConnect
 import type { DataExtractorConnectorConfig } from "./config/dataExtractorConnectorConfig";
 import type { DataProcessingComponentConfig } from "./config/dataProcessingComponentConfig";
 import type { DltConfig } from "./config/dltConfig";
+import type { DocumentManagementComponentConfig } from "./config/documentManagementComponentConfig";
 import type { EntityStorageComponentConfig } from "./config/entityStorageComponentConfig";
 import type { EntityStorageConnectorConfig } from "./config/entityStorageConnectorConfig";
 import type { EventBusComponentConfig } from "./config/eventBusComponentConfig";
@@ -193,5 +194,9 @@ export interface IEngineConfig extends IEngineCoreConfig {
          * Date processing options which can be overridden by individual components by specifying types other than default.
          */
         dataProcessingComponent?: IEngineCoreTypeConfig<DataProcessingComponentConfig>[];
+        /**
+         * Document management options which can be overridden by individual components by specifying types other than default.
+         */
+        documentManagementComponent?: IEngineCoreTypeConfig<DocumentManagementComponentConfig>[];
     };
 }

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

@@ -0,0 +1,9 @@
+import type { IDocumentManagementServiceConstructorOptions } from "@twin.org/document-management-service";
+import type { DocumentManagementComponentType } from "../types/documentManagementComponentType";
+/**
+ * Data processing component config types.
+ */
+export type DocumentManagementComponentConfig = {
+    type: typeof DocumentManagementComponentType.Service;
+    options?: IDocumentManagementServiceConstructorOptions;
+};

package/dist/types/models/types/documentManagementComponentType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Document management component types.
+ */
+export declare const DocumentManagementComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Document management component types.
+ */
+export type DocumentManagementComponentType = (typeof DocumentManagementComponentType)[keyof typeof DocumentManagementComponentType];

package/docs/reference/functions/initialiseDocumentManagementComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseDocumentManagementComponent()
+
+> **initialiseDocumentManagementComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `undefined` \| `string`
+
+Initialise the document management component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md)
+
+The instance config.
+
+### overrideInstanceType?
+
+`string`
+
+The instance type to override the default.
+
+## Returns
+
+`undefined` \| `string`
+
+The name of the instance created.
+
+## Throws
+
+GeneralError if the component type is unknown.

package/docs/reference/index.md

@@ -17,6 +17,7 @@
 - [DataExtractorConnectorConfig](type-aliases/DataExtractorConnectorConfig.md)
 - [DataProcessingComponentConfig](type-aliases/DataProcessingComponentConfig.md)
 - [DltConfig](type-aliases/DltConfig.md)
+- [DocumentManagementComponentConfig](type-aliases/DocumentManagementComponentConfig.md)
 - [EntityStorageComponentConfig](type-aliases/EntityStorageComponentConfig.md)
 - [EntityStorageConnectorConfig](type-aliases/EntityStorageConnectorConfig.md)
 - [EventBusComponentConfig](type-aliases/EventBusComponentConfig.md)
@@ -54,6 +55,7 @@
 - [DataExtractorConnectorType](type-aliases/DataExtractorConnectorType.md)
 - [DataProcessingComponentType](type-aliases/DataProcessingComponentType.md)
 - [DltConfigType](type-aliases/DltConfigType.md)
+- [DocumentManagementComponentType](type-aliases/DocumentManagementComponentType.md)
 - [EntityStorageComponentType](type-aliases/EntityStorageComponentType.md)
 - [EntityStorageConnectorType](type-aliases/EntityStorageConnectorType.md)
 - [EventBusComponentType](type-aliases/EventBusComponentType.md)
@@ -94,6 +96,7 @@
 - [DataExtractorConnectorType](variables/DataExtractorConnectorType.md)
 - [DataProcessingComponentType](variables/DataProcessingComponentType.md)
 - [DltConfigType](variables/DltConfigType.md)
+- [DocumentManagementComponentType](variables/DocumentManagementComponentType.md)
 - [EntityStorageComponentType](variables/EntityStorageComponentType.md)
 - [EntityStorageConnectorType](variables/EntityStorageConnectorType.md)
 - [EventBusComponentType](variables/EventBusComponentType.md)
@@ -133,6 +136,7 @@
 - [initialiseDataConverterConnector](functions/initialiseDataConverterConnector.md)
 - [initialiseDataExtractorConnector](functions/initialiseDataExtractorConnector.md)
 - [initialiseDataProcessingComponent](functions/initialiseDataProcessingComponent.md)
+- [initialiseDocumentManagementComponent](functions/initialiseDocumentManagementComponent.md)
 - [initialiseEntityStorageConnector](functions/initialiseEntityStorageConnector.md)
 - [initialiseEntityStorageComponent](functions/initialiseEntityStorageComponent.md)
 - [initialiseEventBusConnector](functions/initialiseEventBusConnector.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -240,6 +240,12 @@ Data extractor connector options which can be overridden by individual component
 
 Date processing options which can be overridden by individual components by specifying types other than default.
 
+#### documentManagementComponent?
+
+> `optional` **documentManagementComponent**: `IEngineCoreTypeConfig`\<[`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md)\>[]
+
+Document management options which can be overridden by individual components by specifying types other than default.
+
 #### Overrides
 
 `IEngineCoreConfig.types`

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

@@ -0,0 +1,15 @@
+# Type Alias: DocumentManagementComponentConfig
+
+> **DocumentManagementComponentConfig**: `object`
+
+Data processing component config types.
+
+## Type declaration
+
+### type
+
+> **type**: *typeof* [`Service`](../variables/DocumentManagementComponentType.md#service)
+
+### options?
+
+> `optional` **options**: `IDocumentManagementServiceConstructorOptions`

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentManagementComponentType
+
+> **DocumentManagementComponentType**: *typeof* [`DocumentManagementComponentType`](../variables/DocumentManagementComponentType.md)\[keyof *typeof* [`DocumentManagementComponentType`](../variables/DocumentManagementComponentType.md)\]
+
+Document management component types.

package/docs/reference/variables/DocumentManagementComponentType.md

@@ -0,0 +1,13 @@
+# Variable: DocumentManagementComponentType
+
+> `const` **DocumentManagementComponentType**: `object`
+
+Document management component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.1-next.52",
+	"version": "0.0.1-next.53",
 	"description": "Types to use in an engine.",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
-		"@twin.org/engine-models": "0.0.1-next.52",
+		"@twin.org/engine-models": "0.0.1-next.53",
 		"@twin.org/entity": "next",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
@@ -44,6 +44,8 @@
 		"@twin.org/data-processing-extractors": "next",
 		"@twin.org/data-processing-models": "next",
 		"@twin.org/data-processing-service": "next",
+		"@twin.org/document-management-models": "next",
+		"@twin.org/document-management-service": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",
 		"@twin.org/entity-storage-connector-file": "next",