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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32,6 +32,7 @@ var dataProcessingConverters = require('@twin.org/data-processing-converters');
32
32
  var dataProcessingExtractors = require('@twin.org/data-processing-extractors');
33
33
  var dataProcessingModels = require('@twin.org/data-processing-models');
34
34
  var dataProcessingService = require('@twin.org/data-processing-service');
35
+ var documentManagementService = require('@twin.org/document-management-service');
35
36
  var eventBusConnectorLocal = require('@twin.org/event-bus-connector-local');
36
37
  var eventBusModels = require('@twin.org/event-bus-models');
37
38
  var eventBusService = require('@twin.org/event-bus-service');
@@ -903,6 +904,61 @@ function initialiseDataProcessingComponent(engineCore, context, instanceConfig,
903
904
  return finalInstanceType;
904
905
  }
905
906
 
907
+ // Copyright 2024 IOTA Stiftung.
908
+ // SPDX-License-Identifier: Apache-2.0.
909
+ /**
910
+ * Document management component types.
911
+ */
912
+ // eslint-disable-next-line @typescript-eslint/naming-convention
913
+ const DocumentManagementComponentType = {
914
+ /**
915
+ * Service.
916
+ */
917
+ Service: "service"
918
+ };
919
+
920
+ // Copyright 2024 IOTA Stiftung.
921
+ // SPDX-License-Identifier: Apache-2.0.
922
+ /**
923
+ * Initialise the document management component.
924
+ * @param engineCore The engine core.
925
+ * @param context The context for the engine.
926
+ * @param instanceConfig The instance config.
927
+ * @param overrideInstanceType The instance type to override the default.
928
+ * @returns The name of the instance created.
929
+ * @throws GeneralError if the component type is unknown.
930
+ */
931
+ function initialiseDocumentManagementComponent(engineCore, context, instanceConfig, overrideInstanceType) {
932
+ engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
933
+ element: `Document Management Component: ${instanceConfig.type}`
934
+ }));
935
+ const type = instanceConfig.type;
936
+ let component;
937
+ let instanceType;
938
+ if (type === DocumentManagementComponentType.Service) {
939
+ component = new documentManagementService.DocumentManagementService({
940
+ auditableItemGraphComponentType: context.defaultTypes.auditableItemGraphComponent,
941
+ blobStorageComponentType: context.defaultTypes.blobStorageComponent,
942
+ attestationComponentType: context.defaultTypes.attestationComponent,
943
+ ...instanceConfig.options
944
+ });
945
+ instanceType = documentManagementService.DocumentManagementService.NAMESPACE;
946
+ }
947
+ else {
948
+ throw new core.GeneralError("engineCore", "componentUnknownType", {
949
+ type,
950
+ componentType: "documentManagementComponent"
951
+ });
952
+ }
953
+ const finalInstanceType = overrideInstanceType ?? instanceType;
954
+ context.componentInstances.push({
955
+ instanceType: finalInstanceType,
956
+ component
957
+ });
958
+ core.ComponentFactory.register(finalInstanceType, () => component);
959
+ return finalInstanceType;
960
+ }
961
+
906
962
  // Copyright 2024 IOTA Stiftung.
907
963
  // SPDX-License-Identifier: Apache-2.0.
908
964
  /**
@@ -1338,6 +1394,10 @@ const IdentityResolverConnectorType = {
1338
1394
  * IOTA.
1339
1395
  */
1340
1396
  Iota: "iota",
1397
+ /**
1398
+ * IOTA Universal.
1399
+ */
1400
+ IotaUniversal: "iota-universal",
1341
1401
  /**
1342
1402
  * IOTA Stardust.
1343
1403
  */
@@ -1471,7 +1531,6 @@ function initialiseImmutableProofComponent(engineCore, context, instanceConfig,
1471
1531
  immutableProofService.initSchema();
1472
1532
  initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.immutableProofEntityStorageType, "ImmutableProof");
