@nickyzj2023/utils 1.0.16 → 1.0.18

package/src/network.ts

@@ -1,111 +1,111 @@
-import { isObject } from "./is";
-import { mergeObjects } from "./object";
-
-export type RequestInit = BunFetchRequestInit & {
-  parser?: (response: Response) => Promise<any>;
-};
-
-/**
- * 基于 Fetch API 的请求客户端
- * @param baseURL 接口前缀，如 https://nickyzj.run:3030，也可以不填
- * @param defaultOptions 客户端级别的请求选项，方法级别的选项会覆盖这里的相同值
- *
- * @remarks
- * 特性：
- * - 合并客户端级别、方法级别的请求选项
- * - 在 body 里直接传递对象
- * - 可选择使用 to() 处理返回结果为 [Error, Response]
- * - 可选择使用 withCache() 缓存请求结果
- *
- * @example
- * // 用法1：创建客户端
- * const api = fetcher("https://nickyzj.run:3030", { headers: { Authorization: "Bearer token" } });
- * const res = await api.get<Blog>("/blogs/hello-world");
- *
- * // 用法2：直接发送请求
- * const res = await fetcher().get<Blog>("https://nickyzj.run:3030/blogs/hello-world");
- *
- * // 安全处理返回结果
- * const [error, data] = await to(api.get<Blog>("/blogs/hello-world"));
- * if (error) {
- *   console.error(error);
- *   return;
- * }
- *
- * // 缓存请求结果
- * const getBlogs = withCache(api.get);
- * await getBlogs("/blogs");
- * await sleep(1000);
- * await getBlogs("/blogs");  // 不请求，使用缓存结果
- */
-export const fetcher = (baseURL = "", defaultOptions: RequestInit = {}) => {
-  const createRequest = async <T>(
-    path: string,
-    requestOptions: RequestInit = {},
-  ) => {
-    // 构建完整 URL
-    const url = baseURL ? `${baseURL}${path}` : path;
-
-    // 合并 options
-    const { parser, ...options } = mergeObjects(defaultOptions, requestOptions);
-
-    // 转换 body 为字符串
-    if (isObject(options.body)) {
-      options.body = JSON.stringify(options.body);
-      options.headers = {
-        ...options.headers,
-        "Content-Type": "application/json",
-      };
-    }
-
-    // 发送请求
-    const response = await fetch(url, options);
-    if (!response.ok) {
-      throw new Error(response.statusText);
-    }
-
-    const data = await (parser?.(response) ?? response.json());
-    return data as T;
-  };
-
-  return {
-    get: <T>(url: string, options: Omit<RequestInit, "method"> = {}) =>
-      createRequest<T>(url, { ...options, method: "GET" }),
-
-    post: <T>(
-      url: string,
-      body: any,
-      options: Omit<RequestInit, "method" | "body"> = {},
-    ) => createRequest<T>(url, { ...options, method: "POST", body }),
-
-    put: <T>(
-      url: string,
-      body: any,
-      options: Omit<RequestInit, "method" | "body"> = {},
-    ) => createRequest<T>(url, { ...options, method: "PUT", body }),
-
-    delete: <T>(
-      url: string,
-      options: Omit<RequestInit, "method" | "body"> = {},
-    ) => createRequest<T>(url, { ...options, method: "DELETE" }),
-  };
-};
-
-/**
- * Go 语言风格的异步处理方式
- * @param promise 一个能被 await 的异步函数
- * @returns 如果成功，返回 [null, 异步函数结果]，否则返回 [Error, undefined]
- *
- * @example
- * const [error, response] = await to(fetcher().get<Blog>("/blogs/hello-world"));
- */
-export const to = async <T, U = Error>(
-  promise: Promise<T>,
-): Promise<[null, T] | [U, undefined]> => {
-  try {
-    const response = await promise;
-    return [null, response];
-  } catch (error) {
-    return [error as U, undefined];
-  }
-};
+import { isObject } from "./is";
+import { mergeObjects } from "./object";
+
+export type RequestInit = BunFetchRequestInit & {
+  parser?: (response: Response) => Promise<any>;
+};
+
+/**
+ * 基于 Fetch API 的请求客户端
+ * @param baseURL 接口前缀，如 https://nickyzj.run:3030，也可以不填
+ * @param defaultOptions 客户端级别的请求选项，方法级别的选项会覆盖这里的相同值
+ *
+ * @remarks
+ * 特性：
+ * - 合并客户端级别、方法级别的请求选项
+ * - 在 body 里直接传递对象
+ * - 可选择使用 to() 处理返回结果为 [Error, Response]
+ * - 可选择使用 withCache() 缓存请求结果
+ *
+ * @example
+ * // 用法1：创建客户端
+ * const api = fetcher("https://nickyzj.run:3030", { headers: { Authorization: "Bearer token" } });
+ * const res = await api.get<Blog>("/blogs/hello-world");
+ *
+ * // 用法2：直接发送请求
+ * const res = await fetcher().get<Blog>("https://nickyzj.run:3030/blogs/hello-world");
+ *
+ * // 安全处理返回结果
+ * const [error, data] = await to(api.get<Blog>("/blogs/hello-world"));
+ * if (error) {
+ *   console.error(error);
+ *   return;
+ * }
+ *
+ * // 缓存请求结果
+ * const getBlogs = withCache(api.get);
+ * await getBlogs("/blogs");
+ * await sleep(1000);
+ * await getBlogs("/blogs");  // 不请求，使用缓存结果
+ */
+export const fetcher = (baseURL = "", defaultOptions: RequestInit = {}) => {
+  const createRequest = async <T>(
+    path: string,
+    requestOptions: RequestInit = {},
+  ) => {
+    // 构建完整 URL
+    const url = baseURL ? `${baseURL}${path}` : path;
+
+    // 合并 options
+    const { parser, ...options } = mergeObjects(defaultOptions, requestOptions);
+
+    // 转换 body 为字符串
+    if (isObject(options.body)) {
+      options.body = JSON.stringify(options.body);
+      options.headers = {
+        ...options.headers,
+        "Content-Type": "application/json",
+      };
+    }
+
+    // 发送请求
+    const response = await fetch(url, options);
+    if (!response.ok) {
+      throw new Error(response.statusText);
+    }
+
+    const data = await (parser?.(response) ?? response.json());
+    return data as T;
+  };
+
+  return {
+    get: <T>(url: string, options: Omit<RequestInit, "method"> = {}) =>
+      createRequest<T>(url, { ...options, method: "GET" }),
+
+    post: <T>(
+      url: string,
+      body: any,
+      options: Omit<RequestInit, "method" | "body"> = {},
+    ) => createRequest<T>(url, { ...options, method: "POST", body }),
+
+    put: <T>(
+      url: string,
+      body: any,
+      options: Omit<RequestInit, "method" | "body"> = {},
+    ) => createRequest<T>(url, { ...options, method: "PUT", body }),
+
+    delete: <T>(
+      url: string,
+      options: Omit<RequestInit, "method" | "body"> = {},
+    ) => createRequest<T>(url, { ...options, method: "DELETE" }),
+  };
+};
+
+/**
+ * Go 语言风格的异步处理方式
+ * @param promise 一个能被 await 的异步函数
+ * @returns 如果成功，返回 [null, 异步函数结果]，否则返回 [Error, undefined]
+ *
+ * @example
+ * const [error, response] = await to(fetcher().get<Blog>("/blogs/hello-world"));
+ */
+export const to = async <T, U = Error>(
+  promise: Promise<T>,
+): Promise<[null, T] | [U, undefined]> => {
+  try {
+    const response = await promise;
+    return [null, response];
+  } catch (error) {
+    return [error as U, undefined];
+  }
+};

