@choksheak/ts-utils 0.2.9 → 0.3.1

package/kvStore.js

@@ -1,383 +0,0 @@
-"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,
-  kvStoreItem: () => kvStoreItem
-});
-module.exports = __toCommonJS(kvStore_exports);
-
-// src/timeConstants.ts
-var MS_PER_SECOND = 1e3;
-var MS_PER_MINUTE = 6e4;
-var MS_PER_HOUR = 36e5;
-var MS_PER_DAY = 864e5;
-
-// src/duration.ts
-function durationToMs(duration) {
-  var _a, _b, _c, _d, _e;
-  const daysMs = ((_a = duration.days) != null ? _a : 0) * MS_PER_DAY;
-  const hoursMs = ((_b = duration.hours) != null ? _b : 0) * MS_PER_HOUR;
-  const minsMs = ((_c = duration.minutes) != null ? _c : 0) * MS_PER_MINUTE;
-  const secsMs = ((_d = duration.seconds) != null ? _d : 0) * MS_PER_SECOND;
-  const msMs = (_e = duration.milliseconds) != null ? _e : 0;
-  return daysMs + hoursMs + minsMs + secsMs + msMs;
-}
-function durationOrMsToMs(duration) {
-  return typeof duration === "number" ? duration : durationToMs(duration);
-}
-
-// src/kvStore.ts
-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) || !("storedMs" in obj) || typeof obj.storedMs !== "number" || obj.value === void 0 || !("expiryMs" in obj) || typeof obj.expiryMs !== "number" || Date.now() >= obj.expiryMs) {
-    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, expiryDeltaMs = this.defaultExpiryDeltaMs) {
-      const nowMs = Date.now();
-      const obj = {
-        key,
-        value,
-        storedMs: nowMs,
-        expiryMs: nowMs + durationOrMsToMs(expiryDeltaMs)
-      };
-      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);
-            }
-          }
-        }
-      );
-    });
-  }
-  getStoredObject(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;
-      } catch (e) {
-        console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);
-        yield this.delete(key);
-        this.gc();
-        return void 0;
-      }
-    });
-  }
-  get(key) {
-    return __async(this, null, function* () {
-      const obj = yield this.getStoredObject(key);
-      return obj == null ? void 0 : obj.value;
-    });
-  }
-  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.expiryMs);
-              } 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, expiryMs) => {
-        map.set(key, { value, expiryMs });
-      });
-      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, expiryMs) => __async(this, null, function* () {
-          if (value === void 0 || Date.now() >= expiryMs) {
-            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
-);
-var KvStoreItem = class {
-  constructor(key, defaultExpiryDeltaMs, store = kvStore) {
-    this.key = key;
-    this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
-    this.store = store;
-  }
-  /**
-   * Example usage:
-   *
-   *   const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();
-   */
-  getStoredObject() {
-    return __async(this, null, function* () {
-      return yield this.store.getStoredObject(this.key);
-    });
-  }
-  get() {
-    return __async(this, null, function* () {
-      return yield this.store.get(this.key);
-    });
-  }
-  set(_0) {
-    return __async(this, arguments, function* (value, expiryDeltaMs = this.defaultExpiryDeltaMs) {
-      yield this.store.set(this.key, value, expiryDeltaMs);
-    });
-  }
-  delete() {
-    return __async(this, null, function* () {
-      yield this.store.delete(this.key);
-    });
-  }
-};
-function kvStoreItem(key, defaultExpiration) {
-  const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);
-  return new KvStoreItem(key, defaultExpiryDeltaMs);
-}
-// 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,
-  kvStoreItem
-});
-//# sourceMappingURL=kvStore.js.map

