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

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 (5) hide show
  1. package/dist/es/models/ISynchronisedStorageComponent.js.map +1 -1
  2. package/dist/types/models/ISynchronisedStorageComponent.d.ts +4 -5
  3. package/docs/changelog.md +14 -0
  4. package/docs/reference/interfaces/ISynchronisedStorageComponent.md +8 -8
  5. package/package.json +1 -1
package/dist/es/models/ISynchronisedStorageComponent.js.map CHANGED
@@ -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 { IIdentityAuthenticationActionRequest } from \"@twin.org/identity-authentication\";\nimport type { ISyncChangeSet } from \"./ISyncChangeSet.js\";\n\n/**\n * Class for performing synchronised storage operations.\n */\nexport interface ISynchronisedStorageComponent extends IComponent {\n\t/**\n\t * Get the decryption key for the synchronised storage.\n\t * This is used to decrypt the data stored in the synchronised storage.\n\t * @param actionRequest The action request used in the verifiable credential.\n\t * @returns The decryption key.\n\t */\n\tgetDecryptionKey(actionRequest: IIdentityAuthenticationActionRequest): Promise<string>;\n\n\t/**\n\t * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.\n\t * @param syncChangeSet The change set to synchronise.\n\t * @param actionRequest The action request used in the verifiable credential.\n\t * @returns Nothing.\n\t */\n\tsyncChangeSet(\n\t\tsyncChangeSet: ISyncChangeSet,\n\t\tactionRequest: IIdentityAuthenticationActionRequest\n\t): Promise<void>;\n}\n"]}
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"]}
package/dist/types/models/ISynchronisedStorageComponent.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  import type { IComponent } from "@twin.org/core";
2
- import type { IIdentityAuthenticationActionRequest } from "@twin.org/identity-authentication";
3
2
  import type { ISyncChangeSet } from "./ISyncChangeSet.js";
4
3
  /**
5
4
  * Class for performing synchronised storage operations.
@@ -8,15 +7,15 @@ export interface ISynchronisedStorageComponent extends IComponent {
8
7
  /**
9
8
  * Get the decryption key for the synchronised storage.
10
9
  * This is used to decrypt the data stored in the synchronised storage.
11
- * @param actionRequest The action request used in the verifiable credential.
10
+ * @param trustPayload Trust payload to verify the requesters identity.
12
11
  * @returns The decryption key.
13
12
  */
14
- getDecryptionKey(actionRequest: IIdentityAuthenticationActionRequest): Promise<string>;
13
+ getDecryptionKey(trustPayload: unknown): Promise<string>;
15
14
  /**
16
15
  * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
17
16
  * @param syncChangeSet The change set to synchronise.
18
- * @param actionRequest The action request used in the verifiable credential.
17
+ * @param trustPayload Trust payload to verify the requesters identity.
19
18
  * @returns Nothing.
20
19
  */
21
- syncChangeSet(syncChangeSet: ISyncChangeSet, actionRequest: IIdentityAuthenticationActionRequest): Promise<void>;
20
+ syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
22
21
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [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)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **synchronised-storage-models:** Synchronize repo versions
9
+
10
+ ## [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)
11
+
12
+
13
+ ### Features
14
+
15
+ * use trust component ([424f0d6](https://github.com/twinfoundation/synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
16
+
3
17
  ## [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)
4
18
 
5
19
 
package/docs/reference/interfaces/ISynchronisedStorageComponent.md CHANGED
@@ -10,18 +10,18 @@ Class for performing synchronised storage operations.
10
10
 
11
11
  ### getDecryptionKey()
12
12
 
13
- > **getDecryptionKey**(`actionRequest`): `Promise`\<`string`\>
13
+ > **getDecryptionKey**(`trustPayload`): `Promise`\<`string`\>
14
14
 
15
15
  Get the decryption key for the synchronised storage.
16
16
  This is used to decrypt the data stored in the synchronised storage.
17
17
 
18
18
  #### Parameters
19
19
 
20
- ##### actionRequest
20
+ ##### trustPayload
21
21
 
22
- `IIdentityAuthenticationActionRequest`
22
+ `unknown`
23
23
 
24
- The action request used in the verifiable credential.
24
+ Trust payload to verify the requesters identity.
25
25
 
26
26
  #### Returns
27
27
 
@@ -33,7 +33,7 @@ The decryption key.
33
33
 
34
34
  ### syncChangeSet()
35
35
 
36
- > **syncChangeSet**(`syncChangeSet`, `actionRequest`): `Promise`\<`void`\>
36
+ > **syncChangeSet**(`syncChangeSet`, `trustPayload`): `Promise`\<`void`\>
37
37
 
38
38
  Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
39
39
 
@@ -45,11 +45,11 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
45
45
 
46
46
  The change set to synchronise.
47
47
 
48
- ##### actionRequest
48
+ ##### trustPayload
49
49
 
50
- `IIdentityAuthenticationActionRequest`
50
+ `unknown`
51
51
 
52
- The action request used in the verifiable credential.
52
+ Trust payload to verify the requesters identity.
53
53
 
54
54
  #### Returns
55
55
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/synchronised-storage-models",
3
- "version": "0.0.3-next.1",
3
+ "version": "0.0.3-next.3",
4
4
  "description": "Models which define the structure of the synchronised storage connectors and services",
5
5
  "repository": {
6
6
  "type": "git",