@choksheak/ts-utils 0.1.5 → 0.1.6

package/dateTimeStr.d.ts

@@ -0,0 +1,14 @@
+export declare class DateTimeStr {
+    static yyyyMmDd(dt?: Date, separator?: string): string;
+    static hhMmSs(dt?: Date, separator?: string): string;
+    static hhMmSsMs(dt?: Date, timeSeparator?: string, msSeparator?: string): string;
+    static tz(dt?: Date): string;
+    /** Full local date/time string. */
+    static local(dt?: Date, dateSeparator?: string, dtSeparator?: string, timeSeparator?: string, msSeparator?: string): string;
+    /** Use the default ISO string function to keep things simple here. */
+    static utc(dt?: Date): string;
+    /** Default full local date+time string with full & concise info. */
+    static get now(): string;
+    /** Default full UTC date+time string with full & concise info. */
+    static get utcNow(): string;
+}

package/dateTimeStr.js

@@ -0,0 +1,71 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/dateTimeStr.ts
+var dateTimeStr_exports = {};
+__export(dateTimeStr_exports, {
+  DateTimeStr: () => DateTimeStr
+});
+module.exports = __toCommonJS(dateTimeStr_exports);
+var DateTimeStr = class _DateTimeStr {
+  static yyyyMmDd(dt = /* @__PURE__ */ new Date(), separator = "-") {
+    const yr = dt.getFullYear();
+    const mth = dt.getMonth() + 1;
+    const day = dt.getDate();
+    return yr + separator + (mth < 10 ? "0" + mth : mth) + separator + (day < 10 ? "0" + day : day);
+  }
+  static hhMmSs(dt = /* @__PURE__ */ new Date(), separator = ":") {
+    const hr = dt.getHours();
+    const min = dt.getMinutes();
+    const sec = dt.getSeconds();
+    return (hr < 10 ? "0" + hr : hr) + separator + (min < 10 ? "0" + min : min) + separator + (sec < 10 ? "0" + sec : sec);
+  }
+  static hhMmSsMs(dt = /* @__PURE__ */ new Date(), timeSeparator = ":", msSeparator = ".") {
+    const ms = dt.getMilliseconds();
+    return _DateTimeStr.hhMmSs(dt, timeSeparator) + msSeparator + (ms < 10 ? "00" + ms : ms < 100 ? "0" + ms : ms);
+  }
+  static tz(dt = /* @__PURE__ */ new Date()) {
+    if (dt.getTimezoneOffset() === 0) {
+      return "Z";
+    }
+    const tzHours = dt.getTimezoneOffset() / 60;
+    return tzHours >= 0 ? "+" + tzHours : String(tzHours);
+  }
+  /** Full local date/time string. */
+  static local(dt = /* @__PURE__ */ new Date(), dateSeparator = "-", dtSeparator = " ", timeSeparator = ":", msSeparator = ".") {
+    return _DateTimeStr.yyyyMmDd(dt, dateSeparator) + dtSeparator + _DateTimeStr.hhMmSsMs(dt, timeSeparator, msSeparator) + _DateTimeStr.tz(dt);
+  }
+  /** Use the default ISO string function to keep things simple here. */
+  static utc(dt = /* @__PURE__ */ new Date()) {
+    return dt.toISOString();
+  }
+  /** Default full local date+time string with full & concise info. */
+  static get now() {
+    return _DateTimeStr.local();
+  }
+  /** Default full UTC date+time string with full & concise info. */
+  static get utcNow() {
+    return _DateTimeStr.utc();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DateTimeStr
+});
+//# sourceMappingURL=dateTimeStr.js.map

package/dateTimeStr.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dateTimeStr.ts"],"sourcesContent":["export class DateTimeStr {\n  public static yyyyMmDd(dt = new Date(), separator = \"-\"): string {\n    const yr = dt.getFullYear();\n    const mth = dt.getMonth() + 1;\n    const day = dt.getDate();\n\n    return (\n      yr +\n      separator +\n      (mth < 10 ? \"0\" + mth : mth) +\n      separator +\n      (day < 10 ? \"0\" + day : day)\n    );\n  }\n\n  public static hhMmSs(dt = new Date(), separator = \":\"): string {\n    const hr = dt.getHours();\n    const min = dt.getMinutes();\n    const sec = dt.getSeconds();\n\n    return (\n      (hr < 10 ? \"0\" + hr : hr) +\n      separator +\n      (min < 10 ? \"0\" + min : min) +\n      separator +\n      (sec < 10 ? \"0\" + sec : sec)\n    );\n  }\n\n  public static hhMmSsMs(\n    dt = new Date(),\n    timeSeparator = \":\",\n    msSeparator = \".\",\n  ): string {\n    const ms = dt.getMilliseconds();\n\n    return (\n      DateTimeStr.hhMmSs(dt, timeSeparator) +\n      msSeparator +\n      (ms < 10 ? \"00\" + ms : ms < 100 ? \"0\" + ms : ms)\n    );\n  }\n\n  public static tz(dt = new Date()): string {\n    if (dt.getTimezoneOffset() === 0) {\n      return \"Z\";\n    }\n\n    const tzHours = dt.getTimezoneOffset() / 60;\n    return tzHours >= 0 ? \"+\" + tzHours : String(tzHours);\n  }\n\n  /** Full local date/time string. */\n  public static local(\n    dt = new Date(),\n    dateSeparator = \"-\",\n    dtSeparator = \" \",\n    timeSeparator = \":\",\n    msSeparator = \".\",\n  ): string {\n    return (\n      DateTimeStr.yyyyMmDd(dt, dateSeparator) +\n      dtSeparator +\n      DateTimeStr.hhMmSsMs(dt, timeSeparator, msSeparator) +\n      DateTimeStr.tz(dt)\n    );\n  }\n\n  /** Use the default ISO string function to keep things simple here. */\n  public static utc(dt = new Date()) {\n    return dt.toISOString();\n  }\n\n  /** Default full local date+time string with full & concise info. */\n  public static get now() {\n    return DateTimeStr.local();\n  }\n\n  /** Default full UTC date+time string with full & concise info. */\n  public static get utcNow() {\n    return DateTimeStr.utc();\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,IAAM,cAAN,MAAM,aAAY;AAAA,EACvB,OAAc,SAAS,KAAK,oBAAI,KAAK,GAAG,YAAY,KAAa;AAC/D,UAAM,KAAK,GAAG,YAAY;AAC1B,UAAM,MAAM,GAAG,SAAS,IAAI;AAC5B,UAAM,MAAM,GAAG,QAAQ;AAEvB,WACE,KACA,aACC,MAAM,KAAK,MAAM,MAAM,OACxB,aACC,MAAM,KAAK,MAAM,MAAM;AAAA,EAE5B;AAAA,EAEA,OAAc,OAAO,KAAK,oBAAI,KAAK,GAAG,YAAY,KAAa;AAC7D,UAAM,KAAK,GAAG,SAAS;AACvB,UAAM,MAAM,GAAG,WAAW;AAC1B,UAAM,MAAM,GAAG,WAAW;AAE1B,YACG,KAAK,KAAK,MAAM,KAAK,MACtB,aACC,MAAM,KAAK,MAAM,MAAM,OACxB,aACC,MAAM,KAAK,MAAM,MAAM;AAAA,EAE5B;AAAA,EAEA,OAAc,SACZ,KAAK,oBAAI,KAAK,GACd,gBAAgB,KAChB,cAAc,KACN;AACR,UAAM,KAAK,GAAG,gBAAgB;AAE9B,WACE,aAAY,OAAO,IAAI,aAAa,IACpC,eACC,KAAK,KAAK,OAAO,KAAK,KAAK,MAAM,MAAM,KAAK;AAAA,EAEjD;AAAA,EAEA,OAAc,GAAG,KAAK,oBAAI,KAAK,GAAW;AACxC,QAAI,GAAG,kBAAkB,MAAM,GAAG;AAChC,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,GAAG,kBAAkB,IAAI;AACzC,WAAO,WAAW,IAAI,MAAM,UAAU,OAAO,OAAO;AAAA,EACtD;AAAA;AAAA,EAGA,OAAc,MACZ,KAAK,oBAAI,KAAK,GACd,gBAAgB,KAChB,cAAc,KACd,gBAAgB,KAChB,cAAc,KACN;AACR,WACE,aAAY,SAAS,IAAI,aAAa,IACtC,cACA,aAAY,SAAS,IAAI,eAAe,WAAW,IACnD,aAAY,GAAG,EAAE;AAAA,EAErB;AAAA;AAAA,EAGA,OAAc,IAAI,KAAK,oBAAI,KAAK,GAAG;AACjC,WAAO,GAAG,YAAY;AAAA,EACxB;AAAA;AAAA,EAGA,WAAkB,MAAM;AACtB,WAAO,aAAY,MAAM;AAAA,EAC3B;AAAA;AAAA,EAGA,WAAkB,SAAS;AACzB,WAAO,aAAY,IAAI;AAAA,EACzB;AACF;","names":[]}

package/isEmpty.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns true if `t` is empty.
+ */
+export declare function isEmpty(t: unknown): boolean;

package/isEmpty.js

@@ -0,0 +1,48 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/isEmpty.ts
+var isEmpty_exports = {};
+__export(isEmpty_exports, {
+  isEmpty: () => isEmpty
+});
+module.exports = __toCommonJS(isEmpty_exports);
+function isEmpty(t) {
+  if (!t) {
+    return true;
+  }
+  if (typeof t !== "object") {
+    return false;
+  }
+  if ("length" in t) {
+    return t.length === 0;
+  }
+  if ("size" in t) {
+    return t.size === 0;
+  }
+  for (const k in t) {
+    return false;
+  }
+  return true;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isEmpty
+});
+//# sourceMappingURL=isEmpty.js.map

