@gateweb/react-utils 1.17.0 → 2.0.0

package/dist/cjs/client.d.ts

@@ -0,0 +1,289 @@
+import React, { ReactNode } from 'react';
+import { AtLeastOne } from './types.js';
+
+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/cjs/client.js

@@ -0,0 +1,119 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var store12s = require('./store-12s-s9lu_ZPn.js');
+var queryStore12s = require('./queryStore-12s-JzzXvjJC.js');
+var React = require('react');
+var useCountdown12s = require('./useCountdown-12s-uiqhgllY.js');
+var useDisclosure12s = require('./useDisclosure-12s-SZtbSE4A.js');
+var download12s = require('./download-12s-DKxkL92w.js');
+var webStorage12s = require('./webStorage-12s-0RtNO_uc.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var React__default = /*#__PURE__*/_interopDefault(React);
+
+/**
+ * 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__*/ React.createContext(undefined);
+    const useDataContext = ()=>{
+        const context = React.useContext(Context);
+        if (context === undefined) {
+            throw new Error(`useDataContext must be used within a DataProvider`);
+        }
+        return context;
+    };
+    const DataProvider = ({ children, value })=>{
+        const memoized = React.useMemo(()=>value, [
+            value
+        ]);
+        return /*#__PURE__*/ React__default.default.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] = React.useState(defaultValue);
+    const setValue = React.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;
+            }
+        });
+    };
+}
+
+exports.createStoreContext = store12s.createStoreContext;
+exports.QueryProvider = queryStore12s.QueryProvider;
+exports.useQueryContext = queryStore12s.useQueryContext;
+exports.useCountdown = useCountdown12s.useCountdown;
+exports.useDisclosure = useDisclosure12s.useDisclosure;
+exports.downloadFile = download12s.downloadFile;
+exports.getLocalStorage = webStorage12s.getLocalStorage;
+exports.setLocalStorage = webStorage12s.setLocalStorage;
+exports.createDataContext = createDataContext;
+exports.mergeRefs = mergeRefs;
+exports.useValue = useValue;

package/dist/cjs/index.d.ts

@@ -1,5 +1,3 @@
-import React, { ReactNode } from 'react';
-import { AtLeastOne } from './types.js';
 export * from './types.js';
 
 /**
@@ -1183,162 +1181,6 @@ declare const validateDateString: (dateString: string, format: string) => boolea
  */
 declare const isNil: (value: unknown) => value is null | undefined;
 
-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
- */
-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);
- * ```
- */
-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>;
-
 /**
  * 民國年轉西元年
  * @param dateString 日期字串
@@ -1390,38 +1232,5 @@ declare const generatePeriodArray: () => string[];
  */
 declare const getCurrentPeriod: () => string;
 
-/**
- * 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 { ByteSize, MimeTypeMap, OtherMimeType, QueryProvider, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createDataContext, createEnumLikeObject, debounce, decodeBase64, decodeJson, deepClone, deepMerge, downloadFile, encodeBase64, encodeJson, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, mergeRefs, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useDisclosure, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
-export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy, TCountdownActions, UseDisclosureReturn };
+export { ByteSize, MimeTypeMap, OtherMimeType, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, decodeBase64, decodeJson, deepClone, deepMerge, encodeBase64, encodeJson, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };
+export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy };