@choksheak/react-utils 0.3.5 → 0.3.7

package/sharedState.cjs

@@ -20,7 +20,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/sharedState.ts
 var sharedState_exports = {};
 __export(sharedState_exports, {
-  SharedState: () => SharedState,
   SharedStateConfig: () => SharedStateConfig,
   configureSharedState: () => configureSharedState,
   sharedState: () => sharedState,
@@ -43,70 +42,12 @@ function getStorageAdapter(options, defaultStoreExpiryMs) {
   }
   if ("persistTo" in store && typeof store.persistTo === "string" && "key" in store && typeof store.key === "string") {
     const expiryMs = store.expiryMs || defaultStoreExpiryMs;
-    const isValid = store.isValid;
+    const config = { ...store, expiryMs };
     switch (store.persistTo) {
-      case "localStorage": {
-        const adapter = new import_localStore.LocalStore(store.key, {
-          defaultExpiryMs: expiryMs
-        });
-        return {
-          set: (key, value) => {
-            if (IS_NOT_BROWSER) return;
-            adapter.set(key, value);
-          },
-          get: (key) => {
-            if (IS_NOT_BROWSER) return void 0;
-            const value = adapter.get(key);
-            if (isValid && !isValid(value)) {
-              console.warn(
-                `localStorage adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`
-              );
-              adapter.delete(key);
-              return void 0;
-            }
-            return value;
-          },
-          delete: (key) => {
-            if (IS_NOT_BROWSER) return;
-            adapter.delete(key);
-          },
-          clear: () => {
-            if (IS_NOT_BROWSER) return;
-            adapter.clear();
-          }
-        };
-      }
-      case "indexedDb": {
-        const keyPrefix = store.key + ":";
-        const isValid2 = store.isValid;
-        return {
-          set: async (key, value) => {
-            if (IS_NOT_BROWSER) return;
-            await import_kvStore.kvStore.set(keyPrefix + key, value, expiryMs);
-          },
-          get: async (key) => {
-            if (IS_NOT_BROWSER) return void 0;
-            const fullKey = keyPrefix + key;
-            const value = await import_kvStore.kvStore.get(fullKey);
-            if (isValid2 && !isValid2(value)) {
-              console.warn(
-                `indexedDb adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`
-              );
-              await import_kvStore.kvStore.delete(fullKey);
-              return void 0;
-            }
-            return value;
-          },
-          delete: async (key) => {
-            if (IS_NOT_BROWSER) return;
-            await import_kvStore.kvStore.delete(keyPrefix + key);
-          },
-          clear: async () => {
-            if (IS_NOT_BROWSER) return;
-            await import_kvStore.kvStore.clear();
-          }
-        };
-      }
+      case "localStorage":
+        return localStoreAdapter(config);
+      case "indexedDb":
+        return kvStoreAdapter(config);
       default:
         store.persistTo;
         throw new Error(`Unknown store.adapter ${store.persistTo}`);
@@ -114,6 +55,73 @@ function getStorageAdapter(options, defaultStoreExpiryMs) {
   }
   return store;
 }
+function localStoreAdapter({
+  key,
+  expiryMs,
+  isValid
+}) {
+  const adapter = (0, import_localStore.createLocalStore)(key, { defaultExpiryMs: expiryMs });
+  return {
+    set: (key2, value) => {
+      if (IS_NOT_BROWSER) return;
+      adapter.set(key2, value);
+    },
+    get: (key2) => {
+      if (IS_NOT_BROWSER) return void 0;
+      const value = adapter.get(key2);
+      if (isValid && !isValid(value)) {
+        console.warn(
+          `localStorage adapter: Auto-discard invalid value for ${key2}: ${JSON.stringify(value)}`
+        );
+        adapter.delete(key2);
+        return void 0;
+      }
+      return value;
+    },
+    delete: (key2) => {
+      if (IS_NOT_BROWSER) return;
+      adapter.delete(key2);
+    },
+    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 (isValid && !isValid(value)) {
+        console.warn(
+          `indexedDb adapter: Auto-discard invalid value for ${key2}: ${JSON.stringify(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();
+    }
+  };
+}
 
 // src/sharedState.ts
 var SharedStateConfig = {
@@ -131,41 +139,11 @@ var SharedStateConfig = {
 function configureSharedState(config) {
   Object.assign(SharedStateConfig, config);
 }
-var PubSubStore = class {
-  dataByKey = /* @__PURE__ */ new Map();
-  subscribersByKey = /* @__PURE__ */ new Map();
-  // 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 this.dataByKey.get(key);
-  }
-  set(key, value) {
-    const prev = this.dataByKey.get(key);
-    if (prev === value) return;
-    this.dataByKey.set(key, value);
-    this.notify(key, value, prev);
-  }
-  delete(key) {
-    this.dataByKey.delete(key);
-  }
-  setNoNotify(key, value) {
-    this.dataByKey.set(key, value);
-  }
-  // Subscribe to changes of a specific key
-  subscribe(key, subscriber) {
-    let subscribers = this.subscribersByKey.get(key);
-    if (!subscribers) {
-      subscribers = /* @__PURE__ */ new Set();
-      this.subscribersByKey.set(key, subscribers);
-    }
-    subscribers.add(subscriber);
-    return () => {
-      subscribers.delete(subscriber);
-      if (subscribers.size === 0) this.subscribersByKey.delete(key);
-    };
-  }
-  notify(key, next, prev) {
-    const subscribers = this.subscribersByKey.get(key);
+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) {
@@ -176,116 +154,149 @@ var PubSubStore = class {
       }
     }
   }
-};
-var pubSubStore = new PubSubStore();
+  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);
+      };
+    }
+  };
+}
+var pubSubStore = createPubSubStore();
 var STORAGE_KEY = "state";
 var stateKey = 0;
-var SharedState = class {
-  constructor(defaultValue, options) {
-    this.defaultValue = defaultValue;
-    this.pubSubKey = String(stateKey++);
-    this.storageAdapter = getStorageAdapter(
-      options,
-      SharedStateConfig.storeExpiryMs
-    );
-    this.setValueBounded = (next) => {
-      this.setValue(next);
-    };
-    pubSubStore.setNoNotify(this.pubSubKey, defaultValue);
-    const lazyLoad = options?.lazyLoad;
-    const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
-    if (!lazy) {
-      void this.initDefaultValueOnce();
-    }
-  }
-  pubSubKey;
-  storageAdapter;
-  setValueBounded;
-  initStarted = false;
-  initDone = false;
-  /** `subscribe` function required by useSyncExternalStore. */
-  subscribe(subscriber) {
-    return pubSubStore.subscribe(this.pubSubKey, () => subscriber());
-  }
-  /** Returns true if there is a backing store. */
-  hasStore() {
-    return Boolean(this.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.
-   */
-  async setInStore(value) {
-    return await this.storageAdapter?.set(STORAGE_KEY, value);
-  }
-  /**
-   * Get a value directly from the store. Returns undefined if there is no
-   * backing store.
-   */
-  async getFromStore() {
-    return await this.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(this.pubSubKey);
-  }
-  /** Set the value of the shared state. */
-  setValue(next) {
-    if (typeof next === "function") {
-      const prev = pubSubStore.get(this.pubSubKey);
-      next = next(prev);
+function sharedState(defaultValue, options) {
+  let readyResolve = () => {
+  };
+  const readyPromise = new Promise((resolve) => {
+    readyResolve = resolve;
+  });
+  const resolveReadyPromise = readyResolve;
+  const pubSubKey = String(stateKey++);
+  const storageAdapter = getStorageAdapter(
+    options,
+    SharedStateConfig.storeExpiryMs
+  );
+  pubSubStore.setNoNotify(pubSubKey, defaultValue);
+  const lazyLoad = options?.lazyLoad;
+  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateConfig.lazyLoad;
+  const obj = {
+    /** 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.
+     */
+    async setInStore(value) {
+      return await storageAdapter?.set(STORAGE_KEY, value);
+    },
+    /**
+     * Get a value directly from the store. Returns undefined if there is no
+     * backing store.
+     */
+    async getFromStore() {
+      return await 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);
+      void storageAdapter?.set(STORAGE_KEY, defaultValue);
+    },
+    /** Initial default handling. */
+    async initDefaultValueOnce() {
+      if (obj.initDone || obj.initStarted) return;
+      obj.initStarted = true;
+      const stored = await obj.getFromStore();
+      const value = stored !== void 0 ? stored : defaultValue;
+      pubSubStore.set(pubSubKey, value);
+      obj.initDone = true;
+      resolveReadyPromise();
     }
-    pubSubStore.set(this.pubSubKey, next);
-    void this.setInStore(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?.set(STORAGE_KEY, this.defaultValue);
-  }
-  /** Initial default handling. */
-  async initDefaultValueOnce() {
-    if (this.initDone || this.initStarted) return;
-    this.initStarted = true;
-    const stored = await this.getFromStore();
-    const value = stored !== void 0 ? stored : this.defaultValue;
-    pubSubStore.set(this.pubSubKey, value);
-    this.initDone = true;
+  };
+  if (!lazy) {
+    void obj.initDefaultValueOnce();
   }
-};
-function sharedState(defaultValue, options) {
-  return new SharedState(defaultValue, options);
+  return obj;
 }
 function useSharedState(state) {
-  state.initDefaultValueOnce();
+  void state.initDefaultValueOnce();
   const value = (0, import_react.useSyncExternalStore)(
     (onStoreChange) => state.subscribe(onStoreChange),
     () => state.getSnapshot(),
     // getServerSnapshot is needed to prevent SSR dev errors in nextjs.
     () => state.getSnapshot()
   );
-  return [value, state.setValueBounded];
+  return [value, state.setValue];
 }
 function useSharedStateValue(state) {
   return useSharedState(state)[0];
 }
 function useSharedStateSetter(state) {
-  return useSharedState(state)[1];
+  void state.initDefaultValueOnce();
+  return state.setValue;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  SharedState,
   SharedStateConfig,
   configureSharedState,
   sharedState,

package/sharedState.d.mts

@@ -1,18 +1,31 @@
-import { Dispatch, SetStateAction } from 'react';
+import { SetStateAction, Dispatch } from 'react';
 import { StorageOptions } from './storage.mjs';
+import '@choksheak/ts-utils/duration';
 import '@choksheak/ts-utils/storageAdapter';
 
 /**
  * @packageDocumentation
  *
  * The "shared state" is a React state that shares the same value across the
- * entire app. It is largely similar to the jotai library, but is much smaller
- * and much easier to work with when used for persisting in local storage or
- * indexed db, with an automatic expiration for persisted values.
+ * entire app. Users declare a shared state constant that can be reused across
+ * multiple components with the same underlying value.
  *
- * This library aims to be the shortest, simplest, easiest to use, and most
- * efficient implementation of shared global React states with seamless support
- * for client persistence.
+ * Shared states provide persistence to local storage and/or indexed DB out of
+ * the box, by using "@choksheak/ts-utils". Note that no matter if the shared
+ * state uses persistence or not, it will always maintain a copy of the state
+ * in memory. Persisted values can be configured with an automatic expiration
+ * duration.
+ *
+ * This module is largely similar to the open source "jotai" npm library. You
+ * can use shared states to replace "jotai" in your code, and optionally make
+ * use of the persistence mechanism. A quick migration guide from jotai is:
+ *
+ * ```
+ *   atom()          -->  sharedState()
+ *   useAtom()       -->  useSharedState()
+ *   useAtomValue()  -->  useSharedStateValue()
+ *   useSetAtom()    -->  useSharedStateSetter()
+ * ```
  *
  * Example:
  * ```
@@ -22,7 +35,9 @@ import '@choksheak/ts-utils/storageAdapter';
  *   // The first argument is the default value, which is required.
  *   // The second argument is an options object, and is optional (defaults
  *   // to storing in memory only without any persistence).
- *   const usersState = sharedState([], { indexedDbKey: "users" });
+ *   const usersState = sharedState(
+ *     [], { store: { persistTo: "indexedDb", key: "users" }}
+ *   );
  *
  *   export const UsersComponent: React.FC = () => {
  *     // Get both the value and the setter.
@@ -68,19 +83,24 @@ declare function configureSharedState(config: Partial<SharedStateConfig>): void;
 type SharedStateOptions<T> = {
     lazyLoad?: boolean;
 } & StorageOptions<T>;
-/** Please use sharedState() instead. */
-declare class SharedState<T> {
-    private readonly defaultValue;
-    private readonly pubSubKey;
-    private readonly storageAdapter;
-    readonly setValueBounded: Dispatch<SetStateAction<T>>;
-    initStarted: boolean;
-    initDone: boolean;
-    constructor(defaultValue: T, options?: SharedStateOptions<T>);
+/**
+ * Create a new shared state object. Put this code at the top level scope:
+ *
+ * Example:
+ * ```
+ *   const counterState = sharedState<number>(0);
+ * ```
+ */
+declare function sharedState<T>(defaultValue: T, options?: SharedStateOptions<T>): {
+    /** Allow users to await for the completion of data init. */
+    readonly readyPromise: Promise<void>;
+    readonly lazy: boolean;
+    readonly initStarted: false;
+    readonly initDone: false;
     /** `subscribe` function required by useSyncExternalStore. */
-    subscribe(subscriber: () => void): () => void;
+    readonly subscribe: (subscriber: () => void) => () => void;
     /** Returns true if there is a backing store. */
-    hasStore(): boolean;
+    readonly hasStore: () => boolean;
     /**
      * Set a value directly into the store. Does nothing if there is no
      * backing store.
@@ -88,38 +108,30 @@ declare class SharedState<T> {
      * Warning: If you want to set the value properly, you should use
      * `setValue()` instead which also updates the in-memory copy.
      */
-    setInStore(value: T): Promise<void>;
+    readonly setInStore: (value: T) => Promise<void>;
     /**
      * Get a value directly from the store. Returns undefined if there is no
      * backing store.
      */
-    getFromStore(): Promise<T | undefined>;
+    readonly getFromStore: () => Promise<T | undefined>;
     /**
      * 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(): T;
+    readonly getSnapshot: () => T;
     /** Set the value of the shared state. */
-    setValue(next: SetStateAction<T>): void;
+    readonly setValue: (next: SetStateAction<T>) => void;
     /**
      * Remove the value of the shared state. Actually this just sets the value
      * back to the given default value.
      */
-    delete(): void;
+    readonly delete: () => void;
     /** Initial default handling. */
-    initDefaultValueOnce(): Promise<void>;
-}
-/**
- * Create a new shared state object. Put this code at the top level scope:
- *
- * Example:
- * ```
- *   const counterState = sharedState<number>(0);
- * ```
- */
-declare function sharedState<T>(defaultValue: T, options?: SharedStateOptions<T>): SharedState<T>;
+    readonly initDefaultValueOnce: () => Promise<void>;
+};
+type SharedState<T> = ReturnType<typeof sharedState<T>>;
 /**
  * React hook for subscribing to a key in the global store.
  *
@@ -146,6 +158,6 @@ declare function useSharedStateValue<T>(state: SharedState<T>): T;
  *   const setCounter = useSharedStateSetter(counterState);
  * ```
  */
-declare function useSharedStateSetter<T>(state: SharedState<T>): Dispatch<SetStateAction<T>>;
+declare function useSharedStateSetter<T>(state: SharedState<T>): (next: SetStateAction<T>) => void;
 
-export { SharedState, SharedStateConfig, type SharedStateOptions, configureSharedState, sharedState, useSharedState, useSharedStateSetter, useSharedStateValue };
+export { type SharedState, SharedStateConfig, type SharedStateOptions, configureSharedState, sharedState, useSharedState, useSharedStateSetter, useSharedStateValue };