@twin.org/attestation-models 0.0.1-next.12 → 0.0.1-next.14

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.
@@ -25,10 +25,11 @@ export interface IAttestationComponent extends IComponent {
25
25
  * Transfer the attestation to a new holder.
26
26
  * @param attestationId The attestation to transfer.
27
27
  * @param holderIdentity The identity to transfer the attestation to.
28
+ * @param holderAddress The address to transfer the attestation to.
28
29
  * @param identity The identity to perform the attestation operation with.
29
30
  * @returns Nothing.
30
31
  */
31
- transfer(attestationId: string, holderIdentity: string, identity?: string): Promise<void>;
32
+ transfer(attestationId: string, holderIdentity: string, holderAddress: string, identity?: string): Promise<void>;
32
33
  /**
33
34
  * Destroy the attestation.
34
35
  * @param attestationId The attestation to transfer.
@@ -8,12 +8,11 @@ export interface IAttestationConnector extends IComponent {
8
8
  /**
9
9
  * Attest the data and return the collated information.
10
10
  * @param controller The controller identity of the user to access the vault keys.
11
- * @param address The controller address for the attestation.
12
11
  * @param verificationMethodId The identity verification method to use for attesting the data.
13
12
  * @param attestationObject The data to attest.
14
13
  * @returns The collated attestation data.
15
14
  */
16
- create(controller: string, address: string, verificationMethodId: string, attestationObject: IJsonLdNodeObject): Promise<string>;
15
+ create(controller: string, verificationMethodId: string, attestationObject: IJsonLdNodeObject): Promise<string>;
17
16
  /**
18
17
  * Resolve and verify the attestation id.
19
18
  * @param id The attestation id to verify.
@@ -7,7 +7,7 @@ export interface IAttestationTransferRequest {
7
7
  */
8
8
  pathParams: {
9
9
  /**
10
- * The attestation id to verify.
10
+ * The attestation id to transfer.
11
11
  */
12
12
  id: string;
13
13
  };
@@ -19,5 +19,9 @@ export interface IAttestationTransferRequest {
19
19
  * The new holder identity.
20
20
  */
21
21
  holderIdentity: string;
22
+ /**
23
+ * The new holder address.
24
+ */
25
+ holderAddress: string;
22
26
  };
23
27
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/attestation-models - Changelog
2
2
 
3
- ## v0.0.1-next.12
3
+ ## v0.0.1-next.14
4
4
 
5
5
  - Initial Release
@@ -78,7 +78,7 @@ The verified attestation details.
78
78
 
79
79
  ### transfer()
80
80
 
81
- > **transfer**(`attestationId`, `holderIdentity`, `identity`?): `Promise`\<`void`\>
81
+ > **transfer**(`attestationId`, `holderIdentity`, `holderAddress`, `identity`?): `Promise`\<`void`\>
82
82
 
83
83
  Transfer the attestation to a new holder.
84
84
 
@@ -96,6 +96,12 @@ The attestation to transfer.
96
96
 
97
97
  The identity to transfer the attestation to.
98
98
 
99
+ ##### holderAddress
100
+
101
+ `string`
102
+
103
+ The address to transfer the attestation to.
104
+
99
105
  ##### identity?
100
106
 
101
107
  `string`
@@ -10,7 +10,7 @@ Interface describing an attestation connector.
10
10
 
11
11
  ### create()
12
12
 
13
- > **create**(`controller`, `address`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
13
+ > **create**(`controller`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
14
14
 
15
15
  Attest the data and return the collated information.
16
16
 
@@ -22,12 +22,6 @@ Attest the data and return the collated information.
22
22
 
23
23
  The controller identity of the user to access the vault keys.
24
24
 
25
- ##### address
26
-
27
- `string`
28
-
29
- The controller address for the attestation.
30
-
31
25
  ##### verificationMethodId
32
26
 
33
27
  `string`
@@ -14,7 +14,7 @@ The parameters to be used in the transfer.
14
14
 
15
15
  > **id**: `string`
16
16
 
17
- The attestation id to verify.
17
+ The attestation id to transfer.
18
18
 
19
19
  ***
20
20
 
@@ -29,3 +29,9 @@ The parameters to be used in the transfer.
29
29
  > **holderIdentity**: `string`
30
30
 
31
31
  The new holder identity.
32
+
33
+ #### holderAddress
34
+
35
+ > **holderAddress**: `string`
36
+
37
+ The new holder address.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/attestation-models",
3
- "version": "0.0.1-next.12",
3
+ "version": "0.0.1-next.14",
4
4
  "description": "Models which define the structure of the attestation connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -27,9 +27,9 @@
27
27
  "types": "./dist/types/index.d.ts",
28
28
  "exports": {
29
29
  ".": {
30
+ "types": "./dist/types/index.d.ts",
30
31
  "require": "./dist/cjs/index.cjs",
31
- "import": "./dist/esm/index.mjs",
32
- "types": "./dist/types/index.d.ts"
32
+ "import": "./dist/esm/index.mjs"
33
33
  },
34
34
  "./locales/*.json": "./locales/*.json"
35
35
  },