@twin.org/immutable-proof-models 0.0.1-next.11 → 0.0.1-next.12
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/IImmutableProofComponent.d.ts +1 -2
- package/dist/types/models/api/IImmutableProofVerifyRequest.d.ts +0 -10
- package/docs/changelog.md +1 -1
- package/docs/reference/interfaces/IImmutableProofComponent.md +1 -5
- package/docs/reference/interfaces/IImmutableProofVerifyRequest.md +0 -14
- package/package.json +1 -1
|
@@ -24,11 +24,10 @@ export interface IImmutableProofComponent extends IComponent {
|
|
|
24
24
|
/**
|
|
25
25
|
* Verify an authentication proof.
|
|
26
26
|
* @param id The id of the proof to verify.
|
|
27
|
-
* @param proofObject The object to verify as JSON-LD.
|
|
28
27
|
* @returns The result of the verification and any failures.
|
|
29
28
|
* @throws NotFoundError if the proof is not found.
|
|
30
29
|
*/
|
|
31
|
-
verify(id: string
|
|
30
|
+
verify(id: string): Promise<IImmutableProofVerification>;
|
|
32
31
|
/**
|
|
33
32
|
* Remove the immutable storage for the proof.
|
|
34
33
|
* @param id The id of the proof to remove the storage from.
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
1
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
2
|
/**
|
|
4
3
|
* Verify a proof.
|
|
@@ -19,13 +18,4 @@ export interface IImmutableProofVerifyRequest {
|
|
|
19
18
|
*/
|
|
20
19
|
id: string;
|
|
21
20
|
};
|
|
22
|
-
/**
|
|
23
|
-
* The parameters from the body.
|
|
24
|
-
*/
|
|
25
|
-
body: {
|
|
26
|
-
/**
|
|
27
|
-
* The proof object to verify.
|
|
28
|
-
*/
|
|
29
|
-
proofObject: IJsonLdNodeObject;
|
|
30
|
-
};
|
|
31
21
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -62,7 +62,7 @@ NotFoundError if the proof is not found.
|
|
|
62
62
|
|
|
63
63
|
### verify()
|
|
64
64
|
|
|
65
|
-
> **verify**(`id
|
|
65
|
+
> **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
|
|
66
66
|
|
|
67
67
|
Verify an authentication proof.
|
|
68
68
|
|
|
@@ -72,10 +72,6 @@ Verify an authentication proof.
|
|
|
72
72
|
|
|
73
73
|
The id of the proof to verify.
|
|
74
74
|
|
|
75
|
-
• **proofObject**: `IJsonLdNodeObject`
|
|
76
|
-
|
|
77
|
-
The object to verify as JSON-LD.
|
|
78
|
-
|
|
79
75
|
#### Returns
|
|
80
76
|
|
|
81
77
|
`Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
|
|
@@ -27,17 +27,3 @@ The parameters from the path.
|
|
|
27
27
|
> **id**: `string`
|
|
28
28
|
|
|
29
29
|
The id of the immutable proof to verify.
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### body
|
|
34
|
-
|
|
35
|
-
> **body**: `object`
|
|
36
|
-
|
|
37
|
-
The parameters from the body.
|
|
38
|
-
|
|
39
|
-
#### proofObject
|
|
40
|
-
|
|
41
|
-
> **proofObject**: `IJsonLdNodeObject`
|
|
42
|
-
|
|
43
|
-
The proof object to verify.
|
package/package.json
CHANGED