1473
1533
  component = new immutableProofService.ImmutableProofService({
1474
- vaultConnectorType: context.defaultTypes.vaultConnector,
1475
1534
  immutableStorageType: context.defaultTypes.immutableStorageConnector,
1476
1535
  identityConnectorType: context.defaultTypes.identityConnector,
1477
1536
  backgroundTaskConnectorType: context.defaultTypes.backgroundTaskConnector,
@@ -2397,6 +2456,7 @@ exports.DataConverterConnectorType = DataConverterConnectorType;
2397
2456
  exports.DataExtractorConnectorType = DataExtractorConnectorType;
2398
2457
  exports.DataProcessingComponentType = DataProcessingComponentType;
2399
2458
  exports.DltConfigType = DltConfigType;
2459
+ exports.DocumentManagementComponentType = DocumentManagementComponentType;
2400
2460
  exports.EntityStorageComponentType = EntityStorageComponentType;
2401
2461
  exports.EntityStorageConnectorType = EntityStorageConnectorType;
2402
2462
  exports.EventBusComponentType = EventBusComponentType;
@@ -2433,6 +2493,7 @@ exports.initialiseBlobStorageConnector = initialiseBlobStorageConnector;
2433
2493
  exports.initialiseDataConverterConnector = initialiseDataConverterConnector;
2434
2494
  exports.initialiseDataExtractorConnector = initialiseDataExtractorConnector;
2435
2495
  exports.initialiseDataProcessingComponent = initialiseDataProcessingComponent;
2496
+ exports.initialiseDocumentManagementComponent = initialiseDocumentManagementComponent;
2436
2497
  exports.initialiseEntityStorageComponent = initialiseEntityStorageComponent;
2437
2498
  exports.initialiseEntityStorageConnector = initialiseEntityStorageConnector;
2438
2499
  exports.initialiseEventBusComponent = initialiseEventBusComponent;
@@ -30,6 +30,7 @@ import { JsonConverterConnector, XmlConverterConnector } from '@twin.org/data-pr
30
30
  import { JsonPathExtractorConnector } from '@twin.org/data-processing-extractors';
31
31
  import { DataConverterConnectorFactory, DataExtractorConnectorFactory } from '@twin.org/data-processing-models';
32
32
  import { initSchema as initSchema$4, DataProcessingService } from '@twin.org/data-processing-service';
33
+ import { DocumentManagementService } from '@twin.org/document-management-service';
33
34
  import { LocalEventBusConnector } from '@twin.org/event-bus-connector-local';
34
35
  import { EventBusConnectorFactory } from '@twin.org/event-bus-models';
35
36
  import { EventBusService } from '@twin.org/event-bus-service';
@@ -901,6 +902,61 @@ function initialiseDataProcessingComponent(engineCore, context, instanceConfig,
901
902
  return finalInstanceType;
902
903
  }
903
904
 
905
+ // Copyright 2024 IOTA Stiftung.
906
+ // SPDX-License-Identifier: Apache-2.0.
907
+ /**
908
+ * Document management component types.
909
+ */
910
+ // eslint-disable-next-line @typescript-eslint/naming-convention
911
+ const DocumentManagementComponentType = {
912
+ /**
913
+ * Service.
914
+ */
915
+ Service: "service"
916
+ };
917
+
918
+ // Copyright 2024 IOTA Stiftung.
919
+ // SPDX-License-Identifier: Apache-2.0.
920
+ /**
921
+ * Initialise the document management component.
922
+ * @param engineCore The engine core.
923
+ * @param context The context for the engine.
924
+ * @param instanceConfig The instance config.
925
+ * @param overrideInstanceType The instance type to override the default.
926
+ * @returns The name of the instance created.
927
+ * @throws GeneralError if the component type is unknown.
928
+ */
929
+ function initialiseDocumentManagementComponent(engineCore, context, instanceConfig, overrideInstanceType) {
930
+ engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
931
+ element: `Document Management Component: ${instanceConfig.type}`
932
+ }));
933
+ const type = instanceConfig.type;
934
+ let component;
935
+ let instanceType;
936
+ if (type === DocumentManagementComponentType.Service) {
937
+ component = new DocumentManagementService({
938
+ auditableItemGraphComponentType: context.defaultTypes.auditableItemGraphComponent,
939
+ blobStorageComponentType: context.defaultTypes.blobStorageComponent,
940
+ attestationComponentType: context.defaultTypes.attestationComponent,
941
+ ...instanceConfig.options
942
+ });
943
+ instanceType = DocumentManagementService.NAMESPACE;
944
+ }
945
+ else {
946
+ throw new GeneralError("engineCore", "componentUnknownType", {
947
+ type,
948
+ componentType: "documentManagementComponent"
949
+ });
950
+ }
951
+ const finalInstanceType = overrideInstanceType ?? instanceType;
952
+ context.componentInstances.push({
953
+ instanceType: finalInstanceType,
954
+ component
955
+ });
956
+ ComponentFactory.register(finalInstanceType, () => component);
957
+ return finalInstanceType;
958
+ }
959
+
904
960
  // Copyright 2024 IOTA Stiftung.
905
961
  // SPDX-License-Identifier: Apache-2.0.
906
962
  /**
@@ -1336,6 +1392,10 @@ const IdentityResolverConnectorType = {
1336
1392
  * IOTA.
1337
1393
  */
1338
1394
  Iota: "iota",
1395
+ /**
1396
+ * IOTA Universal.
1397
+ */
1398
+ IotaUniversal: "iota-universal",
1339
1399
  /**
1340
1400
  * IOTA Stardust.
1341
1401
  */
@@ -1469,7 +1529,6 @@ function initialiseImmutableProofComponent(engineCore, context, instanceConfig,
1469
1529
  initSchema$6();
1470
1530
  initialiseEntityStorageConnector(engineCore, context, instanceConfig.options?.immutableProofEntityStorageType, "ImmutableProof");
1471
1531
  component = new ImmutableProofService({
1472
- vaultConnectorType: context.defaultTypes.vaultConnector,
1473
1532
  immutableStorageType: context.defaultTypes.immutableStorageConnector,
1474
1533
  identityConnectorType: context.defaultTypes.identityConnector,
1475
1534
  backgroundTaskConnectorType: context.defaultTypes.backgroundTaskConnector,
@@ -2384,4 +2443,4 @@ const DltConfigType = {
2384
2443
  IotaStardust: "iota-stardust"
2385
2444
  };
2386
2445
 
2387
- 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 };
2446
+ 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 };
@@ -0,0 +1,13 @@
1
+ import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
2
+ import type { DocumentManagementComponentConfig } from "../models/config/documentManagementComponentConfig";
3
+ import type { IEngineConfig } from "../models/IEngineConfig";
4
+ /**
5
+ * Initialise the document management component.
6
+ * @param engineCore The engine core.
7
+ * @param context The context for the engine.
8
+ * @param instanceConfig The instance config.
9
+ * @param overrideInstanceType The instance type to override the default.
10
+ * @returns The name of the instance created.
11
+ * @throws GeneralError if the component type is unknown.
12
+ */
13
+ export declare function initialiseDocumentManagementComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: DocumentManagementComponentConfig, overrideInstanceType?: string): string | undefined;
@@ -4,6 +4,7 @@ export * from "./components/auditableItemStream";
4
4
  export * from "./components/backgroundTask";
5
5
  export * from "./components/blobStorage";
6
6
  export * from "./components/dataProcessing";
7
+ export * from "./components/documentManagement";
7
8
  export * from "./components/entityStorage";
8
9
  export * from "./components/eventBus";
9
10
  export * from "./components/faucet";
@@ -29,6 +30,7 @@ export * from "./models/config/dataConverterConnectorConfig";
29
30
  export * from "./models/config/dataExtractorConnectorConfig";
30
31
  export * from "./models/config/dataProcessingComponentConfig";
31
32
  export * from "./models/config/dltConfig";
33
+ export * from "./models/config/documentManagementComponentConfig";
32
34
  export * from "./models/config/entityStorageComponentConfig";
33
35
  export * from "./models/config/entityStorageConnectorConfig";
34
36
  export * from "./models/config/eventBusComponentConfig";
@@ -67,6 +69,7 @@ export * from "./models/types/dataConverterConnectorType";
67
69
  export * from "./models/types/dataExtractorConnectorType";
68
70
  export * from "./models/types/dataProcessingComponentType";
69
71
  export * from "./models/types/dltConfigType";
72
+ export * from "./models/types/documentManagementComponentType";
70
73
  export * from "./models/types/entityStorageComponentType";
71
74
  export * from "./models/types/entityStorageConnectorType";
72
75
  export * from "./models/types/eventBusComponentType";
@@ -10,6 +10,7 @@ import type { DataConverterConnectorConfig } from "./config/dataConverterConnect
10
10
  import type { DataExtractorConnectorConfig } from "./config/dataExtractorConnectorConfig";
11
11
  import type { DataProcessingComponentConfig } from "./config/dataProcessingComponentConfig";
12
12
  import type { DltConfig } from "./config/dltConfig";
13
+ import type { DocumentManagementComponentConfig } from "./config/documentManagementComponentConfig";
13
14
  import type { EntityStorageComponentConfig } from "./config/entityStorageComponentConfig";
14
15
  import type { EntityStorageConnectorConfig } from "./config/entityStorageConnectorConfig";
15
16
  import type { EventBusComponentConfig } from "./config/eventBusComponentConfig";
@@ -193,5 +194,9 @@ export interface IEngineConfig extends IEngineCoreConfig {
193
194
  * Date processing options which can be overridden by individual components by specifying types other than default.
194
195
  */
195
196
  dataProcessingComponent?: IEngineCoreTypeConfig<DataProcessingComponentConfig>[];
197
+ /**
198
+ * Document management options which can be overridden by individual components by specifying types other than default.
199
+ */
200
+ documentManagementComponent?: IEngineCoreTypeConfig<DocumentManagementComponentConfig>[];
196
201
  };
197
202
  }
@@ -0,0 +1,9 @@
1
+ import type { IDocumentManagementServiceConstructorOptions } from "@twin.org/document-management-service";
2
+ import type { DocumentManagementComponentType } from "../types/documentManagementComponentType";
3
+ /**
4
+ * Data processing component config types.
5
+ */
6
+ export type DocumentManagementComponentConfig = {
7
+ type: typeof DocumentManagementComponentType.Service;
8
+ options?: IDocumentManagementServiceConstructorOptions;
9
+ };
@@ -1,17 +1,20 @@
1
1
  import type { IEntityStorageIdentityResolverConnectorConstructorOptions } from "@twin.org/identity-connector-entity-storage";
2
- import type { IIotaIdentityResolverConnectorConstructorOptions } from "@twin.org/identity-connector-iota";
2
+ import type { IIotaIdentityResolverConnectorConstructorOptions, IIotaUniversalResolverConnectorConstructorOptions } from "@twin.org/identity-connector-iota";
3
3
  import type { IIotaStardustIdentityResolverConnectorConstructorOptions } from "@twin.org/identity-connector-iota-stardust";
4
- import type { IdentityConnectorType } from "../types/identityConnectorType";
4
+ import type { IdentityResolverConnectorType } from "../types/identityResolverConnectorType";
5
5
  /**
6
6
  * Identity resolver config connector types.
7
7
  */
8
8
  export type IdentityResolverConnectorConfig = {
9
- type: typeof IdentityConnectorType.EntityStorage;
9
+ type: typeof IdentityResolverConnectorType.EntityStorage;
10
10
  options?: IEntityStorageIdentityResolverConnectorConstructorOptions;
11
11
  } | {
12
- type: typeof IdentityConnectorType.Iota;
12
+ type: typeof IdentityResolverConnectorType.Iota;
13
13
  options: IIotaIdentityResolverConnectorConstructorOptions;
14
14
  } | {
15
- type: typeof IdentityConnectorType.IotaStardust;
15
+ type: typeof IdentityResolverConnectorType.IotaStardust;
16
16
  options: IIotaStardustIdentityResolverConnectorConstructorOptions;
17
+ } | {
18
+ type: typeof IdentityResolverConnectorType.IotaUniversal;
19
+ options: IIotaUniversalResolverConnectorConstructorOptions;
17
20
  };
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Document management component types.
3
+ */
4
+ export declare const DocumentManagementComponentType: {
5
+ /**
6
+ * Service.
7
+ */
8
+ readonly Service: "service";
9
+ };
10
+ /**
11
+ * Document management component types.
12
+ */
13
+ export type DocumentManagementComponentType = (typeof DocumentManagementComponentType)[keyof typeof DocumentManagementComponentType];
@@ -10,6 +10,10 @@ export declare const IdentityResolverConnectorType: {
10
10
  * IOTA.
11
11
  */
12
12
  readonly Iota: "iota";
13
+ /**
14
+ * IOTA Universal.
15
+ */
16
+ readonly IotaUniversal: "iota-universal";
13
17
  /**
14
18
  * IOTA Stardust.
15
19
  */
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/engine-types - Changelog
2
2
 
3
- ## v0.0.1-next.37
3
+ ## v0.0.1-next.54
4
4
 
5
5
  - Initial Release
@@ -0,0 +1,41 @@
1
+ # Function: initialiseDocumentManagementComponent()
2
+
3
+ > **initialiseDocumentManagementComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType`?): `undefined` \| `string`
4
+
5
+ Initialise the document management component.
6
+
7
+ ## Parameters
8
+
9
+ ### engineCore
10
+
11
+ `IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
12
+
13
+ The engine core.
14
+
15
+ ### context
16
+
17
+ `IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
18
+
19
+ The context for the engine.
20
+
21
+ ### instanceConfig
22
+
23
+ [`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md)
24
+
25
+ The instance config.
26
+
27
+ ### overrideInstanceType?
28
+
29
+ `string`
30
+
31
+ The instance type to override the default.
32
+
33
+ ## Returns
34
+
35
+ `undefined` \| `string`
36
+
37
+ The name of the instance created.
38
+
39
+ ## Throws
40
+
41
+ GeneralError if the component type is unknown.
@@ -17,6 +17,7 @@
17
17
  - [DataExtractorConnectorConfig](type-aliases/DataExtractorConnectorConfig.md)
