@twin.org/engine-types 0.0.2-next.3 → 0.0.2-next.5

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

@@ -6,6 +6,7 @@ import type { IMongoDbEntityStorageConnectorConstructorOptions } from "@twin.org
 import type { IMySqlEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-mysql";
 import type { IPostgreSqlEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-postgresql";
 import type { IScyllaDBTableConnectorConstructorOptions } from "@twin.org/entity-storage-connector-scylladb";
+import type { ISynchronisedEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-synchronised";
 import type { EntityStorageConnectorType } from "../types/entityStorageConnectorType";
 /**
  * Entity storage connector config types.
@@ -60,4 +61,7 @@ export type EntityStorageConnectorConfig = {
         config: Omit<IPostgreSqlEntityStorageConnectorConstructorOptions["config"], "tableName">;
         tablePrefix?: string;
     };
+} | {
+    type: typeof EntityStorageConnectorType.Synchronised;
+    options: Omit<ISynchronisedEntityStorageConnectorConstructorOptions, "entitySchema">;
 };

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

@@ -0,0 +1,13 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { ISynchronisedStorageServiceConstructorOptions } from "@twin.org/synchronised-storage-service";
+import type { SynchronisedStorageComponentType } from "../types/synchronisedStorageComponentType";
+/**
+ * Synchronised storage component config types.
+ */
+export type SynchronisedStorageComponentConfig = {
+    type: typeof SynchronisedStorageComponentType.Service;
+    options: ISynchronisedStorageServiceConstructorOptions;
+} | {
+    type: typeof SynchronisedStorageComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

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/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/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/engine-types - Changelog
 
+## [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)
 
 

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/initialiseSynchronisedStorageComponent.md

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

@@ -41,6 +41,7 @@
 - [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
 - [RightsManagementComponentConfig](type-aliases/RightsManagementComponentConfig.md)
 - [RightsManagementPapComponentConfig](type-aliases/RightsManagementPapComponentConfig.md)
+- [SynchronisedStorageComponentConfig](type-aliases/SynchronisedStorageComponentConfig.md)
 - [TaskSchedulerComponentConfig](type-aliases/TaskSchedulerComponentConfig.md)
 - [TelemetryComponentConfig](type-aliases/TelemetryComponentConfig.md)
 - [TelemetryConnectorConfig](type-aliases/TelemetryConnectorConfig.md)
@@ -83,6 +84,7 @@
 - [NftConnectorType](type-aliases/NftConnectorType.md)
 - [RightsManagementComponentType](type-aliases/RightsManagementComponentType.md)
 - [RightsManagementPapComponentType](type-aliases/RightsManagementPapComponentType.md)
+- [SynchronisedStorageComponentType](type-aliases/SynchronisedStorageComponentType.md)
 - [TaskSchedulerComponentType](type-aliases/TaskSchedulerComponentType.md)
 - [TelemetryComponentType](type-aliases/TelemetryComponentType.md)
 - [TelemetryConnectorType](type-aliases/TelemetryConnectorType.md)
@@ -128,6 +130,7 @@
 - [NftConnectorType](variables/NftConnectorType.md)
 - [RightsManagementComponentType](variables/RightsManagementComponentType.md)
 - [RightsManagementPapComponentType](variables/RightsManagementPapComponentType.md)
+- [SynchronisedStorageComponentType](variables/SynchronisedStorageComponentType.md)
 - [TaskSchedulerComponentType](variables/TaskSchedulerComponentType.md)
 - [TelemetryComponentType](variables/TelemetryComponentType.md)
 - [TelemetryConnectorType](variables/TelemetryConnectorType.md)
@@ -172,6 +175,7 @@
 - [initialiseNftComponent](functions/initialiseNftComponent.md)
 - [initialiseRightsManagementComponent](functions/initialiseRightsManagementComponent.md)
 - [initialiseRightsManagementPapComponent](functions/initialiseRightsManagementPapComponent.md)
+- [initialiseSynchronisedStorageComponent](functions/initialiseSynchronisedStorageComponent.md)
 - [initialiseTaskSchedulerComponent](functions/initialiseTaskSchedulerComponent.md)
 - [initialiseTelemetryConnector](functions/initialiseTelemetryConnector.md)
 - [initialiseTelemetryComponent](functions/initialiseTelemetryComponent.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -252,12 +252,6 @@ Date processing options which can be overridden by individual components by spec
 
 Document management options which can be overridden by individual components by specifying types other than default.
 
-#### federatedCatalogueComponent?
-
-> `optional` **federatedCatalogueComponent**: `IEngineCoreTypeConfig`\<[`FederatedCatalogueComponentConfig`](../type-aliases/FederatedCatalogueComponentConfig.md)\>[]
-
-Federated catalogue options which can be overridden by individual components by specifying types other than default.
-
 #### rightsManagementComponent?
 
 > `optional` **rightsManagementComponent**: `IEngineCoreTypeConfig`\<[`RightsManagementComponentConfig`](../type-aliases/RightsManagementComponentConfig.md)\>[]
@@ -270,6 +264,18 @@ Rights management options which can be overridden by individual components by sp
 
 Rights management PAP options which can be overridden by individual components by specifying types other than default.
 
+#### synchronisedStorageComponent?
+
+> `optional` **synchronisedStorageComponent**: `IEngineCoreTypeConfig`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md)\>[]
+
+Synchronised storage options which can be overridden by individual components by specifying types other than default.
+
+#### federatedCatalogueComponent?
+
+> `optional` **federatedCatalogueComponent**: `IEngineCoreTypeConfig`\<[`FederatedCatalogueComponentConfig`](../type-aliases/FederatedCatalogueComponentConfig.md)\>[]
+
+Federated catalogue options which can be overridden by individual components by specifying types other than default.
+
 #### Overrides
 
 `IEngineCoreConfig.types`

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

@@ -1,5 +1,5 @@
 # Type Alias: EntityStorageConnectorConfig
 
-> **EntityStorageConnectorConfig** = \{ `type`: *typeof* [`File`](../variables/EntityStorageConnectorType.md#file); `options`: `Omit`\<`IFileEntityStorageConnectorConstructorOptions`, `"entitySchema"`\> & `object`; \} \| \{ `type`: *typeof* [`Memory`](../variables/EntityStorageConnectorType.md#memory); `options?`: `never`; \} \| \{ `type`: *typeof* [`AwsDynamoDb`](../variables/EntityStorageConnectorType.md#awsdynamodb); `options`: `Omit`\<`IDynamoDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`AzureCosmosDb`](../variables/EntityStorageConnectorType.md#azurecosmosdb); `options`: `Omit`\<`ICosmosDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`GcpFirestoreDb`](../variables/EntityStorageConnectorType.md#gcpfirestoredb); `options`: `Omit`\<`IFirestoreEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`ScyllaDb`](../variables/EntityStorageConnectorType.md#scylladb); `options`: `Omit`\<`IScyllaDBTableConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`MySqlDb`](../variables/EntityStorageConnectorType.md#mysqldb); `options`: `Omit`\<`IMySqlEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`MongoDb`](../variables/EntityStorageConnectorType.md#mongodb); `options`: `Omit`\<`IMongoDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`PostgreSql`](../variables/EntityStorageConnectorType.md#postgresql); `options`: `Omit`\<`IPostgreSqlEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \}
+> **EntityStorageConnectorConfig** = \{ `type`: *typeof* [`File`](../variables/EntityStorageConnectorType.md#file); `options`: `Omit`\<`IFileEntityStorageConnectorConstructorOptions`, `"entitySchema"`\> & `object`; \} \| \{ `type`: *typeof* [`Memory`](../variables/EntityStorageConnectorType.md#memory); `options?`: `never`; \} \| \{ `type`: *typeof* [`AwsDynamoDb`](../variables/EntityStorageConnectorType.md#awsdynamodb); `options`: `Omit`\<`IDynamoDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`AzureCosmosDb`](../variables/EntityStorageConnectorType.md#azurecosmosdb); `options`: `Omit`\<`ICosmosDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`GcpFirestoreDb`](../variables/EntityStorageConnectorType.md#gcpfirestoredb); `options`: `Omit`\<`IFirestoreEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`ScyllaDb`](../variables/EntityStorageConnectorType.md#scylladb); `options`: `Omit`\<`IScyllaDBTableConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`MySqlDb`](../variables/EntityStorageConnectorType.md#mysqldb); `options`: `Omit`\<`IMySqlEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`MongoDb`](../variables/EntityStorageConnectorType.md#mongodb); `options`: `Omit`\<`IMongoDbEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`PostgreSql`](../variables/EntityStorageConnectorType.md#postgresql); `options`: `Omit`\<`IPostgreSqlEntityStorageConnectorConstructorOptions`, `"entitySchema"` \| `"config"`\> & `object`; \} \| \{ `type`: *typeof* [`Synchronised`](../variables/EntityStorageConnectorType.md#synchronised); `options`: `Omit`\<`ISynchronisedEntityStorageConnectorConstructorOptions`, `"entitySchema"`\>; \}
 
 Entity storage connector config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageComponentConfig
+
+> **SynchronisedStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/SynchronisedStorageComponentType.md#service); `options`: `ISynchronisedStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/SynchronisedStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
+
+Synchronised storage component config types.

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

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageComponentType
+
+> **SynchronisedStorageComponentType** = *typeof* [`SynchronisedStorageComponentType`](../variables/SynchronisedStorageComponentType.md)\[keyof *typeof* [`SynchronisedStorageComponentType`](../variables/SynchronisedStorageComponentType.md)\]
+
+Synchronised storage component types.

package/docs/reference/variables/EntityStorageConnectorType.md

@@ -59,3 +59,9 @@ MongoDb.
 > `readonly` **PostgreSql**: `"postgresql"` = `"postgresql"`
 
 Postgre SQL.
+
+### Synchronised
+
+> `readonly` **Synchronised**: `"synchronised"` = `"synchronised"`
+
+Synchronised.

package/docs/reference/variables/SynchronisedStorageComponentType.md

@@ -0,0 +1,19 @@
+# Variable: SynchronisedStorageComponentType
+
+> `const` **SynchronisedStorageComponentType**: `object`
+
+Synchronised storage component types.
+
+## Type declaration
+
+### Service
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.
+
+### RestClient
+
+> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
+
+REST client.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Types to use in an engine.",
 	"repository": {
 		"type": "git",
@@ -47,7 +47,7 @@
 		"@twin.org/document-management-models": "next",
 		"@twin.org/document-management-rest-client": "next",
 		"@twin.org/document-management-service": "next",
-		"@twin.org/engine-models": "0.0.2-next.3",
+		"@twin.org/engine-models": "0.0.2-next.5",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",
@@ -58,6 +58,7 @@
 		"@twin.org/entity-storage-connector-mysql": "next",
 		"@twin.org/entity-storage-connector-postgresql": "next",
 		"@twin.org/entity-storage-connector-scylladb": "next",
+		"@twin.org/entity-storage-connector-synchronised": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/entity-storage-rest-client": "next",
 		"@twin.org/entity-storage-service": "next",
@@ -97,6 +98,9 @@
 		"@twin.org/rights-management-pap-service": "next",
 		"@twin.org/rights-management-rest-client": "next",
 		"@twin.org/rights-management-service": "next",
+		"@twin.org/synchronised-storage-models": "next",
+		"@twin.org/synchronised-storage-rest-client": "next",
+		"@twin.org/synchronised-storage-service": "next",
 		"@twin.org/telemetry-connector-entity-storage": "next",
 		"@twin.org/telemetry-models": "next",
 		"@twin.org/telemetry-rest-client": "next",