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

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Synchronised Storage Models
+# Synchronised Storage Models
 
-Models which define the structure of the synchronised-storage contracts and connectors.
+This package defines the shared contracts for synchronised storage payloads, topics, and schema-aligned model structures. It is intended to keep producers and consumers aligned on message shape and semantics when exchanging state updates.
 
 ## Installation
 

package/dist/es/index.js

@@ -19,7 +19,6 @@ export * from "./models/ISynchronisedEntityCore.js";
 export * from "./models/ISynchronisedStorageComponent.js";
 export * from "./models/ISyncRequest.js";
 export * from "./models/syncChangeOperation.js";
-export * from "./models/synchronisedStorageAssetTypes.js";
 export * from "./models/synchronisedStorageContexts.js";
 export * from "./models/synchronisedStorageTopics.js";
 export * from "./models/synchronisedStorageTypes.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,uCAAuC,CAAC;AACtD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/api/ISyncChangeSetRequest.js\";\nexport * from \"./models/api/ISyncDecryptionKeyRequest.js\";\nexport * from \"./models/api/ISyncDecryptionKeyResponse.js\";\nexport * from \"./models/eventBus/ISyncBatchRequest.js\";\nexport * from \"./models/eventBus/ISyncBatchResponse.js\";\nexport * from \"./models/eventBus/ISyncItemChange.js\";\nexport * from \"./models/eventBus/ISyncItemRemove.js\";\nexport * from \"./models/eventBus/ISyncItemRequest.js\";\nexport * from \"./models/eventBus/ISyncItemResponse.js\";\nexport * from \"./models/eventBus/ISyncItemSet.js\";\nexport * from \"./models/eventBus/ISyncRegisterStorageKey.js\";\nexport * from \"./models/eventBus/ISyncReset.js\";\nexport * from \"./models/ISyncChange.js\";\nexport * from \"./models/ISyncChangeSet.js\";\nexport * from \"./models/ISynchronisedEntity.js\";\nexport * from \"./models/ISynchronisedEntityCore.js\";\nexport * from \"./models/ISynchronisedStorageComponent.js\";\nexport * from \"./models/ISyncRequest.js\";\nexport * from \"./models/syncChangeOperation.js\";\nexport * from \"./models/synchronisedStorageAssetTypes.js\";\nexport * from \"./models/synchronisedStorageContexts.js\";\nexport * from \"./models/synchronisedStorageTopics.js\";\nexport * from \"./models/synchronisedStorageTypes.js\";\nexport * from \"./models/syncNodeIdMode.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,uCAAuC,CAAC;AACtD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/api/ISyncChangeSetRequest.js\";\nexport * from \"./models/api/ISyncDecryptionKeyRequest.js\";\nexport * from \"./models/api/ISyncDecryptionKeyResponse.js\";\nexport * from \"./models/eventBus/ISyncBatchRequest.js\";\nexport * from \"./models/eventBus/ISyncBatchResponse.js\";\nexport * from \"./models/eventBus/ISyncItemChange.js\";\nexport * from \"./models/eventBus/ISyncItemRemove.js\";\nexport * from \"./models/eventBus/ISyncItemRequest.js\";\nexport * from \"./models/eventBus/ISyncItemResponse.js\";\nexport * from \"./models/eventBus/ISyncItemSet.js\";\nexport * from \"./models/eventBus/ISyncRegisterStorageKey.js\";\nexport * from \"./models/eventBus/ISyncReset.js\";\nexport * from \"./models/ISyncChange.js\";\nexport * from \"./models/ISyncChangeSet.js\";\nexport * from \"./models/ISynchronisedEntity.js\";\nexport * from \"./models/ISynchronisedEntityCore.js\";\nexport * from \"./models/ISynchronisedStorageComponent.js\";\nexport * from \"./models/ISyncRequest.js\";\nexport * from \"./models/syncChangeOperation.js\";\nexport * from \"./models/synchronisedStorageContexts.js\";\nexport * from \"./models/synchronisedStorageTopics.js\";\nexport * from \"./models/synchronisedStorageTypes.js\";\nexport * from \"./models/syncNodeIdMode.js\";\n"]}

