@twin.org/immutable-proof-service 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 (30) hide show
  1. package/README.md +1 -1
  2. package/dist/es/entities/immutableProof.js +3 -3
  3. package/dist/es/entities/immutableProof.js.map +1 -1
  4. package/dist/es/immutableProofRoutes.js +98 -14
  5. package/dist/es/immutableProofRoutes.js.map +1 -1
  6. package/dist/es/immutableProofService.js +78 -39
  7. package/dist/es/immutableProofService.js.map +1 -1
  8. package/dist/es/models/IImmutableProofServiceConstructorOptions.js.map +1 -1
  9. package/dist/es/restEntryPoints.js +3 -0
  10. package/dist/es/restEntryPoints.js.map +1 -1
  11. package/dist/types/entities/immutableProof.d.ts +2 -2
  12. package/dist/types/immutableProofRoutes.d.ts +20 -4
  13. package/dist/types/immutableProofService.d.ts +20 -10
  14. package/dist/types/models/IImmutableProofServiceConstructorOptions.d.ts +3 -4
  15. package/dist/types/restEntryPoints.d.ts +3 -0
  16. package/docs/changelog.md +247 -45
  17. package/docs/examples.md +127 -1
  18. package/docs/open-api/spec.json +216 -692
  19. package/docs/reference/classes/ImmutableProof.md +11 -11
  20. package/docs/reference/classes/ImmutableProofService.md +57 -17
  21. package/docs/reference/functions/immutableProofGet.md +1 -1
  22. package/docs/reference/functions/immutableProofRemove.md +31 -0
  23. package/docs/reference/functions/immutableProofRemoveNotarization.md +31 -0
  24. package/docs/reference/functions/immutableProofVerify.md +1 -1
  25. package/docs/reference/index.md +2 -0
  26. package/docs/reference/interfaces/IImmutableProofServiceConfig.md +2 -2
  27. package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md +16 -22
  28. package/docs/reference/variables/restEntryPoints.md +2 -0
  29. package/locales/en.json +2 -1
  30. package/package.json +22 -22
