@wxt-dev/storage 1.2.5 → 1.2.7
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.
- package/LICENSE +21 -0
- package/dist/index.d.mts +259 -258
- package/dist/index.mjs +414 -504
- package/package.json +16 -18
- package/dist/index.d.ts +0 -290
package/dist/index.mjs
CHANGED
|
@@ -1,511 +1,421 @@
|
|
|
1
|
-
import { dequal } from
|
|
2
|
-
import { Mutex } from
|
|
3
|
-
import { browser } from
|
|
1
|
+
import { dequal } from "dequal/lite";
|
|
2
|
+
import { Mutex } from "async-mutex";
|
|
3
|
+
import { browser } from "@wxt-dev/browser";
|
|
4
4
|
|
|
5
|
+
//#region src/index.ts
|
|
6
|
+
/**
|
|
7
|
+
* Simplified storage APIs with support for versioned fields, snapshots, metadata, and item definitions.
|
|
8
|
+
*
|
|
9
|
+
* See [the guide](https://wxt.dev/storage.html) for more information.
|
|
10
|
+
* @module @wxt-dev/storage
|
|
11
|
+
*/
|
|
5
12
|
const storage = createStorage();
|
|
6
13
|
function createStorage() {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
console.debug(
|
|
334
|
-
`[@wxt-dev/storage] Storage migration processed for version: v${migrateToVersion}`
|
|
335
|
-
);
|
|
336
|
-
}
|
|
337
|
-
} catch (err) {
|
|
338
|
-
throw new MigrationError(key, migrateToVersion, {
|
|
339
|
-
cause: err
|
|
340
|
-
});
|
|
341
|
-
}
|
|
342
|
-
}
|
|
343
|
-
await driver.setItems([
|
|
344
|
-
{ key: driverKey, value: migratedValue },
|
|
345
|
-
{ key: driverMetaKey, value: { ...meta, v: targetVersion } }
|
|
346
|
-
]);
|
|
347
|
-
if (debug === true) {
|
|
348
|
-
console.debug(
|
|
349
|
-
`[@wxt-dev/storage] Storage migration completed for ${key} v${targetVersion}`,
|
|
350
|
-
{ migratedValue }
|
|
351
|
-
);
|
|
352
|
-
}
|
|
353
|
-
onMigrationComplete?.(migratedValue, targetVersion);
|
|
354
|
-
};
|
|
355
|
-
const migrationsDone = opts?.migrations == null ? Promise.resolve() : migrate().catch((err) => {
|
|
356
|
-
console.error(
|
|
357
|
-
`[@wxt-dev/storage] Migration failed for ${key}`,
|
|
358
|
-
err
|
|
359
|
-
);
|
|
360
|
-
});
|
|
361
|
-
const initMutex = new Mutex();
|
|
362
|
-
const getFallback = () => opts?.fallback ?? opts?.defaultValue ?? null;
|
|
363
|
-
const getOrInitValue = () => initMutex.runExclusive(async () => {
|
|
364
|
-
const value = await driver.getItem(driverKey);
|
|
365
|
-
if (value != null || opts?.init == null) return value;
|
|
366
|
-
const newValue = await opts.init();
|
|
367
|
-
await driver.setItem(driverKey, newValue);
|
|
368
|
-
return newValue;
|
|
369
|
-
});
|
|
370
|
-
migrationsDone.then(getOrInitValue);
|
|
371
|
-
return {
|
|
372
|
-
key,
|
|
373
|
-
get defaultValue() {
|
|
374
|
-
return getFallback();
|
|
375
|
-
},
|
|
376
|
-
get fallback() {
|
|
377
|
-
return getFallback();
|
|
378
|
-
},
|
|
379
|
-
getValue: async () => {
|
|
380
|
-
await migrationsDone;
|
|
381
|
-
if (opts?.init) {
|
|
382
|
-
return await getOrInitValue();
|
|
383
|
-
} else {
|
|
384
|
-
return await getItem(driver, driverKey, opts);
|
|
385
|
-
}
|
|
386
|
-
},
|
|
387
|
-
getMeta: async () => {
|
|
388
|
-
await migrationsDone;
|
|
389
|
-
return await getMeta(driver, driverKey);
|
|
390
|
-
},
|
|
391
|
-
setValue: async (value) => {
|
|
392
|
-
await migrationsDone;
|
|
393
|
-
return await setItem(driver, driverKey, value);
|
|
394
|
-
},
|
|
395
|
-
setMeta: async (properties) => {
|
|
396
|
-
await migrationsDone;
|
|
397
|
-
return await setMeta(driver, driverKey, properties);
|
|
398
|
-
},
|
|
399
|
-
removeValue: async (opts2) => {
|
|
400
|
-
await migrationsDone;
|
|
401
|
-
return await removeItem(driver, driverKey, opts2);
|
|
402
|
-
},
|
|
403
|
-
removeMeta: async (properties) => {
|
|
404
|
-
await migrationsDone;
|
|
405
|
-
return await removeMeta(driver, driverKey, properties);
|
|
406
|
-
},
|
|
407
|
-
watch: (cb) => watch(
|
|
408
|
-
driver,
|
|
409
|
-
driverKey,
|
|
410
|
-
(newValue, oldValue) => cb(newValue ?? getFallback(), oldValue ?? getFallback())
|
|
411
|
-
),
|
|
412
|
-
migrate
|
|
413
|
-
};
|
|
414
|
-
}
|
|
415
|
-
};
|
|
416
|
-
return storage2;
|
|
14
|
+
const drivers = {
|
|
15
|
+
local: createDriver("local"),
|
|
16
|
+
session: createDriver("session"),
|
|
17
|
+
sync: createDriver("sync"),
|
|
18
|
+
managed: createDriver("managed")
|
|
19
|
+
};
|
|
20
|
+
const getDriver = (area) => {
|
|
21
|
+
const driver = drivers[area];
|
|
22
|
+
if (driver == null) {
|
|
23
|
+
const areaNames = Object.keys(drivers).join(", ");
|
|
24
|
+
throw Error(`Invalid area "${area}". Options: ${areaNames}`);
|
|
25
|
+
}
|
|
26
|
+
return driver;
|
|
27
|
+
};
|
|
28
|
+
const resolveKey = (key) => {
|
|
29
|
+
const deliminatorIndex = key.indexOf(":");
|
|
30
|
+
const driverArea = key.substring(0, deliminatorIndex);
|
|
31
|
+
const driverKey = key.substring(deliminatorIndex + 1);
|
|
32
|
+
if (driverKey == null) throw Error(`Storage key should be in the form of "area:key", but received "${key}"`);
|
|
33
|
+
return {
|
|
34
|
+
driverArea,
|
|
35
|
+
driverKey,
|
|
36
|
+
driver: getDriver(driverArea)
|
|
37
|
+
};
|
|
38
|
+
};
|
|
39
|
+
const getMetaKey = (key) => key + "$";
|
|
40
|
+
const mergeMeta = (oldMeta, newMeta) => {
|
|
41
|
+
const newFields = { ...oldMeta };
|
|
42
|
+
Object.entries(newMeta).forEach(([key, value]) => {
|
|
43
|
+
if (value == null) delete newFields[key];
|
|
44
|
+
else newFields[key] = value;
|
|
45
|
+
});
|
|
46
|
+
return newFields;
|
|
47
|
+
};
|
|
48
|
+
const getValueOrFallback = (value, fallback) => value ?? fallback ?? null;
|
|
49
|
+
const getMetaValue = (properties) => typeof properties === "object" && !Array.isArray(properties) ? properties : {};
|
|
50
|
+
const getItem = async (driver, driverKey, opts) => {
|
|
51
|
+
return getValueOrFallback(await driver.getItem(driverKey), opts?.fallback ?? opts?.defaultValue);
|
|
52
|
+
};
|
|
53
|
+
const getMeta = async (driver, driverKey) => {
|
|
54
|
+
const metaKey = getMetaKey(driverKey);
|
|
55
|
+
return getMetaValue(await driver.getItem(metaKey));
|
|
56
|
+
};
|
|
57
|
+
const setItem = async (driver, driverKey, value) => {
|
|
58
|
+
await driver.setItem(driverKey, value ?? null);
|
|
59
|
+
};
|
|
60
|
+
const setMeta = async (driver, driverKey, properties) => {
|
|
61
|
+
const metaKey = getMetaKey(driverKey);
|
|
62
|
+
const existingFields = getMetaValue(await driver.getItem(metaKey));
|
|
63
|
+
await driver.setItem(metaKey, mergeMeta(existingFields, properties));
|
|
64
|
+
};
|
|
65
|
+
const removeItem = async (driver, driverKey, opts) => {
|
|
66
|
+
await driver.removeItem(driverKey);
|
|
67
|
+
if (opts?.removeMeta) {
|
|
68
|
+
const metaKey = getMetaKey(driverKey);
|
|
69
|
+
await driver.removeItem(metaKey);
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
const removeMeta = async (driver, driverKey, properties) => {
|
|
73
|
+
const metaKey = getMetaKey(driverKey);
|
|
74
|
+
if (properties == null) await driver.removeItem(metaKey);
|
|
75
|
+
else {
|
|
76
|
+
const newFields = getMetaValue(await driver.getItem(metaKey));
|
|
77
|
+
[properties].flat().forEach((field) => delete newFields[field]);
|
|
78
|
+
await driver.setItem(metaKey, newFields);
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
const watch = (driver, driverKey, cb) => driver.watch(driverKey, cb);
|
|
82
|
+
return {
|
|
83
|
+
getItem: async (key, opts) => {
|
|
84
|
+
const { driver, driverKey } = resolveKey(key);
|
|
85
|
+
return await getItem(driver, driverKey, opts);
|
|
86
|
+
},
|
|
87
|
+
getItems: async (keys) => {
|
|
88
|
+
const areaToKeyMap = /* @__PURE__ */ new Map();
|
|
89
|
+
const keyToOptsMap = /* @__PURE__ */ new Map();
|
|
90
|
+
const orderedKeys = [];
|
|
91
|
+
keys.forEach((key) => {
|
|
92
|
+
let keyStr;
|
|
93
|
+
let opts;
|
|
94
|
+
if (typeof key === "string") keyStr = key;
|
|
95
|
+
else if ("getValue" in key) {
|
|
96
|
+
keyStr = key.key;
|
|
97
|
+
opts = { fallback: key.fallback };
|
|
98
|
+
} else {
|
|
99
|
+
keyStr = key.key;
|
|
100
|
+
opts = key.options;
|
|
101
|
+
}
|
|
102
|
+
orderedKeys.push(keyStr);
|
|
103
|
+
const { driverArea, driverKey } = resolveKey(keyStr);
|
|
104
|
+
const areaKeys = areaToKeyMap.get(driverArea) ?? [];
|
|
105
|
+
areaToKeyMap.set(driverArea, areaKeys.concat(driverKey));
|
|
106
|
+
keyToOptsMap.set(keyStr, opts);
|
|
107
|
+
});
|
|
108
|
+
const resultsMap = /* @__PURE__ */ new Map();
|
|
109
|
+
await Promise.all(Array.from(areaToKeyMap.entries()).map(async ([driverArea, keys]) => {
|
|
110
|
+
(await drivers[driverArea].getItems(keys)).forEach((driverResult) => {
|
|
111
|
+
const key = `${driverArea}:${driverResult.key}`;
|
|
112
|
+
const opts = keyToOptsMap.get(key);
|
|
113
|
+
const value = getValueOrFallback(driverResult.value, opts?.fallback ?? opts?.defaultValue);
|
|
114
|
+
resultsMap.set(key, value);
|
|
115
|
+
});
|
|
116
|
+
}));
|
|
117
|
+
return orderedKeys.map((key) => ({
|
|
118
|
+
key,
|
|
119
|
+
value: resultsMap.get(key)
|
|
120
|
+
}));
|
|
121
|
+
},
|
|
122
|
+
getMeta: async (key) => {
|
|
123
|
+
const { driver, driverKey } = resolveKey(key);
|
|
124
|
+
return await getMeta(driver, driverKey);
|
|
125
|
+
},
|
|
126
|
+
getMetas: async (args) => {
|
|
127
|
+
const keys = args.map((arg) => {
|
|
128
|
+
const key = typeof arg === "string" ? arg : arg.key;
|
|
129
|
+
const { driverArea, driverKey } = resolveKey(key);
|
|
130
|
+
return {
|
|
131
|
+
key,
|
|
132
|
+
driverArea,
|
|
133
|
+
driverKey,
|
|
134
|
+
driverMetaKey: getMetaKey(driverKey)
|
|
135
|
+
};
|
|
136
|
+
});
|
|
137
|
+
const areaToDriverMetaKeysMap = keys.reduce((map, key) => {
|
|
138
|
+
map[key.driverArea] ??= [];
|
|
139
|
+
map[key.driverArea].push(key);
|
|
140
|
+
return map;
|
|
141
|
+
}, {});
|
|
142
|
+
const resultsMap = {};
|
|
143
|
+
await Promise.all(Object.entries(areaToDriverMetaKeysMap).map(async ([area, keys]) => {
|
|
144
|
+
const areaRes = await browser.storage[area].get(keys.map((key) => key.driverMetaKey));
|
|
145
|
+
keys.forEach((key) => {
|
|
146
|
+
resultsMap[key.key] = areaRes[key.driverMetaKey] ?? {};
|
|
147
|
+
});
|
|
148
|
+
}));
|
|
149
|
+
return keys.map((key) => ({
|
|
150
|
+
key: key.key,
|
|
151
|
+
meta: resultsMap[key.key]
|
|
152
|
+
}));
|
|
153
|
+
},
|
|
154
|
+
setItem: async (key, value) => {
|
|
155
|
+
const { driver, driverKey } = resolveKey(key);
|
|
156
|
+
await setItem(driver, driverKey, value);
|
|
157
|
+
},
|
|
158
|
+
setItems: async (items) => {
|
|
159
|
+
const areaToKeyValueMap = {};
|
|
160
|
+
items.forEach((item) => {
|
|
161
|
+
const { driverArea, driverKey } = resolveKey("key" in item ? item.key : item.item.key);
|
|
162
|
+
areaToKeyValueMap[driverArea] ??= [];
|
|
163
|
+
areaToKeyValueMap[driverArea].push({
|
|
164
|
+
key: driverKey,
|
|
165
|
+
value: item.value
|
|
166
|
+
});
|
|
167
|
+
});
|
|
168
|
+
await Promise.all(Object.entries(areaToKeyValueMap).map(async ([driverArea, values]) => {
|
|
169
|
+
await getDriver(driverArea).setItems(values);
|
|
170
|
+
}));
|
|
171
|
+
},
|
|
172
|
+
setMeta: async (key, properties) => {
|
|
173
|
+
const { driver, driverKey } = resolveKey(key);
|
|
174
|
+
await setMeta(driver, driverKey, properties);
|
|
175
|
+
},
|
|
176
|
+
setMetas: async (items) => {
|
|
177
|
+
const areaToMetaUpdatesMap = {};
|
|
178
|
+
items.forEach((item) => {
|
|
179
|
+
const { driverArea, driverKey } = resolveKey("key" in item ? item.key : item.item.key);
|
|
180
|
+
areaToMetaUpdatesMap[driverArea] ??= [];
|
|
181
|
+
areaToMetaUpdatesMap[driverArea].push({
|
|
182
|
+
key: driverKey,
|
|
183
|
+
properties: item.meta
|
|
184
|
+
});
|
|
185
|
+
});
|
|
186
|
+
await Promise.all(Object.entries(areaToMetaUpdatesMap).map(async ([storageArea, updates]) => {
|
|
187
|
+
const driver = getDriver(storageArea);
|
|
188
|
+
const metaKeys = updates.map(({ key }) => getMetaKey(key));
|
|
189
|
+
const existingMetas = await driver.getItems(metaKeys);
|
|
190
|
+
const existingMetaMap = Object.fromEntries(existingMetas.map(({ key, value }) => [key, getMetaValue(value)]));
|
|
191
|
+
const metaUpdates = updates.map(({ key, properties }) => {
|
|
192
|
+
const metaKey = getMetaKey(key);
|
|
193
|
+
return {
|
|
194
|
+
key: metaKey,
|
|
195
|
+
value: mergeMeta(existingMetaMap[metaKey] ?? {}, properties)
|
|
196
|
+
};
|
|
197
|
+
});
|
|
198
|
+
await driver.setItems(metaUpdates);
|
|
199
|
+
}));
|
|
200
|
+
},
|
|
201
|
+
removeItem: async (key, opts) => {
|
|
202
|
+
const { driver, driverKey } = resolveKey(key);
|
|
203
|
+
await removeItem(driver, driverKey, opts);
|
|
204
|
+
},
|
|
205
|
+
removeItems: async (keys) => {
|
|
206
|
+
const areaToKeysMap = {};
|
|
207
|
+
keys.forEach((key) => {
|
|
208
|
+
let keyStr;
|
|
209
|
+
let opts;
|
|
210
|
+
if (typeof key === "string") keyStr = key;
|
|
211
|
+
else if ("getValue" in key) keyStr = key.key;
|
|
212
|
+
else if ("item" in key) {
|
|
213
|
+
keyStr = key.item.key;
|
|
214
|
+
opts = key.options;
|
|
215
|
+
} else {
|
|
216
|
+
keyStr = key.key;
|
|
217
|
+
opts = key.options;
|
|
218
|
+
}
|
|
219
|
+
const { driverArea, driverKey } = resolveKey(keyStr);
|
|
220
|
+
areaToKeysMap[driverArea] ??= [];
|
|
221
|
+
areaToKeysMap[driverArea].push(driverKey);
|
|
222
|
+
if (opts?.removeMeta) areaToKeysMap[driverArea].push(getMetaKey(driverKey));
|
|
223
|
+
});
|
|
224
|
+
await Promise.all(Object.entries(areaToKeysMap).map(async ([driverArea, keys]) => {
|
|
225
|
+
await getDriver(driverArea).removeItems(keys);
|
|
226
|
+
}));
|
|
227
|
+
},
|
|
228
|
+
clear: async (base) => {
|
|
229
|
+
await getDriver(base).clear();
|
|
230
|
+
},
|
|
231
|
+
removeMeta: async (key, properties) => {
|
|
232
|
+
const { driver, driverKey } = resolveKey(key);
|
|
233
|
+
await removeMeta(driver, driverKey, properties);
|
|
234
|
+
},
|
|
235
|
+
snapshot: async (base, opts) => {
|
|
236
|
+
const data = await getDriver(base).snapshot();
|
|
237
|
+
opts?.excludeKeys?.forEach((key) => {
|
|
238
|
+
delete data[key];
|
|
239
|
+
delete data[getMetaKey(key)];
|
|
240
|
+
});
|
|
241
|
+
return data;
|
|
242
|
+
},
|
|
243
|
+
restoreSnapshot: async (base, data) => {
|
|
244
|
+
await getDriver(base).restoreSnapshot(data);
|
|
245
|
+
},
|
|
246
|
+
watch: (key, cb) => {
|
|
247
|
+
const { driver, driverKey } = resolveKey(key);
|
|
248
|
+
return watch(driver, driverKey, cb);
|
|
249
|
+
},
|
|
250
|
+
unwatch() {
|
|
251
|
+
Object.values(drivers).forEach((driver) => {
|
|
252
|
+
driver.unwatch();
|
|
253
|
+
});
|
|
254
|
+
},
|
|
255
|
+
defineItem: (key, opts) => {
|
|
256
|
+
const { driver, driverKey } = resolveKey(key);
|
|
257
|
+
const { version: targetVersion = 1, migrations = {}, onMigrationComplete, debug = false } = opts ?? {};
|
|
258
|
+
if (targetVersion < 1) throw Error("Storage item version cannot be less than 1. Initial versions should be set to 1, not 0.");
|
|
259
|
+
const migrate = async () => {
|
|
260
|
+
const driverMetaKey = getMetaKey(driverKey);
|
|
261
|
+
const [{ value }, { value: meta }] = await driver.getItems([driverKey, driverMetaKey]);
|
|
262
|
+
if (value == null) return;
|
|
263
|
+
const currentVersion = meta?.v ?? 1;
|
|
264
|
+
if (currentVersion > targetVersion) throw Error(`Version downgrade detected (v${currentVersion} -> v${targetVersion}) for "${key}"`);
|
|
265
|
+
if (currentVersion === targetVersion) return;
|
|
266
|
+
if (debug) console.debug(`[@wxt-dev/storage] Running storage migration for ${key}: v${currentVersion} -> v${targetVersion}`);
|
|
267
|
+
const migrationsToRun = Array.from({ length: targetVersion - currentVersion }, (_, i) => currentVersion + i + 1);
|
|
268
|
+
let migratedValue = value;
|
|
269
|
+
for (const migrateToVersion of migrationsToRun) try {
|
|
270
|
+
migratedValue = await migrations?.[migrateToVersion]?.(migratedValue) ?? migratedValue;
|
|
271
|
+
if (debug) console.debug(`[@wxt-dev/storage] Storage migration processed for version: v${migrateToVersion}`);
|
|
272
|
+
} catch (err) {
|
|
273
|
+
throw new MigrationError(key, migrateToVersion, { cause: err });
|
|
274
|
+
}
|
|
275
|
+
await driver.setItems([{
|
|
276
|
+
key: driverKey,
|
|
277
|
+
value: migratedValue
|
|
278
|
+
}, {
|
|
279
|
+
key: driverMetaKey,
|
|
280
|
+
value: {
|
|
281
|
+
...meta,
|
|
282
|
+
v: targetVersion
|
|
283
|
+
}
|
|
284
|
+
}]);
|
|
285
|
+
if (debug) console.debug(`[@wxt-dev/storage] Storage migration completed for ${key} v${targetVersion}`, { migratedValue });
|
|
286
|
+
onMigrationComplete?.(migratedValue, targetVersion);
|
|
287
|
+
};
|
|
288
|
+
const migrationsDone = opts?.migrations == null ? Promise.resolve() : migrate().catch((err) => {
|
|
289
|
+
console.error(`[@wxt-dev/storage] Migration failed for ${key}`, err);
|
|
290
|
+
});
|
|
291
|
+
const initMutex = new Mutex();
|
|
292
|
+
const getFallback = () => opts?.fallback ?? opts?.defaultValue ?? null;
|
|
293
|
+
const getOrInitValue = () => initMutex.runExclusive(async () => {
|
|
294
|
+
const value = await driver.getItem(driverKey);
|
|
295
|
+
if (value != null || opts?.init == null) return value;
|
|
296
|
+
const newValue = await opts.init();
|
|
297
|
+
await driver.setItem(driverKey, newValue);
|
|
298
|
+
if (value == null && targetVersion > 1) await setMeta(driver, driverKey, { v: targetVersion });
|
|
299
|
+
return newValue;
|
|
300
|
+
});
|
|
301
|
+
migrationsDone.then(getOrInitValue);
|
|
302
|
+
return {
|
|
303
|
+
key,
|
|
304
|
+
get defaultValue() {
|
|
305
|
+
return getFallback();
|
|
306
|
+
},
|
|
307
|
+
get fallback() {
|
|
308
|
+
return getFallback();
|
|
309
|
+
},
|
|
310
|
+
getValue: async () => {
|
|
311
|
+
await migrationsDone;
|
|
312
|
+
if (opts?.init) return await getOrInitValue();
|
|
313
|
+
else return await getItem(driver, driverKey, opts);
|
|
314
|
+
},
|
|
315
|
+
getMeta: async () => {
|
|
316
|
+
await migrationsDone;
|
|
317
|
+
return await getMeta(driver, driverKey);
|
|
318
|
+
},
|
|
319
|
+
setValue: async (value) => {
|
|
320
|
+
await migrationsDone;
|
|
321
|
+
return await setItem(driver, driverKey, value);
|
|
322
|
+
},
|
|
323
|
+
setMeta: async (properties) => {
|
|
324
|
+
await migrationsDone;
|
|
325
|
+
return await setMeta(driver, driverKey, properties);
|
|
326
|
+
},
|
|
327
|
+
removeValue: async (opts) => {
|
|
328
|
+
await migrationsDone;
|
|
329
|
+
return await removeItem(driver, driverKey, opts);
|
|
330
|
+
},
|
|
331
|
+
removeMeta: async (properties) => {
|
|
332
|
+
await migrationsDone;
|
|
333
|
+
return await removeMeta(driver, driverKey, properties);
|
|
334
|
+
},
|
|
335
|
+
watch: (cb) => watch(driver, driverKey, (newValue, oldValue) => cb(newValue ?? getFallback(), oldValue ?? getFallback())),
|
|
336
|
+
migrate
|
|
337
|
+
};
|
|
338
|
+
}
|
|
339
|
+
};
|
|
417
340
|
}
|
|
418
341
|
function createDriver(storageArea) {
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
getStorageArea().onChanged.addListener(listener);
|
|
489
|
-
watchListeners.add(listener);
|
|
490
|
-
return () => {
|
|
491
|
-
getStorageArea().onChanged.removeListener(listener);
|
|
492
|
-
watchListeners.delete(listener);
|
|
493
|
-
};
|
|
494
|
-
},
|
|
495
|
-
unwatch() {
|
|
496
|
-
watchListeners.forEach((listener) => {
|
|
497
|
-
getStorageArea().onChanged.removeListener(listener);
|
|
498
|
-
});
|
|
499
|
-
watchListeners.clear();
|
|
500
|
-
}
|
|
501
|
-
};
|
|
502
|
-
}
|
|
503
|
-
class MigrationError extends Error {
|
|
504
|
-
constructor(key, version, options) {
|
|
505
|
-
super(`v${version} migration failed for "${key}"`, options);
|
|
506
|
-
this.key = key;
|
|
507
|
-
this.version = version;
|
|
508
|
-
}
|
|
342
|
+
const getStorageArea = () => {
|
|
343
|
+
if (browser.runtime == null) throw Error(`'wxt/storage' must be loaded in a web extension environment
|
|
344
|
+
|
|
345
|
+
- If thrown during a build, see https://github.com/wxt-dev/wxt/issues/371
|
|
346
|
+
- If thrown during tests, mock 'wxt/browser' correctly. See https://wxt.dev/guide/go-further/testing.html
|
|
347
|
+
`);
|
|
348
|
+
if (browser.storage == null) throw Error("You must add the 'storage' permission to your manifest to use 'wxt/storage'");
|
|
349
|
+
const area = browser.storage[storageArea];
|
|
350
|
+
if (area == null) throw Error(`"browser.storage.${storageArea}" is undefined`);
|
|
351
|
+
return area;
|
|
352
|
+
};
|
|
353
|
+
const watchListeners = /* @__PURE__ */ new Set();
|
|
354
|
+
return {
|
|
355
|
+
getItem: async (key) => {
|
|
356
|
+
return (await getStorageArea().get(key))[key];
|
|
357
|
+
},
|
|
358
|
+
getItems: async (keys) => {
|
|
359
|
+
const result = await getStorageArea().get(keys);
|
|
360
|
+
return keys.map((key) => ({
|
|
361
|
+
key,
|
|
362
|
+
value: result[key] ?? null
|
|
363
|
+
}));
|
|
364
|
+
},
|
|
365
|
+
setItem: async (key, value) => {
|
|
366
|
+
if (value == null) await getStorageArea().remove(key);
|
|
367
|
+
else await getStorageArea().set({ [key]: value });
|
|
368
|
+
},
|
|
369
|
+
setItems: async (values) => {
|
|
370
|
+
const map = values.reduce((map, { key, value }) => {
|
|
371
|
+
map[key] = value;
|
|
372
|
+
return map;
|
|
373
|
+
}, {});
|
|
374
|
+
await getStorageArea().set(map);
|
|
375
|
+
},
|
|
376
|
+
removeItem: async (key) => {
|
|
377
|
+
await getStorageArea().remove(key);
|
|
378
|
+
},
|
|
379
|
+
removeItems: async (keys) => {
|
|
380
|
+
await getStorageArea().remove(keys);
|
|
381
|
+
},
|
|
382
|
+
clear: async () => {
|
|
383
|
+
await getStorageArea().clear();
|
|
384
|
+
},
|
|
385
|
+
snapshot: async () => {
|
|
386
|
+
return await getStorageArea().get();
|
|
387
|
+
},
|
|
388
|
+
restoreSnapshot: async (data) => {
|
|
389
|
+
await getStorageArea().set(data);
|
|
390
|
+
},
|
|
391
|
+
watch(key, cb) {
|
|
392
|
+
const listener = (changes) => {
|
|
393
|
+
const change = changes[key];
|
|
394
|
+
if (change == null || dequal(change.newValue, change.oldValue)) return;
|
|
395
|
+
cb(change.newValue ?? null, change.oldValue ?? null);
|
|
396
|
+
};
|
|
397
|
+
getStorageArea().onChanged.addListener(listener);
|
|
398
|
+
watchListeners.add(listener);
|
|
399
|
+
return () => {
|
|
400
|
+
getStorageArea().onChanged.removeListener(listener);
|
|
401
|
+
watchListeners.delete(listener);
|
|
402
|
+
};
|
|
403
|
+
},
|
|
404
|
+
unwatch() {
|
|
405
|
+
watchListeners.forEach((listener) => {
|
|
406
|
+
getStorageArea().onChanged.removeListener(listener);
|
|
407
|
+
});
|
|
408
|
+
watchListeners.clear();
|
|
409
|
+
}
|
|
410
|
+
};
|
|
509
411
|
}
|
|
412
|
+
var MigrationError = class extends Error {
|
|
413
|
+
constructor(key, version, options) {
|
|
414
|
+
super(`v${version} migration failed for "${key}"`, options);
|
|
415
|
+
this.key = key;
|
|
416
|
+
this.version = version;
|
|
417
|
+
}
|
|
418
|
+
};
|
|
510
419
|
|
|
511
|
-
|
|
420
|
+
//#endregion
|
|
421
|
+
export { MigrationError, storage };
|