@choksheak/ts-utils 0.3.0 → 0.3.1

package/kvStore.min.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/duration.ts","../src/kvStore.ts"],"sourcesContent":["/**\n * Bunch of miscellaneous constants and utility functions related to handling\n * date and time durations.\n *\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file. Weeks have fixed durations, but are excluded because we\n * use days as the max duration supported.\n */\n\nimport {\n  HOURS_PER_DAY,\n  MINUTES_PER_HOUR,\n  MS_PER_DAY,\n  MS_PER_HOUR,\n  MS_PER_MINUTE,\n  MS_PER_SECOND,\n  SECONDS_PER_MINUTE,\n} from \"./timeConstants\";\n\nexport type Duration = {\n  days?: number;\n  hours?: number;\n  minutes?: number;\n  seconds?: number;\n  milliseconds?: number;\n};\n\n/**\n * One of: days, hours, minutes, seconds, milliseconds\n */\nexport type DurationType = keyof Duration;\n\n/**\n * Order in which the duration type appears in the duration string.\n */\nexport const DURATION_TYPE_SEQUENCE: DurationType[] = [\n  \"days\",\n  \"hours\",\n  \"minutes\",\n  \"seconds\",\n  \"milliseconds\",\n];\n\n/**\n * Follows the same format as Intl.DurationFormat.prototype.format().\n *\n * Short: 1 yr, 2 mths, 3 wks, 3 days, 4 hr, 5 min, 6 sec, 7 ms, 8 μs, 9 ns\n * Long: 1 year, 2 months, 3 weeks, 3 days, 4 hours, 5 minutes, 6 seconds,\n *       7 milliseconds, 8 microseconds, 9 nanoseconds\n * Narrow: 1y 2mo 3w 3d 4h 5m 6s 7ms 8μs 9ns\n */\nexport type DurationStyle = \"short\" | \"long\" | \"narrow\";\n\nexport type DurationSuffixMap = {\n  short: string;\n  shorts: string;\n  long: string;\n  longs: string;\n  narrow: string;\n};\n\nexport type DurationSuffixType = keyof DurationSuffixMap;\n\nexport const DURATION_STYLE_SUFFIX_MAP: Record<\n  DurationType,\n  DurationSuffixMap\n> = {\n  days: {\n    short: \"day\",\n    shorts: \"days\",\n    long: \"day\",\n    longs: \"days\",\n    narrow: \"d\",\n  },\n  hours: {\n    short: \"hr\",\n    shorts: \"hrs\",\n    long: \"hour\",\n    longs: \"hours\",\n    narrow: \"h\",\n  },\n  minutes: {\n    short: \"min\",\n    shorts: \"mins\",\n    long: \"minute\",\n    longs: \"minutes\",\n    narrow: \"m\",\n  },\n  seconds: {\n    short: \"sec\",\n    shorts: \"secs\",\n    long: \"second\",\n    longs: \"seconds\",\n    narrow: \"s\",\n  },\n  milliseconds: {\n    short: \"ms\",\n    shorts: \"ms\",\n    long: \"millisecond\",\n    longs: \"milliseconds\",\n    narrow: \"ms\",\n  },\n};\n\nfunction getDurationStyleForPlural(style: DurationStyle): DurationSuffixType {\n  return style == \"short\" ? \"shorts\" : style === \"long\" ? \"longs\" : style;\n}\n\nfunction getValueAndUnitSeparator(style: DurationStyle): string {\n  return style === \"narrow\" ? \"\" : \" \";\n}\n\nfunction getDurationTypeSeparator(style: DurationStyle): string {\n  return style === \"narrow\" ? \" \" : \", \";\n}\n\n/**\n * Convert a milliseconds duration into a Duration object. If the given ms is\n * zero, then return an object with a single field of zero with duration type\n * of durationTypeForZero.\n *\n * @param durationTypeForZero Defaults to 'milliseconds'\n */\nexport function msToDuration(\n  ms: number,\n  durationTypeForZero?: DurationType,\n): Duration {\n  if (ms === 0) {\n    durationTypeForZero = durationTypeForZero ?? \"milliseconds\";\n    return { [durationTypeForZero]: 0 };\n  }\n\n  const duration: Duration = {};\n\n  for (let i = 0; i < 1; i++) {\n    let seconds = Math.floor(ms / MS_PER_SECOND);\n    const millis = ms - seconds * MS_PER_SECOND;\n\n    if (millis > 0) {\n      duration[\"milliseconds\"] = millis;\n    }\n\n    if (seconds === 0) {\n      break;\n    }\n\n    let minutes = Math.floor(seconds / SECONDS_PER_MINUTE);\n    seconds -= minutes * SECONDS_PER_MINUTE;\n\n    if (seconds > 0) {\n      duration[\"seconds\"] = seconds;\n    }\n\n    if (minutes === 0) {\n      break;\n    }\n\n    let hours = Math.floor(minutes / MINUTES_PER_HOUR);\n    minutes -= hours * MINUTES_PER_HOUR;\n\n    if (minutes > 0) {\n      duration[\"minutes\"] = minutes;\n    }\n\n    if (hours === 0) {\n      break;\n    }\n\n    const days = Math.floor(hours / HOURS_PER_DAY);\n    hours -= days * HOURS_PER_DAY;\n\n    if (hours > 0) {\n      duration[\"hours\"] = hours;\n    }\n\n    if (days > 0) {\n      duration[\"days\"] = days;\n    }\n  }\n\n  return duration;\n}\n\n/**\n * Returns the number of milliseconds for the given duration.\n */\nexport function durationToMs(duration: Duration): number {\n  const daysMs = (duration.days ?? 0) * MS_PER_DAY;\n  const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;\n  const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;\n  const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;\n  const msMs = duration.milliseconds ?? 0;\n\n  return daysMs + hoursMs + minsMs + secsMs + msMs;\n}\n\n/**\n * Convenience function to return a duration given an ms or Duration.\n */\nexport function durationOrMsToMs(duration: number | Duration): number {\n  return typeof duration === \"number\" ? duration : durationToMs(duration);\n}\n\n/**\n * Format a given Duration object into a string. If the object has no fields,\n * then returns an empty string.\n *\n * @param style Defaults to 'short'\n */\nexport function formatDuration(duration: Duration, style?: DurationStyle) {\n  style = style ?? \"short\";\n  const stylePlural = getDurationStyleForPlural(style);\n\n  const space = getValueAndUnitSeparator(style);\n\n  const a: string[] = [];\n\n  for (const unit of DURATION_TYPE_SEQUENCE) {\n    const value = duration[unit];\n    if (value === undefined) continue;\n\n    const suffixMap = DURATION_STYLE_SUFFIX_MAP[unit];\n    const suffix = value === 1 ? suffixMap[style] : suffixMap[stylePlural];\n    a.push(value + space + suffix);\n  }\n\n  const separator = getDurationTypeSeparator(style);\n  return a.join(separator);\n}\n\n/**\n * Convert a millisecond duration into a human-readable duration string.\n *\n * @param options.durationTypeForZero - Defaults to 'milliseconds'\n * @param options.style - Defaults to 'short'\n */\nexport function readableDuration(\n  ms: number,\n  options?: { durationTypeForZero?: DurationType; style?: DurationStyle },\n): string {\n  const duration = msToDuration(ms, options?.durationTypeForZero);\n\n  return formatDuration(duration, options?.style);\n}\n\n/** A shortened duration string useful for logging timings. */\nexport function elapsed(ms: number): string {\n  // Use long format for 1 minute or over.\n  if (ms > MS_PER_MINUTE) {\n    return readableDuration(ms);\n  }\n\n  // Use seconds format for over 100ms.\n  if (ms > 100) {\n    return `${(ms / 1000).toFixed(3)}s`;\n  }\n\n  // Use milliseconds format.\n  return ms + \"ms\";\n}\n","/**\n * Indexed DB key-value store with support for auto-expirations.\n *\n * Why use this?\n * 1. No need to worry about running out of storage.\n * 2. Extremely simple interface to use indexed DBs.\n * 3. Auto-expirations frees you from worrying about data clean-up.\n * 4. Any serializable data type can be stored (except undefined).\n *\n * How to use?\n * Just use the `kvStore` global constant like the local storage.\n */\n\nimport { Duration, durationOrMsToMs } from \"./duration\";\n\n// Updating the DB name will cause all old entries to be gone.\nconst DEFAULT_DB_NAME = \"KVStore\";\n\n// Updating the version will cause all old entries to be gone.\nconst DEFAULT_DB_VERSION = 1;\n\n// Use a constant store name to keep things simple.\nconst STORE_NAME = \"kvStore\";\n\n/** One day in milliseconds. */\nexport const MILLIS_PER_DAY = 86_400_000;\n\n/** 30 days in ms. */\nexport const DEFAULT_EXPIRY_DELTA_MS = MILLIS_PER_DAY * 30;\n\n/** Do GC once per day. */\nexport const GC_INTERVAL_MS = MILLIS_PER_DAY;\n\ntype StoredObject<T> = {\n  key: string;\n  value: T;\n  storedMs: number;\n  expiryMs: number;\n};\n\n/**\n * Parse a stored value string. Returns undefined if invalid or expired.\n * Throws an error if the string cannot be parsed as JSON.\n */\nfunction validateStoredObject<T>(\n  obj: StoredObject<T>,\n): StoredObject<T> | undefined {\n  if (\n    !obj ||\n    typeof obj !== \"object\" ||\n    !(\"key\" in obj) ||\n    typeof obj.key !== \"string\" ||\n    !(\"value\" in obj) ||\n    !(\"storedMs\" in obj) ||\n    typeof obj.storedMs !== \"number\" ||\n    obj.value === undefined ||\n    !(\"expiryMs\" in obj) ||\n    typeof obj.expiryMs !== \"number\" ||\n    Date.now() >= obj.expiryMs\n  ) {\n    return undefined;\n  }\n\n  return obj;\n}\n\n/** Add an `onerror` handler to the request. */\nfunction withOnError<T extends IDBRequest | IDBTransaction>(\n  request: T,\n  reject: (reason?: unknown) => void,\n): T {\n  request.onerror = (event) => {\n    reject(event);\n  };\n\n  return request;\n}\n\nexport class KVStoreField<T> {\n  public constructor(\n    public readonly store: KVStore,\n    public readonly key: string,\n  ) {}\n\n  public get(): Promise<T | undefined> {\n    return this.store.get(this.key);\n  }\n\n  public set(t: T): Promise<T> {\n    return this.store.set(this.key, t);\n  }\n\n  public delete(): Promise<void> {\n    return this.store.delete(this.key);\n  }\n}\n\n/**\n * You can create multiple KVStores if you want, but most likely you will only\n * need to use the default `kvStore` instance.\n */\nexport class KVStore {\n  // We'll init the DB only on first use.\n  private db: IDBDatabase | undefined;\n\n  // Local storage key name for the last GC completed timestamp.\n  public readonly gcMsStorageKey: string;\n\n  public constructor(\n    public readonly dbName: string,\n    public readonly dbVersion: number,\n    public readonly defaultExpiryDeltaMs: number,\n  ) {\n    this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;\n  }\n\n  private async getOrCreateDb() {\n    if (!this.db) {\n      this.db = await new Promise<IDBDatabase>((resolve, reject) => {\n        const request = withOnError(\n          globalThis.indexedDB.open(this.dbName, this.dbVersion),\n          reject,\n        );\n\n        request.onupgradeneeded = (event) => {\n          const db = (event.target as unknown as { result: IDBDatabase })\n            .result;\n\n          // Create the store on DB init.\n          const objectStore = db.createObjectStore(STORE_NAME, {\n            keyPath: \"key\",\n          });\n\n          objectStore.createIndex(\"key\", \"key\", {\n            unique: true,\n          });\n        };\n\n        request.onsuccess = (event) => {\n          const db = (event.target as unknown as { result: IDBDatabase })\n            .result;\n          resolve(db);\n        };\n      });\n    }\n\n    return this.db;\n  }\n\n  private async transact<T>(\n    mode: IDBTransactionMode,\n    callback: (\n      objectStore: IDBObjectStore,\n      resolve: (t: T) => void,\n      reject: (reason?: unknown) => void,\n    ) => void,\n  ): Promise<T> {\n    const db = await this.getOrCreateDb();\n\n    return await new Promise<T>((resolve, reject) => {\n      const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);\n\n      transaction.onabort = (event) => {\n        reject(event);\n      };\n\n      const objectStore = transaction.objectStore(STORE_NAME);\n\n      callback(objectStore, resolve, reject);\n    });\n  }\n\n  public async set<T>(\n    key: string,\n    value: T,\n    expiryDeltaMs: number | Duration = this.defaultExpiryDeltaMs,\n  ): Promise<T> {\n    const nowMs = Date.now();\n    const obj: StoredObject<T> = {\n      key,\n      value,\n      storedMs: nowMs,\n      expiryMs: nowMs + durationOrMsToMs(expiryDeltaMs),\n    };\n\n    return await this.transact<T>(\n      \"readwrite\",\n      (objectStore, resolve, reject) => {\n        const request = withOnError(objectStore.put(obj), reject);\n\n        request.onsuccess = () => {\n          resolve(value);\n\n          this.gc(); // check GC on every write\n        };\n      },\n    );\n  }\n\n  /** Delete one or multiple keys. */\n  public async delete(key: string | string[]): Promise<void> {\n    return await this.transact<void>(\n      \"readwrite\",\n      (objectStore, resolve, reject) => {\n        objectStore.transaction.oncomplete = () => {\n          resolve();\n        };\n\n        if (typeof key === \"string\") {\n          withOnError(objectStore.delete(key), reject);\n        } else {\n          for (const k of key) {\n            withOnError(objectStore.delete(k), reject);\n          }\n        }\n      },\n    );\n  }\n\n  public async getStoredObject<T>(\n    key: string,\n  ): Promise<StoredObject<T> | undefined> {\n    const stored = await this.transact<StoredObject<T> | undefined>(\n      \"readonly\",\n      (objectStore, resolve, reject) => {\n        const request = withOnError(objectStore.get(key), reject);\n\n        request.onsuccess = () => {\n          resolve(request.result);\n        };\n      },\n    );\n\n    if (!stored) {\n      return undefined;\n    }\n\n    try {\n      const obj = validateStoredObject(stored);\n      if (!obj) {\n        await this.delete(key);\n\n        this.gc(); // check GC on every read of an expired key\n\n        return undefined;\n      }\n\n      return obj;\n    } catch (e) {\n      console.error(`Invalid kv value: ${key}=${JSON.stringify(stored)}:`, e);\n      await this.delete(key);\n\n      this.gc(); // check GC on every read of an invalid key\n\n      return undefined;\n    }\n  }\n\n  public async get<T>(key: string): Promise<T | undefined> {\n    const obj = await this.getStoredObject<T>(key);\n\n    return obj?.value;\n  }\n\n  public async forEach(\n    callback: (\n      key: string,\n      value: unknown,\n      expiryMs: number,\n    ) => void | Promise<void>,\n  ): Promise<void> {\n    await this.transact<void>(\"readonly\", (objectStore, resolve, reject) => {\n      const request = withOnError(objectStore.openCursor(), reject);\n\n      request.onsuccess = async (event) => {\n        const cursor = (\n          event.target as unknown as { result: IDBCursorWithValue }\n        ).result;\n\n        if (cursor) {\n          if (cursor.key) {\n            const obj = validateStoredObject(cursor.value);\n            if (obj) {\n              await callback(String(cursor.key), obj.value, obj.expiryMs);\n            } else {\n              await callback(String(cursor.key), undefined, 0);\n            }\n          }\n          cursor.continue();\n        } else {\n          resolve();\n        }\n      };\n    });\n  }\n\n  /** Cannot be a getter because this needs to be async. */\n  public async size() {\n    let count = 0;\n    await this.forEach(() => {\n      count++;\n    });\n    return count;\n  }\n\n  public async clear() {\n    const keys: string[] = [];\n    await this.forEach((key) => {\n      keys.push(key);\n    });\n\n    await this.delete(keys);\n  }\n\n  /** Mainly for debugging dumps. */\n  public async asMap(): Promise<Map<string, unknown>> {\n    const map = new Map<string, unknown>();\n    await this.forEach((key, value, expiryMs) => {\n      map.set(key, { value, expiryMs });\n    });\n    return map;\n  }\n\n  public get lastGcMs(): number {\n    const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);\n    if (!lastGcMsStr) return 0;\n\n    const ms = Number(lastGcMsStr);\n    return isNaN(ms) ? 0 : ms;\n  }\n\n  public set lastGcMs(ms: number) {\n    globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));\n  }\n\n  /** Perform garbage-collection if due. */\n  public async gc() {\n    const lastGcMs = this.lastGcMs;\n\n    // Set initial timestamp - no need GC now.\n    if (!lastGcMs) {\n      this.lastGcMs = Date.now();\n      return;\n    }\n\n    if (Date.now() < lastGcMs + GC_INTERVAL_MS) {\n      return; // not due for next GC yet\n    }\n\n    // GC is due now, so run it.\n    await this.gcNow();\n  }\n\n  /** Perform garbage-collection immediately without checking. */\n  public async gcNow() {\n    console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);\n\n    // Prevent concurrent GC runs.\n    this.lastGcMs = Date.now();\n\n    const keysToDelete: string[] = [];\n    await this.forEach(\n      async (key: string, value: unknown, expiryMs: number) => {\n        if (value === undefined || Date.now() >= expiryMs) {\n          keysToDelete.push(key);\n        }\n      },\n    );\n\n    if (keysToDelete.length) {\n      await this.delete(keysToDelete);\n    }\n\n    console.log(\n      `Finished kvStore GC on ${this.dbName} v${this.dbVersion} ` +\n        `- deleted ${keysToDelete.length} keys`,\n    );\n\n    // Mark the end time as last GC time.\n    this.lastGcMs = Date.now();\n  }\n\n  /** Get an independent store item with a locked key and value type. */\n  public field<T>(key: string) {\n    return new KVStoreField<T>(this, key);\n  }\n}\n\n/**\n * Default KV store ready for immediate use. You can create new instances if\n * you want, but most likely you will only need one store instance.\n */\nexport const kvStore = new KVStore(\n  DEFAULT_DB_NAME,\n  DEFAULT_DB_VERSION,\n  DEFAULT_EXPIRY_DELTA_MS,\n);\n\n/**\n * Class to represent one key in the store with a default expiration.\n */\nclass KvStoreItem<T> {\n  public constructor(\n    public readonly key: string,\n    public readonly defaultExpiryDeltaMs: number,\n    public readonly store = kvStore,\n  ) {}\n\n  /**\n   * Example usage:\n   *\n   *   const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();\n   */\n  public async getStoredObject(): Promise<StoredObject<T> | undefined> {\n    return await this.store.getStoredObject(this.key);\n  }\n\n  public async get(): Promise<T | undefined> {\n    return await this.store.get(this.key);\n  }\n\n  public async set(\n    value: T,\n    expiryDeltaMs: number = this.defaultExpiryDeltaMs,\n  ): Promise<void> {\n    await this.store.set(this.key, value, expiryDeltaMs);\n  }\n\n  public async delete(): Promise<void> {\n    await this.store.delete(this.key);\n  }\n}\n\n/**\n * Create a KV store item with a key and a default expiration.\n */\nexport function kvStoreItem<T>(\n  key: string,\n  defaultExpiration: number | Duration,\n): KvStoreItem<T> {\n  const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);\n\n  return new KvStoreItem<T>(key, defaultExpiryDeltaMs);\n}\n"],"mappings":"AA0LO,SAASA,EAAaC,EAA4B,CACvD,IAAMC,GAAUD,EAAS,MAAQ,GAAK,MAChCE,GAAWF,EAAS,OAAS,GAAK,KAClCG,GAAUH,EAAS,SAAW,GAAK,IACnCI,GAAUJ,EAAS,SAAW,GAAK,IACnCK,EAAOL,EAAS,cAAgB,EAEtC,OAAOC,EAASC,EAAUC,EAASC,EAASC,CAC9C,CAKO,SAASC,EAAiBN,EAAqC,CACpE,OAAO,OAAOA,GAAa,SAAWA,EAAWD,EAAaC,CAAQ,CACxE,CCzLA,IAAMO,EAAkB,UAGlBC,EAAqB,EAGrBC,EAAa,UAGNC,EAAiB,MAGjBC,EAA0BD,EAAiB,GAG3CE,EAAiBF,EAa9B,SAASG,EACPC,EAC6B,CAC7B,GACE,GAACA,GACD,OAAOA,GAAQ,UACf,EAAE,QAASA,IACX,OAAOA,EAAI,KAAQ,UACnB,EAAE,UAAWA,IACb,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxBA,EAAI,QAAU,QACd,EAAE,aAAcA,IAChB,OAAOA,EAAI,UAAa,UACxB,KAAK,IAAI,GAAKA,EAAI,UAKpB,OAAOA,CACT,CAGA,SAASC,EACPC,EACAC,EACG,CACH,OAAAD,EAAQ,QAAWE,GAAU,CAC3BD,EAAOC,CAAK,CACd,EAEOF,CACT,CAEO,IAAMG,EAAN,KAAsB,CACpB,YACWC,EACAC,EAChB,CAFgB,WAAAD,EACA,SAAAC,CACf,CAEI,KAA8B,CACnC,OAAO,KAAK,MAAM,IAAI,KAAK,GAAG,CAChC,CAEO,IAAI,EAAkB,CAC3B,OAAO,KAAK,MAAM,IAAI,KAAK,IAAK,CAAC,CACnC,CAEO,QAAwB,CAC7B,OAAO,KAAK,MAAM,OAAO,KAAK,GAAG,CACnC,CACF,EAMaC,EAAN,KAAc,CAOZ,YACWC,EACAC,EACAC,EAChB,CAHgB,YAAAF,EACA,eAAAC,EACA,0BAAAC,EAEhB,KAAK,eAAiB,sBAAsBF,CAAM,KAAKC,CAAS,IAAIf,CAAU,EAChF,CAXQ,GAGQ,eAUhB,MAAc,eAAgB,CAC5B,OAAK,KAAK,KACR,KAAK,GAAK,MAAM,IAAI,QAAqB,CAACiB,EAAST,IAAW,CAC5D,IAAMD,EAAUD,EACd,WAAW,UAAU,KAAK,KAAK,OAAQ,KAAK,SAAS,EACrDE,CACF,EAEAD,EAAQ,gBAAmBE,GAAU,CACvBA,EAAM,OACf,OAGoB,kBAAkBT,EAAY,CACnD,QAAS,KACX,CAAC,EAEW,YAAY,MAAO,MAAO,CACpC,OAAQ,EACV,CAAC,CACH,EAEAO,EAAQ,UAAaE,GAAU,CAC7B,IAAMS,EAAMT,EAAM,OACf,OACHQ,EAAQC,CAAE,CACZ,CACF,CAAC,GAGI,KAAK,EACd,CAEA,MAAc,SACZC,EACAC,EAKY,CACZ,IAAMF,EAAK,MAAM,KAAK,cAAc,EAEpC,OAAO,MAAM,IAAI,QAAW,CAACD,EAAST,IAAW,CAC/C,IAAMa,EAAcf,EAAYY,EAAG,YAAYlB,EAAYmB,CAAI,EAAGX,CAAM,EAExEa,EAAY,QAAWZ,GAAU,CAC/BD,EAAOC,CAAK,CACd,EAEA,IAAMa,EAAcD,EAAY,YAAYrB,CAAU,EAEtDoB,EAASE,EAAaL,EAAST,CAAM,CACvC,CAAC,CACH,CAEA,MAAa,IACXI,EACAW,EACAC,EAAmC,KAAK,qBAC5B,CACZ,IAAMC,EAAQ,KAAK,IAAI,EACjBpB,EAAuB,CAC3B,IAAAO,EACA,MAAAW,EACA,SAAUE,EACV,SAAUA,EAAQC,EAAiBF,CAAa,CAClD,EAEA,OAAO,MAAM,KAAK,SAChB,YACA,CAACF,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIjB,CAAG,EAAGG,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQM,CAAK,EAEb,KAAK,GAAG,CACV,CACF,CACF,CACF,CAGA,MAAa,OAAOX,EAAuC,CACzD,OAAO,MAAM,KAAK,SAChB,YACA,CAACU,EAAaL,EAAST,IAAW,CAKhC,GAJAc,EAAY,YAAY,WAAa,IAAM,CACzCL,EAAQ,CACV,EAEI,OAAOL,GAAQ,SACjBN,EAAYgB,EAAY,OAAOV,CAAG,EAAGJ,CAAM,MAE3C,SAAWmB,KAAKf,EACdN,EAAYgB,EAAY,OAAOK,CAAC,EAAGnB,CAAM,CAG/C,CACF,CACF,CAEA,MAAa,gBACXI,EACsC,CACtC,IAAMgB,EAAS,MAAM,KAAK,SACxB,WACA,CAACN,EAAaL,EAAST,IAAW,CAChC,IAAMD,EAAUD,EAAYgB,EAAY,IAAIV,CAAG,EAAGJ,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBU,EAAQV,EAAQ,MAAM,CACxB,CACF,CACF,EAEA,GAAKqB,EAIL,GAAI,CACF,IAAMvB,EAAMD,EAAqBwB,CAAM,EACvC,GAAI,CAACvB,EAAK,CACR,MAAM,KAAK,OAAOO,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CAEA,OAAOP,CACT,OAASwB,EAAG,CACV,QAAQ,MAAM,qBAAqBjB,CAAG,IAAI,KAAK,UAAUgB,CAAM,CAAC,IAAKC,CAAC,EACtE,MAAM,KAAK,OAAOjB,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CACF,CAEA,MAAa,IAAOA,EAAqC,CAGvD,OAFY,MAAM,KAAK,gBAAmBA,CAAG,IAEjC,KACd,CAEA,MAAa,QACXQ,EAKe,CACf,MAAM,KAAK,SAAe,WAAY,CAACE,EAAaL,EAAST,IAAW,CACtE,IAAMD,EAAUD,EAAYgB,EAAY,WAAW,EAAGd,CAAM,EAE5DD,EAAQ,UAAY,MAAOE,GAAU,CACnC,IAAMqB,EACJrB,EAAM,OACN,OAEF,GAAIqB,EAAQ,CACV,GAAIA,EAAO,IAAK,CACd,IAAMzB,EAAMD,EAAqB0B,EAAO,KAAK,EACzCzB,EACF,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAGzB,EAAI,MAAOA,EAAI,QAAQ,EAE1D,MAAMe,EAAS,OAAOU,EAAO,GAAG,EAAG,OAAW,CAAC,CAEnD,CACAA,EAAO,SAAS,CAClB,MACEb,EAAQ,CAEZ,CACF,CAAC,CACH,CAGA,MAAa,MAAO,CAClB,IAAIc,EAAQ,EACZ,aAAM,KAAK,QAAQ,IAAM,CACvBA,GACF,CAAC,EACMA,CACT,CAEA,MAAa,OAAQ,CACnB,IAAMC,EAAiB,CAAC,EACxB,MAAM,KAAK,QAASpB,GAAQ,CAC1BoB,EAAK,KAAKpB,CAAG,CACf,CAAC,EAED,MAAM,KAAK,OAAOoB,CAAI,CACxB,CAGA,MAAa,OAAuC,CAClD,IAAMC,EAAM,IAAI,IAChB,aAAM,KAAK,QAAQ,CAACrB,EAAKW,EAAOW,IAAa,CAC3CD,EAAI,IAAIrB,EAAK,CAAE,MAAAW,EAAO,SAAAW,CAAS,CAAC,CAClC,CAAC,EACMD,CACT,CAEA,IAAW,UAAmB,CAC5B,IAAME,EAAc,WAAW,aAAa,QAAQ,KAAK,cAAc,EACvE,GAAI,CAACA,EAAa,MAAO,GAEzB,IAAMC,EAAK,OAAOD,CAAW,EAC7B,OAAO,MAAMC,CAAE,EAAI,EAAIA,CACzB,CAEA,IAAW,SAASA,EAAY,CAC9B,WAAW,aAAa,QAAQ,KAAK,eAAgB,OAAOA,CAAE,CAAC,CACjE,CAGA,MAAa,IAAK,CAChB,IAAMC,EAAW,KAAK,SAGtB,GAAI,CAACA,EAAU,CACb,KAAK,SAAW,KAAK,IAAI,EACzB,MACF,CAEI,KAAK,IAAI,EAAIA,EAAWlC,GAK5B,MAAM,KAAK,MAAM,CACnB,CAGA,MAAa,OAAQ,CACnB,QAAQ,IAAI,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,KAAK,EAGzE,KAAK,SAAW,KAAK,IAAI,EAEzB,IAAMmC,EAAyB,CAAC,EAChC,MAAM,KAAK,QACT,MAAO1B,EAAaW,EAAgBW,IAAqB,EACnDX,IAAU,QAAa,KAAK,IAAI,GAAKW,IACvCI,EAAa,KAAK1B,CAAG,CAEzB,CACF,EAEI0B,EAAa,QACf,MAAM,KAAK,OAAOA,CAAY,EAGhC,QAAQ,IACN,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,cACzCA,EAAa,MAAM,OACpC,EAGA,KAAK,SAAW,KAAK,IAAI,CAC3B,CAGO,MAAS1B,EAAa,CAC3B,OAAO,IAAIF,EAAgB,KAAME,CAAG,CACtC,CACF,EAMa2B,EAAU,IAAI1B,EACzBf,EACAC,EACAG,CACF,EAKMsC,EAAN,KAAqB,CACZ,YACW5B,EACAI,EACAL,EAAQ4B,EACxB,CAHgB,SAAA3B,EACA,0BAAAI,EACA,WAAAL,CACf,CAOH,MAAa,iBAAwD,CACnE,OAAO,MAAM,KAAK,MAAM,gBAAgB,KAAK,GAAG,CAClD,CAEA,MAAa,KAA8B,CACzC,OAAO,MAAM,KAAK,MAAM,IAAI,KAAK,GAAG,CACtC,CAEA,MAAa,IACXY,EACAC,EAAwB,KAAK,qBACd,CACf,MAAM,KAAK,MAAM,IAAI,KAAK,IAAKD,EAAOC,CAAa,CACrD,CAEA,MAAa,QAAwB,CACnC,MAAM,KAAK,MAAM,OAAO,KAAK,GAAG,CAClC,CACF,EAKO,SAASiB,EACd7B,EACA8B,EACgB,CAChB,IAAM1B,EAAuBU,EAAiBgB,CAAiB,EAE/D,OAAO,IAAIF,EAAe5B,EAAKI,CAAoB,CACrD","names":["durationToMs","duration","daysMs","hoursMs","minsMs","secsMs","msMs","durationOrMsToMs","DEFAULT_DB_NAME","DEFAULT_DB_VERSION","STORE_NAME","MILLIS_PER_DAY","DEFAULT_EXPIRY_DELTA_MS","GC_INTERVAL_MS","validateStoredObject","obj","withOnError","request","reject","event","KVStoreField","store","key","KVStore","dbName","dbVersion","defaultExpiryDeltaMs","resolve","db","mode","callback","transaction","objectStore","value","expiryDeltaMs","nowMs","durationOrMsToMs","k","stored","e","cursor","count","keys","map","expiryMs","lastGcMsStr","ms","lastGcMs","keysToDelete","kvStore","KvStoreItem","kvStoreItem","defaultExpiration"]}
+{"version":3,"sources":["../src/duration.ts","../src/kvStore.ts"],"sourcesContent":["/**\n * Bunch of miscellaneous constants and utility functions related to handling\n * date and time durations.\n *\n * Note that month and year do not have fixed durations, and hence are excluded\n * from this file. Weeks have fixed durations, but are excluded because we\n * use days as the max duration supported.\n */\n\nimport {\n  HOURS_PER_DAY,\n  MINUTES_PER_HOUR,\n  MS_PER_DAY,\n  MS_PER_HOUR,\n  MS_PER_MINUTE,\n  MS_PER_SECOND,\n  SECONDS_PER_MINUTE,\n} from \"./timeConstants\";\n\nexport type Duration = {\n  days?: number;\n  hours?: number;\n  minutes?: number;\n  seconds?: number;\n  milliseconds?: number;\n};\n\n/**\n * One of: days, hours, minutes, seconds, milliseconds\n */\nexport type DurationType = keyof Duration;\n\n/**\n * Order in which the duration type appears in the duration string.\n */\nexport const DURATION_TYPE_SEQUENCE: DurationType[] = [\n  \"days\",\n  \"hours\",\n  \"minutes\",\n  \"seconds\",\n  \"milliseconds\",\n];\n\n/**\n * Follows the same format as Intl.DurationFormat.prototype.format().\n *\n * Short: 1 yr, 2 mths, 3 wks, 3 days, 4 hr, 5 min, 6 sec, 7 ms, 8 μs, 9 ns\n * Long: 1 year, 2 months, 3 weeks, 3 days, 4 hours, 5 minutes, 6 seconds,\n *       7 milliseconds, 8 microseconds, 9 nanoseconds\n * Narrow: 1y 2mo 3w 3d 4h 5m 6s 7ms 8μs 9ns\n */\nexport type DurationStyle = \"short\" | \"long\" | \"narrow\";\n\nexport type DurationSuffixMap = {\n  short: string;\n  shorts: string;\n  long: string;\n  longs: string;\n  narrow: string;\n};\n\nexport type DurationSuffixType = keyof DurationSuffixMap;\n\nexport const DURATION_STYLE_SUFFIX_MAP: Record<\n  DurationType,\n  DurationSuffixMap\n> = {\n  days: {\n    short: \"day\",\n    shorts: \"days\",\n    long: \"day\",\n    longs: \"days\",\n    narrow: \"d\",\n  },\n  hours: {\n    short: \"hr\",\n    shorts: \"hrs\",\n    long: \"hour\",\n    longs: \"hours\",\n    narrow: \"h\",\n  },\n  minutes: {\n    short: \"min\",\n    shorts: \"mins\",\n    long: \"minute\",\n    longs: \"minutes\",\n    narrow: \"m\",\n  },\n  seconds: {\n    short: \"sec\",\n    shorts: \"secs\",\n    long: \"second\",\n    longs: \"seconds\",\n    narrow: \"s\",\n  },\n  milliseconds: {\n    short: \"ms\",\n    shorts: \"ms\",\n    long: \"millisecond\",\n    longs: \"milliseconds\",\n    narrow: \"ms\",\n  },\n};\n\nfunction getDurationStyleForPlural(style: DurationStyle): DurationSuffixType {\n  return style == \"short\" ? \"shorts\" : style === \"long\" ? \"longs\" : style;\n}\n\nfunction getValueAndUnitSeparator(style: DurationStyle): string {\n  return style === \"narrow\" ? \"\" : \" \";\n}\n\nfunction getDurationTypeSeparator(style: DurationStyle): string {\n  return style === \"narrow\" ? \" \" : \", \";\n}\n\n/**\n * Convert a milliseconds duration into a Duration object. If the given ms is\n * zero, then return an object with a single field of zero with duration type\n * of durationTypeForZero.\n *\n * @param durationTypeForZero Defaults to 'milliseconds'\n */\nexport function msToDuration(\n  ms: number,\n  durationTypeForZero?: DurationType,\n): Duration {\n  if (ms === 0) {\n    durationTypeForZero = durationTypeForZero ?? \"milliseconds\";\n    return { [durationTypeForZero]: 0 };\n  }\n\n  const duration: Duration = {};\n\n  for (let i = 0; i < 1; i++) {\n    let seconds = Math.floor(ms / MS_PER_SECOND);\n    const millis = ms - seconds * MS_PER_SECOND;\n\n    if (millis > 0) {\n      duration[\"milliseconds\"] = millis;\n    }\n\n    if (seconds === 0) {\n      break;\n    }\n\n    let minutes = Math.floor(seconds / SECONDS_PER_MINUTE);\n    seconds -= minutes * SECONDS_PER_MINUTE;\n\n    if (seconds > 0) {\n      duration[\"seconds\"] = seconds;\n    }\n\n    if (minutes === 0) {\n      break;\n    }\n\n    let hours = Math.floor(minutes / MINUTES_PER_HOUR);\n    minutes -= hours * MINUTES_PER_HOUR;\n\n    if (minutes > 0) {\n      duration[\"minutes\"] = minutes;\n    }\n\n    if (hours === 0) {\n      break;\n    }\n\n    const days = Math.floor(hours / HOURS_PER_DAY);\n    hours -= days * HOURS_PER_DAY;\n\n    if (hours > 0) {\n      duration[\"hours\"] = hours;\n    }\n\n    if (days > 0) {\n      duration[\"days\"] = days;\n    }\n  }\n\n  return duration;\n}\n\n/**\n * Returns the number of milliseconds for the given duration.\n */\nexport function durationToMs(duration: Duration): number {\n  const daysMs = (duration.days ?? 0) * MS_PER_DAY;\n  const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;\n  const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;\n  const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;\n  const msMs = duration.milliseconds ?? 0;\n\n  return daysMs + hoursMs + minsMs + secsMs + msMs;\n}\n\n/**\n * Convenience function to return a duration given an ms or Duration.\n */\nexport function durationOrMsToMs(duration: number | Duration): number {\n  return typeof duration === \"number\" ? duration : durationToMs(duration);\n}\n\n/**\n * Format a given Duration object into a string. If the object has no fields,\n * then returns an empty string.\n *\n * @param style Defaults to 'short'\n */\nexport function formatDuration(duration: Duration, style?: DurationStyle) {\n  style = style ?? \"short\";\n  const stylePlural = getDurationStyleForPlural(style);\n\n  const space = getValueAndUnitSeparator(style);\n\n  const a: string[] = [];\n\n  for (const unit of DURATION_TYPE_SEQUENCE) {\n    const value = duration[unit];\n    if (value === undefined) continue;\n\n    const suffixMap = DURATION_STYLE_SUFFIX_MAP[unit];\n    const suffix = value === 1 ? suffixMap[style] : suffixMap[stylePlural];\n    a.push(value + space + suffix);\n  }\n\n  const separator = getDurationTypeSeparator(style);\n  return a.join(separator);\n}\n\n/**\n * Convert a millisecond duration into a human-readable duration string.\n *\n * @param options.durationTypeForZero - Defaults to 'milliseconds'\n * @param options.style - Defaults to 'short'\n */\nexport function readableDuration(\n  ms: number,\n  options?: { durationTypeForZero?: DurationType; style?: DurationStyle },\n): string {\n  const duration = msToDuration(ms, options?.durationTypeForZero);\n\n  return formatDuration(duration, options?.style);\n}\n\n/** A shortened duration string useful for logging timings. */\nexport function elapsed(ms: number): string {\n  // Use long format for 1 minute or over.\n  if (ms > MS_PER_MINUTE) {\n    return readableDuration(ms);\n  }\n\n  // Use seconds format for over 100ms.\n  if (ms > 100) {\n    return `${(ms / 1000).toFixed(3)}s`;\n  }\n\n  // Use milliseconds format.\n  return ms + \"ms\";\n}\n","/**\n * Indexed DB key-value store with support for auto-expirations.\n *\n * Why use this?\n * 1. Extremely simple interface to use indexed DBs.\n * 2. Auto-expirations with GC frees you from worrying about data clean-up.\n * 3. 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, but with\n * async interface functions as required by indexed DB.\n *\n * Why not use the indexed DB directly?\n * It will require you to write a lot of code to reinvent the wheel.\n */\n\nimport { Duration, durationOrMsToMs } from \"./duration\";\nimport {\n  FullStorageAdapter,\n  StorageAdapter,\n  StoredObject,\n} from \"./storageAdapter\";\nimport { MS_PER_DAY } from \"./timeConstants\";\n\n/** Global defaults can be updated directly. */\nexport const KvStoreConfig = {\n  /**\n   * Name of the DB in the indexed DB.\n   * Updating the DB name will cause all old entries to be gone.\n   */\n  dbName: \"KVStore\",\n\n  /**\n   * Version of the DB schema. Most likely you will never want to change this.\n   * Updating the version will cause all old entries to be gone.\n   */\n  dbVersion: 1,\n\n  /**\n   * Name of the store within the indexed DB. Each DB can have multiple stores.\n   * In practice, it doesn't matter what you name this to be.\n   */\n  storeName: \"kvStore\",\n\n  /** 30 days in ms. */\n  expiryMs: MS_PER_DAY * 30,\n\n  /** Do GC once per day. */\n  gcIntervalMs: MS_PER_DAY,\n};\n\nexport type KvStoreConfig = typeof KvStoreConfig;\n\n/** Convenience function to update global defaults. */\nexport function configureKvStore(config: Partial<KvStoreConfig>) {\n  Object.assign(KvStoreConfig, config);\n}\n\n/** Type to represent a full object with metadata stored in the store. */\nexport type KvStoredObject<T> = StoredObject<T> & {\n  // The key is required by the ObjectStore.\n  key: string;\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: KvStoredObject<T>,\n): KvStoredObject<T> | undefined {\n  if (\n    !obj ||\n    typeof obj !== \"object\" ||\n    typeof obj.key !== \"string\" ||\n    obj.value === undefined ||\n    typeof obj.storedMs !== \"number\" ||\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\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 */\n// Using `any` because the store could store any type of data for each key,\n// but the caller can specify a more specific type when calling each of the\n// methods.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class KvStore implements FullStorageAdapter<any> {\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 readonly dbVersion: number;\n  public readonly storeName: string;\n  public readonly defaultExpiryMs: number;\n  public readonly gcIntervalMs: number;\n\n  public constructor(\n    public readonly dbName: string,\n    options?: {\n      dbVersion?: number;\n      storeName?: string;\n      defaultExpiryMs?: number | Duration;\n      gcIntervalMs?: number | Duration;\n    },\n  ) {\n    this.dbVersion = options?.dbVersion ?? KvStoreConfig.dbVersion;\n    this.storeName = options?.storeName ?? KvStoreConfig.storeName;\n\n    this.defaultExpiryMs = options?.defaultExpiryMs\n      ? durationOrMsToMs(options.defaultExpiryMs)\n      : KvStoreConfig.expiryMs;\n\n    this.gcIntervalMs = options?.gcIntervalMs\n      ? durationOrMsToMs(options.gcIntervalMs)\n      : KvStoreConfig.gcIntervalMs;\n\n    this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${this.dbVersion}:${this.storeName}`;\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(this.storeName, {\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(\n        db.transaction(this.storeName, mode),\n        reject,\n      );\n\n      transaction.onabort = (event) => {\n        reject(event);\n      };\n\n      const objectStore = transaction.objectStore(this.storeName);\n\n      callback(objectStore, resolve, reject);\n    });\n  }\n\n  /** Set a value in the store. */\n  public async set<T>(\n    key: string,\n    value: T,\n    expiryDeltaMs: number | Duration = this.defaultExpiryMs,\n  ): Promise<T> {\n    const nowMs = Date.now();\n    const obj: KvStoredObject<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  /** Mainly used to get the expiration timestamp of an object. */\n  public async getStoredObject<T>(\n    key: string,\n  ): Promise<KvStoredObject<T> | undefined> {\n    const stored = await this.transact<KvStoredObject<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  /** Get a value by key, or undefined if it does not exist. */\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  /** Generic way to iterate through all entries. */\n  public async forEach<T>(\n    callback: (\n      key: string,\n      value: T,\n      expiryMs: number,\n      storedMs: 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 !== undefined) {\n              await callback(\n                String(cursor.key),\n                obj.value as T,\n                obj.expiryMs,\n                obj.storedMs,\n              );\n            }\n          }\n          cursor.continue();\n        } else {\n          resolve();\n        }\n      };\n    });\n  }\n\n  /**\n   * Returns the number of items in the store. Note that getting the size\n   * requires iterating through the entire store because the items could expire\n   * at any time, and hence the size is a dynamic number.\n   */\n  public async size(): Promise<number> {\n    let count = 0;\n    await this.forEach(() => {\n      count++;\n    });\n    return count;\n  }\n\n  /** Remove all items from the store. */\n  public async clear(): Promise<void> {\n    const keys: string[] = [];\n    await this.forEach((key) => {\n      keys.push(key);\n    });\n\n    await this.delete(keys);\n  }\n\n  /**\n   * Returns all items as map of key to value, mainly used for debugging dumps.\n   * The type T is applied to all values, even though they might not be of type\n   * T (in the case when you store different data types in the same store).\n   */\n  public async asMap<T>(): Promise<Map<string, StoredObject<T>>> {\n    const map = new Map<string, StoredObject<T>>();\n    await this.forEach((key, value, expiryMs, storedMs) => {\n      map.set(key, { value: value as T, expiryMs, storedMs });\n    });\n    return map;\n  }\n\n  /** Returns the ms timestamp for the last GC (garbage collection). */\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  /** Set the ms timestamp for the last GC (garbage collection). */\n  public set lastGcMs(ms: number) {\n    globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));\n  }\n\n  /** Perform garbage-collection if due, else do nothing. */\n  public async gc(): Promise<void> {\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 + this.gcIntervalMs) {\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  /**\n   * Perform garbage collection immediately without checking whether we are\n   * due for the next GC or not.\n   */\n  public async gcNow(): Promise<void> {\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  /** Returns `this` casted into a StorageAdapter<T>. */\n  public asStorageAdapter<T>(): StorageAdapter<T> {\n    return this as StorageAdapter<T>;\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(KvStoreConfig.dbName);\n\n/**\n * Class to represent one key in the store with a default expiration.\n */\nexport class KvStoreItem<T> {\n  public readonly defaultExpiryMs: number;\n\n  public constructor(\n    public readonly key: string,\n    defaultExpiryMs: number | Duration = KvStoreConfig.expiryMs,\n    public readonly store = kvStore,\n  ) {\n    this.defaultExpiryMs = defaultExpiryMs && durationOrMsToMs(defaultExpiryMs);\n  }\n\n  /** Set a value in the store. */\n  public async set(\n    value: T,\n    expiryDeltaMs: number | undefined = this.defaultExpiryMs,\n  ): Promise<void> {\n    await this.store.set(this.key, value, expiryDeltaMs);\n  }\n\n  /**\n   * Example usage:\n   *\n   *   const { value, storedMs, expiryMs, storedMs } =\n   *     await myKvItem.getStoredObject();\n   */\n  public async getStoredObject(): Promise<KvStoredObject<T> | undefined> {\n    return await this.store.getStoredObject(this.key);\n  }\n\n  /** Get a value by key, or undefined if it does not exist. */\n  public async get(): Promise<T | undefined> {\n    return await this.store.get(this.key);\n  }\n\n  /** Delete this key from the store. */\n  public async delete(): Promise<void> {\n    await this.store.delete(this.key);\n  }\n}\n\n/** Create a KV store item with a key and a default expiration. */\nexport function kvStoreItem<T>(\n  key: string,\n  expiryMs?: number | Duration,\n  store = kvStore,\n): KvStoreItem<T> {\n  expiryMs = expiryMs && durationOrMsToMs(expiryMs);\n\n  return new KvStoreItem<T>(key, expiryMs, store);\n}\n"],"mappings":"AA0LO,SAASA,EAAaC,EAA4B,CACvD,IAAMC,GAAUD,EAAS,MAAQ,GAAK,MAChCE,GAAWF,EAAS,OAAS,GAAK,KAClCG,GAAUH,EAAS,SAAW,GAAK,IACnCI,GAAUJ,EAAS,SAAW,GAAK,IACnCK,EAAOL,EAAS,cAAgB,EAEtC,OAAOC,EAASC,EAAUC,EAASC,EAASC,CAC9C,CAKO,SAASC,EAAiBN,EAAqC,CACpE,OAAO,OAAOA,GAAa,SAAWA,EAAWD,EAAaC,CAAQ,CACxE,CChLO,IAAMO,EAAgB,CAK3B,OAAQ,UAMR,UAAW,EAMX,UAAW,UAGX,SAAU,MAAa,GAGvB,aAAc,KAChB,EAKO,SAASC,EAAiBC,EAAgC,CAC/D,OAAO,OAAOF,EAAeE,CAAM,CACrC,CAYA,SAASC,EACPC,EAC+B,CAC/B,GACE,GAACA,GACD,OAAOA,GAAQ,UACf,OAAOA,EAAI,KAAQ,UACnBA,EAAI,QAAU,QACd,OAAOA,EAAI,UAAa,UACxB,OAAOA,EAAI,UAAa,UACxB,KAAK,IAAI,GAAKA,EAAI,UAKpB,OAAOA,CACT,CAGA,SAASC,EACPC,EACAC,EACG,CACH,OAAAD,EAAQ,QAAWE,GAAU,CAC3BD,EAAOC,CAAK,CACd,EAEOF,CACT,CAUO,IAAMG,EAAN,KAAiD,CAY/C,YACWC,EAChBC,EAMA,CAPgB,YAAAD,EAQhB,KAAK,UAAYC,GAAS,WAAaX,EAAc,UACrD,KAAK,UAAYW,GAAS,WAAaX,EAAc,UAErD,KAAK,gBAAkBW,GAAS,gBAC5BC,EAAiBD,EAAQ,eAAe,EACxCX,EAAc,SAElB,KAAK,aAAeW,GAAS,aACzBC,EAAiBD,EAAQ,YAAY,EACrCX,EAAc,aAElB,KAAK,eAAiB,sBAAsBU,CAAM,KAAK,KAAK,SAAS,IAAI,KAAK,SAAS,EACzF,CA/BQ,GAGQ,eAEA,UACA,UACA,gBACA,aAyBhB,MAAc,eAAgB,CAC5B,OAAK,KAAK,KACR,KAAK,GAAK,MAAM,IAAI,QAAqB,CAACG,EAASN,IAAW,CAC5D,IAAMD,EAAUD,EACd,WAAW,UAAU,KAAK,KAAK,OAAQ,KAAK,SAAS,EACrDE,CACF,EAEAD,EAAQ,gBAAmBE,GAAU,CACvBA,EAAM,OACf,OAGoB,kBAAkB,KAAK,UAAW,CACvD,QAAS,KACX,CAAC,EAEW,YAAY,MAAO,MAAO,CACpC,OAAQ,EACV,CAAC,CACH,EAEAF,EAAQ,UAAaE,GAAU,CAC7B,IAAMM,EAAMN,EAAM,OACf,OACHK,EAAQC,CAAE,CACZ,CACF,CAAC,GAGI,KAAK,EACd,CAEA,MAAc,SACZC,EACAC,EAKY,CACZ,IAAMF,EAAK,MAAM,KAAK,cAAc,EAEpC,OAAO,MAAM,IAAI,QAAW,CAACD,EAASN,IAAW,CAC/C,IAAMU,EAAcZ,EAClBS,EAAG,YAAY,KAAK,UAAWC,CAAI,EACnCR,CACF,EAEAU,EAAY,QAAWT,GAAU,CAC/BD,EAAOC,CAAK,CACd,EAEA,IAAMU,EAAcD,EAAY,YAAY,KAAK,SAAS,EAE1DD,EAASE,EAAaL,EAASN,CAAM,CACvC,CAAC,CACH,CAGA,MAAa,IACXY,EACAC,EACAC,EAAmC,KAAK,gBAC5B,CACZ,IAAMC,EAAQ,KAAK,IAAI,EACjBlB,EAAyB,CAC7B,IAAAe,EACA,MAAAC,EACA,SAAUE,EACV,SAAUA,EAAQV,EAAiBS,CAAa,CAClD,EAEA,OAAO,MAAM,KAAK,SAChB,YACA,CAACH,EAAaL,EAASN,IAAW,CAChC,IAAMD,EAAUD,EAAYa,EAAY,IAAId,CAAG,EAAGG,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBO,EAAQO,CAAK,EAEb,KAAK,GAAG,CACV,CACF,CACF,CACF,CAGA,MAAa,OAAOD,EAAuC,CACzD,OAAO,MAAM,KAAK,SAChB,YACA,CAACD,EAAaL,EAASN,IAAW,CAKhC,GAJAW,EAAY,YAAY,WAAa,IAAM,CACzCL,EAAQ,CACV,EAEI,OAAOM,GAAQ,SACjBd,EAAYa,EAAY,OAAOC,CAAG,EAAGZ,CAAM,MAE3C,SAAWgB,KAAKJ,EACdd,EAAYa,EAAY,OAAOK,CAAC,EAAGhB,CAAM,CAG/C,CACF,CACF,CAGA,MAAa,gBACXY,EACwC,CACxC,IAAMK,EAAS,MAAM,KAAK,SACxB,WACA,CAACN,EAAaL,EAASN,IAAW,CAChC,IAAMD,EAAUD,EAAYa,EAAY,IAAIC,CAAG,EAAGZ,CAAM,EAExDD,EAAQ,UAAY,IAAM,CACxBO,EAAQP,EAAQ,MAAM,CACxB,CACF,CACF,EAEA,GAAKkB,EAIL,GAAI,CACF,IAAMpB,EAAMD,EAAqBqB,CAAM,EACvC,GAAI,CAACpB,EAAK,CACR,MAAM,KAAK,OAAOe,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CAEA,OAAOf,CACT,OAASqB,EAAG,CACV,QAAQ,MAAM,qBAAqBN,CAAG,IAAI,KAAK,UAAUK,CAAM,CAAC,IAAKC,CAAC,EACtE,MAAM,KAAK,OAAON,CAAG,EAErB,KAAK,GAAG,EAER,MACF,CACF,CAGA,MAAa,IAAOA,EAAqC,CAGvD,OAFY,MAAM,KAAK,gBAAmBA,CAAG,IAEjC,KACd,CAGA,MAAa,QACXH,EAMe,CACf,MAAM,KAAK,SAAe,WAAY,CAACE,EAAaL,EAASN,IAAW,CACtE,IAAMD,EAAUD,EAAYa,EAAY,WAAW,EAAGX,CAAM,EAE5DD,EAAQ,UAAY,MAAOE,GAAU,CACnC,IAAMkB,EACJlB,EAAM,OACN,OAEF,GAAIkB,EAAQ,CACV,GAAIA,EAAO,IAAK,CACd,IAAMtB,EAAMD,EAAqBuB,EAAO,KAAK,EACzCtB,IAAQ,QACV,MAAMY,EACJ,OAAOU,EAAO,GAAG,EACjBtB,EAAI,MACJA,EAAI,SACJA,EAAI,QACN,CAEJ,CACAsB,EAAO,SAAS,CAClB,MACEb,EAAQ,CAEZ,CACF,CAAC,CACH,CAOA,MAAa,MAAwB,CACnC,IAAIc,EAAQ,EACZ,aAAM,KAAK,QAAQ,IAAM,CACvBA,GACF,CAAC,EACMA,CACT,CAGA,MAAa,OAAuB,CAClC,IAAMC,EAAiB,CAAC,EACxB,MAAM,KAAK,QAAST,GAAQ,CAC1BS,EAAK,KAAKT,CAAG,CACf,CAAC,EAED,MAAM,KAAK,OAAOS,CAAI,CACxB,CAOA,MAAa,OAAkD,CAC7D,IAAMC,EAAM,IAAI,IAChB,aAAM,KAAK,QAAQ,CAACV,EAAKC,EAAOU,EAAUC,IAAa,CACrDF,EAAI,IAAIV,EAAK,CAAE,MAAOC,EAAY,SAAAU,EAAU,SAAAC,CAAS,CAAC,CACxD,CAAC,EACMF,CACT,CAGA,IAAW,UAAmB,CAC5B,IAAMG,EAAc,WAAW,aAAa,QAAQ,KAAK,cAAc,EACvE,GAAI,CAACA,EAAa,MAAO,GAEzB,IAAMC,EAAK,OAAOD,CAAW,EAC7B,OAAO,MAAMC,CAAE,EAAI,EAAIA,CACzB,CAGA,IAAW,SAASA,EAAY,CAC9B,WAAW,aAAa,QAAQ,KAAK,eAAgB,OAAOA,CAAE,CAAC,CACjE,CAGA,MAAa,IAAoB,CAC/B,IAAMC,EAAW,KAAK,SAGtB,GAAI,CAACA,EAAU,CACb,KAAK,SAAW,KAAK,IAAI,EACzB,MACF,CAEI,KAAK,IAAI,EAAIA,EAAW,KAAK,cAKjC,MAAM,KAAK,MAAM,CACnB,CAMA,MAAa,OAAuB,CAClC,QAAQ,IAAI,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,KAAK,EAGzE,KAAK,SAAW,KAAK,IAAI,EAEzB,IAAMC,EAAyB,CAAC,EAChC,MAAM,KAAK,QACT,MAAOhB,EAAaC,EAAgBU,IAAqB,EACnDV,IAAU,QAAa,KAAK,IAAI,GAAKU,IACvCK,EAAa,KAAKhB,CAAG,CAEzB,CACF,EAEIgB,EAAa,QACf,MAAM,KAAK,OAAOA,CAAY,EAGhC,QAAQ,IACN,0BAA0B,KAAK,MAAM,KAAK,KAAK,SAAS,cACzCA,EAAa,MAAM,OACpC,EAGA,KAAK,SAAW,KAAK,IAAI,CAC3B,CAGO,kBAAyC,CAC9C,OAAO,IACT,CACF,EAMaC,EAAU,IAAI3B,EAAQT,EAAc,MAAM,EAK1CqC,EAAN,KAAqB,CAGnB,YACWlB,EAChBmB,EAAqCtC,EAAc,SACnCuC,EAAQH,EACxB,CAHgB,SAAAjB,EAEA,WAAAoB,EAEhB,KAAK,gBAAkBD,GAAmB1B,EAAiB0B,CAAe,CAC5E,CARgB,gBAWhB,MAAa,IACXlB,EACAC,EAAoC,KAAK,gBAC1B,CACf,MAAM,KAAK,MAAM,IAAI,KAAK,IAAKD,EAAOC,CAAa,CACrD,CAQA,MAAa,iBAA0D,CACrE,OAAO,MAAM,KAAK,MAAM,gBAAgB,KAAK,GAAG,CAClD,CAGA,MAAa,KAA8B,CACzC,OAAO,MAAM,KAAK,MAAM,IAAI,KAAK,GAAG,CACtC,CAGA,MAAa,QAAwB,CACnC,MAAM,KAAK,MAAM,OAAO,KAAK,GAAG,CAClC,CACF,EAGO,SAASmB,EACdrB,EACAW,EACAS,EAAQH,EACQ,CAChB,OAAAN,EAAWA,GAAYlB,EAAiBkB,CAAQ,EAEzC,IAAIO,EAAelB,EAAKW,EAAUS,CAAK,CAChD","names":["durationToMs","duration","daysMs","hoursMs","minsMs","secsMs","msMs","durationOrMsToMs","KvStoreConfig","configureKvStore","config","validateStoredObject","obj","withOnError","request","reject","event","KvStore","dbName","options","durationOrMsToMs","resolve","db","mode","callback","transaction","objectStore","key","value","expiryDeltaMs","nowMs","k","stored","e","cursor","count","keys","map","expiryMs","storedMs","lastGcMsStr","ms","lastGcMs","keysToDelete","kvStore","KvStoreItem","defaultExpiryMs","store","kvStoreItem"]}