package/isEmpty.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/isEmpty.ts"],"sourcesContent":["/**\n * Returns true if `t` is empty.\n */\nexport function isEmpty(t: unknown): boolean {\n  // Anything falsy is considered empty.\n  if (!t) {\n    return true;\n  }\n\n  // Arrays are also of type `object`.\n  if (typeof t !== \"object\") {\n    return false;\n  }\n\n  // `length` includes arrays as well.\n  if (\"length\" in t) {\n    return t.length === 0;\n  }\n\n  // `size` is for Set, Map, Blob etc.\n  if (\"size\" in t) {\n    return t.size === 0;\n  }\n\n  // Super fast check for object emptiness.\n  // https://stackoverflow.com/questions/679915/how-do-i-test-for-an-empty-javascript-object\n  for (const k in t) {\n    return false;\n  }\n\n  return true;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,SAAS,QAAQ,GAAqB;AAE3C,MAAI,CAAC,GAAG;AACN,WAAO;AAAA,EACT;AAGA,MAAI,OAAO,MAAM,UAAU;AACzB,WAAO;AAAA,EACT;AAGA,MAAI,YAAY,GAAG;AACjB,WAAO,EAAE,WAAW;AAAA,EACtB;AAGA,MAAI,UAAU,GAAG;AACf,WAAO,EAAE,SAAS;AAAA,EACpB;AAIA,aAAW,KAAK,GAAG;AACjB,WAAO;AAAA,EACT;AAEA,SAAO;AACT;","names":[]}

package/kvStore.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Indexed DB key-value store with support for auto-expirations.
+ *
+ * Why use this?
+ * 1. No need to worry about running out of storage.
+ * 2. Extremely simple interface to use indexed DBs.
+ * 3. Auto-expirations frees you from worrying about data clean-up.
+ * 4. Any serializable data type can be stored (except undefined).
+ *
+ * How to use?
+ * Just use the `kvStore` global constant like the local storage.
+ */
+/** One day in milliseconds. */
+export declare const MILLIS_PER_DAY = 86400000;
+/** 30 days in ms. */
+export declare const DEFAULT_EXPIRY_DELTA_MS: number;
+/** Do GC once per day. */
+export declare const GC_INTERVAL_MS = 86400000;
+export declare class KVStoreField<T> {
+    readonly store: KVStore;
+    readonly key: string;
+    constructor(store: KVStore, key: string);
+    get(): Promise<T | undefined>;
+    set(t: T): Promise<T>;
+    delete(): Promise<void>;
+}
+/**
+ * You can create multiple KVStores if you want, but most likely you will only
+ * need to use the default `kvStore` instance.
+ */
+export declare class KVStore {
+    readonly dbName: string;
+    readonly dbVersion: number;
+    readonly defaultExpiryDeltaMs: number;
+    private db;
+    readonly gcMsStorageKey: string;
+    constructor(dbName: string, dbVersion: number, defaultExpiryDeltaMs: number);
+    private getOrCreateDb;
+    private transact;
+    set<T>(key: string, value: T, expireDeltaMs?: number): Promise<T>;
+    /** Delete one or multiple keys. */
+    delete(key: string | string[]): Promise<void>;
+    get<T>(key: string): Promise<T | undefined>;
+    forEach(callback: (key: string, value: unknown, expireMs: number) => void | Promise<void>): Promise<void>;
+    /** Cannot be a getter because this needs to be async. */
+    size(): Promise<number>;
+    clear(): Promise<void>;
+    /** Mainly for debugging dumps. */
+    asMap(): Promise<Map<string, unknown>>;
+    get lastGcMs(): number;
+    set lastGcMs(ms: number);
+    /** Perform garbage-collection if due. */
+    gc(): Promise<void>;
+    /** Perform garbage-collection immediately without checking. */
+    gcNow(): Promise<void>;
+    /** Get an independent store item with a locked key and value type. */
+    field<T>(key: string): KVStoreField<T>;
+}
+/**
+ * Default KV store ready for immediate use. You can create new instances if
+ * you want, but most likely you will only need one store instance.
+ */
+export declare const kvStore: KVStore;

package/kvStore.js

@@ -0,0 +1,315 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/kvStore.ts
+var kvStore_exports = {};
+__export(kvStore_exports, {
+  DEFAULT_EXPIRY_DELTA_MS: () => DEFAULT_EXPIRY_DELTA_MS,
+  GC_INTERVAL_MS: () => GC_INTERVAL_MS,
+  KVStore: () => KVStore,
+  KVStoreField: () => KVStoreField,
+  MILLIS_PER_DAY: () => MILLIS_PER_DAY,
+  kvStore: () => kvStore
+});
+module.exports = __toCommonJS(kvStore_exports);
+var DEFAULT_DB_NAME = "KVStore";
+var DEFAULT_DB_VERSION = 1;
+var STORE_NAME = "kvStore";
+var MILLIS_PER_DAY = 864e5;
+var DEFAULT_EXPIRY_DELTA_MS = MILLIS_PER_DAY * 30;
+var GC_INTERVAL_MS = MILLIS_PER_DAY;
+function validateStoredObject(obj) {
+  if (!obj || typeof obj !== "object" || !("key" in obj) || typeof obj.key !== "string" || !("value" in obj) || obj.value === void 0 || !("expireMs" in obj) || typeof obj.expireMs !== "number" || Date.now() >= obj.expireMs) {
+    return void 0;
+  }
+  return obj;
+}
+function withOnError(request, reject) {
+  request.onerror = (event) => {
+    reject(event);
+  };
+  return request;
+}
+var KVStoreField = class {
+  constructor(store, key) {
+    this.store = store;
+    this.key = key;
+  }
+  get() {
+    return this.store.get(this.key);
+  }
+  set(t) {
+    return this.store.set(this.key, t);
+  }
+  delete() {
+    return this.store.delete(this.key);
+  }
+};
+var KVStore = class {
+  constructor(dbName, dbVersion, defaultExpiryDeltaMs) {
+    this.dbName = dbName;
+    this.dbVersion = dbVersion;
+    this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
+    this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;
+  }
+  getOrCreateDb() {
+    return __async(this, null, function* () {
+      if (!this.db) {
+        this.db = yield new Promise((resolve, reject) => {
+          const request = withOnError(
+            globalThis.indexedDB.open(this.dbName, this.dbVersion),
+            reject
+          );
+          request.onupgradeneeded = (event) => {
+            const db = event.target.result;
+            const objectStore = db.createObjectStore(STORE_NAME, {
+              keyPath: "key"
+            });
+            objectStore.createIndex("key", "key", {
+              unique: true
+            });
+          };
+          request.onsuccess = (event) => {
+            const db = event.target.result;
+            resolve(db);
+          };
+        });
+      }
+      return this.db;
+    });
+  }
+  transact(mode, callback) {
+    return __async(this, null, function* () {
+      const db = yield this.getOrCreateDb();
+      return yield new Promise((resolve, reject) => {
+        const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);
+        transaction.onabort = (event) => {
+          reject(event);
+        };
+        const objectStore = transaction.objectStore(STORE_NAME);
+        callback(objectStore, resolve, reject);
+      });
+    });
+  }
+  set(_0, _1) {
+    return __async(this, arguments, function* (key, value, expireDeltaMs = this.defaultExpiryDeltaMs) {
+      const obj = {
+        key,
+        value,
+        expireMs: Date.now() + expireDeltaMs
+      };
+      return yield this.transact(
+        "readwrite",
+        (objectStore, resolve, reject) => {
+          const request = withOnError(objectStore.put(obj), reject);
+          request.onsuccess = () => {
+            resolve(value);
+            this.gc();
+          };
+        }
+      );
+    });
+  }
+  /** Delete one or multiple keys. */
+  delete(key) {
+    return __async(this, null, function* () {
+      return yield this.transact(
+        "readwrite",
+        (objectStore, resolve, reject) => {
+          objectStore.transaction.oncomplete = () => {
+            resolve();
+          };
+          if (typeof key === "string") {
+            withOnError(objectStore.delete(key), reject);
+          } else {
+            for (const k of key) {
+              withOnError(objectStore.delete(k), reject);
+            }
+          }
+        }
+      );
+    });
+  }
+  get(key) {
+    return __async(this, null, function* () {
+      const stored = yield this.transact(
+        "readonly",
+        (objectStore, resolve, reject) => {
+          const request = withOnError(objectStore.get(key), reject);
+          request.onsuccess = () => {
+            resolve(request.result);
+          };
+        }
+      );
+      if (!stored) {
+        return void 0;
+      }
+      try {
+        const obj = validateStoredObject(stored);
+        if (!obj) {
+          yield this.delete(key);
+          this.gc();
+          return void 0;
+        }
+        return obj.value;
+      } catch (e) {
+        console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);
+        yield this.delete(key);
+        this.gc();
+        return void 0;
+      }
+    });
+  }
+  forEach(callback) {
+    return __async(this, null, function* () {
+      yield this.transact("readonly", (objectStore, resolve, reject) => {
+        const request = withOnError(objectStore.openCursor(), reject);
+        request.onsuccess = (event) => __async(this, null, function* () {
+          const cursor = event.target.result;
+          if (cursor) {
+            if (cursor.key) {
+              const obj = validateStoredObject(cursor.value);
+              if (obj) {
+                yield callback(String(cursor.key), obj.value, obj.expireMs);
+              } else {
+                yield callback(String(cursor.key), void 0, 0);
+              }
+            }
+            cursor.continue();
+          } else {
+            resolve();
+          }
+        });
+      });
+    });
+  }
+  /** Cannot be a getter because this needs to be async. */
+  size() {
+    return __async(this, null, function* () {
+      let count = 0;
+      yield this.forEach(() => {
+        count++;
+      });
+      return count;
+    });
+  }
+  clear() {
+    return __async(this, null, function* () {
+      const keys = [];
+      yield this.forEach((key) => {
+        keys.push(key);
+      });
+      yield this.delete(keys);
+    });
+  }
+  /** Mainly for debugging dumps. */
+  asMap() {
+    return __async(this, null, function* () {
+      const map = /* @__PURE__ */ new Map();
+      yield this.forEach((key, value, expireMs) => {
+        map.set(key, { value, expireMs });
+      });
+      return map;
+    });
+  }
+  get lastGcMs() {
+    const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);
+    if (!lastGcMsStr) return 0;
+    const ms = Number(lastGcMsStr);
+    return isNaN(ms) ? 0 : ms;
+  }
+  set lastGcMs(ms) {
+    globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));
+  }
+  /** Perform garbage-collection if due. */
+  gc() {
+    return __async(this, null, function* () {
+      const lastGcMs = this.lastGcMs;
+      if (!lastGcMs) {
+        this.lastGcMs = Date.now();
+        return;
+      }
+      if (Date.now() < lastGcMs + GC_INTERVAL_MS) {
+        return;
+      }
+      yield this.gcNow();
+    });
+  }
+  /** Perform garbage-collection immediately without checking. */
+  gcNow() {
+    return __async(this, null, function* () {
+      console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);
+      this.lastGcMs = Date.now();
+      const keysToDelete = [];
+      yield this.forEach(
+        (key, value, expireMs) => __async(this, null, function* () {
+          if (value === void 0 || Date.now() >= expireMs) {
+            keysToDelete.push(key);
+          }
+        })
+      );
+      if (keysToDelete.length) {
+        yield this.delete(keysToDelete);
+      }
+      console.log(
+        `Finished kvStore GC on ${this.dbName} v${this.dbVersion} - deleted ${keysToDelete.length} keys`
+      );
+      this.lastGcMs = Date.now();
+    });
+  }
+  /** Get an independent store item with a locked key and value type. */
+  field(key) {
+    return new KVStoreField(this, key);
+  }
+};
+var kvStore = new KVStore(
+  DEFAULT_DB_NAME,
+  DEFAULT_DB_VERSION,
+  DEFAULT_EXPIRY_DELTA_MS
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_EXPIRY_DELTA_MS,
+  GC_INTERVAL_MS,
+  KVStore,
+  KVStoreField,
+  MILLIS_PER_DAY,
+  kvStore
+});
+//# sourceMappingURL=kvStore.js.map

