@gateweb/react-utils 1.17.0 → 2.0.0

package/dist/cjs/{queryStore-12s-q_SLGgYH.js → queryStore-12s-JzzXvjJC.js}

@@ -30,6 +30,8 @@ const createQueryStore = ({ query, handleChangeQuery })=>zustand.createStore()((
 const QueryContext = /*#__PURE__*/ React.createContext(null);
 /**
  * Provider to provide the store to the context
+ *
+ * @deprecated use `StoreProvider` from `core/store` instead
  */ const QueryProvider = ({ children, query, handleChangeQuery })=>{
     const storeRef = React.useRef(null);
     if (!storeRef.current) {
@@ -61,6 +63,8 @@ const QueryContext = /*#__PURE__*/ React.createContext(null);
  * const result2 = useQueryContext<MyObject>()(q => q.changeQuery);
  * const result3 = useQueryContext<MyObject>()(q => q.query);
  * ```
+ *
+ * @deprecated use `useStoreContext` from `core/store` instead
  */ const useQueryContext = ()=>{
     const store = React.useContext(QueryContext);
     if (!store) throw new Error('Missing QueryContext.Provider in the tree');

package/dist/cjs/store-12s-s9lu_ZPn.js

@@ -0,0 +1,122 @@
+'use client';
+var React = require('react');
+var zustand = require('zustand');
+var traditional = require('zustand/traditional');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var React__default = /*#__PURE__*/_interopDefault(React);
+
+const isObject = (value)=>value !== null && typeof value === 'object';
+/**
+ * merge two objects deeply
+ *
+ * @param target - the target object
+ * @param source - the source object
+ *
+ * @example
+ *
+ * const obja = { a: { a1: { a11: 'value 1', a12: 'value 2' }, a2: 'value 3' }, b: 'value 4' };
+ * const objb = { a: { a1: { a13: 'value 5', a14: 'value 6' }, a3: 'value 7' }};
+ *
+ * const mergeResult = deepMerge(obja, objb); // { a: { a1: { a11: 'value 1', a12: 'value 2', a13: 'value 5', a14: 'value 6' }, a2: 'value 3', a3: 'value 7' }, b: 'value 4' }
+ *
+ */ const deepMerge = (target, source)=>Object.entries(source).reduce((acc, [key, value])=>{
+        if (isObject(value)) {
+            acc[key] = key in target && isObject(target[key]) ? deepMerge(target[key], value) : value;
+        } else {
+            acc[key] = value;
+        }
+        return acc;
+    }, {
+        ...target
+    });
+
+/**
+ * create a zustand store with changeStore method
+ */ const createZustandStore = ({ store, handleChangeStore, defaultMerge })=>zustand.createStore()((set)=>({
+            store,
+            changeStore: (updater, options)=>{
+                set((pre)=>{
+                    const patch = typeof updater === 'function' ? updater(pre.store) : updater;
+                    const newStore = handleChangeStore ? handleChangeStore(pre.store, patch) : patch;
+                    const strategy = options?.merge ?? defaultMerge;
+                    if (strategy === 'shallow') {
+                        return {
+                            store: {
+                                ...pre.store,
+                                ...newStore
+                            }
+                        };
+                    }
+                    return {
+                        store: deepMerge(pre.store, newStore)
+                    };
+                });
+            }
+        }));
+/**
+ * create a store context with provider and hooks
+ *
+ * @example
+ *
+ * ```tsx
+ * // create a store context
+ * const { StoreProvider, useStore, useStoreApi } = createStoreContext<MyObject>();
+ *
+ * // use the StoreProvider to provide the store to the context
+ * <StoreProvider store={{ key: 'value' }}>
+ *   <App />
+ * </StoreProvider>
+ * ```
+ */ const createStoreContext = ()=>{
+    const StoreContext = /*#__PURE__*/ React.createContext(null);
+    /**
+   * Provider to provide the store to the context
+   *
+   * @example
+   *
+   * ```tsx
+   * // use the StoreProvider to provide the store to the context
+   * const { StoreProvider } = createStoreContext<MyObject>();
+   *
+   * <StoreProvider store={{ key: 'value' }}>
+   *   <App />
+   * </StoreProvider>
+   * ```
+   */ const StoreProvider = ({ children, store = {}, handleChangeStore, defaultMerge = 'shallow' })=>{
+        const storeRef = React.useRef(null);
+        if (!storeRef.current) {
+            storeRef.current = createZustandStore({
+                store,
+                handleChangeStore,
+                defaultMerge
+            });
+        }
+        return /*#__PURE__*/ React__default.default.createElement(StoreContext.Provider, {
+            value: storeRef.current
+        }, children);
+    };
+    /**
+   * a hook to get the store from the context
+   *
+   * @example
+   * ```tsx
+   * const { useStore } = createStoreContext<MyObject>();
+   * const value = useStore(s => s.store);
+   * ```
+   *
+   * @param selector - the selector to get the state from the store
+   * @param equalityFn - the equality function to compare the previous and next state
+   */ const useStore = (selector, equalityFn)=>{
+        const store = React.useContext(StoreContext);
+        if (!store) throw new Error('Missing StoreContext.Provider in the tree');
+        return traditional.useStoreWithEqualityFn(store, selector, equalityFn);
+    };
+    return {
+        StoreProvider,
+        useStore
+    };
+};
+
+exports.createStoreContext = createStoreContext;

package/dist/cjs/webStorage-12s-0RtNO_uc.js

@@ -0,0 +1,136 @@
+'use client';
+/* eslint-disable no-bitwise */ const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+/**
+ * 將位元組陣列編碼為 base64 字串
+ *
+ * @param bytes 要編碼的位元組陣列
+ * @returns base64 編碼的字串
+ *
+ * @example
+ * ```ts
+ * const bytes = new TextEncoder().encode('Hello World');
+ * const encoded = encodeBase64(bytes);
+ * console.log(encoded); // 'SGVsbG8gV29ybGQ='
+ * ```
+ */ const encodeBase64 = (bytes)=>{
+    let out = '';
+    for(let i = 0; i < bytes.length; i += 3){
+        const n = bytes[i] << 16 | (bytes[i + 1] || 0) << 8 | (bytes[i + 2] || 0);
+        out += chars[n >> 18 & 63] + chars[n >> 12 & 63] + (i + 1 < bytes.length ? chars[n >> 6 & 63] : '=') + (i + 2 < bytes.length ? chars[n & 63] : '=');
+    }
+    return out;
+};
+/**
+ * 將 base64 字串解碼為位元組陣列
+ *
+ * @param base64 要解碼的 base64 字串（支援 base64url 格式）
+ * @returns 解碼後的位元組陣列
+ *
+ * @example
+ * ```ts
+ * const decoded = decodeBase64('SGVsbG8gV29ybGQ=');
+ * const text = new TextDecoder().decode(decoded);
+ * console.log(text); // 'Hello World'
+ * ```
+ */ const decodeBase64 = (base64)=>{
+    let out = base64.replace(/-/g, '+').replace(/_/g, '/'); // 支援 base64url
+    while(out.length % 4)out += '='; // 自動補 "="
+    const buffer = [];
+    for(let i = 0; i < out.length; i += 4){
+        const n = chars.indexOf(out[i]) << 18 | chars.indexOf(out[i + 1]) << 12 | (chars.indexOf(out[i + 2]) & 63) << 6 | chars.indexOf(out[i + 3]) & 63;
+        buffer.push(n >> 16 & 255);
+        if (out[i + 2] !== '=') buffer.push(n >> 8 & 255);
+        if (out[i + 3] !== '=') buffer.push(n & 255);
+    }
+    return new Uint8Array(buffer);
+};
+/**
+ * 將 JSON 資料編碼為 base64 字串
+ *
+ * @param data 要編碼的 JSON 可序列化資料
+ * @returns base64 編碼的字串
+ *
+ * @example
+ * ```ts
+ * const data = { name: 'John', age: 30 };
+ * const encoded = encodeJson(data);
+ * console.log(encoded); // 'eyJuYW1lIjoiSm9obiIsImFnZSI6MzB9'
+ *
+ * const array = [1, 2, 3];
+ * const encodedArray = encodeJson(array);
+ * ```
+ */ const encodeJson = (data)=>{
+    const json = JSON.stringify(data);
+    return encodeBase64(new TextEncoder().encode(json));
+};
+/**
+ * 將 base64 字串解碼為 JSON 資料
+ *
+ * @param b64 要解碼的 base64 字串
+ * @returns 解碼後的資料
+ *
+ * @example
+ * ```ts
+ * const encoded = 'eyJuYW1lIjoiSm9obiIsImFnZSI6MzB9';
+ * const decoded = decodeJson<{ name: string; age: number }>(encoded);
+ * console.log(decoded); // { name: 'John', age: 30 }
+ *
+ * const decodedArray = decodeJson<number[]>(encodedArray);
+ * ```
+ */ const decodeJson = (b64)=>{
+    const json = new TextDecoder().decode(decodeBase64(b64));
+    return JSON.parse(json);
+};
+
+/**
+ * 從 localStorage 取得資料，支援槽狀取值(Json 物件)
+ *
+ * @param key 鍵值
+ * @param deCode 是否解碼
+ * @returns 取得的資料
+ * @example
+ * const data = getLocalStorage('key');
+ *
+ * const data = getLocalStorage('key.subKey');
+ */ const getLocalStorage = (key, deCode = true)=>{
+    const keys = key.split('.');
+    const storage = localStorage.getItem(keys[0]);
+    if (!storage) return undefined;
+    let currentObject;
+    try {
+        if (deCode) {
+            currentObject = decodeJson(storage);
+        } else {
+            currentObject = JSON.parse(storage);
+        }
+    } catch (_error) {
+        return undefined;
+    }
+    // let currentObject = JSON.parse(storage);
+    if (keys.length === 1) {
+        return currentObject;
+    }
+    keys.shift();
+    while(keys.length > 0){
+        const currentKey = keys.shift();
+        if (!currentKey) break;
+        currentObject = currentObject[currentKey];
+        if (!currentObject) break;
+    }
+    return currentObject;
+};
+/**
+ * 將資料(Json 物件)存入 localStorage
+ * @param key 鍵值
+ * @param value 可序列化的資料
+ * @param enCode 是否編碼
+ */ const setLocalStorage = (key, value, enCode = true)=>{
+    if (enCode) {
+        localStorage.setItem(key, encodeJson(value));
+    } else {
+        localStorage.setItem(key, JSON.stringify(value));
+    }
+};
+
+exports.getLocalStorage = getLocalStorage;
+exports.setLocalStorage = setLocalStorage;

package/dist/es/client.d.mts

@@ -0,0 +1,289 @@
+import React, { ReactNode } from 'react';
+import { AtLeastOne } from './types.mjs';
+
+type TStoreProps<S> = {
+    /**
+     * the store object
+     */
+    store: Partial<S>;
+};
+type TStoreObject<S> = TStoreProps<S>['store'];
+type TStoreState<S> = {
+    /**
+     * trigger the change of store
+     *
+     * @param updater - the new store or a update function
+     * @param options - the options for changing the store
+     *
+     * @example
+     * ```tsx
+     * // update with new store object
+     * changeStore({ key: 'newValue' });
+     * // update with a function
+     * changeStore(preStore => ({ ...preStore, key: 'newValue' }));
+     * ```
+     */
+    changeStore: (updater: TStoreObject<S> | ((preStore: TStoreObject<S>) => TStoreObject<S>), options?: {
+        merge: TInitialProps$1<S>['defaultMerge'];
+    }) => void;
+} & TStoreProps<S>;
+type TInitialProps$1<S> = TStoreProps<S> & {
+    /**
+     * handle the change of store when calling `changeStore`
+     *
+     * @param preStore - the previous store
+     * @param newStore - the new store
+     *
+     * @example
+     *
+     * ```tsx
+     * <StoreProvider store={{ key: 'value' }} handleChangeStore={(preStore, newStore) => {
+     *   // Special handling: reset key when changing anotherKey
+     *   if (newStore.anotherKey && newStore.anotherKey !== preStore.anotherKey) {
+     *     return {
+     *       ...preStore,
+     *       ...newStore,
+     *       key: 'resetValue',
+     *     };
+     *   }
+     *   return {
+     *     ...preStore,
+     *     ...newStore,
+     *   };
+     * }}>
+     *   <App />
+     * </StoreProvider>
+     * ```
+     */
+    handleChangeStore?: (preStore: TStoreObject<S>, newStore: TStoreObject<S>) => TStoreObject<S>;
+    /**
+     * the default merge strategy when calling `changeStore`
+     *
+     * @default 'shallow'
+     *
+     * @example
+     *
+     * ```tsx
+     * // shallow merge
+     * <StoreProvider store={{ key: 'value', anotherKey: { nestedKey: 'nestedValue' } }}>
+     * // deep merge
+     * <StoreProvider store={{ key: 'value', anotherKey: { nestedKey: 'nestedValue' } }} defaultMerge="deep">
+     * ```
+     */
+    defaultMerge: 'shallow' | 'deep';
+};
+/**
+ * create a store context with provider and hooks
+ *
+ * @example
+ *
+ * ```tsx
+ * // create a store context
+ * const { StoreProvider, useStore, useStoreApi } = createStoreContext<MyObject>();
+ *
+ * // use the StoreProvider to provide the store to the context
+ * <StoreProvider store={{ key: 'value' }}>
+ *   <App />
+ * </StoreProvider>
+ * ```
+ */
+declare const createStoreContext: <S>() => {
+    StoreProvider: ({ children, store, handleChangeStore, defaultMerge, }: React.PropsWithChildren<Partial<TInitialProps$1<S>>>) => React.JSX.Element;
+    useStore: <T>(selector: (state: TStoreState<S>) => T, equalityFn?: (left: T, right: T) => boolean) => T;
+};
+
+type TQueryProps<Q> = {
+    /**
+     * the query object
+     */
+    query: Partial<Q>;
+};
+type TQueryState<Q> = {
+    /**
+     * trigger the change of query
+     *
+     * @param query - the new query
+     */
+    changeQuery: (query: TQueryProps<Q>['query']) => void;
+} & TQueryProps<Q>;
+type TInitialProps<Q> = Partial<TQueryProps<Q> & {
+    /**
+     * handle the change of query when calling `changeQuery`
+     *
+     * @param preQuery - the previous query
+     * @param newQuery - the new query
+     * @returns the custom new query
+     */
+    handleChangeQuery: (preQuery: TQueryProps<Q>['query'], newQuery: TQueryProps<Q>['query']) => TQueryProps<Q>['query'];
+}>;
+/**
+ * Provider to provide the store to the context
+ *
+ * @deprecated use `StoreProvider` from `core/store` instead
+ */
+declare const QueryProvider: <Q>({ children, query, handleChangeQuery, }: React.PropsWithChildren<TInitialProps<Q>>) => React.JSX.Element;
+/**
+ * hook to get the store from the context
+ *
+ * because we want the return type of `selector` to be inferred by ts, we use HOF to implement the hook
+ *
+ * so you should use it like this:
+ *
+ * ```tsx
+ * const useQuery = useQueryContext<MyObject>(); // => will return the store hook
+ * const result = useQuery(q => q.query); // => will return the query object
+ * ```
+ *
+ * @example
+ *
+ * ```tsx
+ * const result1 = useQueryContext<MyObject>()(q => '1234');
+ * const result2 = useQueryContext<MyObject>()(q => q.changeQuery);
+ * const result3 = useQueryContext<MyObject>()(q => q.query);
+ * ```
+ *
+ * @deprecated use `useStoreContext` from `core/store` instead
+ */
+declare const useQueryContext: <Q>() => <T>(selector: (state: TQueryState<Q>) => T, equalityFn?: (left: T, right: T) => boolean) => T;
+
+/**
+ * Creates a strongly-typed React Context and Provider pair for data sharing.
+ *
+ * This utility helps you avoid prop drilling by providing a reusable way to define
+ * context with strict type inference. It returns a custom hook for consuming the context
+ * and a Provider component for supplying context values.
+ *
+ * @template T - The value type for the context.
+ * @returns {object} An object containing:
+ *   - useDataContext: A custom hook to access the context value. Throws an error if used outside the provider.
+ *   - DataProvider: A Provider component to wrap your component tree and supply the context value.
+ *
+ * @example
+ * // Example usage:
+ * const { useDataContext, DataProvider } = createDataContext<{ count: number }>();
+ *
+ * function Counter() {
+ *   const { count } = useDataContext();
+ *   return <span>{count}</span>;
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <DataProvider value={{ count: 42 }}>
+ *       <Counter />
+ *     </DataProvider>
+ *   );
+ * }
+ */
+declare const createDataContext: <T>() => {
+    readonly useDataContext: () => T & ({} | null);
+    readonly DataProvider: ({ children, value }: {
+        children: ReactNode;
+        value: T;
+    }) => React.JSX.Element;
+};
+
+type TCountdownActions = {
+    /** 目前秒數 */
+    countdown: number;
+    /** 是否正在倒數計時 */
+    isCounting: boolean;
+    /** 開始倒數計時 */
+    start: () => void;
+    /** 停止倒數計時 */
+    stop: () => void;
+    /** 重置倒數計時 */
+    reset: () => void;
+};
+/**
+ * 倒數計時器
+ *
+ * 可以透過 start() 來啟動倒數計時器
+ * 可以透過 stop() 來停止倒數計時器
+ * 可以透過 reset() 來重置倒數計時器
+ *
+ * @param initialCountdown 倒數計時器初始值
+ * @param enableReinitialize 允許重設初始值
+ */
+declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
+
+type UseDisclosureReturn = {
+    /** Whether the disclosure is currently open. */
+    isOpen: boolean;
+    /** Open the disclosure (sets isOpen = true). */
+    open: () => void;
+    /** Close the disclosure (sets isOpen = false). */
+    close: () => void;
+    /** Toggle the disclosure state (open -> close or close -> open). */
+    toggle: () => void;
+};
+/**
+ * A small hook to control open/close state.
+ *
+ * Supports an optional controlled pattern by passing `isOpen` and `onChange`.
+ *
+ * @example
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ */
+declare function useDisclosure(initialState?: boolean): UseDisclosureReturn;
+
+type TValueOptions<T> = AtLeastOne<{
+    /**
+     * The controlled value.
+     */
+    value?: T;
+    /**
+     * The default value.
+     */
+    defaultValue?: T;
+}>;
+/**
+ * A hook to manage a value.
+ *
+ * @example
+ *
+ * ```tsx
+ * const MyComponent = ({ value }: { value?: number }) => {
+ *    const [currentValue, setCurrentValue] = useValue({ value });
+ * };
+ * ```
+ */
+declare const useValue: <T>({ value, defaultValue }: TValueOptions<T>) => readonly [T, (newValue: T) => void];
+
+declare function mergeRefs<T = any>(refs: Array<React.MutableRefObject<T> | React.LegacyRef<T> | undefined | null>): React.RefCallback<T>;
+
+/**
+ * Downloads a file from a given source.
+ *
+ * @param source - The source of the file to be downloaded. It can be a URL string or a Blob object.
+ * @param filename - The name of the file to be downloaded. Defaults to the current timestamp if not provided.
+ * @param fileExtension - The file extension to be appended to the filename. Optional.
+ *
+ * @example
+ * downloadFile('http://example.com/file.txt', 'testfile', 'txt');
+ * downloadFile(new Blob(['test content'], { type: 'text/plain' }), 'testfile', 'txt');
+ */
+declare const downloadFile: (source: string | Blob, filename?: string, fileExtension?: string) => void;
+
+/**
+ * 從 localStorage 取得資料，支援槽狀取值(Json 物件)
+ *
+ * @param key 鍵值
+ * @param deCode 是否解碼
+ * @returns 取得的資料
+ * @example
+ * const data = getLocalStorage('key');
+ *
+ * const data = getLocalStorage('key.subKey');
+ */
+declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefined;
+/**
+ * 將資料(Json 物件)存入 localStorage
+ * @param key 鍵值
+ * @param value 可序列化的資料
+ * @param enCode 是否編碼
+ */
+declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
+
+export { QueryProvider, createDataContext, createStoreContext, downloadFile, getLocalStorage, mergeRefs, setLocalStorage, useCountdown, useDisclosure, useQueryContext, useValue };
+export type { TCountdownActions, UseDisclosureReturn };

package/dist/es/client.mjs

@@ -0,0 +1,103 @@
+export { c as createStoreContext } from './store-12s-DsXc3Uo0.mjs';
+export { Q as QueryProvider, u as useQueryContext } from './queryStore-12s-Dkb-Af1n.mjs';
+import React, { useMemo, createContext, useContext, useState, useCallback } from 'react';
+export { u as useCountdown } from './useCountdown-12s-t52WIHfq.mjs';
+export { u as useDisclosure } from './useDisclosure-12s-BQAHpAXK.mjs';
+export { d as downloadFile } from './download-12s-CnaJ0p_f.mjs';
+export { g as getLocalStorage, s as setLocalStorage } from './webStorage-12s-Bo7x8q5t.mjs';
+
+/**
+ * Creates a strongly-typed React Context and Provider pair for data sharing.
+ *
+ * This utility helps you avoid prop drilling by providing a reusable way to define
+ * context with strict type inference. It returns a custom hook for consuming the context
+ * and a Provider component for supplying context values.
+ *
+ * @template T - The value type for the context.
+ * @returns {object} An object containing:
+ *   - useDataContext: A custom hook to access the context value. Throws an error if used outside the provider.
+ *   - DataProvider: A Provider component to wrap your component tree and supply the context value.
+ *
+ * @example
+ * // Example usage:
+ * const { useDataContext, DataProvider } = createDataContext<{ count: number }>();
+ *
+ * function Counter() {
+ *   const { count } = useDataContext();
+ *   return <span>{count}</span>;
+ * }
+ *
+ * function App() {
+ *   return (
+ *     <DataProvider value={{ count: 42 }}>
+ *       <Counter />
+ *     </DataProvider>
+ *   );
+ * }
+ */ const createDataContext = ()=>{
+    const Context = /*#__PURE__*/ createContext(undefined);
+    const useDataContext = ()=>{
+        const context = useContext(Context);
+        if (context === undefined) {
+            throw new Error(`useDataContext must be used within a DataProvider`);
+        }
+        return context;
+    };
+    const DataProvider = ({ children, value })=>{
+        const memoized = useMemo(()=>value, [
+            value
+        ]);
+        return /*#__PURE__*/ React.createElement(Context.Provider, {
+            value: memoized
+        }, children);
+    };
+    return {
+        useDataContext,
+        DataProvider
+    };
+};
+
+/**
+ * A hook to manage a value.
+ *
+ * @example
+ *
+ * ```tsx
+ * const MyComponent = ({ value }: { value?: number }) => {
+ *    const [currentValue, setCurrentValue] = useValue({ value });
+ * };
+ * ```
+ */ const useValue = ({ value, defaultValue })=>{
+    if (value === undefined && defaultValue === undefined) {
+        throw new Error('Either `value` or `defaultValue` must be provided.');
+    }
+    const isControlled = value !== undefined;
+    const [internalValue, setInternalValue] = useState(defaultValue);
+    const setValue = useCallback((newValue)=>{
+        if (!isControlled) {
+            setInternalValue(newValue);
+        }
+    }, [
+        isControlled
+    ]);
+    const currentValue = isControlled ? value : internalValue;
+    return [
+        currentValue,
+        setValue
+    ];
+};
+
+function mergeRefs(refs) {
+    return (value)=>{
+        refs.forEach((ref)=>{
+            if (typeof ref === 'function') {
+                ref(value);
+            } else if (ref != null) {
+                // eslint-disable-next-line no-param-reassign
+                ref.current = value;
+            }
+        });
+    };
+}
+
+export { createDataContext, mergeRefs, useValue };