18
18
  - [DataProcessingComponentConfig](type-aliases/DataProcessingComponentConfig.md)
19
19
  - [DltConfig](type-aliases/DltConfig.md)
20
+ - [DocumentManagementComponentConfig](type-aliases/DocumentManagementComponentConfig.md)
20
21
  - [EntityStorageComponentConfig](type-aliases/EntityStorageComponentConfig.md)
21
22
  - [EntityStorageConnectorConfig](type-aliases/EntityStorageConnectorConfig.md)
22
23
  - [EventBusComponentConfig](type-aliases/EventBusComponentConfig.md)
@@ -54,6 +55,7 @@
54
55
  - [DataExtractorConnectorType](type-aliases/DataExtractorConnectorType.md)
55
56
  - [DataProcessingComponentType](type-aliases/DataProcessingComponentType.md)
56
57
  - [DltConfigType](type-aliases/DltConfigType.md)
58
+ - [DocumentManagementComponentType](type-aliases/DocumentManagementComponentType.md)
57
59
  - [EntityStorageComponentType](type-aliases/EntityStorageComponentType.md)
58
60
  - [EntityStorageConnectorType](type-aliases/EntityStorageConnectorType.md)
59
61
  - [EventBusComponentType](type-aliases/EventBusComponentType.md)
@@ -94,6 +96,7 @@
94
96
  - [DataExtractorConnectorType](variables/DataExtractorConnectorType.md)
95
97
  - [DataProcessingComponentType](variables/DataProcessingComponentType.md)
96
98
  - [DltConfigType](variables/DltConfigType.md)
99
+ - [DocumentManagementComponentType](variables/DocumentManagementComponentType.md)
97
100
  - [EntityStorageComponentType](variables/EntityStorageComponentType.md)
98
101
  - [EntityStorageConnectorType](variables/EntityStorageConnectorType.md)
99
102
  - [EventBusComponentType](variables/EventBusComponentType.md)
@@ -133,6 +136,7 @@
133
136
  - [initialiseDataConverterConnector](functions/initialiseDataConverterConnector.md)
134
137
  - [initialiseDataExtractorConnector](functions/initialiseDataExtractorConnector.md)
135
138
  - [initialiseDataProcessingComponent](functions/initialiseDataProcessingComponent.md)
139
+ - [initialiseDocumentManagementComponent](functions/initialiseDocumentManagementComponent.md)
136
140
  - [initialiseEntityStorageConnector](functions/initialiseEntityStorageConnector.md)
137
141
  - [initialiseEntityStorageComponent](functions/initialiseEntityStorageComponent.md)
138
142
  - [initialiseEventBusConnector](functions/initialiseEventBusConnector.md)
@@ -240,6 +240,12 @@ Data extractor connector options which can be overridden by individual component
240
240
 
241
241
  Date processing options which can be overridden by individual components by specifying types other than default.
242
242
 
243
+ #### documentManagementComponent?
244
+
245
+ > `optional` **documentManagementComponent**: `IEngineCoreTypeConfig`\<[`DocumentManagementComponentConfig`](../type-aliases/DocumentManagementComponentConfig.md)\>[]
246
+
247
+ Document management options which can be overridden by individual components by specifying types other than default.
248
+
243
249
  #### Overrides
