@twin.org/immutable-proof-models 0.0.3-next.8 → 0.9.0-next.1

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 (60) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/immutableProofDataTypes.js +18 -7
  3. package/dist/es/dataTypes/immutableProofDataTypes.js.map +1 -1
  4. package/dist/es/index.js +4 -1
  5. package/dist/es/index.js.map +1 -1
  6. package/dist/es/models/IImmutableProof.js.map +1 -1
  7. package/dist/es/models/IImmutableProofComponent.js.map +1 -1
  8. package/dist/es/models/IImmutableProofCredential.js +2 -0
  9. package/dist/es/models/IImmutableProofCredential.js.map +1 -0
  10. package/dist/es/models/IImmutableProofDataIntegrity.js +4 -0
  11. package/dist/es/models/IImmutableProofDataIntegrity.js.map +1 -0
  12. package/dist/es/models/IImmutableProofVerification.js.map +1 -1
  13. package/dist/es/models/api/IImmutableProofCreateRequest.js.map +1 -1
  14. package/dist/es/models/api/IImmutableProofGetResponse.js.map +1 -1
  15. package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js +4 -0
  16. package/dist/es/models/api/IImmutableProofRemoveNotarizationRequest.js.map +1 -0
  17. package/dist/es/models/api/IImmutableProofRemoveRequest.js +4 -0
  18. package/dist/es/models/api/IImmutableProofRemoveRequest.js.map +1 -0
  19. package/dist/es/models/immutableProofTypes.js +4 -4
  20. package/dist/es/models/immutableProofTypes.js.map +1 -1
  21. package/dist/es/schemas/ImmutableProof.json +14 -16
  22. package/dist/es/schemas/ImmutableProofFailure.json +24 -0
  23. package/dist/es/schemas/ImmutableProofVerification.json +30 -0
  24. package/dist/types/index.d.ts +4 -1
  25. package/dist/types/models/IImmutableProof.d.ts +1 -1
  26. package/dist/types/models/IImmutableProofComponent.d.ts +18 -7
  27. package/dist/types/models/IImmutableProofCredential.d.ts +11 -0
  28. package/dist/types/models/IImmutableProofDataIntegrity.d.ts +10 -0
  29. package/dist/types/models/IImmutableProofVerification.d.ts +2 -2
  30. package/dist/types/models/api/IImmutableProofCreateRequest.d.ts +10 -0
  31. package/dist/types/models/api/IImmutableProofGetResponse.d.ts +2 -2
  32. package/dist/types/models/api/IImmutableProofRemoveNotarizationRequest.d.ts +14 -0
  33. package/dist/types/models/api/IImmutableProofRemoveRequest.d.ts +14 -0
  34. package/dist/types/models/immutableProofTypes.d.ts +4 -4
  35. package/docs/changelog.md +163 -46
  36. package/docs/examples.md +72 -1
  37. package/docs/reference/classes/ImmutableProofDataTypes.md +1 -1
  38. package/docs/reference/index.md +4 -1
  39. package/docs/reference/interfaces/IImmutableProof.md +7 -8
  40. package/docs/reference/interfaces/IImmutableProofComponent.md +47 -11
  41. package/docs/reference/interfaces/IImmutableProofCreateRequest.md +14 -1
  42. package/docs/reference/interfaces/IImmutableProofCredential.md +15 -0
  43. package/docs/reference/interfaces/IImmutableProofDataIntegrity.md +11 -0
  44. package/docs/reference/interfaces/IImmutableProofEventBusProofCreated.md +1 -1
  45. package/docs/reference/interfaces/IImmutableProofGetRequest.md +3 -3
  46. package/docs/reference/interfaces/IImmutableProofGetResponse.md +4 -4
  47. package/docs/reference/interfaces/IImmutableProofRemoveNotarizationRequest.md +17 -0
  48. package/docs/reference/interfaces/IImmutableProofRemoveRequest.md +17 -0
  49. package/docs/reference/interfaces/IImmutableProofVerification.md +5 -7
  50. package/docs/reference/interfaces/IImmutableProofVerifyRequest.md +3 -3
  51. package/docs/reference/interfaces/IImmutableProofVerifyResponse.md +3 -3
  52. package/docs/reference/variables/ImmutableProofContexts.md +6 -6
  53. package/docs/reference/variables/ImmutableProofFailure.md +4 -4
  54. package/docs/reference/variables/ImmutableProofTopics.md +1 -1
  55. package/docs/reference/variables/ImmutableProofTypes.md +7 -7
  56. package/package.json +11 -11
  57. package/dist/es/models/IImmutableProofReceipt.js +0 -2
  58. package/dist/es/models/IImmutableProofReceipt.js.map +0 -1
  59. package/dist/types/models/IImmutableProofReceipt.d.ts +0 -26
  60. package/docs/reference/interfaces/IImmutableProofReceipt.md +0 -37
