@twin.org/synchronised-storage-models 0.0.3-next.8 → 0.9.0-next.1

package/docs/examples.md

@@ -1 +1,61 @@
-# @twin.org/synchronised-storage-models - Examples
+# Synchronised Storage Models Examples
+
+Use these model-focused snippets to define strongly typed payloads for synchronisation requests, changes, and event bus workflows.
+
+## Model Contracts
+
+```typescript
+import {
+  SynchronisedStorageContexts,
+  SynchronisedStorageTypes,
+  SyncChangeOperation,
+  type ISyncChangeSet
+} from '@twin.org/synchronised-storage-models';
+
+const syncChangeSet: ISyncChangeSet = {
+  '@context': SynchronisedStorageContexts.Context,
+  type: SynchronisedStorageTypes.ChangeSet,
+  id: 'changeset-001',
+  storageKey: 'profile',
+  dateCreated: '2026-03-10T11:00:00.000Z',
+  dateModified: '2026-03-10T11:00:00.000Z',
+  nodeIdentity: 'did:iota:node-1',
+  changes: [
+    {
+      operation: SyncChangeOperation.Set,
+      id: 'profile-42',
+      entity: {
+        dateModified: '2026-03-10T11:00:00.000Z'
+      }
+    }
+  ]
+};
+
+console.log(syncChangeSet.changes[0].operation); // set
+```
+
+```typescript
+import {
+  SyncNodeIdMode,
+  SynchronisedStorageTopics,
+  type ISynchronisedEntity
+} from '@twin.org/synchronised-storage-models';
+
+interface IProfileEntity extends ISynchronisedEntity {
+  displayName: string;
+}
+
+const entity: IProfileEntity = {
+  id: 'profile-42',
+  nodeIdentity: 'did:iota:node-1',
+  dateModified: '2026-03-10T11:05:00.000Z',
+  displayName: 'Rowan'
+};
+
+const topic = SynchronisedStorageTopics.LocalItemChange;
+const mode = SyncNodeIdMode.Remote;
+
+console.log(entity.id); // profile-42
+console.log(topic); // synchronised-storage:local-item-change
+console.log(mode); // remote
+```

package/docs/reference/index.md

@@ -25,7 +25,6 @@
 
 - [SyncChangeOperation](type-aliases/SyncChangeOperation.md)
 - [SyncNodeIdMode](type-aliases/SyncNodeIdMode.md)
-- [SynchronisedStorageAssetTypes](type-aliases/SynchronisedStorageAssetTypes.md)
 - [SynchronisedStorageContexts](type-aliases/SynchronisedStorageContexts.md)
 - [SynchronisedStorageTopics](type-aliases/SynchronisedStorageTopics.md)
 - [SynchronisedStorageTypes](type-aliases/SynchronisedStorageTypes.md)
@@ -34,7 +33,6 @@
 
 - [SyncChangeOperation](variables/SyncChangeOperation.md)
 - [SyncNodeIdMode](variables/SyncNodeIdMode.md)
-- [SynchronisedStorageAssetTypes](variables/SynchronisedStorageAssetTypes.md)
 - [SynchronisedStorageContexts](variables/SynchronisedStorageContexts.md)
 - [SynchronisedStorageTopics](variables/SynchronisedStorageTopics.md)
 - [SynchronisedStorageTypes](variables/SynchronisedStorageTypes.md)

package/docs/reference/interfaces/ISyncBatchRequest.md

@@ -4,7 +4,7 @@ Request for a local batch.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage for the entities in the batch.
 
 ***
 
-### batchSize
+### batchSize {#batchsize}
 
 > **batchSize**: `number`
 
@@ -20,7 +20,7 @@ The size of the batch.
 
 ***
 
-### requestMode
+### requestMode {#requestmode}
 
 > **requestMode**: [`SyncNodeIdMode`](../type-aliases/SyncNodeIdMode.md)
 

package/docs/reference/interfaces/ISyncBatchResponse.md

@@ -4,7 +4,7 @@ Response for a local batch.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage for the entities in the batch.
 
 ***
 
-### entities
+### entities {#entities}
 
 > **entities**: [`ISynchronisedEntity`](ISynchronisedEntity.md)[]
 
@@ -20,7 +20,7 @@ The entities in the batch.
 
 ***
 
