@twin.org/synchronised-storage-models 0.0.1-next.1 → 0.0.1-next.2

package/dist/cjs/index.cjs

@@ -1,5 +1,22 @@
 'use strict';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The operations for a change.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SyncChangeOperation = {
+    /**
+     * An item was set in the storage.
+     */
+    Set: "set",
+    /**
+     * An item was deleted from the storage.
+     */
+    Delete: "delete"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -12,21 +29,25 @@ const SynchronisedStorageTopics = {
      */
     RegisterSchemaType: "synchronised-storage:register-schema-type",
     /**
-     * An item was set in the storage by the local node.
+     * An item was changed in the storage by the local node.
+     */
+    LocalItemChange: "synchronised-storage:local-item-change",
+    /**
+     * A request has been made for a local item.
      */
-    LocalItemSet: "synchronised-storage:local-item-set",
+    LocalItemRequest: "synchronised-storage:local-item-request",
     /**
-     * An item was removed from the storage by the local node.
+     * A response to a local item request.
      */
-    LocalItemRemove: "synchronised-storage:local-item-remove",
+    LocalItemResponse: "synchronised-storage:local-item-response",
     /**
-     * A request has been made for a consolidation batch.
+     * A request has been made for a batch.
      */
-    ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request",
+    BatchRequest: "synchronised-storage:batch-request",
     /**
-     * A response to a consolidation batch.
+     * A response to a batch.
      */
-    ConsolidationBatchResponse: "synchronised-storage:consolidation-batch-response",
+    BatchResponse: "synchronised-storage:batch-response",
     /**
      * An item was set in the storage by the remote node.
      */
@@ -37,4 +58,5 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
+exports.SyncChangeOperation = SyncChangeOperation;
 exports.SynchronisedStorageTopics = SynchronisedStorageTopics;

package/dist/esm/index.mjs

@@ -1,3 +1,20 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The operations for a change.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SyncChangeOperation = {
+    /**
+     * An item was set in the storage.
+     */
+    Set: "set",
+    /**
+     * An item was deleted from the storage.
+     */
+    Delete: "delete"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -10,21 +27,25 @@ const SynchronisedStorageTopics = {
      */
     RegisterSchemaType: "synchronised-storage:register-schema-type",
     /**
-     * An item was set in the storage by the local node.
+     * An item was changed in the storage by the local node.
+     */
+    LocalItemChange: "synchronised-storage:local-item-change",
+    /**
+     * A request has been made for a local item.
      */
-    LocalItemSet: "synchronised-storage:local-item-set",
+    LocalItemRequest: "synchronised-storage:local-item-request",
     /**
-     * An item was removed from the storage by the local node.
+     * A response to a local item request.
      */
-    LocalItemRemove: "synchronised-storage:local-item-remove",
+    LocalItemResponse: "synchronised-storage:local-item-response",
     /**
-     * A request has been made for a consolidation batch.
+     * A request has been made for a batch.
      */
-    ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request",
+    BatchRequest: "synchronised-storage:batch-request",
     /**
-     * A response to a consolidation batch.
+     * A response to a batch.
      */
-    ConsolidationBatchResponse: "synchronised-storage:consolidation-batch-response",
+    BatchResponse: "synchronised-storage:batch-response",
     /**
      * An item was set in the storage by the remote node.
      */
@@ -35,4 +56,4 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
-export { SynchronisedStorageTopics };
+export { SyncChangeOperation, SynchronisedStorageTopics };

package/dist/types/index.d.ts

@@ -1,9 +1,13 @@
 export * from "./models/api/ISyncChangeSetRequest";
-export * from "./models/eventBus/ISyncConsolidationBatchRequest";
-export * from "./models/eventBus/ISyncConsolidationBatchResponse";
+export * from "./models/eventBus/ISyncBatchRequest";
+export * from "./models/eventBus/ISyncBatchResponse";
+export * from "./models/eventBus/ISyncItemChange";
 export * from "./models/eventBus/ISyncItemRemove";
+export * from "./models/eventBus/ISyncItemRequest";
+export * from "./models/eventBus/ISyncItemResponse";
 export * from "./models/eventBus/ISyncItemSet";
 export * from "./models/eventBus/ISyncRegisterSchemaType";
+export * from "./models/eventBus/syncChangeOperation";
 export * from "./models/ISynchronisedEntity";
 export * from "./models/ISynchronisedStorageComponent";
 export * from "./models/synchronisedStorageTopics";

package/dist/types/models/eventBus/ISyncBatchRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Request for a local batch.
+ */
+export interface ISyncBatchRequest {
+    /**
+     * The type of the schema for the entities in the batch.
+     */
+    schemaType: string;
+    /**
+     * The size of the batch.
+     */
+    batchSize: number;
+}

package/dist/types/models/eventBus/{ISyncConsolidationBatchResponse.d.ts → ISyncBatchResponse.d.ts}

@@ -1,19 +1,20 @@
 import type { ISynchronisedEntity } from "../ISynchronisedEntity";
 /**
- * Response for a local consolidation batch.
+ * Response for a local batch.
  */
-export interface ISyncConsolidationBatchResponse<T extends ISynchronisedEntity> {
+export interface ISyncBatchResponse<T extends ISynchronisedEntity> {
     /**
      * The type of the schema for the entities in the batch.
      */
     schemaType: string;
     /**
-     * The entities in the consolidation batch.
+     * The primary key of the entity in the sync item response.
      */
-    entities: {
-        id: string;
-        entity: T;
-    }[];
+    primaryKey: keyof T;
+    /**
+     * The entities in the batch.
+     */
+    entities: T[];
     /**
      * Is this the last entry in the batch?
      */

package/dist/types/models/eventBus/ISyncItemChange.d.ts

@@ -0,0 +1,18 @@
+import type { SyncChangeOperation } from "./syncChangeOperation";
+/**
+ * The payload for an item change.
+ */
+export interface ISyncItemChange {
+    /**
+     * The type of the schema being changed.
+     */
+    schemaType: string;
+    /**
+     * The operation being performed on the item.
+     */
+    operation: SyncChangeOperation;
+    /**
+     * The id of the item being changed.
+     */
+    id: string;
+}

package/dist/types/models/eventBus/ISyncItemRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Request for a local item.
+ */
+export interface ISyncItemRequest {
+    /**
+     * The type of the schema for the entities in the batch.
+     */
+    schemaType: string;
+    /**
+     * The item id being requested.
+     */
+    id: string;
+}

package/dist/types/models/eventBus/ISyncItemResponse.d.ts

@@ -0,0 +1,18 @@
+import type { ISynchronisedEntity } from "../ISynchronisedEntity";
+/**
+ * Response for a sync item request.
+ */
+export interface ISyncItemResponse<T extends ISynchronisedEntity> {
+    /**
+     * The type of the schema for the entities in the batch.
+     */
+    schemaType: string;
+    /**
+     * The id of the entity in the sync item response.
+     */
+    id: string;
+    /**
+     * The entity in the sync item response, undefined if not found.
+     */
+    entity?: T;
+}

package/dist/types/models/eventBus/ISyncItemSet.d.ts

@@ -7,10 +7,6 @@ export interface ISyncItemSet<T extends ISynchronisedEntity = ISynchronisedEntit
      * The type of the schema being set.
      */
     schemaType: string;
-    /**
-     * The id of the item being set.
-     */
-    id: string;
     /**
      * The entity being set in the item set.
      */

package/dist/types/models/eventBus/syncChangeOperation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The operations for a change.
+ */
+export declare const SyncChangeOperation: {
+    /**
+     * An item was set in the storage.
+     */
+    readonly Set: "set";
+    /**
+     * An item was deleted from the storage.
+     */
+    readonly Delete: "delete";
+};
+/**
+ * The operations for a change
+ */
+export type SyncChangeOperation = (typeof SyncChangeOperation)[keyof typeof SyncChangeOperation];

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

@@ -7,21 +7,25 @@ export declare const SynchronisedStorageTopics: {
      */
     readonly RegisterSchemaType: "synchronised-storage:register-schema-type";
     /**
-     * An item was set in the storage by the local node.
+     * An item was changed in the storage by the local node.
      */
-    readonly LocalItemSet: "synchronised-storage:local-item-set";
+    readonly LocalItemChange: "synchronised-storage:local-item-change";
     /**
-     * An item was removed from the storage by the local node.
+     * A request has been made for a local item.
      */
-    readonly LocalItemRemove: "synchronised-storage:local-item-remove";
+    readonly LocalItemRequest: "synchronised-storage:local-item-request";
     /**
-     * A request has been made for a consolidation batch.
+     * A response to a local item request.
      */
-    readonly ConsolidationBatchRequest: "synchronised-storage:consolidation-batch-request";
+    readonly LocalItemResponse: "synchronised-storage:local-item-response";
     /**
-     * A response to a consolidation batch.
+     * A request has been made for a batch.
      */
-    readonly ConsolidationBatchResponse: "synchronised-storage:consolidation-batch-response";
+    readonly BatchRequest: "synchronised-storage:batch-request";
+    /**
+     * A response to a batch.
+     */
+    readonly BatchResponse: "synchronised-storage:batch-response";
     /**
      * An item was set in the storage by the remote node.
      */

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.1-next.2](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.1...synchronised-storage-models-v0.0.1-next.2) (2025-07-22)
+
+
+### Features
+
+* add async item requests to reduce storage overhead ([#3](https://github.com/twinfoundation/synchronised-storage/issues/3)) ([af4e17d](https://github.com/twinfoundation/synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
+
 ## [0.0.1-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.0...synchronised-storage-models-v0.0.1-next.1) (2025-07-18)
 
 

package/docs/reference/index.md

@@ -5,16 +5,21 @@
 - [ISynchronisedEntity](interfaces/ISynchronisedEntity.md)
 - [ISynchronisedStorageComponent](interfaces/ISynchronisedStorageComponent.md)
 - [ISyncChangeSetRequest](interfaces/ISyncChangeSetRequest.md)
-- [ISyncConsolidationBatchRequest](interfaces/ISyncConsolidationBatchRequest.md)
-- [ISyncConsolidationBatchResponse](interfaces/ISyncConsolidationBatchResponse.md)
+- [ISyncBatchRequest](interfaces/ISyncBatchRequest.md)
+- [ISyncBatchResponse](interfaces/ISyncBatchResponse.md)
+- [ISyncItemChange](interfaces/ISyncItemChange.md)
 - [ISyncItemRemove](interfaces/ISyncItemRemove.md)
+- [ISyncItemRequest](interfaces/ISyncItemRequest.md)
+- [ISyncItemResponse](interfaces/ISyncItemResponse.md)
 - [ISyncItemSet](interfaces/ISyncItemSet.md)
 - [ISyncRegisterSchemaType](interfaces/ISyncRegisterSchemaType.md)
 
 ## Type Aliases
 
+- [SyncChangeOperation](type-aliases/SyncChangeOperation.md)
 - [SynchronisedStorageTopics](type-aliases/SynchronisedStorageTopics.md)
 
 ## Variables
 
+- [SyncChangeOperation](variables/SyncChangeOperation.md)
 - [SynchronisedStorageTopics](variables/SynchronisedStorageTopics.md)

package/docs/reference/interfaces/ISyncBatchRequest.md

@@ -0,0 +1,19 @@
+# Interface: ISyncBatchRequest
+
+Request for a local batch.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema for the entities in the batch.
+
+***
+
+### batchSize
+
+> **batchSize**: `number`
+
+The size of the batch.

package/docs/reference/interfaces/{ISyncConsolidationBatchResponse.md → ISyncBatchResponse.md}

@@ -1,6 +1,6 @@
-# Interface: ISyncConsolidationBatchResponse\<T\>
+# Interface: ISyncBatchResponse\<T\>
 
-Response for a local consolidation batch.
+Response for a local batch.
 
 ## Type Parameters
 
@@ -18,19 +18,19 @@ The type of the schema for the entities in the batch.
 
 ***
 
-### entities
+### primaryKey
 
-> **entities**: `object`[]
+> **primaryKey**: keyof `T`
 
-The entities in the consolidation batch.
+The primary key of the entity in the sync item response.
 
-#### id
+***
 
-> **id**: `string`
+### entities
 
-#### entity
+> **entities**: `T`[]
 
-> **entity**: `T`
+The entities in the batch.
 
 ***
 

package/docs/reference/interfaces/ISyncItemChange.md

@@ -0,0 +1,27 @@
+# Interface: ISyncItemChange
+
+The payload for an item change.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema being changed.
+
+***
+
+### operation
+
+> **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
+
+The operation being performed on the item.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the item being changed.

package/docs/reference/interfaces/ISyncItemRequest.md

@@ -0,0 +1,19 @@
+# Interface: ISyncItemRequest
+
+Request for a local item.
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema for the entities in the batch.
+
+***
+
+### id
+
+> **id**: `string`
+
+The item id being requested.

package/docs/reference/interfaces/ISyncItemResponse.md

@@ -0,0 +1,33 @@
+# Interface: ISyncItemResponse\<T\>
+
+Response for a sync item request.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md)
+
+## Properties
+
+### schemaType
+
+> **schemaType**: `string`
+
+The type of the schema for the entities in the batch.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the entity in the sync item response.
+
+***
+
+### entity?
+
+> `optional` **entity**: `T`
+
+The entity in the sync item response, undefined if not found.

package/docs/reference/interfaces/ISyncItemSet.md

@@ -18,14 +18,6 @@ The type of the schema being set.
 
 ***
 
-### id
-
-> **id**: `string`
-
-The id of the item being set.
-
-***
-
 ### entity
 
 > **entity**: `T`

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

@@ -0,0 +1,5 @@
+# Type Alias: SyncChangeOperation
+
+> **SyncChangeOperation** = *typeof* [`SyncChangeOperation`](../variables/SyncChangeOperation.md)\[keyof *typeof* [`SyncChangeOperation`](../variables/SyncChangeOperation.md)\]
+
+The operations for a change

package/docs/reference/variables/SyncChangeOperation.md

@@ -0,0 +1,19 @@
+# Variable: SyncChangeOperation
+
+> `const` **SyncChangeOperation**: `object`
+
+The operations for a change.
+
+## Type declaration
+
+### Set
+
+> `readonly` **Set**: `"set"` = `"set"`
+
+An item was set in the storage.
+
+### Delete
+
+> `readonly` **Delete**: `"delete"` = `"delete"`
+
+An item was deleted from the storage.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -12,29 +12,35 @@ The topics for synchronised storage event bus notifications.
 
 Register a schema type for the synchronised storage.
 
-### LocalItemSet
+### LocalItemChange
 
-> `readonly` **LocalItemSet**: `"synchronised-storage:local-item-set"` = `"synchronised-storage:local-item-set"`
+> `readonly` **LocalItemChange**: `"synchronised-storage:local-item-change"` = `"synchronised-storage:local-item-change"`
 
-An item was set in the storage by the local node.
+An item was changed in the storage by the local node.
 
-### LocalItemRemove
+### LocalItemRequest
 
-> `readonly` **LocalItemRemove**: `"synchronised-storage:local-item-remove"` = `"synchronised-storage:local-item-remove"`
+> `readonly` **LocalItemRequest**: `"synchronised-storage:local-item-request"` = `"synchronised-storage:local-item-request"`
 
-An item was removed from the storage by the local node.
+A request has been made for a local item.
 
-### ConsolidationBatchRequest
+### LocalItemResponse
 
-> `readonly` **ConsolidationBatchRequest**: `"synchronised-storage:consolidation-batch-request"` = `"synchronised-storage:consolidation-batch-request"`
+> `readonly` **LocalItemResponse**: `"synchronised-storage:local-item-response"` = `"synchronised-storage:local-item-response"`
 
-A request has been made for a consolidation batch.
+A response to a local item request.
 
-### ConsolidationBatchResponse
+### BatchRequest
 
-> `readonly` **ConsolidationBatchResponse**: `"synchronised-storage:consolidation-batch-response"` = `"synchronised-storage:consolidation-batch-response"`
+> `readonly` **BatchRequest**: `"synchronised-storage:batch-request"` = `"synchronised-storage:batch-request"`
 
-A response to a consolidation batch.
+A request has been made for a batch.
+
+### BatchResponse
+
+> `readonly` **BatchResponse**: `"synchronised-storage:batch-response"` = `"synchronised-storage:batch-response"`
+
+A response to a batch.
 
 ### RemoteItemSet
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-models",
-	"version": "0.0.1-next.1",
+	"version": "0.0.1-next.2",
 	"description": "Models which define the structure of the synchronised storage connectors and services",
 	"repository": {
 		"type": "git",

package/dist/types/models/eventBus/ISyncConsolidationBatchRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * Request for a local consolidation batch.
- */
-export interface ISyncConsolidationBatchRequest {
-    /**
-     * The type of the schema for the entities in the batch.
-     */
-    schemaType: string;
-    /**
-     * The size of the consolidation batch.
-     */
-    consolidationBatchSize: number;
-}

package/docs/reference/interfaces/ISyncConsolidationBatchRequest.md

@@ -1,19 +0,0 @@
-# Interface: ISyncConsolidationBatchRequest
-
-Request for a local consolidation batch.
-
-## Properties
-
-### schemaType
-
-> **schemaType**: `string`
-
-The type of the schema for the entities in the batch.
-
-***
-
-### consolidationBatchSize
-
-> **consolidationBatchSize**: `number`
-
-The size of the consolidation batch.