@gateweb/react-utils 1.4.0 → 1.4.2

package/dist/cjs/index.d.ts

@@ -1,4 +1,4 @@
-import { TExtractValueType } from './types.js';
+import { TExtractValueType, AtLeastOne } from './types.js';
 export * from './types.js';
 import React from 'react';
 
@@ -347,6 +347,21 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+type TValueOptions<T> = AtLeastOne<{
+    /**
+     * The controlled value.
+     */
+    value?: T;
+    /**
+     * The default value.
+     */
+    defaultValue?: T;
+}>;
+/**
+ *
+ */
+declare const useValue: <T>({ value, defaultValue }: TValueOptions<T>) => readonly [T, (newValue: T) => void];
+
 declare function invariant(condition: any, message?: string | (() => string)): asserts condition;
 
 /**
@@ -789,4 +804,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useValue, validTaxId, validateDateString, validateFileType, wait };

package/dist/cjs/index.js

@@ -2,7 +2,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var dayjs = require('dayjs');
 var useCountdownClient = require('./useCountdown-client-CNjGBIUB.js');
-require('react');
+var react = require('react');
 var downloadClient = require('./download-client-DKxkL92w.js');
 var webStorageClient = require('./webStorage-client-BGQKUfrO.js');
 
@@ -473,6 +473,28 @@ const transformObjectKey = (obj, transformFunName)=>{
     }
 };
 
+/**
+ *
+ */ 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
+    ];
+};
+
 // const isProduction: boolean = process.env.NODE_ENV === 'production';
 const prefix = 'Invariant failed';
 // Throw an error if the condition fails
@@ -926,6 +948,7 @@ exports.snakeCase2PascalCase = snakeCase2PascalCase;
 exports.snakeString2CamelString = snakeString2CamelString;
 exports.snakeString2PascalString = snakeString2PascalString;
 exports.throttle = throttle;
+exports.useValue = useValue;
 exports.validTaxId = validTaxId;
 exports.validateDateString = validateDateString;
 exports.validateFileType = validateFileType;

package/dist/es/index.d.mts

@@ -1,4 +1,4 @@
-import { TExtractValueType } from './types.mjs';
+import { TExtractValueType, AtLeastOne } from './types.mjs';
 export * from './types.mjs';
 import React from 'react';
 
@@ -347,6 +347,21 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+type TValueOptions<T> = AtLeastOne<{
+    /**
+     * The controlled value.
+     */
+    value?: T;
+    /**
+     * The default value.
+     */
+    defaultValue?: T;
+}>;
+/**
+ *
+ */
+declare const useValue: <T>({ value, defaultValue }: TValueOptions<T>) => readonly [T, (newValue: T) => void];
+
 declare function invariant(condition: any, message?: string | (() => string)): asserts condition;
 
 /**
@@ -789,4 +804,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useValue, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/index.mjs

@@ -1,6 +1,6 @@
 import dayjs from 'dayjs';
 export { u as useCountdown } from './useCountdown-client-t52WIHfq.mjs';
-import 'react';
+import { useState, useCallback } from 'react';
 export { d as downloadFile } from './download-client-CnaJ0p_f.mjs';
 export { g as getLocalStorage, s as setLocalStorage } from './webStorage-client-Pd-loNCg.mjs';
 
@@ -467,6 +467,28 @@ const transformObjectKey = (obj, transformFunName)=>{
     }
 };
 
+/**
+ *
+ */ 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
+    ];
+};
+
 // const isProduction: boolean = process.env.NODE_ENV === 'production';
 const prefix = 'Invariant failed';
 // Throw an error if the condition fails
@@ -870,4 +892,4 @@ function mergeRefs(refs) {
  */ const wait = (ms)=>{
 };
 
-export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useValue, validTaxId, validateDateString, validateFileType, wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [