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

package/dist/cjs/index.cjs

@@ -25,9 +25,9 @@ const SyncChangeOperation = {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const SynchronisedStorageTopics = {
     /**
-     * Register a schema type for the synchronised storage.
+     * Register a storage key for the synchronised storage.
      */
-    RegisterSchemaType: "synchronised-storage:register-schema-type",
+    RegisterStorageKey: "synchronised-storage:register-storage-key",
     /**
      * An item was changed in the storage by the local node.
      */

package/dist/esm/index.mjs

@@ -23,9 +23,9 @@ const SyncChangeOperation = {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const SynchronisedStorageTopics = {
     /**
-     * Register a schema type for the synchronised storage.
+     * Register a storage key for the synchronised storage.
      */
-    RegisterSchemaType: "synchronised-storage:register-schema-type",
+    RegisterStorageKey: "synchronised-storage:register-storage-key",
     /**
      * An item was changed in the storage by the local node.
      */

package/dist/types/index.d.ts

@@ -6,7 +6,7 @@ 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/ISyncRegisterStorageKey";
 export * from "./models/eventBus/syncChangeOperation";
 export * from "./models/ISynchronisedEntity";
 export * from "./models/ISynchronisedStorageComponent";

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

@@ -3,9 +3,9 @@
  */
 export interface ISyncBatchRequest {
     /**
-     * The type of the schema for the entities in the batch.
+     * The key of the storage for the entities in the batch.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The size of the batch.
      */

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

@@ -4,9 +4,9 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
  */
 export interface ISyncBatchResponse<T extends ISynchronisedEntity> {
     /**
-     * The type of the schema for the entities in the batch.
+     * The key of the storage for the entities in the batch.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The primary key of the entity in the sync item response.
      */

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

@@ -4,9 +4,9 @@ import type { SyncChangeOperation } from "./syncChangeOperation";
  */
 export interface ISyncItemChange {
     /**
-     * The type of the schema being changed.
+     * The key of the storage being changed.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The operation being performed on the item.
      */

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

@@ -3,9 +3,9 @@
  */
 export interface ISyncItemRemove {
     /**
-     * The type of the schema being removed.
+     * The key of the storage being removed.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The entity being removed from the item set.
      */

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

@@ -3,9 +3,9 @@
  */
 export interface ISyncItemRequest {
     /**
-     * The type of the schema for the entities in the batch.
+     * The key of the storage for the entities in the batch.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The item id being requested.
      */

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

@@ -4,9 +4,9 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
  */
 export interface ISyncItemResponse<T extends ISynchronisedEntity> {
     /**
-     * The type of the schema for the entities in the batch.
+     * The key of the storage for the entities in the batch.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The id of the entity in the sync item response.
      */

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

@@ -4,9 +4,9 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
  */
 export interface ISyncItemSet<T extends ISynchronisedEntity = ISynchronisedEntity> {
     /**
-     * The type of the schema being set.
+     * The key of the storage being set.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The entity being set in the item set.
      */

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

@@ -0,0 +1,9 @@
+/**
+ * Register a key with synchronised storage.
+ */
+export interface ISyncRegisterStorageKey {
+    /**
+     * The key for the storage being registered.
+     */
+    storageKey: string;
+}

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

@@ -3,9 +3,9 @@
  */
 export declare const SynchronisedStorageTopics: {
     /**
-     * Register a schema type for the synchronised storage.
+     * Register a storage key for the synchronised storage.
      */
-    readonly RegisterSchemaType: "synchronised-storage:register-schema-type";
+    readonly RegisterStorageKey: "synchronised-storage:register-storage-key";
     /**
      * An item was changed in the storage by the local node.
      */

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.1-next.3](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.2...synchronised-storage-models-v0.0.1-next.3) (2025-07-25)
+
+
+### Features
+
+* sync testing ([#5](https://github.com/twinfoundation/synchronised-storage/issues/5)) ([f78d5ac](https://github.com/twinfoundation/synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
+
 ## [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)
 
 

package/docs/reference/index.md

@@ -12,7 +12,7 @@
 - [ISyncItemRequest](interfaces/ISyncItemRequest.md)
 - [ISyncItemResponse](interfaces/ISyncItemResponse.md)
 - [ISyncItemSet](interfaces/ISyncItemSet.md)
-- [ISyncRegisterSchemaType](interfaces/ISyncRegisterSchemaType.md)
+- [ISyncRegisterStorageKey](interfaces/ISyncRegisterStorageKey.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/ISyncBatchRequest.md

@@ -4,11 +4,11 @@ Request for a local batch.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema for the entities in the batch.
+The key of the storage for the entities in the batch.
 
 ***
 

package/docs/reference/interfaces/ISyncBatchResponse.md

@@ -10,11 +10,11 @@ Response for a local batch.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema for the entities in the batch.
+The key of the storage for the entities in the batch.
 
 ***
 

package/docs/reference/interfaces/ISyncItemChange.md

@@ -4,11 +4,11 @@ The payload for an item change.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema being changed.
+The key of the storage being changed.
 
 ***
 

package/docs/reference/interfaces/ISyncItemRemove.md

@@ -4,11 +4,11 @@ The payload for an item remove.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema being removed.
+The key of the storage being removed.
 
 ***
 

package/docs/reference/interfaces/ISyncItemRequest.md

@@ -4,11 +4,11 @@ Request for a local item.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema for the entities in the batch.
+The key of the storage for the entities in the batch.
 
 ***
 

package/docs/reference/interfaces/ISyncItemResponse.md

@@ -10,11 +10,11 @@ Response for a sync item request.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema for the entities in the batch.
+The key of the storage for the entities in the batch.
 
 ***
 

package/docs/reference/interfaces/ISyncItemSet.md

@@ -10,11 +10,11 @@ The payload for an item set.
 
 ## Properties
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The type of the schema being set.
+The key of the storage being set.
 
 ***
 

package/docs/reference/interfaces/ISyncRegisterStorageKey.md

@@ -0,0 +1,11 @@
+# Interface: ISyncRegisterStorageKey
+
+Register a key with synchronised storage.
+
+## Properties
+
+### storageKey
+
+> **storageKey**: `string`
+
+The key for the storage being registered.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -6,11 +6,11 @@ The topics for synchronised storage event bus notifications.
 
 ## Type declaration
 
-### RegisterSchemaType
+### RegisterStorageKey
 
-> `readonly` **RegisterSchemaType**: `"synchronised-storage:register-schema-type"` = `"synchronised-storage:register-schema-type"`
+> `readonly` **RegisterStorageKey**: `"synchronised-storage:register-storage-key"` = `"synchronised-storage:register-storage-key"`
 
-Register a schema type for the synchronised storage.
+Register a storage key for the synchronised storage.
 
 ### LocalItemChange
 

package/package.json

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

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

@@ -1,9 +0,0 @@
-/**
- * Register a type with synchronised storage so that it can perform consolidations.
- */
-export interface ISyncRegisterSchemaType {
-    /**
-     * The type of the schema being registered.
-     */
-    schemaType: string;
-}

package/docs/reference/interfaces/ISyncRegisterSchemaType.md

@@ -1,11 +0,0 @@
-# Interface: ISyncRegisterSchemaType
-
-Register a type with synchronised storage so that it can perform consolidations.
-
-## Properties
-
-### schemaType
-
-> **schemaType**: `string`
-
-The type of the schema being registered.