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

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 (54) hide show
  1. package/README.md +2 -2
  2. package/dist/es/index.js +0 -1
  3. package/dist/es/index.js.map +1 -1
  4. package/dist/es/models/ISyncChange.js.map +1 -1
  5. package/dist/es/models/ISyncChangeSet.js.map +1 -1
  6. package/dist/es/models/ISyncRequest.js.map +1 -1
  7. package/dist/es/models/ISynchronisedEntity.js.map +1 -1
  8. package/dist/es/models/ISynchronisedEntityCore.js.map +1 -1
  9. package/dist/es/models/ISynchronisedStorageComponent.js.map +1 -1
  10. package/dist/es/models/eventBus/ISyncItemRequest.js.map +1 -1
  11. package/dist/es/models/eventBus/ISyncItemResponse.js.map +1 -1
  12. package/dist/es/models/eventBus/ISyncReset.js.map +1 -1
  13. package/dist/types/index.d.ts +0 -1
  14. package/dist/types/models/ISyncChange.d.ts +2 -2
  15. package/dist/types/models/ISyncChangeSet.d.ts +5 -5
  16. package/dist/types/models/ISyncRequest.d.ts +1 -1
  17. package/dist/types/models/ISynchronisedEntity.d.ts +1 -1
  18. package/dist/types/models/ISynchronisedEntityCore.d.ts +1 -1
  19. package/dist/types/models/ISynchronisedStorageComponent.d.ts +1 -1
  20. package/dist/types/models/eventBus/ISyncItemRequest.d.ts +1 -1
  21. package/dist/types/models/eventBus/ISyncItemResponse.d.ts +1 -1
  22. package/dist/types/models/eventBus/ISyncReset.d.ts +1 -1
  23. package/docs/changelog.md +141 -58
  24. package/docs/examples.md +61 -1
  25. package/docs/reference/index.md +0 -2
  26. package/docs/reference/interfaces/ISyncBatchRequest.md +3 -3
  27. package/docs/reference/interfaces/ISyncBatchResponse.md +3 -3
  28. package/docs/reference/interfaces/ISyncChange.md +4 -6
  29. package/docs/reference/interfaces/ISyncChangeSet.md +8 -13
  30. package/docs/reference/interfaces/ISyncChangeSetRequest.md +5 -5
  31. package/docs/reference/interfaces/ISyncDecryptionKeyRequest.md +4 -4
  32. package/docs/reference/interfaces/ISyncDecryptionKeyResponse.md +1 -1
  33. package/docs/reference/interfaces/ISyncItemChange.md +4 -4
  34. package/docs/reference/interfaces/ISyncItemRemove.md +3 -3
  35. package/docs/reference/interfaces/ISyncItemRequest.md +3 -3
  36. package/docs/reference/interfaces/ISyncItemResponse.md +5 -5
  37. package/docs/reference/interfaces/ISyncItemSet.md +2 -2
  38. package/docs/reference/interfaces/ISyncRegisterStorageKey.md +1 -1
  39. package/docs/reference/interfaces/ISyncRequest.md +3 -4
  40. package/docs/reference/interfaces/ISyncReset.md +3 -3
  41. package/docs/reference/interfaces/ISynchronisedEntity.md +3 -5
  42. package/docs/reference/interfaces/ISynchronisedEntityCore.md +1 -2
  43. package/docs/reference/interfaces/ISynchronisedStorageComponent.md +3 -3
  44. package/docs/reference/variables/SyncChangeOperation.md +2 -2
  45. package/docs/reference/variables/SyncNodeIdMode.md +3 -3
  46. package/docs/reference/variables/SynchronisedStorageContexts.md +3 -3
  47. package/docs/reference/variables/SynchronisedStorageTopics.md +9 -9
  48. package/docs/reference/variables/SynchronisedStorageTypes.md +2 -2
  49. package/package.json +8 -10
  50. package/dist/es/models/synchronisedStorageAssetTypes.js +0 -26
  51. package/dist/es/models/synchronisedStorageAssetTypes.js.map +0 -1
  52. package/dist/types/models/synchronisedStorageAssetTypes.d.ts +0 -25
  53. package/docs/reference/type-aliases/SynchronisedStorageAssetTypes.md +0 -5
  54. package/docs/reference/variables/SynchronisedStorageAssetTypes.md +0 -31
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # TWIN Synchronised Storage Models
1
+ # Synchronised Storage Models
2
2
 