244
250
 
245
251
  `IEngineCoreConfig.types`
@@ -0,0 +1,15 @@
1
+ # Type Alias: DocumentManagementComponentConfig
2
+
3
+ > **DocumentManagementComponentConfig**: `object`
4
+
5
+ Data processing component config types.
6
+
7
+ ## Type declaration
8
+
9
+ ### type
10
+
11
+ > **type**: *typeof* [`Service`](../variables/DocumentManagementComponentType.md#service)
12
+
13
+ ### options?
14
+
15
+ > `optional` **options**: `IDocumentManagementServiceConstructorOptions`
@@ -0,0 +1,5 @@
1
+ # Type Alias: DocumentManagementComponentType
2
+
3
+ > **DocumentManagementComponentType**: *typeof* [`DocumentManagementComponentType`](../variables/DocumentManagementComponentType.md)\[keyof *typeof* [`DocumentManagementComponentType`](../variables/DocumentManagementComponentType.md)\]
4
+
5
+ Document management component types.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: IdentityResolverConnectorConfig
2
2
 
3
- > **IdentityResolverConnectorConfig**: \{ `type`: *typeof* [`EntityStorage`](../variables/IdentityConnectorType.md#entitystorage); `options`: `IEntityStorageIdentityResolverConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Iota`](../variables/IdentityConnectorType.md#iota); `options`: `IIotaIdentityResolverConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`IotaStardust`](../variables/IdentityConnectorType.md#iotastardust); `options`: `IIotaStardustIdentityResolverConnectorConstructorOptions`; \}
3
+ > **IdentityResolverConnectorConfig**: \{ `type`: *typeof* [`EntityStorage`](../variables/IdentityResolverConnectorType.md#entitystorage); `options`: `IEntityStorageIdentityResolverConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Iota`](../variables/IdentityResolverConnectorType.md#iota); `options`: `IIotaIdentityResolverConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`IotaStardust`](../variables/IdentityResolverConnectorType.md#iotastardust); `options`: `IIotaStardustIdentityResolverConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`IotaUniversal`](../variables/IdentityResolverConnectorType.md#iotauniversal); `options`: `IIotaUniversalResolverConnectorConstructorOptions`; \}
4
4
 
5
5
  Identity resolver config connector types.
@@ -0,0 +1,13 @@
1
+ # Variable: DocumentManagementComponentType
2
+
3
+ > `const` **DocumentManagementComponentType**: `object`
4
+
5
+ Document management component types.
6
+
7
+ ## Type declaration
8
+
9
+ ### Service
10
+
11
+ > `readonly` **Service**: `"service"` = `"service"`
12
+
13
+ Service.
@@ -18,6 +18,12 @@ Entity storage.
18
18
 
19
19
  IOTA.
20
20
 
21
+ ### IotaUniversal
22
+
23
+ > `readonly` **IotaUniversal**: `"iota-universal"` = `"iota-universal"`
24
+
25
+ IOTA Universal.
26
+
21
27
  ### IotaStardust
22
28
 
23
29
  > `readonly` **IotaStardust**: `"iota-stardust"` = `"iota-stardust"`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/engine-types",
3
- "version": "0.0.1-next.52",
3
+ "version": "0.0.1-next.54",
4
4
  "description": "Types to use in an engine.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -17,7 +17,7 @@
17
17
  "@twin.org/core": "next",
18
18
  "@twin.org/crypto": "next",
19
19
  "@twin.org/data-core": "next",
20
- "@twin.org/engine-models": "0.0.1-next.52",
20
+ "@twin.org/engine-models": "0.0.1-next.54",
21
21
  "@twin.org/entity": "next",
22
22
  "@twin.org/modules": "next",
23
23
  "@twin.org/nameof": "next"
@@ -44,6 +44,8 @@
44
44
  "@twin.org/data-processing-extractors": "next",
45
45
  "@twin.org/data-processing-models": "next",
46
46
  "@twin.org/data-processing-service": "next",
47
+ "@twin.org/document-management-models": "next",
48
+ "@twin.org/document-management-service": "next",
47
49
  "@twin.org/entity-storage-connector-cosmosdb": "next",
48
50
  "@twin.org/entity-storage-connector-dynamodb": "next",
49
51
  "@twin.org/entity-storage-connector-file": "next",