package/dist/es/models/ISyncChange.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISyncChange.js","sourceRoot":"","sources":["../../../src/models/ISyncChange.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntityCore } from \"./ISynchronisedEntityCore.js\";\nimport type { SyncChangeOperation } from \"./syncChangeOperation.js\";\n\n/**\n * The object definition for a sync change.\n */\nexport interface ISyncChange {\n\t/**\n\t * Operation.\n\t */\n\toperation: SyncChangeOperation;\n\n\t/**\n\t * The item id.\n\t */\n\tid: string;\n\n\t/**\n\t * The entity to set.\n\t */\n\tentity?: ISynchronisedEntityCore;\n}\n"]}
+{"version":3,"file":"ISyncChange.js","sourceRoot":"","sources":["../../../src/models/ISyncChange.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntityCore } from \"./ISynchronisedEntityCore.js\";\nimport type { SyncChangeOperation } from \"./syncChangeOperation.js\";\n\n/**\n * The object definition for a sync change.\n */\nexport interface ISyncChange {\n\t/**\n\t * Operation.\n\t * @json-ld type:schema:Text\n\t */\n\toperation: SyncChangeOperation;\n\n\t/**\n\t * The item id.\n\t */\n\tid: string;\n\n\t/**\n\t * The entity to set.\n\t * @json-ld type:json\n\t */\n\tentity?: ISynchronisedEntityCore;\n}\n"]}

package/dist/es/models/ISyncChangeSet.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISyncChangeSet.js","sourceRoot":"","sources":["../../../src/models/ISyncChangeSet.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISyncChange } from \"./ISyncChange.js\";\nimport type { SynchronisedStorageContexts } from \"./synchronisedStorageContexts.js\";\nimport type { SynchronisedStorageTypes } from \"./synchronisedStorageTypes.js\";\n\n/**\n * The object definition for a sync change set.\n */\nexport interface ISyncChangeSet {\n\t/**\n\t * The LD Context for the change set.\n\t */\n\t\"@context\": typeof SynchronisedStorageContexts.ContextRoot;\n\n\t/**\n\t * The LD Type for the change set.\n\t */\n\ttype: typeof SynchronisedStorageTypes.ChangeSet;\n\n\t/**\n\t * The id of the change set.\n\t */\n\tid: string;\n\n\t/**\n\t * The storage key of the change set. This is used to identify the entities being synchronised.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The date the change set was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the change set was last modified.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * The identity of the node that created the change set.\n\t */\n\tnodeId: string;\n\n\t/**\n\t * The changes to apply after a snapshot.\n\t */\n\tchanges: ISyncChange[];\n}\n"]}
+{"version":3,"file":"ISyncChangeSet.js","sourceRoot":"","sources":["../../../src/models/ISyncChangeSet.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISyncChange } from \"./ISyncChange.js\";\nimport type { SynchronisedStorageContexts } from \"./synchronisedStorageContexts.js\";\nimport type { SynchronisedStorageTypes } from \"./synchronisedStorageTypes.js\";\n\n/**\n * The object definition for a sync change set.\n */\nexport interface ISyncChangeSet {\n\t/**\n\t * The LD Context for the change set.\n\t */\n\t\"@context\": typeof SynchronisedStorageContexts.Context;\n\n\t/**\n\t * The LD Type for the change set.\n\t */\n\ttype: typeof SynchronisedStorageTypes.ChangeSet;\n\n\t/**\n\t * The id of the change set.\n\t */\n\tid: string;\n\n\t/**\n\t * The storage key of the change set. This is used to identify the entities being synchronised.\n\t * @json-ld type:schema:identifier\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The date the change set was created.\n\t * @json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the change set was last modified.\n\t * @json-ld namespace:schema\n\t */\n\tdateModified: string;\n\n\t/**\n\t * The identity of the node that created the change set.\n\t * @json-ld namespace:twin-common\n\t */\n\tnodeIdentity: string;\n\n\t/**\n\t * The changes to apply after a snapshot.\n\t * @json-ld type:json\n\t */\n\tchanges: ISyncChange[];\n}\n"]}

package/dist/es/models/ISyncRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISyncRequest.js","sourceRoot":"","sources":["../../../src/models/ISyncRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SynchronisedStorageContexts } from \"./synchronisedStorageContexts.js\";\nimport type { SynchronisedStorageTypes } from \"./synchronisedStorageTypes.js\";\n\n/**\n * The object definition for a sync request.\n */\nexport interface ISyncRequest {\n\t/**\n\t * The LD Context for the request.\n\t */\n\t\"@context\": typeof SynchronisedStorageContexts.ContextRoot;\n\n\t/**\n\t * The LD Type for the request.\n\t */\n\ttype: typeof SynchronisedStorageTypes.SyncRequest;\n\n\t/**\n\t * The identity of the node that created the request.\n\t */\n\tnodeId: string;\n}\n"]}
+{"version":3,"file":"ISyncRequest.js","sourceRoot":"","sources":["../../../src/models/ISyncRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SynchronisedStorageContexts } from \"./synchronisedStorageContexts.js\";\nimport type { SynchronisedStorageTypes } from \"./synchronisedStorageTypes.js\";\n\n/**\n * The object definition for a sync request.\n */\nexport interface ISyncRequest {\n\t/**\n\t * The LD Context for the request.\n\t */\n\t\"@context\": typeof SynchronisedStorageContexts.Context;\n\n\t/**\n\t * The LD Type for the request.\n\t */\n\ttype: typeof SynchronisedStorageTypes.SyncRequest;\n\n\t/**\n\t * The identity of the node that created the request.\n\t * @json-ld namespace:twin-common\n\t */\n\tnodeIdentity: string;\n}\n"]}

