@twin.org/synchronised-storage-models 0.0.1-next.4 → 0.0.1-next.6

package/dist/cjs/index.cjs

@@ -40,6 +40,10 @@ const SynchronisedStorageTopics = {
      * A response to a local item request.
      */
     LocalItemResponse: "synchronised-storage:local-item-response",
+    /**
+     * Reset the storage.
+     */
+    Reset: "synchronised-storage:reset",
     /**
      * A request has been made for a batch.
      */
@@ -58,5 +62,27 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The mode to determine how node identities are matched.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SyncNodeIdentityMode = {
+    /**
+     * Match the local node identity.
+     */
+    Local: "local",
+    /**
+     * Match all but the local node identity.
+     */
+    Remote: "remote",
+    /**
+     * All match both local and remote entities.
+     */
+    All: "all"
+};
+
 exports.SyncChangeOperation = SyncChangeOperation;
+exports.SyncNodeIdentityMode = SyncNodeIdentityMode;
 exports.SynchronisedStorageTopics = SynchronisedStorageTopics;

package/dist/esm/index.mjs

@@ -38,6 +38,10 @@ const SynchronisedStorageTopics = {
      * A response to a local item request.
      */
     LocalItemResponse: "synchronised-storage:local-item-response",
+    /**
+     * Reset the storage.
+     */
+    Reset: "synchronised-storage:reset",
     /**
      * A request has been made for a batch.
      */
@@ -56,4 +60,25 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
-export { SyncChangeOperation, SynchronisedStorageTopics };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The mode to determine how node identities are matched.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SyncNodeIdentityMode = {
+    /**
+     * Match the local node identity.
+     */
+    Local: "local",
+    /**
+     * Match all but the local node identity.
+     */
+    Remote: "remote",
+    /**
+     * All match both local and remote entities.
+     */
+    All: "all"
+};
+
+export { SyncChangeOperation, SyncNodeIdentityMode, SynchronisedStorageTopics };

package/dist/types/index.d.ts

@@ -9,9 +9,11 @@ export * from "./models/eventBus/ISyncItemRequest";
 export * from "./models/eventBus/ISyncItemResponse";
 export * from "./models/eventBus/ISyncItemSet";
 export * from "./models/eventBus/ISyncRegisterStorageKey";
+export * from "./models/eventBus/ISyncReset";
 export * from "./models/eventBus/syncChangeOperation";
 export * from "./models/ISyncChange";
 export * from "./models/ISyncChangeSet";
 export * from "./models/ISynchronisedEntity";
 export * from "./models/ISynchronisedStorageComponent";
 export * from "./models/synchronisedStorageTopics";
+export * from "./models/syncNodeIdentityMode";

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

@@ -20,7 +20,7 @@ export interface ISyncChangeSet<T extends ISynchronisedEntity = ISynchronisedEnt
     /**
      * The date the change set was last modified.
      */
-    dateModified?: string;
+    dateModified: string;
     /**
      * The changes to apply after a snapshot.
      */

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

@@ -1,3 +1,4 @@
+import type { SyncNodeIdentityMode } from "../syncNodeIdentityMode";
 /**
  * Request for a local batch.
  */
@@ -10,4 +11,8 @@ export interface ISyncBatchRequest {
      * The size of the batch.
      */
     batchSize: number;
+    /**
+     * Determines which entries are required, for local it will match the nodeIdentity, for remote it will not include matching nodeIdentity, for all it will include all entries.
+     */
+    requestMode: SyncNodeIdentityMode;
 }

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

@@ -11,6 +11,10 @@ export interface ISyncItemChange {
      * The operation being performed on the item.
      */
     operation: SyncChangeOperation;
+    /**
+     * The node performing the operation.
+     */
+    nodeIdentity: string;
     /**
      * The id of the item being changed.
      */

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

@@ -6,6 +6,10 @@ export interface ISyncItemRemove {
      * The key of the storage being removed.
      */
     storageKey: string;
+    /**
+     * The node identity of the entity being removed.
+     */
+    nodeIdentity: string;
     /**
      * The entity being removed from the item set.
      */

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

@@ -0,0 +1,14 @@
+import type { SyncNodeIdentityMode } from "../syncNodeIdentityMode";
+/**
+ * Request to reset the local storage.
+ */
+export interface ISyncReset {
+    /**
+     * The key of the storage for the entities in the batch.
+     */
+    storageKey: string;
+    /**
+     * Reset mode, this will use the nodeIdentity in the entities to determine which are local/remote.
+     */
+    resetMode: SyncNodeIdentityMode;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * The mode to determine how node identities are matched.
+ */
+export declare const SyncNodeIdentityMode: {
+    /**
+     * Match the local node identity.
+     */
+    readonly Local: "local";
+    /**
+     * Match all but the local node identity.
+     */
+    readonly Remote: "remote";
+    /**
+     * All match both local and remote entities.
+     */
+    readonly All: "all";
+};
+/**
+ * The mode to determine how node identities are matched.
+ */
+export type SyncNodeIdentityMode = (typeof SyncNodeIdentityMode)[keyof typeof SyncNodeIdentityMode];

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

@@ -18,6 +18,10 @@ export declare const SynchronisedStorageTopics: {
      * A response to a local item request.
      */
     readonly LocalItemResponse: "synchronised-storage:local-item-response";
+    /**
+     * Reset the storage.
+     */
+    readonly Reset: "synchronised-storage:reset";
     /**
      * A request has been made for a batch.
      */

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.0.1-next.6](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.5...synchronised-storage-models-v0.0.1-next.6) (2025-08-11)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-models:** Synchronize repo versions
+
+## [0.0.1-next.5](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.4...synchronised-storage-models-v0.0.1-next.5) (2025-08-11)
+
+
+### Features
+
+* additional node identity checks ([76257c4](https://github.com/twinfoundation/synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
+
+
+### Bug Fixes
+
+* missing dependency ([cf4427e](https://github.com/twinfoundation/synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
+
 ## [0.0.1-next.4](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.3...synchronised-storage-models-v0.0.1-next.4) (2025-08-08)
 
 

package/docs/reference/index.md

@@ -17,13 +17,16 @@
 - [ISyncItemResponse](interfaces/ISyncItemResponse.md)
 - [ISyncItemSet](interfaces/ISyncItemSet.md)
 - [ISyncRegisterStorageKey](interfaces/ISyncRegisterStorageKey.md)
+- [ISyncReset](interfaces/ISyncReset.md)
 
 ## Type Aliases
 
 - [SyncChangeOperation](type-aliases/SyncChangeOperation.md)
+- [SyncNodeIdentityMode](type-aliases/SyncNodeIdentityMode.md)
 - [SynchronisedStorageTopics](type-aliases/SynchronisedStorageTopics.md)
 
 ## Variables
 
 - [SyncChangeOperation](variables/SyncChangeOperation.md)
+- [SyncNodeIdentityMode](variables/SyncNodeIdentityMode.md)
 - [SynchronisedStorageTopics](variables/SynchronisedStorageTopics.md)

package/docs/reference/interfaces/ISyncBatchRequest.md

@@ -17,3 +17,11 @@ The key of the storage for the entities in the batch.
 > **batchSize**: `number`
 
 The size of the batch.
+
+***
+
+### requestMode
+
+> **requestMode**: [`SyncNodeIdentityMode`](../type-aliases/SyncNodeIdentityMode.md)
+
+Determines which entries are required, for local it will match the nodeIdentity, for remote it will not include matching nodeIdentity, for all it will include all entries.

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -34,9 +34,9 @@ The storage key of the change set. This is used to identify the entities being s
 
 ***
 
-### dateModified?
+### dateModified
 
-> `optional` **dateModified**: `string`
+> **dateModified**: `string`
 
 The date the change set was last modified.
 

package/docs/reference/interfaces/ISyncItemChange.md

@@ -20,6 +20,14 @@ The operation being performed on the item.
 
 ***
 
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The node performing the operation.
+
+***
+
 ### id
 
 > **id**: `string`

package/docs/reference/interfaces/ISyncItemRemove.md

@@ -12,6 +12,14 @@ The key of the storage being removed.
 
 ***
 
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The node identity of the entity being removed.
+
+***
+
 ### id
 
 > **id**: `string`

package/docs/reference/interfaces/ISyncReset.md

@@ -0,0 +1,19 @@
+# Interface: ISyncReset
+
+Request to reset the local storage.
+
+## Properties
+
+### storageKey
+
+> **storageKey**: `string`
+
+The key of the storage for the entities in the batch.
+
+***
+
+### resetMode
+
+> **resetMode**: [`SyncNodeIdentityMode`](../type-aliases/SyncNodeIdentityMode.md)
+
+Reset mode, this will use the nodeIdentity in the entities to determine which are local/remote.

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

@@ -0,0 +1,5 @@
+# Type Alias: SyncNodeIdentityMode
+
+> **SyncNodeIdentityMode** = *typeof* [`SyncNodeIdentityMode`](../variables/SyncNodeIdentityMode.md)\[keyof *typeof* [`SyncNodeIdentityMode`](../variables/SyncNodeIdentityMode.md)\]
+
+The mode to determine how node identities are matched.

package/docs/reference/variables/SyncNodeIdentityMode.md

@@ -0,0 +1,25 @@
+# Variable: SyncNodeIdentityMode
+
+> `const` **SyncNodeIdentityMode**: `object`
+
+The mode to determine how node identities are matched.
+
+## Type declaration
+
+### Local
+
+> `readonly` **Local**: `"local"` = `"local"`
+
+Match the local node identity.
+
+### Remote
+
+> `readonly` **Remote**: `"remote"` = `"remote"`
+
+Match all but the local node identity.
+
+### All
+
+> `readonly` **All**: `"all"` = `"all"`
+
+All match both local and remote entities.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -30,6 +30,12 @@ A request has been made for a local item.
 
 A response to a local item request.
 
+### Reset
+
+> `readonly` **Reset**: `"synchronised-storage:reset"` = `"synchronised-storage:reset"`
+
+Reset the storage.
+
 ### BatchRequest
 
 > `readonly` **BatchRequest**: `"synchronised-storage:batch-request"` = `"synchronised-storage:batch-request"`

package/package.json

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