package/kvStore.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/kvStore.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\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  expireMs: 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    obj.value === undefined ||\n    !(\"expireMs\" in obj) ||\n    typeof obj.expireMs !== \"number\" ||\n    Date.now() >= obj.expireMs\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    expireDeltaMs: number = this.defaultExpiryDeltaMs,\n  ): Promise<T> {\n    const obj = {\n      key,\n      value,\n      expireMs: Date.now() + expireDeltaMs,\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 get<T>(key: string): Promise<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.value;\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 forEach(\n    callback: (\n      key: string,\n      value: unknown,\n      expireMs: 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.expireMs);\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, expireMs) => {\n      map.set(key, { value, expireMs });\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, expireMs: number) => {\n        if (value === undefined || Date.now() >= expireMs) {\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAcA,IAAM,kBAAkB;AAGxB,IAAM,qBAAqB;AAG3B,IAAM,aAAa;AAGZ,IAAM,iBAAiB;AAGvB,IAAM,0BAA0B,iBAAiB;AAGjD,IAAM,iBAAiB;AAY9B,SAAS,qBACP,KAC6B;AAC7B,MACE,CAAC,OACD,OAAO,QAAQ,YACf,EAAE,SAAS,QACX,OAAO,IAAI,QAAQ,YACnB,EAAE,WAAW,QACb,IAAI,UAAU,UACd,EAAE,cAAc,QAChB,OAAO,IAAI,aAAa,YACxB,KAAK,IAAI,KAAK,IAAI,UAClB;AACA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGA,SAAS,YACP,SACA,QACG;AACH,UAAQ,UAAU,CAAC,UAAU;AAC3B,WAAO,KAAK;AAAA,EACd;AAEA,SAAO;AACT;AAEO,IAAM,eAAN,MAAsB;AAAA,EACpB,YACW,OACA,KAChB;AAFgB;AACA;AAAA,EACf;AAAA,EAEI,MAA8B;AACnC,WAAO,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,EAChC;AAAA,EAEO,IAAI,GAAkB;AAC3B,WAAO,KAAK,MAAM,IAAI,KAAK,KAAK,CAAC;AAAA,EACnC;AAAA,EAEO,SAAwB;AAC7B,WAAO,KAAK,MAAM,OAAO,KAAK,GAAG;AAAA,EACnC;AACF;AAMO,IAAM,UAAN,MAAc;AAAA,EAOZ,YACW,QACA,WACA,sBAChB;AAHgB;AACA;AACA;AAEhB,SAAK,iBAAiB,sBAAsB,MAAM,KAAK,SAAS,IAAI,UAAU;AAAA,EAChF;AAAA,EAEc,gBAAgB;AAAA;AAC5B,UAAI,CAAC,KAAK,IAAI;AACZ,aAAK,KAAK,MAAM,IAAI,QAAqB,CAAC,SAAS,WAAW;AAC5D,gBAAM,UAAU;AAAA,YACd,WAAW,UAAU,KAAK,KAAK,QAAQ,KAAK,SAAS;AAAA,YACrD;AAAA,UACF;AAEA,kBAAQ,kBAAkB,CAAC,UAAU;AACnC,kBAAM,KAAM,MAAM,OACf;AAGH,kBAAM,cAAc,GAAG,kBAAkB,YAAY;AAAA,cACnD,SAAS;AAAA,YACX,CAAC;AAED,wBAAY,YAAY,OAAO,OAAO;AAAA,cACpC,QAAQ;AAAA,YACV,CAAC;AAAA,UACH;AAEA,kBAAQ,YAAY,CAAC,UAAU;AAC7B,kBAAM,KAAM,MAAM,OACf;AACH,oBAAQ,EAAE;AAAA,UACZ;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO,KAAK;AAAA,IACd;AAAA;AAAA,EAEc,SACZ,MACA,UAKY;AAAA;AACZ,YAAM,KAAK,MAAM,KAAK,cAAc;AAEpC,aAAO,MAAM,IAAI,QAAW,CAAC,SAAS,WAAW;AAC/C,cAAM,cAAc,YAAY,GAAG,YAAY,YAAY,IAAI,GAAG,MAAM;AAExE,oBAAY,UAAU,CAAC,UAAU;AAC/B,iBAAO,KAAK;AAAA,QACd;AAEA,cAAM,cAAc,YAAY,YAAY,UAAU;AAEtD,iBAAS,aAAa,SAAS,MAAM;AAAA,MACvC,CAAC;AAAA,IACH;AAAA;AAAA,EAEa,IACX,IACA,IAEY;AAAA,+CAHZ,KACA,OACA,gBAAwB,KAAK,sBACjB;AACZ,YAAM,MAAM;AAAA,QACV;AAAA,QACA;AAAA,QACA,UAAU,KAAK,IAAI,IAAI;AAAA,MACzB;AAEA,aAAO,MAAM,KAAK;AAAA,QAChB;AAAA,QACA,CAAC,aAAa,SAAS,WAAW;AAChC,gBAAM,UAAU,YAAY,YAAY,IAAI,GAAG,GAAG,MAAM;AAExD,kBAAQ,YAAY,MAAM;AACxB,oBAAQ,KAAK;AAEb,iBAAK,GAAG;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AAAA;AAAA,EAGa,OAAO,KAAuC;AAAA;AACzD,aAAO,MAAM,KAAK;AAAA,QAChB;AAAA,QACA,CAAC,aAAa,SAAS,WAAW;AAChC,sBAAY,YAAY,aAAa,MAAM;AACzC,oBAAQ;AAAA,UACV;AAEA,cAAI,OAAO,QAAQ,UAAU;AAC3B,wBAAY,YAAY,OAAO,GAAG,GAAG,MAAM;AAAA,UAC7C,OAAO;AACL,uBAAW,KAAK,KAAK;AACnB,0BAAY,YAAY,OAAO,CAAC,GAAG,MAAM;AAAA,YAC3C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA;AAAA,EAEa,IAAO,KAAqC;AAAA;AACvD,YAAM,SAAS,MAAM,KAAK;AAAA,QACxB;AAAA,QACA,CAAC,aAAa,SAAS,WAAW;AAChC,gBAAM,UAAU,YAAY,YAAY,IAAI,GAAG,GAAG,MAAM;AAExD,kBAAQ,YAAY,MAAM;AACxB,oBAAQ,QAAQ,MAAM;AAAA,UACxB;AAAA,QACF;AAAA,MACF;AAEA,UAAI,CAAC,QAAQ;AACX,eAAO;AAAA,MACT;AAEA,UAAI;AACF,cAAM,MAAM,qBAAqB,MAAM;AACvC,YAAI,CAAC,KAAK;AACR,gBAAM,KAAK,OAAO,GAAG;AAErB,eAAK,GAAG;AAER,iBAAO;AAAA,QACT;AAEA,eAAO,IAAI;AAAA,MACb,SAAS,GAAG;AACV,gBAAQ,MAAM,qBAAqB,GAAG,IAAI,KAAK,UAAU,MAAM,CAAC,KAAK,CAAC;AACtE,cAAM,KAAK,OAAO,GAAG;AAErB,aAAK,GAAG;AAER,eAAO;AAAA,MACT;AAAA,IACF;AAAA;AAAA,EAEa,QACX,UAKe;AAAA;AACf,YAAM,KAAK,SAAe,YAAY,CAAC,aAAa,SAAS,WAAW;AACtE,cAAM,UAAU,YAAY,YAAY,WAAW,GAAG,MAAM;AAE5D,gBAAQ,YAAY,CAAO,UAAU;AACnC,gBAAM,SACJ,MAAM,OACN;AAEF,cAAI,QAAQ;AACV,gBAAI,OAAO,KAAK;AACd,oBAAM,MAAM,qBAAqB,OAAO,KAAK;AAC7C,kBAAI,KAAK;AACP,sBAAM,SAAS,OAAO,OAAO,GAAG,GAAG,IAAI,OAAO,IAAI,QAAQ;AAAA,cAC5D,OAAO;AACL,sBAAM,SAAS,OAAO,OAAO,GAAG,GAAG,QAAW,CAAC;AAAA,cACjD;AAAA,YACF;AACA,mBAAO,SAAS;AAAA,UAClB,OAAO;AACL,oBAAQ;AAAA,UACV;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA;AAAA;AAAA,EAGa,OAAO;AAAA;AAClB,UAAI,QAAQ;AACZ,YAAM,KAAK,QAAQ,MAAM;AACvB;AAAA,MACF,CAAC;AACD,aAAO;AAAA,IACT;AAAA;AAAA,EAEa,QAAQ;AAAA;AACnB,YAAM,OAAiB,CAAC;AACxB,YAAM,KAAK,QAAQ,CAAC,QAAQ;AAC1B,aAAK,KAAK,GAAG;AAAA,MACf,CAAC;AAED,YAAM,KAAK,OAAO,IAAI;AAAA,IACxB;AAAA;AAAA;AAAA,EAGa,QAAuC;AAAA;AAClD,YAAM,MAAM,oBAAI,IAAqB;AACrC,YAAM,KAAK,QAAQ,CAAC,KAAK,OAAO,aAAa;AAC3C,YAAI,IAAI,KAAK,EAAE,OAAO,SAAS,CAAC;AAAA,MAClC,CAAC;AACD,aAAO;AAAA,IACT;AAAA;AAAA,EAEA,IAAW,WAAmB;AAC5B,UAAM,cAAc,WAAW,aAAa,QAAQ,KAAK,cAAc;AACvE,QAAI,CAAC,YAAa,QAAO;AAEzB,UAAM,KAAK,OAAO,WAAW;AAC7B,WAAO,MAAM,EAAE,IAAI,IAAI;AAAA,EACzB;AAAA,EAEA,IAAW,SAAS,IAAY;AAC9B,eAAW,aAAa,QAAQ,KAAK,gBAAgB,OAAO,EAAE,CAAC;AAAA,EACjE;AAAA;AAAA,EAGa,KAAK;AAAA;AAChB,YAAM,WAAW,KAAK;AAGtB,UAAI,CAAC,UAAU;AACb,aAAK,WAAW,KAAK,IAAI;AACzB;AAAA,MACF;AAEA,UAAI,KAAK,IAAI,IAAI,WAAW,gBAAgB;AAC1C;AAAA,MACF;AAGA,YAAM,KAAK,MAAM;AAAA,IACnB;AAAA;AAAA;AAAA,EAGa,QAAQ;AAAA;AACnB,cAAQ,IAAI,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,KAAK;AAGzE,WAAK,WAAW,KAAK,IAAI;AAEzB,YAAM,eAAyB,CAAC;AAChC,YAAM,KAAK;AAAA,QACT,CAAO,KAAa,OAAgB,aAAqB;AACvD,cAAI,UAAU,UAAa,KAAK,IAAI,KAAK,UAAU;AACjD,yBAAa,KAAK,GAAG;AAAA,UACvB;AAAA,QACF;AAAA,MACF;AAEA,UAAI,aAAa,QAAQ;AACvB,cAAM,KAAK,OAAO,YAAY;AAAA,MAChC;AAEA,cAAQ;AAAA,QACN,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,cACzC,aAAa,MAAM;AAAA,MACpC;AAGA,WAAK,WAAW,KAAK,IAAI;AAAA,IAC3B;AAAA;AAAA;AAAA,EAGO,MAAS,KAAa;AAC3B,WAAO,IAAI,aAAgB,MAAM,GAAG;AAAA,EACtC;AACF;AAMO,IAAM,UAAU,IAAI;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AACF;","names":[]}