package/dist/es/models/ISynchronisedEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISynchronisedEntity.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedEntity.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntityCore } from \"./ISynchronisedEntityCore.js\";\n\n/**\n * The base definition for synchronised entries.\n */\nexport interface ISynchronisedEntity extends ISynchronisedEntityCore {\n\t/**\n\t * The id of the entry.\n\t */\n\tid: string;\n\n\t/**\n\t * The identity of the node that owns the entry.\n\t */\n\tnodeId?: string;\n}\n"]}
+{"version":3,"file":"ISynchronisedEntity.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedEntity.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntityCore } from \"./ISynchronisedEntityCore.js\";\n\n/**\n * The base definition for synchronised entries.\n */\nexport interface ISynchronisedEntity extends ISynchronisedEntityCore {\n\t/**\n\t * The id of the entry.\n\t */\n\tid: string;\n\n\t/**\n\t * The identity of the node that owns the entry.\n\t * @json-ld namespace:twin-common\n\t */\n\tnodeIdentity: string;\n}\n"]}

package/dist/es/models/ISynchronisedEntityCore.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISynchronisedEntityCore.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedEntityCore.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The base definition for synchronised entries.\n */\nexport interface ISynchronisedEntityCore {\n\t/**\n\t * The date the entry was modified.\n\t */\n\tdateModified: string;\n}\n"]}
+{"version":3,"file":"ISynchronisedEntityCore.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedEntityCore.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The base definition for synchronised entries.\n */\nexport interface ISynchronisedEntityCore {\n\t/**\n\t * The date the entry was modified.\n\t * @json-ld namespace:schema\n\t */\n\tdateModified: string;\n}\n"]}

package/dist/es/models/ISynchronisedStorageComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISynchronisedStorageComponent.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IIdentityAuthenticationActionRequest } from \"@twin.org/identity-authentication\";\nimport type { ISyncChangeSet } from \"./ISyncChangeSet.js\";\n\n/**\n * Class for performing synchronised storage operations.\n */\nexport interface ISynchronisedStorageComponent extends IComponent {\n\t/**\n\t * Get the decryption key for the synchronised storage.\n\t * This is used to decrypt the data stored in the synchronised storage.\n\t * @param actionRequest The action request used in the verifiable credential.\n\t * @returns The decryption key.\n\t */\n\tgetDecryptionKey(actionRequest: IIdentityAuthenticationActionRequest): Promise<string>;\n\n\t/**\n\t * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.\n\t * @param syncChangeSet The change set to synchronise.\n\t * @param actionRequest The action request used in the verifiable credential.\n\t * @returns Nothing.\n\t */\n\tsyncChangeSet(\n\t\tsyncChangeSet: ISyncChangeSet,\n\t\tactionRequest: IIdentityAuthenticationActionRequest\n\t): Promise<void>;\n}\n"]}
+{"version":3,"file":"ISynchronisedStorageComponent.js","sourceRoot":"","sources":["../../../src/models/ISynchronisedStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ISyncChangeSet } from \"./ISyncChangeSet.js\";\n\n/**\n * Class for performing synchronised storage operations.\n */\nexport interface ISynchronisedStorageComponent extends IComponent {\n\t/**\n\t * Get the decryption key for the synchronised storage.\n\t * This is used to decrypt the data stored in the synchronised storage.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The decryption key.\n\t */\n\tgetDecryptionKey(trustPayload: unknown): Promise<string>;\n\n\t/**\n\t * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.\n\t * @param syncChangeSet The change set to synchronise.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns Nothing.\n\t */\n\tsyncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;\n}\n"]}

package/dist/es/models/synchronisedStorageContexts.js

@@ -1,13 +1,21 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The LD Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const SynchronisedStorageContexts = {
     /**
-     * The SynchronisedStorage LD Context.
+     * The canonical RDF namespace URI for Synchronised Storage.
      */
-    ContextRoot: "https://schema.twindev.org/synchronised-storage"
+    Namespace: "https://schema.twindev.org/synchronised-storage/",
+    /**
+     * The value to use in context for Synchronised Storage.
+     */
+    Context: "https://schema.twindev.org/synchronised-storage/",
+    /**
+     * The JSON-LD Context URL for Synchronised Storage.
+     */
+    JsonLdContext: "https://schema.twindev.org/synchronised-storage/types.jsonld"
 };
 //# sourceMappingURL=synchronisedStorageContexts.js.map

package/dist/es/models/synchronisedStorageContexts.js.map

@@ -1 +1 @@
-{"version":3,"file":"synchronisedStorageContexts.js","sourceRoot":"","sources":["../../../src/models/synchronisedStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,WAAW,EAAE,iDAAiD;CACrD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The LD Contexts concerning SynchronisedStorage.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SynchronisedStorageContexts = {\n\t/**\n\t * The SynchronisedStorage LD Context.\n\t */\n\tContextRoot: \"https://schema.twindev.org/synchronised-storage\"\n} as const;\n\n/**\n * The LD Contexts concerning SynchronisedStorage.\n */\nexport type SynchronisedStorageContexts =\n\t(typeof SynchronisedStorageContexts)[keyof typeof SynchronisedStorageContexts];\n"]}
+{"version":3,"file":"synchronisedStorageContexts.js","sourceRoot":"","sources":["../../../src/models/synchronisedStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,kDAAkD;IAE7D;;OAEG;IACH,OAAO,EAAE,kDAAkD;IAE3D;;OAEG;IACH,aAAa,EAAE,8DAA8D;CACpE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Contexts concerning Synchronised Storage.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SynchronisedStorageContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Synchronised Storage.\n\t */\n\tNamespace: \"https://schema.twindev.org/synchronised-storage/\",\n\n\t/**\n\t * The value to use in context for Synchronised Storage.\n\t */\n\tContext: \"https://schema.twindev.org/synchronised-storage/\",\n\n\t/**\n\t * The JSON-LD Context URL for Synchronised Storage.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/synchronised-storage/types.jsonld\"\n} as const;\n\n/**\n * The Contexts concerning Synchronised Storage.\n */\nexport type SynchronisedStorageContexts =\n\t(typeof SynchronisedStorageContexts)[keyof typeof SynchronisedStorageContexts];\n"]}

package/dist/types/index.d.ts

@@ -17,7 +17,6 @@ export * from "./models/ISynchronisedEntityCore.js";
 export * from "./models/ISynchronisedStorageComponent.js";
 export * from "./models/ISyncRequest.js";
 export * from "./models/syncChangeOperation.js";
-export * from "./models/synchronisedStorageAssetTypes.js";
 export * from "./models/synchronisedStorageContexts.js";
 export * from "./models/synchronisedStorageTopics.js";
 export * from "./models/synchronisedStorageTypes.js";

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

@@ -6,6 +6,7 @@ import type { SyncChangeOperation } from "./syncChangeOperation.js";
 export interface ISyncChange {
     /**
      * Operation.
+     * @json-ld type:schema:Text
      */
     operation: SyncChangeOperation;
     /**
@@ -14,6 +15,7 @@ export interface ISyncChange {
     id: string;
     /**
      * The entity to set.
+     * @json-ld type:json
      */
     entity?: ISynchronisedEntityCore;
 }

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

