@gateweb/react-utils 0.0.5 → 1.1.0

package/README.md

@@ -1,2 +1,74 @@
 # react-utils
-React Utils for GateWeb
+
+**_react-utils_** is a collection of utility functions for GateWeb's React projects.
+
+## Installation
+
+```bash
+npm install @gateweb/react-utils
+# or
+yarn add @gateweb/react-utils
+# or
+pnpm add @gateweb/react-utils
+```
+
+## Usage
+
+```tsx
+import { formatAmount } from '@gateweb/react-utils';
+```
+
+## How to Release a New Version
+
+### Manually Bump the Version
+
+1. Update the version in `package.json`
+
+   ```diff
+   # e.g. bump the version from 0.1.0 to 0.1.1
+   {
+       "name": "@gateweb/react-utils",
+   -   "version": "0.1.0"
+   +   "version": "0.1.1"
+   }
+   ```
+
+2. Install the dependencies and build the package
+
+   ```sh
+   pnpm install
+   pnpm build
+   ```
+
+3. login to npm
+
+   ```sh
+   # make sure you have an npm account
+   pnpm login
+   # npm notice Log in on https://registry.npmjs.org/
+   # Login at:
+   # https://www.npmjs.com/login?next=/login/cli/390e514d-7aa5-4ee7-a13a-b17e6dd64518
+   # Press ENTER to open in the browser...
+   ```
+
+4. Publish the package
+
+   ```sh
+   pnpm publish --access public --no-git-checks
+   ```
+
+5. Check the published package on npmjs.com
+
+   [@gateweb/react-utils](https://www.npmjs.com/package/@gateweb/react-utils)
+
+### Automatically Bump the Version
+
+- When you merge a pull request to the `main` branch, the GitHub Action will automatically bump the version and publish the package to npm.
+
+- The version will follow the [Semantic Versioning](https://semver.org/) rules.
+
+## Notes
+
+- You should use `pnpm` to develop this package.
+- This package is written in TypeScript and supports TypeScript out of the box.
+- This package is built with [bunchee](https://github.com/huozhi/bunchee) which is a zero-config build tool for TypeScript packages based on Rollup.

package/dist/cjs/index.d.ts

@@ -268,6 +268,23 @@ declare const createEnumLikeObject: <T extends Record<string, {
     key: string;
 }[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
 
+/**
+ * simulate a fake api request
+ *
+ * @param returnValue the value to return
+ * @param result the result of the request
+ * @param time the time to wait before resolving
+ *
+ * @example
+ *
+ * const result = await fakeApi({ foo: 'bar' });
+ * console.log(result); // { result: true, data: { foo: 'bar' } }
+ */
+declare const fakeApi: <T>(returnValue: T, result?: boolean, time?: number) => Promise<{
+    result: boolean;
+    data: T;
+}>;
+
 /**
  * 檢查檔案是否為合法的 MIME 類型
  *
@@ -587,6 +604,24 @@ declare const formatAmount: (num: number) => string;
  * formatString('123456', 1, 4) // '1****6'
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */
+declare const formatBytes: (bytes: number, decimals?: number) => string;
 
 /**
  * 檢查稅務編號是否符合正確的編號規則。
@@ -632,6 +667,12 @@ declare const validTaxId: (taxId: string) => boolean;
  */
 declare const validateDateString: (dateString: string, format: string) => boolean;
 
+/**
+ * Wait for a given amount of time
+ * @param ms time to wait in milliseconds
+ */
+declare const wait: (ms: number) => void;
+
 /**
  * Downloads a file from a given source.
  *
@@ -665,4 +706,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, 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 };
+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, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/cjs/index.js

@@ -379,6 +379,26 @@ const transformObjectKey = (obj, transformFunName)=>{
     };
 };
 
+/**
+ * simulate a fake api request
+ *
+ * @param returnValue the value to return
+ * @param result the result of the request
+ * @param time the time to wait before resolving
+ *
+ * @example
+ *
+ * const result = await fakeApi({ foo: 'bar' });
+ * console.log(result); // { result: true, data: { foo: 'bar' } }
+ */ const fakeApi = (returnValue, result = true, time = 1000)=>new Promise((resolve)=>{
+        setTimeout(()=>{
+            resolve({
+                result,
+                data: returnValue
+            });
+        }, time);
+    });
+
 /**
  * 檢查檔案是否為合法的 MIME 類型
  *
@@ -745,6 +765,45 @@ message) {
  *
  * formatString('123456', 1, 4) // '1****6'
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */ const formatBytes = (bytes, decimals = 0)=>{
+    if (bytes === 0) return '0 Bytes';
+    const k = 1024;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${(bytes / k ** i).toFixed(decimals)} ${sizes[i]}`;
+};
+
+/**
+ * Wait for a given amount of time
+ * @param ms time to wait in milliseconds
+ */ const wait = (ms)=>{
+};
 
 exports.useCountdown = useCountdownClient.useCountdown;
 exports.downloadFile = downloadClient.downloadFile;
@@ -758,7 +817,9 @@ exports.camelString2SnakeString = camelString2SnakeString;
 exports.createEnumLikeObject = createEnumLikeObject;
 exports.debounce = debounce;
 exports.extractEnumLikeObject = extractEnumLikeObject;
+exports.fakeApi = fakeApi;
 exports.formatAmount = formatAmount;
+exports.formatBytes = formatBytes;
 exports.formatStarMask = formatStarMask;
 exports.generatePeriodArray = generatePeriodArray;
 exports.getCurrentPeriod = getCurrentPeriod;
@@ -793,3 +854,4 @@ exports.throttle = throttle;
 exports.validTaxId = validTaxId;
 exports.validateDateString = validateDateString;
 exports.validateFileType = validateFileType;
+exports.wait = wait;

package/dist/es/index.d.mts

@@ -268,6 +268,23 @@ declare const createEnumLikeObject: <T extends Record<string, {
     key: string;
 }[] : (value: TExtractValueType<T, "value">) => string | TExtractValueType<T, "value">; };
 
+/**
+ * simulate a fake api request
+ *
+ * @param returnValue the value to return
+ * @param result the result of the request
+ * @param time the time to wait before resolving
+ *
+ * @example
+ *
+ * const result = await fakeApi({ foo: 'bar' });
+ * console.log(result); // { result: true, data: { foo: 'bar' } }
+ */
+declare const fakeApi: <T>(returnValue: T, result?: boolean, time?: number) => Promise<{
+    result: boolean;
+    data: T;
+}>;
+
 /**
  * 檢查檔案是否為合法的 MIME 類型
  *
@@ -587,6 +604,24 @@ declare const formatAmount: (num: number) => string;
  * formatString('123456', 1, 4) // '1****6'
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */
+declare const formatBytes: (bytes: number, decimals?: number) => string;
 
 /**
  * 檢查稅務編號是否符合正確的編號規則。
@@ -632,6 +667,12 @@ declare const validTaxId: (taxId: string) => boolean;
  */
 declare const validateDateString: (dateString: string, format: string) => boolean;
 
+/**
+ * Wait for a given amount of time
+ * @param ms time to wait in milliseconds
+ */
+declare const wait: (ms: number) => void;
+
 /**
  * Downloads a file from a given source.
  *
@@ -665,4 +706,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, 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 };
+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, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/index.mjs

@@ -373,6 +373,26 @@ const transformObjectKey = (obj, transformFunName)=>{
     };
 };
 
+/**
+ * simulate a fake api request
+ *
+ * @param returnValue the value to return
+ * @param result the result of the request
+ * @param time the time to wait before resolving
+ *
+ * @example
+ *
+ * const result = await fakeApi({ foo: 'bar' });
+ * console.log(result); // { result: true, data: { foo: 'bar' } }
+ */ const fakeApi = (returnValue, result = true, time = 1000)=>new Promise((resolve)=>{
+        setTimeout(()=>{
+            resolve({
+                result,
+                data: returnValue
+            });
+        }, time);
+    });
+
 /**
  * 檢查檔案是否為合法的 MIME 類型
  *
@@ -739,5 +759,44 @@ message) {
  *
  * formatString('123456', 1, 4) // '1****6'
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */ const formatBytes = (bytes, decimals = 0)=>{
+    if (bytes === 0) return '0 Bytes';
+    const k = 1024;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${(bytes / k ** i).toFixed(decimals)} ${sizes[i]}`;
+};
+
+/**
+ * Wait for a given amount of time
+ * @param ms time to wait in milliseconds
+ */ const wait = (ms)=>{
+};
 
-export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, 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 };
+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, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };

package/package.json

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