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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/dist/es/models/ISyncChange.js.map +1 -1
  2. package/dist/es/models/ISyncChangeSet.js.map +1 -1
  3. package/dist/es/models/ISyncRequest.js.map +1 -1
  4. package/dist/es/models/ISynchronisedEntity.js.map +1 -1
  5. package/dist/es/models/ISynchronisedEntityCore.js.map +1 -1
  6. package/dist/types/models/ISyncChange.d.ts +2 -0
  7. package/dist/types/models/ISyncChangeSet.d.ts +6 -1
  8. package/dist/types/models/ISyncRequest.d.ts +2 -1
  9. package/dist/types/models/ISynchronisedEntity.d.ts +2 -1
  10. package/dist/types/models/ISynchronisedEntityCore.d.ts +1 -0
  11. package/docs/changelog.md +7 -0
  12. package/docs/reference/interfaces/ISyncChange.md +2 -0
  13. package/docs/reference/interfaces/ISyncChangeSet.md +7 -2
  14. package/docs/reference/interfaces/ISyncRequest.md +3 -2
  15. package/docs/reference/interfaces/ISynchronisedEntity.md +4 -2
  16. package/docs/reference/interfaces/ISynchronisedEntityCore.md +1 -0
  17. package/package.json +1 -1
package/dist/es/models/ISyncChange.js.map CHANGED
@@ -1 +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"]}
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 * 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 CHANGED
@@ -1 +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.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 */\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"]}
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.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 CHANGED
@@ -1 +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.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 */\n\tnodeId: string;\n}\n"]}
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.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 CHANGED
@@ -1 +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"]}
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 * json-ld namespace:twin-common\n\t */\n\tnodeIdentity: string;\n}\n"]}
package/dist/es/models/ISynchronisedEntityCore.js.map CHANGED
@@ -1 +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"]}
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 * json-ld namespace:schema\n\t */\n\tdateModified: string;\n}\n"]}
package/dist/types/models/ISyncChange.d.ts CHANGED
@@ -6,6 +6,7 @@ import type { SyncChangeOperation } from "./syncChangeOperation.js";
6
6
  export interface ISyncChange {
7
7
  /**
8
8
  * Operation.
9
+ * json-ld type:schema:Text
9
10
  */
10
11
  operation: SyncChangeOperation;
11
12
  /**
@@ -14,6 +15,7 @@ export interface ISyncChange {
14
15
  id: string;
15
16
  /**
16
17
  * The entity to set.
18
+ * json-ld type:json
17
19
  */
18
20
  entity?: ISynchronisedEntityCore;
19
21
  }
package/dist/types/models/ISyncChangeSet.d.ts CHANGED
@@ -19,22 +19,27 @@ export interface ISyncChangeSet {
19
19
  id: string;
20
20
  /**
21
21
  * The storage key of the change set. This is used to identify the entities being synchronised.
22
+ * json-ld type:schema:identifier
22
23
  */
23
24
  storageKey: string;
24
25
  /**
25
26
  * The date the change set was created.
27
+ * json-ld namespace:schema
26
28
  */
27
29
  dateCreated: string;
28
30
  /**
29
31
  * The date the change set was last modified.
32
+ * json-ld namespace:schema
30
33
  */
31
34
  dateModified: string;
32
35
  /**
33
36
  * The identity of the node that created the change set.
37
+ * json-ld namespace:twin-common
34
38
  */
35
- nodeId: string;
39
+ nodeIdentity: string;
36
40
  /**
37
41
  * The changes to apply after a snapshot.
42
+ * json-ld type:json
38
43
  */
39
44
  changes: ISyncChange[];
40
45
  }
package/dist/types/models/ISyncRequest.d.ts CHANGED
@@ -14,6 +14,7 @@ export interface ISyncRequest {
14
14
  type: typeof SynchronisedStorageTypes.SyncRequest;
15
15
  /**
16
16
  * The identity of the node that created the request.
17
+ * json-ld namespace:twin-common
17
18
  */
18
- nodeId: string;
19
+ nodeIdentity: string;
19
20
  }
package/dist/types/models/ISynchronisedEntity.d.ts CHANGED
@@ -9,6 +9,7 @@ export interface ISynchronisedEntity extends ISynchronisedEntityCore {
9
9
  id: string;
10
10
  /**
11
11
  * The identity of the node that owns the entry.
12
+ * json-ld namespace:twin-common
12
13
  */
13
- nodeId?: string;
14
+ nodeIdentity: string;
14
15
  }