@@ -8,7 +8,7 @@ export interface ISyncChangeSet {
     /**
      * The LD Context for the change set.
      */
-    "@context": typeof SynchronisedStorageContexts.ContextRoot;
+    "@context": typeof SynchronisedStorageContexts.Context;
     /**
      * The LD Type for the change set.
      */
@@ -19,22 +19,27 @@ export interface ISyncChangeSet {
     id: string;
     /**
      * The storage key of the change set. This is used to identify the entities being synchronised.
+     * @json-ld type:schema:identifier
      */
     storageKey: string;
     /**
      * The date the change set was created.
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The date the change set was last modified.
+     * @json-ld namespace:schema
      */
     dateModified: string;
     /**
      * The identity of the node that created the change set.
+     * @json-ld namespace:twin-common
      */
-    nodeId: string;
+    nodeIdentity: string;
     /**
      * The changes to apply after a snapshot.
+     * @json-ld type:json
      */
     changes: ISyncChange[];
 }

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

@@ -7,13 +7,14 @@ export interface ISyncRequest {
     /**
      * The LD Context for the request.
      */
-    "@context": typeof SynchronisedStorageContexts.ContextRoot;
+    "@context": typeof SynchronisedStorageContexts.Context;
     /**
      * The LD Type for the request.
      */
     type: typeof SynchronisedStorageTypes.SyncRequest;
     /**
      * The identity of the node that created the request.
+     * @json-ld namespace:twin-common
      */
-    nodeId: string;
+    nodeIdentity: string;
 }

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

@@ -9,6 +9,7 @@ export interface ISynchronisedEntity extends ISynchronisedEntityCore {
     id: string;
     /**
      * The identity of the node that owns the entry.
+     * @json-ld namespace:twin-common
      */
-    nodeId?: string;
+    nodeIdentity: string;
 }

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

@@ -4,6 +4,7 @@
 export interface ISynchronisedEntityCore {
     /**
      * The date the entry was modified.
+     * @json-ld namespace:schema
      */
     dateModified: string;
 }

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

@@ -1,5 +1,4 @@
 import type { IComponent } from "@twin.org/core";
-import type { IIdentityAuthenticationActionRequest } from "@twin.org/identity-authentication";
 import type { ISyncChangeSet } from "./ISyncChangeSet.js";
 /**
  * Class for performing synchronised storage operations.
@@ -8,15 +7,15 @@ export interface ISynchronisedStorageComponent extends IComponent {
     /**
      * Get the decryption key for the synchronised storage.
      * This is used to decrypt the data stored in the synchronised storage.
-     * @param actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns The decryption key.
      */
-    getDecryptionKey(actionRequest: IIdentityAuthenticationActionRequest): Promise<string>;
+    getDecryptionKey(trustPayload: unknown): Promise<string>;
     /**
      * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
      * @param syncChangeSet The change set to synchronise.
-     * @param actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns Nothing.
      */
-    syncChangeSet(syncChangeSet: ISyncChangeSet, actionRequest: IIdentityAuthenticationActionRequest): Promise<void>;
+    syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
 }

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

@@ -1,13 +1,21 @@
 /**
- * The LD Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 export declare const SynchronisedStorageContexts: {
     /**
-     * The SynchronisedStorage LD Context.
+     * The canonical RDF namespace URI for Synchronised Storage.
      */
