@twin.org/immutable-proof-models 0.0.3-next.9 → 0.9.0
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/README.md +1 -1
- package/dist/es/dataTypes/immutableProofDataTypes.js +18 -7
- package/dist/es/dataTypes/immutableProofDataTypes.js.map +1 -1
- package/dist/es/index.js +4 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IImmutableProof.js.map +1 -1
- package/dist/es/models/IImmutableProofComponent.js.map +1 -1
- package/dist/es/models/IImmutableProofCredential.js +2 -0
- package/dist/es/models/IImmutableProofCredential.js.map +1 -0
- package/dist/es/models/IImmutableProofDataIntegrity.js +4 -0
- package/dist/es/models/IImmutableProofDataIntegrity.js.map +1 -0
- package/dist/es/models/IImmutableProofVerification.js.map +1 -1
- package/dist/es/models/api/IImmutableProofCreateRequest.js.map +1 -1
- package/dist/es/models/api/IImmutableProofGetResponse.js.map +1 -1
- package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js +4 -0
- package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js.map +1 -0
- package/dist/es/models/api/IImmutableProofRemoveRequest.js +4 -0
- package/dist/es/models/api/IImmutableProofRemoveRequest.js.map +1 -0
- package/dist/es/models/immutableProofTypes.js +4 -4
- package/dist/es/models/immutableProofTypes.js.map +1 -1
- package/dist/es/schemas/ImmutableProof.json +14 -16
- package/dist/es/schemas/ImmutableProofFailure.json +24 -0
- package/dist/es/schemas/ImmutableProofVerification.json +30 -0
- package/dist/types/index.d.ts +4 -1
- package/dist/types/models/IImmutableProof.d.ts +1 -1
- package/dist/types/models/IImmutableProofComponent.d.ts +18 -7
- package/dist/types/models/IImmutableProofCredential.d.ts +11 -0
- package/dist/types/models/IImmutableProofDataIntegrity.d.ts +10 -0
- package/dist/types/models/IImmutableProofVerification.d.ts +2 -2
- package/dist/types/models/api/IImmutableProofCreateRequest.d.ts +10 -0
- package/dist/types/models/api/IImmutableProofGetResponse.d.ts +2 -2
- package/dist/types/models/api/IImmutableProofRemoveNotarizationRequest.d.ts +14 -0
- package/dist/types/models/api/IImmutableProofRemoveRequest.d.ts +14 -0
- package/dist/types/models/immutableProofTypes.d.ts +4 -4
- package/docs/changelog.md +165 -47
- package/docs/examples.md +72 -1
- package/docs/reference/classes/ImmutableProofDataTypes.md +1 -1
- package/docs/reference/index.md +4 -1
- package/docs/reference/interfaces/IImmutableProof.md +7 -8
- package/docs/reference/interfaces/IImmutableProofComponent.md +47 -11
- package/docs/reference/interfaces/IImmutableProofCreateRequest.md +14 -1
- package/docs/reference/interfaces/IImmutableProofCredential.md +15 -0
- package/docs/reference/interfaces/IImmutableProofDataIntegrity.md +11 -0
- package/docs/reference/interfaces/IImmutableProofEventBusProofCreated.md +1 -1
- package/docs/reference/interfaces/IImmutableProofGetRequest.md +3 -3
- package/docs/reference/interfaces/IImmutableProofGetResponse.md +4 -4
- package/docs/reference/interfaces/IImmutableProofRemoveNotarizationRequest.md +17 -0
- package/docs/reference/interfaces/IImmutableProofRemoveRequest.md +17 -0
- package/docs/reference/interfaces/IImmutableProofVerification.md +5 -7
- package/docs/reference/interfaces/IImmutableProofVerifyRequest.md +3 -3
- package/docs/reference/interfaces/IImmutableProofVerifyResponse.md +3 -3
- package/docs/reference/variables/ImmutableProofContexts.md +6 -6
- package/docs/reference/variables/ImmutableProofFailure.md +4 -4
- package/docs/reference/variables/ImmutableProofTopics.md +1 -1
- package/docs/reference/variables/ImmutableProofTypes.md +7 -7
- package/package.json +11 -11
- package/dist/es/models/IImmutableProofReceipt.js +0 -2
- package/dist/es/models/IImmutableProofReceipt.js.map +0 -1
- package/dist/types/models/IImmutableProofReceipt.d.ts +0 -26
- package/docs/reference/interfaces/IImmutableProofReceipt.md +0 -37
package/docs/changelog.md
CHANGED
|
@@ -1,153 +1,271 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.0
|
|
3
|
+
## [0.9.0](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.9.0...immutable-proof-models-v0.9.0) (2026-06-25)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* release to production ([cb7ecff](https://github.com/iotaledger/twin-immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
|
|
9
|
+
* release to production ([#58](https://github.com/iotaledger/twin-immutable-proof/issues/58)) ([e1d8c04](https://github.com/iotaledger/twin-immutable-proof/commit/e1d8c04c4d2c764980ed44b320c3ce6218c9b70b))
|
|
10
|
+
|
|
11
|
+
## [0.9.0-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.9.0-next.0...immutable-proof-models-v0.9.0-next.1) (2026-06-24)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
|
|
17
|
+
* add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
|
|
18
|
+
* add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
|
|
19
|
+
* add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
|
|
20
|
+
* eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
|
|
21
|
+
* immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
|
|
22
|
+
* replace verifiable storage with notarization as immutable proof ([#41](https://github.com/iotaledger/twin-immutable-proof/issues/41)) ([54f2154](https://github.com/iotaledger/twin-immutable-proof/commit/54f215469b0bdc9ea94cad572ca13b8533144104))
|
|
23
|
+
* typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
|
|
24
|
+
* update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
|
|
25
|
+
* update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
|
|
26
|
+
* update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
|
|
27
|
+
* update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
|
|
28
|
+
* update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
|
|
29
|
+
* update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
|
|
30
|
+
* update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
|
|
31
|
+
* update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
|
|
32
|
+
* update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
|
|
33
|
+
* update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
|
|
34
|
+
* use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Bug Fixes
|
|
38
|
+
|
|
39
|
+
* Missing user and node identity on create ([#1](https://github.com/iotaledger/twin-immutable-proof/issues/1)) ([80ea2f9](https://github.com/iotaledger/twin-immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
|
|
40
|
+
* use async getStore in tests ([ec0b3b3](https://github.com/iotaledger/twin-immutable-proof/commit/ec0b3b38271fddf38a4b521cf871cc9cc01049f4))
|
|
41
|
+
|
|
42
|
+
## [0.0.3-next.17](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.16...immutable-proof-models-v0.0.3-next.17) (2026-06-11)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Miscellaneous Chores
|
|
46
|
+
|
|
47
|
+
* **immutable-proof-models:** Synchronize repo versions
|
|
48
|
+
|
|
49
|
+
## [0.0.3-next.16](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.15...immutable-proof-models-v0.0.3-next.16) (2026-05-29)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### Features
|
|
53
|
+
|
|
54
|
+
* add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
|
|
55
|
+
* add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
|
|
56
|
+
* add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
|
|
57
|
+
* add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
|
|
58
|
+
* eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
|
|
59
|
+
* immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
|
|
60
|
+
* replace verifiable storage with notarization as immutable proof ([#41](https://github.com/iotaledger/twin-immutable-proof/issues/41)) ([54f2154](https://github.com/iotaledger/twin-immutable-proof/commit/54f215469b0bdc9ea94cad572ca13b8533144104))
|
|
61
|
+
* typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
|
|
62
|
+
* update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
|
|
63
|
+
* update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
|
|
64
|
+
* update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
|
|
65
|
+
* update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
|
|
66
|
+
* update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
|
|
67
|
+
* update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
|
|
68
|
+
* update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
|
|
69
|
+
* update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
|
|
70
|
+
* update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
|
|
71
|
+
* update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
|
|
72
|
+
* use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Bug Fixes
|
|
76
|
+
|
|
77
|
+
* Missing user and node identity on create ([#1](https://github.com/iotaledger/twin-immutable-proof/issues/1)) ([80ea2f9](https://github.com/iotaledger/twin-immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
|
|
78
|
+
|
|
79
|
+
## [0.0.3-next.15](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.14...immutable-proof-models-v0.0.3-next.15) (2026-05-29)
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Features
|
|
83
|
+
|
|
84
|
+
* update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
|
|
85
|
+
|
|
86
|
+
## [0.0.3-next.14](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.13...immutable-proof-models-v0.0.3-next.14) (2026-05-28)
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### Features
|
|
90
|
+
|
|
91
|
+
* replace verifiable storage with notarization as immutable proof ([#41](https://github.com/iotaledger/twin-immutable-proof/issues/41)) ([54f2154](https://github.com/iotaledger/twin-immutable-proof/commit/54f215469b0bdc9ea94cad572ca13b8533144104))
|
|
92
|
+
|
|
93
|
+
## [0.0.3-next.13](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.12...immutable-proof-models-v0.0.3-next.13) (2026-05-20)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Features
|
|
97
|
+
|
|
98
|
+
* update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
|
|
99
|
+
|
|
100
|
+
## [0.0.3-next.12](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.11...immutable-proof-models-v0.0.3-next.12) (2026-05-12)
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Features
|
|
104
|
+
|
|
105
|
+
* typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
|
|
106
|
+
|
|
107
|
+
## [0.0.3-next.11](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.10...immutable-proof-models-v0.0.3-next.11) (2026-03-25)
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### Features
|
|
111
|
+
|
|
112
|
+
* add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
|
|
113
|
+
|
|
114
|
+
## [0.0.3-next.10](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.9...immutable-proof-models-v0.0.3-next.10) (2026-02-25)
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### Features
|
|
118
|
+
|
|
119
|
+
* update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
|
|
120
|
+
|
|
121
|
+
## [0.0.3-next.9](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.8...immutable-proof-models-v0.0.3-next.9) (2026-02-13)
|
|
4
122
|
|
|
5
123
|
|
|
6
124
|
### Miscellaneous Chores
|
|
7
125
|
|
|
8
126
|
* **immutable-proof-models:** Synchronize repo versions
|
|
9
127
|
|
|
10
|
-
## [0.0.3-next.8](https://github.com/
|
|
128
|
+
## [0.0.3-next.8](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.7...immutable-proof-models-v0.0.3-next.8) (2026-02-10)
|
|
11
129
|
|
|
12
130
|
|
|
13
131
|
### Features
|
|
14
132
|
|
|
15
|
-
* immutable proof as vc ([#31](https://github.com/
|
|
133
|
+
* immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
|
|
16
134
|
|
|
17
|
-
## [0.0.3-next.7](https://github.com/
|
|
135
|
+
## [0.0.3-next.7](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.6...immutable-proof-models-v0.0.3-next.7) (2026-02-05)
|
|
18
136
|
|
|
19
137
|
|
|
20
138
|
### Features
|
|
21
139
|
|
|
22
|
-
* add ts-to-jsonld-context tool ([871191b](https://github.com/
|
|
140
|
+
* add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
|
|
23
141
|
|
|
24
|
-
## [0.0.3-next.6](https://github.com/
|
|
142
|
+
## [0.0.3-next.6](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.5...immutable-proof-models-v0.0.3-next.6) (2026-01-21)
|
|
25
143
|
|
|
26
144
|
|
|
27
145
|
### Features
|
|
28
146
|
|
|
29
|
-
* update contexts ([#22](https://github.com/
|
|
147
|
+
* update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
|
|
30
148
|
|
|
31
|
-
## [0.0.3-next.5](https://github.com/
|
|
149
|
+
## [0.0.3-next.5](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.4...immutable-proof-models-v0.0.3-next.5) (2026-01-14)
|
|
32
150
|
|
|
33
151
|
|
|
34
152
|
### Features
|
|
35
153
|
|
|
36
|
-
* update contexts and namespaces ([#20](https://github.com/
|
|
154
|
+
* update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
|
|
37
155
|
|
|
38
|
-
## [0.0.3-next.4](https://github.com/
|
|
156
|
+
## [0.0.3-next.4](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.3...immutable-proof-models-v0.0.3-next.4) (2026-01-07)
|
|
39
157
|
|
|
40
158
|
|
|
41
159
|
### Miscellaneous Chores
|
|
42
160
|
|
|
43
161
|
* **immutable-proof-models:** Synchronize repo versions
|
|
44
162
|
|
|
45
|
-
## [0.0.3-next.3](https://github.com/
|
|
163
|
+
## [0.0.3-next.3](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.2...immutable-proof-models-v0.0.3-next.3) (2025-11-28)
|
|
46
164
|
|
|
47
165
|
|
|
48
166
|
### Miscellaneous Chores
|
|
49
167
|
|
|
50
168
|
* **immutable-proof-models:** Synchronize repo versions
|
|
51
169
|
|
|
52
|
-
## [0.0.3-next.2](https://github.com/
|
|
170
|
+
## [0.0.3-next.2](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.1...immutable-proof-models-v0.0.3-next.2) (2025-11-28)
|
|
53
171
|
|
|
54
172
|
|
|
55
173
|
### Miscellaneous Chores
|
|
56
174
|
|
|
57
175
|
* **immutable-proof-models:** Synchronize repo versions
|
|
58
176
|
|
|
59
|
-
## [0.0.3-next.1](https://github.com/
|
|
177
|
+
## [0.0.3-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.3-next.0...immutable-proof-models-v0.0.3-next.1) (2025-11-12)
|
|
60
178
|
|
|
61
179
|
|
|
62
180
|
### Features
|
|
63
181
|
|
|
64
|
-
* add context id features ([#14](https://github.com/
|
|
65
|
-
* add validate-locales ([d6a7c07](https://github.com/
|
|
66
|
-
* eslint migration to flat config ([c8536f2](https://github.com/
|
|
67
|
-
* update data types to use fully qualified names ([e94d0f5](https://github.com/
|
|
68
|
-
* update dependencies ([7d6b321](https://github.com/
|
|
69
|
-
* update framework core ([e708d4d](https://github.com/
|
|
70
|
-
* update ts-to-schema generation ([c4fc864](https://github.com/
|
|
71
|
-
* update twindev schemas ([d2bb94b](https://github.com/
|
|
72
|
-
* use shared store mechanism ([#3](https://github.com/
|
|
182
|
+
* add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
|
|
183
|
+
* add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
|
|
184
|
+
* eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
|
|
185
|
+
* update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
|
|
186
|
+
* update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
|
|
187
|
+
* update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
|
|
188
|
+
* update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
|
|
189
|
+
* update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
|
|
190
|
+
* use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
|
|
73
191
|
|
|
74
192
|
|
|
75
193
|
### Bug Fixes
|
|
76
194
|
|
|
77
|
-
* Missing user and node identity on create ([#1](https://github.com/
|
|
195
|
+
* Missing user and node identity on create ([#1](https://github.com/iotaledger/twin-immutable-proof/issues/1)) ([80ea2f9](https://github.com/iotaledger/twin-immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
|
|
78
196
|
|
|
79
|
-
## [0.0.2-next.3](https://github.com/
|
|
197
|
+
## [0.0.2-next.3](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.2-next.2...immutable-proof-models-v0.0.2-next.3) (2025-10-09)
|
|
80
198
|
|
|
81
199
|
|
|
82
200
|
### Features
|
|
83
201
|
|
|
84
|
-
* add validate-locales ([d6a7c07](https://github.com/
|
|
202
|
+
* add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
|
|
85
203
|
|
|
86
|
-
## [0.0.2-next.2](https://github.com/
|
|
204
|
+
## [0.0.2-next.2](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.2-next.1...immutable-proof-models-v0.0.2-next.2) (2025-08-29)
|
|
87
205
|
|
|
88
206
|
|
|
89
207
|
### Features
|
|
90
208
|
|
|
91
|
-
* eslint migration to flat config ([c8536f2](https://github.com/
|
|
209
|
+
* eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
|
|
92
210
|
|
|
93
|
-
## [0.0.2-next.1](https://github.com/
|
|
211
|
+
## [0.0.2-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.2-next.0...immutable-proof-models-v0.0.2-next.1) (2025-08-20)
|
|
94
212
|
|
|
95
213
|
|
|
96
214
|
### Features
|
|
97
215
|
|
|
98
|
-
* update data types to use fully qualified names ([e94d0f5](https://github.com/
|
|
99
|
-
* update dependencies ([7d6b321](https://github.com/
|
|
100
|
-
* update framework core ([e708d4d](https://github.com/
|
|
101
|
-
* update ts-to-schema generation ([c4fc864](https://github.com/
|
|
102
|
-
* update twindev schemas ([d2bb94b](https://github.com/
|
|
103
|
-
* use shared store mechanism ([#3](https://github.com/
|
|
216
|
+
* update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
|
|
217
|
+
* update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
|
|
218
|
+
* update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
|
|
219
|
+
* update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
|
|
220
|
+
* update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
|
|
221
|
+
* use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
|
|
104
222
|
|
|
105
223
|
|
|
106
224
|
### Bug Fixes
|
|
107
225
|
|
|
108
|
-
* Missing user and node identity on create ([#1](https://github.com/
|
|
226
|
+
* Missing user and node identity on create ([#1](https://github.com/iotaledger/twin-immutable-proof/issues/1)) ([80ea2f9](https://github.com/iotaledger/twin-immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
|
|
109
227
|
|
|
110
228
|
## 0.0.1 (2025-07-09)
|
|
111
229
|
|
|
112
230
|
|
|
113
231
|
### Features
|
|
114
232
|
|
|
115
|
-
* release to production ([cb7ecff](https://github.com/
|
|
233
|
+
* release to production ([cb7ecff](https://github.com/iotaledger/twin-immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
|
|
116
234
|
|
|
117
|
-
## [0.0.1-next.35](https://github.com/
|
|
235
|
+
## [0.0.1-next.35](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.1-next.34...immutable-proof-models-v0.0.1-next.35) (2025-06-12)
|
|
118
236
|
|
|
119
237
|
|
|
120
238
|
### Features
|
|
121
239
|
|
|
122
|
-
* update dependencies ([7d6b321](https://github.com/
|
|
240
|
+
* update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
|
|
123
241
|
|
|
124
|
-
## [0.0.1-next.34](https://github.com/
|
|
242
|
+
## [0.0.1-next.34](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.1-next.33...immutable-proof-models-v0.0.1-next.34) (2025-06-03)
|
|
125
243
|
|
|
126
244
|
|
|
127
245
|
### Features
|
|
128
246
|
|
|
129
|
-
* update ts-to-schema generation ([c4fc864](https://github.com/
|
|
247
|
+
* update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
|
|
130
248
|
|
|
131
|
-
## [0.0.1-next.33](https://github.com/
|
|
249
|
+
## [0.0.1-next.33](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.1-next.32...immutable-proof-models-v0.0.1-next.33) (2025-05-28)
|
|
132
250
|
|
|
133
251
|
|
|
134
252
|
### Features
|
|
135
253
|
|
|
136
|
-
* update data types to use fully qualified names ([e94d0f5](https://github.com/
|
|
254
|
+
* update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
|
|
137
255
|
|
|
138
|
-
## [0.0.1-next.32](https://github.com/
|
|
256
|
+
## [0.0.1-next.32](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.1-next.31...immutable-proof-models-v0.0.1-next.32) (2025-04-17)
|
|
139
257
|
|
|
140
258
|
|
|
141
259
|
### Features
|
|
142
260
|
|
|
143
|
-
* use shared store mechanism ([#3](https://github.com/
|
|
261
|
+
* use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
|
|
144
262
|
|
|
145
|
-
## [0.0.1-next.31](https://github.com/
|
|
263
|
+
## [0.0.1-next.31](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-models-v0.0.1-next.30...immutable-proof-models-v0.0.1-next.31) (2025-03-28)
|
|
146
264
|
|
|
147
265
|
|
|
148
266
|
### Bug Fixes
|
|
149
267
|
|
|
150
|
-
* Missing user and node identity on create ([#1](https://github.com/
|
|
268
|
+
* Missing user and node identity on create ([#1](https://github.com/iotaledger/twin-immutable-proof/issues/1)) ([80ea2f9](https://github.com/iotaledger/twin-immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
|
|
151
269
|
|
|
152
270
|
## v0.0.1-next.30
|
|
153
271
|
|
package/docs/examples.md
CHANGED
|
@@ -1 +1,72 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Immutable Proof Models Examples
|
|
2
|
+
|
|
3
|
+
These snippets show how to register data types and then use the immutable proof model contracts in request and response flows.
|
|
4
|
+
|
|
5
|
+
## ImmutableProofDataTypes
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
import { DataTypeHandlerFactory } from '@twin.org/data-core';
|
|
9
|
+
import { ImmutableProofDataTypes, ImmutableProofTypes } from '@twin.org/immutable-proof-models';
|
|
10
|
+
|
|
11
|
+
ImmutableProofDataTypes.registerTypes();
|
|
12
|
+
|
|
13
|
+
const handler = DataTypeHandlerFactory.get(
|
|
14
|
+
'https://schema.twindev.org/immutable-proof/ImmutableProof'
|
|
15
|
+
);
|
|
16
|
+
console.log(handler.type === ImmutableProofTypes.ImmutableProof); // true
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Model Contracts
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type {
|
|
23
|
+
IImmutableProofCreateRequest,
|
|
24
|
+
IImmutableProofGetResponse,
|
|
25
|
+
IImmutableProofVerifyResponse
|
|
26
|
+
} from '@twin.org/immutable-proof-models';
|
|
27
|
+
|
|
28
|
+
const createRequest: IImmutableProofCreateRequest = {
|
|
29
|
+
body: {
|
|
30
|
+
document: {
|
|
31
|
+
'@context': 'https://schema.org',
|
|
32
|
+
type: 'Person',
|
|
33
|
+
name: 'Alice Example'
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
console.log(createRequest.body.document.type); // Person
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { ImmutableProofFailure, ImmutableProofTypes } from '@twin.org/immutable-proof-models';
|
|
43
|
+
import type {
|
|
44
|
+
IImmutableProofGetResponse,
|
|
45
|
+
IImmutableProofVerifyResponse
|
|
46
|
+
} from '@twin.org/immutable-proof-models';
|
|
47
|
+
|
|
48
|
+
const getResponse: IImmutableProofGetResponse = {
|
|
49
|
+
body: {
|
|
50
|
+
'@context': ['https://www.w3.org/2018/credentials/v1'],
|
|
51
|
+
type: ['VerifiableCredential', ImmutableProofTypes.ImmutableProof],
|
|
52
|
+
issuer: 'did:iota:tst:issuer',
|
|
53
|
+
id: 'immutable-proof:01JABCDEF1234567890',
|
|
54
|
+
credentialSubject: {
|
|
55
|
+
id: 'https://example.org/documents/100',
|
|
56
|
+
proofIntegrity: 'yEr9VvYCGDh2Ww1YwQMehUy4LlW35mLhX8j8R8U6x0g='
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
const verifyResponse: IImmutableProofVerifyResponse = {
|
|
62
|
+
body: {
|
|
63
|
+
'@context': 'https://schema.twindev.org/immutable-proof',
|
|
64
|
+
type: ImmutableProofTypes.ImmutableProofVerification,
|
|
65
|
+
verified: false,
|
|
66
|
+
failure: ImmutableProofFailure.ProofMissing
|
|
67
|
+
}
|
|
68
|
+
};
|
|
69
|
+
|
|
70
|
+
console.log(getResponse.body.id); // immutable-proof:01JABCDEF1234567890
|
|
71
|
+
console.log(verifyResponse.body.failure); // proof-missing
|
|
72
|
+
```
|
package/docs/reference/index.md
CHANGED
|
@@ -8,11 +8,14 @@
|
|
|
8
8
|
|
|
9
9
|
- [IImmutableProof](interfaces/IImmutableProof.md)
|
|
10
10
|
- [IImmutableProofComponent](interfaces/IImmutableProofComponent.md)
|
|
11
|
-
- [
|
|
11
|
+
- [IImmutableProofCredential](interfaces/IImmutableProofCredential.md)
|
|
12
|
+
- [IImmutableProofDataIntegrity](interfaces/IImmutableProofDataIntegrity.md)
|
|
12
13
|
- [IImmutableProofVerification](interfaces/IImmutableProofVerification.md)
|
|
13
14
|
- [IImmutableProofCreateRequest](interfaces/IImmutableProofCreateRequest.md)
|
|
14
15
|
- [IImmutableProofGetRequest](interfaces/IImmutableProofGetRequest.md)
|
|
15
16
|
- [IImmutableProofGetResponse](interfaces/IImmutableProofGetResponse.md)
|
|
17
|
+
- [IImmutableProofRemoveNotarizationRequest](interfaces/IImmutableProofRemoveNotarizationRequest.md)
|
|
18
|
+
- [IImmutableProofRemoveRequest](interfaces/IImmutableProofRemoveRequest.md)
|
|
16
19
|
- [IImmutableProofVerifyRequest](interfaces/IImmutableProofVerifyRequest.md)
|
|
17
20
|
- [IImmutableProofVerifyResponse](interfaces/IImmutableProofVerifyResponse.md)
|
|
18
21
|
- [IImmutableProofEventBusProofCreated](interfaces/IImmutableProofEventBusProofCreated.md)
|
|
@@ -4,33 +4,32 @@ Interface describing an immutable proof state.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### @context?
|
|
7
|
+
### @context? {#context}
|
|
8
8
|
|
|
9
|
-
> `optional` **@context
|
|
9
|
+
> `optional` **@context?**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
|
|
10
10
|
|
|
11
11
|
JSON-LD Context.
|
|
12
12
|
|
|
13
13
|
***
|
|
14
14
|
|
|
15
|
-
### type?
|
|
15
|
+
### type? {#type}
|
|
16
16
|
|
|
17
|
-
> `optional` **type
|
|
17
|
+
> `optional` **type?**: `"ImmutableProof"`
|
|
18
18
|
|
|
19
19
|
JSON-LD Type.
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
### id?
|
|
23
|
+
### id? {#id}
|
|
24
24
|
|
|
25
|
-
> `optional` **id
|
|
25
|
+
> `optional` **id?**: `string`
|
|
26
26
|
|
|
27
27
|
The id of the object associated with the proof.
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
31
|
-
### proofIntegrity
|
|
31
|
+
### proofIntegrity {#proofintegrity}
|
|
32
32
|
|
|
33
33
|
> **proofIntegrity**: `string`
|
|
34
34
|
|
|
35
35
|
The integrity hash of the object associated with the proof.
|
|
36
|
-
json-ld namespace:twin-common
|
|
@@ -8,9 +8,9 @@ Interface describing an immutable proof contract.
|
|
|
8
8
|
|
|
9
9
|
## Methods
|
|
10
10
|
|
|
11
|
-
### create()
|
|
11
|
+
### create() {#create}
|
|
12
12
|
|
|
13
|
-
> **create**(`document`): `Promise`\<`string`\>
|
|
13
|
+
> **create**(`document`, `options?`): `Promise`\<`string`\>
|
|
14
14
|
|
|
15
15
|
Create a new proof.
|
|
16
16
|
|
|
@@ -22,6 +22,16 @@ Create a new proof.
|
|
|
22
22
|
|
|
23
23
|
The document to create the proof for.
|
|
24
24
|
|
|
25
|
+
##### options?
|
|
26
|
+
|
|
27
|
+
Optional settings for the proof.
|
|
28
|
+
|
|
29
|
+
###### deleteLock?
|
|
30
|
+
|
|
31
|
+
`string`
|
|
32
|
+
|
|
33
|
+
An ISO 8601 date-time string specifying when the notarization lock expires; if omitted no lock is applied.
|
|
34
|
+
|
|
25
35
|
#### Returns
|
|
26
36
|
|
|
27
37
|
`Promise`\<`string`\>
|
|
@@ -30,9 +40,9 @@ The id of the new proof.
|
|
|
30
40
|
|
|
31
41
|
***
|
|
32
42
|
|
|
33
|
-
### get()
|
|
43
|
+
### get() {#get}
|
|
34
44
|
|
|
35
|
-
> **get**(`id`): `Promise
|
|
45
|
+
> **get**(`id`): `Promise`\<[`IImmutableProofCredential`](IImmutableProofCredential.md)\>
|
|
36
46
|
|
|
37
47
|
Get a proof.
|
|
38
48
|
|
|
@@ -46,7 +56,7 @@ The id of the proof to get.
|
|
|
46
56
|
|
|
47
57
|
#### Returns
|
|
48
58
|
|
|
49
|
-
`Promise
|
|
59
|
+
`Promise`\<[`IImmutableProofCredential`](IImmutableProofCredential.md)\>
|
|
50
60
|
|
|
51
61
|
The proof.
|
|
52
62
|
|
|
@@ -56,7 +66,7 @@ NotFoundError if the proof is not found.
|
|
|
56
66
|
|
|
57
67
|
***
|
|
58
68
|
|
|
59
|
-
### verify()
|
|
69
|
+
### verify() {#verify}
|
|
60
70
|
|
|
61
71
|
> **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
|
|
62
72
|
|
|
@@ -82,11 +92,37 @@ NotFoundError if the proof is not found.
|
|
|
82
92
|
|
|
83
93
|
***
|
|
84
94
|
|
|
85
|
-
###
|
|
95
|
+
### remove() {#remove}
|
|
96
|
+
|
|
97
|
+
> **remove**(`id`): `Promise`\<`void`\>
|
|
98
|
+
|
|
99
|
+
Remove the proof and its notarization.
|
|
100
|
+
|
|
101
|
+
#### Parameters
|
|
102
|
+
|
|
103
|
+
##### id
|
|
104
|
+
|
|
105
|
+
`string`
|
|
106
|
+
|
|
107
|
+
The id of the proof to remove.
|
|
108
|
+
|
|
109
|
+
#### Returns
|
|
110
|
+
|
|
111
|
+
`Promise`\<`void`\>
|
|
112
|
+
|
|
113
|
+
A promise that resolves when the proof and its notarization have been removed.
|
|
114
|
+
|
|
115
|
+
#### Throws
|
|
116
|
+
|
|
117
|
+
NotFoundError if the proof is not found.
|
|
118
|
+
|
|
119
|
+
***
|
|
120
|
+
|
|
121
|
+
### removeNotarization() {#removenotarization}
|
|
86
122
|
|
|
87
|
-
> **
|
|
123
|
+
> **removeNotarization**(`id`): `Promise`\<`void`\>
|
|
88
124
|
|
|
89
|
-
Remove the
|
|
125
|
+
Remove only the notarization for the proof, keeping the proof entity.
|
|
90
126
|
|
|
91
127
|
#### Parameters
|
|
92
128
|
|
|
@@ -94,13 +130,13 @@ Remove the verifiable storage for the proof.
|
|
|
94
130
|
|
|
95
131
|
`string`
|
|
96
132
|
|
|
97
|
-
The id of the proof to remove the
|
|
133
|
+
The id of the proof to remove the notarization from.
|
|
98
134
|
|
|
99
135
|
#### Returns
|
|
100
136
|
|
|
101
137
|
`Promise`\<`void`\>
|
|
102
138
|
|
|
103
|
-
|
|
139
|
+
A promise that resolves when the notarization has been removed.
|
|
104
140
|
|
|
105
141
|
#### Throws
|
|
106
142
|
|
|
@@ -4,7 +4,7 @@ Create a proof.
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
|
-
### body
|
|
7
|
+
### body {#body}
|
|
8
8
|
|
|
9
9
|
> **body**: `object`
|
|
10
10
|
|
|
@@ -15,3 +15,16 @@ The parameters from the body.
|
|
|
15
15
|
> **document**: `IJsonLdNodeObject`
|
|
16
16
|
|
|
17
17
|
The document to create the proof for.
|
|
18
|
+
|
|
19
|
+
#### options?
|
|
20
|
+
|
|
21
|
+
> `optional` **options?**: `object`
|
|
22
|
+
|
|
23
|
+
Optional settings for the proof.
|
|
24
|
+
|
|
25
|
+
##### options.deleteLock?
|
|
26
|
+
|
|
27
|
+
> `optional` **deleteLock?**: `string`
|
|
28
|
+
|
|
29
|
+
An ISO 8601 date-time string specifying when the notarization lock expires.
|
|
30
|
+
If omitted, no deletion lock is applied.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Interface: IImmutableProofCredential
|
|
2
|
+
|
|
3
|
+
Interface describing an immutable proof credential.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- `Omit`\<`IDidVerifiableCredential`, `"proof"`\>
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### proof? {#proof}
|
|
12
|
+
|
|
13
|
+
> `optional` **proof?**: IProof & IImmutableProofDataIntegrity
|
|
14
|
+
|
|
15
|
+
The proof of the verifiable credential, which includes the data integrity information.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Interface: IImmutableProofDataIntegrity
|
|
2
|
+
|
|
3
|
+
Interface describing additional data integrity fields attached to an immutable proof.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### notarizationId? {#notarizationid}
|
|
8
|
+
|
|
9
|
+
> `optional` **notarizationId?**: `string`
|
|
10
|
+
|
|
11
|
+
The notarization id.
|