@ruan-cat/utils 1.3.0 → 1.3.1

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "阮喵喵工具集合。一个纯typescript库。",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "homepage": "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/packages/utils",
+  "homepage": "https://utils.ruancat6312.top",
   "bugs": {
     "url": "https://github.com/ruan-cat/vercel-monorepo-test/issues"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ruan-cat/vercel-monorepo-test.git",
-    "directory": "utils"
+    "directory": "packages/utils"
   },
   "exports": {
     ".": {
@@ -35,17 +35,26 @@
   },
   "files": [
     "src",
+    "!src/tests",
     "tsconfig.json"
   ],
   "devDependencies": {
     "@antfu/utils": "^0.7.10",
+    "@types/qs": "^6.9.17",
+    "@vueuse/integrations": "^12.1.0",
+    "axios": "^1.7.9",
+    "qs": "^6.13.1",
+    "tsup": "^8.3.5",
+    "type-plus": "^7.6.2",
     "typedoc": "^0.27.0",
     "typedoc-plugin-markdown": "^4.3.0",
     "typescript": "5.7.2",
     "unplugin-vue-router": "^0.10.8",
-    "@ruan-cat/vuepress-preset-config": "^0.1.13"
+    "@ruan-cat/vuepress-preset-config": "^0.1.14"
   },
   "peerDependencies": {
+    "@vueuse/integrations": "^12",
+    "axios": "^1.7.x",
     "typescript": "5.7.2",
     "unplugin-vue-router": "^0.10.8"
   },
@@ -55,6 +64,12 @@
     },
     "unplugin-vue-router": {
       "optional": true
+    },
+    "@vueuse/integrations": {
+      "optional": true
+    },
+    "axios": {
+      "optional": true
     }
   },
   "scripts": {
@@ -73,6 +88,7 @@
     "generate:type-3": "vue-tsc -p tsconfig.types.json",
     "get-type": "pnpm clean:type && pnpm generate:type-3",
     "build:-try-1": "pnpm clean:type && vue-tsc -p tsconfig.build.json",
+    "build:tsup": "tsup",
     "rm:node_modules": "rimraf node_modules"
   }
 }

package/readme.md

@@ -1,5 +1,7 @@
 # 工具包
 
+这是阮喵喵开发的工具包，提供了一些工具函数。
+
 ## TODO: 尝试开发一个 cli
 
 - https://cloud.tencent.com/developer/article/2033881

package/src/index.ts

@@ -4,5 +4,6 @@ export * from "./Prettify.ts";
 export * from "./unplugin-vue-router/index.ts";
 export * from "./define-promise-tasks.ts";
 export * from "./simple-promise-tools.ts";
+export * from "./vueuse/useAxios.ts";
 
 export * from "./types/pnpm-workspace.yaml.shim.ts";

package/src/vueuse/useAxios.ts

@@ -0,0 +1,126 @@
+import type { RequiredPick } from "type-plus";
+import type { AxiosRequestConfig, AxiosResponse, AxiosInstance } from "axios";
+import type { UseAxiosOptions, UseAxiosReturn } from "@vueuse/integrations/useAxios";
+
+/** 拓展的类型参数 用于约束必填的字段 */
+export type KeyAxiosRequestConfig<D = any> = keyof AxiosRequestConfig<D>;
+
+/** 填写key值的帮助类型 */
+export type KeyHelper<K extends KeyAxiosRequestConfig> = K;
+
+/**
+ * 创建 AxiosRequestConfig 的各种变种类型
+ * @description
+ * 目前需要给 AxiosRequestConfig 添加必填属性
+ *
+ * 故需要本工具创建各种变种类型
+ *
+ * @example CreateAxiosRequestConfig<"url", D>
+ */
+export type CreateAxiosRequestConfig<K extends keyof Target, D = any, Target = AxiosRequestConfig<D>> = RequiredPick<
+	Target,
+	K
+>;
+
+/** 拓展K泛型后的类型 */
+export interface StrictUseAxiosReturn<
+	T,
+	/**
+	 * 拓展的类型参数 用于约束必填的字段
+	 * @description
+	 * 这里不需要提供默认的取值
+	 */
+	K extends KeyAxiosRequestConfig<D>,
+	R,
+	D,
+> extends UseAxiosReturn<T, R, D> {
+	/**
+	 * Manually call the axios request
+	 */
+	execute: (
+		url?: string | CreateAxiosRequestConfig<K, D>,
+		config?: CreateAxiosRequestConfig<K, D>,
+	) => Promise<StrictUseAxiosReturn<T, K, R, D>>;
+}
+
+/**
+ * 拓展类型参数后的 useAxios 函数
+ * @description
+ * 在我们的封装中 使用本类型
+ */
+export declare function useAxios<
+	T = any,
+	/** 拓展的类型参数 用于约束必填的字段 */
+	K extends KeyAxiosRequestConfig<D> = "url",
+	R = AxiosResponse<T>,
+	D = any,
+>(
+	url: string,
+	config: AxiosRequestConfig<D>,
+	instance: AxiosInstance,
+	options?: UseAxiosOptions,
+): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
+
+/** 包装器的参数 */
+export interface UseAxiosWrapperParams<
+	/**
+	 * 业务数据类型
+	 * @description
+	 * 必须先填写业务类型
+	 */
+	T = any,
+	/**
+	 * AxiosRequestConfig 默认必填的字段
+	 * @description
+	 * 用于约束其他类型的字段
+	 *
+	 * 然后才能填写必传的参数类型
+	 *
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	K extends KeyAxiosRequestConfig<D> = "url",
+	/**
+	 * UseAxiosOptions 的派生类型
+	 */
+	UseAxiosOptionsLike extends UseAxiosOptions = UseAxiosOptions,
+	/**
+	 * AxiosRequestConfig 用的类型
+	 * @description
+	 * 最后才可以传递此类型
+	 */
+	D = any,
+> {
+	/**
+	 * axios的配置类型
+	 * @description
+	 * 默认为 必填url请求地址的 config 请求配置
+	 */
+	config: CreateAxiosRequestConfig<K, D>;
+
+	/**
+	 * axios实例
+	 * @description
+	 * 对于包装器函数而言 必须传递有意义的请求实例
+	 */
+	instance: AxiosInstance;
+
+	/** useAxios 的选项配置 */
+	options: UseAxiosOptionsLike;
+}
+
+/**
+ * useAxios 的包装函数
+ * @description
+ * 其本质是对 useAxios 函数的封装，仅仅是包装了参数层
+ *
+ * 预期设计成一个万能的 通用的请求函数
+ */
+export function useAxiosWrapper<T, K extends KeyAxiosRequestConfig, D = any>(params: UseAxiosWrapperParams) {
+	const {
+		config: { url },
+		config,
+		instance,
+		options,
+	} = params;
+	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
+}

package/tsconfig.json

@@ -33,21 +33,16 @@
 			"typedoc",
 			"typedoc-plugin-markdown",
 		],
-		"paths": {
-			"@/*": [
-				"./src/*"
-			]
-		}
 	},
 	"include": [
 		"./src/**/*.ts",
-		"./tests/**/*.ts",
 		"./src/**/*.js",
-		"./tests/**/*.js",
-		// 尝试手动提供一个全局的类型声明。
-		"./tests/with-types/types/CanNewTypeByClass.d.ts",
+		// "./tests/**/*.ts",
+		// "./tests/**/*.js",
 	],
 	"exclude": [
+		// 测试用例的全部文件 交由本项目根目录下的 tsconfig.json 处理
+		"src/tests/**/*.ts",
 		"notuse-typedoc.config.cjs"
 	]
 }