@fireproof/core 0.0.8 → 0.0.10

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 (31) hide show
  1. package/README.md +148 -0
  2. package/hooks/use-fireproof.ts +14 -8
  3. package/index.js +2 -1
  4. package/package.json +2 -1
  5. package/src/db-index.js +78 -37
  6. package/src/fireproof.js +18 -30
  7. package/src/hydrator.js +47 -6
  8. package/test/db-index.test.js +5 -4
  9. package/test/fireproof.test.js +2 -2
  10. package/test/hydrator.test.js +5 -5
  11. package/test/listener.test.js +2 -1
  12. package/coverage/base.css +0 -224
  13. package/coverage/block-navigation.js +0 -87
  14. package/coverage/block.js.html +0 -280
  15. package/coverage/blockstore.js.html +0 -928
  16. package/coverage/clock.js.html +0 -1078
  17. package/coverage/db-index.js.html +0 -907
  18. package/coverage/favicon.png +0 -0
  19. package/coverage/fireproof.js.html +0 -1042
  20. package/coverage/index.html +0 -206
  21. package/coverage/listener.js.html +0 -409
  22. package/coverage/prettify.css +0 -1
  23. package/coverage/prettify.js +0 -2
  24. package/coverage/prolly.js.html +0 -931
  25. package/coverage/sort-arrow-sprite.png +0 -0
  26. package/coverage/sorter.js +0 -196
  27. package/coverage/tmp/coverage-28490-1680373005621-0.json +0 -1
  28. package/coverage/tmp/coverage-28494-1680373004502-0.json +0 -1
  29. package/coverage/tmp/coverage-28500-1680373005593-0.json +0 -1
  30. package/coverage/tmp/coverage-28504-1680373005559-0.json +0 -1
  31. package/coverage/valet.js.html +0 -439
