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

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

@@ -4,6 +4,6 @@ import type { TaskSchedulerComponentType } from "../types/taskSchedulerComponent
  * Background task scheduled component config types.
  */
 export type TaskSchedulerComponentConfig = {
-    type: typeof TaskSchedulerComponentType.Default;
+    type: typeof TaskSchedulerComponentType.Service;
     options?: ITaskSchedulerConstructorOptions;
 };

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

@@ -1,3 +1,4 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { ITelemetryServiceConstructorOptions } from "@twin.org/telemetry-service";
 import type { TelemetryComponentType } from "../types/telemetryComponentType";
 /**
@@ -6,4 +7,7 @@ import type { TelemetryComponentType } from "../types/telemetryComponentType";
 export type TelemetryComponentConfig = {
     type: typeof TelemetryComponentType.Service;
     options?: ITelemetryServiceConstructorOptions;
+} | {
+    type: typeof TelemetryComponentType.RestClient;
+    options: IBaseRestClientConfig;
 };

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

@@ -1,3 +1,4 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IVerifiableStorageServiceConstructorOptions } from "@twin.org/verifiable-storage-service";
 import type { VerifiableStorageComponentType } from "../types/verifiableStorageComponentType";
 /**
@@ -6,4 +7,7 @@ import type { VerifiableStorageComponentType } from "../types/verifiableStorageC
 export type VerifiableStorageComponentConfig = {
     type: typeof VerifiableStorageComponentType.Service;
     options?: IVerifiableStorageServiceConstructorOptions;
+} | {
+    type: typeof VerifiableStorageComponentType.RestClient;
+    options: IBaseRestClientConfig;
 };

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

@@ -6,6 +6,10 @@ export declare const AttestationComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Attestation component types.

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

@@ -6,6 +6,10 @@ export declare const AuditableItemGraphComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Auditable item graph component types.

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

@@ -6,6 +6,10 @@ export declare const AuditableItemStreamComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Auditable item stream component types.

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

@@ -6,6 +6,10 @@ export declare const BlobStorageComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Blob storage component types.

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

@@ -6,6 +6,10 @@ export declare const DataProcessingComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Data processing component types.

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

@@ -0,0 +1,21 @@
+/**
+ * Data space connector component types.
+ */
+export declare const DataSpaceConnectorComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+    /**
+     * Socket client.
+     */
+    readonly SocketClient: "socket-client";
+};
+/**
+ * Data space connector component types.
+ */
+export type DataSpaceConnectorComponentType = (typeof DataSpaceConnectorComponentType)[keyof typeof DataSpaceConnectorComponentType];

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

@@ -6,6 +6,10 @@ export declare const DocumentManagementComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Document management component types.

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

@@ -6,6 +6,10 @@ export declare const EntityStorageComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Entity storage component types.

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

@@ -38,6 +38,10 @@ export declare const EntityStorageConnectorType: {
      * Postgre SQL.
      */
     readonly PostgreSql: "postgresql";
+    /**
+     * Synchronised.
+     */
+    readonly Synchronised: "synchronised";
 };
 /**
  * Entity storage connector types.

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

@@ -6,6 +6,10 @@ export declare const EventBusComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * Socket client.
+     */
+    readonly SocketClient: "socket-client";
 };
 /**
  * Event bus component types.

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

@@ -6,6 +6,10 @@ export declare const FederatedCatalogueComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Federated catalogue component types.

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

@@ -6,6 +6,10 @@ export declare const IdentityComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Identity component types.

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

@@ -6,6 +6,10 @@ export declare const IdentityProfileComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Identity profile component types.

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

@@ -6,6 +6,10 @@ export declare const IdentityResolverComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Identity resolver component types.

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

@@ -6,6 +6,10 @@ export declare const ImmutableProofComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Immutable proof component types.

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

@@ -6,6 +6,10 @@ export declare const LoggingComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Logging component types.

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

@@ -6,6 +6,10 @@ export declare const NftComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * NFT component types.

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

@@ -6,6 +6,10 @@ export declare const RightsManagementComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Rights management component types.

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Synchronised storage component types.
+ */
+export declare const SynchronisedStorageComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+};
+/**
+ * Synchronised storage component types.
+ */
+export type SynchronisedStorageComponentType = (typeof SynchronisedStorageComponentType)[keyof typeof SynchronisedStorageComponentType];

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

