@choksheak/ts-utils 0.2.8 → 0.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.
- package/README.md +2 -0
- package/{arrayBuffer.js → arrayBuffer.cjs} +0 -1
- package/arrayBuffer.d.mts +10 -0
- package/arrayBuffer.min.cjs +2 -0
- package/arrayBuffer.min.cjs.map +1 -0
- package/arrayBuffer.min.mjs +2 -0
- package/{arrayBuffer.js.map → arrayBuffer.min.mjs.map} +1 -1
- package/arrayBuffer.mjs +14 -0
- package/{assert.js → assert.cjs} +3 -2
- package/assert.d.mts +7 -0
- package/assert.d.ts +1 -1
- package/assert.min.cjs +2 -0
- package/assert.min.cjs.map +1 -0
- package/assert.min.mjs +2 -0
- package/assert.min.mjs.map +1 -0
- package/assert.mjs +11 -0
- package/{average.js → average.cjs} +0 -1
- package/average.d.mts +7 -0
- package/average.min.cjs +2 -0
- package/{average.js.map → average.min.cjs.map} +1 -1
- package/average.min.mjs +2 -0
- package/average.min.mjs.map +1 -0
- package/average.mjs +20 -0
- package/base64Url.cjs +40 -0
- package/base64Url.d.mts +10 -0
- package/base64Url.d.ts +8 -0
- package/base64Url.min.cjs +2 -0
- package/base64Url.min.cjs.map +1 -0
- package/base64Url.min.mjs +2 -0
- package/base64Url.min.mjs.map +1 -0
- package/base64Url.mjs +14 -0
- package/{dateTimeStr.js → dateTimeStr.cjs} +0 -1
- package/dateTimeStr.d.mts +85 -0
- package/dateTimeStr.min.cjs +2 -0
- package/dateTimeStr.min.cjs.map +1 -0
- package/dateTimeStr.min.mjs +2 -0
- package/{dateTimeStr.js.map → dateTimeStr.min.mjs.map} +1 -1
- package/dateTimeStr.mjs +83 -0
- package/{duration.js → duration.cjs} +9 -11
- package/duration.d.mts +78 -0
- package/duration.min.cjs +2 -0
- package/duration.min.cjs.map +1 -0
- package/duration.min.mjs +2 -0
- package/duration.min.mjs.map +1 -0
- package/duration.mjs +154 -0
- package/{isEmpty.js → isEmpty.cjs} +0 -1
- package/isEmpty.d.mts +6 -0
- package/isEmpty.min.cjs +2 -0
- package/isEmpty.min.cjs.map +1 -0
- package/isEmpty.min.mjs +2 -0
- package/{isEmpty.js.map → isEmpty.min.mjs.map} +1 -1
- package/isEmpty.mjs +22 -0
- package/kvStore.cjs +333 -0
- package/kvStore.d.mts +97 -0
- package/kvStore.min.cjs +2 -0
- package/kvStore.min.cjs.map +1 -0
- package/kvStore.min.mjs +2 -0
- package/kvStore.min.mjs.map +1 -0
- package/kvStore.mjs +300 -0
- package/{localStorageCache.js → localStorageCache.cjs} +5 -7
- package/localStorageCache.d.mts +57 -0
- package/localStorageCache.min.cjs +2 -0
- package/localStorageCache.min.cjs.map +1 -0
- package/localStorageCache.min.mjs +2 -0
- package/localStorageCache.min.mjs.map +1 -0
- package/localStorageCache.mjs +92 -0
- package/{logging.js → logging.cjs} +0 -1
- package/logging.d.mts +4 -0
- package/logging.min.cjs +2 -0
- package/logging.min.cjs.map +1 -0
- package/logging.min.mjs +2 -0
- package/{logging.js.map → logging.min.mjs.map} +1 -1
- package/logging.mjs +21 -0
- package/{nonEmpty.js → nonEmpty.cjs} +0 -1
- package/nonEmpty.d.mts +10 -0
- package/nonEmpty.min.cjs +2 -0
- package/{nonEmpty.js.map → nonEmpty.min.cjs.map} +1 -1
- package/nonEmpty.min.mjs +2 -0
- package/nonEmpty.min.mjs.map +1 -0
- package/nonEmpty.mjs +30 -0
- package/{nonNil.js → nonNil.cjs} +0 -1
- package/{src/nonNil.ts → nonNil.d.mts} +3 -6
- package/nonNil.min.cjs +2 -0
- package/nonNil.min.cjs.map +1 -0
- package/nonNil.min.mjs +2 -0
- package/{nonNil.js.map → nonNil.min.mjs.map} +1 -1
- package/nonNil.mjs +10 -0
- package/package.json +414 -24
- package/{round.js → round.cjs} +0 -1
- package/{src/round.ts → round.d.mts} +4 -8
- package/round.min.cjs +2 -0
- package/round.min.cjs.map +1 -0
- package/round.min.mjs +2 -0
- package/{round.js.map → round.min.mjs.map} +1 -1
- package/round.mjs +12 -0
- package/{safeBtoa.js → safeBtoa.cjs} +0 -1
- package/safeBtoa.d.mts +6 -0
- package/safeBtoa.min.cjs +2 -0
- package/safeBtoa.min.cjs.map +1 -0
- package/safeBtoa.min.mjs +2 -0
- package/{safeBtoa.js.map → safeBtoa.min.mjs.map} +1 -1
- package/safeBtoa.mjs +9 -0
- package/{safeParseFloat.js → safeParseFloat.cjs} +0 -1
- package/safeParseFloat.d.mts +6 -0
- package/safeParseFloat.min.cjs +2 -0
- package/safeParseFloat.min.cjs.map +1 -0
- package/safeParseFloat.min.mjs +2 -0
- package/{safeParseFloat.js.map → safeParseFloat.min.mjs.map} +1 -1
- package/safeParseFloat.mjs +8 -0
- package/{safeParseInt.js → safeParseInt.cjs} +0 -1
- package/safeParseInt.d.mts +6 -0
- package/safeParseInt.min.cjs +2 -0
- package/safeParseInt.min.cjs.map +1 -0
- package/safeParseInt.min.mjs +2 -0
- package/{safeParseInt.js.map → safeParseInt.min.mjs.map} +1 -1
- package/safeParseInt.mjs +8 -0
- package/sha256.cjs +35 -0
- package/sha256.d.mts +6 -0
- package/sha256.min.cjs +2 -0
- package/sha256.min.cjs.map +1 -0
- package/sha256.min.mjs +2 -0
- package/{sha256.js.map → sha256.min.mjs.map} +1 -1
- package/sha256.mjs +10 -0
- package/{sleep.js → sleep.cjs} +0 -1
- package/{src/sleep.ts → sleep.d.mts} +3 -3
- package/sleep.min.cjs +2 -0
- package/sleep.min.cjs.map +1 -0
- package/sleep.min.mjs +2 -0
- package/{sleep.js.map → sleep.min.mjs.map} +1 -1
- package/sleep.mjs +7 -0
- package/{sum.js → sum.cjs} +0 -1
- package/sum.d.mts +7 -0
- package/sum.min.cjs +2 -0
- package/sum.min.cjs.map +1 -0
- package/sum.min.mjs +2 -0
- package/{sum.js.map → sum.min.mjs.map} +1 -1
- package/sum.mjs +13 -0
- package/{timeConstants.js → timeConstants.cjs} +0 -1
- package/timeConstants.d.mts +20 -0
- package/timeConstants.min.cjs +2 -0
- package/timeConstants.min.cjs.map +1 -0
- package/timeConstants.min.mjs +2 -0
- package/{timeConstants.js.map → timeConstants.min.mjs.map} +1 -1
- package/timeConstants.mjs +31 -0
- package/{timer.js → timer.cjs} +6 -6
- package/timer.d.mts +13 -0
- package/timer.min.cjs +2 -0
- package/timer.min.cjs.map +1 -0
- package/timer.min.mjs +2 -0
- package/timer.min.mjs.map +1 -0
- package/timer.mjs +161 -0
- package/assert.js.map +0 -1
- package/docs/.nojekyll +0 -1
- package/docs/assets/hierarchy.js +0 -1
- package/docs/assets/highlight.css +0 -22
- package/docs/assets/icons.js +0 -18
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/main.js +0 -60
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1640
- package/docs/classes/kvStore.KVStore.html +0 -26
- package/docs/classes/kvStore.KVStoreField.html +0 -7
- package/docs/classes/timer.Timer.html +0 -8
- package/docs/functions/arrayBuffer.arrayBufferToBase64.html +0 -2
- package/docs/functions/arrayBuffer.arrayBufferToHex.html +0 -2
- package/docs/functions/assert.assert.html +0 -3
- package/docs/functions/average.average.html +0 -3
- package/docs/functions/dateTimeStr.getDisplayDateTime.html +0 -3
- package/docs/functions/dateTimeStr.getLongMonthNameOneIndexed.html +0 -4
- package/docs/functions/dateTimeStr.getLongMonthNameZeroIndexed.html +0 -4
- package/docs/functions/dateTimeStr.getShortMonthNameOneIndexed.html +0 -4
- package/docs/functions/dateTimeStr.getShortMonthNameZeroIndexed.html +0 -4
- package/docs/functions/dateTimeStr.hhMm.html +0 -4
- package/docs/functions/dateTimeStr.hhMmSs.html +0 -4
- package/docs/functions/dateTimeStr.hhMmSsMs.html +0 -5
- package/docs/functions/dateTimeStr.toDate.html +0 -4
- package/docs/functions/dateTimeStr.tzShort.html +0 -4
- package/docs/functions/dateTimeStr.yyyyMm.html +0 -4
- package/docs/functions/dateTimeStr.yyyyMmDd.html +0 -4
- package/docs/functions/duration.durationOrMsToMs.html +0 -2
- package/docs/functions/duration.durationToMs.html +0 -2
- package/docs/functions/duration.elapsed.html +0 -2
- package/docs/functions/duration.formatDuration.html +0 -4
- package/docs/functions/duration.msToDuration.html +0 -5
- package/docs/functions/duration.readableDuration.html +0 -4
- package/docs/functions/isEmpty.isEmpty.html +0 -2
- package/docs/functions/kvStore.kvStoreItem.html +0 -2
- package/docs/functions/localStorageCache.storeItem.html +0 -15
- package/docs/functions/logging.capLength.html +0 -1
- package/docs/functions/logging.stringify.html +0 -1
- package/docs/functions/nonEmpty.nonEmpty.html +0 -5
- package/docs/functions/nonNil.nonNil.html +0 -5
- package/docs/functions/round.round.html +0 -5
- package/docs/functions/round.roundS.html +0 -3
- package/docs/functions/safeBtoa.safeBtoa.html +0 -2
- package/docs/functions/safeParseFloat.safeParseFloat.html +0 -2
- package/docs/functions/safeParseInt.safeParseInt.html +0 -2
- package/docs/functions/sha256.sha256.html +0 -2
- package/docs/functions/sleep.sleep.html +0 -3
- package/docs/functions/sum.sum.html +0 -3
- package/docs/functions/timer.timer.html +0 -2
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -4
- package/docs/modules/arrayBuffer.html +0 -1
- package/docs/modules/assert.html +0 -1
- package/docs/modules/average.html +0 -1
- package/docs/modules/dateTimeStr.html +0 -1
- package/docs/modules/duration.html +0 -1
- package/docs/modules/isEmpty.html +0 -1
- package/docs/modules/kvStore.html +0 -1
- package/docs/modules/localStorageCache.html +0 -1
- package/docs/modules/logging.html +0 -1
- package/docs/modules/nonEmpty.html +0 -1
- package/docs/modules/nonNil.html +0 -1
- package/docs/modules/round.html +0 -1
- package/docs/modules/safeBtoa.html +0 -1
- package/docs/modules/safeParseFloat.html +0 -1
- package/docs/modules/safeParseInt.html +0 -1
- package/docs/modules/sha256.html +0 -1
- package/docs/modules/sleep.html +0 -1
- package/docs/modules/sum.html +0 -1
- package/docs/modules/timeConstants.html +0 -1
- package/docs/modules/timer.html +0 -1
- package/docs/modules.html +0 -1
- package/docs/types/dateTimeStr.AnyDateTime.html +0 -1
- package/docs/types/duration.Duration.html +0 -6
- package/docs/types/duration.DurationStyle.html +0 -6
- package/docs/types/duration.DurationSuffixMap.html +0 -6
- package/docs/types/duration.DurationSuffixType.html +0 -1
- package/docs/types/duration.DurationType.html +0 -2
- package/docs/types/localStorageCache.StoredItem.html +0 -4
- package/docs/variables/duration.DURATION_STYLE_SUFFIX_MAP.html +0 -1
- package/docs/variables/duration.DURATION_TYPE_SEQUENCE.html +0 -2
- package/docs/variables/kvStore.DEFAULT_EXPIRY_DELTA_MS.html +0 -2
- package/docs/variables/kvStore.GC_INTERVAL_MS.html +0 -2
- package/docs/variables/kvStore.MILLIS_PER_DAY.html +0 -2
- package/docs/variables/kvStore.kvStore.html +0 -3
- package/docs/variables/timeConstants.HOURS_PER_DAY.html +0 -1
- package/docs/variables/timeConstants.HOURS_PER_WEEK.html +0 -1
- package/docs/variables/timeConstants.MINUTES_PER_DAY.html +0 -1
- package/docs/variables/timeConstants.MINUTES_PER_HOUR.html +0 -1
- package/docs/variables/timeConstants.MINUTES_PER_WEEK.html +0 -1
- package/docs/variables/timeConstants.MS_PER_DAY.html +0 -1
- package/docs/variables/timeConstants.MS_PER_HOUR.html +0 -1
- package/docs/variables/timeConstants.MS_PER_MINUTE.html +0 -1
- package/docs/variables/timeConstants.MS_PER_SECOND.html +0 -3
- package/docs/variables/timeConstants.MS_PER_WEEK.html +0 -1
- package/docs/variables/timeConstants.SECONDS_PER_DAY.html +0 -1
- package/docs/variables/timeConstants.SECONDS_PER_HOUR.html +0 -1
- package/docs/variables/timeConstants.SECONDS_PER_MINUTE.html +0 -1
- package/docs/variables/timeConstants.SECONDS_PER_WEEK.html +0 -1
- package/duration.js.map +0 -1
- package/kvStore.js +0 -383
- package/kvStore.js.map +0 -1
- package/localStorageCache.js.map +0 -1
- package/sha256.js +0 -58
- package/src/arrayBuffer.ts +0 -29
- package/src/assert.ts +0 -12
- package/src/average.ts +0 -13
- package/src/dateTimeStr.ts +0 -184
- package/src/duration.ts +0 -260
- package/src/isEmpty.ts +0 -32
- package/src/kvStore.ts +0 -444
- package/src/localStorageCache.ts +0 -121
- package/src/logging.ts +0 -26
- package/src/nonEmpty.ts +0 -18
- package/src/safeBtoa.ts +0 -15
- package/src/safeParseFloat.ts +0 -10
- package/src/safeParseInt.ts +0 -10
- package/src/sha256.ts +0 -13
- package/src/sum.ts +0 -17
- package/src/timeConstants.ts +0 -22
- package/src/timer.ts +0 -33
- package/timer.js.map +0 -1
package/kvStore.cjs
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/kvStore.ts
|
|
21
|
+
var kvStore_exports = {};
|
|
22
|
+
__export(kvStore_exports, {
|
|
23
|
+
DEFAULT_EXPIRY_DELTA_MS: () => DEFAULT_EXPIRY_DELTA_MS,
|
|
24
|
+
GC_INTERVAL_MS: () => GC_INTERVAL_MS,
|
|
25
|
+
KVStore: () => KVStore,
|
|
26
|
+
KVStoreField: () => KVStoreField,
|
|
27
|
+
MILLIS_PER_DAY: () => MILLIS_PER_DAY,
|
|
28
|
+
kvStore: () => kvStore,
|
|
29
|
+
kvStoreItem: () => kvStoreItem
|
|
30
|
+
});
|
|
31
|
+
module.exports = __toCommonJS(kvStore_exports);
|
|
32
|
+
|
|
33
|
+
// src/timeConstants.ts
|
|
34
|
+
var MS_PER_SECOND = 1e3;
|
|
35
|
+
var MS_PER_MINUTE = 6e4;
|
|
36
|
+
var MS_PER_HOUR = 36e5;
|
|
37
|
+
var MS_PER_DAY = 864e5;
|
|
38
|
+
|
|
39
|
+
// src/duration.ts
|
|
40
|
+
function durationToMs(duration) {
|
|
41
|
+
const daysMs = (duration.days ?? 0) * MS_PER_DAY;
|
|
42
|
+
const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;
|
|
43
|
+
const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;
|
|
44
|
+
const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;
|
|
45
|
+
const msMs = duration.milliseconds ?? 0;
|
|
46
|
+
return daysMs + hoursMs + minsMs + secsMs + msMs;
|
|
47
|
+
}
|
|
48
|
+
function durationOrMsToMs(duration) {
|
|
49
|
+
return typeof duration === "number" ? duration : durationToMs(duration);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// src/kvStore.ts
|
|
53
|
+
var DEFAULT_DB_NAME = "KVStore";
|
|
54
|
+
var DEFAULT_DB_VERSION = 1;
|
|
55
|
+
var STORE_NAME = "kvStore";
|
|
56
|
+
var MILLIS_PER_DAY = 864e5;
|
|
57
|
+
var DEFAULT_EXPIRY_DELTA_MS = MILLIS_PER_DAY * 30;
|
|
58
|
+
var GC_INTERVAL_MS = MILLIS_PER_DAY;
|
|
59
|
+
function validateStoredObject(obj) {
|
|
60
|
+
if (!obj || typeof obj !== "object" || !("key" in obj) || typeof obj.key !== "string" || !("value" in obj) || !("storedMs" in obj) || typeof obj.storedMs !== "number" || obj.value === void 0 || !("expiryMs" in obj) || typeof obj.expiryMs !== "number" || Date.now() >= obj.expiryMs) {
|
|
61
|
+
return void 0;
|
|
62
|
+
}
|
|
63
|
+
return obj;
|
|
64
|
+
}
|
|
65
|
+
function withOnError(request, reject) {
|
|
66
|
+
request.onerror = (event) => {
|
|
67
|
+
reject(event);
|
|
68
|
+
};
|
|
69
|
+
return request;
|
|
70
|
+
}
|
|
71
|
+
var KVStoreField = class {
|
|
72
|
+
constructor(store, key) {
|
|
73
|
+
this.store = store;
|
|
74
|
+
this.key = key;
|
|
75
|
+
}
|
|
76
|
+
get() {
|
|
77
|
+
return this.store.get(this.key);
|
|
78
|
+
}
|
|
79
|
+
set(t) {
|
|
80
|
+
return this.store.set(this.key, t);
|
|
81
|
+
}
|
|
82
|
+
delete() {
|
|
83
|
+
return this.store.delete(this.key);
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
var KVStore = class {
|
|
87
|
+
constructor(dbName, dbVersion, defaultExpiryDeltaMs) {
|
|
88
|
+
this.dbName = dbName;
|
|
89
|
+
this.dbVersion = dbVersion;
|
|
90
|
+
this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
|
|
91
|
+
this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;
|
|
92
|
+
}
|
|
93
|
+
// We'll init the DB only on first use.
|
|
94
|
+
db;
|
|
95
|
+
// Local storage key name for the last GC completed timestamp.
|
|
96
|
+
gcMsStorageKey;
|
|
97
|
+
async getOrCreateDb() {
|
|
98
|
+
if (!this.db) {
|
|
99
|
+
this.db = await new Promise((resolve, reject) => {
|
|
100
|
+
const request = withOnError(
|
|
101
|
+
globalThis.indexedDB.open(this.dbName, this.dbVersion),
|
|
102
|
+
reject
|
|
103
|
+
);
|
|
104
|
+
request.onupgradeneeded = (event) => {
|
|
105
|
+
const db = event.target.result;
|
|
106
|
+
const objectStore = db.createObjectStore(STORE_NAME, {
|
|
107
|
+
keyPath: "key"
|
|
108
|
+
});
|
|
109
|
+
objectStore.createIndex("key", "key", {
|
|
110
|
+
unique: true
|
|
111
|
+
});
|
|
112
|
+
};
|
|
113
|
+
request.onsuccess = (event) => {
|
|
114
|
+
const db = event.target.result;
|
|
115
|
+
resolve(db);
|
|
116
|
+
};
|
|
117
|
+
});
|
|
118
|
+
}
|
|
119
|
+
return this.db;
|
|
120
|
+
}
|
|
121
|
+
async transact(mode, callback) {
|
|
122
|
+
const db = await this.getOrCreateDb();
|
|
123
|
+
return await new Promise((resolve, reject) => {
|
|
124
|
+
const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);
|
|
125
|
+
transaction.onabort = (event) => {
|
|
126
|
+
reject(event);
|
|
127
|
+
};
|
|
128
|
+
const objectStore = transaction.objectStore(STORE_NAME);
|
|
129
|
+
callback(objectStore, resolve, reject);
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
async set(key, value, expiryDeltaMs = this.defaultExpiryDeltaMs) {
|
|
133
|
+
const nowMs = Date.now();
|
|
134
|
+
const obj = {
|
|
135
|
+
key,
|
|
136
|
+
value,
|
|
137
|
+
storedMs: nowMs,
|
|
138
|
+
expiryMs: nowMs + durationOrMsToMs(expiryDeltaMs)
|
|
139
|
+
};
|
|
140
|
+
return await this.transact(
|
|
141
|
+
"readwrite",
|
|
142
|
+
(objectStore, resolve, reject) => {
|
|
143
|
+
const request = withOnError(objectStore.put(obj), reject);
|
|
144
|
+
request.onsuccess = () => {
|
|
145
|
+
resolve(value);
|
|
146
|
+
this.gc();
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
);
|
|
150
|
+
}
|
|
151
|
+
/** Delete one or multiple keys. */
|
|
152
|
+
async delete(key) {
|
|
153
|
+
return await this.transact(
|
|
154
|
+
"readwrite",
|
|
155
|
+
(objectStore, resolve, reject) => {
|
|
156
|
+
objectStore.transaction.oncomplete = () => {
|
|
157
|
+
resolve();
|
|
158
|
+
};
|
|
159
|
+
if (typeof key === "string") {
|
|
160
|
+
withOnError(objectStore.delete(key), reject);
|
|
161
|
+
} else {
|
|
162
|
+
for (const k of key) {
|
|
163
|
+
withOnError(objectStore.delete(k), reject);
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
);
|
|
168
|
+
}
|
|
169
|
+
async getStoredObject(key) {
|
|
170
|
+
const stored = await this.transact(
|
|
171
|
+
"readonly",
|
|
172
|
+
(objectStore, resolve, reject) => {
|
|
173
|
+
const request = withOnError(objectStore.get(key), reject);
|
|
174
|
+
request.onsuccess = () => {
|
|
175
|
+
resolve(request.result);
|
|
176
|
+
};
|
|
177
|
+
}
|
|
178
|
+
);
|
|
179
|
+
if (!stored) {
|
|
180
|
+
return void 0;
|
|
181
|
+
}
|
|
182
|
+
try {
|
|
183
|
+
const obj = validateStoredObject(stored);
|
|
184
|
+
if (!obj) {
|
|
185
|
+
await this.delete(key);
|
|
186
|
+
this.gc();
|
|
187
|
+
return void 0;
|
|
188
|
+
}
|
|
189
|
+
return obj;
|
|
190
|
+
} catch (e) {
|
|
191
|
+
console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);
|
|
192
|
+
await this.delete(key);
|
|
193
|
+
this.gc();
|
|
194
|
+
return void 0;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
async get(key) {
|
|
198
|
+
const obj = await this.getStoredObject(key);
|
|
199
|
+
return obj?.value;
|
|
200
|
+
}
|
|
201
|
+
async forEach(callback) {
|
|
202
|
+
await this.transact("readonly", (objectStore, resolve, reject) => {
|
|
203
|
+
const request = withOnError(objectStore.openCursor(), reject);
|
|
204
|
+
request.onsuccess = async (event) => {
|
|
205
|
+
const cursor = event.target.result;
|
|
206
|
+
if (cursor) {
|
|
207
|
+
if (cursor.key) {
|
|
208
|
+
const obj = validateStoredObject(cursor.value);
|
|
209
|
+
if (obj) {
|
|
210
|
+
await callback(String(cursor.key), obj.value, obj.expiryMs);
|
|
211
|
+
} else {
|
|
212
|
+
await callback(String(cursor.key), void 0, 0);
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
cursor.continue();
|
|
216
|
+
} else {
|
|
217
|
+
resolve();
|
|
218
|
+
}
|
|
219
|
+
};
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
/** Cannot be a getter because this needs to be async. */
|
|
223
|
+
async size() {
|
|
224
|
+
let count = 0;
|
|
225
|
+
await this.forEach(() => {
|
|
226
|
+
count++;
|
|
227
|
+
});
|
|
228
|
+
return count;
|
|
229
|
+
}
|
|
230
|
+
async clear() {
|
|
231
|
+
const keys = [];
|
|
232
|
+
await this.forEach((key) => {
|
|
233
|
+
keys.push(key);
|
|
234
|
+
});
|
|
235
|
+
await this.delete(keys);
|
|
236
|
+
}
|
|
237
|
+
/** Mainly for debugging dumps. */
|
|
238
|
+
async asMap() {
|
|
239
|
+
const map = /* @__PURE__ */ new Map();
|
|
240
|
+
await this.forEach((key, value, expiryMs) => {
|
|
241
|
+
map.set(key, { value, expiryMs });
|
|
242
|
+
});
|
|
243
|
+
return map;
|
|
244
|
+
}
|
|
245
|
+
get lastGcMs() {
|
|
246
|
+
const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);
|
|
247
|
+
if (!lastGcMsStr) return 0;
|
|
248
|
+
const ms = Number(lastGcMsStr);
|
|
249
|
+
return isNaN(ms) ? 0 : ms;
|
|
250
|
+
}
|
|
251
|
+
set lastGcMs(ms) {
|
|
252
|
+
globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));
|
|
253
|
+
}
|
|
254
|
+
/** Perform garbage-collection if due. */
|
|
255
|
+
async gc() {
|
|
256
|
+
const lastGcMs = this.lastGcMs;
|
|
257
|
+
if (!lastGcMs) {
|
|
258
|
+
this.lastGcMs = Date.now();
|
|
259
|
+
return;
|
|
260
|
+
}
|
|
261
|
+
if (Date.now() < lastGcMs + GC_INTERVAL_MS) {
|
|
262
|
+
return;
|
|
263
|
+
}
|
|
264
|
+
await this.gcNow();
|
|
265
|
+
}
|
|
266
|
+
/** Perform garbage-collection immediately without checking. */
|
|
267
|
+
async gcNow() {
|
|
268
|
+
console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);
|
|
269
|
+
this.lastGcMs = Date.now();
|
|
270
|
+
const keysToDelete = [];
|
|
271
|
+
await this.forEach(
|
|
272
|
+
async (key, value, expiryMs) => {
|
|
273
|
+
if (value === void 0 || Date.now() >= expiryMs) {
|
|
274
|
+
keysToDelete.push(key);
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
);
|
|
278
|
+
if (keysToDelete.length) {
|
|
279
|
+
await this.delete(keysToDelete);
|
|
280
|
+
}
|
|
281
|
+
console.log(
|
|
282
|
+
`Finished kvStore GC on ${this.dbName} v${this.dbVersion} - deleted ${keysToDelete.length} keys`
|
|
283
|
+
);
|
|
284
|
+
this.lastGcMs = Date.now();
|
|
285
|
+
}
|
|
286
|
+
/** Get an independent store item with a locked key and value type. */
|
|
287
|
+
field(key) {
|
|
288
|
+
return new KVStoreField(this, key);
|
|
289
|
+
}
|
|
290
|
+
};
|
|
291
|
+
var kvStore = new KVStore(
|
|
292
|
+
DEFAULT_DB_NAME,
|
|
293
|
+
DEFAULT_DB_VERSION,
|
|
294
|
+
DEFAULT_EXPIRY_DELTA_MS
|
|
295
|
+
);
|
|
296
|
+
var KvStoreItem = class {
|
|
297
|
+
constructor(key, defaultExpiryDeltaMs, store = kvStore) {
|
|
298
|
+
this.key = key;
|
|
299
|
+
this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
|
|
300
|
+
this.store = store;
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* Example usage:
|
|
304
|
+
*
|
|
305
|
+
* const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();
|
|
306
|
+
*/
|
|
307
|
+
async getStoredObject() {
|
|
308
|
+
return await this.store.getStoredObject(this.key);
|
|
309
|
+
}
|
|
310
|
+
async get() {
|
|
311
|
+
return await this.store.get(this.key);
|
|
312
|
+
}
|
|
313
|
+
async set(value, expiryDeltaMs = this.defaultExpiryDeltaMs) {
|
|
314
|
+
await this.store.set(this.key, value, expiryDeltaMs);
|
|
315
|
+
}
|
|
316
|
+
async delete() {
|
|
317
|
+
await this.store.delete(this.key);
|
|
318
|
+
}
|
|
319
|
+
};
|
|
320
|
+
function kvStoreItem(key, defaultExpiration) {
|
|
321
|
+
const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);
|
|
322
|
+
return new KvStoreItem(key, defaultExpiryDeltaMs);
|
|
323
|
+
}
|
|
324
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
325
|
+
0 && (module.exports = {
|
|
326
|
+
DEFAULT_EXPIRY_DELTA_MS,
|
|
327
|
+
GC_INTERVAL_MS,
|
|
328
|
+
KVStore,
|
|
329
|
+
KVStoreField,
|
|
330
|
+
MILLIS_PER_DAY,
|
|
331
|
+
kvStore,
|
|
332
|
+
kvStoreItem
|
|
333
|
+
});
|
package/kvStore.d.mts
ADDED
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { Duration } from './duration.mjs';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Indexed DB key-value store with support for auto-expirations.
|
|
5
|
+
*
|
|
6
|
+
* Why use this?
|
|
7
|
+
* 1. No need to worry about running out of storage.
|
|
8
|
+
* 2. Extremely simple interface to use indexed DBs.
|
|
9
|
+
* 3. Auto-expirations frees you from worrying about data clean-up.
|
|
10
|
+
* 4. Any serializable data type can be stored (except undefined).
|
|
11
|
+
*
|
|
12
|
+
* How to use?
|
|
13
|
+
* Just use the `kvStore` global constant like the local storage.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
/** One day in milliseconds. */
|
|
17
|
+
declare const MILLIS_PER_DAY = 86400000;
|
|
18
|
+
/** 30 days in ms. */
|
|
19
|
+
declare const DEFAULT_EXPIRY_DELTA_MS: number;
|
|
20
|
+
/** Do GC once per day. */
|
|
21
|
+
declare const GC_INTERVAL_MS = 86400000;
|
|
22
|
+
type StoredObject<T> = {
|
|
23
|
+
key: string;
|
|
24
|
+
value: T;
|
|
25
|
+
storedMs: number;
|
|
26
|
+
expiryMs: number;
|
|
27
|
+
};
|
|
28
|
+
declare class KVStoreField<T> {
|
|
29
|
+
readonly store: KVStore;
|
|
30
|
+
readonly key: string;
|
|
31
|
+
constructor(store: KVStore, key: string);
|
|
32
|
+
get(): Promise<T | undefined>;
|
|
33
|
+
set(t: T): Promise<T>;
|
|
34
|
+
delete(): Promise<void>;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* You can create multiple KVStores if you want, but most likely you will only
|
|
38
|
+
* need to use the default `kvStore` instance.
|
|
39
|
+
*/
|
|
40
|
+
declare class KVStore {
|
|
41
|
+
readonly dbName: string;
|
|
42
|
+
readonly dbVersion: number;
|
|
43
|
+
readonly defaultExpiryDeltaMs: number;
|
|
44
|
+
private db;
|
|
45
|
+
readonly gcMsStorageKey: string;
|
|
46
|
+
constructor(dbName: string, dbVersion: number, defaultExpiryDeltaMs: number);
|
|
47
|
+
private getOrCreateDb;
|
|
48
|
+
private transact;
|
|
49
|
+
set<T>(key: string, value: T, expiryDeltaMs?: number | Duration): Promise<T>;
|
|
50
|
+
/** Delete one or multiple keys. */
|
|
51
|
+
delete(key: string | string[]): Promise<void>;
|
|
52
|
+
getStoredObject<T>(key: string): Promise<StoredObject<T> | undefined>;
|
|
53
|
+
get<T>(key: string): Promise<T | undefined>;
|
|
54
|
+
forEach(callback: (key: string, value: unknown, expiryMs: number) => void | Promise<void>): Promise<void>;
|
|
55
|
+
/** Cannot be a getter because this needs to be async. */
|
|
56
|
+
size(): Promise<number>;
|
|
57
|
+
clear(): Promise<void>;
|
|
58
|
+
/** Mainly for debugging dumps. */
|
|
59
|
+
asMap(): Promise<Map<string, unknown>>;
|
|
60
|
+
get lastGcMs(): number;
|
|
61
|
+
set lastGcMs(ms: number);
|
|
62
|
+
/** Perform garbage-collection if due. */
|
|
63
|
+
gc(): Promise<void>;
|
|
64
|
+
/** Perform garbage-collection immediately without checking. */
|
|
65
|
+
gcNow(): Promise<void>;
|
|
66
|
+
/** Get an independent store item with a locked key and value type. */
|
|
67
|
+
field<T>(key: string): KVStoreField<T>;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Default KV store ready for immediate use. You can create new instances if
|
|
71
|
+
* you want, but most likely you will only need one store instance.
|
|
72
|
+
*/
|
|
73
|
+
declare const kvStore: KVStore;
|
|
74
|
+
/**
|
|
75
|
+
* Class to represent one key in the store with a default expiration.
|
|
76
|
+
*/
|
|
77
|
+
declare class KvStoreItem<T> {
|
|
78
|
+
readonly key: string;
|
|
79
|
+
readonly defaultExpiryDeltaMs: number;
|
|
80
|
+
readonly store: KVStore;
|
|
81
|
+
constructor(key: string, defaultExpiryDeltaMs: number, store?: KVStore);
|
|
82
|
+
/**
|
|
83
|
+
* Example usage:
|
|
84
|
+
*
|
|
85
|
+
* const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();
|
|
86
|
+
*/
|
|
87
|
+
getStoredObject(): Promise<StoredObject<T> | undefined>;
|
|
88
|
+
get(): Promise<T | undefined>;
|
|
89
|
+
set(value: T, expiryDeltaMs?: number): Promise<void>;
|
|
90
|
+
delete(): Promise<void>;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Create a KV store item with a key and a default expiration.
|
|
94
|
+
*/
|
|
95
|
+
declare function kvStoreItem<T>(key: string, defaultExpiration: number | Duration): KvStoreItem<T>;
|
|
96
|
+
|
|
97
|
+
export { DEFAULT_EXPIRY_DELTA_MS, GC_INTERVAL_MS, KVStore, KVStoreField, MILLIS_PER_DAY, kvStore, kvStoreItem };
|
package/kvStore.min.cjs
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";var h=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var E=Object.prototype.hasOwnProperty;var w=(n,t)=>{for(var e in t)h(n,e,{get:t[e],enumerable:!0})},x=(n,t,e,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of T(t))!E.call(n,r)&&r!==e&&h(n,r,{get:()=>t[r],enumerable:!(s=_(t,r))||s.enumerable});return n};var P=n=>x(h({},"__esModule",{value:!0}),n);var C={};w(C,{DEFAULT_EXPIRY_DELTA_MS:()=>S,GC_INTERVAL_MS:()=>D,KVStore:()=>p,KVStoreField:()=>d,MILLIS_PER_DAY:()=>b,kvStore:()=>m,kvStoreItem:()=>A});module.exports=P(C);function N(n){let t=(n.days??0)*864e5,e=(n.hours??0)*36e5,s=(n.minutes??0)*6e4,r=(n.seconds??0)*1e3,o=n.milliseconds??0;return t+e+s+r+o}function y(n){return typeof n=="number"?n:N(n)}var I="KVStore",U=1,l="kvStore",b=864e5,S=b*30,D=b;function g(n){if(!(!n||typeof n!="object"||!("key"in n)||typeof n.key!="string"||!("value"in n)||!("storedMs"in n)||typeof n.storedMs!="number"||n.value===void 0||!("expiryMs"in n)||typeof n.expiryMs!="number"||Date.now()>=n.expiryMs))return n}function c(n,t){return n.onerror=e=>{t(e)},n}var d=class{constructor(t,e){this.store=t;this.key=e}get(){return this.store.get(this.key)}set(t){return this.store.set(this.key,t)}delete(){return this.store.delete(this.key)}},p=class{constructor(t,e,s){this.dbName=t;this.dbVersion=e;this.defaultExpiryDeltaMs=s;this.gcMsStorageKey=`__kvStore:lastGcMs:${t}:v${e}:${l}`}db;gcMsStorageKey;async getOrCreateDb(){return this.db||(this.db=await new Promise((t,e)=>{let s=c(globalThis.indexedDB.open(this.dbName,this.dbVersion),e);s.onupgradeneeded=r=>{r.target.result.createObjectStore(l,{keyPath:"key"}).createIndex("key","key",{unique:!0})},s.onsuccess=r=>{let o=r.target.result;t(o)}})),this.db}async transact(t,e){let s=await this.getOrCreateDb();return await new Promise((r,o)=>{let i=c(s.transaction(l,t),o);i.onabort=u=>{o(u)};let a=i.objectStore(l);e(a,r,o)})}async set(t,e,s=this.defaultExpiryDeltaMs){let r=Date.now(),o={key:t,value:e,storedMs:r,expiryMs:r+y(s)};return await this.transact("readwrite",(i,a,u)=>{let M=c(i.put(o),u);M.onsuccess=()=>{a(e),this.gc()}})}async delete(t){return await this.transact("readwrite",(e,s,r)=>{if(e.transaction.oncomplete=()=>{s()},typeof t=="string")c(e.delete(t),r);else for(let o of t)c(e.delete(o),r)})}async getStoredObject(t){let e=await this.transact("readonly",(s,r,o)=>{let i=c(s.get(t),o);i.onsuccess=()=>{r(i.result)}});if(e)try{let s=g(e);if(!s){await this.delete(t),this.gc();return}return s}catch(s){console.error(`Invalid kv value: ${t}=${JSON.stringify(e)}:`,s),await this.delete(t),this.gc();return}}async get(t){return(await this.getStoredObject(t))?.value}async forEach(t){await this.transact("readonly",(e,s,r)=>{let o=c(e.openCursor(),r);o.onsuccess=async i=>{let a=i.target.result;if(a){if(a.key){let u=g(a.value);u?await t(String(a.key),u.value,u.expiryMs):await t(String(a.key),void 0,0)}a.continue()}else s()}})}async size(){let t=0;return await this.forEach(()=>{t++}),t}async clear(){let t=[];await this.forEach(e=>{t.push(e)}),await this.delete(t)}async asMap(){let t=new Map;return await this.forEach((e,s,r)=>{t.set(e,{value:s,expiryMs:r})}),t}get lastGcMs(){let t=globalThis.localStorage.getItem(this.gcMsStorageKey);if(!t)return 0;let e=Number(t);return isNaN(e)?0:e}set lastGcMs(t){globalThis.localStorage.setItem(this.gcMsStorageKey,String(t))}async gc(){let t=this.lastGcMs;if(!t){this.lastGcMs=Date.now();return}Date.now()<t+D||await this.gcNow()}async gcNow(){console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`),this.lastGcMs=Date.now();let t=[];await this.forEach(async(e,s,r)=>{(s===void 0||Date.now()>=r)&&t.push(e)}),t.length&&await this.delete(t),console.log(`Finished kvStore GC on ${this.dbName} v${this.dbVersion} - deleted ${t.length} keys`),this.lastGcMs=Date.now()}field(t){return new d(this,t)}},m=new p(I,U,S),f=class{constructor(t,e,s=m){this.key=t;this.defaultExpiryDeltaMs=e;this.store=s}async getStoredObject(){return await this.store.getStoredObject(this.key)}async get(){return await this.store.get(this.key)}async set(t,e=this.defaultExpiryDeltaMs){await this.store.set(this.key,t,e)}async delete(){await this.store.delete(this.key)}};function A(n,t){let e=y(t);return new f(n,e)}0&&(module.exports={DEFAULT_EXPIRY_DELTA_MS,GC_INTERVAL_MS,KVStore,KVStoreField,MILLIS_PER_DAY,kvStore,kvStoreItem});
|
|
2
|
+
//# sourceMappingURL=kvStore.min.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/kvStore.ts","../src/duration.ts"],"sourcesContent":["/**\n * Indexed DB key-value store with support for auto-expirations.\n *\n * Why use this?\n * 1. No need to worry about running out of storage.\n * 2. Extremely simple interface to use indexed DBs.\n * 3. Auto-expirations frees you from worrying about data clean-up.\n * 4. Any serializable data type can be stored (except undefined).\n *\n * How to use?\n * Just use the `kvStore` global constant like the local storage.\n */\n\nimport { Duration, durationOrMsToMs } from \"./duration\";\n\n// Updating the DB name will cause all old entries to be gone.\nconst DEFAULT_DB_NAME = \"KVStore\";\n\n// Updating the version will cause all old entries to be gone.\nconst DEFAULT_DB_VERSION = 1;\n\n// Use a constant store name to keep things simple.\nconst STORE_NAME = \"kvStore\";\n\n/** One day in milliseconds. */\nexport const MILLIS_PER_DAY = 86_400_000;\n\n/** 30 days in ms. */\nexport const DEFAULT_EXPIRY_DELTA_MS = MILLIS_PER_DAY * 30;\n\n/** Do GC once per day. */\nexport const GC_INTERVAL_MS = MILLIS_PER_DAY;\n\ntype StoredObject<T> = {\n key: string;\n value: T;\n storedMs: number;\n expiryMs: number;\n};\n\n/**\n * Parse a stored value string. Returns undefined if invalid or expired.\n * Throws an error if the string cannot be parsed as JSON.\n */\nfunction validateStoredObject<T>(\n obj: StoredObject<T>,\n): StoredObject<T> | undefined {\n if (\n !obj ||\n typeof obj !== \"object\" ||\n !(\"key\" in obj) ||\n typeof obj.key !== \"string\" ||\n !(\"value\" in obj) ||\n !(\"storedMs\" in obj) ||\n typeof obj.storedMs !== \"number\" ||\n obj.value === undefined ||\n !(\"expiryMs\" in obj) ||\n typeof obj.expiryMs !== \"number\" ||\n Date.now() >= obj.expiryMs\n ) {\n return undefined;\n }\n\n return obj;\n}\n\n/** Add an `onerror` handler to the request. */\nfunction withOnError<T extends IDBRequest | IDBTransaction>(\n request: T,\n reject: (reason?: unknown) => void,\n): T {\n request.onerror = (event) => {\n reject(event);\n };\n\n return request;\n}\n\nexport class KVStoreField<T> {\n public constructor(\n public readonly store: KVStore,\n public readonly key: string,\n ) {}\n\n public get(): Promise<T | undefined> {\n return this.store.get(this.key);\n }\n\n public set(t: T): Promise<T> {\n return this.store.set(this.key, t);\n }\n\n public delete(): Promise<void> {\n return this.store.delete(this.key);\n }\n}\n\n/**\n * You can create multiple KVStores if you want, but most likely you will only\n * need to use the default `kvStore` instance.\n */\nexport class KVStore {\n // We'll init the DB only on first use.\n private db: IDBDatabase | undefined;\n\n // Local storage key name for the last GC completed timestamp.\n public readonly gcMsStorageKey: string;\n\n public constructor(\n public readonly dbName: string,\n public readonly dbVersion: number,\n public readonly defaultExpiryDeltaMs: number,\n ) {\n this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;\n }\n\n private async getOrCreateDb() {\n if (!this.db) {\n this.db = await new Promise<IDBDatabase>((resolve, reject) => {\n const request = withOnError(\n globalThis.indexedDB.open(this.dbName, this.dbVersion),\n reject,\n );\n\n request.onupgradeneeded = (event) => {\n const db = (event.target as unknown as { result: IDBDatabase })\n .result;\n\n // Create the store on DB init.\n const objectStore = db.createObjectStore(STORE_NAME, {\n keyPath: \"key\",\n });\n\n objectStore.createIndex(\"key\", \"key\", {\n unique: true,\n });\n };\n\n request.onsuccess = (event) => {\n const db = (event.target as unknown as { result: IDBDatabase })\n .result;\n resolve(db);\n };\n });\n }\n\n return this.db;\n }\n\n private async transact<T>(\n mode: IDBTransactionMode,\n callback: (\n objectStore: IDBObjectStore,\n resolve: (t: T) => void,\n reject: (reason?: unknown) => void,\n ) => void,\n ): Promise<T> {\n const db = await this.getOrCreateDb();\n\n return await new Promise<T>((resolve, reject) => {\n const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);\n\n transaction.onabort = (event) => {\n reject(event);\n };\n\n const objectStore = transaction.objectStore(STORE_NAME);\n\n callback(objectStore, resolve, reject);\n });\n }\n\n public async set<T>(\n key: string,\n value: T,\n expiryDeltaMs: number | Duration = this.defaultExpiryDeltaMs,\n ): Promise<T> {\n const nowMs = Date.now();\n const obj: StoredObject<T> = {\n key,\n value,\n storedMs: nowMs,\n expiryMs: nowMs + durationOrMsToMs(expiryDeltaMs),\n };\n\n return await this.transact<T>(\n \"readwrite\",\n (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.put(obj), reject);\n\n request.onsuccess = () => {\n resolve(value);\n\n this.gc(); // check GC on every write\n };\n },\n );\n }\n\n /** Delete one or multiple keys. */\n public async delete(key: string | string[]): Promise<void> {\n return await this.transact<void>(\n \"readwrite\",\n (objectStore, resolve, reject) => {\n objectStore.transaction.oncomplete = () => {\n resolve();\n };\n\n if (typeof key === \"string\") {\n withOnError(objectStore.delete(key), reject);\n } else {\n for (const k of key) {\n withOnError(objectStore.delete(k), reject);\n }\n }\n },\n );\n }\n\n public async getStoredObject<T>(\n key: string,\n ): Promise<StoredObject<T> | undefined> {\n const stored = await this.transact<StoredObject<T> | undefined>(\n \"readonly\",\n (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.get(key), reject);\n\n request.onsuccess = () => {\n resolve(request.result);\n };\n },\n );\n\n if (!stored) {\n return undefined;\n }\n\n try {\n const obj = validateStoredObject(stored);\n if (!obj) {\n await this.delete(key);\n\n this.gc(); // check GC on every read of an expired key\n\n return undefined;\n }\n\n return obj;\n } catch (e) {\n console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);\n await this.delete(key);\n\n this.gc(); // check GC on every read of an invalid key\n\n return undefined;\n }\n }\n\n public async get<T>(key: string): Promise<T | undefined> {\n const obj = await this.getStoredObject<T>(key);\n\n return obj?.value;\n }\n\n public async forEach(\n callback: (\n key: string,\n value: unknown,\n expiryMs: number,\n ) => void | Promise<void>,\n ): Promise<void> {\n await this.transact<void>(\"readonly\", (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.openCursor(), reject);\n\n request.onsuccess = async (event) => {\n const cursor = (\n event.target as unknown as { result: IDBCursorWithValue }\n ).result;\n\n if (cursor) {\n if (cursor.key) {\n const obj = validateStoredObject(cursor.value);\n if (obj) {\n await callback(String(cursor.key), obj.value, obj.expiryMs);\n } else {\n await callback(String(cursor.key), undefined, 0);\n }\n }\n cursor.continue();\n } else {\n resolve();\n }\n };\n });\n }\n\n /** Cannot be a getter because this needs to be async. */\n public async size() {\n let count = 0;\n await this.forEach(() => {\n count++;\n });\n return count;\n }\n\n public async clear() {\n const keys: string[] = [];\n await this.forEach((key) => {\n keys.push(key);\n });\n\n await this.delete(keys);\n }\n\n /** Mainly for debugging dumps. */\n public async asMap(): Promise<Map<string, unknown>> {\n const map = new Map<string, unknown>();\n await this.forEach((key, value, expiryMs) => {\n map.set(key, { value, expiryMs });\n });\n return map;\n }\n\n public get lastGcMs(): number {\n const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);\n if (!lastGcMsStr) return 0;\n\n const ms = Number(lastGcMsStr);\n return isNaN(ms) ? 0 : ms;\n }\n\n public set lastGcMs(ms: number) {\n globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));\n }\n\n /** Perform garbage-collection if due. */\n public async gc() {\n const lastGcMs = this.lastGcMs;\n\n // Set initial timestamp - no need GC now.\n if (!lastGcMs) {\n this.lastGcMs = Date.now();\n return;\n }\n\n if (Date.now() < lastGcMs + GC_INTERVAL_MS) {\n return; // not due for next GC yet\n }\n\n // GC is due now, so run it.\n await this.gcNow();\n }\n\n /** Perform garbage-collection immediately without checking. */\n public async gcNow() {\n console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);\n\n // Prevent concurrent GC runs.\n this.lastGcMs = Date.now();\n\n const keysToDelete: string[] = [];\n await this.forEach(\n async (key: string, value: unknown, expiryMs: number) => {\n if (value === undefined || Date.now() >= expiryMs) {\n keysToDelete.push(key);\n }\n },\n );\n\n if (keysToDelete.length) {\n await this.delete(keysToDelete);\n }\n\n console.log(\n `Finished kvStore GC on ${this.dbName} v${this.dbVersion} ` +\n `- deleted ${keysToDelete.length} keys`,\n );\n\n // Mark the end time as last GC time.\n this.lastGcMs = Date.now();\n }\n\n /** Get an independent store item with a locked key and value type. */\n public field<T>(key: string) {\n return new KVStoreField<T>(this, key);\n }\n}\n\n/**\n * Default KV store ready for immediate use. You can create new instances if\n * you want, but most likely you will only need one store instance.\n */\nexport const kvStore = new KVStore(\n DEFAULT_DB_NAME,\n DEFAULT_DB_VERSION,\n DEFAULT_EXPIRY_DELTA_MS,\n);\n\n/**\n * Class to represent one key in the store with a default expiration.\n */\nclass KvStoreItem<T> {\n public constructor(\n public readonly key: string,\n public readonly defaultExpiryDeltaMs: number,\n public readonly store = kvStore,\n ) {}\n\n /**\n * Example usage:\n *\n * const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();\n */\n public async getStoredObject(): Promise<StoredObject<T> | undefined> {\n return await this.store.getStoredObject(this.key);\n }\n\n public async get(): Promise<T | undefined> {\n return await this.store.get(this.key);\n }\n\n public async set(\n value: T,\n expiryDeltaMs: number = this.defaultExpiryDeltaMs,\n ): Promise<void> {\n await this.store.set(this.key, value, expiryDeltaMs);\n }\n\n public async delete(): Promise<void> {\n await this.store.delete(this.key);\n }\n}\n\n/**\n * Create a KV store item with a key and a default expiration.\n */\nexport function kvStoreItem<T>(\n key: string,\n defaultExpiration: number | Duration,\n): KvStoreItem<T> {\n const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);\n\n return new KvStoreItem<T>(key, defaultExpiryDeltaMs);\n}\n","/**\n * Bunch of miscellaneous constants and utility functions related to handling\n * date and time durations.\n *\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file. Weeks have fixed durations, but are excluded because we\n * use days as the max duration supported.\n */\n\nimport {\n HOURS_PER_DAY,\n MINUTES_PER_HOUR,\n MS_PER_DAY,\n MS_PER_HOUR,\n MS_PER_MINUTE,\n MS_PER_SECOND,\n SECONDS_PER_MINUTE,\n} from \"./timeConstants\";\n\nexport type Duration = {\n days?: number;\n hours?: number;\n minutes?: number;\n seconds?: number;\n milliseconds?: number;\n};\n\n/**\n * One of: days, hours, minutes, seconds, milliseconds\n */\nexport type DurationType = keyof Duration;\n\n/**\n * Order in which the duration type appears in the duration string.\n */\nexport const DURATION_TYPE_SEQUENCE: DurationType[] = [\n \"days\",\n \"hours\",\n \"minutes\",\n \"seconds\",\n \"milliseconds\",\n];\n\n/**\n * Follows the same format as Intl.DurationFormat.prototype.format().\n *\n * Short: 1 yr, 2 mths, 3 wks, 3 days, 4 hr, 5 min, 6 sec, 7 ms, 8 μs, 9 ns\n * Long: 1 year, 2 months, 3 weeks, 3 days, 4 hours, 5 minutes, 6 seconds,\n * 7 milliseconds, 8 microseconds, 9 nanoseconds\n * Narrow: 1y 2mo 3w 3d 4h 5m 6s 7ms 8μs 9ns\n */\nexport type DurationStyle = \"short\" | \"long\" | \"narrow\";\n\nexport type DurationSuffixMap = {\n short: string;\n shorts: string;\n long: string;\n longs: string;\n narrow: string;\n};\n\nexport type DurationSuffixType = keyof DurationSuffixMap;\n\nexport const DURATION_STYLE_SUFFIX_MAP: Record<\n DurationType,\n DurationSuffixMap\n> = {\n days: {\n short: \"day\",\n shorts: \"days\",\n long: \"day\",\n longs: \"days\",\n narrow: \"d\",\n },\n hours: {\n short: \"hr\",\n shorts: \"hrs\",\n long: \"hour\",\n longs: \"hours\",\n narrow: \"h\",\n },\n minutes: {\n short: \"min\",\n shorts: \"mins\",\n long: \"minute\",\n longs: \"minutes\",\n narrow: \"m\",\n },\n seconds: {\n short: \"sec\",\n shorts: \"secs\",\n long: \"second\",\n longs: \"seconds\",\n narrow: \"s\",\n },\n milliseconds: {\n short: \"ms\",\n shorts: \"ms\",\n long: \"millisecond\",\n longs: \"milliseconds\",\n narrow: \"ms\",\n },\n};\n\nfunction getDurationStyleForPlural(style: DurationStyle): DurationSuffixType {\n return style == \"short\" ? \"shorts\" : style === \"long\" ? \"longs\" : style;\n}\n\nfunction getValueAndUnitSeparator(style: DurationStyle): string {\n return style === \"narrow\" ? \"\" : \" \";\n}\n\nfunction getDurationTypeSeparator(style: DurationStyle): string {\n return style === \"narrow\" ? \" \" : \", \";\n}\n\n/**\n * Convert a milliseconds duration into a Duration object. If the given ms is\n * zero, then return an object with a single field of zero with duration type\n * of durationTypeForZero.\n *\n * @param durationTypeForZero Defaults to 'milliseconds'\n */\nexport function msToDuration(\n ms: number,\n durationTypeForZero?: DurationType,\n): Duration {\n if (ms === 0) {\n durationTypeForZero = durationTypeForZero ?? \"milliseconds\";\n return { [durationTypeForZero]: 0 };\n }\n\n const duration: Duration = {};\n\n for (let i = 0; i < 1; i++) {\n let seconds = Math.floor(ms / MS_PER_SECOND);\n const millis = ms - seconds * MS_PER_SECOND;\n\n if (millis > 0) {\n duration[\"milliseconds\"] = millis;\n }\n\n if (seconds === 0) {\n break;\n }\n\n let minutes = Math.floor(seconds / SECONDS_PER_MINUTE);\n seconds -= minutes * SECONDS_PER_MINUTE;\n\n if (seconds > 0) {\n duration[\"seconds\"] = seconds;\n }\n\n if (minutes === 0) {\n break;\n }\n\n let hours = Math.floor(minutes / MINUTES_PER_HOUR);\n minutes -= hours * MINUTES_PER_HOUR;\n\n if (minutes > 0) {\n duration[\"minutes\"] = minutes;\n }\n\n if (hours === 0) {\n break;\n }\n\n const days = Math.floor(hours / HOURS_PER_DAY);\n hours -= days * HOURS_PER_DAY;\n\n if (hours > 0) {\n duration[\"hours\"] = hours;\n }\n\n if (days > 0) {\n duration[\"days\"] = days;\n }\n }\n\n return duration;\n}\n\n/**\n * Returns the number of milliseconds for the given duration.\n */\nexport function durationToMs(duration: Duration): number {\n const daysMs = (duration.days ?? 0) * MS_PER_DAY;\n const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;\n const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;\n const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;\n const msMs = duration.milliseconds ?? 0;\n\n return daysMs + hoursMs + minsMs + secsMs + msMs;\n}\n\n/**\n * Convenience function to return a duration given an ms or Duration.\n */\nexport function durationOrMsToMs(duration: number | Duration): number {\n return typeof duration === \"number\" ? duration : durationToMs(duration);\n}\n\n/**\n * Format a given Duration object into a string. If the object has no fields,\n * then returns an empty string.\n *\n * @param style Defaults to 'short'\n */\nexport function formatDuration(duration: Duration, style?: DurationStyle) {\n style = style ?? \"short\";\n const stylePlural = getDurationStyleForPlural(style);\n\n const space = getValueAndUnitSeparator(style);\n\n const a: string[] = [];\n\n for (const unit of DURATION_TYPE_SEQUENCE) {\n const value = duration[unit];\n if (value === undefined) continue;\n\n const suffixMap = DURATION_STYLE_SUFFIX_MAP[unit];\n const suffix = value === 1 ? suffixMap[style] : suffixMap[stylePlural];\n a.push(value + space + suffix);\n }\n\n const separator = getDurationTypeSeparator(style);\n return a.join(separator);\n}\n\n/**\n * Convert a millisecond duration into a human-readable duration string.\n *\n * @param options.durationTypeForZero - Defaults to 'milliseconds'\n * @param options.style - Defaults to 'short'\n */\nexport function readableDuration(\n ms: number,\n options?: { durationTypeForZero?: DurationType; style?: DurationStyle },\n): string {\n const duration = msToDuration(ms, options?.durationTypeForZero);\n\n return formatDuration(duration, options?.style);\n}\n\n/** A shortened duration string useful for logging timings. */\nexport function elapsed(ms: number): string {\n // Use long format for 1 minute or over.\n if (ms > MS_PER_MINUTE) {\n return readableDuration(ms);\n }\n\n // Use seconds format for over 100ms.\n if (ms > 100) {\n return `${(ms / 1000).toFixed(3)}s`;\n }\n\n // Use milliseconds format.\n return ms + \"ms\";\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,6BAAAE,EAAA,mBAAAC,EAAA,YAAAC,EAAA,iBAAAC,EAAA,mBAAAC,EAAA,YAAAC,EAAA,gBAAAC,IAAA,eAAAC,EAAAT,GC0LO,SAASU,EAAaC,EAA4B,CACvD,IAAMC,GAAUD,EAAS,MAAQ,GAAK,MAChCE,GAAWF,EAAS,OAAS,GAAK,KAClCG,GAAUH,EAAS,SAAW,GAAK,IACnCI,GAAUJ,EAAS,SAAW,GAAK,IACnCK,EAAOL,EAAS,cAAgB,EAEtC,OAAOC,EAASC,EAAUC,EAASC,EAASC,CAC9C,CAKO,SAASC,EAAiBN,EAAqC,CACpE,OAAO,OAAOA,GAAa,SAAWA,EAAWD,EAAaC,CAAQ,CACxE,CDzLA,IAAMO,EAAkB,UAGlBC,EAAqB,EAGrBC,EAAa,UAGNC,EAAiB,MAGjBC,EAA0BD,EAAiB,GAG3CE,EAAiBF,EAa9B,SAASG,EACPC,EAC6B,CAC7B,GACE,GAACA,GACD,OAAOA,GAAQ,UACf,EAAE,QAASA,IACX,OAAOA,EAAI,KAAQ,UACnB,EAAE,UAAWA,IACb,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxBA,EAAI,QAAU,QACd,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxB,KAAK,IAAI,GAAKA,EAAI,UAKpB,OAAOA,CACT,CAGA,SAASC,EACPC,EACAC,EACG,CACH,OAAAD,EAAQ,QAAWE,GAAU,CAC3BD,EAAOC,CAAK,CACd,EAEOF,CACT,CAEO,IAAMG,EAAN,KAAsB,CACpB,YACWC,EACAC,EAChB,CAFgB,WAAAD,EACA,SAAAC,CACf,CAEI,KAA8B,CACnC,OAAO,KAAK,MAAM,IAAI,KAAK,GAAG,CAChC,CAEO,IAAI,EAAkB,CAC3B,OAAO,KAAK,MAAM,IAAI,KAAK,IAAK,CAAC,CACnC,CAEO,QAAwB,CAC7B,OAAO,KAAK,MAAM,OAAO,KAAK,GAAG,CACnC,CACF,EAMaC,EAAN,KAAc,CAOZ,YACWC,EACAC,EACAC,EAChB,CAHgB,YAAAF,EACA,eAAAC,EACA,0BAAAC,EAEhB,KAAK,eAAiB,sBAAsBF,CAAM,KAAKC,CAAS,IAAIf,CAAU,EAChF,CAXQ,GAGQ,eAUhB,MAAc,eAAgB,CAC5B,OAAK,KAAK,KACR,KAAK,GAAK,MAAM,IAAI,QAAqB,CAACiB,EAAST,IAAW,CAC5D,IAAMD,EAAUD,EACd,WAAW,UAAU,KAAK,KAAK,OAAQ,KAAK,SAAS,EACrDE,CACF,EAEAD,EAAQ,gBAAmBE,GAAU,CACvBA,EAAM,OACf,OAGoB,kBAAkBT,EAAY,CACnD,QAAS,KACX,CAAC,EAEW,YAAY,MAAO,MAAO,CACpC,OAAQ,EACV,CAAC,CACH,EAEAO,EAAQ,UAAaE,GAAU,CAC7B,IAAMS,EAAMT,EAAM,OACf,OACHQ,EAAQC,CAAE,CACZ,CACF,CAAC,GAGI,KAAK,EACd,CAEA,MAAc,SACZC,EACAC,EAKY,CACZ,IAAMF,EAAK,MAAM,KAAK,cAAc,EAEpC,OAAO,MAAM,IAAI,QAAW,CAACD,EAAST,IAAW,CAC/C,IAAMa,EAAcf,EAAYY,EAAG,YAAYlB,EAAYmB,CAAI,EAAGX,CAAM,EAExEa,EAAY,QAAWZ,GAAU,CAC/BD,EAAOC,CAAK,CACd,EAEA,IAAMa,EAAcD,EAAY,YAAYrB,CAAU,EAEtDoB,EAASE,EAAaL,EAAST,CAAM,CACvC,CAAC,CACH,CAEA,MAAa,IACXI,EACAW,EACAC,EAAmC,KAAK,qBAC5B,CACZ,IAAMC,EAAQ,KAAK,IAAI,EACjBpB,EAAuB,CAC3B,IAAAO,EACA,MAAAW,EACA,SAAUE,EACV,SAAUA,EAAQC,EAAiBF,CAAa,CAClD,EAEA,OAAO,MAAM,KAAK,SAChB,YACA,CAACF,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIjB,CAAG,EAAGG,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQM,CAAK,EAEb,KAAK,GAAG,CACV,CACF,CACF,CACF,CAGA,MAAa,OAAOX,EAAuC,CACzD,OAAO,MAAM,KAAK,SAChB,YACA,CAACU,EAAaL,EAAST,IAAW,CAKhC,GAJAc,EAAY,YAAY,WAAa,IAAM,CACzCL,EAAQ,CACV,EAEI,OAAOL,GAAQ,SACjBN,EAAYgB,EAAY,OAAOV,CAAG,EAAGJ,CAAM,MAE3C,SAAWmB,KAAKf,EACdN,EAAYgB,EAAY,OAAOK,CAAC,EAAGnB,CAAM,CAG/C,CACF,CACF,CAEA,MAAa,gBACXI,EACsC,CACtC,IAAMgB,EAAS,MAAM,KAAK,SACxB,WACA,CAACN,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIV,CAAG,EAAGJ,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQV,EAAQ,MAAM,CACxB,CACF,CACF,EAEA,GAAKqB,EAIL,GAAI,CACF,IAAMvB,EAAMD,EAAqBwB,CAAM,EACvC,GAAI,CAACvB,EAAK,CACR,MAAM,KAAK,OAAOO,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CAEA,OAAOP,CACT,OAASwB,EAAG,CACV,QAAQ,MAAM,qBAAqBjB,CAAG,IAAI,KAAK,UAAUgB,CAAM,CAAC,IAAKC,CAAC,EACtE,MAAM,KAAK,OAAOjB,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CACF,CAEA,MAAa,IAAOA,EAAqC,CAGvD,OAFY,MAAM,KAAK,gBAAmBA,CAAG,IAEjC,KACd,CAEA,MAAa,QACXQ,EAKe,CACf,MAAM,KAAK,SAAe,WAAY,CAACE,EAAaL,EAAST,IAAW,CACtE,IAAMD,EAAUD,EAAYgB,EAAY,WAAW,EAAGd,CAAM,EAE5DD,EAAQ,UAAY,MAAOE,GAAU,CACnC,IAAMqB,EACJrB,EAAM,OACN,OAEF,GAAIqB,EAAQ,CACV,GAAIA,EAAO,IAAK,CACd,IAAMzB,EAAMD,EAAqB0B,EAAO,KAAK,EACzCzB,EACF,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAGzB,EAAI,MAAOA,EAAI,QAAQ,EAE1D,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAG,OAAW,CAAC,CAEnD,CACAA,EAAO,SAAS,CAClB,MACEb,EAAQ,CAEZ,CACF,CAAC,CACH,CAGA,MAAa,MAAO,CAClB,IAAIc,EAAQ,EACZ,aAAM,KAAK,QAAQ,IAAM,CACvBA,GACF,CAAC,EACMA,CACT,CAEA,MAAa,OAAQ,CACnB,IAAMC,EAAiB,CAAC,EACxB,MAAM,KAAK,QAASpB,GAAQ,CAC1BoB,EAAK,KAAKpB,CAAG,CACf,CAAC,EAED,MAAM,KAAK,OAAOoB,CAAI,CACxB,CAGA,MAAa,OAAuC,CAClD,IAAMC,EAAM,IAAI,IAChB,aAAM,KAAK,QAAQ,CAACrB,EAAKW,EAAOW,IAAa,CAC3CD,EAAI,IAAIrB,EAAK,CAAE,MAAAW,EAAO,SAAAW,CAAS,CAAC,CAClC,CAAC,EACMD,CACT,CAEA,IAAW,UAAmB,CAC5B,IAAME,EAAc,WAAW,aAAa,QAAQ,KAAK,cAAc,EACvE,GAAI,CAACA,EAAa,MAAO,GAEzB,IAAMC,EAAK,OAAOD,CAAW,EAC7B,OAAO,MAAMC,CAAE,EAAI,EAAIA,CACzB,CAEA,IAAW,SAASA,EAAY,CAC9B,WAAW,aAAa,QAAQ,KAAK,eAAgB,OAAOA,CAAE,CAAC,CACjE,CAGA,MAAa,IAAK,CAChB,IAAMC,EAAW,KAAK,SAGtB,GAAI,CAACA,EAAU,CACb,KAAK,SAAW,KAAK,IAAI,EACzB,MACF,CAEI,KAAK,IAAI,EAAIA,EAAWlC,GAK5B,MAAM,KAAK,MAAM,CACnB,CAGA,MAAa,OAAQ,CACnB,QAAQ,IAAI,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,KAAK,EAGzE,KAAK,SAAW,KAAK,IAAI,EAEzB,IAAMmC,EAAyB,CAAC,EAChC,MAAM,KAAK,QACT,MAAO1B,EAAaW,EAAgBW,IAAqB,EACnDX,IAAU,QAAa,KAAK,IAAI,GAAKW,IACvCI,EAAa,KAAK1B,CAAG,CAEzB,CACF,EAEI0B,EAAa,QACf,MAAM,KAAK,OAAOA,CAAY,EAGhC,QAAQ,IACN,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,cACzCA,EAAa,MAAM,OACpC,EAGA,KAAK,SAAW,KAAK,IAAI,CAC3B,CAGO,MAAS1B,EAAa,CAC3B,OAAO,IAAIF,EAAgB,KAAME,CAAG,CACtC,CACF,EAMa2B,EAAU,IAAI1B,EACzBf,EACAC,EACAG,CACF,EAKMsC,EAAN,KAAqB,CACZ,YACW5B,EACAI,EACAL,EAAQ4B,EACxB,CAHgB,SAAA3B,EACA,0BAAAI,EACA,WAAAL,CACf,CAOH,MAAa,iBAAwD,CACnE,OAAO,MAAM,KAAK,MAAM,gBAAgB,KAAK,GAAG,CAClD,CAEA,MAAa,KAA8B,CACzC,OAAO,MAAM,KAAK,MAAM,IAAI,KAAK,GAAG,CACtC,CAEA,MAAa,IACXY,EACAC,EAAwB,KAAK,qBACd,CACf,MAAM,KAAK,MAAM,IAAI,KAAK,IAAKD,EAAOC,CAAa,CACrD,CAEA,MAAa,QAAwB,CACnC,MAAM,KAAK,MAAM,OAAO,KAAK,GAAG,CAClC,CACF,EAKO,SAASiB,EACd7B,EACA8B,EACgB,CAChB,IAAM1B,EAAuBU,EAAiBgB,CAAiB,EAE/D,OAAO,IAAIF,EAAe5B,EAAKI,CAAoB,CACrD","names":["kvStore_exports","__export","DEFAULT_EXPIRY_DELTA_MS","GC_INTERVAL_MS","KVStore","KVStoreField","MILLIS_PER_DAY","kvStore","kvStoreItem","__toCommonJS","durationToMs","duration","daysMs","hoursMs","minsMs","secsMs","msMs","durationOrMsToMs","DEFAULT_DB_NAME","DEFAULT_DB_VERSION","STORE_NAME","MILLIS_PER_DAY","DEFAULT_EXPIRY_DELTA_MS","GC_INTERVAL_MS","validateStoredObject","obj","withOnError","request","reject","event","KVStoreField","store","key","KVStore","dbName","dbVersion","defaultExpiryDeltaMs","resolve","db","mode","callback","transaction","objectStore","value","expiryDeltaMs","nowMs","durationOrMsToMs","k","stored","e","cursor","count","keys","map","expiryMs","lastGcMsStr","ms","lastGcMs","keysToDelete","kvStore","KvStoreItem","kvStoreItem","defaultExpiration"]}
|
package/kvStore.min.mjs
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
function _(n){let t=(n.days??0)*864e5,e=(n.hours??0)*36e5,s=(n.minutes??0)*6e4,r=(n.seconds??0)*1e3,o=n.milliseconds??0;return t+e+s+r+o}function d(n){return typeof n=="number"?n:_(n)}var T="KVStore",E=1,l="kvStore",b=864e5,w=b*30,x=b;function f(n){if(!(!n||typeof n!="object"||!("key"in n)||typeof n.key!="string"||!("value"in n)||!("storedMs"in n)||typeof n.storedMs!="number"||n.value===void 0||!("expiryMs"in n)||typeof n.expiryMs!="number"||Date.now()>=n.expiryMs))return n}function c(n,t){return n.onerror=e=>{t(e)},n}var p=class{constructor(t,e){this.store=t;this.key=e}get(){return this.store.get(this.key)}set(t){return this.store.set(this.key,t)}delete(){return this.store.delete(this.key)}},h=class{constructor(t,e,s){this.dbName=t;this.dbVersion=e;this.defaultExpiryDeltaMs=s;this.gcMsStorageKey=`__kvStore:lastGcMs:${t}:v${e}:${l}`}db;gcMsStorageKey;async getOrCreateDb(){return this.db||(this.db=await new Promise((t,e)=>{let s=c(globalThis.indexedDB.open(this.dbName,this.dbVersion),e);s.onupgradeneeded=r=>{r.target.result.createObjectStore(l,{keyPath:"key"}).createIndex("key","key",{unique:!0})},s.onsuccess=r=>{let o=r.target.result;t(o)}})),this.db}async transact(t,e){let s=await this.getOrCreateDb();return await new Promise((r,o)=>{let i=c(s.transaction(l,t),o);i.onabort=u=>{o(u)};let a=i.objectStore(l);e(a,r,o)})}async set(t,e,s=this.defaultExpiryDeltaMs){let r=Date.now(),o={key:t,value:e,storedMs:r,expiryMs:r+d(s)};return await this.transact("readwrite",(i,a,u)=>{let g=c(i.put(o),u);g.onsuccess=()=>{a(e),this.gc()}})}async delete(t){return await this.transact("readwrite",(e,s,r)=>{if(e.transaction.oncomplete=()=>{s()},typeof t=="string")c(e.delete(t),r);else for(let o of t)c(e.delete(o),r)})}async getStoredObject(t){let e=await this.transact("readonly",(s,r,o)=>{let i=c(s.get(t),o);i.onsuccess=()=>{r(i.result)}});if(e)try{let s=f(e);if(!s){await this.delete(t),this.gc();return}return s}catch(s){console.error(`Invalid kv value: ${t}=${JSON.stringify(e)}:`,s),await this.delete(t),this.gc();return}}async get(t){return(await this.getStoredObject(t))?.value}async forEach(t){await this.transact("readonly",(e,s,r)=>{let o=c(e.openCursor(),r);o.onsuccess=async i=>{let a=i.target.result;if(a){if(a.key){let u=f(a.value);u?await t(String(a.key),u.value,u.expiryMs):await t(String(a.key),void 0,0)}a.continue()}else s()}})}async size(){let t=0;return await this.forEach(()=>{t++}),t}async clear(){let t=[];await this.forEach(e=>{t.push(e)}),await this.delete(t)}async asMap(){let t=new Map;return await this.forEach((e,s,r)=>{t.set(e,{value:s,expiryMs:r})}),t}get lastGcMs(){let t=globalThis.localStorage.getItem(this.gcMsStorageKey);if(!t)return 0;let e=Number(t);return isNaN(e)?0:e}set lastGcMs(t){globalThis.localStorage.setItem(this.gcMsStorageKey,String(t))}async gc(){let t=this.lastGcMs;if(!t){this.lastGcMs=Date.now();return}Date.now()<t+x||await this.gcNow()}async gcNow(){console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`),this.lastGcMs=Date.now();let t=[];await this.forEach(async(e,s,r)=>{(s===void 0||Date.now()>=r)&&t.push(e)}),t.length&&await this.delete(t),console.log(`Finished kvStore GC on ${this.dbName} v${this.dbVersion} - deleted ${t.length} keys`),this.lastGcMs=Date.now()}field(t){return new p(this,t)}},P=new h(T,E,w),y=class{constructor(t,e,s=P){this.key=t;this.defaultExpiryDeltaMs=e;this.store=s}async getStoredObject(){return await this.store.getStoredObject(this.key)}async get(){return await this.store.get(this.key)}async set(t,e=this.defaultExpiryDeltaMs){await this.store.set(this.key,t,e)}async delete(){await this.store.delete(this.key)}};function C(n,t){let e=d(t);return new y(n,e)}export{w as DEFAULT_EXPIRY_DELTA_MS,x as GC_INTERVAL_MS,h as KVStore,p as KVStoreField,b as MILLIS_PER_DAY,P as kvStore,C as kvStoreItem};
|
|
2
|
+
//# sourceMappingURL=kvStore.min.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/duration.ts","../src/kvStore.ts"],"sourcesContent":["/**\n * Bunch of miscellaneous constants and utility functions related to handling\n * date and time durations.\n *\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file. Weeks have fixed durations, but are excluded because we\n * use days as the max duration supported.\n */\n\nimport {\n HOURS_PER_DAY,\n MINUTES_PER_HOUR,\n MS_PER_DAY,\n MS_PER_HOUR,\n MS_PER_MINUTE,\n MS_PER_SECOND,\n SECONDS_PER_MINUTE,\n} from \"./timeConstants\";\n\nexport type Duration = {\n days?: number;\n hours?: number;\n minutes?: number;\n seconds?: number;\n milliseconds?: number;\n};\n\n/**\n * One of: days, hours, minutes, seconds, milliseconds\n */\nexport type DurationType = keyof Duration;\n\n/**\n * Order in which the duration type appears in the duration string.\n */\nexport const DURATION_TYPE_SEQUENCE: DurationType[] = [\n \"days\",\n \"hours\",\n \"minutes\",\n \"seconds\",\n \"milliseconds\",\n];\n\n/**\n * Follows the same format as Intl.DurationFormat.prototype.format().\n *\n * Short: 1 yr, 2 mths, 3 wks, 3 days, 4 hr, 5 min, 6 sec, 7 ms, 8 μs, 9 ns\n * Long: 1 year, 2 months, 3 weeks, 3 days, 4 hours, 5 minutes, 6 seconds,\n * 7 milliseconds, 8 microseconds, 9 nanoseconds\n * Narrow: 1y 2mo 3w 3d 4h 5m 6s 7ms 8μs 9ns\n */\nexport type DurationStyle = \"short\" | \"long\" | \"narrow\";\n\nexport type DurationSuffixMap = {\n short: string;\n shorts: string;\n long: string;\n longs: string;\n narrow: string;\n};\n\nexport type DurationSuffixType = keyof DurationSuffixMap;\n\nexport const DURATION_STYLE_SUFFIX_MAP: Record<\n DurationType,\n DurationSuffixMap\n> = {\n days: {\n short: \"day\",\n shorts: \"days\",\n long: \"day\",\n longs: \"days\",\n narrow: \"d\",\n },\n hours: {\n short: \"hr\",\n shorts: \"hrs\",\n long: \"hour\",\n longs: \"hours\",\n narrow: \"h\",\n },\n minutes: {\n short: \"min\",\n shorts: \"mins\",\n long: \"minute\",\n longs: \"minutes\",\n narrow: \"m\",\n },\n seconds: {\n short: \"sec\",\n shorts: \"secs\",\n long: \"second\",\n longs: \"seconds\",\n narrow: \"s\",\n },\n milliseconds: {\n short: \"ms\",\n shorts: \"ms\",\n long: \"millisecond\",\n longs: \"milliseconds\",\n narrow: \"ms\",\n },\n};\n\nfunction getDurationStyleForPlural(style: DurationStyle): DurationSuffixType {\n return style == \"short\" ? \"shorts\" : style === \"long\" ? \"longs\" : style;\n}\n\nfunction getValueAndUnitSeparator(style: DurationStyle): string {\n return style === \"narrow\" ? \"\" : \" \";\n}\n\nfunction getDurationTypeSeparator(style: DurationStyle): string {\n return style === \"narrow\" ? \" \" : \", \";\n}\n\n/**\n * Convert a milliseconds duration into a Duration object. If the given ms is\n * zero, then return an object with a single field of zero with duration type\n * of durationTypeForZero.\n *\n * @param durationTypeForZero Defaults to 'milliseconds'\n */\nexport function msToDuration(\n ms: number,\n durationTypeForZero?: DurationType,\n): Duration {\n if (ms === 0) {\n durationTypeForZero = durationTypeForZero ?? \"milliseconds\";\n return { [durationTypeForZero]: 0 };\n }\n\n const duration: Duration = {};\n\n for (let i = 0; i < 1; i++) {\n let seconds = Math.floor(ms / MS_PER_SECOND);\n const millis = ms - seconds * MS_PER_SECOND;\n\n if (millis > 0) {\n duration[\"milliseconds\"] = millis;\n }\n\n if (seconds === 0) {\n break;\n }\n\n let minutes = Math.floor(seconds / SECONDS_PER_MINUTE);\n seconds -= minutes * SECONDS_PER_MINUTE;\n\n if (seconds > 0) {\n duration[\"seconds\"] = seconds;\n }\n\n if (minutes === 0) {\n break;\n }\n\n let hours = Math.floor(minutes / MINUTES_PER_HOUR);\n minutes -= hours * MINUTES_PER_HOUR;\n\n if (minutes > 0) {\n duration[\"minutes\"] = minutes;\n }\n\n if (hours === 0) {\n break;\n }\n\n const days = Math.floor(hours / HOURS_PER_DAY);\n hours -= days * HOURS_PER_DAY;\n\n if (hours > 0) {\n duration[\"hours\"] = hours;\n }\n\n if (days > 0) {\n duration[\"days\"] = days;\n }\n }\n\n return duration;\n}\n\n/**\n * Returns the number of milliseconds for the given duration.\n */\nexport function durationToMs(duration: Duration): number {\n const daysMs = (duration.days ?? 0) * MS_PER_DAY;\n const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;\n const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;\n const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;\n const msMs = duration.milliseconds ?? 0;\n\n return daysMs + hoursMs + minsMs + secsMs + msMs;\n}\n\n/**\n * Convenience function to return a duration given an ms or Duration.\n */\nexport function durationOrMsToMs(duration: number | Duration): number {\n return typeof duration === \"number\" ? duration : durationToMs(duration);\n}\n\n/**\n * Format a given Duration object into a string. If the object has no fields,\n * then returns an empty string.\n *\n * @param style Defaults to 'short'\n */\nexport function formatDuration(duration: Duration, style?: DurationStyle) {\n style = style ?? \"short\";\n const stylePlural = getDurationStyleForPlural(style);\n\n const space = getValueAndUnitSeparator(style);\n\n const a: string[] = [];\n\n for (const unit of DURATION_TYPE_SEQUENCE) {\n const value = duration[unit];\n if (value === undefined) continue;\n\n const suffixMap = DURATION_STYLE_SUFFIX_MAP[unit];\n const suffix = value === 1 ? suffixMap[style] : suffixMap[stylePlural];\n a.push(value + space + suffix);\n }\n\n const separator = getDurationTypeSeparator(style);\n return a.join(separator);\n}\n\n/**\n * Convert a millisecond duration into a human-readable duration string.\n *\n * @param options.durationTypeForZero - Defaults to 'milliseconds'\n * @param options.style - Defaults to 'short'\n */\nexport function readableDuration(\n ms: number,\n options?: { durationTypeForZero?: DurationType; style?: DurationStyle },\n): string {\n const duration = msToDuration(ms, options?.durationTypeForZero);\n\n return formatDuration(duration, options?.style);\n}\n\n/** A shortened duration string useful for logging timings. */\nexport function elapsed(ms: number): string {\n // Use long format for 1 minute or over.\n if (ms > MS_PER_MINUTE) {\n return readableDuration(ms);\n }\n\n // Use seconds format for over 100ms.\n if (ms > 100) {\n return `${(ms / 1000).toFixed(3)}s`;\n }\n\n // Use milliseconds format.\n return ms + \"ms\";\n}\n","/**\n * Indexed DB key-value store with support for auto-expirations.\n *\n * Why use this?\n * 1. No need to worry about running out of storage.\n * 2. Extremely simple interface to use indexed DBs.\n * 3. Auto-expirations frees you from worrying about data clean-up.\n * 4. Any serializable data type can be stored (except undefined).\n *\n * How to use?\n * Just use the `kvStore` global constant like the local storage.\n */\n\nimport { Duration, durationOrMsToMs } from \"./duration\";\n\n// Updating the DB name will cause all old entries to be gone.\nconst DEFAULT_DB_NAME = \"KVStore\";\n\n// Updating the version will cause all old entries to be gone.\nconst DEFAULT_DB_VERSION = 1;\n\n// Use a constant store name to keep things simple.\nconst STORE_NAME = \"kvStore\";\n\n/** One day in milliseconds. */\nexport const MILLIS_PER_DAY = 86_400_000;\n\n/** 30 days in ms. */\nexport const DEFAULT_EXPIRY_DELTA_MS = MILLIS_PER_DAY * 30;\n\n/** Do GC once per day. */\nexport const GC_INTERVAL_MS = MILLIS_PER_DAY;\n\ntype StoredObject<T> = {\n key: string;\n value: T;\n storedMs: number;\n expiryMs: number;\n};\n\n/**\n * Parse a stored value string. Returns undefined if invalid or expired.\n * Throws an error if the string cannot be parsed as JSON.\n */\nfunction validateStoredObject<T>(\n obj: StoredObject<T>,\n): StoredObject<T> | undefined {\n if (\n !obj ||\n typeof obj !== \"object\" ||\n !(\"key\" in obj) ||\n typeof obj.key !== \"string\" ||\n !(\"value\" in obj) ||\n !(\"storedMs\" in obj) ||\n typeof obj.storedMs !== \"number\" ||\n obj.value === undefined ||\n !(\"expiryMs\" in obj) ||\n typeof obj.expiryMs !== \"number\" ||\n Date.now() >= obj.expiryMs\n ) {\n return undefined;\n }\n\n return obj;\n}\n\n/** Add an `onerror` handler to the request. */\nfunction withOnError<T extends IDBRequest | IDBTransaction>(\n request: T,\n reject: (reason?: unknown) => void,\n): T {\n request.onerror = (event) => {\n reject(event);\n };\n\n return request;\n}\n\nexport class KVStoreField<T> {\n public constructor(\n public readonly store: KVStore,\n public readonly key: string,\n ) {}\n\n public get(): Promise<T | undefined> {\n return this.store.get(this.key);\n }\n\n public set(t: T): Promise<T> {\n return this.store.set(this.key, t);\n }\n\n public delete(): Promise<void> {\n return this.store.delete(this.key);\n }\n}\n\n/**\n * You can create multiple KVStores if you want, but most likely you will only\n * need to use the default `kvStore` instance.\n */\nexport class KVStore {\n // We'll init the DB only on first use.\n private db: IDBDatabase | undefined;\n\n // Local storage key name for the last GC completed timestamp.\n public readonly gcMsStorageKey: string;\n\n public constructor(\n public readonly dbName: string,\n public readonly dbVersion: number,\n public readonly defaultExpiryDeltaMs: number,\n ) {\n this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;\n }\n\n private async getOrCreateDb() {\n if (!this.db) {\n this.db = await new Promise<IDBDatabase>((resolve, reject) => {\n const request = withOnError(\n globalThis.indexedDB.open(this.dbName, this.dbVersion),\n reject,\n );\n\n request.onupgradeneeded = (event) => {\n const db = (event.target as unknown as { result: IDBDatabase })\n .result;\n\n // Create the store on DB init.\n const objectStore = db.createObjectStore(STORE_NAME, {\n keyPath: \"key\",\n });\n\n objectStore.createIndex(\"key\", \"key\", {\n unique: true,\n });\n };\n\n request.onsuccess = (event) => {\n const db = (event.target as unknown as { result: IDBDatabase })\n .result;\n resolve(db);\n };\n });\n }\n\n return this.db;\n }\n\n private async transact<T>(\n mode: IDBTransactionMode,\n callback: (\n objectStore: IDBObjectStore,\n resolve: (t: T) => void,\n reject: (reason?: unknown) => void,\n ) => void,\n ): Promise<T> {\n const db = await this.getOrCreateDb();\n\n return await new Promise<T>((resolve, reject) => {\n const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);\n\n transaction.onabort = (event) => {\n reject(event);\n };\n\n const objectStore = transaction.objectStore(STORE_NAME);\n\n callback(objectStore, resolve, reject);\n });\n }\n\n public async set<T>(\n key: string,\n value: T,\n expiryDeltaMs: number | Duration = this.defaultExpiryDeltaMs,\n ): Promise<T> {\n const nowMs = Date.now();\n const obj: StoredObject<T> = {\n key,\n value,\n storedMs: nowMs,\n expiryMs: nowMs + durationOrMsToMs(expiryDeltaMs),\n };\n\n return await this.transact<T>(\n \"readwrite\",\n (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.put(obj), reject);\n\n request.onsuccess = () => {\n resolve(value);\n\n this.gc(); // check GC on every write\n };\n },\n );\n }\n\n /** Delete one or multiple keys. */\n public async delete(key: string | string[]): Promise<void> {\n return await this.transact<void>(\n \"readwrite\",\n (objectStore, resolve, reject) => {\n objectStore.transaction.oncomplete = () => {\n resolve();\n };\n\n if (typeof key === \"string\") {\n withOnError(objectStore.delete(key), reject);\n } else {\n for (const k of key) {\n withOnError(objectStore.delete(k), reject);\n }\n }\n },\n );\n }\n\n public async getStoredObject<T>(\n key: string,\n ): Promise<StoredObject<T> | undefined> {\n const stored = await this.transact<StoredObject<T> | undefined>(\n \"readonly\",\n (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.get(key), reject);\n\n request.onsuccess = () => {\n resolve(request.result);\n };\n },\n );\n\n if (!stored) {\n return undefined;\n }\n\n try {\n const obj = validateStoredObject(stored);\n if (!obj) {\n await this.delete(key);\n\n this.gc(); // check GC on every read of an expired key\n\n return undefined;\n }\n\n return obj;\n } catch (e) {\n console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);\n await this.delete(key);\n\n this.gc(); // check GC on every read of an invalid key\n\n return undefined;\n }\n }\n\n public async get<T>(key: string): Promise<T | undefined> {\n const obj = await this.getStoredObject<T>(key);\n\n return obj?.value;\n }\n\n public async forEach(\n callback: (\n key: string,\n value: unknown,\n expiryMs: number,\n ) => void | Promise<void>,\n ): Promise<void> {\n await this.transact<void>(\"readonly\", (objectStore, resolve, reject) => {\n const request = withOnError(objectStore.openCursor(), reject);\n\n request.onsuccess = async (event) => {\n const cursor = (\n event.target as unknown as { result: IDBCursorWithValue }\n ).result;\n\n if (cursor) {\n if (cursor.key) {\n const obj = validateStoredObject(cursor.value);\n if (obj) {\n await callback(String(cursor.key), obj.value, obj.expiryMs);\n } else {\n await callback(String(cursor.key), undefined, 0);\n }\n }\n cursor.continue();\n } else {\n resolve();\n }\n };\n });\n }\n\n /** Cannot be a getter because this needs to be async. */\n public async size() {\n let count = 0;\n await this.forEach(() => {\n count++;\n });\n return count;\n }\n\n public async clear() {\n const keys: string[] = [];\n await this.forEach((key) => {\n keys.push(key);\n });\n\n await this.delete(keys);\n }\n\n /** Mainly for debugging dumps. */\n public async asMap(): Promise<Map<string, unknown>> {\n const map = new Map<string, unknown>();\n await this.forEach((key, value, expiryMs) => {\n map.set(key, { value, expiryMs });\n });\n return map;\n }\n\n public get lastGcMs(): number {\n const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);\n if (!lastGcMsStr) return 0;\n\n const ms = Number(lastGcMsStr);\n return isNaN(ms) ? 0 : ms;\n }\n\n public set lastGcMs(ms: number) {\n globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));\n }\n\n /** Perform garbage-collection if due. */\n public async gc() {\n const lastGcMs = this.lastGcMs;\n\n // Set initial timestamp - no need GC now.\n if (!lastGcMs) {\n this.lastGcMs = Date.now();\n return;\n }\n\n if (Date.now() < lastGcMs + GC_INTERVAL_MS) {\n return; // not due for next GC yet\n }\n\n // GC is due now, so run it.\n await this.gcNow();\n }\n\n /** Perform garbage-collection immediately without checking. */\n public async gcNow() {\n console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);\n\n // Prevent concurrent GC runs.\n this.lastGcMs = Date.now();\n\n const keysToDelete: string[] = [];\n await this.forEach(\n async (key: string, value: unknown, expiryMs: number) => {\n if (value === undefined || Date.now() >= expiryMs) {\n keysToDelete.push(key);\n }\n },\n );\n\n if (keysToDelete.length) {\n await this.delete(keysToDelete);\n }\n\n console.log(\n `Finished kvStore GC on ${this.dbName} v${this.dbVersion} ` +\n `- deleted ${keysToDelete.length} keys`,\n );\n\n // Mark the end time as last GC time.\n this.lastGcMs = Date.now();\n }\n\n /** Get an independent store item with a locked key and value type. */\n public field<T>(key: string) {\n return new KVStoreField<T>(this, key);\n }\n}\n\n/**\n * Default KV store ready for immediate use. You can create new instances if\n * you want, but most likely you will only need one store instance.\n */\nexport const kvStore = new KVStore(\n DEFAULT_DB_NAME,\n DEFAULT_DB_VERSION,\n DEFAULT_EXPIRY_DELTA_MS,\n);\n\n/**\n * Class to represent one key in the store with a default expiration.\n */\nclass KvStoreItem<T> {\n public constructor(\n public readonly key: string,\n public readonly defaultExpiryDeltaMs: number,\n public readonly store = kvStore,\n ) {}\n\n /**\n * Example usage:\n *\n * const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();\n */\n public async getStoredObject(): Promise<StoredObject<T> | undefined> {\n return await this.store.getStoredObject(this.key);\n }\n\n public async get(): Promise<T | undefined> {\n return await this.store.get(this.key);\n }\n\n public async set(\n value: T,\n expiryDeltaMs: number = this.defaultExpiryDeltaMs,\n ): Promise<void> {\n await this.store.set(this.key, value, expiryDeltaMs);\n }\n\n public async delete(): Promise<void> {\n await this.store.delete(this.key);\n }\n}\n\n/**\n * Create a KV store item with a key and a default expiration.\n */\nexport function kvStoreItem<T>(\n key: string,\n defaultExpiration: number | Duration,\n): KvStoreItem<T> {\n const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);\n\n return new KvStoreItem<T>(key, defaultExpiryDeltaMs);\n}\n"],"mappings":"AA0LO,SAASA,EAAaC,EAA4B,CACvD,IAAMC,GAAUD,EAAS,MAAQ,GAAK,MAChCE,GAAWF,EAAS,OAAS,GAAK,KAClCG,GAAUH,EAAS,SAAW,GAAK,IACnCI,GAAUJ,EAAS,SAAW,GAAK,IACnCK,EAAOL,EAAS,cAAgB,EAEtC,OAAOC,EAASC,EAAUC,EAASC,EAASC,CAC9C,CAKO,SAASC,EAAiBN,EAAqC,CACpE,OAAO,OAAOA,GAAa,SAAWA,EAAWD,EAAaC,CAAQ,CACxE,CCzLA,IAAMO,EAAkB,UAGlBC,EAAqB,EAGrBC,EAAa,UAGNC,EAAiB,MAGjBC,EAA0BD,EAAiB,GAG3CE,EAAiBF,EAa9B,SAASG,EACPC,EAC6B,CAC7B,GACE,GAACA,GACD,OAAOA,GAAQ,UACf,EAAE,QAASA,IACX,OAAOA,EAAI,KAAQ,UACnB,EAAE,UAAWA,IACb,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxBA,EAAI,QAAU,QACd,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxB,KAAK,IAAI,GAAKA,EAAI,UAKpB,OAAOA,CACT,CAGA,SAASC,EACPC,EACAC,EACG,CACH,OAAAD,EAAQ,QAAWE,GAAU,CAC3BD,EAAOC,CAAK,CACd,EAEOF,CACT,CAEO,IAAMG,EAAN,KAAsB,CACpB,YACWC,EACAC,EAChB,CAFgB,WAAAD,EACA,SAAAC,CACf,CAEI,KAA8B,CACnC,OAAO,KAAK,MAAM,IAAI,KAAK,GAAG,CAChC,CAEO,IAAI,EAAkB,CAC3B,OAAO,KAAK,MAAM,IAAI,KAAK,IAAK,CAAC,CACnC,CAEO,QAAwB,CAC7B,OAAO,KAAK,MAAM,OAAO,KAAK,GAAG,CACnC,CACF,EAMaC,EAAN,KAAc,CAOZ,YACWC,EACAC,EACAC,EAChB,CAHgB,YAAAF,EACA,eAAAC,EACA,0BAAAC,EAEhB,KAAK,eAAiB,sBAAsBF,CAAM,KAAKC,CAAS,IAAIf,CAAU,EAChF,CAXQ,GAGQ,eAUhB,MAAc,eAAgB,CAC5B,OAAK,KAAK,KACR,KAAK,GAAK,MAAM,IAAI,QAAqB,CAACiB,EAAST,IAAW,CAC5D,IAAMD,EAAUD,EACd,WAAW,UAAU,KAAK,KAAK,OAAQ,KAAK,SAAS,EACrDE,CACF,EAEAD,EAAQ,gBAAmBE,GAAU,CACvBA,EAAM,OACf,OAGoB,kBAAkBT,EAAY,CACnD,QAAS,KACX,CAAC,EAEW,YAAY,MAAO,MAAO,CACpC,OAAQ,EACV,CAAC,CACH,EAEAO,EAAQ,UAAaE,GAAU,CAC7B,IAAMS,EAAMT,EAAM,OACf,OACHQ,EAAQC,CAAE,CACZ,CACF,CAAC,GAGI,KAAK,EACd,CAEA,MAAc,SACZC,EACAC,EAKY,CACZ,IAAMF,EAAK,MAAM,KAAK,cAAc,EAEpC,OAAO,MAAM,IAAI,QAAW,CAACD,EAAST,IAAW,CAC/C,IAAMa,EAAcf,EAAYY,EAAG,YAAYlB,EAAYmB,CAAI,EAAGX,CAAM,EAExEa,EAAY,QAAWZ,GAAU,CAC/BD,EAAOC,CAAK,CACd,EAEA,IAAMa,EAAcD,EAAY,YAAYrB,CAAU,EAEtDoB,EAASE,EAAaL,EAAST,CAAM,CACvC,CAAC,CACH,CAEA,MAAa,IACXI,EACAW,EACAC,EAAmC,KAAK,qBAC5B,CACZ,IAAMC,EAAQ,KAAK,IAAI,EACjBpB,EAAuB,CAC3B,IAAAO,EACA,MAAAW,EACA,SAAUE,EACV,SAAUA,EAAQC,EAAiBF,CAAa,CAClD,EAEA,OAAO,MAAM,KAAK,SAChB,YACA,CAACF,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIjB,CAAG,EAAGG,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQM,CAAK,EAEb,KAAK,GAAG,CACV,CACF,CACF,CACF,CAGA,MAAa,OAAOX,EAAuC,CACzD,OAAO,MAAM,KAAK,SAChB,YACA,CAACU,EAAaL,EAAST,IAAW,CAKhC,GAJAc,EAAY,YAAY,WAAa,IAAM,CACzCL,EAAQ,CACV,EAEI,OAAOL,GAAQ,SACjBN,EAAYgB,EAAY,OAAOV,CAAG,EAAGJ,CAAM,MAE3C,SAAWmB,KAAKf,EACdN,EAAYgB,EAAY,OAAOK,CAAC,EAAGnB,CAAM,CAG/C,CACF,CACF,CAEA,MAAa,gBACXI,EACsC,CACtC,IAAMgB,EAAS,MAAM,KAAK,SACxB,WACA,CAACN,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIV,CAAG,EAAGJ,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQV,EAAQ,MAAM,CACxB,CACF,CACF,EAEA,GAAKqB,EAIL,GAAI,CACF,IAAMvB,EAAMD,EAAqBwB,CAAM,EACvC,GAAI,CAACvB,EAAK,CACR,MAAM,KAAK,OAAOO,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CAEA,OAAOP,CACT,OAASwB,EAAG,CACV,QAAQ,MAAM,qBAAqBjB,CAAG,IAAI,KAAK,UAAUgB,CAAM,CAAC,IAAKC,CAAC,EACtE,MAAM,KAAK,OAAOjB,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CACF,CAEA,MAAa,IAAOA,EAAqC,CAGvD,OAFY,MAAM,KAAK,gBAAmBA,CAAG,IAEjC,KACd,CAEA,MAAa,QACXQ,EAKe,CACf,MAAM,KAAK,SAAe,WAAY,CAACE,EAAaL,EAAST,IAAW,CACtE,IAAMD,EAAUD,EAAYgB,EAAY,WAAW,EAAGd,CAAM,EAE5DD,EAAQ,UAAY,MAAOE,GAAU,CACnC,IAAMqB,EACJrB,EAAM,OACN,OAEF,GAAIqB,EAAQ,CACV,GAAIA,EAAO,IAAK,CACd,IAAMzB,EAAMD,EAAqB0B,EAAO,KAAK,EACzCzB,EACF,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAGzB,EAAI,MAAOA,EAAI,QAAQ,EAE1D,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAG,OAAW,CAAC,CAEnD,CACAA,EAAO,SAAS,CAClB,MACEb,EAAQ,CAEZ,CACF,CAAC,CACH,CAGA,MAAa,MAAO,CAClB,IAAIc,EAAQ,EACZ,aAAM,KAAK,QAAQ,IAAM,CACvBA,GACF,CAAC,EACMA,CACT,CAEA,MAAa,OAAQ,CACnB,IAAMC,EAAiB,CAAC,EACxB,MAAM,KAAK,QAASpB,GAAQ,CAC1BoB,EAAK,KAAKpB,CAAG,CACf,CAAC,EAED,MAAM,KAAK,OAAOoB,CAAI,CACxB,CAGA,MAAa,OAAuC,CAClD,IAAMC,EAAM,IAAI,IAChB,aAAM,KAAK,QAAQ,CAACrB,EAAKW,EAAOW,IAAa,CAC3CD,EAAI,IAAIrB,EAAK,CAAE,MAAAW,EAAO,SAAAW,CAAS,CAAC,CAClC,CAAC,EACMD,CACT,CAEA,IAAW,UAAmB,CAC5B,IAAME,EAAc,WAAW,aAAa,QAAQ,KAAK,cAAc,EACvE,GAAI,CAACA,EAAa,MAAO,GAEzB,IAAMC,EAAK,OAAOD,CAAW,EAC7B,OAAO,MAAMC,CAAE,EAAI,EAAIA,CACzB,CAEA,IAAW,SAASA,EAAY,CAC9B,WAAW,aAAa,QAAQ,KAAK,eAAgB,OAAOA,CAAE,CAAC,CACjE,CAGA,MAAa,IAAK,CAChB,IAAMC,EAAW,KAAK,SAGtB,GAAI,CAACA,EAAU,CACb,KAAK,SAAW,KAAK,IAAI,EACzB,MACF,CAEI,KAAK,IAAI,EAAIA,EAAWlC,GAK5B,MAAM,KAAK,MAAM,CACnB,CAGA,MAAa,OAAQ,CACnB,QAAQ,IAAI,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,KAAK,EAGzE,KAAK,SAAW,KAAK,IAAI,EAEzB,IAAMmC,EAAyB,CAAC,EAChC,MAAM,KAAK,QACT,MAAO1B,EAAaW,EAAgBW,IAAqB,EACnDX,IAAU,QAAa,KAAK,IAAI,GAAKW,IACvCI,EAAa,KAAK1B,CAAG,CAEzB,CACF,EAEI0B,EAAa,QACf,MAAM,KAAK,OAAOA,CAAY,EAGhC,QAAQ,IACN,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,cACzCA,EAAa,MAAM,OACpC,EAGA,KAAK,SAAW,KAAK,IAAI,CAC3B,CAGO,MAAS1B,EAAa,CAC3B,OAAO,IAAIF,EAAgB,KAAME,CAAG,CACtC,CACF,EAMa2B,EAAU,IAAI1B,EACzBf,EACAC,EACAG,CACF,EAKMsC,EAAN,KAAqB,CACZ,YACW5B,EACAI,EACAL,EAAQ4B,EACxB,CAHgB,SAAA3B,EACA,0BAAAI,EACA,WAAAL,CACf,CAOH,MAAa,iBAAwD,CACnE,OAAO,MAAM,KAAK,MAAM,gBAAgB,KAAK,GAAG,CAClD,CAEA,MAAa,KAA8B,CACzC,OAAO,MAAM,KAAK,MAAM,IAAI,KAAK,GAAG,CACtC,CAEA,MAAa,IACXY,EACAC,EAAwB,KAAK,qBACd,CACf,MAAM,KAAK,MAAM,IAAI,KAAK,IAAKD,EAAOC,CAAa,CACrD,CAEA,MAAa,QAAwB,CACnC,MAAM,KAAK,MAAM,OAAO,KAAK,GAAG,CAClC,CACF,EAKO,SAASiB,EACd7B,EACA8B,EACgB,CAChB,IAAM1B,EAAuBU,EAAiBgB,CAAiB,EAE/D,OAAO,IAAIF,EAAe5B,EAAKI,CAAoB,CACrD","names":["durationToMs","duration","daysMs","hoursMs","minsMs","secsMs","msMs","durationOrMsToMs","DEFAULT_DB_NAME","DEFAULT_DB_VERSION","STORE_NAME","MILLIS_PER_DAY","DEFAULT_EXPIRY_DELTA_MS","GC_INTERVAL_MS","validateStoredObject","obj","withOnError","request","reject","event","KVStoreField","store","key","KVStore","dbName","dbVersion","defaultExpiryDeltaMs","resolve","db","mode","callback","transaction","objectStore","value","expiryDeltaMs","nowMs","durationOrMsToMs","k","stored","e","cursor","count","keys","map","expiryMs","lastGcMsStr","ms","lastGcMs","keysToDelete","kvStore","KvStoreItem","kvStoreItem","defaultExpiration"]}
|