package/coverage/valet.js.html DELETED
@@ -1,439 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for valet.js</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> valet.js</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">94.91% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>112/118</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">86.36% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>19/22</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">100% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>6/6</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">94.91% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>112/118</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 oninput="onInput()" type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line high'></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></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
185
- <span class="cline-any cline-yes">1x</span>
186
- <span class="cline-any cline-yes">1x</span>
187
- <span class="cline-any cline-yes">1x</span>
188
- <span class="cline-any cline-yes">1x</span>
189
- <span class="cline-any cline-yes">1x</span>
190
- <span class="cline-any cline-yes">43x</span>
191
- <span class="cline-any cline-yes">43x</span>
192
- <span class="cline-any cline-yes">43x</span>
193
- <span class="cline-any cline-yes">43x</span>
194
- <span class="cline-any cline-yes">43x</span>
195
- <span class="cline-any cline-yes">43x</span>
196
- <span class="cline-any cline-yes">43x</span>
197
- <span class="cline-any cline-yes">43x</span>
198
- <span class="cline-any cline-yes">43x</span>
199
- <span class="cline-any cline-yes">43x</span>
200
- <span class="cline-any cline-yes">43x</span>
201
- <span class="cline-any cline-yes">43x</span>
202
- <span class="cline-any cline-yes">43x</span>
203
- <span class="cline-any cline-yes">1x</span>
204
- <span class="cline-any cline-yes">1x</span>
205
- <span class="cline-any cline-yes">1x</span>
206
- <span class="cline-any cline-yes">1x</span>
207
- <span class="cline-any cline-yes">1x</span>
208
- <span class="cline-any cline-yes">1x</span>
209
- <span class="cline-any cline-yes">1x</span>
210
- <span class="cline-any cline-yes">1x</span>
211
- <span class="cline-any cline-yes">1x</span>
212
- <span class="cline-any cline-yes">1x</span>
213
- <span class="cline-any cline-yes">1x</span>
214
- <span class="cline-any cline-yes">1x</span>
215
- <span class="cline-any cline-yes">1x</span>
216
- <span class="cline-any cline-yes">1x</span>
217
- <span class="cline-any cline-yes">1x</span>
218
- <span class="cline-any cline-yes">1x</span>
219
- <span class="cline-any cline-yes">1x</span>
220
- <span class="cline-any cline-no">&nbsp;</span>
221
- <span class="cline-any cline-yes">43x</span>
222
- <span class="cline-any cline-yes">43x</span>
223
- <span class="cline-any cline-yes">43x</span>
224
- <span class="cline-any cline-yes">1x</span>
225
- <span class="cline-any cline-yes">1x</span>
226
- <span class="cline-any cline-yes">1x</span>
227
- <span class="cline-any cline-yes">51x</span>
228
- <span class="cline-any cline-yes">51x</span>
229
- <span class="cline-any cline-yes">51x</span>
230
- <span class="cline-any cline-yes">51x</span>
231
- <span class="cline-any cline-yes">51x</span>
232
- <span class="cline-any cline-yes">1x</span>
233
- <span class="cline-any cline-yes">43x</span>
234
- <span class="cline-any cline-yes">43x</span>
235
- <span class="cline-any cline-yes">43x</span>
236
- <span class="cline-any cline-yes">43x</span>
237
- <span class="cline-any cline-yes">190x</span>
238
- <span class="cline-any cline-yes">41x</span>
239
- <span class="cline-any cline-yes">41x</span>
240
- <span class="cline-any cline-yes">2x</span>
241
- <span class="cline-any cline-yes">2x</span>
242
- <span class="cline-any cline-yes">2x</span>
243
- <span class="cline-any cline-yes">2x</span>
244
- <span class="cline-any cline-yes">2x</span>
245
- <span class="cline-any cline-yes">2x</span>
246
- <span class="cline-any cline-yes">2x</span>
247
- <span class="cline-any cline-yes">2x</span>
248
- <span class="cline-any cline-yes">2x</span>
249
- <span class="cline-any cline-yes">2x</span>
250
- <span class="cline-any cline-yes">41x</span>
251
- <span class="cline-any cline-yes">41x</span>
252
- <span class="cline-any cline-yes">190x</span>
253
- <span class="cline-any cline-yes">190x</span>
254
- <span class="cline-any cline-yes">43x</span>
255
- <span class="cline-any cline-yes">43x</span>
256
- <span class="cline-any cline-yes">43x</span>
257
- <span class="cline-any cline-yes">43x</span>
258
- <span class="cline-any cline-yes">43x</span>
259
- <span class="cline-any cline-yes">43x</span>
260
- <span class="cline-any cline-yes">43x</span>
261
- <span class="cline-any cline-yes">187x</span>
262
- <span class="cline-any cline-yes">187x</span>
263
- <span class="cline-any cline-yes">187x</span>
264
- <span class="cline-any cline-yes">187x</span>
265
- <span class="cline-any cline-yes">187x</span>
266
- <span class="cline-any cline-yes">187x</span>
267
- <span class="cline-any cline-yes">187x</span>
268
- <span class="cline-any cline-yes">187x</span>
269
- <span class="cline-any cline-yes">187x</span>
270
- <span class="cline-any cline-yes">1x</span>
271
- <span class="cline-any cline-no">&nbsp;</span>
272
- <span class="cline-any cline-no">&nbsp;</span>
273
- <span class="cline-any cline-no">&nbsp;</span>
274
- <span class="cline-any cline-yes">1x</span>
275
- <span class="cline-any cline-yes">1x</span>
276
- <span class="cline-any cline-yes">1x</span>
277
- <span class="cline-any cline-yes">1x</span>
278
- <span class="cline-any cline-yes">187x</span>
279
- <span class="cline-any cline-yes">186x</span>
280
- <span class="cline-any cline-yes">186x</span>
281
- <span class="cline-any cline-yes">187x</span>
282
- <span class="cline-any cline-yes">43x</span>
283
- <span class="cline-any cline-yes">43x</span>
284
- <span class="cline-any cline-yes">43x</span>
285
- <span class="cline-any cline-yes">43x</span>
286
- <span class="cline-any cline-yes">1x</span>
287
- <span class="cline-any cline-yes">1x</span>
288
- <span class="cline-any cline-yes">1x</span>
289
- <span class="cline-any cline-yes">1x</span>
290
- <span class="cline-any cline-yes">1x</span>
291
- <span class="cline-any cline-no">&nbsp;</span>
292
- <span class="cline-any cline-no">&nbsp;</span>
293
- <span class="cline-any cline-yes">1x</span>
294
- <span class="cline-any cline-yes">1x</span>
295
- <span class="cline-any cline-yes">1x</span>
296
- <span class="cline-any cline-yes">1x</span>
297
- <span class="cline-any cline-yes">1x</span>
298
- <span class="cline-any cline-yes">1x</span>
299
- <span class="cline-any cline-yes">1x</span>
300
- <span class="cline-any cline-yes">1x</span>
301
- <span class="cline-any cline-yes">43x</span>
302
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { CarReader } from '@ipld/car'
303
- import { CID } from 'multiformats/cid'
304
- import { openDB } from 'idb'
305
- import cargoQueue from 'async/cargoQueue.js'
306
- &nbsp;
307
- export default class Valet {
308
- idb = null
309
- #uploadQueue = null
310
- #alreadyEnqueued = new Set()
311
- &nbsp;
312
- /**
313
- * Function installed by the database to upload car files
314
- * @type {null|function(string, Uint8Array):Promise&lt;void&gt;}
315
- */
316
- uploadFunction = null
317
- &nbsp;
318
- constructor (name = 'default') {
319
- this.name = name
320
- this.#uploadQueue = cargoQueue(async (tasks, callback) =&gt; {
321
- console.log(
322
- 'queue worker',
323
- tasks.length,
324
- tasks.reduce((acc, t) =&gt; acc + t.value.length, 0)
325
- )
326
- if (this.uploadFunction) {
327
- // todo we can coalesce these into a single car file
328
- return await this.withDB(async (db) =&gt; {
329
- for (const task of tasks) {
330
- await this.uploadFunction(task.carCid, task.value)
331
- // update the indexedb to mark this car as no longer pending
332
- const carMeta = await db.get('cidToCar', task.carCid)
333
- delete carMeta.pending
334
- await db.put('cidToCar', carMeta)
335
- }
336
- })
337
- }
338
- <span class="cstat-no" title="statement not covered" ><span class="branch-0 cbranch-no" title="branch not covered" > callback()</span></span>
339
- })
340
- &nbsp;
341
- this.#uploadQueue.drain(async () =&gt; {
342
- return await this.withDB(async (db) =&gt; {
343
- const carKeys = (await db.getAllFromIndex('cidToCar', 'pending')).map((c) =&gt; c.car)
344
- for (const carKey of carKeys) {
345
- await this.uploadFunction(carKey, await db.get('cars', carKey))
346
- const carMeta = await db.get('cidToCar', carKey)
347
- delete carMeta.pending
348
- await db.put('cidToCar', carMeta)
349
- }
350
- })
351
- })
352
- }
353
- &nbsp;
354
- withDB = async (dbWorkFun) =&gt; {
355
- if (!this.idb) {
356
- this.idb = await openDB(`fp.${this.name}.valet`, 2, {
357
- upgrade (db, oldVersion, newVersion, transaction) {
358
- if (oldVersion &lt; 1) {
359
- db.createObjectStore('cars') // todo use database name
360
- const cidToCar = db.createObjectStore('cidToCar', { keyPath: 'car' })
361
- cidToCar.createIndex('cids', 'cids', { multiEntry: true })
362
- }
363
- if (oldVersion &lt; 2) {
364
- const cidToCar = transaction.objectStore('cidToCar')
365
- cidToCar.createIndex('pending', 'pending')
366
- }
367
- }
368
- })
369
- }
370
- return await dbWorkFun(this.idb)
371
- }
372
- &nbsp;
373
- /**
374
- *
375
- * @param {string} carCid
376
- * @param {*} value
377
- */
378
- async parkCar (carCid, value, cids) {
379
- await this.withDB(async (db) =&gt; {
380
- const tx = db.transaction(['cars', 'cidToCar'], 'readwrite')
381
- await tx.objectStore('cars').put(value, carCid)
382
- await tx.objectStore('cidToCar').put({ pending: 'y', car: carCid, cids: Array.from(cids) })
383
- return await tx.done
384
- })
385
- &nbsp;
386
- // upload to web3.storage if we have credentials
387
- if (this.uploadFunction) {
388
- if (this.#alreadyEnqueued.has(carCid)) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
389
- <span class="cstat-no" title="statement not covered" > // console.log('already enqueued', carCid)</span>
390
- <span class="cstat-no" title="statement not covered" > return</span>
391
- <span class="cstat-no" title="statement not covered" > }</span>
392
- // don't await this, it will be done in the queue
393
- // console.log('add to queue', carCid, value.length)
394
- this.#uploadQueue.push({ carCid, value })
395
- this.#alreadyEnqueued.add(carCid)
396
- } else {
397
- // console.log('no upload function', carCid, value.length, this.uploadFunction)
398
- }
399
- }
400
- &nbsp;
401
- remoteBlockFunction = null
402
- &nbsp;
403
- async getBlock (dataCID) {
404
- return await this.withDB(async (db) =&gt; {
405
- const tx = db.transaction(['cars', 'cidToCar'], 'readonly')
406
- const indexResp = await tx.objectStore('cidToCar').index('cids').get(dataCID)
407
- const carCid = indexResp?.car
408
- if (!carCid) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
409
- <span class="cstat-no" title="statement not covered" > throw new Error('Missing block: ' + dataCID)</span>
410
- <span class="cstat-no" title="statement not covered" > }</span>
411
- const carBytes = await tx.objectStore('cars').get(carCid)
412
- const reader = await CarReader.fromBytes(carBytes)
413
- const gotBlock = await reader.get(CID.parse(dataCID))
414
- if (gotBlock) {
415
- return gotBlock.bytes
416
- }
417
- })
418
- }
419
- }
420
- &nbsp;</pre></td></tr></table></pre>
421
-
422
- <div class='push'></div><!-- for sticky footer -->
423
- </div><!-- /wrapper -->
424
- <div class='footer quiet pad2 space-top1 center small'>
425
- Code coverage generated by
426
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
427
- at 2023-04-01T18:16:45.716Z
428
- </div>
429
- <script src="prettify.js"></script>
430
- <script>
431
- window.onload = function () {
432
- prettyPrint();
433
- };
434
- </script>
435
- <script src="sorter.js"></script>
436
- <script src="block-navigation.js"></script>
437
- </body>
438
- </html>
439
-