@ruan-cat/utils 4.5.0 → 4.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruan-cat/utils",
-  "version": "4.5.0",
+  "version": "4.7.0",
   "description": "阮喵喵工具集合。默认提供js文件，也直接提供ts文件。",
   "type": "module",
   "main": "./src/index.ts",
@@ -60,7 +60,7 @@
     "tsconfig.json"
   ],
   "dependencies": {
-    "@vueuse/integrations": "^12.7.0",
+    "@vueuse/integrations": "^13.3.0",
     "axios": "^1.8.1",
     "consola": "^3.4.0",
     "lodash-es": "^4.17.21"

package/src/vueuse/useAxios/index.ts

@@ -43,6 +43,7 @@ export interface StrictUseAxiosReturn<
 	K extends KeyAxiosRequestConfig<D>,
 	R,
 	D,
+	O extends UseAxiosOptions = UseAxiosOptions<T>,
 > extends UseAxiosReturn<T, R, D> {
 	/**
 	 * Manually call the axios request
@@ -50,7 +51,7 @@ export interface StrictUseAxiosReturn<
 	execute: (
 		url?: string | CreateAxiosRequestConfig<K, D>,
 		config?: CreateAxiosRequestConfig<K, D>,
-	) => Promise<StrictUseAxiosReturn<T, K, R, D>>;
+	) => Promise<StrictUseAxiosReturn<T, K, R, D, O>>;
 }
 
 declare module "@vueuse/integrations/useAxios" {
@@ -65,12 +66,13 @@ declare module "@vueuse/integrations/useAxios" {
 		K extends KeyAxiosRequestConfig<D> = "url",
 		R = AxiosResponse<T>,
 		D = any,
+		O extends UseAxiosOptionsBase<T> = UseAxiosOptionsBase<T>,
 	>(
 		url: string,
 		config: AxiosRequestConfig<D>,
 		instance: AxiosInstance,
-		options?: UseAxiosOptionsBase,
-	): StrictUseAxiosReturn<T, K, R, D> & Promise<StrictUseAxiosReturn<T, K, R, D>>;
+		options: O,
+	): StrictUseAxiosReturn<T, K, R, D, O> & Promise<StrictUseAxiosReturn<T, K, R, D, O>>;
 }
 
 /** 包装器的参数 @version 2 */
@@ -142,10 +144,11 @@ export function useAxiosWrapper<
 	T,
 	UseAxiosOptionsLike extends UseAxiosOptionsBase,
 	D = any,
+	O extends UseAxiosOptionsBase<T> = UseAxiosOptionsBase<T>,
 >(params: UseAxiosWrapperParams<K, T, UseAxiosOptionsLike, D>) {
-	const { config = {}, instance, options = {} } = params;
+	const { config = {}, instance, options = {} as O } = params;
 	const url = params.url || "";
-	return useAxios<T, K, AxiosResponse<T>, D>(url, config, instance, options);
+	return useAxios<T, K, AxiosResponse<T>, D, O>(url, config, instance, options as O);
 }
 
 export * from "./v1.js";

package/src/vueuse/useAxios-for-01s/main.ts

@@ -8,13 +8,7 @@ import axios from "axios";
 import type { JsonVO } from "./types/JsonVO";
 
 import type { AxiosRequestConfigBaseKey, HttpParamWay } from "./tools.ts";
-import {
-	createDefaultUseAxiosOptions,
-	setHeaders,
-	UpType,
-	setDefaultUseAxiosOptions,
-	setDataByHttpParamWay,
-} from "./tools";
+import { createDefaultUseAxiosOptions, setHeaders, UpType, setDefaultUseAxiosOptions } from "./tools";
 
 /**
  * 内部用的 axios 实例
@@ -34,7 +28,7 @@ export function defineAxiosInstance(axiosInstance: AxiosInstance) {
 }
 
 export type ParamsPathKey = AxiosRequestConfigBaseKey | "url";
-export type ParamsQueryKey = AxiosRequestConfigBaseKey | "data";
+export type ParamsQueryKey = AxiosRequestConfigBaseKey | "params";
 export type ParamsBodyKey = AxiosRequestConfigBaseKey | "data";
 
 type UseAxiosWrapperUseKey<T extends HttpParamWay, K extends KeyAxiosRequestConfig> =
@@ -61,6 +55,7 @@ export function useRequestIn01s<
 	T = any,
 	D = any,
 	HttpParamWayTemp extends HttpParamWay = Params<K>["httpParamWay"],
+	O extends UseAxiosOptionsBase<JsonVO<T>> = UseAxiosOptionsBase<JsonVO<T>>,
 >(
 	params: Params<
 		//
@@ -79,16 +74,15 @@ export function useRequestIn01s<
 	} = params;
 	setHeaders(config, upType);
 	setDefaultUseAxiosOptions(options);
-	setDataByHttpParamWay({
-		httpParamWay,
-		config,
-	});
+
+	// console.log(" 最后请求前，看一下数据？ ", config);
 	// console.log(" instance  ?", instance.defaults.baseURL);
 	return useAxiosWrapper<
 		//
 		UseAxiosWrapperUseKey<HttpParamWayTemp, K>,
 		JsonVO<T>,
 		UseAxiosOptionsBase<JsonVO<T>>,
-		D
+		D,
+		O
 	>({ config, instance, options, url });
 }

package/src/vueuse/useAxios-for-01s/tools.ts

@@ -12,6 +12,15 @@ import { isConditionsSome } from "../../index";
  * @description
  * 用于控制接口请求时的参数传递方式
  * @see https://www.cnblogs.com/jinyuanya/p/13934722.html
+ *
+ * @description
+ * 警告 该配置目前失去意义
+ *
+ * 该配置目前不再被使用了 不会被任何函数使用 配置起来属于无意义内容
+ *
+ * 未来会被删除 并重新整理对应的接口生成成果
+ *
+ * TODO: 准备删除该工具
  */
 export type HttpParamWay =
 	// 路径传参
@@ -78,6 +87,44 @@ export enum HttpCode {
 	SUCCESS = 10000,
 }
 
+/**
+ * 请求结果分类
+ * @description
+ * 成功 失败 错误
+ */
+export type HttpStatus = "success" | "fail" | "error";
+
+/** 接口请求状态是否是成功的？ */
+export function isHttpStatusSuccess(status: HttpStatus): status is "success" {
+	return status === "success";
+}
+
+/**
+ * http码的映射存储值
+ * @description
+ * 根据业务类型存储不同的值
+ */
+export interface HttpCodeMessageMapValue {
+	/** 接口提示文本 */
+	message: string;
+	/** 接口请求状态 */
+	type: HttpStatus;
+}
+
+/** 请求码与请求响应文本的映射表 */
+export const HttpCodeMessageMap: Record<HttpCode, HttpCodeMessageMapValue> = {
+	[HttpCode.UNAUTHORIZED]: { message: "未登录或登录已过期，请重新登录", type: "error" },
+	[HttpCode.FORBIDDEN]: { message: "没有相关权限", type: "error" },
+	[HttpCode.NOT_FOUND]: { message: "访问页面未找到", type: "error" },
+	[HttpCode.SERVER_ERROR]: { message: "服务器错误", type: "error" },
+	[HttpCode.PARAMS_INVALID]: { message: "上传参数异常", type: "error" },
+	[HttpCode.CONTENT_TYPE_ERR]: { message: "ContentType错误", type: "error" },
+	[HttpCode.API_UN_IMPL]: { message: "功能尚未实现", type: "error" },
+	[HttpCode.SERVER_BUSY]: { message: "服务器繁忙", type: "error" },
+	[HttpCode.FAIL]: { message: "操作失败", type: "fail" },
+	[HttpCode.SUCCESS]: { message: "操作成功", type: "success" },
+};
+
 /**
  * 上传类型-请求体类型 枚举
  * @description
@@ -165,12 +212,29 @@ export function setDefaultUseAxiosOptions<T>(options: UseAxiosOptionsBase<T>) {
 	options.immediate = options?.immediate ?? _options.immediate;
 }
 
-/** @private */
+/**
+ * @private
+ * @deprecated
+ * 废弃该功能
+ *
+ * 该函数没意义 重设请求前的参数 没有意义
+ *
+ * 重新设置的参数 没办法及时传递到真正执行接口请求的函数内
+ */
 interface SetDataByHttpParamWayParams {
 	httpParamWay: HttpParamWay;
 	config: AxiosRequestConfig;
 }
-export function setDataByHttpParamWay(params: SetDataByHttpParamWayParams) {
+
+/**
+ * @deprecated
+ * 废弃该功能
+ *
+ * 该函数没意义 重设请求前的参数 没有意义
+ *
+ * 重新设置的参数 没办法及时传递到真正执行接口请求的函数内
+ */
+function setDataByHttpParamWay(params: SetDataByHttpParamWayParams) {
 	const { httpParamWay, config } = params;
 	if (
 		isConditionsSome([