@ruan-cat/utils 3.1.0 → 3.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "description": "阮喵喵工具集合。一个纯typescript库，也提供纯js文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -58,23 +58,23 @@
     "tsconfig.json"
   ],
   "dependencies": {
-    "@vueuse/integrations": "^12.3.0",
-    "axios": "^1.7.9",
+    "@vueuse/integrations": "^12.7.0",
+    "axios": "^1.8.1",
     "consola": "^3.4.0",
     "lodash-es": "^4.17.21"
   },
   "devDependencies": {
-    "@antfu/utils": "^0.7.10",
+    "@antfu/utils": "^9.1.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^22.13.1",
-    "@types/qs": "^6.9.17",
-    "qs": "^6.13.1",
-    "tsup": "^8.3.5",
+    "@types/node": "^22.13.8",
+    "@types/qs": "^6.9.18",
+    "qs": "^6.14.0",
+    "tsup": "^8.4.0",
     "type-plus": "^7.6.2",
-    "typedoc": "^0.27.0",
+    "typedoc": "^0.27.9",
     "typedoc-plugin-frontmatter": "^1.2.1",
-    "typedoc-plugin-markdown": "^4.3.0",
-    "typescript": "5.7.3",
+    "typedoc-plugin-markdown": "^4.4.2",
+    "typescript": "^5.8.2",
     "unplugin-vue-router": "^0.11.2",
     "vite-plugin-autogeneration-import-file": "^3.0.0",
     "@ruan-cat/vuepress-preset-config": "^0.1.19"

package/src/vueuse/useAxios/index.ts

@@ -1,10 +1,10 @@
 import type { RequiredPick } from "type-plus";
 import type { AxiosRequestConfig, AxiosResponse, AxiosInstance } from "axios";
-import type { UseAxiosOptions, UseAxiosReturn } from "@vueuse/integrations/useAxios";
+import type { UseAxiosOptions, UseAxiosOptionsBase, UseAxiosReturn } from "@vueuse/integrations/useAxios";
 import { useAxios } from "@vueuse/integrations/useAxios";
 
 /** 在封装函数时 需要使用该类型 */
-export { UseAxiosOptions };
+export { UseAxiosOptions, UseAxiosOptionsBase };
 
 /** 拓展的类型参数 用于约束必填的字段 */
 export type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
@@ -12,7 +12,10 @@ export type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
 /** 填写key值的帮助类型 */
 export type KeyHelper<K extends KeyAxiosRequestConfig> = K;
 
+/** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
 export type RemoveUrl<T extends KeyAxiosRequestConfig> = Exclude<T, "url">;
+/** @deprecated 在v2版本中，我们不使用该工具来约束删减类型 */
+export type RemoveUrlMethod<T extends KeyAxiosRequestConfig> = Exclude<T, "url" | "method">;
 
 /**
  * 创建 AxiosRequestConfig 的各种变种类型
@@ -65,11 +68,11 @@ declare module "@vueuse/integrations/useAxios" {
 		url: string,
 		config: AxiosRequestConfig<D>,
 		instance: AxiosInstance,
-		options?: UseAxiosOptions,
+		options?: UseAxiosOptionsBase,
 	): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
 }
 
-/** 包装器的参数 */
+/** 包装器的参数 @version 1 */
 export interface UseAxiosWrapperParams<
 	/**
 	 * 业务数据类型
@@ -122,6 +125,7 @@ export interface UseAxiosWrapperParams<
  * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
  *
  * 预期设计成一个万能的 通用的请求函数
+ * @version 1
  */
 export function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParams) {
 	const {
@@ -136,3 +140,5 @@ export function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(par
 	// 跳转到我们拓展的函数声明
 	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
 }
+
+export * from "./v2.ts";

package/src/vueuse/useAxios/v2.ts

@@ -0,0 +1,86 @@
+/**
+ * 这里是第二版本的工具 目前属于测试阶段
+ * 等待完善后，会正式地替代原来的设计。
+ */
+import type { AxiosResponse, AxiosInstance } from "axios";
+import type { UseAxiosOptionsBase } from "@vueuse/integrations/useAxios";
+import { useAxios } from "@vueuse/integrations/useAxios";
+import type { CreateAxiosRequestConfig, KeyAxiosRequestConfig } from "./index.ts";
+
+/** 包装器的参数 @version 2 */
+export interface UseAxiosWrapperParams2<
+	/**
+	 * AxiosRequestConfig 默认必填的字段
+	 * @description
+	 * key是首先必填的字段 必须要约束axios请求配置的可选项值
+	 *
+	 * 该key值不再默认要求url是必填项 不做严格约束
+	 */
+	K extends KeyAxiosRequestConfig,
+	/**
+	 * 业务数据类型
+	 * @description
+	 * axios的返回值类型 二版本不再默认提供any类型
+	 *
+	 * 下游工具必须主动传递类型
+	 */
+	T,
+	/** UseAxiosOptionsBase 的派生类型 */
+	UseAxiosOptionsLike extends UseAxiosOptionsBase = UseAxiosOptionsBase<T>,
+	/**
+	 * AxiosRequestConfig 用的类型
+	 * @description
+	 * 通常是 axios 的输入值
+	 */
+	D = any,
+> {
+	/**
+	 * 接口的url
+	 * @description
+	 * 接口必须要有url地址，该url迁移到此处专门设置
+	 *
+	 * 不要求在 axios 配置内必传url了。
+	 * @version 2
+	 */
+	url: string;
+	/**
+	 * axios的配置类型
+	 * @description
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	config: CreateAxiosRequestConfig<K, D>;
+
+	/**
+	 * axios实例
+	 * @description
+	 * 对于包装器函数而言 必须传递有意义的请求实例
+	 */
+	instance: AxiosInstance;
+
+	/** useAxios 的选项配置 */
+	options: UseAxiosOptionsLike;
+}
+
+/**
+ * 正在尝试重构的2 url不是非必填 多了独立的url参数 */
+
+/**
+ * useAxios 的包装函数
+ * @description
+ * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
+ *
+ * 预期设计成一个万能的 通用的请求函数
+ *
+ * 类型必传key T UseAxiosOptionsLike
+ * @version 2
+ */
+export function useAxiosWrapper2<
+	K extends KeyAxiosRequestConfig,
+	T,
+	UseAxiosOptionsLike extends UseAxiosOptionsBase,
+	D = any,
+>(params: UseAxiosWrapperParams2<K, T, UseAxiosOptionsLike, D>) {
+	const { config = {}, instance, options = {} } = params;
+	const url = params.url || "";
+	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
+}