3
- Models which define the structure of the synchronised-storage contracts and connectors.
3
+ 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.
4
4
 
5
5
  ## Installation
6
6
 
package/dist/es/index.js CHANGED
@@ -19,7 +19,6 @@ export * from "./models/ISynchronisedEntityCore.js";
19
19
  export * from "./models/ISynchronisedStorageComponent.js";
20
20
  export * from "./models/ISyncRequest.js";
21
21
  export * from "./models/syncChangeOperation.js";
22
- export * from "./models/synchronisedStorageAssetTypes.js";
23
22
  export * from "./models/synchronisedStorageContexts.js";
24
23
  export * from "./models/synchronisedStorageTopics.js";
25
24
  export * from "./models/synchronisedStorageTypes.js";
@@ -1 +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"]}
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,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"]}
@@ -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 * 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"]}
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"]}
@@ -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 * 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"]}
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"]}
@@ -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 * json-ld namespace:twin-common\n\t */\n\tnodeIdentity: 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"]}
@@ -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 * json-ld namespace:twin-common\n\t */\n\tnodeIdentity: 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"]}
@@ -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 * json-ld namespace:schema\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"]}
@@ -1 +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 { 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"]}
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 { 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 A promise that resolves when the change set has been applied and stored.\n\t */\n\tsyncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"ISyncItemRequest.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncItemRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request for a local item.\n */\nexport interface ISyncItemRequest {\n\t/**\n\t * The key of the storage for the entities in the batch.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The item id being requested.\n\t */\n\tid: string;\n}\n"]}
1
+ {"version":3,"file":"ISyncItemRequest.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncItemRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request for a local item.\n */\nexport interface ISyncItemRequest {\n\t/**\n\t * The key of the storage containing the requested item.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The item id being requested.\n\t */\n\tid: string;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"ISyncItemResponse.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncItemResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntity } from \"../ISynchronisedEntity.js\";\n\n/**\n * Response for a sync item request.\n */\nexport interface ISyncItemResponse {\n\t/**\n\t * The key of the storage for the entities in the batch.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The id of the entity in the sync item response.\n\t */\n\tid: string;\n\n\t/**\n\t * The entity in the sync item response, undefined if not found.\n\t */\n\tentity?: ISynchronisedEntity;\n}\n"]}
1
+ {"version":3,"file":"ISyncItemResponse.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncItemResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISynchronisedEntity } from \"../ISynchronisedEntity.js\";\n\n/**\n * Response for a sync item request.\n */\nexport interface ISyncItemResponse {\n\t/**\n\t * The key of the storage containing the responding item.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * The id of the entity in the sync item response.\n\t */\n\tid: string;\n\n\t/**\n\t * The entity in the sync item response, undefined if not found.\n\t */\n\tentity?: ISynchronisedEntity;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"ISyncReset.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncReset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SyncNodeIdMode } from \"../syncNodeIdMode.js\";\n\n/**\n * Request to reset the local storage.\n */\nexport interface ISyncReset {\n\t/**\n\t * The key of the storage for the entities in the batch.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * Reset mode, this will use the nodeId in the entities to determine which are local/remote.\n\t */\n\tresetMode: SyncNodeIdMode;\n}\n"]}
1
+ {"version":3,"file":"ISyncReset.js","sourceRoot":"","sources":["../../../../src/models/eventBus/ISyncReset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SyncNodeIdMode } from \"../syncNodeIdMode.js\";\n\n/**\n * Request to reset the local storage.\n */\nexport interface ISyncReset {\n\t/**\n\t * The key of the storage to reset.\n\t */\n\tstorageKey: string;\n\n\t/**\n\t * Reset mode, this will use the nodeId in the entities to determine which are local/remote.\n\t */\n\tresetMode: SyncNodeIdMode;\n}\n"]}
@@ -17,7 +17,6 @@ export * from "./models/ISynchronisedEntityCore.js";
17
17
  export * from "./models/ISynchronisedStorageComponent.js";
18
18
  export * from "./models/ISyncRequest.js";
19
19
  export * from "./models/syncChangeOperation.js";
20
- export * from "./models/synchronisedStorageAssetTypes.js";
21
20
  export * from "./models/synchronisedStorageContexts.js";
22
21
  export * from "./models/synchronisedStorageTopics.js";
23
22
  export * from "./models/synchronisedStorageTypes.js";
@@ -6,7 +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
+ * @json-ld type:schema:Text
10
10
  */