package/localStorageCache.d.ts

@@ -7,3 +7,12 @@ export declare class LocalStorageCache {
     static setValue<T>(key: string, value: T, expireDeltaMs: number): void;
     static getValue<T>(key: string, logError?: boolean): T | undefined;
 }
+/** Same as above, but saves some config for reuse. */
+export declare class LocalStorageCacheItem<T> {
+    readonly key: string;
+    readonly expireDeltaMs: number;
+    readonly logError: boolean;
+    constructor(key: string, expireDeltaMs: number, logError?: boolean, defaultValue?: T);
+    set(value: T): void;
+    get(): T | undefined;
+}

package/localStorageCache.js

@@ -20,7 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/localStorageCache.ts
 var localStorageCache_exports = {};
 __export(localStorageCache_exports, {
-  LocalStorageCache: () => LocalStorageCache
+  LocalStorageCache: () => LocalStorageCache,
+  LocalStorageCacheItem: () => LocalStorageCacheItem
 });
 module.exports = __toCommonJS(localStorageCache_exports);
 var LocalStorageCache = class {
@@ -31,14 +32,12 @@ var LocalStorageCache = class {
   }
   static getValue(key, logError = true) {
     const jsonStr = globalThis.localStorage.getItem(key);
-    if (!jsonStr) return void 0;
+    if (!jsonStr || typeof jsonStr !== "string") {
+      return void 0;
+    }
     try {
       const obj = JSON.parse(jsonStr);
-      if (!obj || typeof obj !== "object" || !("value" in obj) || !("expireMs" in obj)) {
-        globalThis.localStorage.removeItem(key);
-        return void 0;
-      }
-      if (Date.now() >= obj.expireMs) {
+      if (!obj || typeof obj !== "object" || !("value" in obj) || !("expireMs" in obj) || typeof obj.expireMs !== "number" || Date.now() >= obj.expireMs) {
         globalThis.localStorage.removeItem(key);
         return void 0;
       }
@@ -52,8 +51,27 @@ var LocalStorageCache = class {
     }
   }
 };
+var LocalStorageCacheItem = class {
+  constructor(key, expireDeltaMs, logError = true, defaultValue) {
+    this.key = key;
+    this.expireDeltaMs = expireDeltaMs;
+    this.logError = logError;
+    if (defaultValue !== void 0) {
+      if (this.get() === void 0) {
+        this.set(defaultValue);
+      }
+    }
+  }
+  set(value) {
+    LocalStorageCache.setValue(this.key, value, this.expireDeltaMs);
+  }
+  get() {
+    return LocalStorageCache.getValue(this.key, this.logError);
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  LocalStorageCache
+  LocalStorageCache,
+  LocalStorageCacheItem
 });
 //# sourceMappingURL=localStorageCache.js.map

package/localStorageCache.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/localStorageCache.ts"],"sourcesContent":["/**\n * Simple local storage cache with support for auto-expiration.\n * Note that this works in the browser context only because nodejs does not\n * have local storage.\n */\nexport class LocalStorageCache {\n  public static setValue<T>(key: string, value: T, expireDeltaMs: number) {\n    const expireMs = Date.now() + expireDeltaMs;\n    const valueStr = JSON.stringify({ value, expireMs });\n\n    globalThis.localStorage.setItem(key, valueStr);\n  }\n\n  public static getValue<T>(key: string, logError = true): T | undefined {\n    const jsonStr = globalThis.localStorage.getItem(key);\n    if (!jsonStr) return undefined;\n\n    try {\n      const obj: { value: T; expireMs: number } | undefined =\n        JSON.parse(jsonStr);\n      if (\n        !obj ||\n        typeof obj !== \"object\" ||\n        !(\"value\" in obj) ||\n        !(\"expireMs\" in obj)\n      ) {\n        globalThis.localStorage.removeItem(key);\n        return undefined;\n      }\n\n      if (Date.now() >= obj.expireMs) {\n        globalThis.localStorage.removeItem(key);\n        return undefined;\n      }\n\n      return obj.value;\n    } catch (e) {\n      if (logError) {\n        console.error(`Found invalid storage value: ${key}=${jsonStr}:`, e);\n      }\n      globalThis.localStorage.removeItem(key);\n      return undefined;\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,IAAM,oBAAN,MAAwB;AAAA,EAC7B,OAAc,SAAY,KAAa,OAAU,eAAuB;AACtE,UAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,UAAM,WAAW,KAAK,UAAU,EAAE,OAAO,SAAS,CAAC;AAEnD,eAAW,aAAa,QAAQ,KAAK,QAAQ;AAAA,EAC/C;AAAA,EAEA,OAAc,SAAY,KAAa,WAAW,MAAqB;AACrE,UAAM,UAAU,WAAW,aAAa,QAAQ,GAAG;AACnD,QAAI,CAAC,QAAS,QAAO;AAErB,QAAI;AACF,YAAM,MACJ,KAAK,MAAM,OAAO;AACpB,UACE,CAAC,OACD,OAAO,QAAQ,YACf,EAAE,WAAW,QACb,EAAE,cAAc,MAChB;AACA,mBAAW,aAAa,WAAW,GAAG;AACtC,eAAO;AAAA,MACT;AAEA,UAAI,KAAK,IAAI,KAAK,IAAI,UAAU;AAC9B,mBAAW,aAAa,WAAW,GAAG;AACtC,eAAO;AAAA,MACT;AAEA,aAAO,IAAI;AAAA,IACb,SAAS,GAAG;AACV,UAAI,UAAU;AACZ,gBAAQ,MAAM,gCAAgC,GAAG,IAAI,OAAO,KAAK,CAAC;AAAA,MACpE;AACA,iBAAW,aAAa,WAAW,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../src/localStorageCache.ts"],"sourcesContent":["/**\n * Simple local storage cache with support for auto-expiration.\n * Note that this works in the browser context only because nodejs does not\n * have local storage.\n */\nexport class LocalStorageCache {\n  public static setValue<T>(key: string, value: T, expireDeltaMs: number) {\n    const expireMs = Date.now() + expireDeltaMs;\n    const valueStr = JSON.stringify({ value, expireMs });\n\n    globalThis.localStorage.setItem(key, valueStr);\n  }\n\n  public static getValue<T>(key: string, logError = true): T | undefined {\n    const jsonStr = globalThis.localStorage.getItem(key);\n\n    if (!jsonStr || typeof jsonStr !== \"string\") {\n      return undefined;\n    }\n\n    try {\n      const obj: { value: T; expireMs: number } | undefined =\n        JSON.parse(jsonStr);\n      if (\n        !obj ||\n        typeof obj !== \"object\" ||\n        !(\"value\" in obj) ||\n        !(\"expireMs\" in obj) ||\n        typeof obj.expireMs !== \"number\" ||\n        Date.now() >= obj.expireMs\n      ) {\n        globalThis.localStorage.removeItem(key);\n        return undefined;\n      }\n\n      return obj.value;\n    } catch (e) {\n      if (logError) {\n        console.error(`Found invalid storage value: ${key}=${jsonStr}:`, e);\n      }\n      globalThis.localStorage.removeItem(key);\n      return undefined;\n    }\n  }\n}\n\n/** Same as above, but saves some config for reuse. */\nexport class LocalStorageCacheItem<T> {\n  public constructor(\n    public readonly key: string,\n    public readonly expireDeltaMs: number,\n    public readonly logError = true,\n    defaultValue?: T,\n  ) {\n    if (defaultValue !== undefined) {\n      if (this.get() === undefined) {\n        this.set(defaultValue);\n      }\n    }\n  }\n\n  public set(value: T) {\n    LocalStorageCache.setValue(this.key, value, this.expireDeltaMs);\n  }\n\n  public get(): T | undefined {\n    return LocalStorageCache.getValue(this.key, this.logError);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKO,IAAM,oBAAN,MAAwB;AAAA,EAC7B,OAAc,SAAY,KAAa,OAAU,eAAuB;AACtE,UAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,UAAM,WAAW,KAAK,UAAU,EAAE,OAAO,SAAS,CAAC;AAEnD,eAAW,aAAa,QAAQ,KAAK,QAAQ;AAAA,EAC/C;AAAA,EAEA,OAAc,SAAY,KAAa,WAAW,MAAqB;AACrE,UAAM,UAAU,WAAW,aAAa,QAAQ,GAAG;AAEnD,QAAI,CAAC,WAAW,OAAO,YAAY,UAAU;AAC3C,aAAO;AAAA,IACT;AAEA,QAAI;AACF,YAAM,MACJ,KAAK,MAAM,OAAO;AACpB,UACE,CAAC,OACD,OAAO,QAAQ,YACf,EAAE,WAAW,QACb,EAAE,cAAc,QAChB,OAAO,IAAI,aAAa,YACxB,KAAK,IAAI,KAAK,IAAI,UAClB;AACA,mBAAW,aAAa,WAAW,GAAG;AACtC,eAAO;AAAA,MACT;AAEA,aAAO,IAAI;AAAA,IACb,SAAS,GAAG;AACV,UAAI,UAAU;AACZ,gBAAQ,MAAM,gCAAgC,GAAG,IAAI,OAAO,KAAK,CAAC;AAAA,MACpE;AACA,iBAAW,aAAa,WAAW,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAGO,IAAM,wBAAN,MAA+B;AAAA,EAC7B,YACW,KACA,eACA,WAAW,MAC3B,cACA;AAJgB;AACA;AACA;AAGhB,QAAI,iBAAiB,QAAW;AAC9B,UAAI,KAAK,IAAI,MAAM,QAAW;AAC5B,aAAK,IAAI,YAAY;AAAA,MACvB;AAAA,IACF;AAAA,EACF;AAAA,EAEO,IAAI,OAAU;AACnB,sBAAkB,SAAS,KAAK,KAAK,OAAO,KAAK,aAAa;AAAA,EAChE;AAAA,EAEO,MAAqB;AAC1B,WAAO,kBAAkB,SAAS,KAAK,KAAK,KAAK,QAAQ;AAAA,EAC3D;AACF;","names":[]}

package/nonEmpty.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type asserts that `t` is truthy.
+ * Throws an error if `t` is null or undefined.
+ */
+export declare function nonEmpty<T>(t: T | null | undefined | "" | 0 | -0 | 0n | false | typeof NaN, varName?: string): T;