package/kvStore.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/kvStore.ts","../src/timeConstants.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 * Note that month and year do not have fixed durations, and hence are excluded\n * from this file.\n */\n\nexport const MS_PER_SECOND = 1000;\nexport const MS_PER_MINUTE = 60_000;\nexport const MS_PER_HOUR = 3_600_000;\nexport const MS_PER_DAY = 86_400_000;\nexport const MS_PER_WEEK = 604_800_000;\n\nexport const SECONDS_PER_MINUTE = 60;\nexport const SECONDS_PER_HOUR = 3_600;\nexport const SECONDS_PER_DAY = 86_400;\nexport const SECONDS_PER_WEEK = 604_800;\n\nexport const MINUTES_PER_HOUR = 60;\nexport const MINUTES_PER_DAY = 1440;\nexport const MINUTES_PER_WEEK = 10_080;\n\nexport const HOURS_PER_DAY = 24;\nexport const HOURS_PER_WEEK = 168;\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  MS_PER_SECOND,\n  SECONDS_PER_MINUTE,\n  MINUTES_PER_HOUR,\n  HOURS_PER_DAY,\n  MS_PER_DAY,\n  MS_PER_MINUTE,\n  MS_PER_HOUR,\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,gBAAgB;AACtB,IAAM,gBAAgB;AACtB,IAAM,cAAc;AACpB,IAAM,aAAa;;;ACkLnB,SAAS,aAAa,UAA4B;AA1LzD;AA2LE,QAAM,WAAU,cAAS,SAAT,YAAiB,KAAK;AACtC,QAAM,YAAW,cAAS,UAAT,YAAkB,KAAK;AACxC,QAAM,WAAU,cAAS,YAAT,YAAoB,KAAK;AACzC,QAAM,WAAU,cAAS,YAAT,YAAoB,KAAK;AACzC,QAAM,QAAO,cAAS,iBAAT,YAAyB;AAEtC,SAAO,SAAS,UAAU,SAAS,SAAS;AAC9C;AAKO,SAAS,iBAAiB,UAAqC;AACpE,SAAO,OAAO,aAAa,WAAW,WAAW,aAAa,QAAQ;AACxE;;;AFzLA,IAAM,kBAAkB;AAGxB,IAAM,qBAAqB;AAG3B,IAAM,aAAa;AAGZ,IAAM,iBAAiB;AAGvB,IAAM,0BAA0B,iBAAiB;AAGjD,IAAM,iBAAiB;AAa9B,SAAS,qBACP,KAC6B;AAC7B,MACE,CAAC,OACD,OAAO,QAAQ,YACf,EAAE,SAAS,QACX,OAAO,IAAI,QAAQ,YACnB,EAAE,WAAW,QACb,EAAE,cAAc,QAChB,OAAO,IAAI,aAAa,YACxB,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,gBAAmC,KAAK,sBAC5B;AACZ,YAAM,QAAQ,KAAK,IAAI;AACvB,YAAM,MAAuB;AAAA,QAC3B;AAAA,QACA;AAAA,QACA,UAAU;AAAA,QACV,UAAU,QAAQ,iBAAiB,aAAa;AAAA,MAClD;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,gBACX,KACsC;AAAA;AACtC,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;AAAA,MACT,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,IAAO,KAAqC;AAAA;AACvD,YAAM,MAAM,MAAM,KAAK,gBAAmB,GAAG;AAE7C,aAAO,2BAAK;AAAA,IACd;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;AAKA,IAAM,cAAN,MAAqB;AAAA,EACZ,YACW,KACA,sBACA,QAAQ,SACxB;AAHgB;AACA;AACA;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOU,kBAAwD;AAAA;AACnE,aAAO,MAAM,KAAK,MAAM,gBAAgB,KAAK,GAAG;AAAA,IAClD;AAAA;AAAA,EAEa,MAA8B;AAAA;AACzC,aAAO,MAAM,KAAK,MAAM,IAAI,KAAK,GAAG;AAAA,IACtC;AAAA;AAAA,EAEa,IACX,IAEe;AAAA,+CAFf,OACA,gBAAwB,KAAK,sBACd;AACf,YAAM,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,aAAa;AAAA,IACrD;AAAA;AAAA,EAEa,SAAwB;AAAA;AACnC,YAAM,KAAK,MAAM,OAAO,KAAK,GAAG;AAAA,IAClC;AAAA;AACF;AAKO,SAAS,YACd,KACA,mBACgB;AAChB,QAAM,uBAAuB,iBAAiB,iBAAiB;AAE/D,SAAO,IAAI,YAAe,KAAK,oBAAoB;AACrD;","names":[]}

package/localStorageCache.d.ts

