@twin.org/immutable-proof-service 0.0.3-next.10 → 0.0.3-next.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +79 -49
  3. package/docs/examples.md +127 -1
  4. package/docs/open-api/spec.json +8 -693
  5. package/docs/reference/classes/ImmutableProof.md +10 -10
  6. package/docs/reference/classes/ImmutableProofService.md +7 -7
  7. package/docs/reference/interfaces/IImmutableProofServiceConfig.md +2 -2
  8. package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md +14 -14
  9. package/package.json +6 -6
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Immutable Proof Service
2
2
 
3
- Immutable proof contract implementation and REST endpoint definitions.
3
+ This package implements the core immutable proof lifecycle, including proof creation, retrieval, verification, and storage coordination. It also exposes route and schema helpers so API hosts can register endpoints and entity schemas with consistent behaviour.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,11 +1,41 @@
1
- # @twin.org/immutable-proof-service - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.10](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.9...immutable-proof-service-v0.0.3-next.10) (2026-02-25)
3
+ ## [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)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * update schemas ([ab0569a](https://github.com/twinfoundation/immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
8
+ * typescript 6 update ([34d8aea](https://github.com/iotaledger/twin-immutable-proof/commit/34d8aea0ea0c1e1252de1882517abb1683d98313))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.11 to 0.0.3-next.12
16
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.11 to 0.0.3-next.12
17
+
18
+ ## [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)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **immutable-proof-service:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/immutable-proof-models bumped from 0.0.3-next.10 to 0.0.3-next.11
31
+ * @twin.org/immutable-proof-task bumped from 0.0.3-next.10 to 0.0.3-next.11
32
+
33
+ ## [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)
34
+
35
+
36
+ ### Features
37
+
38
+ * update schemas ([ab0569a](https://github.com/iotaledger/twin-immutable-proof/commit/ab0569adf3419beefd8aef7793fdbe5b2fe2d93e))
9
39
 
10
40
 
11
41
  ### Dependencies
@@ -15,12 +45,12 @@
15
45
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.9 to 0.0.3-next.10
16
46
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.9 to 0.0.3-next.10
17
47
 
18
- ## [0.0.3-next.9](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-service-v0.0.3-next.8...immutable-proof-service-v0.0.3-next.9) (2026-02-13)
48
+ ## [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)
19
49
 
20
50
 
21
51
  ### Features
22
52
 
23
- * remove vm linkage in on chain proof ([4034336](https://github.com/twinfoundation/immutable-proof/commit/4034336177261dcf3b017524a56f3f6537545227))
53
+ * remove vm linkage in on chain proof ([4034336](https://github.com/iotaledger/twin-immutable-proof/commit/4034336177261dcf3b017524a56f3f6537545227))
24
54
 
25
55
 
26
56
  ### Dependencies
@@ -30,12 +60,12 @@
30
60
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.8 to 0.0.3-next.9
31
61
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.8 to 0.0.3-next.9
32
62
 
33
- ## [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)
63
+ ## [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)
34
64
 
35
65
 
36
66
  ### Features
37
67
 
38
- * immutable proof as vc ([#31](https://github.com/twinfoundation/immutable-proof/issues/31)) ([79cdb03](https://github.com/twinfoundation/immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
68
+ * immutable proof as vc ([#31](https://github.com/iotaledger/twin-immutable-proof/issues/31)) ([79cdb03](https://github.com/iotaledger/twin-immutable-proof/commit/79cdb03eb86c4f6d2ab1d5bf235f74ff74e8b877))
39
69
 
40
70
 
41
71
  ### Dependencies
@@ -45,7 +75,7 @@
45
75
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.7 to 0.0.3-next.8
46
76
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.7 to 0.0.3-next.8
47
77
 
48
- ## [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)
78
+ ## [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)
49
79
 
50
80
 
51
81
  ### Miscellaneous Chores
@@ -60,12 +90,12 @@
60
90
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.6 to 0.0.3-next.7
61
91
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.6 to 0.0.3-next.7
62
92
 
63
- ## [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)
93
+ ## [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)
64
94
 
65
95
 
66
96
  ### Features
67
97
 
68
- * update contexts ([#22](https://github.com/twinfoundation/immutable-proof/issues/22)) ([645b880](https://github.com/twinfoundation/immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
98
+ * update contexts ([#22](https://github.com/iotaledger/twin-immutable-proof/issues/22)) ([645b880](https://github.com/iotaledger/twin-immutable-proof/commit/645b8803540408c74e3891b2c5ff9aefd5908d9f))
69
99
 
70
100
 
71
101
  ### Dependencies
@@ -75,12 +105,12 @@
75
105
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.5 to 0.0.3-next.6
76
106
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.5 to 0.0.3-next.6
77
107
 
78
- ## [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)
108
+ ## [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)
79
109
 
80
110
 
81
111
  ### Features
82
112
 
83
- * update contexts and namespaces ([#20](https://github.com/twinfoundation/immutable-proof/issues/20)) ([d38aa69](https://github.com/twinfoundation/immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
113
+ * update contexts and namespaces ([#20](https://github.com/iotaledger/twin-immutable-proof/issues/20)) ([d38aa69](https://github.com/iotaledger/twin-immutable-proof/commit/d38aa696c73e4fcc304f08fb458d5900109abcb4))
84
114
 
85
115
 
86
116
  ### Dependencies
@@ -90,12 +120,12 @@
90
120
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.4 to 0.0.3-next.5
91
121
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.4 to 0.0.3-next.5
92
122
 
93
- ## [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)
123
+ ## [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)
94
124
 
95
125
 
96
126
  ### Features
97
127
 
98
- * add logging ([#18](https://github.com/twinfoundation/immutable-proof/issues/18)) ([e331ce8](https://github.com/twinfoundation/immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
128
+ * add logging ([#18](https://github.com/iotaledger/twin-immutable-proof/issues/18)) ([e331ce8](https://github.com/iotaledger/twin-immutable-proof/commit/e331ce843393554750c2708ebce1273056b6399a))
99
129
 
100
130
 
101
131
  ### Dependencies
@@ -105,12 +135,12 @@
105
135
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.3 to 0.0.3-next.4
106
136
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.3 to 0.0.3-next.4
107
137
 
108
- ## [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)
138
+ ## [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)
109
139
 
110
140
 
111
141
  ### Bug Fixes
112
142
 
113
- * constructor component name ([06ea7c3](https://github.com/twinfoundation/immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
143
+ * constructor component name ([06ea7c3](https://github.com/iotaledger/twin-immutable-proof/commit/06ea7c3602a7b465870300bf02f358d95312d49a))
114
144
 
115
145
 
116
146
  ### Dependencies
@@ -120,12 +150,12 @@
120
150
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.2 to 0.0.3-next.3
121
151
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.2 to 0.0.3-next.3
122
152
 
123
- ## [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)
153
+ ## [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)
124
154
 
125
155
 
126
156
  ### Features
127
157
 
128
- * update background tasks ([f25741c](https://github.com/twinfoundation/immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
158
+ * update background tasks ([f25741c](https://github.com/iotaledger/twin-immutable-proof/commit/f25741c704e2c8311bc98bc69d4d926c523c781e))
129
159
 
130
160
 
131
161
  ### Dependencies
@@ -135,24 +165,24 @@
135
165
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.1 to 0.0.3-next.2
136
166
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.1 to 0.0.3-next.2
137
167
 
138
- ## [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)
168
+ ## [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)
139
169
 
140
170
 
141
171
  ### Features
142
172
 
143
- * add context id features ([#14](https://github.com/twinfoundation/immutable-proof/issues/14)) ([ed5a594](https://github.com/twinfoundation/immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
144
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
145
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
146
- * remove unused namespace ([a39864c](https://github.com/twinfoundation/immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
147
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
148
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
149
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
150
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
173
+ * add context id features ([#14](https://github.com/iotaledger/twin-immutable-proof/issues/14)) ([ed5a594](https://github.com/iotaledger/twin-immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
174
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
175
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
176
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
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
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
151
181
 
152
182
 
153
183
  ### Bug Fixes
154
184
 
155
- * 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))
185
+ * 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))
156
186
 
157
187
 
158
188
  ### Dependencies
@@ -162,12 +192,12 @@
162
192
  * @twin.org/immutable-proof-models bumped from 0.0.3-next.0 to 0.0.3-next.1
163
193
  * @twin.org/immutable-proof-task bumped from 0.0.3-next.0 to 0.0.3-next.1
164
194
 
165
- ## [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)
195
+ ## [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)
166
196
 
167
197
 
168
198
  ### Features
169
199
 
170
- * add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
200
+ * add validate-locales ([d6a7c07](https://github.com/iotaledger/twin-immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
171
201
 
172
202
 
173
203
  ### Dependencies
@@ -177,12 +207,12 @@
177
207
  * @twin.org/immutable-proof-models bumped from 0.0.2-next.2 to 0.0.2-next.3
178
208
  * @twin.org/immutable-proof-task bumped from 0.0.2-next.2 to 0.0.2-next.3
179
209
 
180
- ## [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)
210
+ ## [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)
181
211
 
182
212
 
183
213
  ### Features
184
214
 
185
- * eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
215
+ * eslint migration to flat config ([c8536f2](https://github.com/iotaledger/twin-immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
186
216
 
187
217
 
188
218
  ### Dependencies
@@ -192,21 +222,21 @@
192
222
  * @twin.org/immutable-proof-models bumped from 0.0.2-next.1 to 0.0.2-next.2
193
223
  * @twin.org/immutable-proof-task bumped from 0.0.2-next.1 to 0.0.2-next.2
194
224
 
195
- ## [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)
225
+ ## [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)
196
226
 
197
227
 
198
228
  ### Features
199
229
 
200
- * remove unused namespace ([a39864c](https://github.com/twinfoundation/immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
201
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
202
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
203
- * update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
204
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
230
+ * remove unused namespace ([a39864c](https://github.com/iotaledger/twin-immutable-proof/commit/a39864c0b2ca8753334a34028b8e5823a14162b4))
231
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
232
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
233
+ * update framework core ([e708d4d](https://github.com/iotaledger/twin-immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
234
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
205
235
 
206
236
 
207
237
  ### Bug Fixes
208
238
 
209
- * 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))
239
+ * 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))
210
240
 
211
241
 
212
242
  ### Dependencies
@@ -221,7 +251,7 @@
221
251
 
222
252
  ### Features
223
253
 
224
- * release to production ([cb7ecff](https://github.com/twinfoundation/immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
254
+ * release to production ([cb7ecff](https://github.com/iotaledger/twin-immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
225
255
 
226
256
 
227
257
  ### Dependencies
@@ -231,12 +261,12 @@
231
261
  * @twin.org/immutable-proof-models bumped from ^0.0.0 to ^0.0.1
232
262
  * @twin.org/immutable-proof-task bumped from ^0.0.0 to ^0.0.1
233
263
 
234
- ## [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)
264
+ ## [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)
235
265
 
236
266
 
237
267
  ### Features
238
268
 
239
- * update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
269
+ * update dependencies ([7d6b321](https://github.com/iotaledger/twin-immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
240
270
 
241
271
 
242
272
  ### Dependencies
@@ -246,7 +276,7 @@
246
276
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.34 to 0.0.1-next.35
247
277
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.34 to 0.0.1-next.35
248
278
 
249
- ## [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)
279
+ ## [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)
250
280
 
251
281
 
252
282
  ### Miscellaneous Chores
@@ -261,12 +291,12 @@
261
291
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.33 to 0.0.1-next.34
262
292
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.33 to 0.0.1-next.34
263
293
 
264
- ## [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)
294
+ ## [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)
265
295
 
266
296
 
267
297
  ### Features
268
298
 
269
- * update data types to use fully qualified names ([e94d0f5](https://github.com/twinfoundation/immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
299
+ * update data types to use fully qualified names ([e94d0f5](https://github.com/iotaledger/twin-immutable-proof/commit/e94d0f5db93856b5b59cfd34e55252fa13a7f4e0))
270
300
 
271
301
 
272
302
  ### Dependencies
@@ -276,12 +306,12 @@
276
306
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.32 to 0.0.1-next.33
277
307
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.32 to 0.0.1-next.33
278
308
 
279
- ## [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)
309
+ ## [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)
280
310
 
281
311
 
282
312
  ### Features
283
313
 
284
- * use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
314
+ * use shared store mechanism ([#3](https://github.com/iotaledger/twin-immutable-proof/issues/3)) ([7042a40](https://github.com/iotaledger/twin-immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
285
315
 
286
316
 
287
317
  ### Dependencies
@@ -291,12 +321,12 @@
291
321
  * @twin.org/immutable-proof-models bumped from 0.0.1-next.31 to 0.0.1-next.32
292
322
  * @twin.org/immutable-proof-task bumped from 0.0.1-next.31 to 0.0.1-next.32
293
323
 
294
- ## [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)
324
+ ## [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)
295
325
 
296
326
 
297
327
  ### Bug Fixes
298
328
 
299
- * 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))
329
+ * 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))
300
330
 
301
331
 
302
332
  ### 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
+ verifiableStorageId: 'verifiable-storage: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
+ ```