package/src/object.ts

@@ -50,3 +50,116 @@ export const mergeObjects = <
 
   return result as T & U;
 };
+
+// --- mapKeys ---
+
+// 这里的 DeepMapKeys 只能承诺 key 是 string，无法推断出 key 的具体字面量变化
+// 因为 TS 不支持根据任意函数反推 Key 的字面量类型
+export type DeepMapKeys<T> =
+  T extends Array<infer U>
+    ? Array<DeepMapKeys<U>>
+    : T extends object
+      ? { [key: string]: DeepMapKeys<T[keyof T]> }
+      : T;
+
+/**
+ * 递归处理对象里的 key
+ *
+ * @remarks
+ * 无法完整推导出类型，只能做到有递归，key 全为 string，value 为同层级的所有类型的联合
+ *
+ * @template T 要转换的对象
+ *
+ * @example
+ * const obj = { a: { b: 1 } };
+ * const result = mapKeys(obj, (key) => key.toUpperCase());
+ * console.log(result); // { A: { B: 1 } }
+ */
+export const mapKeys = <T>(
+  obj: T,
+  getNewKey: (key: string) => string,
+): DeepMapKeys<T> => {
+  // 递归处理数组
+  if (Array.isArray(obj)) {
+    return obj.map((item) => mapKeys(item, getNewKey)) as any;
+  }
+
+  // 处理普通对象
+  if (isObject(obj)) {
+    const keys = Object.keys(obj);
+    return keys.reduce(
+      (result, key) => {
+        const newKey = getNewKey(key);
+        const value = (obj as any)[key];
+        result[newKey] = mapKeys(value, getNewKey);
+        return result;
+      },
+      {} as Record<string, any>,
+    ) as DeepMapKeys<T>;
+  }
+
+  // 处理非数组/对象
+  return obj as any;
+};
+
+// --- mapValues ---
+
+// 这里的 DeepMapValues 尝试保留 key，但将 value 类型替换为 R
+// 注意：如果原 value 是对象，我们递归处理结构，而不是把整个对象变成 R
+export type DeepMapValues<T, R> =
+  T extends Array<infer U>
+    ? Array<DeepMapValues<U, R>>
+    : T extends object
+      ? { [K in keyof T]: T[K] extends object ? DeepMapValues<T[K], R> : R }
+      : R;
+
+/**
+ * 递归处理对象里的 value
+ *
+ * @remarks
+ * 无法完整推导出类型，所有 value 最终都会变为 any
+ *
+ * @template T 要转换的对象
+ * @template R 转换后的值类型，为 any，无法进一步推导
+ *
+ * @example
+ * const obj = { a: 1, b: { c: 2 } };
+ * const result = mapValues(obj, (value, key) => isPrimitive(value) ? value + 1 : value);
+ * console.log(result); // { a: 2, b: { c: 3 } }
+ */
+export const mapValues = <T, R = any>(
+  obj: T,
+  getNewValue: (value: any, key: string | number) => R,
+): DeepMapValues<T, R> => {
+  // 处理数组
+  if (Array.isArray(obj)) {
+    return obj.map((item, index) => {
+      // 如果元素是对象，则递归处理
+      if (isObject(item)) {
+        return mapValues(item, getNewValue);
+      }
+      // 如果元素是原始值，则直接应用 getNewValue（此时 key 为数组下标）
+      return getNewValue(item, index);
+    }) as any;
+  }
+
+  // 处理普通对象
+  if (isObject(obj)) {
+    const keys = Object.keys(obj);
+    return keys.reduce((result, key) => {
+      const value = (obj as any)[key];
+      // 如果值为对象或数组，则递归处理
+      if (!isPrimitive(value)) {
+        result[key] = mapValues(value, getNewValue);
+      }
+      // 否则直接应用 getNewValue
+      else {
+        result[key] = getNewValue(value, key);
+      }
+      return result;
+    }, {} as any) as DeepMapValues<T, R>;
+  }
+
+  // 处理非数组/对象
+  return obj as any;
+};

