@twin.org/immutable-proof-models 0.0.1-next.14 → 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.
Files changed (4) hide show
  1. package/docs/changelog.md +1 -1
  2. package/docs/reference/interfaces/IImmutableProof.md +1 -1
  3. package/docs/reference/interfaces/IImmutableProofComponent.md +21 -7
  4. package/package.json +3 -3
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/immutable-proof-models - Changelog
2
2
 
3
- ## v0.0.1-next.14
3
+ ## v0.0.1-next.16
4
4
 
5
5
  - Initial Release
package/docs/reference/interfaces/IImmutableProof.md CHANGED
@@ -6,7 +6,7 @@ Interface describing an immutable proof state.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/immutable-proof/"` \| [`"https://schema.twindev.org/immutable-proof/"`, `...string[]`]
9
+ > **@context**: `"https://schema.twindev.org/immutable-proof/"` \| \[`"https://schema.twindev.org/immutable-proof/"`, `...string[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
package/docs/reference/interfaces/IImmutableProofComponent.md CHANGED
@@ -16,15 +16,21 @@ Create a new authentication proof.
16
16
 
17
17
  #### Parameters
18
18
 
19
- • **proofObject**: `IJsonLdNodeObject`
19
+ ##### proofObject
20
+
21
+ `IJsonLdNodeObject`
20
22
 
21
23
  The object for the proof as JSON-LD.
22
24
 
23
- • **userIdentity?**: `string`
25
+ ##### userIdentity?
26
+
27
+ `string`
24
28
 
25
29
  The identity to create the immutable proof operation with.
26
30
 
27
- • **nodeIdentity?**: `string`
31
+ ##### nodeIdentity?
32
+
33
+ `string`
28
34
 
29
35
  The node identity to use for vault operations.
30
36
 
@@ -44,7 +50,9 @@ Get an authentication proof.
44
50
 
45
51
  #### Parameters
46
52
 
47
- • **id**: `string`
53
+ ##### id
54
+
55
+ `string`
48
56
 
49
57
  The id of the proof to get.
50
58
 
@@ -68,7 +76,9 @@ Verify an authentication proof.
68
76
 
69
77
  #### Parameters
70
78
 
71
- • **id**: `string`
79
+ ##### id
80
+
81
+ `string`
72
82
 
73
83
  The id of the proof to verify.
74
84
 
@@ -92,11 +102,15 @@ Remove the immutable storage for the proof.
92
102
 
93
103
  #### Parameters
94
104
 
95
- • **id**: `string`
105
+ ##### id
106
+
107
+ `string`
96
108
 
97
109
  The id of the proof to remove the storage from.
98
110
 
99
- • **nodeIdentity?**: `string`
111
+ ##### nodeIdentity?
112
+
113
+ `string`
100
114
 
101
115
  The node identity to use for vault operations.
102
116
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/immutable-proof-models",
3
- "version": "0.0.1-next.14",
3
+ "version": "0.0.1-next.16",
4
4
  "description": "Models which define the structure of the immutable proof 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
  },