@choksheak/react-utils 0.4.4 → 0.4.6

package/sharedState.mjs

@@ -1,13 +1,302 @@
-import {
-  SharedStateConfig,
-  configureSharedState,
-  sharedState,
-  useSharedState,
-  useSharedStateSetter,
-  useSharedStateValue
-} from "./chunk-YHU4KW2D.mjs";
-import "./chunk-PHLY3LR4.mjs";
-import "./chunk-R7POPVJR.mjs";
+// 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 = {
+  /**
+   * Default duration for storage expiration in milliseconds. Initial value
+   * is 30 days, but can be changed to anything.
+   */
+  storeExpiryMs: 30 * MS_PER_DAY,
+  /**
+   * True to load from storage only on mount, false (default) to load in
+   * the top level scope when the shared state is defined.
+   */
+  lazyLoad: false
+};
+function configureSharedState(config) {
+  Object.assign(SharedStateConfig, config);
+}
+function createPubSubStore() {
+  const dataByKey = /* @__PURE__ */ new Map();
+  const subscribersByKey = /* @__PURE__ */ new Map();
+  function notify(key, next, prev) {
+    const subscribers = subscribersByKey.get(key);
+    if (!subscribers) return;
+    const copy = Array.from(subscribers.values());
+    for (const subscriber of copy) {
+      try {
+        subscriber(next, prev);
+      } catch (e) {
+        console.error(`Error invoking subscriber:`, e);
+      }
+    }
+  }
+  return {
+    // This could be undefined if T includes undefined, else it should never
+    // return undefined because the user has to always specify the default value.
+    get(key) {
+      return dataByKey.get(key);
+    },
+    set(key, value) {
+      const prev = dataByKey.get(key);
+      if (prev === value) return;
+      dataByKey.set(key, value);
+      notify(key, value, prev);
+    },
+    delete(key) {
+      dataByKey.delete(key);
+    },
+    setNoNotify(key, value) {
+      dataByKey.set(key, value);
+    },
+    // Subscribe to changes of a specific key
+    subscribe(key, subscriber) {
+      let subscribers = subscribersByKey.get(key);
+      if (!subscribers) {
+        subscribers = /* @__PURE__ */ new Set();
+        subscribersByKey.set(key, subscribers);
+      }
+      subscribers.add(subscriber);
+      return () => {
+        subscribers.delete(subscriber);
+        if (subscribers.size === 0) subscribersByKey.delete(key);
+      };
+    }
+  };
+}
+function getOrCreatePubSubStore() {
+  if (typeof window !== "undefined") {
+    const t = window.globalThis;
+    return t.reactUtilsPubSubStore || (t.reactUtilsPubSubStore = createPubSubStore());
+  }
+  return createPubSubStore();
+}
+var pubSubStore = getOrCreatePubSubStore();
+var STORAGE_KEY = "state";
+var 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 = () => {
+  };
+  const readyPromise = new Promise((resolve) => {
+    readyResolve = resolve;
+  });
+  const resolveReadyPromise = readyResolve;
+  const pubSubKey = String(getNextStateKey());
+  const storageAdapter = getStorageAdapter(
+    options,
+    SharedStateConfig.storeExpiryMs
+  );
+  pubSubStore.setNoNotify(pubSubKey, defaultValue);
+  const lazyLoad = options?.lazyLoad;
+  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
+  function completeInit(stored) {
+    const value = stored !== void 0 ? stored : defaultValue;
+    pubSubStore.set(pubSubKey, value);
+    obj.initDone = true;
+    resolveReadyPromise();
+  }
+  const obj = {
+    defaultValue,
+    /** Allow users to await for the completion of data init. */
+    readyPromise,
+    lazy,
+    initStarted: false,
+    initDone: false,
+    /** `subscribe` function required by useSyncExternalStore. */
+    subscribe(subscriber) {
+      return pubSubStore.subscribe(pubSubKey, () => subscriber());
+    },
+    /** Returns true if there is a backing store. */
+    hasStore() {
+      return Boolean(storageAdapter);
+    },
+    /**
+     * Set a value directly into the store. Does nothing if there is no
+     * backing store.
+     *
+     * Warning: If you want to set the value properly, you should use
+     * `setValue()` instead which also updates the in-memory copy.
+     */
+    setInStore(value) {
+      return storageAdapter?.set(STORAGE_KEY, value);
+    },
+    /**
+     * Get a value directly from the store. Returns undefined if there is no
+     * backing store.
+     */
+    getFromStore() {
+      return storageAdapter?.get(STORAGE_KEY);
+    },
+    /**
+     * Get the value of the shared state.
+     *  `getSnapshot` function — must return same ref if value unchanged.
+     * Note that this would return the default value if data init from store is
+     * not completed yet.
+     */
+    getSnapshot() {
+      return pubSubStore.get(pubSubKey);
+    },
+    /** Set the value of the shared state. */
+    setValue(next) {
+      if (typeof next === "function") {
+        const prev = pubSubStore.get(pubSubKey);
+        next = next(prev);
+      }
+      pubSubStore.set(pubSubKey, next);
+      void obj.setInStore(next);
+    },
+    /**
+     * Remove the value of the shared state. Actually this just sets the value
+     * back to the given default value.
+     */
+    delete() {
+      pubSubStore.set(pubSubKey, defaultValue);
+      return storageAdapter?.set(STORAGE_KEY, defaultValue);
+    },
+    /** Initial default handling. */
+    initDefaultValueOnce() {
+      if (obj.initDone || obj.initStarted) return;
+      obj.initStarted = true;
+      const maybePromise = obj.getFromStore();
+      if (maybePromise instanceof Promise) {
+        return maybePromise.then(completeInit);
+      } else {
+        const stored = maybePromise;
+        completeInit(stored);
+      }
+    }
+  };
+  if (!lazy) {
+    obj.initDefaultValueOnce();
+  }
+  return obj;
+}
+function useSharedState(state) {
+  void state.initDefaultValueOnce();
+  const value = useSyncExternalStore(
+    (onStoreChange) => state.subscribe(onStoreChange),
+    () => state.getSnapshot(),
+    // getServerSnapshot is needed to prevent SSR dev errors in nextjs.
+    () => state.getSnapshot()
+  );
+  return [value, state.setValue];
+}
+function useSharedStateValue(state) {
+  return useSharedState(state)[0];
+}
+function useSharedStateSetter(state) {
+  void state.initDefaultValueOnce();
+  return state.setValue;
+}
 export {
   SharedStateConfig,
   configureSharedState,

package/storage.cjs

@@ -1,11 +1,130 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-
-
-var _chunk5PDGU37Ecjs = require('./chunk-5PDGU37E.cjs');
-require('./chunk-IS3BZTWE.cjs');
-
-
-
-
-exports.getStorageAdapter = _chunk5PDGU37Ecjs.getStorageAdapter; exports.kvStoreAdapter = _chunk5PDGU37Ecjs.kvStoreAdapter; exports.localStoreAdapter = _chunk5PDGU37Ecjs.localStoreAdapter;
+// 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";
+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 = (0, import_localStore.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 import_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);
+      if (value !== void 0 && isValid && !isValid(value)) {
+        console.warn(
+          `indexedDb adapter: Auto-discard invalid value for ${key2}:`,
+          value
+        );
+        await import_kvStore.kvStore.delete(fullKey);
+        return void 0;
+      }
+      return value;
+    },
+    delete: async (key2) => {
+      if (IS_NOT_BROWSER) return;
+      await import_kvStore.kvStore.delete(keyPrefix + key2);
+    },
+    clear: async () => {
+      if (IS_NOT_BROWSER) return;
+      await import_kvStore.kvStore.clear();
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getStorageAdapter,
+  kvStoreAdapter,
+  localStoreAdapter
+});