-### lastEntry
+### lastEntry {#lastentry}
 
 > **lastEntry**: `boolean`
 

package/docs/reference/interfaces/ISyncChange.md

@@ -4,16 +4,15 @@ The object definition for a sync change.
 
 ## Properties
 
-### operation
+### operation {#operation}
 
 > **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
 
 Operation.
-json-ld type:schema:Text
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -21,9 +20,8 @@ The item id.
 
 ***
 
-### entity?
+### entity? {#entity}
 
-> `optional` **entity**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
+> `optional` **entity?**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
 
 The entity to set.
-json-ld type:json

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -4,7 +4,7 @@ The object definition for a sync change set.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: `"https://schema.twindev.org/synchronised-storage/"`
 
@@ -12,7 +12,7 @@ The LD Context for the change set.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"ChangeSet"`
 
@@ -20,7 +20,7 @@ The LD Type for the change set.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -28,45 +28,40 @@ The id of the change set.
 
 ***
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
 The storage key of the change set. This is used to identify the entities being synchronised.
-json-ld type:schema:identifier
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date the change set was created.
-json-ld namespace:schema
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
 The date the change set was last modified.
-json-ld namespace:schema
 
 ***
 
-### nodeIdentity
+### nodeIdentity {#nodeidentity}
 
 > **nodeIdentity**: `string`
 
 The identity of the node that created the change set.
-json-ld namespace:twin-common
 
 ***
 
-### changes
+### changes {#changes}
 
 > **changes**: [`ISyncChange`](ISyncChange.md)[]
 
 The changes to apply after a snapshot.
-json-ld type:json

package/docs/reference/interfaces/ISyncChangeSetRequest.md

@@ -4,23 +4,23 @@ Request a trusted node to perform a sync request for a changeset.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
 #### accept?
 
-> `optional` **accept**: `"application/ld+json"` \| `"application/json"`
+> `optional` **accept?**: `"application/ld+json"` \| `"application/json"`
 
 #### authorization?
 
-> `optional` **authorization**: `string`
+> `optional` **authorization?**: `string`
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`ISyncChangeSet`](ISyncChangeSet.md)
 

package/docs/reference/interfaces/ISyncDecryptionKeyRequest.md

@@ -4,16 +4,16 @@ Request for the decryption key for the synchronised storage.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
 #### accept?
 
-> `optional` **accept**: `"application/ld+json"` \| `"application/json"`
+> `optional` **accept?**: `"application/ld+json"` \| `"application/json"`
 
 #### authorization?
 
-> `optional` **authorization**: `string`
+> `optional` **authorization?**: `string`

package/docs/reference/interfaces/ISyncDecryptionKeyResponse.md

@@ -4,7 +4,7 @@ Response to a request for the decryption key for the synchronised storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 

package/docs/reference/interfaces/ISyncItemChange.md

@@ -4,7 +4,7 @@ The payload for an item change.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage being changed.
 
 ***
 
-### operation
+### operation {#operation}
 
 > **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
 
@@ -20,7 +20,7 @@ The operation being performed on the item.
 
 ***
 
-### nodeId
+### nodeId {#nodeid}
 
 > **nodeId**: `string`
 
@@ -28,7 +28,7 @@ The node performing the operation.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/ISyncItemRemove.md

@@ -4,7 +4,7 @@ The payload for an item remove.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage being removed.
 
 ***
 
-### nodeId
+### nodeId {#nodeid}
 
 > **nodeId**: `string`
 
@@ -20,7 +20,7 @@ The node identity of the entity being removed.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/ISyncItemRequest.md

@@ -4,15 +4,15 @@ Request for a local item.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
-The key of the storage for the entities in the batch.
+The key of the storage containing the requested item.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/ISyncItemResponse.md

@@ -4,15 +4,15 @@ Response for a sync item request.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
-The key of the storage for the entities in the batch.
+The key of the storage containing the responding item.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -20,8 +20,8 @@ The id of the entity in the sync item response.
 
 ***
 
-### entity?
+### entity? {#entity}
 
-> `optional` **entity**: [`ISynchronisedEntity`](ISynchronisedEntity.md)
+> `optional` **entity?**: [`ISynchronisedEntity`](ISynchronisedEntity.md)
 
 The entity in the sync item response, undefined if not found.

package/docs/reference/interfaces/ISyncItemSet.md

@@ -4,7 +4,7 @@ The payload for an item set.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage being set.
 
 ***
 
-### entity
+### entity {#entity}
 
 > **entity**: [`ISynchronisedEntity`](ISynchronisedEntity.md)
 

package/docs/reference/interfaces/ISyncRegisterStorageKey.md

@@ -4,7 +4,7 @@ Register a key with synchronised storage.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 

package/docs/reference/interfaces/ISyncRequest.md

@@ -4,7 +4,7 @@ The object definition for a sync request.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: `"https://schema.twindev.org/synchronised-storage/"`
 
@@ -12,7 +12,7 @@ The LD Context for the request.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"SyncRequest"`
 
@@ -20,9 +20,8 @@ The LD Type for the request.
 
 ***
 
-### nodeIdentity
+### nodeIdentity {#nodeidentity}
 
 > **nodeIdentity**: `string`
 
 The identity of the node that created the request.
-json-ld namespace:twin-common

package/docs/reference/interfaces/ISyncReset.md

@@ -4,15 +4,15 @@ Request to reset the local storage.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
-The key of the storage for the entities in the batch.
+The key of the storage to reset.
 
 ***
 
-### resetMode
+### resetMode {#resetmode}
 
 > **resetMode**: [`SyncNodeIdMode`](../type-aliases/SyncNodeIdMode.md)
 

package/docs/reference/interfaces/ISynchronisedEntity.md

@@ -8,7 +8,7 @@ The base definition for synchronised entries.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -16,21 +16,19 @@ The id of the entry.
 
 ***
 
-### nodeIdentity
+### nodeIdentity {#nodeidentity}
 
 > **nodeIdentity**: `string`
 
 The identity of the node that owns the entry.
-json-ld namespace:twin-common
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
 The date the entry was modified.
-json-ld namespace:schema
 
 #### Inherited from
 

package/docs/reference/interfaces/ISynchronisedEntityCore.md

@@ -8,9 +8,8 @@ The base definition for synchronised entries.
 
 ## Properties
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
 The date the entry was modified.
-json-ld namespace:schema

package/docs/reference/interfaces/ISynchronisedStorageComponent.md

@@ -8,7 +8,7 @@ Class for performing synchronised storage operations.
 
 ## Methods
 
-### getDecryptionKey()
+### getDecryptionKey() {#getdecryptionkey}
 
 > **getDecryptionKey**(`trustPayload`): `Promise`\<`string`\>
 
@@ -31,7 +31,7 @@ The decryption key.
 
 ***
 
-### syncChangeSet()
+### syncChangeSet() {#syncchangeset}
 
 > **syncChangeSet**(`syncChangeSet`, `trustPayload`): `Promise`\<`void`\>
 
@@ -55,4 +55,4 @@ Trust payload to verify the requesters identity.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the change set has been applied and stored.

package/docs/reference/variables/SyncChangeOperation.md

@@ -6,13 +6,13 @@ The operations for a change.
 
 ## Type Declaration
 
-### Set
+### Set {#set}
 
 > `readonly` **Set**: `"set"` = `"set"`
 
 An item was set in the storage.
 
-### Delete
+### Delete {#delete}
 
 > `readonly` **Delete**: `"delete"` = `"delete"`
 

package/docs/reference/variables/SyncNodeIdMode.md

@@ -6,19 +6,19 @@ The mode to determine how node identities are matched.
 
 ## Type Declaration
 
-### Local
+### Local {#local}
 
 > `readonly` **Local**: `"local"` = `"local"`
 
 Match the local node identity.
 
-### Remote
+### Remote {#remote}
 
 > `readonly` **Remote**: `"remote"` = `"remote"`
 
 Match all but the local node identity.
 
-### All
+### All {#all}
 
 > `readonly` **All**: `"all"` = `"all"`
 

package/docs/reference/variables/SynchronisedStorageContexts.md

@@ -6,19 +6,19 @@ The Contexts concerning Synchronised Storage.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/synchronised-storage/"` = `"https://schema.twindev.org/synchronised-storage/"`
 
 The canonical RDF namespace URI for Synchronised Storage.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/synchronised-storage/"` = `"https://schema.twindev.org/synchronised-storage/"`
 
 The value to use in context for Synchronised Storage.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/synchronised-storage/types.jsonld"` = `"https://schema.twindev.org/synchronised-storage/types.jsonld"`