package/dist/types/models/ISynchronisedEntityCore.d.ts CHANGED
@@ -4,6 +4,7 @@
4
4
  export interface ISynchronisedEntityCore {
5
5
  /**
6
6
  * The date the entry was modified.
7
+ * json-ld namespace:schema
7
8
  */
8
9
  dateModified: string;
9
10
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Features
7
+
8
+ * json ld contexts ([#36](https://github.com/twinfoundation/synchronised-storage/issues/36)) ([3a87a9f](https://github.com/twinfoundation/synchronised-storage/commit/3a87a9fb16d21baf672e44b4e8914cf1937b1d6a))
9
+
3
10
  ## [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)
4
11
 
5
12
 
package/docs/reference/interfaces/ISyncChange.md CHANGED
@@ -9,6 +9,7 @@ The object definition for a sync change.
9
9
  > **operation**: [`SyncChangeOperation`](../type-aliases/SyncChangeOperation.md)
10
10
 
11
11
  Operation.
12
+ json-ld type:schema:Text
12
13
 
13
14
  ***
14
15
 
@@ -25,3 +26,4 @@ The item id.
25
26
  > `optional` **entity**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
26
27
 
27
28
  The entity to set.
29
+ json-ld type:json
package/docs/reference/interfaces/ISyncChangeSet.md CHANGED
@@ -33,6 +33,7 @@ The id of the change set.
33
33
  > **storageKey**: `string`
34
34
 
35
35
  The storage key of the change set. This is used to identify the entities being synchronised.
36
+ json-ld type:schema:identifier
36
37
 
37
38
  ***
38
39
 
@@ -41,6 +42,7 @@ The storage key of the change set. This is used to identify the entities being s
41
42
  > **dateCreated**: `string`
42
43
 
43
44
  The date the change set was created.
45
+ json-ld namespace:schema
44
46
 
45
47
  ***
46
48
 
@@ -49,14 +51,16 @@ The date the change set was created.
49
51
  > **dateModified**: `string`
50
52
 
51
53
  The date the change set was last modified.
54
+ json-ld namespace:schema
52
55
 
53
56
  ***
54
57
 
55
- ### nodeId
58
+ ### nodeIdentity
56
59
 
57
- > **nodeId**: `string`
60
+ > **nodeIdentity**: `string`
58
61
 
59
62
  The identity of the node that created the change set.
63
+ json-ld namespace:twin-common
60
64
 
61
65
  ***
62
66
 
@@ -65,3 +69,4 @@ The identity of the node that created the change set.
65
69
  > **changes**: [`ISyncChange`](ISyncChange.md)[]
66
70
 
67
71
  The changes to apply after a snapshot.
72
+ json-ld type:json
package/docs/reference/interfaces/ISyncRequest.md CHANGED
@@ -20,8 +20,9 @@ The LD Type for the request.
20
20
 
21
21
  ***
22
22
 
23
- ### nodeId
23
+ ### nodeIdentity
24
24
 
25
- > **nodeId**: `string`
25
+ > **nodeIdentity**: `string`
26
26
 
27
27
  The identity of the node that created the request.
28
+ json-ld namespace:twin-common
package/docs/reference/interfaces/ISynchronisedEntity.md CHANGED
@@ -16,11 +16,12 @@ The id of the entry.
16
16
 
17
17
  ***
18
18
 
19
- ### nodeId?
19
+ ### nodeIdentity
20
20
 
21
- > `optional` **nodeId**: `string`
21
+ > **nodeIdentity**: `string`
22
22
 
23
23
  The identity of the node that owns the entry.
24
+ json-ld namespace:twin-common
24
25
 
25
26
  ***
26
27
 
@@ -29,6 +30,7 @@ The identity of the node that owns the entry.
29
30
  > **dateModified**: `string`
30
31
 
31
32
  The date the entry was modified.
33
+ json-ld namespace:schema
32
34
 
33
35
  #### Inherited from
34
36
 
package/docs/reference/interfaces/ISynchronisedEntityCore.md CHANGED
@@ -13,3 +13,4 @@ The base definition for synchronised entries.
13
13
  > **dateModified**: `string`
14
14
 
15
15
  The date the entry was modified.
16
+ json-ld namespace:schema
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/synchronised-storage-models",
3
- "version": "0.0.3-next.6",
3
+ "version": "0.0.3-next.7",
4
4
  "description": "Models which define the structure of the synchronised storage connectors and services",
5
5
  "repository": {
6
6
  "type": "git",