package/docs/changelog.md CHANGED
@@ -1,11 +1,213 @@
1
- # @twin.org/immutable-proof-service - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.8](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.7...immutable-proof-service-v0.0.3-next.8) (2026-02-10)
3
+ ## [0.9.0-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.9.0-next.0...immutable-proof-service-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 logging ([#18](https://github.com/iotaledger/twin-immutable-proof/issues/18)) ([e331ce8](https://github.com/iotaledger/twin-immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
10
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
11
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
12
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
13
+ * remove default loggers ([1f59001](https://github.com/iotaledger/twin-immutable-proof/commit/1f59001038a9b83b5e3675c4cee2c4131023e9ff))
14
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
15
+ * remove vm linkage in on chain proof ([4034336](https://github.com/iotaledger/twin-immutable-proof/commit/4034336177261dcf3b017524a56f3f6537545227))
16
+ * 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))
17
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
18
+ * update background tasks ([f25741c](https://github.com/iotaledger/twin-immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
19
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
20
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
21
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
22
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
23
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
24
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
25
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
26
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
27
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
28
+
29
+
30
+ ### Bug Fixes
31
+
32
+ * constructor component name ([06ea7c3](https://github.com/iotaledger/twin-immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
33
+ * 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))
34
+ * register platform mock in immutable proof service tests ([#52](https://github.com/iotaledger/twin-immutable-proof/issues/52)) ([b9575d3](https://github.com/iotaledger/twin-immutable-proof/commit/b9575d3d79de9abad08692831f751d1aab20c0b5))
35
+ * test mocks ([c89f465](https://github.com/iotaledger/twin-immutable-proof/commit/c89f465873024196bfd4b8cc48df1c301acf62f9))
36
+ * use async getStore in tests ([ec0b3b3](https://github.com/iotaledger/twin-immutable-proof/commit/ec0b3b38271fddf38a4b521cf871cc9cc01049f4))
37
+
38
+
39
+ ### Dependencies
40
+
41
+ * The following workspace dependencies were updated
42
+ * dependencies
43
+ * @twin.org/immutable-proof-models bumped from 0.9.0-next.0 to 0.9.0-next.1
44
+ * @twin.org/immutable-proof-task bumped from 0.9.0-next.0 to 0.9.0-next.1
45
+
46
+ ## [0.0.3-next.17](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.16...immutable-proof-service-v0.0.3-next.17) (2026-06-11)
47
+
48
+
49
+ ### Features
50
+
51
+ * remove default loggers ([1f59001](https://github.com/iotaledger/twin-immutable-proof/commit/1f59001038a9b83b5e3675c4cee2c4131023e9ff))
52
+
53
+
54
+ ### Dependencies
55
+
56
+ * The following workspace dependencies were updated
57
+ * dependencies
58
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.16 to 0.0.3-next.17
59
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.16 to 0.0.3-next.17
60
+
61
+ ## [0.0.3-next.16](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.15...immutable-proof-service-v0.0.3-next.16) (2026-05-29)
62
+
63
+
64
+ ### Features
65
+
66
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
67
+ * add logging ([#18](https://github.com/iotaledger/twin-immutable-proof/issues/18)) ([e331ce8](https://github.com/iotaledger/twin-immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
68
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
69
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
70
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
71
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
72
+ * remove vm linkage in on chain proof ([4034336](https://github.com/iotaledger/twin-immutable-proof/commit/4034336177261dcf3b017524a56f3f6537545227))
73
+ * 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))
74
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
75
+ * update background tasks ([f25741c](https://github.com/iotaledger/twin-immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
76
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
77
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
78
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
79
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
80
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
81
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
82
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
83
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
84
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
85
+
86
+
87
+ ### Bug Fixes
88
+
89
+ * constructor component name ([06ea7c3](https://github.com/iotaledger/twin-immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
90
+ * 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))
91
+
92
+
93
+ ### Dependencies
94
+
95
+ * The following workspace dependencies were updated
96
+ * dependencies
97
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.15 to 0.0.3-next.16
98
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.15 to 0.0.3-next.16
99
+
100
+ ## [0.0.3-next.15](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.14...immutable-proof-service-v0.0.3-next.15) (2026-05-29)
101
+
102
+
103
+ ### Features
104
+
105
+ * update remove methods ([#45](https://github.com/iotaledger/twin-immutable-proof/issues/45)) ([9db19bb](https://github.com/iotaledger/twin-immutable-proof/commit/9db19bb4c8e6f5d66139755e8b8a8071a77c4887))
106
+
107
+
108
+ ### Dependencies
109
+
110
+ * The following workspace dependencies were updated
111
+ * dependencies
112
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.14 to 0.0.3-next.15
113
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.14 to 0.0.3-next.15
114
+
115
+ ## [0.0.3-next.14](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.13...immutable-proof-service-v0.0.3-next.14) (2026-05-28)
116
+
117
+
118
+ ### Features
119
+
120
+ * 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))
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.13 to 0.0.3-next.14
128
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.13 to 0.0.3-next.14
129
+
130
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.12...immutable-proof-service-v0.0.3-next.13) (2026-05-20)
131
+
132
+
133
+ ### Features
134
+
135
+ * update dependencies ([1ec6b18](https://github.com/iotaledger/twin-immutable-proof/commit/1ec6b18e93198a8fc4935700863cdab1c3df7b64))
136
+
137
+
138
+ ### Dependencies
139
+
140
+ * The following workspace dependencies were updated
141
+ * dependencies
142
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.12 to 0.0.3-next.13
143
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.12 to 0.0.3-next.13
144
+
145
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.11...immutable-proof-service-v0.0.3-next.12) (2026-05-12)
146
+
147
+
148
+ ### Features
149
+
150
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
151
+
152
+
153
+ ### Dependencies
154
+
155
+ * The following workspace dependencies were updated
156
+ * dependencies
157
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.11 to 0.0.3-next.12
158
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.11 to 0.0.3-next.12
159
+
160
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.10...immutable-proof-service-v0.0.3-next.11) (2026-03-25)
161
+
162
+
163
+ ### Miscellaneous Chores
164
+
165
+ * **immutable-proof-service:** Synchronize repo versions
166
+
167
+
168
+ ### Dependencies
169
+
170
+ * The following workspace dependencies were updated
171
+ * dependencies
172
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.10 to 0.0.3-next.11
173
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.10 to 0.0.3-next.11
174
+
175
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.9...immutable-proof-service-v0.0.3-next.10) (2026-02-25)
176
+
177
+
178
+ ### Features
179
+
180
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
181
+
182
+
183
+ ### Dependencies
184
+
185
+ * The following workspace dependencies were updated
186
+ * dependencies
187
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.9 to 0.0.3-next.10
188
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.9 to 0.0.3-next.10
189
+
190
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.8...immutable-proof-service-v0.0.3-next.9) (2026-02-13)
191
+
192
+
193
+ ### Features
194
+
195
+ * remove vm linkage in on chain proof ([4034336](https://github.com/iotaledger/twin-immutable-proof/commit/4034336177261dcf3b017524a56f3f6537545227))
196
+
197
+
198
+ ### Dependencies
199
+
200
+ * The following workspace dependencies were updated
201
+ * dependencies
202
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.8 to 0.0.3-next.9
203
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.8 to 0.0.3-next.9
204
+
205
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.7...immutable-proof-service-v0.0.3-next.8) (2026-02-10)
206
+
207
+
208
+ ### Features
209
+
210
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
9
211
 
10
212
 
11
213
  ### Dependencies
@@ -15,7 +217,7 @@
15
217
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.7 to 0.0.3-next.8
16
218
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.7 to 0.0.3-next.8
17
219
 
18
- ## [0.0.3-next.7](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.6...immutable-proof-service-v0.0.3-next.7) (2026-02-05)
220
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.6...immutable-proof-service-v0.0.3-next.7) (2026-02-05)
19
221
 
20
222
 
21
223
  ### Miscellaneous Chores
@@ -30,12 +232,12 @@
30
232
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.6 to 0.0.3-next.7
31
233
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.6 to 0.0.3-next.7
32
234
 
33
- ## [0.0.3-next.6](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.5...immutable-proof-service-v0.0.3-next.6) (2026-01-21)
235
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.5...immutable-proof-service-v0.0.3-next.6) (2026-01-21)
34
236
 
35
237
 
36
238
  ### Features
37
239
 
38
- * update contexts ([#22](https://github.com/twinfoundation/immutable-proof/issues/22)) ([645b880](https://github.com/twinfoundation/immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
240
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
39
241
 
40
242
 
41
243
  ### Dependencies
@@ -45,12 +247,12 @@
45
247
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.5 to 0.0.3-next.6
46
248
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.5 to 0.0.3-next.6
47
249
 
48
- ## [0.0.3-next.5](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.4...immutable-proof-service-v0.0.3-next.5) (2026-01-14)
250
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.4...immutable-proof-service-v0.0.3-next.5) (2026-01-14)
49
251
 
50
252
 
51
253
  ### Features
52
254
 
53
- * update contexts and namespaces ([#20](https://github.com/twinfoundation/immutable-proof/issues/20)) ([d38aa69](https://github.com/twinfoundation/immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
255
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
54
256
 
55
257
 
56
258
  ### Dependencies
@@ -60,12 +262,12 @@
60
262
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.4 to 0.0.3-next.5
61
263
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.4 to 0.0.3-next.5
62
264
 
63
- ## [0.0.3-next.4](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.3...immutable-proof-service-v0.0.3-next.4) (2026-01-07)
265
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.3...immutable-proof-service-v0.0.3-next.4) (2026-01-07)
64
266
 
65
267
 
66
268
  ### Features
67
269
 
68
- * add logging ([#18](https://github.com/twinfoundation/immutable-proof/issues/18)) ([e331ce8](https://github.com/twinfoundation/immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
270
+ * add logging ([#18](https://github.com/iotaledger/twin-immutable-proof/issues/18)) ([e331ce8](https://github.com/iotaledger/twin-immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
69
271
 
70
272
 
71
273
  ### Dependencies
@@ -75,12 +277,12 @@
75
277
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.3 to 0.0.3-next.4
76
278
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.3 to 0.0.3-next.4
77
279
 
78
- ## [0.0.3-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.2...immutable-proof-service-v0.0.3-next.3) (2025-11-28)
280
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.2...immutable-proof-service-v0.0.3-next.3) (2025-11-28)
79
281
 
80
282
 
81
283
  ### Bug Fixes
82
284
 
83
- * constructor component name ([06ea7c3](https://github.com/twinfoundation/immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
285
+ * constructor component name ([06ea7c3](https://github.com/iotaledger/twin-immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
84
286
 
85
287
 
86
288
  ### Dependencies
@@ -90,12 +292,12 @@
90
292
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.2 to 0.0.3-next.3
91
293
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.2 to 0.0.3-next.3
92
294
 
93
- ## [0.0.3-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.1...immutable-proof-service-v0.0.3-next.2) (2025-11-28)
295
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.1...immutable-proof-service-v0.0.3-next.2) (2025-11-28)
94
296
 
95
297
 
96
298
  ### Features
97
299
 
98
- * update background tasks ([f25741c](https://github.com/twinfoundation/immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
300
+ * update background tasks ([f25741c](https://github.com/iotaledger/twin-immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
99
301
 
100
302
 
101
303
  ### Dependencies
@@ -105,24 +307,24 @@
105
307
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.1 to 0.0.3-next.2
106
308
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.1 to 0.0.3-next.2
107
309
 
108
- ## [0.0.3-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.0...immutable-proof-service-v0.0.3-next.1) (2025-11-12)
310
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.3-next.0...immutable-proof-service-v0.0.3-next.1) (2025-11-12)
109
311
 
110
312
 
111
313
  ### Features
112
314
 
113
- * add context id features ([#14](https://github.com/twinfoundation/immutable-proof/issues/14)) ([ed5a594](https://github.com/twinfoundation/immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
114
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
115
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
116
- * remove unused namespace ([a39864c](https://github.com/twinfoundation/immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
117
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
118
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
119
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
120
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
315
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
316
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
317
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
318
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
319
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
320
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
321
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
322
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
121
323
 
122
324
 
123
325
  ### Bug Fixes
124
326
 
125
- * 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))
327
+ * 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))
126
328
 
127
329
 
128
330
  ### Dependencies
@@ -132,12 +334,12 @@
132
334
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.0 to 0.0.3-next.1
133
335
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.0 to 0.0.3-next.1
134
336
 
135
- ## [0.0.2-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.2...immutable-proof-service-v0.0.2-next.3) (2025-10-09)
337
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.2-next.2...immutable-proof-service-v0.0.2-next.3) (2025-10-09)
136
338
 
137
339
 
138
340
  ### Features
139
341
 
140
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
342
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
141
343
 
142
344
 
143
345
  ### Dependencies
@@ -147,12 +349,12 @@
147
349
  * @twin.org/immutable-proof-models bumped from 0.0.2-next.2 to 0.0.2-next.3
148
350
  * @twin.org/immutable-proof-task bumped from 0.0.2-next.2 to 0.0.2-next.3
149
351
 
150
- ## [0.0.2-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.1...immutable-proof-service-v0.0.2-next.2) (2025-08-29)
352
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.2-next.1...immutable-proof-service-v0.0.2-next.2) (2025-08-29)
151
353
 
152
354
 
153
355
  ### Features
154
356
 
155
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
357
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
156
358
 
157
359
 
158
360
  ### Dependencies
@@ -162,21 +364,21 @@
162
364
  * @twin.org/immutable-proof-models bumped from 0.0.2-next.1 to 0.0.2-next.2
163
365
  * @twin.org/immutable-proof-task bumped from 0.0.2-next.1 to 0.0.2-next.2
164
366
 
165
- ## [0.0.2-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.2-next.0...immutable-proof-service-v0.0.2-next.1) (2025-08-20)
367
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.2-next.0...immutable-proof-service-v0.0.2-next.1) (2025-08-20)
166
368
 
167
369
 
168
370
  ### Features
169
371
 
170
- * remove unused namespace ([a39864c](https://github.com/twinfoundation/immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
171
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
172
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
173
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
174
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
372
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
373
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
374
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
375
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
376
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
175
377
 
176
378
 
177
379
  ### Bug Fixes
178
380
 
179
- * 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))
381
+ * 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))
180
382
 
181
383
 
182
384
  ### Dependencies
@@ -191,7 +393,7 @@
191
393
 
192
394
  ### Features
193
395
 
194
- * release to production ([cb7ecff](https://github.com/twinfoundation/immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
396
+ * release to production ([cb7ecff](https://github.com/iotaledger/twin-immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
195
397
 
196
398
 
197
399
  ### Dependencies
@@ -201,12 +403,12 @@
201
403
  * @twin.org/immutable-proof-models bumped from ^0.0.0 to ^0.0.1
202
404
  * @twin.org/immutable-proof-task bumped from ^0.0.0 to ^0.0.1
203
405
 
204
- ## [0.0.1-next.35](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.1-next.34...immutable-proof-service-v0.0.1-next.35) (2025-06-12)
406
+ ## [0.0.1-next.35](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.1-next.34...immutable-proof-service-v0.0.1-next.35) (2025-06-12)
205
407
 
206
408
 
207
409
  ### Features
208
410
 
209
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
411
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
210
412
 
211
413
 
212
414
  ### Dependencies
@@ -216,7 +418,7 @@
216
418
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.34 to 0.0.1-next.35
217
419
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.34 to 0.0.1-next.35
218
420
 
219
- ## [0.0.1-next.34](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.1-next.33...immutable-proof-service-v0.0.1-next.34) (2025-06-03)
421
+ ## [0.0.1-next.34](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.1-next.33...immutable-proof-service-v0.0.1-next.34) (2025-06-03)
220
422
 
221
423
 
222
424
  ### Miscellaneous Chores
@@ -231,12 +433,12 @@
231
433
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.33 to 0.0.1-next.34
232
434
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.33 to 0.0.1-next.34
233
435
 
234
- ## [0.0.1-next.33](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.1-next.32...immutable-proof-service-v0.0.1-next.33) (2025-05-28)
436
+ ## [0.0.1-next.33](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.1-next.32...immutable-proof-service-v0.0.1-next.33) (2025-05-28)
235
437
 
236
438
 
237
439
  ### Features
238
440
 
239
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
441
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
240
442
 
241
443
 
242
444
  ### Dependencies
@@ -246,12 +448,12 @@
246
448
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.32 to 0.0.1-next.33
247
449
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.32 to 0.0.1-next.33
248
450
 
249
- ## [0.0.1-next.32](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.1-next.31...immutable-proof-service-v0.0.1-next.32) (2025-04-17)
451
+ ## [0.0.1-next.32](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.1-next.31...immutable-proof-service-v0.0.1-next.32) (2025-04-17)
250
452
 
251
453
 
252
454
  ### Features
253
455
 
254
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
456
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
255
457
 
256
458
 
257
459
  ### Dependencies
@@ -261,12 +463,12 @@
261
463
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.31 to 0.0.1-next.32
262
464
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.31 to 0.0.1-next.32
263
465
 
264
- ## [0.0.1-next.31](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.1-next.30...immutable-proof-service-v0.0.1-next.31) (2025-03-28)
466
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-immutable-proof/compare/immutable-proof-service-v0.0.1-next.30...immutable-proof-service-v0.0.1-next.31) (2025-03-28)
265
467
 
266
468
 
267
469
  ### Bug Fixes
268
470
 
269
- * 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))
471
+ * 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))
270
472
 
271
473
 
272
474
  ### Dependencies
package/docs/examples.md CHANGED
@@ -1 +1,127 @@
1
- # @twin.org/immutable-proof-service - Examples
1
+ # Immutable Proof Service Examples
2
+
3
+ These examples show how to initialise storage and routes, create and retrieve proofs, verify them, and work with persisted entities.
4
+
5
+ ## ImmutableProofService
6
+
7
+ ```typescript
8
+ import { ImmutableProofService } from '@twin.org/immutable-proof-service';
9
+
10
+ const service = new ImmutableProofService({
11
+ identityConnectorType: 'identity',
12
+ config: {
13
+ verificationMethodId: 'immutable-proof-assertion'
14
+ }
15
+ });
16
+
17
+ console.log(service.className()); // ImmutableProofService
18
+ ```
19
+
20
+ ```typescript
21
+ import { ImmutableProofService } from '@twin.org/immutable-proof-service';
22
+
23
+ const service = new ImmutableProofService();
24
+ await service.start();
25
+
26
+ const proofId = await service.create({
27
+ '@context': 'https://schema.org',
28
+ type: 'Person',
29
+ name: 'Alice Example'
30
+ });
31
+
32
+ console.log(proofId); // immutable-proof:01JABCDEF1234567890
33
+ ```
34
+
35
+ ```typescript
36
+ import { ImmutableProofService } from '@twin.org/immutable-proof-service';
37
+
38
+ const service = new ImmutableProofService();
39
+ const proofId = 'immutable-proof:01JABCDEF1234567890';
40
+
41
+ const credential = await service.get(proofId);
42
+ const verification = await service.verify(proofId);
43
+
44
+ console.log(credential.id); // immutable-proof:01JABCDEF1234567890
45
+ console.log(verification.verified); // true
46
+ ```
47
+
48
+ ```typescript
49
+ import { ImmutableProofService } from '@twin.org/immutable-proof-service';
50
+
51
+ const service = new ImmutableProofService();
52
+ const proofId = 'immutable-proof:01JABCDEF1234567890';
53
+
54
+ await service.removeVerifiable(proofId);
55
+ const verificationAfterRemoval = await service.verify(proofId);
56
+
57
+ console.log(verificationAfterRemoval.verified); // false
58
+ ```
59
+
60
+ ## ImmutableProof
61
+
62
+ ```typescript
63
+ import { ImmutableProof } from '@twin.org/immutable-proof-service';
64
+
65
+ const entity: ImmutableProof = {
66
+ id: '01JABCDEF1234567890',
67
+ organizationId: 'did:iota:tst:issuer',
68
+ dateCreated: '2026-03-10T09:30:00.000Z',
69
+ proofObjectId: 'https://example.org/documents/100',
70
+ proofObjectIntegrity: 'yEr9VvYCGDh2Ww1YwQMehUy4LlW35mLhX8j8R8U6x0g=',
71
+ notarizationId: 'notarization:01JABCDE'
72
+ };
73
+
74
+ console.log(entity.organizationId); // did:iota:tst:issuer
75
+ ```
76
+
77
+ ## Route and Schema Helpers
78
+
79
+ ```typescript
80
+ import {
81
+ generateRestRoutesImmutableProof,
82
+ initSchema,
83
+ restEntryPoints
84
+ } from '@twin.org/immutable-proof-service';
85
+
86
+ initSchema();
87
+
88
+ const routes = generateRestRoutesImmutableProof('/immutable-proof', 'immutable-proof');
89
+ console.log(routes.length); // 3
90
+ console.log(restEntryPoints[0].name); // immutable-proof
91
+ ```
92
+
93
+ ```typescript
94
+ import {
95
+ immutableProofCreate,
96
+ immutableProofGet,
97
+ immutableProofVerify
98
+ } from '@twin.org/immutable-proof-service';
99
+
100
+ const requestContext = {};
101
+
102
+ const createResponse = await immutableProofCreate(requestContext, 'immutable-proof', {
103
+ body: {
104
+ document: {
105
+ '@context': 'https://schema.org',
106
+ type: 'Person',
107
+ name: 'Alice Example'
108
+ }
109
+ }
110
+ });
111
+
112
+ const getResponse = await immutableProofGet(requestContext, 'immutable-proof', {
113
+ pathParams: {
114
+ id: createResponse.headers.location
115
+ }
116
+ });
117
+
118
+ const verifyResponse = await immutableProofVerify(requestContext, 'immutable-proof', {
119
+ pathParams: {
120
+ id: createResponse.headers.location
121
+ }
122
+ });
123
+
124
+ console.log(createResponse.statusCode); // 201
125
+ console.log(getResponse.body.id); // immutable-proof:01JABCDEF1234567890
126
+ console.log(verifyResponse.body.verified); // true
127
+ ```