@forgerock/storage 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/coverage/base.css +224 -0
  3. package/coverage/block-navigation.js +87 -0
  4. package/coverage/coverage-final.json +3 -0
  5. package/coverage/favicon.png +0 -0
  6. package/coverage/index.html +131 -0
  7. package/coverage/prettify.css +1 -0
  8. package/coverage/prettify.js +2 -0
  9. package/coverage/sort-arrow-sprite.png +0 -0
  10. package/coverage/sorter.js +210 -0
  11. package/coverage/src/index.html +116 -0
  12. package/coverage/src/index.ts.html +106 -0
  13. package/coverage/src/lib/index.html +116 -0
  14. package/coverage/src/lib/storage.effects.ts.html +472 -0
  15. package/dist/src/lib/storage.effects.d.ts +16 -16
  16. package/dist/src/lib/storage.effects.d.ts.map +1 -1
  17. package/dist/src/lib/storage.effects.js +57 -70
  18. package/dist/tsconfig.lib.tsbuildinfo +1 -1
  19. package/eslint.config.mjs +2 -2
  20. package/package.json +2 -2
  21. package/src/lib/storage.effects.test.ts +112 -52
  22. package/src/lib/storage.effects.ts +85 -87
  23. package/vite.config.ts +0 -0
package/coverage/src/lib/storage.effects.ts.html ADDED
@@ -0,0 +1,472 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/lib/storage.effects.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/lib</a> storage.effects.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">60.43% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>55/91</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">72.72% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>16/22</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">80% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>4/5</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">60.43% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>55/91</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line medium'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a>
140
+ <a name='L75'></a><a href='#L75'>75</a>
141
+ <a name='L76'></a><a href='#L76'>76</a>
142
+ <a name='L77'></a><a href='#L77'>77</a>
143
+ <a name='L78'></a><a href='#L78'>78</a>
144
+ <a name='L79'></a><a href='#L79'>79</a>
145
+ <a name='L80'></a><a href='#L80'>80</a>
146
+ <a name='L81'></a><a href='#L81'>81</a>
147
+ <a name='L82'></a><a href='#L82'>82</a>
148
+ <a name='L83'></a><a href='#L83'>83</a>
149
+ <a name='L84'></a><a href='#L84'>84</a>
150
+ <a name='L85'></a><a href='#L85'>85</a>
151
+ <a name='L86'></a><a href='#L86'>86</a>
152
+ <a name='L87'></a><a href='#L87'>87</a>
153
+ <a name='L88'></a><a href='#L88'>88</a>
154
+ <a name='L89'></a><a href='#L89'>89</a>
155
+ <a name='L90'></a><a href='#L90'>90</a>
156
+ <a name='L91'></a><a href='#L91'>91</a>
157
+ <a name='L92'></a><a href='#L92'>92</a>
158
+ <a name='L93'></a><a href='#L93'>93</a>
159
+ <a name='L94'></a><a href='#L94'>94</a>
160
+ <a name='L95'></a><a href='#L95'>95</a>
161
+ <a name='L96'></a><a href='#L96'>96</a>
162
+ <a name='L97'></a><a href='#L97'>97</a>
163
+ <a name='L98'></a><a href='#L98'>98</a>
164
+ <a name='L99'></a><a href='#L99'>99</a>
165
+ <a name='L100'></a><a href='#L100'>100</a>
166
+ <a name='L101'></a><a href='#L101'>101</a>
167
+ <a name='L102'></a><a href='#L102'>102</a>
168
+ <a name='L103'></a><a href='#L103'>103</a>
169
+ <a name='L104'></a><a href='#L104'>104</a>
170
+ <a name='L105'></a><a href='#L105'>105</a>
171
+ <a name='L106'></a><a href='#L106'>106</a>
172
+ <a name='L107'></a><a href='#L107'>107</a>
173
+ <a name='L108'></a><a href='#L108'>108</a>
174
+ <a name='L109'></a><a href='#L109'>109</a>
175
+ <a name='L110'></a><a href='#L110'>110</a>
176
+ <a name='L111'></a><a href='#L111'>111</a>
177
+ <a name='L112'></a><a href='#L112'>112</a>
178
+ <a name='L113'></a><a href='#L113'>113</a>
179
+ <a name='L114'></a><a href='#L114'>114</a>
180
+ <a name='L115'></a><a href='#L115'>115</a>
181
+ <a name='L116'></a><a href='#L116'>116</a>
182
+ <a name='L117'></a><a href='#L117'>117</a>
183
+ <a name='L118'></a><a href='#L118'>118</a>
184
+ <a name='L119'></a><a href='#L119'>119</a>
185
+ <a name='L120'></a><a href='#L120'>120</a>
186
+ <a name='L121'></a><a href='#L121'>121</a>
187
+ <a name='L122'></a><a href='#L122'>122</a>
188
+ <a name='L123'></a><a href='#L123'>123</a>
189
+ <a name='L124'></a><a href='#L124'>124</a>
190
+ <a name='L125'></a><a href='#L125'>125</a>
191
+ <a name='L126'></a><a href='#L126'>126</a>
192
+ <a name='L127'></a><a href='#L127'>127</a>
193
+ <a name='L128'></a><a href='#L128'>128</a>
194
+ <a name='L129'></a><a href='#L129'>129</a>
195
+ <a name='L130'></a><a href='#L130'>130</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
196
+ <span class="cline-any cline-neutral">&nbsp;</span>
197
+ <span class="cline-any cline-neutral">&nbsp;</span>
198
+ <span class="cline-any cline-neutral">&nbsp;</span>
199
+ <span class="cline-any cline-neutral">&nbsp;</span>
200
+ <span class="cline-any cline-neutral">&nbsp;</span>
201
+ <span class="cline-any cline-neutral">&nbsp;</span>
202
+ <span class="cline-any cline-neutral">&nbsp;</span>
203
+ <span class="cline-any cline-neutral">&nbsp;</span>
204
+ <span class="cline-any cline-neutral">&nbsp;</span>
205
+ <span class="cline-any cline-neutral">&nbsp;</span>
206
+ <span class="cline-any cline-neutral">&nbsp;</span>
207
+ <span class="cline-any cline-neutral">&nbsp;</span>
208
+ <span class="cline-any cline-neutral">&nbsp;</span>
209
+ <span class="cline-any cline-neutral">&nbsp;</span>
210
+ <span class="cline-any cline-neutral">&nbsp;</span>
211
+ <span class="cline-any cline-neutral">&nbsp;</span>
212
+ <span class="cline-any cline-neutral">&nbsp;</span>
213
+ <span class="cline-any cline-neutral">&nbsp;</span>
214
+ <span class="cline-any cline-neutral">&nbsp;</span>
215
+ <span class="cline-any cline-neutral">&nbsp;</span>
216
+ <span class="cline-any cline-neutral">&nbsp;</span>
217
+ <span class="cline-any cline-neutral">&nbsp;</span>
218
+ <span class="cline-any cline-neutral">&nbsp;</span>
219
+ <span class="cline-any cline-neutral">&nbsp;</span>
220
+ <span class="cline-any cline-neutral">&nbsp;</span>
221
+ <span class="cline-any cline-neutral">&nbsp;</span>
222
+ <span class="cline-any cline-neutral">&nbsp;</span>
223
+ <span class="cline-any cline-neutral">&nbsp;</span>
224
+ <span class="cline-any cline-no">&nbsp;</span>
225
+ <span class="cline-any cline-no">&nbsp;</span>
226
+ <span class="cline-any cline-no">&nbsp;</span>
227
+ <span class="cline-any cline-no">&nbsp;</span>
228
+ <span class="cline-any cline-no">&nbsp;</span>
229
+ <span class="cline-any cline-no">&nbsp;</span>
230
+ <span class="cline-any cline-no">&nbsp;</span>
231
+ <span class="cline-any cline-no">&nbsp;</span>
232
+ <span class="cline-any cline-no">&nbsp;</span>
233
+ <span class="cline-any cline-no">&nbsp;</span>
234
+ <span class="cline-any cline-no">&nbsp;</span>
235
+ <span class="cline-any cline-no">&nbsp;</span>
236
+ <span class="cline-any cline-no">&nbsp;</span>
237
+ <span class="cline-any cline-no">&nbsp;</span>
238
+ <span class="cline-any cline-no">&nbsp;</span>
239
+ <span class="cline-any cline-no">&nbsp;</span>
240
+ <span class="cline-any cline-no">&nbsp;</span>
241
+ <span class="cline-any cline-no">&nbsp;</span>
242
+ <span class="cline-any cline-neutral">&nbsp;</span>
243
+ <span class="cline-any cline-no">&nbsp;</span>
244
+ <span class="cline-any cline-no">&nbsp;</span>
245
+ <span class="cline-any cline-no">&nbsp;</span>
246
+ <span class="cline-any cline-no">&nbsp;</span>
247
+ <span class="cline-any cline-no">&nbsp;</span>
248
+ <span class="cline-any cline-no">&nbsp;</span>
249
+ <span class="cline-any cline-neutral">&nbsp;</span>
250
+ <span class="cline-any cline-yes">1x</span>
251
+ <span class="cline-any cline-yes">4x</span>
252
+ <span class="cline-any cline-yes">4x</span>
253
+ <span class="cline-any cline-yes">4x</span>
254
+ <span class="cline-any cline-yes">4x</span>
255
+ <span class="cline-any cline-yes">4x</span>
256
+ <span class="cline-any cline-yes">4x</span>
257
+ <span class="cline-any cline-neutral">&nbsp;</span>
258
+ <span class="cline-any cline-yes">4x</span>
259
+ <span class="cline-any cline-no">&nbsp;</span>
260
+ <span class="cline-any cline-no">&nbsp;</span>
261
+ <span class="cline-any cline-neutral">&nbsp;</span>
262
+ <span class="cline-any cline-yes">4x</span>
263
+ <span class="cline-any cline-yes">4x</span>
264
+ <span class="cline-any cline-yes">9x</span>
265
+ <span class="cline-any cline-yes">3x</span>
266
+ <span class="cline-any cline-yes">3x</span>
267
+ <span class="cline-any cline-yes">1x</span>
268
+ <span class="cline-any cline-yes">1x</span>
269
+ <span class="cline-any cline-neutral">&nbsp;</span>
270
+ <span class="cline-any cline-yes">2x</span>
271
+ <span class="cline-any cline-yes">2x</span>
272
+ <span class="cline-any cline-yes">2x</span>
273
+ <span class="cline-any cline-yes">3x</span>
274
+ <span class="cline-any cline-no">&nbsp;</span>
275
+ <span class="cline-any cline-no">&nbsp;</span>
276
+ <span class="cline-any cline-yes">3x</span>
277
+ <span class="cline-any cline-neutral">&nbsp;</span>
278
+ <span class="cline-any cline-yes">6x</span>
279
+ <span class="cline-any cline-yes">6x</span>
280
+ <span class="cline-any cline-yes">6x</span>
281
+ <span class="cline-any cline-yes">9x</span>
282
+ <span class="cline-any cline-yes">2x</span>
283
+ <span class="cline-any cline-yes">2x</span>
284
+ <span class="cline-any cline-yes">9x</span>
285
+ <span class="cline-any cline-no">&nbsp;</span>
286
+ <span class="cline-any cline-no">&nbsp;</span>
287
+ <span class="cline-any cline-neutral">&nbsp;</span>
288
+ <span class="cline-any cline-yes">4x</span>
289
+ <span class="cline-any cline-yes">4x</span>
290
+ <span class="cline-any cline-yes">4x</span>
291
+ <span class="cline-any cline-yes">9x</span>
292
+ <span class="cline-any cline-no">&nbsp;</span>
293
+ <span class="cline-any cline-no">&nbsp;</span>
294
+ <span class="cline-any cline-yes">9x</span>
295
+ <span class="cline-any cline-yes">4x</span>
296
+ <span class="cline-any cline-yes">12x</span>
297
+ <span class="cline-any cline-yes">12x</span>
298
+ <span class="cline-any cline-yes">6x</span>
299
+ <span class="cline-any cline-yes">6x</span>
300
+ <span class="cline-any cline-yes">6x</span>
301
+ <span class="cline-any cline-neutral">&nbsp;</span>
302
+ <span class="cline-any cline-yes">6x</span>
303
+ <span class="cline-any cline-yes">6x</span>
304
+ <span class="cline-any cline-yes">6x</span>
305
+ <span class="cline-any cline-yes">12x</span>
306
+ <span class="cline-any cline-no">&nbsp;</span>
307
+ <span class="cline-any cline-no">&nbsp;</span>
308
+ <span class="cline-any cline-yes">12x</span>
309
+ <span class="cline-any cline-yes">4x</span>
310
+ <span class="cline-any cline-yes">4x</span>
311
+ <span class="cline-any cline-yes">2x</span>
312
+ <span class="cline-any cline-yes">2x</span>
313
+ <span class="cline-any cline-yes">2x</span>
314
+ <span class="cline-any cline-neutral">&nbsp;</span>
315
+ <span class="cline-any cline-yes">2x</span>
316
+ <span class="cline-any cline-yes">2x</span>
317
+ <span class="cline-any cline-yes">2x</span>
318
+ <span class="cline-any cline-yes">4x</span>
319
+ <span class="cline-any cline-no">&nbsp;</span>
320
+ <span class="cline-any cline-no">&nbsp;</span>
321
+ <span class="cline-any cline-yes">4x</span>
322
+ <span class="cline-any cline-yes">4x</span>
323
+ <span class="cline-any cline-yes">4x</span>
324
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/*
325
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
326
+ *
327
+ * This software may be modified and distributed under the terms
328
+ * of the MIT license. See the LICENSE file for details.
329
+ */
330
+ import { CustomStorageObject, GenericError } from '@forgerock/sdk-types';
331
+ &nbsp;
332
+ export interface StorageClient&lt;Value&gt; {
333
+ get: () =&gt; Promise&lt;Value | GenericError | null&gt;;
334
+ set: (value: Value) =&gt; Promise&lt;GenericError | null&gt;;
335
+ remove: () =&gt; Promise&lt;GenericError | null&gt;;
336
+ }
337
+ &nbsp;
338
+ export type StorageConfig = BrowserStorageConfig | CustomStorageConfig;
339
+ &nbsp;
340
+ export interface BrowserStorageConfig {
341
+ type: 'localStorage' | 'sessionStorage';
342
+ prefix?: string;
343
+ name: string;
344
+ }
345
+ &nbsp;
346
+ export interface CustomStorageConfig {
347
+ type: 'custom';
348
+ prefix?: string;
349
+ name: string;
350
+ custom: CustomStorageObject;
351
+ }
352
+ &nbsp;
353
+ <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >function createStorageError(</span></span>
354
+ <span class="cstat-no" title="statement not covered" > storeType: 'localStorage' | 'sessionStorage' | 'custom',</span>
355
+ <span class="cstat-no" title="statement not covered" > action: 'Storing' | 'Retrieving' | 'Removing' | 'Parsing',</span>
356
+ <span class="cstat-no" title="statement not covered" >): GenericError {</span>
357
+ <span class="cstat-no" title="statement not covered" > let storageName;</span>
358
+ <span class="cstat-no" title="statement not covered" > switch (storeType) {</span>
359
+ <span class="cstat-no" title="statement not covered" > case 'localStorage':</span>
360
+ <span class="cstat-no" title="statement not covered" > storageName = 'local';</span>
361
+ <span class="cstat-no" title="statement not covered" > break;</span>
362
+ <span class="cstat-no" title="statement not covered" > case 'sessionStorage':</span>
363
+ <span class="cstat-no" title="statement not covered" > storageName = 'session';</span>
364
+ <span class="cstat-no" title="statement not covered" > break;</span>
365
+ <span class="cstat-no" title="statement not covered" > case 'custom':</span>
366
+ <span class="cstat-no" title="statement not covered" > storageName = 'custom';</span>
367
+ <span class="cstat-no" title="statement not covered" > break;</span>
368
+ <span class="cstat-no" title="statement not covered" > default:</span>
369
+ <span class="cstat-no" title="statement not covered" > break;</span>
370
+ <span class="cstat-no" title="statement not covered" > }</span>
371
+ &nbsp;
372
+ <span class="cstat-no" title="statement not covered" > return {</span>
373
+ <span class="cstat-no" title="statement not covered" > error: `${action}_error`,</span>
374
+ <span class="cstat-no" title="statement not covered" > message: `Error ${action.toLowerCase()} value from ${storageName} storage`,</span>
375
+ <span class="cstat-no" title="statement not covered" > type: action === 'Parsing' ? 'parse_error' : 'unknown_error',</span>
376
+ <span class="cstat-no" title="statement not covered" > };</span>
377
+ <span class="cstat-no" title="statement not covered" >}</span>
378
+ &nbsp;
379
+ export function createStorage&lt;Value&gt;(config: StorageConfig): StorageClient&lt;Value&gt; {
380
+ const { type: storeType, prefix = 'pic', name } = config;
381
+ const key = `${prefix}-${name}`;
382
+ const storageTypes = {
383
+ sessionStorage,
384
+ localStorage,
385
+ };
386
+ &nbsp;
387
+ if (storeType === 'custom' &amp;&amp; !('custom' in config)) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
388
+ <span class="cstat-no" title="statement not covered" > throw new Error('Custom storage configuration must include a custom storage object');</span>
389
+ <span class="cstat-no" title="statement not covered" > }</span>
390
+ &nbsp;
391
+ return {
392
+ get: async function storageGet(): Promise&lt;Value | GenericError | null&gt; {
393
+ if (storeType === 'custom') {
394
+ const value = await config.custom.get(key);
395
+ if (value === null || (typeof value === 'object' &amp;&amp; 'error' in value)) {
396
+ return value;
397
+ }
398
+ &nbsp;
399
+ try {
400
+ const parsed = JSON.parse(value);
401
+ return parsed as Value;
402
+ <span class="branch-0 cbranch-no" title="branch not covered" > } catch {</span>
403
+ <span class="cstat-no" title="statement not covered" > return createStorageError(storeType, 'Parsing');</span>
404
+ <span class="cstat-no" title="statement not covered" > }</span>
405
+ }
406
+ &nbsp;
407
+ let value: string | null;
408
+ try {
409
+ value = await storageTypes[storeType].getItem(key);
410
+ if (value === null) {
411
+ return value;
412
+ }
413
+ <span class="branch-0 cbranch-no" title="branch not covered" > } catch {</span>
414
+ <span class="cstat-no" title="statement not covered" > return createStorageError(storeType, 'Retrieving');</span>
415
+ <span class="cstat-no" title="statement not covered" > }</span>
416
+ &nbsp;
417
+ try {
418
+ const parsed = JSON.parse(value);
419
+ return parsed as Value;
420
+ <span class="branch-0 cbranch-no" title="branch not covered" > } catch {</span>
421
+ <span class="cstat-no" title="statement not covered" > return createStorageError(storeType, 'Parsing');</span>
422
+ <span class="cstat-no" title="statement not covered" > }</span>
423
+ },
424
+ set: async function storageSet(value: Value): Promise&lt;GenericError | null&gt; {
425
+ const valueToStore = JSON.stringify(value);
426
+ if (storeType === 'custom') {
427
+ const value = await config.custom.set(key, valueToStore);
428
+ return Promise.resolve(value ?? null);
429
+ }
430
+ &nbsp;
431
+ try {
432
+ await storageTypes[storeType].setItem(key, valueToStore);
433
+ return Promise.resolve(null);
434
+ <span class="branch-0 cbranch-no" title="branch not covered" > } catch {</span>
435
+ <span class="cstat-no" title="statement not covered" > return createStorageError(storeType, 'Storing');</span>
436
+ <span class="cstat-no" title="statement not covered" > }</span>
437
+ },
438
+ remove: async function storageRemove(): Promise&lt;GenericError | null&gt; {
439
+ if (storeType === 'custom') {
440
+ const value = await config.custom.remove(key);
441
+ return Promise.resolve(value ?? null);
442
+ }
443
+ &nbsp;
444
+ try {
445
+ await storageTypes[storeType].removeItem(key);
446
+ return Promise.resolve(null);
447
+ <span class="branch-0 cbranch-no" title="branch not covered" > } catch {</span>
448
+ <span class="cstat-no" title="statement not covered" > return createStorageError(storeType, 'Removing');</span>
449
+ <span class="cstat-no" title="statement not covered" > }</span>
450
+ },
451
+ } as StorageClient&lt;Value&gt;;
452
+ }
453
+ &nbsp;</pre></td></tr></table></pre>
454
+
455
+ <div class='push'></div><!-- for sticky footer -->
456
+ </div><!-- /wrapper -->
457
+ <div class='footer quiet pad2 space-top1 center small'>
458
+ Code coverage generated by
459
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
460
+ at 2025-11-24T21:09:09.258Z
461
+ </div>
462
+ <script src="../../prettify.js"></script>
463
+ <script>
464
+ window.onload = function () {
465
+ prettyPrint();
466
+ };
467
+ </script>
468
+ <script src="../../sorter.js"></script>
469
+ <script src="../../block-navigation.js"></script>
470
+ </body>
471
+ </html>
472
+
package/dist/src/lib/storage.effects.d.ts CHANGED
@@ -1,20 +1,20 @@
1
- import { CustomStorageObject } from '@forgerock/sdk-types';
2
- export interface StorageConfig {
3
- storeType: CustomStorageObject | 'localStorage' | 'sessionStorage';
1
+ import { CustomStorageObject, GenericError } from '@forgerock/sdk-types';
2
+ export interface StorageClient<Value> {
3
+ get: () => Promise<Value | GenericError | null>;
4
+ set: (value: Value) => Promise<GenericError | null>;
5
+ remove: () => Promise<GenericError | null>;
6
+ }
7
+ export type StorageConfig = BrowserStorageConfig | CustomStorageConfig;
8
+ export interface BrowserStorageConfig {
9
+ type: 'localStorage' | 'sessionStorage';
4
10
  prefix?: string;
11
+ name: string;
5
12
  }
6
- export interface GenericError {
7
- code?: string | number;
8
- message: string;
9
- type: 'argument_error' | 'davinci_error' | 'internal_error' | 'network_error' | 'state_error' | 'unknown_error';
13
+ export interface CustomStorageConfig {
14
+ type: 'custom';
15
+ prefix?: string;
16
+ name: string;
17
+ custom: CustomStorageObject;
10
18
  }
11
- export declare function createStorage<Value>(config: StorageConfig, storageName: string, customStore?: CustomStorageObject): {
12
- get: () => Promise<Value | GenericError | null>;
13
- set: (value: Value) => Promise<void | {
14
- code: string;
15
- message: string;
16
- type: string;
17
- }>;
18
- remove: () => Promise<void>;
19
- };
19
+ export declare function createStorage<Value>(config: StorageConfig): StorageClient<Value>;
20
20
  //# sourceMappingURL=storage.effects.d.ts.map
package/dist/src/lib/storage.effects.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"storage.effects.d.ts","sourceRoot":"","sources":["../../../src/lib/storage.effects.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,mBAAmB,GAAG,cAAc,GAAG,gBAAgB,CAAC;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EACA,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,eAAe,GACf,aAAa,GACb,eAAe,CAAC;CACrB;AAED,wBAAgB,aAAa,CAAC,KAAK,EACjC,MAAM,EAAE,aAAa,EACrB,WAAW,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,mBAAmB;eAMG,OAAO,CAAC,KAAK,GAAG,YAAY,GAAG,IAAI,CAAC;iBAiDhC,KAAK;;;;;;EA+C9C"}
1
+ {"version":3,"file":"storage.effects.d.ts","sourceRoot":"","sources":["../../../src/lib/storage.effects.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzE,MAAM,WAAW,aAAa,CAAC,KAAK;IAClC,GAAG,EAAE,MAAM,OAAO,CAAC,KAAK,GAAG,YAAY,GAAG,IAAI,CAAC,CAAC;IAChD,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IACpD,MAAM,EAAE,MAAM,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;CAC5C;AAED,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;AAEvE,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,cAAc,GAAG,gBAAgB,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,QAAQ,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AA4BD,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,GAAG,aAAa,CAAC,KAAK,CAAC,CAyEhF"}