@choksheak/react-utils 0.1.5 → 0.1.7

package/sharedState.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/sharedState.ts
 var sharedState_exports = {};
 __export(sharedState_exports, {
+  SharedState: () => SharedState,
   SharedStateConfig: () => SharedStateConfig,
   sharedState: () => sharedState,
   useSharedState: () => useSharedState,
@@ -27,16 +28,119 @@ __export(sharedState_exports, {
   useSharedStateValue: () => useSharedStateValue
 });
 module.exports = __toCommonJS(sharedState_exports);
-var import_kvStore = require("@choksheak/ts-utils/kvStore");
+var import_kvStore2 = require("@choksheak/ts-utils/kvStore");
 var import_timeConstants = require("@choksheak/ts-utils/timeConstants");
 var import_react = require("react");
+
+// src/utils/storage.ts
+var import_kvStore = require("@choksheak/ts-utils/kvStore");
+function getStorageAdapter(options, defaultStoreExpiryMs) {
+  const { localStorageKey, indexedDbKey, storeExpiryMs, store } = options ?? {};
+  if (store) {
+    return store;
+  }
+  const expiryMs = storeExpiryMs || defaultStoreExpiryMs;
+  if (localStorageKey) {
+    return new LocalStorageAdapter(localStorageKey, expiryMs);
+  }
+  if (indexedDbKey) {
+    return new IndexedDbAdapter(indexedDbKey, expiryMs);
+  }
+  return null;
+}
+var LocalStorageAdapter = class {
+  constructor(keyPrefix, expiryMs) {
+    this.keyPrefix = keyPrefix;
+    this.expiryMs = expiryMs;
+  }
+  save(key, value) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    window.localStorage.setItem(
+      fullKey,
+      JSON.stringify({
+        value,
+        expiresAt: this.expiryMs ? Date.now() + this.expiryMs : 0
+      })
+    );
+  }
+  load(key) {
+    if (typeof window === "undefined") return void 0;
+    const fullKey = this.keyPrefix + ":" + key;
+    const raw = window.localStorage.getItem(fullKey);
+    if (!raw) return void 0;
+    try {
+      const box = JSON.parse(raw);
+      if (!box || box.expiresAt && Date.now() >= box.expiresAt) {
+        window.localStorage.removeItem(fullKey);
+        return void 0;
+      }
+      return box.value;
+    } catch {
+      window.localStorage.removeItem(fullKey);
+      return void 0;
+    }
+  }
+  delete(key) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    window.localStorage.removeItem(fullKey);
+  }
+  clear() {
+    if (typeof window === "undefined") return;
+    for (const key of Object.keys(window.localStorage)) {
+      if (key.startsWith(this.keyPrefix)) {
+        window.localStorage.removeItem(key);
+      }
+    }
+  }
+};
+var IndexedDbAdapter = class {
+  constructor(keyPrefix, expiryMs) {
+    this.keyPrefix = keyPrefix;
+    this.expiryMs = expiryMs;
+  }
+  async save(key, value) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    await import_kvStore.kvStore.set(fullKey, JSON.stringify(value), this.expiryMs);
+  }
+  async load(key) {
+    if (typeof window === "undefined") return void 0;
+    const fullKey = this.keyPrefix + ":" + key;
+    const raw = await import_kvStore.kvStore.get(fullKey);
+    if (raw === void 0) return void 0;
+    try {
+      return JSON.parse(raw);
+    } catch {
+      await import_kvStore.kvStore.delete(fullKey);
+      return void 0;
+    }
+  }
+  async delete(key) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    await import_kvStore.kvStore.delete(fullKey);
+  }
+  async clear() {
+    if (typeof window === "undefined") return;
+    await import_kvStore.kvStore.forEach(async (k) => {
+      if (k.startsWith(this.keyPrefix)) {
+        await import_kvStore.kvStore.delete(k);
+      }
+    });
+  }
+};
+
+// src/sharedState.ts
 var SharedStateConfig = class {
   /**
-   * Default duration for persistence expiration in milliseconds.
+   * Default duration for storage expiration in milliseconds. Initial value
+   * is 30 days, but can be changed to anything.
    */
-  static defaultPersistExpiryMs = import_timeConstants.MS_PER_DAY;
+  static storeExpiryMs = import_timeConstants.MS_PER_DAY * 30;
   /**
-   * True to load from persistence only on mount, false (default) to load in
+   * True to load from storage only on mount, false (default) to load in
    * the top level scope when the shared state is defined.
    */
   static lazyLoad = false;
@@ -55,6 +159,9 @@ var PubSubStore = class {
     this.dataByKey.set(key, value);
     this.notify(key, value, prev);
   }
+  delete(key) {
+    this.dataByKey.delete(key);
+  }
   setNoNotify(key, value) {
     this.dataByKey.set(key, value);
   }
@@ -84,51 +191,58 @@ var PubSubStore = class {
     }
   }
 };