11
11
  operation: SyncChangeOperation;
12
12
  /**
@@ -15,7 +15,7 @@ export interface ISyncChange {
15
15
  id: string;
16
16
  /**
17
17
  * The entity to set.
18
- * json-ld type:json
18
+ * @json-ld type:json
19
19
  */
20
20
  entity?: ISynchronisedEntityCore;
21
21
  }
@@ -19,27 +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
+ * @json-ld type:schema:identifier
23
23
  */
24
24
  storageKey: string;
25
25
  /**
26
26
  * The date the change set was created.
27
- * json-ld namespace:schema
27
+ * @json-ld namespace:schema
28
28
  */
29
29
  dateCreated: string;
30
30
  /**
31
31
  * The date the change set was last modified.
32
- * json-ld namespace:schema
32
+ * @json-ld namespace:schema
33
33
  */
34
34
  dateModified: string;
35
35
  /**
36
36
  * The identity of the node that created the change set.
37
- * json-ld namespace:twin-common
37
+ * @json-ld namespace:twin-common
38
38
  */
39
39
  nodeIdentity: string;
40
40
  /**
41
41
  * The changes to apply after a snapshot.
42
- * json-ld type:json
42
+ * @json-ld type:json
43
43
  */
44
44
  changes: ISyncChange[];
45
45
  }
@@ -14,7 +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
+ * @json-ld namespace:twin-common
18
18
  */
19
19
  nodeIdentity: string;
20
20
  }
@@ -9,7 +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
+ * @json-ld namespace:twin-common
13
13
  */
14
14
  nodeIdentity: string;
15
15
  }
@@ -4,7 +4,7 @@
4
4
  export interface ISynchronisedEntityCore {
5
5
  /**
6
6
  * The date the entry was modified.
7
- * json-ld namespace:schema
7
+ * @json-ld namespace:schema
8
8
  */
9
9
  dateModified: string;
10
10
  }
