@gateweb/react-utils 0.0.1 → 0.0.3

package/dist/cjs/index.d.ts

@@ -263,6 +263,8 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+declare function invariant(condition: any, message?: string | (() => string)): asserts condition;
+
 /**
  * 判斷執行環境是否為 Server(node.js) 端
  */
@@ -290,25 +292,6 @@ declare const omit: <T extends object, K extends [...(keyof T)[]]>(object: T, ..
  * const b = omitByValue(a, undefined, null); // { c: 3, d: 4 }
  */
 declare const omitByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? never : K2; }[keyof T]>;
-/**
- * 將指定格式的物件轉換成類似 enum 的物件
- *
- * @param enumObject enum 物件
- * @param valueKey value 的 key
- *
- * @example
- *
- * ```js
- * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
- * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
- */
-declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any; }>, K extends string>(enumObject: T, valueKey: K) => { [key in keyof T]: T[key][K]; };
 
 /**
  * debounce function
@@ -617,4 +600,28 @@ 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, debounce, downloadFile, extractEnumLikeObject, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType };
+/**
+ * 從對象類型中提取特定屬性的值類型。
+ *
+ * @template T 要處理的對象類型
+ * @template K 要提取的屬性名（字符串字面量類型）
+ *
+ * @description
+ * 這個類型用於從一個對象類型 T 中提取指定屬性 K 的值類型。
+ * T 應該是一個對象，其每個屬性都是另一個包含 K 屬性的對象。
+ * 如果 T 不符合這個結構，或者指定的屬性 K 不存在，則返回 never。
+ *
+ * @example
+ * type Obj = {
+ *   a: { value: string },
+ *   b: { value: number }
+ * };
+ * type Result = ExtractValueType<Obj, 'value'>; // string | number
+ *
+ * @returns 返回 T 中所有 K 屬性值的聯合類型，如果不符合條件則返回 never
+ */
+type TExtractValueType<T, K extends string> = T extends Record<string, {
+    [P in K]: infer R;
+}> ? R : never;
+
+export { type TCountdownActions, type TExtractValueType, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, debounce, downloadFile, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType };

package/dist/cjs/index.js

@@ -376,6 +376,32 @@ const transformObjectKey = (obj, transformFunName)=>{
     }
 };
 
+// const isProduction: boolean = process.env.NODE_ENV === 'production';
+const prefix = 'Invariant failed';
+// Throw an error if the condition fails
+// Strip out error messages for production
+// > Not providing an inline default argument for message as the result is smaller
+function invariant(condition, // Can provide a string, or a function that returns a string for cases where
+// the message takes a fair amount of effort to compute
+message) {
+    if (condition) {
+        return;
+    }
+    // Condition not passed
+    // In production we strip the message but still throw
+    if (process.env.NODE_ENV === 'production') {
+        throw new Error(prefix);
+    }
+    // When not in production we allow the message to pass through
+    // *This block will be removed in production builds*
+    const provided = typeof message === 'function' ? message() : message;
+    // Options:
+    // 1. message provided: `${prefix}: ${provided}`
+    // 2. message not provided: prefix
+    const value = provided ? `${prefix}: ${provided}` : prefix;
+    throw new Error(value);
+}
+
 /**
  * 判斷執行環境是否為 Server(node.js) 端
  */ const isServer = ()=>typeof window === 'undefined';
@@ -416,27 +442,6 @@ const transformObjectKey = (obj, transformFunName)=>{
             [key]: value
         };
     }, {});
-/**
- * 將指定格式的物件轉換成類似 enum 的物件
- *
- * @param enumObject enum 物件
- * @param valueKey value 的 key
- *
- * @example
- *
- * ```js
- * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
- * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
- */ const extractEnumLikeObject = (enumObject, valueKey)=>Object.entries(enumObject).reduce((acc, [key, value])=>({
-            ...acc,
-            [key]: value[valueKey]
-        }), {});
 
 /**
  * debounce function
@@ -679,12 +684,12 @@ exports.camelCase2SnakeCase = camelCase2SnakeCase;
 exports.camelString2PascalString = camelString2PascalString;
 exports.camelString2SnakeString = camelString2SnakeString;
 exports.debounce = debounce;
-exports.extractEnumLikeObject = extractEnumLikeObject;
 exports.formatAmount = formatAmount;
 exports.formatStarMask = formatStarMask;
 exports.generatePeriodArray = generatePeriodArray;
 exports.getCurrentPeriod = getCurrentPeriod;
 exports.getMimeType = getMimeType;
+exports.invariant = invariant;
 exports.isChinese = isChinese;
 exports.isDateString = isDateString;
 exports.isDateTimeString = isDateTimeString;

package/dist/es/index.d.mts

@@ -263,6 +263,8 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+declare function invariant(condition: any, message?: string | (() => string)): asserts condition;
+
 /**
  * 判斷執行環境是否為 Server(node.js) 端
  */