-var store = new PubSubStore();
+var pubSubStore = new PubSubStore();
+var STORAGE_KEY = "state";
 var stateKey = 0;
-function sharedState(defaultValue, options) {
-  const { localStorageKey, indexedDbKey, persistExpiryMs, lazyLoad } = options ?? {};
-  const key = String(stateKey++);
-  let persistenceAdapter;
-  const expiryMs = persistExpiryMs ?? SharedStateConfig.defaultPersistExpiryMs;
-  if (localStorageKey) {
-    persistenceAdapter = new LocalStorageAdapter(localStorageKey, expiryMs);
-  } else if (indexedDbKey) {
-    persistenceAdapter = new IndexedDbAdapter(indexedDbKey, expiryMs);
+var SharedState = class {
+  constructor(defaultValue, options) {
+    this.defaultValue = defaultValue;
+    this.pubSubKey = String(stateKey++);
+    this.storageAdapter = getStorageAdapter(options, import_kvStore2.DEFAULT_EXPIRY_DELTA_MS);
+    pubSubStore.setNoNotify(this.pubSubKey, defaultValue);
+    const lazyLoad = options?.lazyLoad;
+    const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
+    if (!lazy) {
+      void this.initDefaultValueOnce();
+    }
   }
-  function subscribe(subscriber) {
-    return store.subscribe(key, () => subscriber());
+  pubSubKey;
+  storageAdapter;
+  initDone = false;
+  // `subscribe` function required by useSyncExternalStore
+  subscribe(subscriber) {
+    return pubSubStore.subscribe(this.pubSubKey, () => subscriber());
   }
-  function getSnapshot() {
-    return store.get(key);
+  // Get the value of the shared state.
+  // `getSnapshot` function — must return same ref if value unchanged
+  getSnapshot() {
+    return pubSubStore.get(this.pubSubKey);
   }
-  function setValue(next) {
+  // Set the value of the shared state.
+  setValue(next) {
     if (typeof next === "function") {
-      const prev = store.get(key);
+      const prev = pubSubStore.get(this.pubSubKey);
       next = next(prev);
     }
-    store.set(key, next);
-    void persistenceAdapter?.save?.(next);
-  }
-  store.setNoNotify(key, defaultValue);
-  const state = {
-    subscribe,
-    getSnapshot,
-    // initial default handling
-    initDefaultValueOnce: async () => {
-      if (state.initDone) return;
-      state.initDone = true;
-      const v = await persistenceAdapter?.load?.();
-      store.set(key, v !== void 0 ? v : defaultValue);
-    },
-    initDone: false,
-    setValue
-  };
-  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
-  if (!lazy) {
-    void state.initDefaultValueOnce();
-  }
-  return state;
+    pubSubStore.set(this.pubSubKey, next);
+    void this.storageAdapter?.save(STORAGE_KEY, next);
+  }
+  // Remove the value of the shared state. Actually this just sets the value
+  // back to the given default value.
+  delete() {
+    pubSubStore.set(this.pubSubKey, this.defaultValue);
+    void this.storageAdapter?.save(STORAGE_KEY, this.defaultValue);
+  }
+  // Initial default handling
+  async initDefaultValueOnce() {
+    if (this.initDone) return;
+    this.initDone = true;
+    const v = await this.storageAdapter?.load(STORAGE_KEY);
+    pubSubStore.set(this.pubSubKey, v !== void 0 ? v : this.defaultValue);
+  }
+};
+function sharedState(defaultValue, options) {
+  return new SharedState(defaultValue, options);
 }
 function useSharedState(state) {
   state.initDefaultValueOnce();
@@ -146,51 +260,9 @@ function useSharedStateValue(state) {
 function useSharedStateSetter(state) {
   return useSharedState(state)[1];
 }
-var LocalStorageAdapter = class {
-  constructor(key, expiryMs) {
-    this.key = key;
-    this.expiryMs = expiryMs;
-  }
-  save(value) {
-    if (typeof window === "undefined") return;
-    window.localStorage.setItem(
-      this.key,
-      JSON.stringify({
-        value,
-        expiresAt: Date.now() + this.expiryMs
-      })
-    );
-  }
-  load() {
-    if (typeof window === "undefined") return void 0;
-    const raw = window.localStorage.getItem(this.key);
-    if (!raw) return void 0;
-    const box = JSON.parse(raw);
-    if (!box || !box?.expiresAt || Date.now() >= box.expiresAt) {
-      window.localStorage.removeItem(this.key);
-      return void 0;
-    }
-    return box.value;
-  }
-};
-var IndexedDbAdapter = class {
-  constructor(key, expiryMs) {
-    this.key = key;
-    this.expiryMs = expiryMs;
-  }
-  async save(value) {
-    if (typeof window === "undefined") return;
-    await import_kvStore.kvStore.set(this.key, JSON.stringify(value), this.expiryMs);
-  }
-  async load() {
-    if (typeof window === "undefined") return void 0;
-    const raw = await import_kvStore.kvStore.get(this.key);
-    if (raw === void 0) return void 0;
-    return JSON.parse(raw);
-  }
-};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  SharedState,
   SharedStateConfig,
   sharedState,
   useSharedState,

package/sharedState.mjs

@@ -1,14 +1,117 @@
 // src/sharedState.ts
-import { kvStore } from "@choksheak/ts-utils/kvStore";
+import { DEFAULT_EXPIRY_DELTA_MS } from "@choksheak/ts-utils/kvStore";
 import { MS_PER_DAY } from "@choksheak/ts-utils/timeConstants";
 import { useSyncExternalStore } from "react";
+
+// src/utils/storage.ts
+import { kvStore } from "@choksheak/ts-utils/kvStore";
+function getStorageAdapter(options, defaultStoreExpiryMs) {
+  const { localStorageKey, indexedDbKey, storeExpiryMs, store } = options ?? {};
+  if (store) {
+    return store;
+  }
+  const expiryMs = storeExpiryMs || defaultStoreExpiryMs;
+  if (localStorageKey) {
+    return new LocalStorageAdapter(localStorageKey, expiryMs);
+  }
+  if (indexedDbKey) {
+    return new IndexedDbAdapter(indexedDbKey, expiryMs);
+  }
+  return null;
+}
+var LocalStorageAdapter = class {
+  constructor(keyPrefix, expiryMs) {
+    this.keyPrefix = keyPrefix;
+    this.expiryMs = expiryMs;
+  }
+  save(key, value) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    window.localStorage.setItem(
+      fullKey,
+      JSON.stringify({
+        value,
+        expiresAt: this.expiryMs ? Date.now() + this.expiryMs : 0
+      })
+    );
+  }
+  load(key) {
+    if (typeof window === "undefined") return void 0;
+    const fullKey = this.keyPrefix + ":" + key;
+    const raw = window.localStorage.getItem(fullKey);
+    if (!raw) return void 0;
+    try {
+      const box = JSON.parse(raw);
+      if (!box || box.expiresAt && Date.now() >= box.expiresAt) {
+        window.localStorage.removeItem(fullKey);
+        return void 0;
+      }
+      return box.value;
+    } catch {
+      window.localStorage.removeItem(fullKey);
+      return void 0;
+    }
+  }
+  delete(key) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    window.localStorage.removeItem(fullKey);
+  }
+  clear() {
+    if (typeof window === "undefined") return;
+    for (const key of Object.keys(window.localStorage)) {
+      if (key.startsWith(this.keyPrefix)) {
+        window.localStorage.removeItem(key);
+      }
+    }
+  }
+};
+var IndexedDbAdapter = class {
+  constructor(keyPrefix, expiryMs) {
+    this.keyPrefix = keyPrefix;
+    this.expiryMs = expiryMs;
+  }
+  async save(key, value) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    await kvStore.set(fullKey, JSON.stringify(value), this.expiryMs);
+  }
+  async load(key) {
+    if (typeof window === "undefined") return void 0;
+    const fullKey = this.keyPrefix + ":" + key;
+    const raw = await kvStore.get(fullKey);
+    if (raw === void 0) return void 0;
+    try {
+      return JSON.parse(raw);
+    } catch {
+      await kvStore.delete(fullKey);
+      return void 0;
+    }
+  }
+  async delete(key) {
+    if (typeof window === "undefined") return;
+    const fullKey = this.keyPrefix + ":" + key;
+    await kvStore.delete(fullKey);
+  }
+  async clear() {
+    if (typeof window === "undefined") return;
+    await kvStore.forEach(async (k) => {
+      if (k.startsWith(this.keyPrefix)) {
+        await kvStore.delete(k);
+      }
+    });
+  }
+};
+
+// src/sharedState.ts
 var SharedStateConfig = class {
   /**
-   * Default duration for persistence expiration in milliseconds.
+   * Default duration for storage expiration in milliseconds. Initial value
+   * is 30 days, but can be changed to anything.
    */
-  static defaultPersistExpiryMs = MS_PER_DAY;
+  static storeExpiryMs = MS_PER_DAY * 30;
   /**
-   * True to load from persistence only on mount, false (default) to load in
+   * True to load from storage only on mount, false (default) to load in
    * the top level scope when the shared state is defined.
    */
   static lazyLoad = false;
@@ -27,6 +130,9 @@ var PubSubStore = class {
     this.dataByKey.set(key, value);
     this.notify(key, value, prev);
   }
+  delete(key) {
+    this.dataByKey.delete(key);
+  }
   setNoNotify(key, value) {
     this.dataByKey.set(key, value);
   }
@@ -56,51 +162,58 @@ var PubSubStore = class {
     }
   }
 };
-var store = new PubSubStore();
+var pubSubStore = new PubSubStore();
+var STORAGE_KEY = "state";
 var stateKey = 0;
-function sharedState(defaultValue, options) {
-  const { localStorageKey, indexedDbKey, persistExpiryMs, lazyLoad } = options ?? {};
-  const key = String(stateKey++);
-  let persistenceAdapter;
-  const expiryMs = persistExpiryMs ?? SharedStateConfig.defaultPersistExpiryMs;
-  if (localStorageKey) {
-    persistenceAdapter = new LocalStorageAdapter(localStorageKey, expiryMs);
-  } else if (indexedDbKey) {
-    persistenceAdapter = new IndexedDbAdapter(indexedDbKey, expiryMs);
+var SharedState = class {
+  constructor(defaultValue, options) {
+    this.defaultValue = defaultValue;
+    this.pubSubKey = String(stateKey++);
+    this.storageAdapter = getStorageAdapter(options, DEFAULT_EXPIRY_DELTA_MS);
+    pubSubStore.setNoNotify(this.pubSubKey, defaultValue);
+    const lazyLoad = options?.lazyLoad;
+    const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
+    if (!lazy) {
+      void this.initDefaultValueOnce();
+    }
   }
-  function subscribe(subscriber) {
-    return store.subscribe(key, () => subscriber());
+  pubSubKey;
+  storageAdapter;
+  initDone = false;
+  // `subscribe` function required by useSyncExternalStore
+  subscribe(subscriber) {
+    return pubSubStore.subscribe(this.pubSubKey, () => subscriber());
   }
-  function getSnapshot() {
-    return store.get(key);
+  // Get the value of the shared state.
+  // `getSnapshot` function — must return same ref if value unchanged
+  getSnapshot() {
+    return pubSubStore.get(this.pubSubKey);
   }
-  function setValue(next) {
+  // Set the value of the shared state.
+  setValue(next) {
     if (typeof next === "function") {
-      const prev = store.get(key);
+      const prev = pubSubStore.get(this.pubSubKey);
       next = next(prev);
     }
-    store.set(key, next);
-    void persistenceAdapter?.save?.(next);
-  }
-  store.setNoNotify(key, defaultValue);
-  const state = {
-    subscribe,
-    getSnapshot,
-    // initial default handling
-    initDefaultValueOnce: async () => {
-      if (state.initDone) return;
-      state.initDone = true;
-      const v = await persistenceAdapter?.load?.();
-      store.set(key, v !== void 0 ? v : defaultValue);
-    },
-    initDone: false,
-    setValue
-  };
-  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
-  if (!lazy) {
-    void state.initDefaultValueOnce();
-  }
-  return state;
+    pubSubStore.set(this.pubSubKey, next);
+    void this.storageAdapter?.save(STORAGE_KEY, next);
+  }
+  // Remove the value of the shared state. Actually this just sets the value
+  // back to the given default value.
+  delete() {
+    pubSubStore.set(this.pubSubKey, this.defaultValue);
+    void this.storageAdapter?.save(STORAGE_KEY, this.defaultValue);
+  }
+  // Initial default handling
+  async initDefaultValueOnce() {
+    if (this.initDone) return;
+    this.initDone = true;
+    const v = await this.storageAdapter?.load(STORAGE_KEY);
+    pubSubStore.set(this.pubSubKey, v !== void 0 ? v : this.defaultValue);
+  }
+};
+function sharedState(defaultValue, options) {
+  return new SharedState(defaultValue, options);
 }
 function useSharedState(state) {
   state.initDefaultValueOnce();
@@ -118,50 +231,8 @@ function useSharedStateValue(state) {
 function useSharedStateSetter(state) {
   return useSharedState(state)[1];
 }
-var LocalStorageAdapter = class {
-  constructor(key, expiryMs) {
-    this.key = key;
-    this.expiryMs = expiryMs;
-  }
-  save(value) {
-    if (typeof window === "undefined") return;
-    window.localStorage.setItem(
-      this.key,
-      JSON.stringify({
-        value,
-        expiresAt: Date.now() + this.expiryMs
-      })
-    );
-  }
-  load() {
-    if (typeof window === "undefined") return void 0;
-    const raw = window.localStorage.getItem(this.key);
-    if (!raw) return void 0;
-    const box = JSON.parse(raw);
-    if (!box || !box?.expiresAt || Date.now() >= box.expiresAt) {
-      window.localStorage.removeItem(this.key);
-      return void 0;
-    }
-    return box.value;
-  }
-};
-var IndexedDbAdapter = class {
-  constructor(key, expiryMs) {
-    this.key = key;
-    this.expiryMs = expiryMs;
-  }
-  async save(value) {
-    if (typeof window === "undefined") return;
-    await kvStore.set(this.key, JSON.stringify(value), this.expiryMs);
-  }
-  async load() {
-    if (typeof window === "undefined") return void 0;
-    const raw = await kvStore.get(this.key);
-    if (raw === void 0) return void 0;
-    return JSON.parse(raw);
-  }
-};
 export {
+  SharedState,
   SharedStateConfig,
   sharedState,
   useSharedState,