@@ -5,7 +5,7 @@ export declare const TaskSchedulerComponentType: {
     /**
      * Task scheduler.
      */
-    readonly Default: "default";
+    readonly Service: "service";
 };
 /**
  * Task scheduler component types.

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

@@ -6,6 +6,10 @@ export declare const TelemetryComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Telemetry component types.

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

@@ -6,6 +6,10 @@ export declare const VerifiableStorageComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Verifiable storage component types.

package/docs/changelog.md

@@ -1,5 +1,155 @@
 # @twin.org/engine-types - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.9...engine-types-v0.0.2-next.10) (2025-08-26)
+
+
+### Features
+
+* add data space connector ([a824d99](https://github.com/twinfoundation/engine/commit/a824d9931faeaa8115e01f8e7545b802d0e7ac70))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.9 to 0.0.2-next.10
+
+## [0.0.2-next.9](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.8...engine-types-v0.0.2-next.9) (2025-08-25)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.7...engine-types-v0.0.2-next.8) (2025-08-22)
+
+
+### Features
+
+* add rights management modules ([e02cadc](https://github.com/twinfoundation/engine/commit/e02cadc840d242fe16a73ab41ba61376c7467e50))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.7 to 0.0.2-next.8
+
+## [0.0.2-next.7](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.6...engine-types-v0.0.2-next.7) (2025-08-22)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.6 to 0.0.2-next.7
+
+## [0.0.2-next.6](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.5...engine-types-v0.0.2-next.6) (2025-08-21)
+
+
+### Features
+
+* update framework core ([acc0f8d](https://github.com/twinfoundation/engine/commit/acc0f8d455a4b8ec47f1da643139fa0f07775fa6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.5 to 0.0.2-next.6
+
+## [0.0.2-next.5](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.4...engine-types-v0.0.2-next.5) (2025-08-14)
+
+
+### Features
+
+* add synchronised storage support ([5142e34](https://github.com/twinfoundation/engine/commit/5142e3488f09195cf9f48a9c6c6d1014231a4c2c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.3...engine-types-v0.0.2-next.4) (2025-07-25)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.2...engine-types-v0.0.2-next.3) (2025-07-24)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.1...engine-types-v0.0.2-next.2) (2025-07-21)
+
+
+### Features
+
+* add rest clients as components ([c6f956a](https://github.com/twinfoundation/engine/commit/c6f956afe4fc22cd552174539c92a109448dc242))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+
+## [0.0.2-next.1](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.2-next.0...engine-types-v0.0.2-next.1) (2025-07-11)
+
+
+### Features
+
+* add auth admin component ([201cd06](https://github.com/twinfoundation/engine/commit/201cd061be83afccb5a6b06856ffe7cf8db7d6b3))
+* add data processing component to doc management component ([2e4920f](https://github.com/twinfoundation/engine/commit/2e4920fb0626060dd6c570bc2bc7357fa8605ff0))
+* add federated catalogue ([1b15dd0](https://github.com/twinfoundation/engine/commit/1b15dd059a11446457651c411a73145fab37f025))
+* add mimeTypeProcessors and disableNodeIdentity ([bb7e81e](https://github.com/twinfoundation/engine/commit/bb7e81e2036fe042068a5645ec59b22e20d33aad))
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+* attestation no longer requires wallet connector ([772caa8](https://github.com/twinfoundation/engine/commit/772caa87c09691a746550f490291cdcf284b0e0e))
+* iota rebased release ([474d92b](https://github.com/twinfoundation/engine/commit/474d92b352f4ccc431a4f138afee2ee89824664d))
+* modifying the engine to run the new services ([#10](https://github.com/twinfoundation/engine/issues/10)) ([6f7141f](https://github.com/twinfoundation/engine/commit/6f7141fe0a6d05c725066b274bcc18b5490e580b))
+* switch to devDeps ([32832ac](https://github.com/twinfoundation/engine/commit/32832acd934e1e5569474281a527c9b118d30732))
+* update dependencies ([97c9f64](https://github.com/twinfoundation/engine/commit/97c9f64b6ef096963bcc5de338a2a9e99bdc1a11))
+* use shared store mechanism ([#2](https://github.com/twinfoundation/engine/issues/2)) ([9eed8d7](https://github.com/twinfoundation/engine/commit/9eed8d7766388479b42f03e2542fe761f2156408))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-11)
 
 

package/docs/reference/functions/initialiseDataSpaceConnectorComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseDataSpaceConnectorComponent()
+
+> **initialiseDataSpaceConnectorComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+
+Initialise the data space connector component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`DataSpaceConnectorComponentConfig`](../type-aliases/DataSpaceConnectorComponentConfig.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/functions/initialiseEntityStorageConnector.md

@@ -1,6 +1,6 @@
 # Function: initialiseEntityStorageConnector()
 
-> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`): `void`
+> **initialiseEntityStorageConnector**(`engineCore`, `context`, `typeCustom`, `schema`): `string`
 
 Initialise the entity storage connector.
 
@@ -32,7 +32,9 @@ The schema for the entity storage.
 
 ## Returns
 
-`void`
+`string`
+
+The name of the instance type that was created.
 
 ## Throws
 

package/docs/reference/functions/initialiseRightsManagementPdpComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseRightsManagementPdpComponent()
+
+> **initialiseRightsManagementPdpComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+
+Initialise the rights management PDP component.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`RightsManagementPdpComponentConfig`](../type-aliases/RightsManagementPdpComponentConfig.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.