package/src/string.ts

@@ -0,0 +1,22 @@
+/**
+ * 转换下划线命名法为驼峰命名法
+ *
+ * @example
+ * snakeToCamel("user_name") // 'userName'
+ */
+export const snakeToCamel = (str: string) => {
+  return str.replace(/_([a-zA-Z])/g, (match, pattern) => pattern.toUpperCase());
+};
+
+/**
+ * 转换驼峰命名法为下划线命名法
+ *
+ * @example
+ * camelToSnake("shouldComponentUpdate") // 'should_component_update'
+ */
+export const camelToSnake = (str: string) => {
+  return str.replace(
+    /([A-Z])/g,
+    (match, pattern) => `_${pattern.toLowerCase()}`,
+  );
+};

package/src/time.ts

@@ -1,11 +1,11 @@
-/**
- * 延迟一段时间再执行后续代码
- * @param time 延迟时间，默认 150ms
- * @example
- * await sleep(1000); // 等待 1 秒执行后续代码
- */
-export const sleep = async (time = 150) => {
-  return new Promise((resolve) => {
-    setTimeout(resolve, time);
-  });
-};
+/**
+ * 延迟一段时间再执行后续代码
+ * @param time 延迟时间，默认 150ms
+ * @example
+ * await sleep(1000); // 等待 1 秒执行后续代码
+ */
+export const sleep = async (time = 150) => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, time);
+  });
+};

package/tsconfig.json

@@ -1,32 +1,32 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext", "DOM"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "outDir": "dist",
-    "declaration": true,
-    "emitDeclarationOnly": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  },
-  "include": ["src"]
-}
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext", "DOM"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "outDir": "dist",
+    "declaration": true,
+    "emitDeclarationOnly": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  },
+  "include": ["src"]
+}