@@ -15,7 +15,7 @@ export interface ISynchronisedStorageComponent extends IComponent {
15
15
  * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
16
16
  * @param syncChangeSet The change set to synchronise.
17
17
  * @param trustPayload Trust payload to verify the requesters identity.
18
- * @returns Nothing.
18
+ * @returns A promise that resolves when the change set has been applied and stored.
19
19
  */
20
20
  syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
21
21
  }
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export interface ISyncItemRequest {
5
5
  /**
6
- * The key of the storage for the entities in the batch.
6
+ * The key of the storage containing the requested item.
7
7
  */
8
8
  storageKey: string;
9
9
  /**
@@ -4,7 +4,7 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity.js";
4
4
  */
5
5
  export interface ISyncItemResponse {
6
6
  /**
7
- * The key of the storage for the entities in the batch.
7
+ * The key of the storage containing the responding item.
8
8
  */
9
9
  storageKey: string;
10
10
  /**
@@ -4,7 +4,7 @@ import type { SyncNodeIdMode } from "../syncNodeIdMode.js";
4
4
  */
5
5
  export interface ISyncReset {
6
6
  /**
7
- * The key of the storage for the entities in the batch.
7
+ * The key of the storage to reset.
8
8
  */
9
9
  storageKey: string;
10
10
  /**
package/docs/changelog.md CHANGED
@@ -1,201 +1,284 @@
1
1
  # Changelog
2
2
 
3
- ## [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)
3
+ ## [0.9.0](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.9.0...synchronised-storage-models-v0.9.0) (2026-06-25)
4
+
5
+
6
+ ### Features
7
+
8
+ * initial commit ([16949b8](https://github.com/iotaledger/twin-synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
9
+ * release to production ([#55](https://github.com/iotaledger/twin-synchronised-storage/issues/55)) ([8e5df2f](https://github.com/iotaledger/twin-synchronised-storage/commit/8e5df2fd3ef9c7a39d7bd9f366fe54b266eb0d5b))
10
+
11
+ ## [0.9.0-next.1](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.9.0-next.0...synchronised-storage-models-v0.9.0-next.1) (2026-06-24)
12
+
13
+
14
+ ### Features
15
+
16
+ * add async item requests to reduce storage overhead ([#3](https://github.com/iotaledger/twin-synchronised-storage/issues/3)) ([af4e17d](https://github.com/iotaledger/twin-synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
17
+ * add context id features ([#24](https://github.com/iotaledger/twin-synchronised-storage/issues/24)) ([5266b18](https://github.com/iotaledger/twin-synchronised-storage/commit/5266b18088317c7dc274a209a79102a6fc88a8e4))
18
+ * add rights management integration ([56fff6b](https://github.com/iotaledger/twin-synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
19
+ * add rights management integration ([d003d33](https://github.com/iotaledger/twin-synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
20
+ * add ts-to-jsonld-context tool ([16d7677](https://github.com/iotaledger/twin-synchronised-storage/commit/16d76776e7e3f75e6c4fb9f88cb32fed2967c4b6))
21
+ * add validate-locales ([e3d7b98](https://github.com/iotaledger/twin-synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
22
+ * additional node identity checks ([76257c4](https://github.com/iotaledger/twin-synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
23
+ * blob storage connector instead of component ([#7](https://github.com/iotaledger/twin-synchronised-storage/issues/7)) ([ea27241](https://github.com/iotaledger/twin-synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
24
+ * eslint migration to flat config ([f601c14](https://github.com/iotaledger/twin-synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
25
+ * initial commit ([16949b8](https://github.com/iotaledger/twin-synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
26
+ * json ld contexts ([#36](https://github.com/iotaledger/twin-synchronised-storage/issues/36)) ([3a87a9f](https://github.com/iotaledger/twin-synchronised-storage/commit/3a87a9fb16d21baf672e44b4e8914cf1937b1d6a))
27
+ * remove unused dependencies ([518c460](https://github.com/iotaledger/twin-synchronised-storage/commit/518c460d2e5e2b2c487565acb5162a03ddb85eae))
28
+ * sync testing ([#5](https://github.com/iotaledger/twin-synchronised-storage/issues/5)) ([f78d5ac](https://github.com/iotaledger/twin-synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
29
+ * typescript 6 update ([b0e6d52](https://github.com/iotaledger/twin-synchronised-storage/commit/b0e6d52f622dc1ff2273f5e09e8370382742ae50))
30
+ * update contexts ([#34](https://github.com/iotaledger/twin-synchronised-storage/issues/34)) ([7be9caf](https://github.com/iotaledger/twin-synchronised-storage/commit/7be9caf3da63f8afefd625650150bed171a1d045))
31
+ * update contexts and namespaces ([#31](https://github.com/iotaledger/twin-synchronised-storage/issues/31)) ([b31c8fa](https://github.com/iotaledger/twin-synchronised-storage/commit/b31c8fabb8431a230415aaa2caa47fb021489d3a))
32
+ * update dependencies ([2bce2e2](https://github.com/iotaledger/twin-synchronised-storage/commit/2bce2e205f9e1acdef41681720e192b77aa50468))
33
+ * update framework core ([99f09cc](https://github.com/iotaledger/twin-synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
34
+ * update schemas ([7566c48](https://github.com/iotaledger/twin-synchronised-storage/commit/7566c4860baad5ead4327ac19cb5b647e63f2ca3))
35
+ * update to in built vc auth mechanism ([411a371](https://github.com/iotaledger/twin-synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
36
+ * use trust component ([424f0d6](https://github.com/iotaledger/twin-synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
37
+
38
+
39
+ ### Bug Fixes
40
+
41
+ * missing dependency ([cf4427e](https://github.com/iotaledger/twin-synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
42
+ * remove redundant code ([19edb23](https://github.com/iotaledger/twin-synchronised-storage/commit/19edb236f318b9c9454a64259d0ab5098a0c8173))
43
+
44
+ ## [0.0.3-next.15](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.14...synchronised-storage-models-v0.0.3-next.15) (2026-06-11)
45
+
46
+
47
+ ### Miscellaneous Chores
48
+
49
+ * **synchronised-storage-models:** Synchronize repo versions
50
+
51
+ ## [0.0.3-next.14](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.13...synchronised-storage-models-v0.0.3-next.14) (2026-05-20)
52
+
53
+
54
+ ### Features
55
+
56
+ * update dependencies ([2bce2e2](https://github.com/iotaledger/twin-synchronised-storage/commit/2bce2e205f9e1acdef41681720e192b77aa50468))
57
+
58
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.12...synchronised-storage-models-v0.0.3-next.13) (2026-05-12)
59
+
60
+
61
+ ### Features
62
+
63
+ * typescript 6 update ([b0e6d52](https://github.com/iotaledger/twin-synchronised-storage/commit/b0e6d52f622dc1ff2273f5e09e8370382742ae50))
64
+
65
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.11...synchronised-storage-models-v0.0.3-next.12) (2026-05-07)
66
+
67
+
68
+ ### Miscellaneous Chores
69
+
70
+ * **synchronised-storage-models:** Synchronize repo versions
71
+
72
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.10...synchronised-storage-models-v0.0.3-next.11) (2026-04-10)
73
+
74
+
75
+ ### Miscellaneous Chores
76
+
77
+ * **synchronised-storage-models:** Synchronize repo versions
78
+
79
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.9...synchronised-storage-models-v0.0.3-next.10) (2026-03-20)
80
+
81
+
82
+ ### Bug Fixes
83
+
84
+ * remove redundant code ([19edb23](https://github.com/iotaledger/twin-synchronised-storage/commit/19edb236f318b9c9454a64259d0ab5098a0c8173))
85
+
86
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.8...synchronised-storage-models-v0.0.3-next.9) (2026-03-04)
4
87
 
5
88
 
6
89
  ### Miscellaneous Chores
7
90
 
8
91
  * **synchronised-storage-models:** Synchronize repo versions
9
92
 
10
- ## [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)
93
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.7...synchronised-storage-models-v0.0.3-next.8) (2026-02-25)
11
94
 
12
95
 
13
96
  ### Features
14
97
 
15
- * add ts-to-jsonld-context tool ([16d7677](https://github.com/twinfoundation/synchronised-storage/commit/16d76776e7e3f75e6c4fb9f88cb32fed2967c4b6))
16
- * update schemas ([7566c48](https://github.com/twinfoundation/synchronised-storage/commit/7566c4860baad5ead4327ac19cb5b647e63f2ca3))
98
+ * add ts-to-jsonld-context tool ([16d7677](https://github.com/iotaledger/twin-synchronised-storage/commit/16d76776e7e3f75e6c4fb9f88cb32fed2967c4b6))
99
+ * update schemas ([7566c48](https://github.com/iotaledger/twin-synchronised-storage/commit/7566c4860baad5ead4327ac19cb5b647e63f2ca3))
17
100
 
18
- ## [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)
101
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.6...synchronised-storage-models-v0.0.3-next.7) (2026-01-28)
19
102
 
20
103
 
21
104
  ### Features
22
105
 
23
- * json ld contexts ([#36](https://github.com/twinfoundation/synchronised-storage/issues/36)) ([3a87a9f](https://github.com/twinfoundation/synchronised-storage/commit/3a87a9fb16d21baf672e44b4e8914cf1937b1d6a))
106
+ * json ld contexts ([#36](https://github.com/iotaledger/twin-synchronised-storage/issues/36)) ([3a87a9f](https://github.com/iotaledger/twin-synchronised-storage/commit/3a87a9fb16d21baf672e44b4e8914cf1937b1d6a))
24
107
 
25
- ## [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)
108
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.5...synchronised-storage-models-v0.0.3-next.6) (2026-01-22)
26
109
 
27
110
 
28
111
  ### Features
29
112
 
30
- * update contexts ([#34](https://github.com/twinfoundation/synchronised-storage/issues/34)) ([7be9caf](https://github.com/twinfoundation/synchronised-storage/commit/7be9caf3da63f8afefd625650150bed171a1d045))
113
+ * update contexts ([#34](https://github.com/iotaledger/twin-synchronised-storage/issues/34)) ([7be9caf](https://github.com/iotaledger/twin-synchronised-storage/commit/7be9caf3da63f8afefd625650150bed171a1d045))
31
114
 
32
- ## [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)
115
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.4...synchronised-storage-models-v0.0.3-next.5) (2026-01-19)
33
116
 
34
117
 
35
118
  ### Features
36
119
 
37
- * remove unused dependencies ([518c460](https://github.com/twinfoundation/synchronised-storage/commit/518c460d2e5e2b2c487565acb5162a03ddb85eae))
120
+ * remove unused dependencies ([518c460](https://github.com/iotaledger/twin-synchronised-storage/commit/518c460d2e5e2b2c487565acb5162a03ddb85eae))
38
121
 
39
- ## [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)
122
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.3...synchronised-storage-models-v0.0.3-next.4) (2026-01-15)
40
123
 
41
124
 
42
125
  ### Features
43
126
 
44
- * update contexts and namespaces ([#31](https://github.com/twinfoundation/synchronised-storage/issues/31)) ([b31c8fa](https://github.com/twinfoundation/synchronised-storage/commit/b31c8fabb8431a230415aaa2caa47fb021489d3a))
127
+ * update contexts and namespaces ([#31](https://github.com/iotaledger/twin-synchronised-storage/issues/31)) ([b31c8fa](https://github.com/iotaledger/twin-synchronised-storage/commit/b31c8fabb8431a230415aaa2caa47fb021489d3a))
45
128
 
46
- ## [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)
129
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.2...synchronised-storage-models-v0.0.3-next.3) (2026-01-12)
47
130
 
48
131
 
49
132
  ### Miscellaneous Chores
50
133
 
51
134
  * **synchronised-storage-models:** Synchronize repo versions
52
135
 
53
- ## [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)
136
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.1...synchronised-storage-models-v0.0.3-next.2) (2025-12-04)
54
137
 
55
138
 
56
139
  ### Features
57
140
 
58
- * use trust component ([424f0d6](https://github.com/twinfoundation/synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
141
+ * use trust component ([424f0d6](https://github.com/iotaledger/twin-synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
59
142
 
60
- ## [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)
143
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.3-next.0...synchronised-storage-models-v0.0.3-next.1) (2025-11-12)
61
144
 
62
145
 
63
146
  ### Features
64
147
 
65
- * add async item requests to reduce storage overhead ([#3](https://github.com/twinfoundation/synchronised-storage/issues/3)) ([af4e17d](https://github.com/twinfoundation/synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
66
- * add context id features ([#24](https://github.com/twinfoundation/synchronised-storage/issues/24)) ([5266b18](https://github.com/twinfoundation/synchronised-storage/commit/5266b18088317c7dc274a209a79102a6fc88a8e4))
67
- * add rights management integration ([56fff6b](https://github.com/twinfoundation/synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
68
- * add rights management integration ([d003d33](https://github.com/twinfoundation/synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
69
- * add validate-locales ([e3d7b98](https://github.com/twinfoundation/synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
70
- * additional node identity checks ([76257c4](https://github.com/twinfoundation/synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
71
- * blob storage connector instead of component ([#7](https://github.com/twinfoundation/synchronised-storage/issues/7)) ([ea27241](https://github.com/twinfoundation/synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
72
- * eslint migration to flat config ([f601c14](https://github.com/twinfoundation/synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
73
- * initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
74
- * sync testing ([#5](https://github.com/twinfoundation/synchronised-storage/issues/5)) ([f78d5ac](https://github.com/twinfoundation/synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
75
- * update framework core ([99f09cc](https://github.com/twinfoundation/synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
76
- * update to in built vc auth mechanism ([411a371](https://github.com/twinfoundation/synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
148
+ * add async item requests to reduce storage overhead ([#3](https://github.com/iotaledger/twin-synchronised-storage/issues/3)) ([af4e17d](https://github.com/iotaledger/twin-synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
149
+ * add context id features ([#24](https://github.com/iotaledger/twin-synchronised-storage/issues/24)) ([5266b18](https://github.com/iotaledger/twin-synchronised-storage/commit/5266b18088317c7dc274a209a79102a6fc88a8e4))
150
+ * add rights management integration ([56fff6b](https://github.com/iotaledger/twin-synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
151
+ * add rights management integration ([d003d33](https://github.com/iotaledger/twin-synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
152
+ * add validate-locales ([e3d7b98](https://github.com/iotaledger/twin-synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
153
+ * additional node identity checks ([76257c4](https://github.com/iotaledger/twin-synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
154
+ * blob storage connector instead of component ([#7](https://github.com/iotaledger/twin-synchronised-storage/issues/7)) ([ea27241](https://github.com/iotaledger/twin-synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
155
+ * eslint migration to flat config ([f601c14](https://github.com/iotaledger/twin-synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
156
+ * initial commit ([16949b8](https://github.com/iotaledger/twin-synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
157
+ * sync testing ([#5](https://github.com/iotaledger/twin-synchronised-storage/issues/5)) ([f78d5ac](https://github.com/iotaledger/twin-synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
158
+ * update framework core ([99f09cc](https://github.com/iotaledger/twin-synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
159
+ * update to in built vc auth mechanism ([411a371](https://github.com/iotaledger/twin-synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
77
160
 
78
161
 
79
162
  ### Bug Fixes
80
163
 
81
- * missing dependency ([cf4427e](https://github.com/twinfoundation/synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
164
+ * missing dependency ([cf4427e](https://github.com/iotaledger/twin-synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
82
165
 
83
- ## [0.0.1-next.16](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.15...synchronised-storage-models-v0.0.1-next.16) (2025-10-09)
166
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.15...synchronised-storage-models-v0.0.1-next.16) (2025-10-09)
84
167
 
85
168
 
86
169
  ### Features
87
170
 
88
- * add validate-locales ([e3d7b98](https://github.com/twinfoundation/synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
171
+ * add validate-locales ([e3d7b98](https://github.com/iotaledger/twin-synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
89
172
 
90
- ## [0.0.1-next.15](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.14...synchronised-storage-models-v0.0.1-next.15) (2025-09-23)
173
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.14...synchronised-storage-models-v0.0.1-next.15) (2025-09-23)
91
174
 
92
175
 
93
176
  ### Features
94
177
 
95
- * add rights management integration ([56fff6b](https://github.com/twinfoundation/synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
96
- * update to in built vc auth mechanism ([411a371](https://github.com/twinfoundation/synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
178
+ * add rights management integration ([56fff6b](https://github.com/iotaledger/twin-synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
179
+ * update to in built vc auth mechanism ([411a371](https://github.com/iotaledger/twin-synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
97
180
 
98
- ## [0.0.1-next.14](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.13...synchronised-storage-models-v0.0.1-next.14) (2025-09-22)
181
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.13...synchronised-storage-models-v0.0.1-next.14) (2025-09-22)
99
182
 
100
183
 
101
184
  ### Features
102
185
 
103
- * add rights management integration ([d003d33](https://github.com/twinfoundation/synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
186
+ * add rights management integration ([d003d33](https://github.com/iotaledger/twin-synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
104
187
 
105
- ## [0.0.1-next.13](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.12...synchronised-storage-models-v0.0.1-next.13) (2025-08-29)
188
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.12...synchronised-storage-models-v0.0.1-next.13) (2025-08-29)
106
189
 
107
190
 
108
191
  ### Features
109
192
 
110
- * eslint migration to flat config ([f601c14](https://github.com/twinfoundation/synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
193
+ * eslint migration to flat config ([f601c14](https://github.com/iotaledger/twin-synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
111
194
 
112
- ## [0.0.1-next.12](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.11...synchronised-storage-models-v0.0.1-next.12) (2025-08-21)
195
+ ## [0.0.1-next.12](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.11...synchronised-storage-models-v0.0.1-next.12) (2025-08-21)
113
196
 
114
197
 
115
198
  ### Features
116
199
 
117
- * update framework core ([99f09cc](https://github.com/twinfoundation/synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
200
+ * update framework core ([99f09cc](https://github.com/iotaledger/twin-synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
118
201
 
119
- ## [0.0.1-next.11](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.10...synchronised-storage-models-v0.0.1-next.11) (2025-08-15)
202
+ ## [0.0.1-next.11](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.10...synchronised-storage-models-v0.0.1-next.11) (2025-08-15)
120
203
 
121
204
 
122
205
  ### Miscellaneous Chores
123
206
 
124
207
  * **synchronised-storage-models:** Synchronize repo versions
125
208
 
126
- ## [0.0.1-next.10](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.9...synchronised-storage-models-v0.0.1-next.10) (2025-08-15)
209
+ ## [0.0.1-next.10](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.9...synchronised-storage-models-v0.0.1-next.10) (2025-08-15)
127
210
 
128
211
 
129
212
  ### Miscellaneous Chores
130
213
 
131
214
  * **synchronised-storage-models:** Synchronize repo versions
132
215
 
133
- ## [0.0.1-next.9](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.8...synchronised-storage-models-v0.0.1-next.9) (2025-08-13)
216
+ ## [0.0.1-next.9](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.8...synchronised-storage-models-v0.0.1-next.9) (2025-08-13)
134
217
 
135
218
 
136
219
  ### Miscellaneous Chores
137
220
 
138
221
  * **synchronised-storage-models:** Synchronize repo versions
139
222
 
140
- ## [0.0.1-next.8](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.7...synchronised-storage-models-v0.0.1-next.8) (2025-08-13)
223
+ ## [0.0.1-next.8](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.7...synchronised-storage-models-v0.0.1-next.8) (2025-08-13)
141
224
 
142
225
 
143
226
  ### Miscellaneous Chores
144
227
 
145
228
  * **synchronised-storage-models:** Synchronize repo versions
146
229
 
147
- ## [0.0.1-next.7](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.6...synchronised-storage-models-v0.0.1-next.7) (2025-08-12)
230
+ ## [0.0.1-next.7](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.6...synchronised-storage-models-v0.0.1-next.7) (2025-08-12)
148
231
 
149
232
 
150
233
  ### Miscellaneous Chores
151
234
 
152
235
  * **synchronised-storage-models:** Synchronize repo versions
153
236
 
154
- ## [0.0.1-next.6](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.5...synchronised-storage-models-v0.0.1-next.6) (2025-08-11)
237
+ ## [0.0.1-next.6](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.5...synchronised-storage-models-v0.0.1-next.6) (2025-08-11)
155
238
 
156
239
 
157
240
  ### Miscellaneous Chores
158
241
 
159
242
  * **synchronised-storage-models:** Synchronize repo versions
160
243
 
161
- ## [0.0.1-next.5](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.4...synchronised-storage-models-v0.0.1-next.5) (2025-08-11)
244
+ ## [0.0.1-next.5](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.4...synchronised-storage-models-v0.0.1-next.5) (2025-08-11)
162
245
 
163
246
 
164
247
  ### Features
165
248
 
166
- * additional node identity checks ([76257c4](https://github.com/twinfoundation/synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
249
+ * additional node identity checks ([76257c4](https://github.com/iotaledger/twin-synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
167
250
 
168
251
 
169
252
  ### Bug Fixes
170
253
 
171
- * missing dependency ([cf4427e](https://github.com/twinfoundation/synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
254
+ * missing dependency ([cf4427e](https://github.com/iotaledger/twin-synchronised-storage/commit/cf4427edf6668b90aae9a9c1faafff13dffc2fc7))
172
255
 
173
- ## [0.0.1-next.4](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.3...synchronised-storage-models-v0.0.1-next.4) (2025-08-08)
256
+ ## [0.0.1-next.4](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.3...synchronised-storage-models-v0.0.1-next.4) (2025-08-08)
174
257
 
175
258
 
176
259
  ### Features
177
260
 
178
- * blob storage connector instead of component ([#7](https://github.com/twinfoundation/synchronised-storage/issues/7)) ([ea27241](https://github.com/twinfoundation/synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
261
+ * blob storage connector instead of component ([#7](https://github.com/iotaledger/twin-synchronised-storage/issues/7)) ([ea27241](https://github.com/iotaledger/twin-synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
179
262
 
180
- ## [0.0.1-next.3](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.2...synchronised-storage-models-v0.0.1-next.3) (2025-07-25)
263
+ ## [0.0.1-next.3](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.2...synchronised-storage-models-v0.0.1-next.3) (2025-07-25)
181
264
 
182
265
 
183
266
  ### Features
184
267
 
185
- * sync testing ([#5](https://github.com/twinfoundation/synchronised-storage/issues/5)) ([f78d5ac](https://github.com/twinfoundation/synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
268
+ * sync testing ([#5](https://github.com/iotaledger/twin-synchronised-storage/issues/5)) ([f78d5ac](https://github.com/iotaledger/twin-synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
186
269
 
187
- ## [0.0.1-next.2](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.1...synchronised-storage-models-v0.0.1-next.2) (2025-07-22)
270
+ ## [0.0.1-next.2](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.1...synchronised-storage-models-v0.0.1-next.2) (2025-07-22)
188
271
 
189
272
 
190
273
  ### Features
191
274
 
192
- * add async item requests to reduce storage overhead ([#3](https://github.com/twinfoundation/synchronised-storage/issues/3)) ([af4e17d](https://github.com/twinfoundation/synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
275
+ * add async item requests to reduce storage overhead ([#3](https://github.com/iotaledger/twin-synchronised-storage/issues/3)) ([af4e17d](https://github.com/iotaledger/twin-synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
193
276
 
194
- ## [0.0.1-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.0...synchronised-storage-models-v0.0.1-next.1) (2025-07-18)
277
+ ## [0.0.1-next.1](https://github.com/iotaledger/twin-synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.0...synchronised-storage-models-v0.0.1-next.1) (2025-07-18)
195
278
 
196
279
 
197
280
  ### Features
198
281
 
199
- * initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
282
+ * initial commit ([16949b8](https://github.com/iotaledger/twin-synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
200
283
 
201
- ## @twin.org/synchronised-storage-models - Changelog
284
+ ## Changelog