@@ -1,55 +0,0 @@
-import { Duration } from "./duration";
-export type StoredItem<T> = {
-    value: T;
-    storedMs: number;
-    expiryMs: number;
-};
-/**
- * Simple local storage cache with support for auto-expiration.
- * Note that this works in the browser context only because nodejs does not
- * have local storage.
- *
- * Create a cache item accessor object with auto-expiration. The value will
- * always be stored as a string by applying JSON.stringify(), and will be
- * returned in the same object type by applying JSON.parse().
- *
- * In order to provide proper type-checking, please always specify the T
- * type parameter. E.g. const item = storeItem<string>("name", 10_000);
- *
- * @param key The store key in local storage.
- * @param expires Either a number in milliseconds, or a Duration object
- * @param logError Log an error if we found an invalid object in the store.
- *   The invalid object is usually a string that cannot be parsed as JSON.
- * @param defaultValue Specify a default value to use for the object. Defaults
- *   to undefined.
- */
-export declare function storeItem<T>(key: string, expires: number | Duration, logError?: boolean, defaultValue?: T): CacheItem<T>;
-declare class CacheItem<T> {
-    readonly key: string;
-    readonly expireDeltaMs: number;
-    readonly logError: boolean;
-    readonly defaultValue: T | undefined;
-    /**
-     * Create a cache item accessor object with auto-expiration.
-     */
-    constructor(key: string, expireDeltaMs: number, logError: boolean, defaultValue: T | undefined);
-    /**
-     * Set the value of this item with auto-expiration.
-     */
-    set(value: T, expiryDelta?: number | Duration): void;
-    /**
-     * Example usage:
-     *
-     *   const { value, storedMs, expiryMs } = await myItem.getStoredItem();
-     */
-    getStoredItem(): StoredItem<T> | undefined;
-    /**
-     * Get the value of this item, or undefined if value is not set or expired.
-     */
-    get(): T | undefined;
-    /**
-     * Remove the value of this item.
-     */
-    remove(): void;
-}
-export {};

package/localStorageCache.js

@@ -1,121 +0,0 @@
-"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/localStorageCache.ts
-var localStorageCache_exports = {};
-__export(localStorageCache_exports, {
-  storeItem: () => storeItem
-});
-module.exports = __toCommonJS(localStorageCache_exports);
-
-// src/timeConstants.ts
-var MS_PER_SECOND = 1e3;
-var MS_PER_MINUTE = 6e4;
-var MS_PER_HOUR = 36e5;
-var MS_PER_DAY = 864e5;
-
-// src/duration.ts
-function durationToMs(duration) {
-  var _a, _b, _c, _d, _e;
-  const daysMs = ((_a = duration.days) != null ? _a : 0) * MS_PER_DAY;
-  const hoursMs = ((_b = duration.hours) != null ? _b : 0) * MS_PER_HOUR;
-  const minsMs = ((_c = duration.minutes) != null ? _c : 0) * MS_PER_MINUTE;
-  const secsMs = ((_d = duration.seconds) != null ? _d : 0) * MS_PER_SECOND;
-  const msMs = (_e = duration.milliseconds) != null ? _e : 0;
-  return daysMs + hoursMs + minsMs + secsMs + msMs;
-}
-function durationOrMsToMs(duration) {
-  return typeof duration === "number" ? duration : durationToMs(duration);
-}
-
-// src/localStorageCache.ts
-function storeItem(key, expires, logError = true, defaultValue) {
-  const expireDeltaMs = durationOrMsToMs(expires);
-  return new CacheItem(key, expireDeltaMs, logError, defaultValue);
-}
-var CacheItem = class {
-  /**
-   * Create a cache item accessor object with auto-expiration.
-   */
-  constructor(key, expireDeltaMs, logError, defaultValue) {
-    this.key = key;
-    this.expireDeltaMs = expireDeltaMs;
-    this.logError = logError;
-    this.defaultValue = defaultValue;
-  }
-  /**
-   * Set the value of this item with auto-expiration.
-   */
-  set(value, expiryDelta = this.expireDeltaMs) {
-    const nowMs = Date.now();
-    const toStore = {
-      value,
-      storedMs: nowMs,
-      expiryMs: nowMs + durationOrMsToMs(expiryDelta)
-    };
-    const valueStr = JSON.stringify(toStore);
-    globalThis.localStorage.setItem(this.key, valueStr);
-  }
-  /**
-   * Example usage:
-   *
-   *   const { value, storedMs, expiryMs } = await myItem.getStoredItem();
-   */
-  getStoredItem() {
-    const jsonStr = globalThis.localStorage.getItem(this.key);
-    if (!jsonStr) {
-      return void 0;
-    }
-    try {
-      const obj = JSON.parse(jsonStr);
-      if (!obj || typeof obj !== "object" || !("value" in obj) || !("storedMs" in obj) || typeof obj.storedMs !== "number" || !("expiryMs" in obj) || typeof obj.expiryMs !== "number" || Date.now() >= obj.expiryMs) {
-        this.remove();
-        return void 0;
-      }
-      return obj;
-    } catch (e) {
-      if (this.logError) {
-        console.error(
-          `Found invalid storage value: ${this.key}=${jsonStr}:`,
-          e
-        );
-      }
-      this.remove();
-      return void 0;
-    }
-  }
-  /**
-   * Get the value of this item, or undefined if value is not set or expired.
-   */
-  get() {
-    const stored = this.getStoredItem();
-    return stored !== void 0 ? stored.value : this.defaultValue;
-  }
-  /**
-   * Remove the value of this item.
-   */
-  remove() {
-    globalThis.localStorage.removeItem(this.key);
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  storeItem
-});
-//# sourceMappingURL=localStorageCache.js.map

