@choksheak/react-utils 0.4.5 → 0.4.7

package/sharedState.min.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n *\n * Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n *\n * This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n *\n * ```\n *   atom()          -->  sharedState()\n *   useAtom()       -->  useSharedState()\n *   useAtomValue()  -->  useSharedStateValue()\n *   useSetAtom()    -->  useSharedStateSetter()\n * ```\n *\n * Example:\n * ```\n *   import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n *\n *   // Create a new shared state in the top level scope.\n *   // The first argument is the default value, which is required.\n *   // The second argument is an options object, and is optional (defaults\n *   // to storing in memory only without any persistence).\n *   const usersState = sharedState(\n *     [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n *   );\n *\n *   export const UsersComponent: React.FC = () => {\n *     // Get both the value and the setter.\n *     const [users, setUsers] = useSharedState(usersState);\n *     ...\n *   };\n *\n *   export const ReadOnlyComponent: React.FC = () => {\n *     // Get the value only.\n *     const users = useSharedStateValue(usersState);\n *     ...\n *   };\n *\n *   export const WriteOnlyComponent: React.FC = () => {\n *     // Get the setter only.\n *     const setUsers = useSharedStateSetter(usersState);\n *     ...\n *   };\n * ```\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/************************************************************************/\n/* Global config                                                        */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateConfig = {\n  /**\n   * Default duration for storage expiration in milliseconds. Initial value\n   * is 30 days, but can be changed to anything.\n   */\n  storeExpiryMs: 30 * MS_PER_DAY,\n\n  /**\n   * True to load from storage only on mount, false (default) to load in\n   * the top level scope when the shared state is defined.\n   */\n  lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/** Convenience function to update global defaults. */\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n  Object.assign(SharedStateConfig, config);\n}\n\n/************************************************************************/\n/* Pub-sub store\n/************************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n  const dataByKey = new Map<string, unknown>();\n  const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n  function notify<T>(key: string, next: T, prev: T): void {\n    const subscribers = subscribersByKey.get(key);\n    if (!subscribers) return;\n\n    // Make copy to protect against mutation during iteration.\n    const copy = Array.from(subscribers.values());\n    for (const subscriber of copy) {\n      try {\n        subscriber(next, prev);\n      } catch (e) {\n        console.error(`Error invoking subscriber:`, e);\n      }\n    }\n  }\n\n  return {\n    // This could be undefined if T includes undefined, else it should never\n    // return undefined because the user has to always specify the default value.\n    get<T>(key: string): T {\n      return dataByKey.get(key) as T;\n    },\n\n    set<T>(key: string, value: T): void {\n      const prev = dataByKey.get(key) as T;\n\n      // Do nothing if no change.\n      if (prev === value) return;\n\n      dataByKey.set(key, value);\n      notify(key, value, prev);\n    },\n\n    delete(key: string): void {\n      dataByKey.delete(key);\n    },\n\n    setNoNotify<T>(key: string, value: T): void {\n      dataByKey.set(key, value);\n    },\n\n    // Subscribe to changes of a specific key\n    subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n      let subscribers = subscribersByKey.get(key);\n      if (!subscribers) {\n        subscribers = new Set();\n        subscribersByKey.set(key, subscribers);\n      }\n\n      // Type coercion: we store Subscriber<unknown>\n      subscribers.add(subscriber as Subscriber<unknown>);\n\n      // Return unsubscribe function\n      return () => {\n        subscribers.delete(subscriber as Subscriber<unknown>);\n        if (subscribers.size === 0) subscribersByKey.delete(key);\n      };\n    },\n  } as const;\n}\n\n/**\n * Ensure we always use the same store. If we create two stores, then the\n * reactive updates will fail.\n */\nfunction getOrCreatePubSubStore() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as unknown as {\n      reactUtilsPubSubStore: ReturnType<typeof createPubSubStore> | undefined;\n    };\n    return (\n      t.reactUtilsPubSubStore || (t.reactUtilsPubSubStore = createPubSubStore())\n    );\n  }\n  return createPubSubStore();\n}\n\nconst pubSubStore = getOrCreatePubSubStore();\n\n/************************************************************************/\n/* Shared state implementation                                          */\n/************************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/** Options to configure a shared state. */\nexport type SharedStateOptions<T> = {\n  lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/**\n * Create a new shared state object. Put this code at the top level scope:\n *\n * Example:\n * ```\n *   const counterState = sharedState<number>(0);\n * ```\n */\nexport function sharedState<T>(\n  defaultValue: T,\n  options?: SharedStateOptions<T>,\n) {\n  let readyResolve: () => void = () => {};\n\n  const readyPromise = new Promise<void>((resolve) => {\n    readyResolve = resolve;\n  });\n\n  const resolveReadyPromise = readyResolve;\n\n  const pubSubKey = String(stateKey++);\n\n  // Use max of 1 storage adapter per shared state.\n  const storageAdapter = getStorageAdapter(\n    options,\n    SharedStateConfig.storeExpiryMs,\n  );\n\n  // Always set the default value first to avoid returning undefineds if that\n  // is not part of T. Don't notify with the default value.\n  pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n  const lazyLoad = options?.lazyLoad;\n  const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n  function completeInit(stored: T | undefined) {\n    const value = stored !== undefined ? stored : defaultValue;\n\n    pubSubStore.set(pubSubKey, value);\n\n    // @ts-expect-error ts(2540) - Assign to readonly property.\n    obj.initDone = true;\n    resolveReadyPromise();\n  }\n\n  const obj = {\n    defaultValue,\n\n    /** Allow users to await for the completion of data init. */\n    readyPromise,\n\n    lazy,\n\n    initStarted: false,\n    initDone: false,\n\n    /** `subscribe` function required by useSyncExternalStore. */\n    subscribe(subscriber: () => void): () => void {\n      return pubSubStore.subscribe(pubSubKey, () => subscriber());\n    },\n\n    /** Returns true if there is a backing store. */\n    hasStore(): boolean {\n      return Boolean(storageAdapter);\n    },\n\n    /**\n     * Set a value directly into the store. Does nothing if there is no\n     * backing store.\n     *\n     * Warning: If you want to set the value properly, you should use\n     * `setValue()` instead which also updates the in-memory copy.\n     */\n    setInStore(value: T): Promise<void> | void {\n      return storageAdapter?.set(STORAGE_KEY, value);\n    },\n\n    /**\n     * Get a value directly from the store. Returns undefined if there is no\n     * backing store.\n     */\n    getFromStore(): Promise<T | undefined> | T | undefined {\n      return storageAdapter?.get(STORAGE_KEY);\n    },\n\n    /**\n     * Get the value of the shared state.\n     *  `getSnapshot` function — must return same ref if value unchanged.\n     * Note that this would return the default value if data init from store is\n     * not completed yet.\n     */\n    getSnapshot(): T {\n      return pubSubStore.get(pubSubKey);\n    },\n\n    /** Set the value of the shared state. */\n    setValue(next: SetStateAction<T>): void {\n      if (typeof next === \"function\") {\n        const prev = pubSubStore.get<T>(pubSubKey);\n        next = (next as (p: T) => T)(prev);\n      }\n\n      pubSubStore.set(pubSubKey, next);\n      void obj.setInStore(next);\n    },\n\n    /**\n     * Remove the value of the shared state. Actually this just sets the value\n     * back to the given default value.\n     */\n    delete(): Promise<void> | void {\n      pubSubStore.set(pubSubKey, defaultValue);\n      return storageAdapter?.set(STORAGE_KEY, defaultValue);\n    },\n\n    /** Initial default handling. */\n    initDefaultValueOnce(): Promise<void> | void {\n      if (obj.initDone || obj.initStarted) return;\n      // @ts-expect-error ts(2540) - Assign to readonly property.\n      obj.initStarted = true;\n\n      const maybePromise = obj.getFromStore();\n\n      // Allow sync vs async code paths. This allows init to be fully completed\n      // from store before the sharedState() function returns.\n      if (maybePromise instanceof Promise) {\n        return maybePromise.then(completeInit);\n      } else {\n        const stored = maybePromise;\n        completeInit(stored);\n      }\n    },\n  } as const;\n\n  if (!lazy) {\n    obj.initDefaultValueOnce();\n  }\n\n  return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/**\n * React hook for subscribing to a key in the global store.\n *\n * Example:\n * ```\n *   const [counter, setCounter] = useSharedState(counterState);\n * ```\n */\nexport function useSharedState<T>(\n  state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n  void state.initDefaultValueOnce();\n\n  const value = useSyncExternalStore(\n    (onStoreChange) => state.subscribe(onStoreChange),\n    () => state.getSnapshot(),\n    // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n    () => state.getSnapshot(),\n  );\n\n  return [value, state.setValue];\n}\n\n/**\n * Same as useSharedState(), but returns the value only.\n *\n * Example:\n * ```\n *   const counter = useSharedStateValue(counterState);\n * ```\n */\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n  return useSharedState(state)[0];\n}\n\n/**\n * Same as useSharedState(), but returns the setter only.\n *\n * Example:\n * ```\n *   const setCounter = useSharedStateSetter(counterState);\n * ```\n */\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n  void state.initDefaultValueOnce();\n\n  return state.setValue;\n}\n","/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,uBAAAE,EAAA,yBAAAC,EAAA,gBAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,wBAAAC,IAAA,eAAAC,EAAAR,GAwDA,IAAAS,EAA2B,6CAC3BC,EAA+D,iBC7C/D,IAAAC,EAAwB,uCACxBC,EAAiC,0CAkC3BC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAIvB,IAAMC,KAAU,oBAFG,cAE0B,CAC3C,gBAAiBN,CACnB,CAAC,EAGKO,EAAYH,EAAM,IAExB,MAAO,CACL,IAAK,CAACA,EAAaI,IAAmB,CAChCb,GAGJW,EAAQ,IAAIC,EAAYH,EAAKI,CAAK,CACpC,EAEA,IAAMJ,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQF,EAAQ,IAAOG,CAAO,EAGpC,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,wDAAwDC,CAAO,KAAK,KAAK,UAAUD,CAAK,CAAC,EAC3F,EACAF,EAAQ,OAAOG,CAAO,EACtB,MACF,CAEA,OAAOD,CACT,EAEA,OAASJ,GAAsB,CACzBT,GAEJW,EAAQ,OAAOC,EAAYH,CAAG,CAChC,EAGA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,IAAME,EAAYH,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaI,IAA4B,CAC/Cb,GAGJ,MAAM,UAAQ,IAAIY,EAAYH,EAAKI,EAAOR,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQ,MAAM,UAAQ,IAAOC,CAAO,EAG1C,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,qDAAqDJ,CAAG,IACxDI,CACF,EACA,MAAM,UAAQ,OAAOC,CAAO,EAC5B,MACF,CAEA,OAAOD,CACT,EACA,OAAQ,MAAOJ,GAA+B,CACxCT,GAEJ,MAAM,UAAQ,OAAOY,EAAYH,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAM,UAAQ,MAAM,CACtB,CACF,CACF,CDnIO,IAAMe,EAAoB,CAK/B,cAAe,GAAK,aAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOF,EAAmBE,CAAM,CACzC,CAQA,SAASC,GAAoB,CAC3B,IAAMC,EAAY,IAAI,IAChBC,EAAmB,IAAI,IAE7B,SAASC,EAAUC,EAAaC,EAASC,EAAe,CACtD,IAAMC,EAAcL,EAAiB,IAAIE,CAAG,EAC5C,GAAI,CAACG,EAAa,OAGlB,IAAMC,EAAO,MAAM,KAAKD,EAAY,OAAO,CAAC,EAC5C,QAAWE,KAAcD,EACvB,GAAI,CACFC,EAAWJ,EAAMC,CAAI,CACvB,OAASI,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,IAAON,EAAgB,CACrB,OAAOH,EAAU,IAAIG,CAAG,CAC1B,EAEA,IAAOA,EAAaO,EAAgB,CAClC,IAAML,EAAOL,EAAU,IAAIG,CAAG,EAG1BE,IAASK,IAEbV,EAAU,IAAIG,EAAKO,CAAK,EACxBR,EAAOC,EAAKO,EAAOL,CAAI,EACzB,EAEA,OAAOF,EAAmB,CACxBH,EAAU,OAAOG,CAAG,CACtB,EAEA,YAAeA,EAAaO,EAAgB,CAC1CV,EAAU,IAAIG,EAAKO,CAAK,CAC1B,EAGA,UAAaP,EAAaK,EAAuC,CAC/D,IAAIF,EAAcL,EAAiB,IAAIE,CAAG,EAC1C,OAAKG,IACHA,EAAc,IAAI,IAClBL,EAAiB,IAAIE,EAAKG,CAAW,GAIvCA,EAAY,IAAIE,CAAiC,EAG1C,IAAM,CACXF,EAAY,OAAOE,CAAiC,EAChDF,EAAY,OAAS,GAAGL,EAAiB,OAAOE,CAAG,CACzD,CACF,CACF,CACF,CAMA,SAASQ,GAAyB,CAChC,GAAI,OAAO,OAAW,IAAa,CACjC,IAAMC,EAAI,OAAO,WAGjB,OACEA,EAAE,wBAA0BA,EAAE,sBAAwBb,EAAkB,EAE5E,CACA,OAAOA,EAAkB,CAC3B,CAEA,IAAMc,EAAcF,EAAuB,EAMrCG,EAAc,QAOhBC,EAAW,EAUR,SAASC,EACdC,EACAC,EACA,CACA,IAAIC,EAA2B,IAAM,CAAC,EAEhCC,EAAe,IAAI,QAAeC,GAAY,CAClDF,EAAeE,CACjB,CAAC,EAEKC,EAAsBH,EAEtBI,EAAY,OAAOR,GAAU,EAG7BS,EAAiBC,EACrBP,EACAtB,EAAkB,aACpB,EAIAiB,EAAY,YAAYU,EAAWN,CAAY,EAE/C,IAAMS,EAAWR,GAAS,SACpBS,EAAOD,IAAa,OAAYA,EAAW9B,EAAkB,SAEnE,SAASgC,EAAaC,EAAuB,CAC3C,IAAMnB,EAAQmB,IAAW,OAAYA,EAASZ,EAE9CJ,EAAY,IAAIU,EAAWb,CAAK,EAGhCoB,EAAI,SAAW,GACfR,EAAoB,CACtB,CAEA,IAAMQ,EAAM,CACV,aAAAb,EAGA,aAAAG,EAEA,KAAAO,EAEA,YAAa,GACb,SAAU,GAGV,UAAUnB,EAAoC,CAC5C,OAAOK,EAAY,UAAUU,EAAW,IAAMf,EAAW,CAAC,CAC5D,EAGA,UAAoB,CAClB,MAAO,EAAQgB,CACjB,EASA,WAAWd,EAAgC,CACzC,OAAOc,GAAgB,IAAIV,EAAaJ,CAAK,CAC/C,EAMA,cAAuD,CACrD,OAAOc,GAAgB,IAAIV,CAAW,CACxC,EAQA,aAAiB,CACf,OAAOD,EAAY,IAAIU,CAAS,CAClC,EAGA,SAASnB,EAA+B,CACtC,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMC,EAAOQ,EAAY,IAAOU,CAAS,EACzCnB,EAAQA,EAAqBC,CAAI,CACnC,CAEAQ,EAAY,IAAIU,EAAWnB,CAAI,EAC1B0B,EAAI,WAAW1B,CAAI,CAC1B,EAMA,QAA+B,CAC7B,OAAAS,EAAY,IAAIU,EAAWN,CAAY,EAChCO,GAAgB,IAAIV,EAAaG,CAAY,CACtD,EAGA,sBAA6C,CAC3C,GAAIa,EAAI,UAAYA,EAAI,YAAa,OAErCA,EAAI,YAAc,GAElB,IAAMC,EAAeD,EAAI,aAAa,EAItC,GAAIC,aAAwB,QAC1B,OAAOA,EAAa,KAAKH,CAAY,EAGrCA,EADeG,CACI,CAEvB,CACF,EAEA,OAAKJ,GACHG,EAAI,qBAAqB,EAGpBA,CACT,CAYO,SAASE,EACdC,EACkC,CAClC,OAAKA,EAAM,qBAAqB,EASzB,IAPO,wBACXC,GAAkBD,EAAM,UAAUC,CAAa,EAChD,IAAMD,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,QAAQ,CAC/B,CAUO,SAASE,EAAuBF,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASG,EAAwBH,EAAuB,CAC7D,OAAKA,EAAM,qBAAqB,EAEzBA,EAAM,QACf","names":["sharedState_exports","__export","SharedStateConfig","configureSharedState","sharedState","useSharedState","useSharedStateSetter","useSharedStateValue","__toCommonJS","import_timeConstants","import_react","import_kvStore","import_localStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","keyPrefix","value","fullKey","SharedStateConfig","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","getOrCreatePubSubStore","t","pubSubStore","STORAGE_KEY","stateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","getStorageAdapter","lazyLoad","lazy","completeInit","stored","obj","maybePromise","useSharedState","state","onStoreChange","useSharedStateValue","useSharedStateSetter"]}
+{"version":3,"sources":["../src/sharedState.ts"],"names":["SharedStateConfig","MS_PER_DAY","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","getOrCreatePubSubStore","t","pubSubStore","STORAGE_KEY","stateKey","getNextStateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","getStorageAdapter","lazyLoad","lazy","completeInit","stored","obj","maybePromise","useSharedState","state","useSyncExternalStore","onStoreChange","useSharedStateValue","useSharedStateSetter"],"mappings":"AAwDA,mvBAA2B,8BACoC,oCAEb,MASrCA,CAAAA,CAAoB,CAK/B,aAAA,CAAe,EAAA,CAAKC,yBAAAA,CAMpB,QAAA,CAAU,CAAA,CACZ,CAAA,CAKO,SAASC,CAAAA,CAAqBC,CAAAA,CAAoC,CACvE,MAAA,CAAO,MAAA,CAAOH,CAAAA,CAAmBG,CAAM,CACzC,CAQA,SAASC,CAAAA,CAAAA,CAAoB,CAC3B,MAAMC,CAAAA,CAAY,IAAI,GAAA,CAChBC,CAAAA,CAAmB,IAAI,GAAA,CAE7B,SAASC,CAAAA,CAAUC,CAAAA,CAAaC,CAAAA,CAASC,CAAAA,CAAe,CACtD,MAAMC,CAAAA,CAAcL,CAAAA,CAAiB,GAAA,CAAIE,CAAG,CAAA,CAC5C,EAAA,CAAI,CAACG,CAAAA,CAAa,MAAA,CAGlB,MAAMC,CAAAA,CAAO,KAAA,CAAM,IAAA,CAAKD,CAAAA,CAAY,MAAA,CAAO,CAAC,CAAA,CAC5C,GAAA,CAAA,MAAWE,EAAAA,GAAcD,CAAAA,CACvB,GAAI,CACFC,CAAAA,CAAWJ,CAAAA,CAAMC,CAAI,CACvB,CAAA,KAAA,CAASI,CAAAA,CAAG,CACV,OAAA,CAAQ,KAAA,CAAM,4BAAA,CAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,GAAA,CAAON,CAAAA,CAAgB,CACrB,OAAOH,CAAAA,CAAU,GAAA,CAAIG,CAAG,CAC1B,CAAA,CAEA,GAAA,CAAOA,CAAAA,CAAaO,CAAAA,CAAgB,CAClC,MAAML,CAAAA,CAAOL,CAAAA,CAAU,GAAA,CAAIG,CAAG,CAAA,CAG1BE,CAAAA,GAASK,CAAAA,EAAAA,CAEbV,CAAAA,CAAU,GAAA,CAAIG,CAAAA,CAAKO,CAAK,CAAA,CACxBR,CAAAA,CAAOC,CAAAA,CAAKO,CAAAA,CAAOL,CAAI,CAAA,CACzB,CAAA,CAEA,MAAA,CAAOF,CAAAA,CAAmB,CACxBH,CAAAA,CAAU,MAAA,CAAOG,CAAG,CACtB,CAAA,CAEA,WAAA,CAAeA,CAAAA,CAAaO,CAAAA,CAAgB,CAC1CV,CAAAA,CAAU,GAAA,CAAIG,CAAAA,CAAKO,CAAK,CAC1B,CAAA,CAGA,SAAA,CAAaP,CAAAA,CAAaK,CAAAA,CAAuC,CAC/D,IAAIF,CAAAA,CAAcL,CAAAA,CAAiB,GAAA,CAAIE,CAAG,CAAA,CAC1C,OAAKG,CAAAA,EAAAA,CACHA,CAAAA,CAAc,IAAI,GAAA,CAClBL,CAAAA,CAAiB,GAAA,CAAIE,CAAAA,CAAKG,CAAW,CAAA,CAAA,CAIvCA,CAAAA,CAAY,GAAA,CAAIE,CAAiC,CAAA,CAG1C,CAAA,CAAA,EAAM,CACXF,CAAAA,CAAY,MAAA,CAAOE,CAAiC,CAAA,CAChDF,CAAAA,CAAY,IAAA,GAAS,CAAA,EAAGL,CAAAA,CAAiB,MAAA,CAAOE,CAAG,CACzD,CACF,CACF,CACF,CAMA,SAASQ,CAAAA,CAAAA,CAAyB,CAChC,EAAA,CAAI,OAAO,MAAA,CAAW,GAAA,CAAa,CACjC,MAAMC,CAAAA,CAAI,MAAA,CAAO,UAAA,CAGjB,OACEA,CAAAA,CAAE,qBAAA,EAAA,CAA0BA,CAAAA,CAAE,qBAAA,CAAwBb,CAAAA,CAAkB,CAAA,CAE5E,CACA,OAAOA,CAAAA,CAAkB,CAC3B,CAEA,MAAMc,CAAAA,CAAcF,CAAAA,CAAuB,CAAA,CAMrCG,CAAAA,CAAc,OAAA,CAOpB,IAAIC,CAAAA,CAAW,CAAA,CAGf,SAASC,CAAAA,CAAAA,CAAkB,CACzB,EAAA,CAAI,OAAO,MAAA,CAAW,GAAA,CAAa,CACjC,MAAMJ,CAAAA,CAAI,MAAA,CAAO,UAAA,CACjB,OAAAA,CAAAA,CAAE,kBAAA,CAAA,kBAAsBA,CAAAA,CAAE,kBAAA,SAAsB,GAAA,CAAA,CAAK,CAAA,CAC9CA,CAAAA,CAAE,kBACX,CACA,MAAO,EAAEG,CACX,CAUO,SAASE,CAAAA,CACdC,CAAAA,CACAC,CAAAA,CACA,CACA,IAAIC,CAAAA,CAA2B,CAAA,CAAA,EAAM,CAAC,CAAA,CAEtC,MAAMC,CAAAA,CAAe,IAAI,OAAA,CAAeC,CAAAA,EAAY,CAClDF,CAAAA,CAAeE,CACjB,CAAC,CAAA,CAEKC,CAAAA,CAAsBH,CAAAA,CAGtBI,CAAAA,CAAY,MAAA,CAAOR,CAAAA,CAAgB,CAAC,CAAA,CAGpCS,CAAAA,CAAiBC,wCAAAA,CACrBP,CACAxB,CAAAA,CAAkB,aACpB,CAAA,CAIAkB,CAAAA,CAAY,WAAA,CAAYW,CAAAA,CAAWN,CAAY,CAAA,CAE/C,MAAMS,CAAAA,iBAAWR,CAAAA,2BAAS,UAAA,CACpBS,CAAAA,CAAOD,CAAAA,GAAa,KAAA,CAAA,CAAYA,CAAAA,CAAWhC,CAAAA,CAAkB,QAAA,CAEnE,SAASkC,CAAAA,CAAaC,CAAAA,CAAuB,CAC3C,MAAMpB,CAAAA,CAAQoB,CAAAA,GAAW,KAAA,CAAA,CAAYA,CAAAA,CAASZ,CAAAA,CAE9CL,CAAAA,CAAY,GAAA,CAAIW,CAAAA,CAAWd,CAAK,CAAA,CAGhCqB,CAAAA,CAAI,QAAA,CAAW,CAAA,CAAA,CACfR,CAAAA,CAAoB,CACtB,CAEA,MAAMQ,CAAAA,CAAM,CACV,YAAA,CAAAb,CAAAA,CAGA,YAAA,CAAAG,CAAAA,CAEA,IAAA,CAAAO,CAAAA,CAEA,WAAA,CAAa,CAAA,CAAA,CACb,QAAA,CAAU,CAAA,CAAA,CAGV,SAAA,CAAUpB,CAAAA,CAAoC,CAC5C,OAAOK,CAAAA,CAAY,SAAA,CAAUW,CAAAA,CAAW,CAAA,CAAA,EAAMhB,CAAAA,CAAW,CAAC,CAC5D,CAAA,CAGA,QAAA,CAAA,CAAoB,CAClB,MAAO,CAAA,CAAQiB,CACjB,CAAA,CASA,UAAA,CAAWf,CAAAA,CAAgC,CACzC,uBAAOe,CAAAA,6BAAgB,GAAA,mBAAIX,CAAAA,CAAaJ,CAAK,GAC/C,CAAA,CAMA,YAAA,CAAA,CAAuD,CACrD,uBAAOe,CAAAA,6BAAgB,GAAA,mBAAIX,CAAW,GACxC,CAAA,CAQA,WAAA,CAAA,CAAiB,CACf,OAAOD,CAAAA,CAAY,GAAA,CAAIW,CAAS,CAClC,CAAA,CAGA,QAAA,CAASpB,CAAAA,CAA+B,CACtC,EAAA,CAAI,OAAOA,CAAAA,EAAS,UAAA,CAAY,CAC9B,MAAMC,CAAAA,CAAOQ,CAAAA,CAAY,GAAA,CAAOW,CAAS,CAAA,CACzCpB,CAAAA,CAAQA,CAAAA,CAAqBC,CAAI,CACnC,CAEAQ,CAAAA,CAAY,GAAA,CAAIW,CAAAA,CAAWpB,CAAI,CAAA,CAC1B2B,CAAAA,CAAI,UAAA,CAAW3B,CAAI,CAC1B,CAAA,CAMA,MAAA,CAAA,CAA+B,CAC7B,OAAAS,CAAAA,CAAY,GAAA,CAAIW,CAAAA,CAAWN,CAAY,CAAA,iBAChCO,CAAAA,6BAAgB,GAAA,mBAAIX,CAAAA,CAAaI,CAAY,GACtD,CAAA,CAGA,oBAAA,CAAA,CAA6C,CAC3C,EAAA,CAAIa,CAAAA,CAAI,QAAA,EAAYA,CAAAA,CAAI,WAAA,CAAa,MAAA,CAErCA,CAAAA,CAAI,WAAA,CAAc,CAAA,CAAA,CAElB,MAAMC,CAAAA,CAAeD,CAAAA,CAAI,YAAA,CAAa,CAAA,CAItC,EAAA,CAAIC,EAAAA,WAAwB,OAAA,CAC1B,OAAOA,CAAAA,CAAa,IAAA,CAAKH,CAAY,CAAA,CAGrCA,CAAAA,CADeG,CACI,CAEvB,CACF,CAAA,CAEA,OAAKJ,CAAAA,EACHG,CAAAA,CAAI,oBAAA,CAAqB,CAAA,CAGpBA,CACT,CAYO,SAASE,CAAAA,CACdC,CAAAA,CACkC,CAClC,OAAKA,CAAAA,CAAM,oBAAA,CAAqB,CAAA,CASzB,CAPOC,yCAAAA,CACXC,EAAkBF,CAAAA,CAAM,SAAA,CAAUE,CAAa,CAAA,CAChD,CAAA,CAAA,EAAMF,CAAAA,CAAM,WAAA,CAAY,CAAA,CAExB,CAAA,CAAA,EAAMA,CAAAA,CAAM,WAAA,CAAY,CAC1B,CAAA,CAEeA,CAAAA,CAAM,QAAQ,CAC/B,CAUO,SAASG,CAAAA,CAAuBH,CAAAA,CAAuB,CAC5D,OAAOD,CAAAA,CAAeC,CAAK,CAAA,CAAE,CAAC,CAChC,CAUO,SAASI,CAAAA,CAAwBJ,CAAAA,CAAuB,CAC7D,OAAKA,CAAAA,CAAM,oBAAA,CAAqB,CAAA,CAEzBA,CAAAA,CAAM,QACf,CAAA,wLAAA","file":"/Users/choksheaklau/src/react-utils/dist/sharedState.min.cjs","sourcesContent":["/**\n * @packageDocumentation\n *\n * The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n *\n * Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n *\n * This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n *\n * ```\n *   atom()          -->  sharedState()\n *   useAtom()       -->  useSharedState()\n *   useAtomValue()  -->  useSharedStateValue()\n *   useSetAtom()    -->  useSharedStateSetter()\n * ```\n *\n * Example:\n * ```\n *   import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n *\n *   // Create a new shared state in the top level scope.\n *   // The first argument is the default value, which is required.\n *   // The second argument is an options object, and is optional (defaults\n *   // to storing in memory only without any persistence).\n *   const usersState = sharedState(\n *     [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n *   );\n *\n *   export const UsersComponent: React.FC = () => {\n *     // Get both the value and the setter.\n *     const [users, setUsers] = useSharedState(usersState);\n *     ...\n *   };\n *\n *   export const ReadOnlyComponent: React.FC = () => {\n *     // Get the value only.\n *     const users = useSharedStateValue(usersState);\n *     ...\n *   };\n *\n *   export const WriteOnlyComponent: React.FC = () => {\n *     // Get the setter only.\n *     const setUsers = useSharedStateSetter(usersState);\n *     ...\n *   };\n * ```\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/************************************************************************/\n/* Global config                                                        */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateConfig = {\n  /**\n   * Default duration for storage expiration in milliseconds. Initial value\n   * is 30 days, but can be changed to anything.\n   */\n  storeExpiryMs: 30 * MS_PER_DAY,\n\n  /**\n   * True to load from storage only on mount, false (default) to load in\n   * the top level scope when the shared state is defined.\n   */\n  lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/** Convenience function to update global defaults. */\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n  Object.assign(SharedStateConfig, config);\n}\n\n/************************************************************************/\n/* Pub-sub store\n/************************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n  const dataByKey = new Map<string, unknown>();\n  const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n  function notify<T>(key: string, next: T, prev: T): void {\n    const subscribers = subscribersByKey.get(key);\n    if (!subscribers) return;\n\n    // Make copy to protect against mutation during iteration.\n    const copy = Array.from(subscribers.values());\n    for (const subscriber of copy) {\n      try {\n        subscriber(next, prev);\n      } catch (e) {\n        console.error(`Error invoking subscriber:`, e);\n      }\n    }\n  }\n\n  return {\n    // This could be undefined if T includes undefined, else it should never\n    // return undefined because the user has to always specify the default value.\n    get<T>(key: string): T {\n      return dataByKey.get(key) as T;\n    },\n\n    set<T>(key: string, value: T): void {\n      const prev = dataByKey.get(key) as T;\n\n      // Do nothing if no change.\n      if (prev === value) return;\n\n      dataByKey.set(key, value);\n      notify(key, value, prev);\n    },\n\n    delete(key: string): void {\n      dataByKey.delete(key);\n    },\n\n    setNoNotify<T>(key: string, value: T): void {\n      dataByKey.set(key, value);\n    },\n\n    // Subscribe to changes of a specific key\n    subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n      let subscribers = subscribersByKey.get(key);\n      if (!subscribers) {\n        subscribers = new Set();\n        subscribersByKey.set(key, subscribers);\n      }\n\n      // Type coercion: we store Subscriber<unknown>\n      subscribers.add(subscriber as Subscriber<unknown>);\n\n      // Return unsubscribe function\n      return () => {\n        subscribers.delete(subscriber as Subscriber<unknown>);\n        if (subscribers.size === 0) subscribersByKey.delete(key);\n      };\n    },\n  } as const;\n}\n\n/**\n * Ensure we always use the same store. If we create two stores, then the\n * reactive updates will fail.\n */\nfunction getOrCreatePubSubStore() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as {\n      reactUtilsPubSubStore?: ReturnType<typeof createPubSubStore>;\n    };\n    return (\n      t.reactUtilsPubSubStore || (t.reactUtilsPubSubStore = createPubSubStore())\n    );\n  }\n  return createPubSubStore();\n}\n\nconst pubSubStore = getOrCreatePubSubStore();\n\n/************************************************************************/\n/* Shared state implementation                                          */\n/************************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/** Options to configure a shared state. */\nexport type SharedStateOptions<T> = {\n  lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n// Try to make this safe across hot reloads and bundling.\nfunction getNextStateKey() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as { reactUtilsStateKey?: number };\n    t.reactUtilsStateKey = (t.reactUtilsStateKey ?? 0) + 1;\n    return t.reactUtilsStateKey;\n  }\n  return ++stateKey;\n}\n\n/**\n * Create a new shared state object. Put this code at the top level scope:\n *\n * Example:\n * ```\n *   const counterState = sharedState<number>(0);\n * ```\n */\nexport function sharedState<T>(\n  defaultValue: T,\n  options?: SharedStateOptions<T>,\n) {\n  let readyResolve: () => void = () => {};\n\n  const readyPromise = new Promise<void>((resolve) => {\n    readyResolve = resolve;\n  });\n\n  const resolveReadyPromise = readyResolve;\n\n  // We'll make a new key with each hot reload, but that's ok.\n  const pubSubKey = String(getNextStateKey());\n\n  // Use max of 1 storage adapter per shared state.\n  const storageAdapter = getStorageAdapter(\n    options,\n    SharedStateConfig.storeExpiryMs,\n  );\n\n  // Always set the default value first to avoid returning undefineds if that\n  // is not part of T. Don't notify with the default value.\n  pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n  const lazyLoad = options?.lazyLoad;\n  const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n  function completeInit(stored: T | undefined) {\n    const value = stored !== undefined ? stored : defaultValue;\n\n    pubSubStore.set(pubSubKey, value);\n\n    // @ts-expect-error ts(2540) - Assign to readonly property.\n    obj.initDone = true;\n    resolveReadyPromise();\n  }\n\n  const obj = {\n    defaultValue,\n\n    /** Allow users to await for the completion of data init. */\n    readyPromise,\n\n    lazy,\n\n    initStarted: false,\n    initDone: false,\n\n    /** `subscribe` function required by useSyncExternalStore. */\n    subscribe(subscriber: () => void): () => void {\n      return pubSubStore.subscribe(pubSubKey, () => subscriber());\n    },\n\n    /** Returns true if there is a backing store. */\n    hasStore(): boolean {\n      return Boolean(storageAdapter);\n    },\n\n    /**\n     * Set a value directly into the store. Does nothing if there is no\n     * backing store.\n     *\n     * Warning: If you want to set the value properly, you should use\n     * `setValue()` instead which also updates the in-memory copy.\n     */\n    setInStore(value: T): Promise<void> | void {\n      return storageAdapter?.set(STORAGE_KEY, value);\n    },\n\n    /**\n     * Get a value directly from the store. Returns undefined if there is no\n     * backing store.\n     */\n    getFromStore(): Promise<T | undefined> | T | undefined {\n      return storageAdapter?.get(STORAGE_KEY);\n    },\n\n    /**\n     * Get the value of the shared state.\n     *  `getSnapshot` function — must return same ref if value unchanged.\n     * Note that this would return the default value if data init from store is\n     * not completed yet.\n     */\n    getSnapshot(): T {\n      return pubSubStore.get(pubSubKey);\n    },\n\n    /** Set the value of the shared state. */\n    setValue(next: SetStateAction<T>): void {\n      if (typeof next === \"function\") {\n        const prev = pubSubStore.get<T>(pubSubKey);\n        next = (next as (p: T) => T)(prev);\n      }\n\n      pubSubStore.set(pubSubKey, next);\n      void obj.setInStore(next);\n    },\n\n    /**\n     * Remove the value of the shared state. Actually this just sets the value\n     * back to the given default value.\n     */\n    delete(): Promise<void> | void {\n      pubSubStore.set(pubSubKey, defaultValue);\n      return storageAdapter?.set(STORAGE_KEY, defaultValue);\n    },\n\n    /** Initial default handling. */\n    initDefaultValueOnce(): Promise<void> | void {\n      if (obj.initDone || obj.initStarted) return;\n      // @ts-expect-error ts(2540) - Assign to readonly property.\n      obj.initStarted = true;\n\n      const maybePromise = obj.getFromStore();\n\n      // Allow sync vs async code paths. This allows init to be fully completed\n      // from store before the sharedState() function returns.\n      if (maybePromise instanceof Promise) {\n        return maybePromise.then(completeInit);\n      } else {\n        const stored = maybePromise;\n        completeInit(stored);\n      }\n    },\n  } as const;\n\n  if (!lazy) {\n    obj.initDefaultValueOnce();\n  }\n\n  return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/**\n * React hook for subscribing to a key in the global store.\n *\n * Example:\n * ```\n *   const [counter, setCounter] = useSharedState(counterState);\n * ```\n */\nexport function useSharedState<T>(\n  state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n  void state.initDefaultValueOnce();\n\n  const value = useSyncExternalStore(\n    (onStoreChange) => state.subscribe(onStoreChange),\n    () => state.getSnapshot(),\n    // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n    () => state.getSnapshot(),\n  );\n\n  return [value, state.setValue];\n}\n\n/**\n * Same as useSharedState(), but returns the value only.\n *\n * Example:\n * ```\n *   const counter = useSharedStateValue(counterState);\n * ```\n */\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n  return useSharedState(state)[0];\n}\n\n/**\n * Same as useSharedState(), but returns the setter only.\n *\n * Example:\n * ```\n *   const setCounter = useSharedStateSetter(counterState);\n * ```\n */\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n  void state.initDefaultValueOnce();\n\n  return state.setValue;\n}\n"]}

package/sharedState.min.mjs

@@ -1,2 +1,2 @@
-import{MS_PER_DAY as x}from"@choksheak/ts-utils/timeConstants";import{useSyncExternalStore as P}from"react";import{kvStore as p}from"@choksheak/ts-utils/kvStore";import{createLocalStore as m}from"@choksheak/ts-utils/localStore";var S=typeof window>"u";function y(e,a){let{store:o}=e??{};if(!o)return null;if("persistTo"in o&&typeof o.persistTo=="string"&&"key"in o&&typeof o.key=="string"){let n=o.expiryMs||a,t={...o,expiryMs:n};switch(o.persistTo){case"localStorage":return h(t);case"indexedDb":return w(t);default:throw o.persistTo,new Error(`Unknown store.adapter ${o.persistTo}`)}}return o}function h({key:e,expiryMs:a,isValid:o}){let t=m("react-utils",{defaultExpiryMs:a}),r=e+":";return{set:(i,u)=>{S||t.set(r+i,u)},get:i=>{if(S)return;let u=r+i,d=t.get(u);if(d!==void 0&&o&&!o(d)){console.warn(`localStorage adapter: Auto-discard invalid value for ${u}: ${JSON.stringify(d)}`),t.delete(u);return}return d},delete:i=>{S||t.delete(r+i)},clear:()=>{S||t.clear()}}}function w({key:e,expiryMs:a,isValid:o}){let n=e+":";return{set:async(t,r)=>{S||await p.set(n+t,r,a)},get:async t=>{if(S)return;let r=n+t,i=await p.get(r);if(i!==void 0&&o&&!o(i)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}:`,i),await p.delete(r);return}return i},delete:async t=>{S||await p.delete(n+t)},clear:async()=>{S||await p.clear()}}}var b={storeExpiryMs:30*x,lazyLoad:!1};function L(e){Object.assign(b,e)}function v(){let e=new Map,a=new Map;function o(n,t,r){let i=a.get(n);if(!i)return;let u=Array.from(i.values());for(let d of u)try{d(t,r)}catch(l){console.error("Error invoking subscriber:",l)}}return{get(n){return e.get(n)},set(n,t){let r=e.get(n);r!==t&&(e.set(n,t),o(n,t,r))},delete(n){e.delete(n)},setNoNotify(n,t){e.set(n,t)},subscribe(n,t){let r=a.get(n);return r||(r=new Set,a.set(n,r)),r.add(t),()=>{r.delete(t),r.size===0&&a.delete(n)}}}}function A(){if(typeof window<"u"){let e=window.globalThis;return e.reactUtilsPubSubStore||(e.reactUtilsPubSubStore=v())}return v()}var f=A(),g="state",O=0;function B(e,a){let o=()=>{},n=new Promise(s=>{o=s}),t=o,r=String(O++),i=y(a,b.storeExpiryMs);f.setNoNotify(r,e);let u=a?.lazyLoad,d=u!==void 0?u:b.lazyLoad;function l(s){let T=s!==void 0?s:e;f.set(r,T),c.initDone=!0,t()}let c={defaultValue:e,readyPromise:n,lazy:d,initStarted:!1,initDone:!1,subscribe(s){return f.subscribe(r,()=>s())},hasStore(){return!!i},setInStore(s){return i?.set(g,s)},getFromStore(){return i?.get(g)},getSnapshot(){return f.get(r)},setValue(s){if(typeof s=="function"){let T=f.get(r);s=s(T)}f.set(r,s),c.setInStore(s)},delete(){return f.set(r,e),i?.set(g,e)},initDefaultValueOnce(){if(c.initDone||c.initStarted)return;c.initStarted=!0;let s=c.getFromStore();if(s instanceof Promise)return s.then(l);l(s)}};return d||c.initDefaultValueOnce(),c}function D(e){return e.initDefaultValueOnce(),[P(o=>e.subscribe(o),()=>e.getSnapshot(),()=>e.getSnapshot()),e.setValue]}function I(e){return D(e)[0]}function U(e){return e.initDefaultValueOnce(),e.setValue}export{b as SharedStateConfig,L as configureSharedState,B as sharedState,D as useSharedState,U as useSharedStateSetter,I as useSharedStateValue};
+import{MS_PER_DAY as g}from"@choksheak/ts-utils/timeConstants";import{useSyncExternalStore as y}from"react";import{getStorageAdapter as v}from"./storage";const p={storeExpiryMs:30*g,lazyLoad:!1};function E(e){Object.assign(p,e)}function l(){const e=new Map,i=new Map;function S(o,n,t){const a=i.get(o);if(!a)return;const c=Array.from(a.values());for(const d of c)try{d(n,t)}catch(f){console.error("Error invoking subscriber:",f)}}return{get(o){return e.get(o)},set(o,n){const t=e.get(o);t!==n&&(e.set(o,n),S(o,n,t))},delete(o){e.delete(o)},setNoNotify(o,n){e.set(o,n)},subscribe(o,n){let t=i.get(o);return t||(t=new Set,i.set(o,t)),t.add(n),()=>{t.delete(n),t.size===0&&i.delete(o)}}}}function h(){if(typeof window<"u"){const e=window.globalThis;return e.reactUtilsPubSubStore||(e.reactUtilsPubSubStore=l())}return l()}const u=h(),T="state";let m=0;function P(){if(typeof window<"u"){const e=window.globalThis;return e.reactUtilsStateKey=(e.reactUtilsStateKey??0)+1,e.reactUtilsStateKey}return++m}function U(e,i){let S=()=>{};const o=new Promise(r=>{S=r}),n=S,t=String(P()),a=v(i,p.storeExpiryMs);u.setNoNotify(t,e);const c=i?.lazyLoad,d=c!==void 0?c:p.lazyLoad;function f(r){const b=r!==void 0?r:e;u.set(t,b),s.initDone=!0,n()}const s={defaultValue:e,readyPromise:o,lazy:d,initStarted:!1,initDone:!1,subscribe(r){return u.subscribe(t,()=>r())},hasStore(){return!!a},setInStore(r){return a?.set(T,r)},getFromStore(){return a?.get(T)},getSnapshot(){return u.get(t)},setValue(r){if(typeof r=="function"){const b=u.get(t);r=r(b)}u.set(t,r),s.setInStore(r)},delete(){return u.set(t,e),a?.set(T,e)},initDefaultValueOnce(){if(s.initDone||s.initStarted)return;s.initStarted=!0;const r=s.getFromStore();if(r instanceof Promise)return r.then(f);f(r)}};return d||s.initDefaultValueOnce(),s}function w(e){return e.initDefaultValueOnce(),[y(S=>e.subscribe(S),()=>e.getSnapshot(),()=>e.getSnapshot()),e.setValue]}function R(e){return w(e)[0]}function C(e){return e.initDefaultValueOnce(),e.setValue}export{p as SharedStateConfig,E as configureSharedState,U as sharedState,w as useSharedState,C as useSharedStateSetter,R as useSharedStateValue};
 //# sourceMappingURL=sharedState.min.mjs.map

package/sharedState.min.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n *\n * Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n *\n * This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n *\n * ```\n *   atom()          -->  sharedState()\n *   useAtom()       -->  useSharedState()\n *   useAtomValue()  -->  useSharedStateValue()\n *   useSetAtom()    -->  useSharedStateSetter()\n * ```\n *\n * Example:\n * ```\n *   import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n *\n *   // Create a new shared state in the top level scope.\n *   // The first argument is the default value, which is required.\n *   // The second argument is an options object, and is optional (defaults\n *   // to storing in memory only without any persistence).\n *   const usersState = sharedState(\n *     [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n *   );\n *\n *   export const UsersComponent: React.FC = () => {\n *     // Get both the value and the setter.\n *     const [users, setUsers] = useSharedState(usersState);\n *     ...\n *   };\n *\n *   export const ReadOnlyComponent: React.FC = () => {\n *     // Get the value only.\n *     const users = useSharedStateValue(usersState);\n *     ...\n *   };\n *\n *   export const WriteOnlyComponent: React.FC = () => {\n *     // Get the setter only.\n *     const setUsers = useSharedStateSetter(usersState);\n *     ...\n *   };\n * ```\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/************************************************************************/\n/* Global config                                                        */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateConfig = {\n  /**\n   * Default duration for storage expiration in milliseconds. Initial value\n   * is 30 days, but can be changed to anything.\n   */\n  storeExpiryMs: 30 * MS_PER_DAY,\n\n  /**\n   * True to load from storage only on mount, false (default) to load in\n   * the top level scope when the shared state is defined.\n   */\n  lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/** Convenience function to update global defaults. */\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n  Object.assign(SharedStateConfig, config);\n}\n\n/************************************************************************/\n/* Pub-sub store\n/************************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n  const dataByKey = new Map<string, unknown>();\n  const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n  function notify<T>(key: string, next: T, prev: T): void {\n    const subscribers = subscribersByKey.get(key);\n    if (!subscribers) return;\n\n    // Make copy to protect against mutation during iteration.\n    const copy = Array.from(subscribers.values());\n    for (const subscriber of copy) {\n      try {\n        subscriber(next, prev);\n      } catch (e) {\n        console.error(`Error invoking subscriber:`, e);\n      }\n    }\n  }\n\n  return {\n    // This could be undefined if T includes undefined, else it should never\n    // return undefined because the user has to always specify the default value.\n    get<T>(key: string): T {\n      return dataByKey.get(key) as T;\n    },\n\n    set<T>(key: string, value: T): void {\n      const prev = dataByKey.get(key) as T;\n\n      // Do nothing if no change.\n      if (prev === value) return;\n\n      dataByKey.set(key, value);\n      notify(key, value, prev);\n    },\n\n    delete(key: string): void {\n      dataByKey.delete(key);\n    },\n\n    setNoNotify<T>(key: string, value: T): void {\n      dataByKey.set(key, value);\n    },\n\n    // Subscribe to changes of a specific key\n    subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n      let subscribers = subscribersByKey.get(key);\n      if (!subscribers) {\n        subscribers = new Set();\n        subscribersByKey.set(key, subscribers);\n      }\n\n      // Type coercion: we store Subscriber<unknown>\n      subscribers.add(subscriber as Subscriber<unknown>);\n\n      // Return unsubscribe function\n      return () => {\n        subscribers.delete(subscriber as Subscriber<unknown>);\n        if (subscribers.size === 0) subscribersByKey.delete(key);\n      };\n    },\n  } as const;\n}\n\n/**\n * Ensure we always use the same store. If we create two stores, then the\n * reactive updates will fail.\n */\nfunction getOrCreatePubSubStore() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as unknown as {\n      reactUtilsPubSubStore: ReturnType<typeof createPubSubStore> | undefined;\n    };\n    return (\n      t.reactUtilsPubSubStore || (t.reactUtilsPubSubStore = createPubSubStore())\n    );\n  }\n  return createPubSubStore();\n}\n\nconst pubSubStore = getOrCreatePubSubStore();\n\n/************************************************************************/\n/* Shared state implementation                                          */\n/************************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/** Options to configure a shared state. */\nexport type SharedStateOptions<T> = {\n  lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/**\n * Create a new shared state object. Put this code at the top level scope:\n *\n * Example:\n * ```\n *   const counterState = sharedState<number>(0);\n * ```\n */\nexport function sharedState<T>(\n  defaultValue: T,\n  options?: SharedStateOptions<T>,\n) {\n  let readyResolve: () => void = () => {};\n\n  const readyPromise = new Promise<void>((resolve) => {\n    readyResolve = resolve;\n  });\n\n  const resolveReadyPromise = readyResolve;\n\n  const pubSubKey = String(stateKey++);\n\n  // Use max of 1 storage adapter per shared state.\n  const storageAdapter = getStorageAdapter(\n    options,\n    SharedStateConfig.storeExpiryMs,\n  );\n\n  // Always set the default value first to avoid returning undefineds if that\n  // is not part of T. Don't notify with the default value.\n  pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n  const lazyLoad = options?.lazyLoad;\n  const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n  function completeInit(stored: T | undefined) {\n    const value = stored !== undefined ? stored : defaultValue;\n\n    pubSubStore.set(pubSubKey, value);\n\n    // @ts-expect-error ts(2540) - Assign to readonly property.\n    obj.initDone = true;\n    resolveReadyPromise();\n  }\n\n  const obj = {\n    defaultValue,\n\n    /** Allow users to await for the completion of data init. */\n    readyPromise,\n\n    lazy,\n\n    initStarted: false,\n    initDone: false,\n\n    /** `subscribe` function required by useSyncExternalStore. */\n    subscribe(subscriber: () => void): () => void {\n      return pubSubStore.subscribe(pubSubKey, () => subscriber());\n    },\n\n    /** Returns true if there is a backing store. */\n    hasStore(): boolean {\n      return Boolean(storageAdapter);\n    },\n\n    /**\n     * Set a value directly into the store. Does nothing if there is no\n     * backing store.\n     *\n     * Warning: If you want to set the value properly, you should use\n     * `setValue()` instead which also updates the in-memory copy.\n     */\n    setInStore(value: T): Promise<void> | void {\n      return storageAdapter?.set(STORAGE_KEY, value);\n    },\n\n    /**\n     * Get a value directly from the store. Returns undefined if there is no\n     * backing store.\n     */\n    getFromStore(): Promise<T | undefined> | T | undefined {\n      return storageAdapter?.get(STORAGE_KEY);\n    },\n\n    /**\n     * Get the value of the shared state.\n     *  `getSnapshot` function — must return same ref if value unchanged.\n     * Note that this would return the default value if data init from store is\n     * not completed yet.\n     */\n    getSnapshot(): T {\n      return pubSubStore.get(pubSubKey);\n    },\n\n    /** Set the value of the shared state. */\n    setValue(next: SetStateAction<T>): void {\n      if (typeof next === \"function\") {\n        const prev = pubSubStore.get<T>(pubSubKey);\n        next = (next as (p: T) => T)(prev);\n      }\n\n      pubSubStore.set(pubSubKey, next);\n      void obj.setInStore(next);\n    },\n\n    /**\n     * Remove the value of the shared state. Actually this just sets the value\n     * back to the given default value.\n     */\n    delete(): Promise<void> | void {\n      pubSubStore.set(pubSubKey, defaultValue);\n      return storageAdapter?.set(STORAGE_KEY, defaultValue);\n    },\n\n    /** Initial default handling. */\n    initDefaultValueOnce(): Promise<void> | void {\n      if (obj.initDone || obj.initStarted) return;\n      // @ts-expect-error ts(2540) - Assign to readonly property.\n      obj.initStarted = true;\n\n      const maybePromise = obj.getFromStore();\n\n      // Allow sync vs async code paths. This allows init to be fully completed\n      // from store before the sharedState() function returns.\n      if (maybePromise instanceof Promise) {\n        return maybePromise.then(completeInit);\n      } else {\n        const stored = maybePromise;\n        completeInit(stored);\n      }\n    },\n  } as const;\n\n  if (!lazy) {\n    obj.initDefaultValueOnce();\n  }\n\n  return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/**\n * React hook for subscribing to a key in the global store.\n *\n * Example:\n * ```\n *   const [counter, setCounter] = useSharedState(counterState);\n * ```\n */\nexport function useSharedState<T>(\n  state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n  void state.initDefaultValueOnce();\n\n  const value = useSyncExternalStore(\n    (onStoreChange) => state.subscribe(onStoreChange),\n    () => state.getSnapshot(),\n    // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n    () => state.getSnapshot(),\n  );\n\n  return [value, state.setValue];\n}\n\n/**\n * Same as useSharedState(), but returns the value only.\n *\n * Example:\n * ```\n *   const counter = useSharedStateValue(counterState);\n * ```\n */\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n  return useSharedState(state)[0];\n}\n\n/**\n * Same as useSharedState(), but returns the setter only.\n *\n * Example:\n * ```\n *   const setCounter = useSharedStateSetter(counterState);\n * ```\n */\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n  void state.initDefaultValueOnce();\n\n  return state.setValue;\n}\n","/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"],"mappings":"AAwDA,OAAS,cAAAA,MAAkB,oCAC3B,OAAmC,wBAAAC,MAA4B,QC7C/D,OAAS,WAAAC,MAAe,8BACxB,OAAS,oBAAAC,MAAwB,iCAkCjC,IAAMC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAIvB,IAAMC,EAAUZ,EAFG,cAE0B,CAC3C,gBAAiBM,CACnB,CAAC,EAGKO,EAAYH,EAAM,IAExB,MAAO,CACL,IAAK,CAACA,EAAaI,IAAmB,CAChCb,GAGJW,EAAQ,IAAIC,EAAYH,EAAKI,CAAK,CACpC,EAEA,IAAMJ,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQF,EAAQ,IAAOG,CAAO,EAGpC,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,wDAAwDC,CAAO,KAAK,KAAK,UAAUD,CAAK,CAAC,EAC3F,EACAF,EAAQ,OAAOG,CAAO,EACtB,MACF,CAEA,OAAOD,CACT,EAEA,OAASJ,GAAsB,CACzBT,GAEJW,EAAQ,OAAOC,EAAYH,CAAG,CAChC,EAGA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,IAAME,EAAYH,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaI,IAA4B,CAC/Cb,GAGJ,MAAMF,EAAQ,IAAIc,EAAYH,EAAKI,EAAOR,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQ,MAAMf,EAAQ,IAAOgB,CAAO,EAG1C,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,qDAAqDJ,CAAG,IACxDI,CACF,EACA,MAAMf,EAAQ,OAAOgB,CAAO,EAC5B,MACF,CAEA,OAAOD,CACT,EACA,OAAQ,MAAOJ,GAA+B,CACxCT,GAEJ,MAAMF,EAAQ,OAAOc,EAAYH,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAMF,EAAQ,MAAM,CACtB,CACF,CACF,CDnIO,IAAMiB,EAAoB,CAK/B,cAAe,GAAKC,EAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOH,EAAmBG,CAAM,CACzC,CAQA,SAASC,GAAoB,CAC3B,IAAMC,EAAY,IAAI,IAChBC,EAAmB,IAAI,IAE7B,SAASC,EAAUC,EAAaC,EAASC,EAAe,CACtD,IAAMC,EAAcL,EAAiB,IAAIE,CAAG,EAC5C,GAAI,CAACG,EAAa,OAGlB,IAAMC,EAAO,MAAM,KAAKD,EAAY,OAAO,CAAC,EAC5C,QAAWE,KAAcD,EACvB,GAAI,CACFC,EAAWJ,EAAMC,CAAI,CACvB,OAASI,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,IAAON,EAAgB,CACrB,OAAOH,EAAU,IAAIG,CAAG,CAC1B,EAEA,IAAOA,EAAaO,EAAgB,CAClC,IAAML,EAAOL,EAAU,IAAIG,CAAG,EAG1BE,IAASK,IAEbV,EAAU,IAAIG,EAAKO,CAAK,EACxBR,EAAOC,EAAKO,EAAOL,CAAI,EACzB,EAEA,OAAOF,EAAmB,CACxBH,EAAU,OAAOG,CAAG,CACtB,EAEA,YAAeA,EAAaO,EAAgB,CAC1CV,EAAU,IAAIG,EAAKO,CAAK,CAC1B,EAGA,UAAaP,EAAaK,EAAuC,CAC/D,IAAIF,EAAcL,EAAiB,IAAIE,CAAG,EAC1C,OAAKG,IACHA,EAAc,IAAI,IAClBL,EAAiB,IAAIE,EAAKG,CAAW,GAIvCA,EAAY,IAAIE,CAAiC,EAG1C,IAAM,CACXF,EAAY,OAAOE,CAAiC,EAChDF,EAAY,OAAS,GAAGL,EAAiB,OAAOE,CAAG,CACzD,CACF,CACF,CACF,CAMA,SAASQ,GAAyB,CAChC,GAAI,OAAO,OAAW,IAAa,CACjC,IAAMC,EAAI,OAAO,WAGjB,OACEA,EAAE,wBAA0BA,EAAE,sBAAwBb,EAAkB,EAE5E,CACA,OAAOA,EAAkB,CAC3B,CAEA,IAAMc,EAAcF,EAAuB,EAMrCG,EAAc,QAOhBC,EAAW,EAUR,SAASC,EACdC,EACAC,EACA,CACA,IAAIC,EAA2B,IAAM,CAAC,EAEhCC,EAAe,IAAI,QAAeC,GAAY,CAClDF,EAAeE,CACjB,CAAC,EAEKC,EAAsBH,EAEtBI,EAAY,OAAOR,GAAU,EAG7BS,EAAiBC,EACrBP,EACAvB,EAAkB,aACpB,EAIAkB,EAAY,YAAYU,EAAWN,CAAY,EAE/C,IAAMS,EAAWR,GAAS,SACpBS,EAAOD,IAAa,OAAYA,EAAW/B,EAAkB,SAEnE,SAASiC,EAAaC,EAAuB,CAC3C,IAAMnB,EAAQmB,IAAW,OAAYA,EAASZ,EAE9CJ,EAAY,IAAIU,EAAWb,CAAK,EAGhCoB,EAAI,SAAW,GACfR,EAAoB,CACtB,CAEA,IAAMQ,EAAM,CACV,aAAAb,EAGA,aAAAG,EAEA,KAAAO,EAEA,YAAa,GACb,SAAU,GAGV,UAAUnB,EAAoC,CAC5C,OAAOK,EAAY,UAAUU,EAAW,IAAMf,EAAW,CAAC,CAC5D,EAGA,UAAoB,CAClB,MAAO,EAAQgB,CACjB,EASA,WAAWd,EAAgC,CACzC,OAAOc,GAAgB,IAAIV,EAAaJ,CAAK,CAC/C,EAMA,cAAuD,CACrD,OAAOc,GAAgB,IAAIV,CAAW,CACxC,EAQA,aAAiB,CACf,OAAOD,EAAY,IAAIU,CAAS,CAClC,EAGA,SAASnB,EAA+B,CACtC,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMC,EAAOQ,EAAY,IAAOU,CAAS,EACzCnB,EAAQA,EAAqBC,CAAI,CACnC,CAEAQ,EAAY,IAAIU,EAAWnB,CAAI,EAC1B0B,EAAI,WAAW1B,CAAI,CAC1B,EAMA,QAA+B,CAC7B,OAAAS,EAAY,IAAIU,EAAWN,CAAY,EAChCO,GAAgB,IAAIV,EAAaG,CAAY,CACtD,EAGA,sBAA6C,CAC3C,GAAIa,EAAI,UAAYA,EAAI,YAAa,OAErCA,EAAI,YAAc,GAElB,IAAMC,EAAeD,EAAI,aAAa,EAItC,GAAIC,aAAwB,QAC1B,OAAOA,EAAa,KAAKH,CAAY,EAGrCA,EADeG,CACI,CAEvB,CACF,EAEA,OAAKJ,GACHG,EAAI,qBAAqB,EAGpBA,CACT,CAYO,SAASE,EACdC,EACkC,CAClC,OAAKA,EAAM,qBAAqB,EASzB,CAPOC,EACXC,GAAkBF,EAAM,UAAUE,CAAa,EAChD,IAAMF,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,QAAQ,CAC/B,CAUO,SAASG,EAAuBH,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASI,EAAwBJ,EAAuB,CAC7D,OAAKA,EAAM,qBAAqB,EAEzBA,EAAM,QACf","names":["MS_PER_DAY","useSyncExternalStore","kvStore","createLocalStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","keyPrefix","value","fullKey","SharedStateConfig","MS_PER_DAY","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","getOrCreatePubSubStore","t","pubSubStore","STORAGE_KEY","stateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","getStorageAdapter","lazyLoad","lazy","completeInit","stored","obj","maybePromise","useSharedState","state","useSyncExternalStore","onStoreChange","useSharedStateValue","useSharedStateSetter"]}
+{"version":3,"sources":["../src/sharedState.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n *\n * Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n *\n * This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n *\n * ```\n *   atom()          -->  sharedState()\n *   useAtom()       -->  useSharedState()\n *   useAtomValue()  -->  useSharedStateValue()\n *   useSetAtom()    -->  useSharedStateSetter()\n * ```\n *\n * Example:\n * ```\n *   import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n *\n *   // Create a new shared state in the top level scope.\n *   // The first argument is the default value, which is required.\n *   // The second argument is an options object, and is optional (defaults\n *   // to storing in memory only without any persistence).\n *   const usersState = sharedState(\n *     [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n *   );\n *\n *   export const UsersComponent: React.FC = () => {\n *     // Get both the value and the setter.\n *     const [users, setUsers] = useSharedState(usersState);\n *     ...\n *   };\n *\n *   export const ReadOnlyComponent: React.FC = () => {\n *     // Get the value only.\n *     const users = useSharedStateValue(usersState);\n *     ...\n *   };\n *\n *   export const WriteOnlyComponent: React.FC = () => {\n *     // Get the setter only.\n *     const setUsers = useSharedStateSetter(usersState);\n *     ...\n *   };\n * ```\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/************************************************************************/\n/* Global config                                                        */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateConfig = {\n  /**\n   * Default duration for storage expiration in milliseconds. Initial value\n   * is 30 days, but can be changed to anything.\n   */\n  storeExpiryMs: 30 * MS_PER_DAY,\n\n  /**\n   * True to load from storage only on mount, false (default) to load in\n   * the top level scope when the shared state is defined.\n   */\n  lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/** Convenience function to update global defaults. */\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n  Object.assign(SharedStateConfig, config);\n}\n\n/************************************************************************/\n/* Pub-sub store\n/************************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n  const dataByKey = new Map<string, unknown>();\n  const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n  function notify<T>(key: string, next: T, prev: T): void {\n    const subscribers = subscribersByKey.get(key);\n    if (!subscribers) return;\n\n    // Make copy to protect against mutation during iteration.\n    const copy = Array.from(subscribers.values());\n    for (const subscriber of copy) {\n      try {\n        subscriber(next, prev);\n      } catch (e) {\n        console.error(`Error invoking subscriber:`, e);\n      }\n    }\n  }\n\n  return {\n    // This could be undefined if T includes undefined, else it should never\n    // return undefined because the user has to always specify the default value.\n    get<T>(key: string): T {\n      return dataByKey.get(key) as T;\n    },\n\n    set<T>(key: string, value: T): void {\n      const prev = dataByKey.get(key) as T;\n\n      // Do nothing if no change.\n      if (prev === value) return;\n\n      dataByKey.set(key, value);\n      notify(key, value, prev);\n    },\n\n    delete(key: string): void {\n      dataByKey.delete(key);\n    },\n\n    setNoNotify<T>(key: string, value: T): void {\n      dataByKey.set(key, value);\n    },\n\n    // Subscribe to changes of a specific key\n    subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n      let subscribers = subscribersByKey.get(key);\n      if (!subscribers) {\n        subscribers = new Set();\n        subscribersByKey.set(key, subscribers);\n      }\n\n      // Type coercion: we store Subscriber<unknown>\n      subscribers.add(subscriber as Subscriber<unknown>);\n\n      // Return unsubscribe function\n      return () => {\n        subscribers.delete(subscriber as Subscriber<unknown>);\n        if (subscribers.size === 0) subscribersByKey.delete(key);\n      };\n    },\n  } as const;\n}\n\n/**\n * Ensure we always use the same store. If we create two stores, then the\n * reactive updates will fail.\n */\nfunction getOrCreatePubSubStore() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as {\n      reactUtilsPubSubStore?: ReturnType<typeof createPubSubStore>;\n    };\n    return (\n      t.reactUtilsPubSubStore || (t.reactUtilsPubSubStore = createPubSubStore())\n    );\n  }\n  return createPubSubStore();\n}\n\nconst pubSubStore = getOrCreatePubSubStore();\n\n/************************************************************************/\n/* Shared state implementation                                          */\n/************************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/** Options to configure a shared state. */\nexport type SharedStateOptions<T> = {\n  lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n// Try to make this safe across hot reloads and bundling.\nfunction getNextStateKey() {\n  if (typeof window !== \"undefined\") {\n    const t = window.globalThis as { reactUtilsStateKey?: number };\n    t.reactUtilsStateKey = (t.reactUtilsStateKey ?? 0) + 1;\n    return t.reactUtilsStateKey;\n  }\n  return ++stateKey;\n}\n\n/**\n * Create a new shared state object. Put this code at the top level scope:\n *\n * Example:\n * ```\n *   const counterState = sharedState<number>(0);\n * ```\n */\nexport function sharedState<T>(\n  defaultValue: T,\n  options?: SharedStateOptions<T>,\n) {\n  let readyResolve: () => void = () => {};\n\n  const readyPromise = new Promise<void>((resolve) => {\n    readyResolve = resolve;\n  });\n\n  const resolveReadyPromise = readyResolve;\n\n  // We'll make a new key with each hot reload, but that's ok.\n  const pubSubKey = String(getNextStateKey());\n\n  // Use max of 1 storage adapter per shared state.\n  const storageAdapter = getStorageAdapter(\n    options,\n    SharedStateConfig.storeExpiryMs,\n  );\n\n  // Always set the default value first to avoid returning undefineds if that\n  // is not part of T. Don't notify with the default value.\n  pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n  const lazyLoad = options?.lazyLoad;\n  const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n  function completeInit(stored: T | undefined) {\n    const value = stored !== undefined ? stored : defaultValue;\n\n    pubSubStore.set(pubSubKey, value);\n\n    // @ts-expect-error ts(2540) - Assign to readonly property.\n    obj.initDone = true;\n    resolveReadyPromise();\n  }\n\n  const obj = {\n    defaultValue,\n\n    /** Allow users to await for the completion of data init. */\n    readyPromise,\n\n    lazy,\n\n    initStarted: false,\n    initDone: false,\n\n    /** `subscribe` function required by useSyncExternalStore. */\n    subscribe(subscriber: () => void): () => void {\n      return pubSubStore.subscribe(pubSubKey, () => subscriber());\n    },\n\n    /** Returns true if there is a backing store. */\n    hasStore(): boolean {\n      return Boolean(storageAdapter);\n    },\n\n    /**\n     * Set a value directly into the store. Does nothing if there is no\n     * backing store.\n     *\n     * Warning: If you want to set the value properly, you should use\n     * `setValue()` instead which also updates the in-memory copy.\n     */\n    setInStore(value: T): Promise<void> | void {\n      return storageAdapter?.set(STORAGE_KEY, value);\n    },\n\n    /**\n     * Get a value directly from the store. Returns undefined if there is no\n     * backing store.\n     */\n    getFromStore(): Promise<T | undefined> | T | undefined {\n      return storageAdapter?.get(STORAGE_KEY);\n    },\n\n    /**\n     * Get the value of the shared state.\n     *  `getSnapshot` function — must return same ref if value unchanged.\n     * Note that this would return the default value if data init from store is\n     * not completed yet.\n     */\n    getSnapshot(): T {\n      return pubSubStore.get(pubSubKey);\n    },\n\n    /** Set the value of the shared state. */\n    setValue(next: SetStateAction<T>): void {\n      if (typeof next === \"function\") {\n        const prev = pubSubStore.get<T>(pubSubKey);\n        next = (next as (p: T) => T)(prev);\n      }\n\n      pubSubStore.set(pubSubKey, next);\n      void obj.setInStore(next);\n    },\n\n    /**\n     * Remove the value of the shared state. Actually this just sets the value\n     * back to the given default value.\n     */\n    delete(): Promise<void> | void {\n      pubSubStore.set(pubSubKey, defaultValue);\n      return storageAdapter?.set(STORAGE_KEY, defaultValue);\n    },\n\n    /** Initial default handling. */\n    initDefaultValueOnce(): Promise<void> | void {\n      if (obj.initDone || obj.initStarted) return;\n      // @ts-expect-error ts(2540) - Assign to readonly property.\n      obj.initStarted = true;\n\n      const maybePromise = obj.getFromStore();\n\n      // Allow sync vs async code paths. This allows init to be fully completed\n      // from store before the sharedState() function returns.\n      if (maybePromise instanceof Promise) {\n        return maybePromise.then(completeInit);\n      } else {\n        const stored = maybePromise;\n        completeInit(stored);\n      }\n    },\n  } as const;\n\n  if (!lazy) {\n    obj.initDefaultValueOnce();\n  }\n\n  return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/**\n * React hook for subscribing to a key in the global store.\n *\n * Example:\n * ```\n *   const [counter, setCounter] = useSharedState(counterState);\n * ```\n */\nexport function useSharedState<T>(\n  state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n  void state.initDefaultValueOnce();\n\n  const value = useSyncExternalStore(\n    (onStoreChange) => state.subscribe(onStoreChange),\n    () => state.getSnapshot(),\n    // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n    () => state.getSnapshot(),\n  );\n\n  return [value, state.setValue];\n}\n\n/**\n * Same as useSharedState(), but returns the value only.\n *\n * Example:\n * ```\n *   const counter = useSharedStateValue(counterState);\n * ```\n */\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n  return useSharedState(state)[0];\n}\n\n/**\n * Same as useSharedState(), but returns the setter only.\n *\n * Example:\n * ```\n *   const setCounter = useSharedStateSetter(counterState);\n * ```\n */\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n  void state.initDefaultValueOnce();\n\n  return state.setValue;\n}\n"],"mappings":"AAwDA,OAAS,cAAAA,MAAkB,oCAC3B,OAAmC,wBAAAC,MAA4B,QAE/D,OAAS,qBAAAC,MAAyC,YAS3C,MAAMC,EAAoB,CAK/B,cAAe,GAAKH,EAMpB,SAAU,EACZ,EAKO,SAASI,EAAqBC,EAAoC,CACvE,OAAO,OAAOF,EAAmBE,CAAM,CACzC,CAQA,SAASC,GAAoB,CAC3B,MAAMC,EAAY,IAAI,IAChBC,EAAmB,IAAI,IAE7B,SAASC,EAAUC,EAAaC,EAASC,EAAe,CACtD,MAAMC,EAAcL,EAAiB,IAAIE,CAAG,EAC5C,GAAI,CAACG,EAAa,OAGlB,MAAMC,EAAO,MAAM,KAAKD,EAAY,OAAO,CAAC,EAC5C,UAAWE,KAAcD,EACvB,GAAI,CACFC,EAAWJ,EAAMC,CAAI,CACvB,OAASI,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,IAAON,EAAgB,CACrB,OAAOH,EAAU,IAAIG,CAAG,CAC1B,EAEA,IAAOA,EAAaO,EAAgB,CAClC,MAAML,EAAOL,EAAU,IAAIG,CAAG,EAG1BE,IAASK,IAEbV,EAAU,IAAIG,EAAKO,CAAK,EACxBR,EAAOC,EAAKO,EAAOL,CAAI,EACzB,EAEA,OAAOF,EAAmB,CACxBH,EAAU,OAAOG,CAAG,CACtB,EAEA,YAAeA,EAAaO,EAAgB,CAC1CV,EAAU,IAAIG,EAAKO,CAAK,CAC1B,EAGA,UAAaP,EAAaK,EAAuC,CAC/D,IAAIF,EAAcL,EAAiB,IAAIE,CAAG,EAC1C,OAAKG,IACHA,EAAc,IAAI,IAClBL,EAAiB,IAAIE,EAAKG,CAAW,GAIvCA,EAAY,IAAIE,CAAiC,EAG1C,IAAM,CACXF,EAAY,OAAOE,CAAiC,EAChDF,EAAY,OAAS,GAAGL,EAAiB,OAAOE,CAAG,CACzD,CACF,CACF,CACF,CAMA,SAASQ,GAAyB,CAChC,GAAI,OAAO,OAAW,IAAa,CACjC,MAAMC,EAAI,OAAO,WAGjB,OACEA,EAAE,wBAA0BA,EAAE,sBAAwBb,EAAkB,EAE5E,CACA,OAAOA,EAAkB,CAC3B,CAEA,MAAMc,EAAcF,EAAuB,EAMrCG,EAAc,QAOpB,IAAIC,EAAW,EAGf,SAASC,GAAkB,CACzB,GAAI,OAAO,OAAW,IAAa,CACjC,MAAMJ,EAAI,OAAO,WACjB,OAAAA,EAAE,oBAAsBA,EAAE,oBAAsB,GAAK,EAC9CA,EAAE,kBACX,CACA,MAAO,EAAEG,CACX,CAUO,SAASE,EACdC,EACAC,EACA,CACA,IAAIC,EAA2B,IAAM,CAAC,EAEtC,MAAMC,EAAe,IAAI,QAAeC,GAAY,CAClDF,EAAeE,CACjB,CAAC,EAEKC,EAAsBH,EAGtBI,EAAY,OAAOR,EAAgB,CAAC,EAGpCS,EAAiB9B,EACrBwB,EACAvB,EAAkB,aACpB,EAIAiB,EAAY,YAAYW,EAAWN,CAAY,EAE/C,MAAMQ,EAAWP,GAAS,SACpBQ,EAAOD,IAAa,OAAYA,EAAW9B,EAAkB,SAEnE,SAASgC,EAAaC,EAAuB,CAC3C,MAAMnB,EAAQmB,IAAW,OAAYA,EAASX,EAE9CL,EAAY,IAAIW,EAAWd,CAAK,EAGhCoB,EAAI,SAAW,GACfP,EAAoB,CACtB,CAEA,MAAMO,EAAM,CACV,aAAAZ,EAGA,aAAAG,EAEA,KAAAM,EAEA,YAAa,GACb,SAAU,GAGV,UAAUnB,EAAoC,CAC5C,OAAOK,EAAY,UAAUW,EAAW,IAAMhB,EAAW,CAAC,CAC5D,EAGA,UAAoB,CAClB,MAAO,EAAQiB,CACjB,EASA,WAAWf,EAAgC,CACzC,OAAOe,GAAgB,IAAIX,EAAaJ,CAAK,CAC/C,EAMA,cAAuD,CACrD,OAAOe,GAAgB,IAAIX,CAAW,CACxC,EAQA,aAAiB,CACf,OAAOD,EAAY,IAAIW,CAAS,CAClC,EAGA,SAASpB,EAA+B,CACtC,GAAI,OAAOA,GAAS,WAAY,CAC9B,MAAMC,EAAOQ,EAAY,IAAOW,CAAS,EACzCpB,EAAQA,EAAqBC,CAAI,CACnC,CAEAQ,EAAY,IAAIW,EAAWpB,CAAI,EAC1B0B,EAAI,WAAW1B,CAAI,CAC1B,EAMA,QAA+B,CAC7B,OAAAS,EAAY,IAAIW,EAAWN,CAAY,EAChCO,GAAgB,IAAIX,EAAaI,CAAY,CACtD,EAGA,sBAA6C,CAC3C,GAAIY,EAAI,UAAYA,EAAI,YAAa,OAErCA,EAAI,YAAc,GAElB,MAAMC,EAAeD,EAAI,aAAa,EAItC,GAAIC,aAAwB,QAC1B,OAAOA,EAAa,KAAKH,CAAY,EAGrCA,EADeG,CACI,CAEvB,CACF,EAEA,OAAKJ,GACHG,EAAI,qBAAqB,EAGpBA,CACT,CAYO,SAASE,EACdC,EACkC,CAClC,OAAKA,EAAM,qBAAqB,EASzB,CAPOvC,EACXwC,GAAkBD,EAAM,UAAUC,CAAa,EAChD,IAAMD,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,QAAQ,CAC/B,CAUO,SAASE,EAAuBF,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASG,EAAwBH,EAAuB,CAC7D,OAAKA,EAAM,qBAAqB,EAEzBA,EAAM,QACf","names":["MS_PER_DAY","useSyncExternalStore","getStorageAdapter","SharedStateConfig","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","getOrCreatePubSubStore","t","pubSubStore","STORAGE_KEY","stateKey","getNextStateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","lazyLoad","lazy","completeInit","stored","obj","maybePromise","useSharedState","state","onStoreChange","useSharedStateValue","useSharedStateSetter"]}

package/sharedState.mjs

@@ -1,108 +1,7 @@
-// src/sharedState.ts
 import { MS_PER_DAY } from "@choksheak/ts-utils/timeConstants";
 import { useSyncExternalStore } from "react";
-
-// src/storage.ts
-import { kvStore } from "@choksheak/ts-utils/kvStore";
-import { createLocalStore } from "@choksheak/ts-utils/localStore";
-var IS_NOT_BROWSER = typeof window === "undefined";
-function getStorageAdapter(options, defaultStoreExpiryMs) {
-  const { store } = options ?? {};
-  if (!store) {
-    return null;
-  }
-  if ("persistTo" in store && typeof store.persistTo === "string" && "key" in store && typeof store.key === "string") {
-    const expiryMs = store.expiryMs || defaultStoreExpiryMs;
-    const config = { ...store, expiryMs };
-    switch (store.persistTo) {
-      case "localStorage":
-        return localStoreAdapter(config);
-      case "indexedDb":
-        return kvStoreAdapter(config);
-      default:
-        store.persistTo;
-        throw new Error(`Unknown store.adapter ${store.persistTo}`);
-    }
-  }
-  return store;
-}
-function localStoreAdapter({
-  key,
-  expiryMs,
-  isValid
-}) {
-  const STORE_NAME = "react-utils";
-  const adapter = createLocalStore(STORE_NAME, {
-    defaultExpiryMs: expiryMs
-  });
-  const keyPrefix = key + ":";
-  return {
-    set: (key2, value) => {
-      if (IS_NOT_BROWSER) return;
-      adapter.set(keyPrefix + key2, value);
-    },
-    get: (key2) => {
-      if (IS_NOT_BROWSER) return void 0;
-      const fullKey = keyPrefix + key2;
-      const value = adapter.get(fullKey);
-      if (value !== void 0 && isValid && !isValid(value)) {
-        console.warn(
-          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`
-        );
-        adapter.delete(fullKey);
-        return void 0;
-      }
-      return value;
-    },
-    delete: (key2) => {
-      if (IS_NOT_BROWSER) return;
-      adapter.delete(keyPrefix + key2);
-    },
-    /** Note that this will clear all keys in all shared states. */
-    clear: () => {
-      if (IS_NOT_BROWSER) return;
-      adapter.clear();
-    }
-  };
-}
-function kvStoreAdapter({
-  key,
-  expiryMs,
-  isValid
-}) {
-  const keyPrefix = key + ":";
-  return {
-    set: async (key2, value) => {
-      if (IS_NOT_BROWSER) return;
-      await kvStore.set(keyPrefix + key2, value, expiryMs);
-    },
-    get: async (key2) => {
-      if (IS_NOT_BROWSER) return void 0;
-      const fullKey = keyPrefix + key2;
-      const value = await kvStore.get(fullKey);
-      if (value !== void 0 && isValid && !isValid(value)) {
-        console.warn(
-          `indexedDb adapter: Auto-discard invalid value for ${key2}:`,
-          value
-        );
-        await kvStore.delete(fullKey);
-        return void 0;
-      }
-      return value;
-    },
-    delete: async (key2) => {
-      if (IS_NOT_BROWSER) return;
-      await kvStore.delete(keyPrefix + key2);
-    },
-    clear: async () => {
-      if (IS_NOT_BROWSER) return;
-      await kvStore.clear();
-    }
-  };
-}
-
-// src/sharedState.ts
-var SharedStateConfig = {
+import { getStorageAdapter } from "./storage";
+const SharedStateConfig = {
   /**
    * Default duration for storage expiration in milliseconds. Initial value
    * is 30 days, but can be changed to anything.
@@ -172,9 +71,17 @@ function getOrCreatePubSubStore() {
   }
   return createPubSubStore();
 }
-var pubSubStore = getOrCreatePubSubStore();
-var STORAGE_KEY = "state";
-var stateKey = 0;
+const pubSubStore = getOrCreatePubSubStore();
+const STORAGE_KEY = "state";
+let stateKey = 0;
+function getNextStateKey() {
+  if (typeof window !== "undefined") {
+    const t = window.globalThis;
+    t.reactUtilsStateKey = (t.reactUtilsStateKey ?? 0) + 1;
+    return t.reactUtilsStateKey;
+  }
+  return ++stateKey;
+}
 function sharedState(defaultValue, options) {
   let readyResolve = () => {
   };
@@ -182,7 +89,7 @@ function sharedState(defaultValue, options) {
     readyResolve = resolve;
   });
   const resolveReadyPromise = readyResolve;
-  const pubSubKey = String(stateKey++);
+  const pubSubKey = String(getNextStateKey());
   const storageAdapter = getStorageAdapter(
     options,
     SharedStateConfig.storeExpiryMs

package/storage.cjs

@@ -1,35 +1,8 @@
-"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/storage.ts
-var storage_exports = {};
-__export(storage_exports, {
-  getStorageAdapter: () => getStorageAdapter,
-  kvStoreAdapter: () => kvStoreAdapter,
-  localStoreAdapter: () => localStoreAdapter
-});
-module.exports = __toCommonJS(storage_exports);
-var import_kvStore = require("@choksheak/ts-utils/kvStore");
-var import_localStore = require("@choksheak/ts-utils/localStore");
-var IS_NOT_BROWSER = typeof window === "undefined";
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _kvStore = require('@choksheak/ts-utils/kvStore');
+var _localStore = require('@choksheak/ts-utils/localStore');
+const IS_NOT_BROWSER = typeof window === "undefined";
 function getStorageAdapter(options, defaultStoreExpiryMs) {
-  const { store } = options ?? {};
+  const { store } = _nullishCoalesce(options, () => ( {}));
   if (!store) {
     return null;
   }
@@ -54,7 +27,7 @@ function localStoreAdapter({
   isValid
 }) {
   const STORE_NAME = "react-utils";
-  const adapter = (0, import_localStore.createLocalStore)(STORE_NAME, {
+  const adapter = _localStore.createLocalStore.call(void 0, STORE_NAME, {
     defaultExpiryMs: expiryMs
   });
   const keyPrefix = key + ":";
@@ -96,35 +69,34 @@ function kvStoreAdapter({
   return {
     set: async (key2, value) => {
       if (IS_NOT_BROWSER) return;
-      await import_kvStore.kvStore.set(keyPrefix + key2, value, expiryMs);
+      await _kvStore.kvStore.set(keyPrefix + key2, value, expiryMs);
     },
     get: async (key2) => {
       if (IS_NOT_BROWSER) return void 0;
       const fullKey = keyPrefix + key2;
-      const value = await import_kvStore.kvStore.get(fullKey);
+      const value = await _kvStore.kvStore.get(fullKey);
       if (value !== void 0 && isValid && !isValid(value)) {
         console.warn(
           `indexedDb adapter: Auto-discard invalid value for ${key2}:`,
           value
         );
-        await import_kvStore.kvStore.delete(fullKey);
+        await _kvStore.kvStore.delete(fullKey);
         return void 0;
       }
       return value;
     },
     delete: async (key2) => {
       if (IS_NOT_BROWSER) return;
-      await import_kvStore.kvStore.delete(keyPrefix + key2);
+      await _kvStore.kvStore.delete(keyPrefix + key2);
     },
     clear: async () => {
       if (IS_NOT_BROWSER) return;
-      await import_kvStore.kvStore.clear();
+      await _kvStore.kvStore.clear();
     }
   };
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getStorageAdapter,
-  kvStoreAdapter,
-  localStoreAdapter
-});
+
+
+
+
+exports.getStorageAdapter = getStorageAdapter; exports.kvStoreAdapter = kvStoreAdapter; exports.localStoreAdapter = localStoreAdapter;

package/storage.min.cjs

@@ -1,2 +1,2 @@
-"use strict";var f=Object.defineProperty;var T=Object.getOwnPropertyDescriptor;var S=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var x=(o,r)=>{for(var e in r)f(o,e,{get:r[e],enumerable:!0})},m=(o,r,e,i)=>{if(r&&typeof r=="object"||typeof r=="function")for(let t of S(r))!y.call(o,t)&&t!==e&&f(o,t,{get:()=>r[t],enumerable:!(i=T(r,t))||i.enumerable});return o};var v=o=>m(f({},"__esModule",{value:!0}),o);var A={};x(A,{getStorageAdapter:()=>w,kvStoreAdapter:()=>g,localStoreAdapter:()=>l});module.exports=v(A);var d=require("@choksheak/ts-utils/kvStore"),c=require("@choksheak/ts-utils/localStore"),a=typeof window>"u";function w(o,r){let{store:e}=o??{};if(!e)return null;if("persistTo"in e&&typeof e.persistTo=="string"&&"key"in e&&typeof e.key=="string"){let i=e.expiryMs||r,t={...e,expiryMs:i};switch(e.persistTo){case"localStorage":return l(t);case"indexedDb":return g(t);default:throw e.persistTo,new Error(`Unknown store.adapter ${e.persistTo}`)}}return e}function l({key:o,expiryMs:r,isValid:e}){let t=(0,c.createLocalStore)("react-utils",{defaultExpiryMs:r}),s=o+":";return{set:(n,u)=>{a||t.set(s+n,u)},get:n=>{if(a)return;let u=s+n,p=t.get(u);if(p!==void 0&&e&&!e(p)){console.warn(`localStorage adapter: Auto-discard invalid value for ${u}: ${JSON.stringify(p)}`),t.delete(u);return}return p},delete:n=>{a||t.delete(s+n)},clear:()=>{a||t.clear()}}}function g({key:o,expiryMs:r,isValid:e}){let i=o+":";return{set:async(t,s)=>{a||await d.kvStore.set(i+t,s,r)},get:async t=>{if(a)return;let s=i+t,n=await d.kvStore.get(s);if(n!==void 0&&e&&!e(n)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}:`,n),await d.kvStore.delete(s);return}return n},delete:async t=>{a||await d.kvStore.delete(i+t)},clear:async()=>{a||await d.kvStore.clear()}}}0&&(module.exports={getStorageAdapter,kvStoreAdapter,localStoreAdapter});
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _kvStore = require('@choksheak/ts-utils/kvStore');var _localStore = require('@choksheak/ts-utils/localStore');const n=typeof window>"u";function v(s,a){const{store:e}=_nullishCoalesce(s, () => ({}));if(!e)return null;if("persistTo"in e&&typeof e.persistTo=="string"&&"key"in e&&typeof e.key=="string"){const i=e.expiryMs||a,t={...e,expiryMs:i};switch(e.persistTo){case"localStorage":return c(t);case"indexedDb":return l(t);default:throw e.persistTo,new Error(`Unknown store.adapter ${e.persistTo}`)}}return e}function c({key:s,expiryMs:a,isValid:e}){const t=_localStore.createLocalStore.call(void 0, "react-utils",{defaultExpiryMs:a}),o=s+":";return{set:(r,d)=>{n||t.set(o+r,d)},get:r=>{if(n)return;const d=o+r,p=t.get(d);if(p!==void 0&&e&&!e(p)){console.warn(`localStorage adapter: Auto-discard invalid value for ${d}: ${JSON.stringify(p)}`),t.delete(d);return}return p},delete:r=>{n||t.delete(o+r)},clear:()=>{n||t.clear()}}}function l({key:s,expiryMs:a,isValid:e}){const i=s+":";return{set:async(t,o)=>{n||await _kvStore.kvStore.set(i+t,o,a)},get:async t=>{if(n)return;const o=i+t,r=await _kvStore.kvStore.get(o);if(r!==void 0&&e&&!e(r)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}:`,r),await _kvStore.kvStore.delete(o);return}return r},delete:async t=>{n||await _kvStore.kvStore.delete(i+t)},clear:async()=>{n||await _kvStore.kvStore.clear()}}}exports.getStorageAdapter = v; exports.kvStoreAdapter = l; exports.localStoreAdapter = c;
 //# sourceMappingURL=storage.min.cjs.map

package/storage.min.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/storage.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,uBAAAE,EAAA,mBAAAC,EAAA,sBAAAC,IAAA,eAAAC,EAAAL,GAYA,IAAAM,EAAwB,uCACxBC,EAAiC,0CAkC3BC,EAAiB,OAAO,OAAW,IAMlC,SAASN,EACdO,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOP,EAAqBS,CAAM,EAEpC,IAAK,YACH,OAAOV,EAAkBU,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASP,EAAqB,CACnC,IAAAU,EACA,SAAAF,EACA,QAAAG,CACF,EAAyB,CAIvB,IAAMC,KAAU,oBAFG,cAE0B,CAC3C,gBAAiBJ,CACnB,CAAC,EAGKK,EAAYH,EAAM,IAExB,MAAO,CACL,IAAK,CAACA,EAAaI,IAAmB,CAChCV,GAGJQ,EAAQ,IAAIC,EAAYH,EAAKI,CAAK,CACpC,EAEA,IAAMJ,GAA+B,CACnC,GAAIN,EAAgB,OAEpB,IAAMW,EAAUF,EAAYH,EACtBI,EAAQF,EAAQ,IAAOG,CAAO,EAGpC,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,wDAAwDC,CAAO,KAAK,KAAK,UAAUD,CAAK,CAAC,EAC3F,EACAF,EAAQ,OAAOG,CAAO,EACtB,MACF,CAEA,OAAOD,CACT,EAEA,OAASJ,GAAsB,CACzBN,GAEJQ,EAAQ,OAAOC,EAAYH,CAAG,CAChC,EAGA,MAAO,IAAY,CACbN,GAEJQ,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASb,EAAkB,CAChC,IAAAW,EACA,SAAAF,EACA,QAAAG,CACF,EAAyB,CAEvB,IAAME,EAAYH,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaI,IAA4B,CAC/CV,GAGJ,MAAM,UAAQ,IAAIS,EAAYH,EAAKI,EAAON,CAAQ,CACpD,EACA,IAAK,MAAOE,GAAwC,CAClD,GAAIN,EAAgB,OAEpB,IAAMW,EAAUF,EAAYH,EACtBI,EAAQ,MAAM,UAAQ,IAAOC,CAAO,EAG1C,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,qDAAqDJ,CAAG,IACxDI,CACF,EACA,MAAM,UAAQ,OAAOC,CAAO,EAC5B,MACF,CAEA,OAAOD,CACT,EACA,OAAQ,MAAOJ,GAA+B,CACxCN,GAEJ,MAAM,UAAQ,OAAOS,EAAYH,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BN,GAEJ,MAAM,UAAQ,MAAM,CACtB,CACF,CACF","names":["storage_exports","__export","getStorageAdapter","kvStoreAdapter","localStoreAdapter","__toCommonJS","import_kvStore","import_localStore","IS_NOT_BROWSER","options","defaultStoreExpiryMs","store","expiryMs","config","key","isValid","adapter","keyPrefix","value","fullKey"]}
+{"version":3,"sources":["../src/storage.ts"],"names":["IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter"],"mappings":"AAYA,mOAAwB,4DACS,MAkC3BA,CAAAA,CAAiB,OAAO,MAAA,CAAW,GAAA,CAMlC,SAASC,CAAAA,CACdC,CAAAA,CACAC,CAAAA,CAC0B,CAC1B,KAAM,CAAE,KAAA,CAAAC,CAAM,CAAA,kBAAIF,CAAAA,SAAW,CAAC,GAAA,CAE9B,EAAA,CAAI,CAACE,CAAAA,CACH,OAAO,IAAA,CAGT,EAAA,CACE,WAAA,GAAeA,CAAAA,EACf,OAAOA,CAAAA,CAAM,SAAA,EAAc,QAAA,EAC3B,KAAA,GAASA,CAAAA,EACT,OAAOA,CAAAA,CAAM,GAAA,EAAQ,QAAA,CACrB,CACA,MAAMC,CAAAA,CAAWD,CAAAA,CAAM,QAAA,EAAYD,CAAAA,CAC7BG,CAAAA,CAAS,CAAE,GAAGF,CAAAA,CAAO,QAAA,CAAAC,CAAS,CAAA,CAEpC,MAAA,CAAQD,CAAAA,CAAM,SAAA,CAAW,CACvB,IAAK,cAAA,CACH,OAAOG,CAAAA,CAAqBD,CAAM,CAAA,CAEpC,IAAK,WAAA,CACH,OAAOE,CAAAA,CAAkBF,CAAM,CAAA,CAEjC,OAAA,CACE,MAAAF,CAAAA,CAAM,SAAA,CACA,IAAI,KAAA,CAAM,CAAA,sBAAA,EAAyBA,CAAAA,CAAM,SAAS,CAAA,CAAA","file":"/Users/choksheaklau/src/react-utils/dist/storage.min.cjs","sourcesContent":["/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"]}

package/storage.min.mjs

@@ -1,2 +1,2 @@
-import{kvStore as u}from"@choksheak/ts-utils/kvStore";import{createLocalStore as f}from"@choksheak/ts-utils/localStore";var n=typeof window>"u";function S(s,a){let{store:e}=s??{};if(!e)return null;if("persistTo"in e&&typeof e.persistTo=="string"&&"key"in e&&typeof e.key=="string"){let i=e.expiryMs||a,t={...e,expiryMs:i};switch(e.persistTo){case"localStorage":return c(t);case"indexedDb":return l(t);default:throw e.persistTo,new Error(`Unknown store.adapter ${e.persistTo}`)}}return e}function c({key:s,expiryMs:a,isValid:e}){let t=f("react-utils",{defaultExpiryMs:a}),o=s+":";return{set:(r,d)=>{n||t.set(o+r,d)},get:r=>{if(n)return;let d=o+r,p=t.get(d);if(p!==void 0&&e&&!e(p)){console.warn(`localStorage adapter: Auto-discard invalid value for ${d}: ${JSON.stringify(p)}`),t.delete(d);return}return p},delete:r=>{n||t.delete(o+r)},clear:()=>{n||t.clear()}}}function l({key:s,expiryMs:a,isValid:e}){let i=s+":";return{set:async(t,o)=>{n||await u.set(i+t,o,a)},get:async t=>{if(n)return;let o=i+t,r=await u.get(o);if(r!==void 0&&e&&!e(r)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}:`,r),await u.delete(o);return}return r},delete:async t=>{n||await u.delete(i+t)},clear:async()=>{n||await u.clear()}}}export{S as getStorageAdapter,l as kvStoreAdapter,c as localStoreAdapter};
+import{kvStore as u}from"@choksheak/ts-utils/kvStore";import{createLocalStore as f}from"@choksheak/ts-utils/localStore";const n=typeof window>"u";function v(s,a){const{store:e}=s??{};if(!e)return null;if("persistTo"in e&&typeof e.persistTo=="string"&&"key"in e&&typeof e.key=="string"){const i=e.expiryMs||a,t={...e,expiryMs:i};switch(e.persistTo){case"localStorage":return c(t);case"indexedDb":return l(t);default:throw e.persistTo,new Error(`Unknown store.adapter ${e.persistTo}`)}}return e}function c({key:s,expiryMs:a,isValid:e}){const t=f("react-utils",{defaultExpiryMs:a}),o=s+":";return{set:(r,d)=>{n||t.set(o+r,d)},get:r=>{if(n)return;const d=o+r,p=t.get(d);if(p!==void 0&&e&&!e(p)){console.warn(`localStorage adapter: Auto-discard invalid value for ${d}: ${JSON.stringify(p)}`),t.delete(d);return}return p},delete:r=>{n||t.delete(o+r)},clear:()=>{n||t.clear()}}}function l({key:s,expiryMs:a,isValid:e}){const i=s+":";return{set:async(t,o)=>{n||await u.set(i+t,o,a)},get:async t=>{if(n)return;const o=i+t,r=await u.get(o);if(r!==void 0&&e&&!e(r)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}:`,r),await u.delete(o);return}return r},delete:async t=>{n||await u.delete(i+t)},clear:async()=>{n||await u.clear()}}}export{v as getStorageAdapter,l as kvStoreAdapter,c as localStoreAdapter};
 //# sourceMappingURL=storage.min.mjs.map

package/storage.min.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/storage.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"],"mappings":"AAYA,OAAS,WAAAA,MAAe,8BACxB,OAAS,oBAAAC,MAAwB,iCAkCjC,IAAMC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAIvB,IAAMC,EAAUZ,EAFG,cAE0B,CAC3C,gBAAiBM,CACnB,CAAC,EAGKO,EAAYH,EAAM,IAExB,MAAO,CACL,IAAK,CAACA,EAAaI,IAAmB,CAChCb,GAGJW,EAAQ,IAAIC,EAAYH,EAAKI,CAAK,CACpC,EAEA,IAAMJ,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQF,EAAQ,IAAOG,CAAO,EAGpC,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,wDAAwDC,CAAO,KAAK,KAAK,UAAUD,CAAK,CAAC,EAC3F,EACAF,EAAQ,OAAOG,CAAO,EACtB,MACF,CAEA,OAAOD,CACT,EAEA,OAASJ,GAAsB,CACzBT,GAEJW,EAAQ,OAAOC,EAAYH,CAAG,CAChC,EAGA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,IAAME,EAAYH,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaI,IAA4B,CAC/Cb,GAGJ,MAAMF,EAAQ,IAAIc,EAAYH,EAAKI,EAAOR,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,IAAMc,EAAUF,EAAYH,EACtBI,EAAQ,MAAMf,EAAQ,IAAOgB,CAAO,EAG1C,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,qDAAqDJ,CAAG,IACxDI,CACF,EACA,MAAMf,EAAQ,OAAOgB,CAAO,EAC5B,MACF,CAEA,OAAOD,CACT,EACA,OAAQ,MAAOJ,GAA+B,CACxCT,GAEJ,MAAMF,EAAQ,OAAOc,EAAYH,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAMF,EAAQ,MAAM,CACtB,CACF,CACF","names":["kvStore","createLocalStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","keyPrefix","value","fullKey"]}
+{"version":3,"sources":["../src/storage.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n *\n * Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n */\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/** List of all available pre-built persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/** Options to configure a pre-built store adapter. */\nexport type StoreOptions = {\n  /** Choose which pre-built store adapter to use. */\n  persistTo: PersistTo;\n\n  /** Storage key to act as a namespace to store the data. */\n  key: string;\n\n  /** How long to wait before the value is considered expired. */\n  expiryMs?: number | Duration;\n\n  /** Returns true if the given value supposed to be of type T is valid. */\n  isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/** Either use a pre-built store, or a custom one you provide. */\nexport type StorageOptions<T> = {\n  /**\n   * You can either specify the storage adapter directly to use a custom\n   * store, or specify the properties to use the pre-built ones.\n   */\n  store?: StorageAdapter<T> | StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/**\n * Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n */\nexport function getStorageAdapter<T>(\n  options: StorageOptions<T> | undefined,\n  defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n  const { store } = options ?? {};\n\n  if (!store) {\n    return null;\n  }\n\n  if (\n    \"persistTo\" in store &&\n    typeof store.persistTo === \"string\" &&\n    \"key\" in store &&\n    typeof store.key === \"string\"\n  ) {\n    const expiryMs = store.expiryMs || defaultStoreExpiryMs;\n    const config = { ...store, expiryMs };\n\n    switch (store.persistTo) {\n      case \"localStorage\":\n        return localStoreAdapter<T>(config);\n\n      case \"indexedDb\":\n        return kvStoreAdapter<T>(config);\n\n      default:\n        store.persistTo satisfies never;\n        throw new Error(`Unknown store.adapter ${store.persistTo}`);\n    }\n  }\n\n  return store as StorageAdapter<T>;\n}\n\n/**\n * Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n */\nexport function localStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Put everything in the same store so that we can GC properly.\n  const STORE_NAME = \"react-utils\";\n\n  const adapter = createLocalStore(STORE_NAME, {\n    defaultExpiryMs: expiryMs,\n  });\n\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  return {\n    set: (key: string, value: T): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      adapter.set(keyPrefix + key, value);\n    },\n\n    get: (key: string): T | undefined => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = adapter.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `localStorage adapter: Auto-discard invalid value for ${fullKey}: ${JSON.stringify(value)}`,\n        );\n        adapter.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n\n    delete: (key: string): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.delete(keyPrefix + key);\n    },\n\n    /** Note that this will clear all keys in all shared states. */\n    clear: (): void => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      adapter.clear();\n    },\n  };\n}\n\n/**\n * Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n  key,\n  expiryMs,\n  isValid,\n}: StoreConstructorArgs) {\n  // Use the key prefix as a unique namespace for this store.\n  const keyPrefix = key + \":\";\n\n  // Prefix all keys using `keyPrefix` so that we can keep all data in\n  // the same store in the same DB. If we keep the data in different\n  // DB stores, then GC will not be able to clean up abandoned stores.\n  return {\n    set: async (key: string, value: T): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      // Also apply the custom expiryMs on every item in this store.\n      await kvStore.set(keyPrefix + key, value, expiryMs);\n    },\n    get: async (key: string): Promise<T | undefined> => {\n      if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n      const fullKey = keyPrefix + key;\n      const value = await kvStore.get<T>(fullKey);\n\n      // If there is no value, don't try to check for validatity.\n      if (value !== undefined && isValid && !isValid(value)) {\n        console.warn(\n          `indexedDb adapter: Auto-discard invalid value for ${key}:`,\n          value,\n        );\n        await kvStore.delete(fullKey);\n        return undefined;\n      }\n\n      return value;\n    },\n    delete: async (key: string): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.delete(keyPrefix + key);\n    },\n    clear: async (): Promise<void> => {\n      if (IS_NOT_BROWSER) return; // handle SSR\n\n      await kvStore.clear();\n    },\n  };\n}\n"],"mappings":"AAYA,OAAS,WAAAA,MAAe,8BACxB,OAAS,oBAAAC,MAAwB,iCAkCjC,MAAMC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,KAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,MAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAIvB,MAAMC,EAAUZ,EAFG,cAE0B,CAC3C,gBAAiBM,CACnB,CAAC,EAGKO,EAAYH,EAAM,IAExB,MAAO,CACL,IAAK,CAACA,EAAaI,IAAmB,CAChCb,GAGJW,EAAQ,IAAIC,EAAYH,EAAKI,CAAK,CACpC,EAEA,IAAMJ,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,MAAMc,EAAUF,EAAYH,EACtBI,EAAQF,EAAQ,IAAOG,CAAO,EAGpC,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,wDAAwDC,CAAO,KAAK,KAAK,UAAUD,CAAK,CAAC,EAC3F,EACAF,EAAQ,OAAOG,CAAO,EACtB,MACF,CAEA,OAAOD,CACT,EAEA,OAASJ,GAAsB,CACzBT,GAEJW,EAAQ,OAAOC,EAAYH,CAAG,CAChC,EAGA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,MAAME,EAAYH,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaI,IAA4B,CAC/Cb,GAGJ,MAAMF,EAAQ,IAAIc,EAAYH,EAAKI,EAAOR,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,MAAMc,EAAUF,EAAYH,EACtBI,EAAQ,MAAMf,EAAQ,IAAOgB,CAAO,EAG1C,GAAID,IAAU,QAAaH,GAAW,CAACA,EAAQG,CAAK,EAAG,CACrD,QAAQ,KACN,qDAAqDJ,CAAG,IACxDI,CACF,EACA,MAAMf,EAAQ,OAAOgB,CAAO,EAC5B,MACF,CAEA,OAAOD,CACT,EACA,OAAQ,MAAOJ,GAA+B,CACxCT,GAEJ,MAAMF,EAAQ,OAAOc,EAAYH,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAMF,EAAQ,MAAM,CACtB,CACF,CACF","names":["kvStore","createLocalStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","keyPrefix","value","fullKey"]}

package/storage.mjs

@@ -1,7 +1,6 @@
-// src/storage.ts
 import { kvStore } from "@choksheak/ts-utils/kvStore";
 import { createLocalStore } from "@choksheak/ts-utils/localStore";
-var IS_NOT_BROWSER = typeof window === "undefined";
+const IS_NOT_BROWSER = typeof window === "undefined";
 function getStorageAdapter(options, defaultStoreExpiryMs) {
   const { store } = options ?? {};
   if (!store) {