@gateweb/react-utils 1.6.0 → 1.7.0

package/dist/cjs/index.d.ts

@@ -438,6 +438,40 @@ declare const pickByValue: <T extends object, K extends any[]>(object: T, ...val
  *
  */
 declare const deepMerge: <T extends object, U extends object>(target: T, source: U) => T & U;
+/**
+ * a utility type to make all properties of an object required
+ *
+ * @param T - the object type
+ * @param K - the keys to make required
+ * @param RemoveUndefined - whether to remove undefined from the type
+ *
+ * @example
+ *
+ * type A = { a?: number; b?: string | undefined; c?: boolean };
+ * // Even though b is required, it can be undefined
+ * type B = RequiredBy<A, 'a' | 'b'>; // { a: number; b: string | undefined; c?: boolean
+ * type C = RequiredBy<A, 'a' | 'b', true>; // { a: number; b: string; c?: boolean }
+ */
+type RequiredBy<T, K extends keyof T, RemoveUndefined extends boolean = false> = Omit<T, K> & {
+    [P in K]-?: RemoveUndefined extends true ? Exclude<T[P], undefined> : T[P];
+};
+/**
+ * a utility type to make all properties of an object optional
+ *
+ * @param T - the object type
+ * @param K - the keys to make optional
+ * @param RemoveUndefined - whether to remove undefined from the type
+ *
+ * @example
+ *
+ * type A = { a: number; b: string | undefined; c: boolean };
+ * // Even though b is optional, it can be undefined
+ * type B = PartialBy<A, 'a' | 'b'>; // { a?: number; b?: string | undefined; c: boolean }
+ * type C = PartialBy<A, 'a' | 'b', true>; // { a?: number; b?: string; c: boolean }
+ */
+type PartialBy<T, K extends keyof T, RemoveUndefined extends boolean = false> = Omit<T, K> & {
+    [P in K]?: RemoveUndefined extends true ? Exclude<T[P], undefined> : T[P];
+};
 
 /**
  * debounce function
@@ -827,4 +861,5 @@ 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, deepMerge, 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 };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, deepMerge, 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 };
+export type { PartialBy, RequiredBy, TCountdownActions };

package/dist/cjs/types.d.ts

@@ -88,6 +88,8 @@ type Entries<T> = {
  *
  * @template T - The object type to transform into keys.
  *
+ * @deprecated Use `MapToType` instead.
+ *
  * @example
  *
  * type Example = { a: number; b: string };
@@ -171,5 +173,19 @@ type DeepPartial<T> = (T extends (infer U)[] ? DeepPartial<U>[] : {
 type TChangeKeyType<T, K extends keyof T, V> = Omit<T, K> & {
     [P in K]: V;
 };
+/**
+ * A utility type that transforms an object type `T` into another object type where each value type is replaced with type `A`.
+ *
+ * @template T - The object type to transform into keys.
+ *
+ * @example
+ *
+ * type Example = { a: number; b: string };
+ * type ExampleToBoolean = MapToType<Example, boolean>;
+ * // Result: ExampleToBoolean is { a: boolean; b: boolean; }
+ */
+type MapToType<T extends Record<any, any>, A = any> = {
+    [K in keyof T]: A;
+};
 
-export type { AtLeastOne, DeepPartial, Entries, MapToString, OnlyOne, PopArgs, PushArgs, ShiftArgs, TChangeKeyType, TExtractValueType, UnshiftArgs };
+export type { AtLeastOne, DeepPartial, Entries, MapToString, MapToType, OnlyOne, PopArgs, PushArgs, ShiftArgs, TChangeKeyType, TExtractValueType, UnshiftArgs };

package/dist/es/index.d.mts

@@ -438,6 +438,40 @@ declare const pickByValue: <T extends object, K extends any[]>(object: T, ...val
  *
  */
 declare const deepMerge: <T extends object, U extends object>(target: T, source: U) => T & U;
+/**
+ * a utility type to make all properties of an object required
+ *
+ * @param T - the object type
+ * @param K - the keys to make required
+ * @param RemoveUndefined - whether to remove undefined from the type
+ *
+ * @example
+ *
+ * type A = { a?: number; b?: string | undefined; c?: boolean };
+ * // Even though b is required, it can be undefined
+ * type B = RequiredBy<A, 'a' | 'b'>; // { a: number; b: string | undefined; c?: boolean
+ * type C = RequiredBy<A, 'a' | 'b', true>; // { a: number; b: string; c?: boolean }
+ */
+type RequiredBy<T, K extends keyof T, RemoveUndefined extends boolean = false> = Omit<T, K> & {
+    [P in K]-?: RemoveUndefined extends true ? Exclude<T[P], undefined> : T[P];
+};
+/**
+ * a utility type to make all properties of an object optional
+ *
+ * @param T - the object type
+ * @param K - the keys to make optional
+ * @param RemoveUndefined - whether to remove undefined from the type
+ *
+ * @example
+ *
+ * type A = { a: number; b: string | undefined; c: boolean };
+ * // Even though b is optional, it can be undefined
+ * type B = PartialBy<A, 'a' | 'b'>; // { a?: number; b?: string | undefined; c: boolean }
+ * type C = PartialBy<A, 'a' | 'b', true>; // { a?: number; b?: string; c: boolean }
+ */
+type PartialBy<T, K extends keyof T, RemoveUndefined extends boolean = false> = Omit<T, K> & {
+    [P in K]?: RemoveUndefined extends true ? Exclude<T[P], undefined> : T[P];
+};
 
 /**
  * debounce function
@@ -827,4 +861,5 @@ 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, deepMerge, 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 };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, deepMerge, 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 };
+export type { PartialBy, RequiredBy, TCountdownActions };

package/dist/es/types.d.mts

@@ -88,6 +88,8 @@ type Entries<T> = {
  *
  * @template T - The object type to transform into keys.
  *
+ * @deprecated Use `MapToType` instead.
+ *
  * @example
  *
  * type Example = { a: number; b: string };
@@ -171,5 +173,19 @@ type DeepPartial<T> = (T extends (infer U)[] ? DeepPartial<U>[] : {
 type TChangeKeyType<T, K extends keyof T, V> = Omit<T, K> & {
     [P in K]: V;
 };
+/**
+ * A utility type that transforms an object type `T` into another object type where each value type is replaced with type `A`.
+ *
+ * @template T - The object type to transform into keys.
+ *
+ * @example
+ *
+ * type Example = { a: number; b: string };
+ * type ExampleToBoolean = MapToType<Example, boolean>;
+ * // Result: ExampleToBoolean is { a: boolean; b: boolean; }
+ */
+type MapToType<T extends Record<any, any>, A = any> = {
+    [K in keyof T]: A;
+};
 
-export type { AtLeastOne, DeepPartial, Entries, MapToString, OnlyOne, PopArgs, PushArgs, ShiftArgs, TChangeKeyType, TExtractValueType, UnshiftArgs };
+export type { AtLeastOne, DeepPartial, Entries, MapToString, MapToType, OnlyOne, PopArgs, PushArgs, ShiftArgs, TChangeKeyType, TExtractValueType, UnshiftArgs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [
@@ -37,7 +37,9 @@
   "dependencies": {
     "dayjs": "^1.11.13",
     "react": "^19.0.0",
-    "react-dom": "^19.0.0"
+    "react-dom": "^19.0.0",
+    "use-sync-external-store": "^1.5.0",
+    "zustand": "^5.0.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",