package/localStorageCache.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/localStorageCache.ts","../src/timeConstants.ts","../src/duration.ts"],"sourcesContent":["import { Duration, durationOrMsToMs } from \"./duration\";\n\nexport type StoredItem<T> = { value: T; storedMs: number; expiryMs: number };\n\n/**\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 *\n * Create a cache item accessor object with auto-expiration. The value will\n * always be stored as a string by applying JSON.stringify(), and will be\n * returned in the same object type by applying JSON.parse().\n *\n * In order to provide proper type-checking, please always specify the T\n * type parameter. E.g. const item = storeItem<string>(\"name\", 10_000);\n *\n * @param key The store key in local storage.\n * @param expires Either a number in milliseconds, or a Duration object\n * @param logError Log an error if we found an invalid object in the store.\n *   The invalid object is usually a string that cannot be parsed as JSON.\n * @param defaultValue Specify a default value to use for the object. Defaults\n *   to undefined.\n */\nexport function storeItem<T>(\n  key: string,\n  expires: number | Duration,\n  logError = true,\n  defaultValue?: T,\n) {\n  const expireDeltaMs = durationOrMsToMs(expires);\n\n  return new CacheItem<T>(key, expireDeltaMs, logError, defaultValue);\n}\n\nclass CacheItem<T> {\n  /**\n   * Create a cache item accessor object with auto-expiration.\n   */\n  public constructor(\n    public readonly key: string,\n    public readonly expireDeltaMs: number,\n    public readonly logError: boolean,\n    public readonly defaultValue: T | undefined,\n  ) {}\n\n  /**\n   * Set the value of this item with auto-expiration.\n   */\n  public set(\n    value: T,\n    expiryDelta: number | Duration = this.expireDeltaMs,\n  ): void {\n    const nowMs = Date.now();\n    const toStore: StoredItem<T> = {\n      value,\n      storedMs: nowMs,\n      expiryMs: nowMs + durationOrMsToMs(expiryDelta),\n    };\n    const valueStr = JSON.stringify(toStore);\n\n    globalThis.localStorage.setItem(this.key, valueStr);\n  }\n\n  /**\n   * Example usage:\n   *\n   *   const { value, storedMs, expiryMs } = await myItem.getStoredItem();\n   */\n  public getStoredItem(): StoredItem<T> | undefined {\n    const jsonStr = globalThis.localStorage.getItem(this.key);\n\n    if (!jsonStr) {\n      return undefined;\n    }\n\n    try {\n      const obj: StoredItem<T> | undefined = JSON.parse(jsonStr);\n\n      if (\n        !obj ||\n        typeof obj !== \"object\" ||\n        !(\"value\" in obj) ||\n        !(\"storedMs\" in obj) ||\n        typeof obj.storedMs !== \"number\" ||\n        !(\"expiryMs\" in obj) ||\n        typeof obj.expiryMs !== \"number\" ||\n        Date.now() >= obj.expiryMs\n      ) {\n        this.remove();\n        return undefined;\n      }\n\n      return obj;\n    } catch (e) {\n      if (this.logError) {\n        console.error(\n          `Found invalid storage value: ${this.key}=${jsonStr}:`,\n          e,\n        );\n      }\n      this.remove();\n      return undefined;\n    }\n  }\n\n  /**\n   * Get the value of this item, or undefined if value is not set or expired.\n   */\n  public get(): T | undefined {\n    const stored = this.getStoredItem();\n\n    return stored !== undefined ? stored.value : this.defaultValue;\n  }\n\n  /**\n   * Remove the value of this item.\n   */\n  public remove(): void {\n    globalThis.localStorage.removeItem(this.key);\n  }\n}\n","/**\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file.\n */\n\nexport const MS_PER_SECOND = 1000;\nexport const MS_PER_MINUTE = 60_000;\nexport const MS_PER_HOUR = 3_600_000;\nexport const MS_PER_DAY = 86_400_000;\nexport const MS_PER_WEEK = 604_800_000;\n\nexport const SECONDS_PER_MINUTE = 60;\nexport const SECONDS_PER_HOUR = 3_600;\nexport const SECONDS_PER_DAY = 86_400;\nexport const SECONDS_PER_WEEK = 604_800;\n\nexport const MINUTES_PER_HOUR = 60;\nexport const MINUTES_PER_DAY = 1440;\nexport const MINUTES_PER_WEEK = 10_080;\n\nexport const HOURS_PER_DAY = 24;\nexport const HOURS_PER_WEEK = 168;\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  MS_PER_SECOND,\n  SECONDS_PER_MINUTE,\n  MINUTES_PER_HOUR,\n  HOURS_PER_DAY,\n  MS_PER_DAY,\n  MS_PER_MINUTE,\n  MS_PER_HOUR,\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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,gBAAgB;AACtB,IAAM,gBAAgB;AACtB,IAAM,cAAc;AACpB,IAAM,aAAa;;;ACkLnB,SAAS,aAAa,UAA4B;AA1LzD;AA2LE,QAAM,WAAU,cAAS,SAAT,YAAiB,KAAK;AACtC,QAAM,YAAW,cAAS,UAAT,YAAkB,KAAK;AACxC,QAAM,WAAU,cAAS,YAAT,YAAoB,KAAK;AACzC,QAAM,WAAU,cAAS,YAAT,YAAoB,KAAK;AACzC,QAAM,QAAO,cAAS,iBAAT,YAAyB;AAEtC,SAAO,SAAS,UAAU,SAAS,SAAS;AAC9C;AAKO,SAAS,iBAAiB,UAAqC;AACpE,SAAO,OAAO,aAAa,WAAW,WAAW,aAAa,QAAQ;AACxE;;;AFlLO,SAAS,UACd,KACA,SACA,WAAW,MACX,cACA;AACA,QAAM,gBAAgB,iBAAiB,OAAO;AAE9C,SAAO,IAAI,UAAa,KAAK,eAAe,UAAU,YAAY;AACpE;AAEA,IAAM,YAAN,MAAmB;AAAA;AAAA;AAAA;AAAA,EAIV,YACW,KACA,eACA,UACA,cAChB;AAJgB;AACA;AACA;AACA;AAAA,EACf;AAAA;AAAA;AAAA;AAAA,EAKI,IACL,OACA,cAAiC,KAAK,eAChC;AACN,UAAM,QAAQ,KAAK,IAAI;AACvB,UAAM,UAAyB;AAAA,MAC7B;AAAA,MACA,UAAU;AAAA,MACV,UAAU,QAAQ,iBAAiB,WAAW;AAAA,IAChD;AACA,UAAM,WAAW,KAAK,UAAU,OAAO;AAEvC,eAAW,aAAa,QAAQ,KAAK,KAAK,QAAQ;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,gBAA2C;AAChD,UAAM,UAAU,WAAW,aAAa,QAAQ,KAAK,GAAG;AAExD,QAAI,CAAC,SAAS;AACZ,aAAO;AAAA,IACT;AAEA,QAAI;AACF,YAAM,MAAiC,KAAK,MAAM,OAAO;AAEzD,UACE,CAAC,OACD,OAAO,QAAQ,YACf,EAAE,WAAW,QACb,EAAE,cAAc,QAChB,OAAO,IAAI,aAAa,YACxB,EAAE,cAAc,QAChB,OAAO,IAAI,aAAa,YACxB,KAAK,IAAI,KAAK,IAAI,UAClB;AACA,aAAK,OAAO;AACZ,eAAO;AAAA,MACT;AAEA,aAAO;AAAA,IACT,SAAS,GAAG;AACV,UAAI,KAAK,UAAU;AACjB,gBAAQ;AAAA,UACN,gCAAgC,KAAK,GAAG,IAAI,OAAO;AAAA,UACnD;AAAA,QACF;AAAA,MACF;AACA,WAAK,OAAO;AACZ,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,MAAqB;AAC1B,UAAM,SAAS,KAAK,cAAc;AAElC,WAAO,WAAW,SAAY,OAAO,QAAQ,KAAK;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAKO,SAAe;AACpB,eAAW,aAAa,WAAW,KAAK,GAAG;AAAA,EAC7C;AACF;","names":[]}