@twin.org/synchronised-storage-models 0.0.3-next.5 → 0.0.3-next.7

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.Namespace;\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.Namespace;\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/synchronisedStorageContexts.js

@@ -1,13 +1,21 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
- * The Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const SynchronisedStorageContexts = {
     /**
-     * The namespace.
+     * The canonical RDF namespace URI for Synchronised Storage.
      */
-    Namespace: "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,SAAS,EAAE,kDAAkD;CACpD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Contexts concerning SynchronisedStorage.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const SynchronisedStorageContexts = {\n\t/**\n\t * The namespace.\n\t */\n\tNamespace: \"https://schema.twindev.org/synchronised-storage/\"\n} as const;\n\n/**\n * The 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/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.Namespace;
+    "@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.Namespace;
+    "@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/synchronisedStorageContexts.d.ts

@@ -1,13 +1,21 @@
 /**
- * The Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 export declare const SynchronisedStorageContexts: {
     /**
-     * The namespace.
+     * The canonical RDF namespace URI for 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 Contexts concerning SynchronisedStorage.
+ * The Contexts concerning Synchronised Storage.
  */
 export type SynchronisedStorageContexts = (typeof SynchronisedStorageContexts)[keyof typeof SynchronisedStorageContexts];

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
 
 

package/docs/reference/interfaces/ISyncChange.md

@@ -9,6 +9,7 @@ The object definition for a sync change.
 > **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
 
 Operation.
+json-ld type:schema:Text
 
 ***
 
@@ -25,3 +26,4 @@ The item id.
 > `optional` **entity**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
 
 The entity to set.
+json-ld type:json

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -33,6 +33,7 @@ The id of the change set.
 > **storageKey**: `string`
 
 The storage key of the change set. This is used to identify the entities being synchronised.
+json-ld type:schema:identifier
 
 ***
 
@@ -41,6 +42,7 @@ The storage key of the change set. This is used to identify the entities being s
 > **dateCreated**: `string`
 
 The date the change set was created.
+json-ld namespace:schema
 
 ***
 
@@ -49,14 +51,16 @@ The date the change set was created.
 > **dateModified**: `string`
 
 The date the change set was last modified.
+json-ld namespace:schema
 
 ***
 
-### nodeId
+### nodeIdentity
 
-> **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that created the change set.
+json-ld namespace:twin-common
 
 ***
 
@@ -65,3 +69,4 @@ The identity of the node that created the change set.
 > **changes**: [`ISyncChange`](ISyncChange.md)[]
 
 The changes to apply after a snapshot.
+json-ld type:json

package/docs/reference/interfaces/ISyncRequest.md

@@ -20,8 +20,9 @@ The LD Type for the request.
 
 ***
 
-### nodeId
+### nodeIdentity
 
-> **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that created the request.
+json-ld namespace:twin-common

package/docs/reference/interfaces/ISynchronisedEntity.md

@@ -16,11 +16,12 @@ The id of the entry.
 
 ***
 
-### nodeId?
+### nodeIdentity
 
-> `optional` **nodeId**: `string`
+> **nodeIdentity**: `string`
 
 The identity of the node that owns the entry.
+json-ld namespace:twin-common
 
 ***
 
@@ -29,6 +30,7 @@ The identity of the node that owns the entry.
 > **dateModified**: `string`
 
 The date the entry was modified.
+json-ld namespace:schema
 
 #### Inherited from
 

package/docs/reference/interfaces/ISynchronisedEntityCore.md

@@ -13,3 +13,4 @@ The base definition for synchronised entries.
 > **dateModified**: `string`
 
 The date the entry was modified.
+json-ld namespace:schema

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

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

package/docs/reference/variables/SynchronisedStorageContexts.md

@@ -2,7 +2,7 @@
 
 > `const` **SynchronisedStorageContexts**: `object`
 
-The Contexts concerning SynchronisedStorage.
+The Contexts concerning Synchronised Storage.
 
 ## Type Declaration
 
@@ -10,4 +10,16 @@ The Contexts concerning SynchronisedStorage.
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/synchronised-storage/"` = `"https://schema.twindev.org/synchronised-storage/"`
 
-The namespace.
+The canonical RDF namespace URI for Synchronised Storage.
+
+### 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
+
+> `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/package.json

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