package/kvStore.mjs

@@ -18,14 +18,32 @@ function durationOrMsToMs(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;
+var KvStoreConfig = {
+  /**
+   * Name of the DB in the indexed DB.
+   * Updating the DB name will cause all old entries to be gone.
+   */
+  dbName: "KVStore",
+  /**
+   * Version of the DB schema. Most likely you will never want to change this.
+   * Updating the version will cause all old entries to be gone.
+   */
+  dbVersion: 1,
+  /**
+   * Name of the store within the indexed DB. Each DB can have multiple stores.
+   * In practice, it doesn't matter what you name this to be.
+   */
+  storeName: "kvStore",
+  /** 30 days in ms. */
+  expiryMs: MS_PER_DAY * 30,
+  /** Do GC once per day. */
+  gcIntervalMs: MS_PER_DAY
+};
+function configureKvStore(config) {
+  Object.assign(KvStoreConfig, config);
+}
 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) {
+  if (!obj || typeof obj !== "object" || typeof obj.key !== "string" || obj.value === void 0 || typeof obj.storedMs !== "number" || typeof obj.expiryMs !== "number" || Date.now() >= obj.expiryMs) {
     return void 0;
   }
   return obj;
@@ -36,32 +54,23 @@ function withOnError(request, reject) {
   };
   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) {
+var KvStore = class {
+  constructor(dbName, options) {
     this.dbName = dbName;
-    this.dbVersion = dbVersion;
-    this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
-    this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${dbVersion}:${STORE_NAME}`;
+    this.dbVersion = options?.dbVersion ?? KvStoreConfig.dbVersion;
+    this.storeName = options?.storeName ?? KvStoreConfig.storeName;
+    this.defaultExpiryMs = options?.defaultExpiryMs ? durationOrMsToMs(options.defaultExpiryMs) : KvStoreConfig.expiryMs;
+    this.gcIntervalMs = options?.gcIntervalMs ? durationOrMsToMs(options.gcIntervalMs) : KvStoreConfig.gcIntervalMs;
+    this.gcMsStorageKey = `__kvStore:lastGcMs:${dbName}:v${this.dbVersion}:${this.storeName}`;
   }
-  // We'll init the DB only on first use.
+  /** We'll init the DB only on first use. */
   db;
-  // Local storage key name for the last GC completed timestamp.
+  /** Local storage key name for the last GC completed timestamp. */
   gcMsStorageKey;
+  dbVersion;
+  storeName;
+  defaultExpiryMs;
+  gcIntervalMs;
   async getOrCreateDb() {
     if (!this.db) {
       this.db = await new Promise((resolve, reject) => {
@@ -71,7 +80,7 @@ var KVStore = class {
         );
         request.onupgradeneeded = (event) => {
           const db = event.target.result;
-          const objectStore = db.createObjectStore(STORE_NAME, {
+          const objectStore = db.createObjectStore(this.storeName, {
             keyPath: "key"
           });
           objectStore.createIndex("key", "key", {
@@ -89,15 +98,19 @@ var KVStore = class {
   async transact(mode, callback) {
     const db = await this.getOrCreateDb();
     return await new Promise((resolve, reject) => {
-      const transaction = withOnError(db.transaction(STORE_NAME, mode), reject);
+      const transaction = withOnError(
+        db.transaction(this.storeName, mode),
+        reject
+      );
       transaction.onabort = (event) => {
         reject(event);
       };
-      const objectStore = transaction.objectStore(STORE_NAME);
+      const objectStore = transaction.objectStore(this.storeName);
       callback(objectStore, resolve, reject);
     });
   }
-  async set(key, value, expiryDeltaMs = this.defaultExpiryDeltaMs) {
+  /** Set a value in the store. */
+  async set(key, value, expiryDeltaMs = this.defaultExpiryMs) {
     const nowMs = Date.now();
     const obj = {
       key,
@@ -134,6 +147,7 @@ var KVStore = class {
       }
     );
   }
+  /** Mainly used to get the expiration timestamp of an object. */
   async getStoredObject(key) {
     const stored = await this.transact(
       "readonly",
@@ -162,10 +176,12 @@ var KVStore = class {
       return void 0;
     }
   }
+  /** Get a value by key, or undefined if it does not exist. */
   async get(key) {
     const obj = await this.getStoredObject(key);
     return obj?.value;
   }
+  /** Generic way to iterate through all entries. */
   async forEach(callback) {
     await this.transact("readonly", (objectStore, resolve, reject) => {
       const request = withOnError(objectStore.openCursor(), reject);
@@ -174,10 +190,13 @@ var KVStore = class {
         if (cursor) {
           if (cursor.key) {
             const obj = validateStoredObject(cursor.value);
-            if (obj) {
-              await callback(String(cursor.key), obj.value, obj.expiryMs);
-            } else {
-              await callback(String(cursor.key), void 0, 0);
+            if (obj !== void 0) {
+              await callback(
+                String(cursor.key),
+                obj.value,
+                obj.expiryMs,
+                obj.storedMs
+              );
             }
           }
           cursor.continue();
@@ -187,7 +206,11 @@ var KVStore = class {
       };
     });
   }
-  /** Cannot be a getter because this needs to be async. */
+  /**
+   * Returns the number of items in the store. Note that getting the size
+   * requires iterating through the entire store because the items could expire
+   * at any time, and hence the size is a dynamic number.
+   */
   async size() {
     let count = 0;
     await this.forEach(() => {
@@ -195,6 +218,7 @@ var KVStore = class {
     });
     return count;
   }
+  /** Remove all items from the store. */
   async clear() {
     const keys = [];
     await this.forEach((key) => {
@@ -202,36 +226,45 @@ var KVStore = class {
     });
     await this.delete(keys);
   }
-  /** Mainly for debugging dumps. */
+  /**
+   * Returns all items as map of key to value, mainly used for debugging dumps.
+   * The type T is applied to all values, even though they might not be of type
+   * T (in the case when you store different data types in the same store).
+   */
   async asMap() {
     const map = /* @__PURE__ */ new Map();
-    await this.forEach((key, value, expiryMs) => {
-      map.set(key, { value, expiryMs });
+    await this.forEach((key, value, expiryMs, storedMs) => {
+      map.set(key, { value, expiryMs, storedMs });
     });
     return map;
   }
+  /** Returns the ms timestamp for the last GC (garbage collection). */
   get lastGcMs() {
     const lastGcMsStr = globalThis.localStorage.getItem(this.gcMsStorageKey);
     if (!lastGcMsStr) return 0;
     const ms = Number(lastGcMsStr);
     return isNaN(ms) ? 0 : ms;
   }
+  /** Set the ms timestamp for the last GC (garbage collection). */
   set lastGcMs(ms) {
     globalThis.localStorage.setItem(this.gcMsStorageKey, String(ms));
   }
-  /** Perform garbage-collection if due. */
+  /** Perform garbage-collection if due, else do nothing. */
   async gc() {
     const lastGcMs = this.lastGcMs;
     if (!lastGcMs) {
       this.lastGcMs = Date.now();
       return;
     }
-    if (Date.now() < lastGcMs + GC_INTERVAL_MS) {
+    if (Date.now() < lastGcMs + this.gcIntervalMs) {
       return;
     }
     await this.gcNow();
   }
-  /** Perform garbage-collection immediately without checking. */
+  /**
+   * Perform garbage collection immediately without checking whether we are
+   * due for the next GC or not.
+   */
   async gcNow() {
     console.log(`Starting kvStore GC on ${this.dbName} v${this.dbVersion}...`);
     this.lastGcMs = Date.now();
@@ -251,50 +284,50 @@ var KVStore = class {
     );
     this.lastGcMs = Date.now();
   }
-  /** Get an independent store item with a locked key and value type. */
-  field(key) {
-    return new KVStoreField(this, key);
+  /** Returns `this` casted into a StorageAdapter<T>. */
+  asStorageAdapter() {
+    return this;
   }
 };
-var kvStore = new KVStore(
-  DEFAULT_DB_NAME,
-  DEFAULT_DB_VERSION,
-  DEFAULT_EXPIRY_DELTA_MS
-);
+var kvStore = new KvStore(KvStoreConfig.dbName);
 var KvStoreItem = class {
-  constructor(key, defaultExpiryDeltaMs, store = kvStore) {
+  constructor(key, defaultExpiryMs = KvStoreConfig.expiryMs, store = kvStore) {
     this.key = key;
-    this.defaultExpiryDeltaMs = defaultExpiryDeltaMs;
     this.store = store;
+    this.defaultExpiryMs = defaultExpiryMs && durationOrMsToMs(defaultExpiryMs);
+  }
+  defaultExpiryMs;
+  /** Set a value in the store. */
+  async set(value, expiryDeltaMs = this.defaultExpiryMs) {
+    await this.store.set(this.key, value, expiryDeltaMs);
   }
   /**
    * Example usage:
    *
-   *   const { value, storedMs, expiryMs } = await myKvItem.getStoredObject();
+   *   const { value, storedMs, expiryMs, storedMs } =
+   *     await myKvItem.getStoredObject();
    */
   async getStoredObject() {
     return await this.store.getStoredObject(this.key);
   }
+  /** Get a value by key, or undefined if it does not exist. */
   async get() {
     return await this.store.get(this.key);
   }
-  async set(value, expiryDeltaMs = this.defaultExpiryDeltaMs) {
-    await this.store.set(this.key, value, expiryDeltaMs);
-  }
+  /** Delete this key from the store. */
   async delete() {
     await this.store.delete(this.key);
   }
 };
-function kvStoreItem(key, defaultExpiration) {
-  const defaultExpiryDeltaMs = durationOrMsToMs(defaultExpiration);
-  return new KvStoreItem(key, defaultExpiryDeltaMs);
+function kvStoreItem(key, expiryMs, store = kvStore) {
+  expiryMs = expiryMs && durationOrMsToMs(expiryMs);
+  return new KvStoreItem(key, expiryMs, store);
 }
 export {
-  DEFAULT_EXPIRY_DELTA_MS,
-  GC_INTERVAL_MS,
-  KVStore,
-  KVStoreField,
-  MILLIS_PER_DAY,
+  KvStore,
+  KvStoreConfig,
+  KvStoreItem,
+  configureKvStore,
   kvStore,
   kvStoreItem
 };