@twin.org/attestation-models 0.0.1-next.15 → 0.0.1-next.16
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.
- package/dist/types/models/IAttestationComponent.d.ts +1 -2
- package/dist/types/models/api/IAttestationCreateRequest.d.ts +0 -4
- package/docs/changelog.md +1 -1
- package/docs/reference/interfaces/IAttestationComponent.md +1 -7
- package/docs/reference/interfaces/IAttestationCreateRequest.md +0 -6
- package/package.json +1 -1
@@ -7,14 +7,13 @@ import type { IAttestationInformation } from "./IAttestationInformation";
|
|
7
7
|
export interface IAttestationComponent extends IComponent {
|
8
8
|
/**
|
9
9
|
* Attest the data and return the collated information.
|
10
|
-
* @param verificationMethodId The identity verification method to use for attesting the data.
|
11
10
|
* @param attestationObject The data to attest.
|
12
11
|
* @param namespace The namespace of the connector to use for the attestation, defaults to component configured namespace.
|
13
12
|
* @param identity The identity to perform the attestation operation with.
|
14
13
|
* @param nodeIdentity The node identity to include in the attestation.
|
15
14
|
* @returns The id of the attestation.
|
16
15
|
*/
|
17
|
-
create(
|
16
|
+
create(attestationObject: IJsonLdNodeObject, namespace?: string, identity?: string, nodeIdentity?: string): Promise<string>;
|
18
17
|
/**
|
19
18
|
* Resolve and verify the attestation id.
|
20
19
|
* @param id The attestation id to verify.
|
package/docs/changelog.md
CHANGED
@@ -10,18 +10,12 @@ Interface describing an attestation contract.
|
|
10
10
|
|
11
11
|
### create()
|
12
12
|
|
13
|
-
> **create**(`
|
13
|
+
> **create**(`attestationObject`, `namespace`?, `identity`?, `nodeIdentity`?): `Promise`\<`string`\>
|
14
14
|
|
15
15
|
Attest the data and return the collated information.
|
16
16
|
|
17
17
|
#### Parameters
|
18
18
|
|
19
|
-
##### verificationMethodId
|
20
|
-
|
21
|
-
`string`
|
22
|
-
|
23
|
-
The identity verification method to use for attesting the data.
|
24
|
-
|
25
19
|
##### attestationObject
|
26
20
|
|
27
21
|
`IJsonLdNodeObject`
|
@@ -10,12 +10,6 @@ Attest the data and return the id of the attestation.
|
|
10
10
|
|
11
11
|
The data to be used in the signing.
|
12
12
|
|
13
|
-
#### verificationMethodId
|
14
|
-
|
15
|
-
> **verificationMethodId**: `string`
|
16
|
-
|
17
|
-
The identity verification method to use for attesting the data.
|
18
|
-
|
19
13
|
#### attestationObject
|
20
14
|
|
21
15
|
> **attestationObject**: `IJsonLdNodeObject`
|