package/docs/changelog.md CHANGED
@@ -1,146 +1,263 @@
1
- # @twin.org/immutable-proof-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.8](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.7...immutable-proof-models-v0.0.3-next.8) (2026-02-10)
3
+ ## [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)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * immutable proof as vc ([#31](https://github.com/twinfoundation/immutable-proof/issues/31)) ([79cdb03](https://github.com/twinfoundation/immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
8
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
9
+ * add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
10
+ * add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
11
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
12
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
13
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
14
+ * 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))
15
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
16
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
17
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
18
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
19
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
20
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
21
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
22
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
23
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
24
+ * update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
25
+ * update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
26
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
9
27
 
10
- ## [0.0.3-next.7](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.6...immutable-proof-models-v0.0.3-next.7) (2026-02-05)
28
+
29
+ ### Bug Fixes
30
+
31
+ * 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))
32
+ * use async getStore in tests ([ec0b3b3](https://github.com/iotaledger/twin-immutable-proof/commit/ec0b3b38271fddf38a4b521cf871cc9cc01049f4))
33
+
34
+ ## [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)
35
+
36
+
37
+ ### Miscellaneous Chores
38
+
39
+ * **immutable-proof-models:** Synchronize repo versions
40
+
41
+ ## [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)
42
+
43
+
44
+ ### Features
45
+
46
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
47
+ * add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
48
+ * add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
49
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
50
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
51
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
52
+ * 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))
53
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
54
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
55
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
56
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
57
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
58
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
59
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
60
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
61
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
62
+ * update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
63
+ * update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
64
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
65
+
66
+
67
+ ### Bug Fixes
68
+
69
+ * 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))
70
+
71
+ ## [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)
72
+
73
+
74
+ ### Features
75
+
76
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
77
+
78
+ ## [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)
79
+
80
+
81
+ ### Features
82
+
83
+ * 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))
84
+
85
+ ## [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)
86
+
87
+
88
+ ### Features
89
+
90
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
91
+
92
+ ## [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)
93
+
94
+
95
+ ### Features
96
+
97
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
98
+
99
+ ## [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)
100
+
101
+
102
+ ### Features
103
+
104
+ * add missing proof type registration ([1e9f52b](https://github.com/iotaledger/twin-immutable-proof/commit/1e9f52b88ab201e97c9d2aa7611fb8f77a82d614))
105
+
106
+ ## [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)
107
+
108
+
109
+ ### Features
110
+
111
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
112
+
113
+ ## [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)
114
+
115
+
116
+ ### Miscellaneous Chores
117
+
118
+ * **immutable-proof-models:** Synchronize repo versions
119
+
120
+ ## [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)
121
+
122
+
123
+ ### Features
124
+
125
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
126
+
127
+ ## [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)
11
128
 
12
129
 
13
130
  ### Features
14
131
 
15
- * add ts-to-jsonld-context tool ([871191b](https://github.com/twinfoundation/immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
132
+ * add ts-to-jsonld-context tool ([871191b](https://github.com/iotaledger/twin-immutable-proof/commit/871191b75cb82c2f6daaab08a71384ba92f02a64))
16
133
 
17
- ## [0.0.3-next.6](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.5...immutable-proof-models-v0.0.3-next.6) (2026-01-21)
134
+ ## [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)
18
135
 
19
136
 
20
137
  ### Features
21
138
 
22
- * update contexts ([#22](https://github.com/twinfoundation/immutable-proof/issues/22)) ([645b880](https://github.com/twinfoundation/immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
139
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
23
140
 
24
- ## [0.0.3-next.5](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.4...immutable-proof-models-v0.0.3-next.5) (2026-01-14)
141
+ ## [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)
25
142
 
26
143
 
27
144
  ### Features
28
145
 
29
- * update contexts and namespaces ([#20](https://github.com/twinfoundation/immutable-proof/issues/20)) ([d38aa69](https://github.com/twinfoundation/immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
146
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
30
147
 
31
- ## [0.0.3-next.4](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.3...immutable-proof-models-v0.0.3-next.4) (2026-01-07)
148
+ ## [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)
32
149
 
33
150
 
34
151
  ### Miscellaneous Chores
35
152
 
36
153
  * **immutable-proof-models:** Synchronize repo versions
37
154
 
38
- ## [0.0.3-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.2...immutable-proof-models-v0.0.3-next.3) (2025-11-28)
155
+ ## [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)
39
156
 
40
157
 
41
158
  ### Miscellaneous Chores
42
159
 
43
160
  * **immutable-proof-models:** Synchronize repo versions
44
161
 
45
- ## [0.0.3-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.1...immutable-proof-models-v0.0.3-next.2) (2025-11-28)
162
+ ## [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)
46
163
 
47
164
 
48
165
  ### Miscellaneous Chores
49
166
 
50
167
  * **immutable-proof-models:** Synchronize repo versions
51
168
 
52
- ## [0.0.3-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.3-next.0...immutable-proof-models-v0.0.3-next.1) (2025-11-12)
169
+ ## [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)
53
170
 
54
171
 
55
172
  ### Features
56
173
 
57
- * add context id features ([#14](https://github.com/twinfoundation/immutable-proof/issues/14)) ([ed5a594](https://github.com/twinfoundation/immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
58
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
59
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
60
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
61
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
62
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
63
- * update ts-to-schema generation ([c4fc864](https://github.com/twinfoundation/immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
64
- * update twindev schemas ([d2bb94b](https://github.com/twinfoundation/immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
65
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
174
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
175
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
176
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
177
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
178
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
179
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
180
+ * update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
181
+ * update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
182
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
66
183
 
67
184
 
68
185
  ### Bug Fixes
69
186
 
70
- * Missing user and node identity on create ([#1](https://github.com/twinfoundation/immutable-proof/issues/1)) ([80ea2f9](https://github.com/twinfoundation/immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
187
+ * 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))
71
188
 
72
- ## [0.0.2-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.2-next.2...immutable-proof-models-v0.0.2-next.3) (2025-10-09)
189
+ ## [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)
73
190
 
74
191
 
75
192
  ### Features
76
193
 
77
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
194
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
78
195
 
79
- ## [0.0.2-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.2-next.1...immutable-proof-models-v0.0.2-next.2) (2025-08-29)
196
+ ## [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)
80
197
 
81
198
 
82
199
  ### Features
83
200
 
84
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
201
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
85
202
 
86
- ## [0.0.2-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.2-next.0...immutable-proof-models-v0.0.2-next.1) (2025-08-20)
203
+ ## [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)
87
204
 
88
205
 
89
206
  ### Features
90
207
 
91
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
92
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
93
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
94
- * update ts-to-schema generation ([c4fc864](https://github.com/twinfoundation/immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
95
- * update twindev schemas ([d2bb94b](https://github.com/twinfoundation/immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
96
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
208
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
209
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
210
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
211
+ * update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
212
+ * update twindev schemas ([d2bb94b](https://github.com/iotaledger/twin-immutable-proof/commit/d2bb94b31e61f899e41dbca1b1aeb2b3bb70b229))
213
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
97
214
 
98
215
 
99
216
  ### Bug Fixes
100
217
 
101
- * Missing user and node identity on create ([#1](https://github.com/twinfoundation/immutable-proof/issues/1)) ([80ea2f9](https://github.com/twinfoundation/immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
218
+ * 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))
102
219
 
103
220
  ## 0.0.1 (2025-07-09)
104
221
 
105
222
 
106
223
  ### Features
107
224
 
108
- * release to production ([cb7ecff](https://github.com/twinfoundation/immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
225
+ * release to production ([cb7ecff](https://github.com/iotaledger/twin-immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
109
226
 
110
- ## [0.0.1-next.35](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.34...immutable-proof-models-v0.0.1-next.35) (2025-06-12)
227
+ ## [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)
111
228
 
112
229
 
113
230
  ### Features
114
231
 
115
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
232
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
116
233
 
117
- ## [0.0.1-next.34](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.33...immutable-proof-models-v0.0.1-next.34) (2025-06-03)
234
+ ## [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)
118
235
 
119
236
 
120
237
  ### Features
121
238
 
122
- * update ts-to-schema generation ([c4fc864](https://github.com/twinfoundation/immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
239
+ * update ts-to-schema generation ([c4fc864](https://github.com/iotaledger/twin-immutable-proof/commit/c4fc8646e7b8ee040d356f7f0f3b2d6f4ac63e40))
123
240
 
124
- ## [0.0.1-next.33](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.32...immutable-proof-models-v0.0.1-next.33) (2025-05-28)
241
+ ## [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)
125
242
 
126
243
 
127
244
  ### Features
128
245
 
129
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
246
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
130
247
 
131
- ## [0.0.1-next.32](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.31...immutable-proof-models-v0.0.1-next.32) (2025-04-17)
248
+ ## [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)
132
249
 
133
250
 
134
251
  ### Features
135
252
 
136
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
253
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
137
254
 
138
- ## [0.0.1-next.31](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-models-v0.0.1-next.30...immutable-proof-models-v0.0.1-next.31) (2025-03-28)
255
+ ## [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)
139
256
 
140
257
 
141
258
  ### Bug Fixes
142
259
 
143
- * Missing user and node identity on create ([#1](https://github.com/twinfoundation/immutable-proof/issues/1)) ([80ea2f9](https://github.com/twinfoundation/immutable-proof/commit/80ea2f901afc7531f4a522227a61e6fa1482484d))
260
+ * 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))
144
261
 
145
262
  ## v0.0.1-next.30
146
263
 
package/docs/examples.md CHANGED
@@ -1 +1,72 @@
1
- # @twin.org/immutable-proof-models - Examples
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
+ ```
@@ -14,7 +14,7 @@ Handle all the data types for immutable proof.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### registerTypes()
17
+ ### registerTypes() {#registertypes}
18
18
 
19
19
  > `static` **registerTypes**(): `void`
20
20
 
@@ -8,11 +8,14 @@
8
8
 
9
9
  - [IImmutableProof](interfaces/IImmutableProof.md)
10
10
  - [IImmutableProofComponent](interfaces/IImmutableProofComponent.md)
11
- - [IImmutableProofReceipt](interfaces/IImmutableProofReceipt.md)
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**: \[`"https://schema.twindev.org/immutable-proof/"`, `"https://schema.twindev.org/common/"`\]
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**: `"ImmutableProof"`
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**: `string`
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`\<`IDidVerifiableCredential`\>
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`\<`IDidVerifiableCredential`\>
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
- ### removeVerifiable()
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
- > **removeVerifiable**(`id`): `Promise`\<`void`\>
123
+ > **removeNotarization**(`id`): `Promise`\<`void`\>
88
124
 
89
- Remove the verifiable storage for the proof.
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 storage from.
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
- Nothing.
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.
@@ -4,7 +4,7 @@ Event bus payload for proof created.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### id
7
+ ### id {#id}
8
8
 
9
9
  > **id**: `string`
10
10