@@ -290,25 +292,6 @@ declare const omit: <T extends object, K extends [...(keyof T)[]]>(object: T, ..
  * const b = omitByValue(a, undefined, null); // { c: 3, d: 4 }
  */
 declare const omitByValue: <T extends object, K extends any[]>(object: T, ...values: K) => Pick<T, { [K2 in keyof T]: T[K2] extends K[number] ? never : K2; }[keyof T]>;
-/**
- * 將指定格式的物件轉換成類似 enum 的物件
- *
- * @param enumObject enum 物件
- * @param valueKey value 的 key
- *
- * @example
- *
- * ```js
- * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
- * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
- */
-declare const extractEnumLikeObject: <T extends Record<string, { [P in K]: any; }>, K extends string>(enumObject: T, valueKey: K) => { [key in keyof T]: T[key][K]; };
 
 /**
  * debounce function
@@ -617,4 +600,28 @@ 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, debounce, downloadFile, extractEnumLikeObject, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType };
+/**
+ * 從對象類型中提取特定屬性的值類型。
+ *
+ * @template T 要處理的對象類型
+ * @template K 要提取的屬性名（字符串字面量類型）
+ *
+ * @description
+ * 這個類型用於從一個對象類型 T 中提取指定屬性 K 的值類型。
+ * T 應該是一個對象，其每個屬性都是另一個包含 K 屬性的對象。
+ * 如果 T 不符合這個結構，或者指定的屬性 K 不存在，則返回 never。
+ *
+ * @example
+ * type Obj = {
+ *   a: { value: string },
+ *   b: { value: number }
+ * };
+ * type Result = ExtractValueType<Obj, 'value'>; // string | number
+ *
+ * @returns 返回 T 中所有 K 屬性值的聯合類型，如果不符合條件則返回 never
+ */
+type TExtractValueType<T, K extends string> = T extends Record<string, {
+    [P in K]: infer R;
+}> ? R : never;
+
+export { type TCountdownActions, type TExtractValueType, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, debounce, downloadFile, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType };

package/dist/es/index.mjs

@@ -370,6 +370,32 @@ const transformObjectKey = (obj, transformFunName)=>{
     }
 };
 
+// const isProduction: boolean = process.env.NODE_ENV === 'production';
+const prefix = 'Invariant failed';
+// Throw an error if the condition fails
+// Strip out error messages for production
+// > Not providing an inline default argument for message as the result is smaller
+function invariant(condition, // Can provide a string, or a function that returns a string for cases where
+// the message takes a fair amount of effort to compute
+message) {
+    if (condition) {
+        return;
+    }
+    // Condition not passed
+    // In production we strip the message but still throw
+    if (process.env.NODE_ENV === 'production') {
+        throw new Error(prefix);
+    }
+    // When not in production we allow the message to pass through
+    // *This block will be removed in production builds*
+    const provided = typeof message === 'function' ? message() : message;
+    // Options:
+    // 1. message provided: `${prefix}: ${provided}`
+    // 2. message not provided: prefix
+    const value = provided ? `${prefix}: ${provided}` : prefix;
+    throw new Error(value);
+}
+
 /**
  * 判斷執行環境是否為 Server(node.js) 端
  */ const isServer = ()=>typeof window === 'undefined';
@@ -410,27 +436,6 @@ const transformObjectKey = (obj, transformFunName)=>{
             [key]: value
         };
     }, {});
-/**
- * 將指定格式的物件轉換成類似 enum 的物件
- *
- * @param enumObject enum 物件
- * @param valueKey value 的 key
- *
- * @example
- *
- * ```js
- * const myObj = {
- *    A: { value: 'a' },
- *    B: { value: 'b', other: 'other' },
- * }
- *
- * const enumCode = extractEnumLikeObject(myObj, 'value');
- * console.log(enumCode); // { A: 'a', B: 'b' }
- * ```
- */ const extractEnumLikeObject = (enumObject, valueKey)=>Object.entries(enumObject).reduce((acc, [key, value])=>({
-            ...acc,
-            [key]: value[valueKey]
-        }), {});
 
 /**
  * debounce function
@@ -663,4 +668,4 @@ const transformObjectKey = (obj, transformFunName)=>{
  * formatString('123456', 1, 4) // '1****6'
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
 
-export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, debounce, extractEnumLikeObject, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, debounce, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType };

package/package.json

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