-    readonly ContextRoot: "https://schema.twindev.org/synchronised-storage";
+    readonly Namespace: "https://schema.twindev.org/synchronised-storage/";
+    /**
+     * The value to use in context for Synchronised Storage.
+     */
+    readonly Context: "https://schema.twindev.org/synchronised-storage/";
+    /**
+     * The JSON-LD Context URL for Synchronised Storage.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/synchronised-storage/types.jsonld";
 };
 /**
- * The LD Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 export type SynchronisedStorageContexts = (typeof SynchronisedStorageContexts)[keyof typeof SynchronisedStorageContexts];

package/docs/changelog.md

@@ -1,5 +1,76 @@
 # Changelog
 
+## [0.0.3-next.11](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.10...synchronised-storage-models-v0.0.3-next.11) (2026-04-10)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.9...synchronised-storage-models-v0.0.3-next.10) (2026-03-20)
+
+
+### Bug Fixes
+
+* remove redundant code ([19edb23](https://github.com/twinfoundation/synchronised-storage/commit/19edb236f318b9c9454a64259d0ab5098a0c8173))
+
+## [0.0.3-next.9](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.8...synchronised-storage-models-v0.0.3-next.9) (2026-03-04)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.7...synchronised-storage-models-v0.0.3-next.8) (2026-02-25)
+
+
+### Features
+
+* add ts-to-jsonld-context tool ([16d7677](https://github.com/twinfoundation/synchronised-storage/commit/16d76776e7e3f75e6c4fb9f88cb32fed2967c4b6))
+* update schemas ([7566c48](https://github.com/twinfoundation/synchronised-storage/commit/7566c4860baad5ead4327ac19cb5b647e63f2ca3))
+
+## [0.0.3-next.7](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.6...synchronised-storage-models-v0.0.3-next.7) (2026-01-28)
+
+
+### Features
+
+* json ld contexts ([#36](https://github.com/twinfoundation/synchronised-storage/issues/36)) ([3a87a9f](https://github.com/twinfoundation/synchronised-storage/commit/3a87a9fb16d21baf672e44b4e8914cf1937b1d6a))
+
+## [0.0.3-next.6](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.5...synchronised-storage-models-v0.0.3-next.6) (2026-01-22)
+
+
+### Features
+
+* update contexts ([#34](https://github.com/twinfoundation/synchronised-storage/issues/34)) ([7be9caf](https://github.com/twinfoundation/synchronised-storage/commit/7be9caf3da63f8afefd625650150bed171a1d045))
+
+## [0.0.3-next.5](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.4...synchronised-storage-models-v0.0.3-next.5) (2026-01-19)
+
+
+### Features
+
+* remove unused dependencies ([518c460](https://github.com/twinfoundation/synchronised-storage/commit/518c460d2e5e2b2c487565acb5162a03ddb85eae))
+
+## [0.0.3-next.4](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.3...synchronised-storage-models-v0.0.3-next.4) (2026-01-15)
+
+
+### Features
+
+* update contexts and namespaces ([#31](https://github.com/twinfoundation/synchronised-storage/issues/31)) ([b31c8fa](https://github.com/twinfoundation/synchronised-storage/commit/b31c8fabb8431a230415aaa2caa47fb021489d3a))
+
+## [0.0.3-next.3](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.2...synchronised-storage-models-v0.0.3-next.3) (2026-01-12)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.2](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.1...synchronised-storage-models-v0.0.3-next.2) (2025-12-04)
+
+
+### Features
+
+* use trust component ([424f0d6](https://github.com/twinfoundation/synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
+
 ## [0.0.3-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.0...synchronised-storage-models-v0.0.3-next.1) (2025-11-12)
 
 
@@ -141,4 +212,4 @@
 
 * initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
 
-## @twin.org/synchronised-storage-models - Changelog
+## Changelog

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,7 +4,7 @@ The object definition for a sync change.
 
 ## Properties
 
-### operation
+### operation {#operation}
 
 > **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
 
@@ -12,7 +12,7 @@ Operation.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -20,8 +20,8 @@ The item id.
 
 ***
 
-### entity?
+### entity? {#entity}
 
-> `optional` **entity**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
+> `optional` **entity?**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
 
 The entity to set.

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -4,15 +4,15 @@ The object definition for a sync change set.
 
 ## Properties
 
-### @context
+### @context {#context}
 
-> **@context**: `"https://schema.twindev.org/synchronised-storage"`
+> **@context**: `"https://schema.twindev.org/synchronised-storage/"`
 
 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,7 +28,7 @@ The id of the change set.
 
 ***
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -36,7 +36,7 @@ The storage key of the change set. This is used to identify the entities being s
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -44,7 +44,7 @@ The date the change set was created.
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
@@ -52,15 +52,15 @@ The date the change set was last modified.
 
 ***
 
-### nodeId
+### nodeIdentity {#nodeidentity}
 
-> **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that created the change set.
 
 ***
 
-### changes
+### changes {#changes}
 
 > **changes**: [`ISyncChange`](ISyncChange.md)[]
 

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,7 +4,7 @@ Request for a local item.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage for the entities in the batch.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/ISyncItemResponse.md

@@ -4,7 +4,7 @@ Response for a sync item request.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage for the entities in the batch.
 
 ***
 
-### 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,15 +4,15 @@ The object definition for a sync request.
 
 ## Properties
 
-### @context
+### @context {#context}
 
-> **@context**: `"https://schema.twindev.org/synchronised-storage"`
+> **@context**: `"https://schema.twindev.org/synchronised-storage/"`
 
 The LD Context for the request.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"SyncRequest"`
 
@@ -20,8 +20,8 @@ The LD Type for the request.
 
 ***
 
-### nodeId
+### nodeIdentity {#nodeidentity}
 
-> **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that created the request.

package/docs/reference/interfaces/ISyncReset.md

@@ -4,7 +4,7 @@ Request to reset the local storage.
 
 ## Properties
 
-### storageKey
+### storageKey {#storagekey}
 
 > **storageKey**: `string`
 
@@ -12,7 +12,7 @@ The key of the storage for the entities in the batch.
 
 ***
 
-### 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,15 +16,15 @@ The id of the entry.
 
 ***
 
-### nodeId?
+### nodeIdentity {#nodeidentity}
 
-> `optional` **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that owns the entry.
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 

package/docs/reference/interfaces/ISynchronisedEntityCore.md

@@ -8,7 +8,7 @@ The base definition for synchronised entries.
 
 ## Properties
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 

package/docs/reference/interfaces/ISynchronisedStorageComponent.md

@@ -8,20 +8,20 @@ Class for performing synchronised storage operations.
 
 ## Methods
 
-### getDecryptionKey()
+### getDecryptionKey() {#getdecryptionkey}
 
-> **getDecryptionKey**(`actionRequest`): `Promise`\<`string`\>
+> **getDecryptionKey**(`trustPayload`): `Promise`\<`string`\>
 
 Get the decryption key for the synchronised storage.
 This is used to decrypt the data stored in the synchronised storage.
 
 #### Parameters
 
-##### actionRequest
+##### trustPayload
 
-`IIdentityAuthenticationActionRequest`
+`unknown`
 
-The action request used in the verifiable credential.
+Trust payload to verify the requesters identity.
 
 #### Returns
 
@@ -31,9 +31,9 @@ The decryption key.
 
 ***
 
-### syncChangeSet()
+### syncChangeSet() {#syncchangeset}
 
-> **syncChangeSet**(`syncChangeSet`, `actionRequest`): `Promise`\<`void`\>
+> **syncChangeSet**(`syncChangeSet`, `trustPayload`): `Promise`\<`void`\>
 
 Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
 
@@ -45,11 +45,11 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 The change set to synchronise.
 
-##### actionRequest
+##### trustPayload
 
-`IIdentityAuthenticationActionRequest`
+`unknown`
 
-The action request used in the verifiable credential.
+Trust payload to verify the requesters identity.
 
 #### Returns
 

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

@@ -2,4 +2,4 @@
 
 > **SynchronisedStorageContexts** = *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\[keyof *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\]
 
-The LD Contexts concerning SynchronisedStorage.
+The Contexts concerning Synchronised Storage.

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

@@ -2,12 +2,24 @@
 
 > `const` **SynchronisedStorageContexts**: `object`
 
-The LD Contexts concerning SynchronisedStorage.
+The Contexts concerning Synchronised Storage.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/synchronised-storage"` = `"https://schema.twindev.org/synchronised-storage"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/synchronised-storage/"` = `"https://schema.twindev.org/synchronised-storage/"`
 
-The SynchronisedStorage LD Context.
+The canonical RDF namespace URI for Synchronised Storage.
+
+### 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}
+
+> `readonly` **JsonLdContext**: `"https://schema.twindev.org/synchronised-storage/types.jsonld"` = `"https://schema.twindev.org/synchronised-storage/types.jsonld"`
+
+The JSON-LD Context URL for Synchronised Storage.

package/docs/reference/variables/SynchronisedStorageTopics.md

@@ -6,55 +6,55 @@ The topics for synchronised storage event bus notifications.
 
 ## Type Declaration
 
-### RegisterStorageKey
+### RegisterStorageKey {#registerstoragekey}
 
 > `readonly` **RegisterStorageKey**: `"synchronised-storage:register-storage-key"` = `"synchronised-storage:register-storage-key"`
 
 Register a storage key for the synchronised storage.
 
-### LocalItemChange
+### LocalItemChange {#localitemchange}
 
 > `readonly` **LocalItemChange**: `"synchronised-storage:local-item-change"` = `"synchronised-storage:local-item-change"`
 
 An item was changed in the storage by the local node.
 
-### LocalItemRequest
+### LocalItemRequest {#localitemrequest}
 
 > `readonly` **LocalItemRequest**: `"synchronised-storage:local-item-request"` = `"synchronised-storage:local-item-request"`
 
 A request has been made for a local item.
 
-### LocalItemResponse
+### LocalItemResponse {#localitemresponse}
 
 > `readonly` **LocalItemResponse**: `"synchronised-storage:local-item-response"` = `"synchronised-storage:local-item-response"`
 
 A response to a local item request.
 
-### Reset
+### Reset {#reset}
 
 > `readonly` **Reset**: `"synchronised-storage:reset"` = `"synchronised-storage:reset"`
 
 Reset the storage.
 
-### BatchRequest
+### BatchRequest {#batchrequest}
 
 > `readonly` **BatchRequest**: `"synchronised-storage:batch-request"` = `"synchronised-storage:batch-request"`
 
 A request has been made for a batch.
 
-### BatchResponse
+### BatchResponse {#batchresponse}
 
 > `readonly` **BatchResponse**: `"synchronised-storage:batch-response"` = `"synchronised-storage:batch-response"`
 
 A response to a batch.
 
-### RemoteItemSet
+### RemoteItemSet {#remoteitemset}
 
 > `readonly` **RemoteItemSet**: `"synchronised-storage:remote-item-set"` = `"synchronised-storage:remote-item-set"`
 
 An item was set in the storage by the remote node.
 
-### RemoteItemRemove
+### RemoteItemRemove {#remoteitemremove}
 
 > `readonly` **RemoteItemRemove**: `"synchronised-storage:remote-item-remove"` = `"synchronised-storage:remote-item-remove"`
 

package/docs/reference/variables/SynchronisedStorageTypes.md

@@ -6,13 +6,13 @@ The types of Synchronised Storage data.
 
 ## Type Declaration
 
-### SyncRequest
+### SyncRequest {#syncrequest}
 
 > `readonly` **SyncRequest**: `"SyncRequest"` = `"SyncRequest"`
 
 Represents a synchronised storage request.
 
-### ChangeSet
+### ChangeSet {#changeset}
 
 > `readonly` **ChangeSet**: `"ChangeSet"` = `"ChangeSet"`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/synchronised-storage-models",
-	"version": "0.0.3-next.1",
-	"description": "Models which define the structure of the synchronised storage connectors and services",
+	"version": "0.0.3-next.11",
+	"description": "Shared models, constants, and schemas for synchronised storage messages and contracts.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/synchronised-storage.git",
@@ -16,11 +16,8 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-authentication": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/standards-w3c-odrl": "next"
+		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",

package/dist/es/models/synchronisedStorageAssetTypes.js

@@ -1,26 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { ActionType } from "@twin.org/standards-w3c-odrl";
-/**
- * The ODRL asset types for SynchronisedStorage.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const SynchronisedStorageAssetTypes = {
-    /**
-     * Decryption Key.
-     */
-    DecryptionKey: "decryption-key",
-    /**
-     * Decryption Key Actions.
-     */
-    DecryptionKeyActions: [ActionType.Read],
-    /**
-     * Change Set.
-     */
-    ChangeSet: "change-set",
-    /**
-     * Change Set Actions.
-     */
-    ChangeSetActions: [ActionType.Write]
-};
-//# sourceMappingURL=synchronisedStorageAssetTypes.js.map

package/dist/es/models/synchronisedStorageAssetTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"synchronisedStorageAssetTypes.js","sourceRoot":"","sources":["../../../src/models/synchronisedStorageAssetTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC5C;;OAEG;IACH,aAAa,EAAE,gBAAgB;IAE/B;;OAEG;IACH,oBAAoB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,YAAY;IAEvB;;OAEG;IACH,gBAAgB,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC;CAC3B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ActionType } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * The ODRL asset types for SynchronisedStorage.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SynchronisedStorageAssetTypes = {\n\t/**\n\t * Decryption Key.\n\t */\n\tDecryptionKey: \"decryption-key\",\n\n\t/**\n\t * Decryption Key Actions.\n\t */\n\tDecryptionKeyActions: [ActionType.Read],\n\n\t/**\n\t * Change Set.\n\t */\n\tChangeSet: \"change-set\",\n\n\t/**\n\t * Change Set Actions.\n\t */\n\tChangeSetActions: [ActionType.Write]\n} as const;\n\n/**\n * The ODRL asset types for SynchronisedStorage.\n */\nexport type SynchronisedStorageAssetTypes =\n\t(typeof SynchronisedStorageAssetTypes)[keyof typeof SynchronisedStorageAssetTypes];\n"]}

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

@@ -1,25 +0,0 @@
-/**
- * The ODRL asset types for SynchronisedStorage.
- */
-export declare const SynchronisedStorageAssetTypes: {
-    /**
-     * Decryption Key.
-     */
-    readonly DecryptionKey: "decryption-key";
-    /**
-     * Decryption Key Actions.
-     */
-    readonly DecryptionKeyActions: readonly ["read"];
-    /**
-     * Change Set.
-     */
-    readonly ChangeSet: "change-set";
-    /**
-     * Change Set Actions.
-     */
-    readonly ChangeSetActions: readonly ["write"];
-};
-/**
- * The ODRL asset types for SynchronisedStorage.
- */
-export type SynchronisedStorageAssetTypes = (typeof SynchronisedStorageAssetTypes)[keyof typeof SynchronisedStorageAssetTypes];

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

@@ -1,5 +0,0 @@
-# Type Alias: SynchronisedStorageAssetTypes
-
-> **SynchronisedStorageAssetTypes** = *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\[keyof *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\]
-
-The ODRL asset types for SynchronisedStorage.

package/docs/reference/variables/SynchronisedStorageAssetTypes.md

@@ -1,31 +0,0 @@
-# Variable: SynchronisedStorageAssetTypes
-
-> `const` **SynchronisedStorageAssetTypes**: `object`
-
-The ODRL asset types for SynchronisedStorage.
-
-## Type Declaration
-
-### DecryptionKey
-
-> `readonly` **DecryptionKey**: `"decryption-key"` = `"decryption-key"`
-
-Decryption Key.
-
-### DecryptionKeyActions
-
-> `readonly` **DecryptionKeyActions**: readonly \[`"read"`\]
-
-Decryption Key Actions.
-
-### ChangeSet
-
-> `readonly` **ChangeSet**: `"change-set"` = `"change-set"`
-
-Change Set.
-
-### ChangeSetActions
-
-> `readonly` **ChangeSetActions**: readonly \[`"write"`\]
-
-Change Set Actions.