package/storage.min.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkUFJQLQFImincjs = require('./chunk-UFJQLQFI.min.cjs');require('./chunk-ZCDXPV3A.min.cjs');exports.getStorageAdapter = _chunkUFJQLQFImincjs.a; exports.kvStoreAdapter = _chunkUFJQLQFImincjs.c; exports.localStoreAdapter = _chunkUFJQLQFImincjs.b;
+"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});
 //# sourceMappingURL=storage.min.cjs.map

package/storage.min.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["/Users/choksheaklau/src/react-utils/dist/storage.min.cjs"],"names":[],"mappings":"AAAA,wIAA2C,oCAAiC,wJAA0E","file":"/Users/choksheaklau/src/react-utils/dist/storage.min.cjs"}
+{"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"]}

package/storage.min.mjs

@@ -1,2 +1,2 @@
-import{a,b,c}from"./chunk-VHMO75EY.min.mjs";import"./chunk-HRE7YPUJ.min.mjs";export{a as getStorageAdapter,c as kvStoreAdapter,b as localStoreAdapter};
+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};
 //# sourceMappingURL=storage.min.mjs.map

package/storage.min.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"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"]}

package/storage.mjs

@@ -1,9 +1,101 @@
-import {
-  getStorageAdapter,
-  kvStoreAdapter,
-  localStoreAdapter
-} from "./chunk-PHLY3LR4.mjs";
-import "./chunk-R7POPVJR.mjs";
+// 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();
+    }
+  };
+}
 export {
   getStorageAdapter,
   kvStoreAdapter,