@oiij/naive-ui 0.0.73 → 0.0.75

package/dist/components/preset-select/PresetSelect.vue.d.ts

@@ -1,12 +1,12 @@
 import { DataObject, UseDataRequestPagination } from "../../composables/use-data-request.js";
 import { PresetSelectEmits, PresetSelectExpose, PresetSelectProps, PresetSelectValue } from "./index.js";
+import * as vue49 from "vue";
 import * as _vueuse_core11 from "@vueuse/core";
-import * as vue66 from "vue";
 import { SelectInst, SelectOption } from "naive-ui";
 
 //#region src/components/preset-select/PresetSelect.vue.d.ts
 declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject, D extends DataObject, R extends DataObject>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-  props: vue66.PublicProps & __VLS_PrettifyLocal<PresetSelectProps<V, P, D, R> & {
+  props: vue49.PublicProps & __VLS_PrettifyLocal<PresetSelectProps<V, P, D, R> & {
     onSuccess?: ((data: D, params: P[]) => any) | undefined;
     onError?: ((err: Error, params: P[]) => any) | undefined;
     onClear?: (() => any) | undefined;
@@ -23,7 +23,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
   }> & (typeof globalThis extends {
     __VLS_PROPS_FALLBACK: infer P_1;
   } ? P_1 : {});
-  expose: (exposed: vue66.ShallowUnwrapRef<PresetSelectExpose<P, D, R>>) => void;
+  expose: (exposed: vue49.ShallowUnwrapRef<PresetSelectExpose<P, D, R>>) => void;
   attrs: any;
   slots: {
     header?: (props: {
@@ -37,7 +37,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
         pageSize: number;
         itemCount: number;
       };
-      selectRef: SelectInst | null;
+      selectInst: SelectInst | null;
       run: (...params: P[]) => void;
       runAsync: (...params: P[]) => Promise<D>;
       refresh: () => void;
@@ -64,7 +64,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
         pageSize: number;
         itemCount: number;
       };
-      selectRef: SelectInst | null;
+      selectInst: SelectInst | null;
       run: (...params: P[]) => void;
       runAsync: (...params: P[]) => Promise<D>;
       refresh: () => void;
@@ -91,7 +91,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
         pageSize: number;
         itemCount: number;
       };
-      selectRef: SelectInst | null;
+      selectInst: SelectInst | null;
       run: (...params: P[]) => void;
       runAsync: (...params: P[]) => Promise<D>;
       refresh: () => void;
@@ -118,7 +118,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
         pageSize: number;
         itemCount: number;
       };
-      selectRef: SelectInst | null;
+      selectInst: SelectInst | null;
       run: (...params: P[]) => void;
       runAsync: (...params: P[]) => Promise<D>;
       refresh: () => void;
@@ -145,7 +145,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
         pageSize: number;
         itemCount: number;
       };
-      selectRef: SelectInst | null;
+      selectInst: SelectInst | null;
       run: (...params: P[]) => void;
       runAsync: (...params: P[]) => Promise<D>;
       refresh: () => void;
@@ -162,7 +162,7 @@ declare const __VLS_export: <V extends PresetSelectValue, P extends DataObject,
     }) => any;
   };
   emit: PresetSelectEmits<V, P, D, R>;
-}>) => vue66.VNode & {
+}>) => vue49.VNode & {
   __ctx?: Awaited<typeof __VLS_setup>;
 };
 declare const _default: typeof __VLS_export;

package/dist/components/preset-select/index.d.ts

@@ -18,7 +18,7 @@ type PresetSelectFields = DataRequestFields & {
   children?: string;
 };
 type PresetSelectExpose<P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject> = UseDataRequestReturns<P, D, R> & {
-  selectRef: Readonly<ShallowRef<SelectInst | null>>;
+  selectInst: Readonly<ShallowRef<SelectInst | null>>;
 };
 type PresetSelectProps<V extends PresetSelectValue, P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject> = RemoteRequestProps<P, D> & {
   value?: V;

package/dist/components/remote-request/RemoteRequest.vue.d.ts

@@ -1,11 +1,11 @@
 import { DataObject, UseDataRequestPagination } from "../../composables/use-data-request.js";
 import { RemoteRequestEmits, RemoteRequestExpose, RemoteRequestProps } from "./index.js";
+import * as vue22 from "vue";
 import * as _vueuse_core4 from "@vueuse/core";
-import * as vue38 from "vue";
 
 //#region src/components/remote-request/RemoteRequest.vue.d.ts
 declare const __VLS_export: <P extends DataObject, D extends DataObject, R extends DataObject>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-  props: vue38.PublicProps & __VLS_PrettifyLocal<RemoteRequestProps<P, D> & {
+  props: vue22.PublicProps & __VLS_PrettifyLocal<RemoteRequestProps<P, D> & {
     onSuccess?: ((data: D, params: P[]) => any) | undefined;
     onError?: ((err: Error, params: P[]) => any) | undefined;
     onFinally?: ((params: P[], data?: D | undefined, err?: Error | undefined) => any) | undefined;
@@ -13,7 +13,7 @@ declare const __VLS_export: <P extends DataObject, D extends DataObject, R exten
   }> & (typeof globalThis extends {
     __VLS_PROPS_FALLBACK: infer P_1;
   } ? P_1 : {});
-  expose: (exposed: vue38.ShallowUnwrapRef<RemoteRequestExpose<P, D, R>>) => void;
+  expose: (exposed: vue22.ShallowUnwrapRef<RemoteRequestExpose<P, D, R>>) => void;
   attrs: any;
   slots: {
     default?: (props: {
@@ -43,7 +43,7 @@ declare const __VLS_export: <P extends DataObject, D extends DataObject, R exten
     }) => any;
   };
   emit: RemoteRequestEmits<P, D>;
-}>) => vue38.VNode & {
+}>) => vue22.VNode & {
   __ctx?: Awaited<typeof __VLS_setup>;
 };
 declare const _default: typeof __VLS_export;

package/dist/components/search-input/SearchInput.js

@@ -1,6 +1,6 @@
 import MageSearch_default from "../icons/MageSearch.js";
-import { useDebounceFn, useTimeoutFn } from "@vueuse/core";
 import { Fragment, computed, createBlock, createCommentVNode, createElementBlock, createSlots, createTextVNode, createVNode, defineComponent, mergeProps, openBlock, ref, renderSlot, unref, useTemplateRef, watch, watchEffect, withCtx } from "vue";
+import { useDebounceFn, useTimeoutFn } from "@vueuse/core";
 import { NButton, NInput, NInputGroup } from "naive-ui";
 
 //#region src/components/search-input/SearchInput.vue

package/dist/components/search-input/SearchInput.vue.d.ts

@@ -1,5 +1,5 @@
 import { SearchInputProps } from "./index.js";
-import * as vue23 from "vue";
+import * as vue57 from "vue";
 
 //#region src/components/search-input/SearchInput.vue.d.ts
 declare var __VLS_19: {}, __VLS_21: {}, __VLS_28: {
@@ -15,11 +15,11 @@ type __VLS_Slots = {} & {
 } & {
   'button-icon'?: (props: typeof __VLS_39) => any;
 };
-declare const __VLS_base: vue23.DefineComponent<SearchInputProps, {}, {}, {}, {}, vue23.ComponentOptionsMixin, vue23.ComponentOptionsMixin, {} & {
+declare const __VLS_base: vue57.DefineComponent<SearchInputProps, {}, {}, {}, {}, vue57.ComponentOptionsMixin, vue57.ComponentOptionsMixin, {} & {
   "update:value": (v: string | null | undefined) => any;
-}, string, vue23.PublicProps, Readonly<SearchInputProps> & Readonly<{
+}, string, vue57.PublicProps, Readonly<SearchInputProps> & Readonly<{
   "onUpdate:value"?: ((v: string | null | undefined) => any) | undefined;
-}>, {}, {}, {}, {}, string, vue23.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue57.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/toggle-input/ToggleInput.vue.d.ts

@@ -1,5 +1,5 @@
 import { ClassStyle } from "../data-table-plus/index.js";
-import * as vue13 from "vue";
+import * as vue15 from "vue";
 import { InputProps } from "naive-ui";
 
 //#region src/components/toggle-input/ToggleInput.vue.d.ts
@@ -27,14 +27,14 @@ type __VLS_Slots = {} & {
 } & {
   default?: (props: typeof __VLS_13) => any;
 };
-declare const __VLS_base: vue13.DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, vue13.ComponentOptionsMixin, vue13.ComponentOptionsMixin, {
+declare const __VLS_base: vue15.DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, vue15.ComponentOptionsMixin, vue15.ComponentOptionsMixin, {
   "update:value": (value: string | number | undefined) => any;
 } & {
   trigger: () => any;
-}, string, vue13.PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+}, string, vue15.PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
   "onUpdate:value"?: ((value: string | number | undefined) => any) | undefined;
   onTrigger?: (() => any) | undefined;
-}>, {}, {}, {}, {}, string, vue13.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue15.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/tooltip-button/TooltipButton.vue.d.ts

@@ -1,5 +1,5 @@
 import { TooltipButtonProps } from "./index.js";
-import * as vue8 from "vue";
+import * as vue10 from "vue";
 
 //#region src/components/tooltip-button/TooltipButton.vue.d.ts
 declare var __VLS_17: {}, __VLS_20: {}, __VLS_22: {};
@@ -10,11 +10,11 @@ type __VLS_Slots = {} & {
 } & {
   tooltip?: (props: typeof __VLS_22) => any;
 };
-declare const __VLS_base: vue8.DefineComponent<TooltipButtonProps, {}, {}, {}, {}, vue8.ComponentOptionsMixin, vue8.ComponentOptionsMixin, {} & {
+declare const __VLS_base: vue10.DefineComponent<TooltipButtonProps, {}, {}, {}, {}, vue10.ComponentOptionsMixin, vue10.ComponentOptionsMixin, {} & {
   click: (ev: MouseEvent) => any;
-}, string, vue8.PublicProps, Readonly<TooltipButtonProps> & Readonly<{
+}, string, vue10.PublicProps, Readonly<TooltipButtonProps> & Readonly<{
   onClick?: ((ev: MouseEvent) => any) | undefined;
-}>, {}, {}, {}, {}, string, vue8.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue10.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/transition/BaseTransition.vue.d.ts

@@ -1,12 +1,12 @@
 import { TransitionProps as TransitionProps$1 } from "./index.js";
-import * as vue41 from "vue";
+import * as vue30 from "vue";
 
 //#region src/components/transition/BaseTransition.vue.d.ts
 declare var __VLS_7: {};
 type __VLS_Slots = {} & {
   default?: (props: typeof __VLS_7) => any;
 };
-declare const __VLS_base: vue41.DefineComponent<TransitionProps$1, {}, {}, {}, {}, vue41.ComponentOptionsMixin, vue41.ComponentOptionsMixin, {}, string, vue41.PublicProps, Readonly<TransitionProps$1> & Readonly<{}>, {}, {}, {}, {}, string, vue41.ComponentProvideOptions, false, {}, any>;
+declare const __VLS_base: vue30.DefineComponent<TransitionProps$1, {}, {}, {}, {}, vue30.ComponentOptionsMixin, vue30.ComponentOptionsMixin, {}, string, vue30.PublicProps, Readonly<TransitionProps$1> & Readonly<{}>, {}, {}, {}, {}, string, vue30.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/type-writer/TypeWriter.js

@@ -43,7 +43,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
 		onStop((v) => {
 			emit("stop", v);
 		});
-		const { htmlRef } = useMarkdownIt(void 0, {
+		const { html } = useMarkdownIt(void 0, {
 			value: typedValue,
 			markdownItOptions: {
 				html: true,
@@ -53,7 +53,7 @@ const _sfc_main = /* @__PURE__ */ defineComponent({
 				highlight
 			}
 		});
-		const renderValue = computed(() => __props.markdown ? htmlRef.value : typedValue.value);
+		const renderValue = computed(() => __props.markdown ? html.value : typedValue.value);
 		return (_ctx, _cache) => {
 			return openBlock(), createBlock(unref(NEl), {
 				tag: "div",

package/dist/components/type-writer/TypeWriter.vue.d.ts

@@ -1,22 +1,22 @@
 import { TypeWriterProps } from "./index.js";
-import * as vue82 from "vue";
+import * as vue75 from "vue";
 
 //#region src/components/type-writer/TypeWriter.vue.d.ts
-declare const __VLS_export: vue82.DefineComponent<TypeWriterProps, {}, {}, {}, {}, vue82.ComponentOptionsMixin, vue82.ComponentOptionsMixin, {} & {
+declare const __VLS_export: vue75.DefineComponent<TypeWriterProps, {}, {}, {}, {}, vue75.ComponentOptionsMixin, vue75.ComponentOptionsMixin, {} & {
   start: () => any;
   update: (v: {
     index: number;
     value: string;
   }) => any;
   stop: (v: string) => any;
-}, string, vue82.PublicProps, Readonly<TypeWriterProps> & Readonly<{
+}, string, vue75.PublicProps, Readonly<TypeWriterProps> & Readonly<{
   onStart?: (() => any) | undefined;
   onUpdate?: ((v: {
     index: number;
     value: string;
   }) => any) | undefined;
   onStop?: ((v: string) => any) | undefined;
-}>, {}, {}, {}, {}, string, vue82.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue75.ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 //#endregion
 export { _default };

package/dist/composables/index.d.ts

@@ -1,3 +1,4 @@
+import { UseAutoMenuReturn, useAutoMenu } from "./use-auto-menu.js";
 import { DataObject, DataRequestFields, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, useDataRequest } from "./use-data-request.js";
 import { useLoading } from "./use-loading.js";
 import { UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, useNaiveForm } from "./use-naive-form.js";

package/dist/composables/use-auto-menu.d.ts

@@ -0,0 +1,74 @@
+import * as vue0 from "vue";
+import { MaybeRefOrGetter, VNode } from "vue";
+import { MenuOption } from "naive-ui";
+import { RouteRecordRaw } from "vue-router";
+
+//#region src/composables/use-auto-menu.d.ts
+/**
+ * 配置选项接口
+ */
+type Options = {
+  /**
+   * 隐藏条件，可以是函数或字符串
+   * - 如果是函数，返回 true 时路由将不显示在菜单中
+   * - 如果是字符串，则从 route.meta 中获取对应属性的值
+   */
+  hide?: ((route: RouteRecordRaw) => boolean | string) | string;
+  /**
+   * 根路由判断，可以是函数或字符串
+   * - 如果是函数，返回 true 时路由将作为顶级菜单
+   * - 如果是字符串，则从 route.meta 中获取对应属性的值
+   */
+  root?: ((route: RouteRecordRaw) => boolean | string) | string;
+  /**
+   * 标签生成，可以是函数或字符串
+   * - 如果是函数，使用函数返回值作为菜单项的显示文本
+   * - 如果是字符串，则从 route.meta 中获取对应属性的值
+   */
+  label?: ((route: RouteRecordRaw) => string) | string;
+  /**
+   * 键生成，可以是函数或字符串
+   * - 如果是函数，使用函数返回值作为菜单项的唯一标识
+   * - 如果是字符串，则从 route.meta 中获取对应属性的值
+   */
+  key?: ((route: RouteRecordRaw) => string) | string;
+  /**
+   * 图标渲染函数，用于自定义路由图标
+   */
+  icon?: (route: RouteRecordRaw) => VNode | string | undefined | null;
+};
+/**
+ * 自动菜单组合函数
+ * @param routes 路由配置数组
+ * @param options 配置选项
+ * @returns 包含菜单选项和扁平化菜单选项的对象
+ *
+ * @example
+ * // 基本使用
+ * const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes)
+ *
+ * // 带配置选项（使用函数）
+ * const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes, {
+ *   hide: (route) => route.meta?.hidden,
+ *   root: (route) => route.meta?.root,
+ *   label: (route) => route.meta?.title ?? route.name,
+ *   key: (route) => route.path,
+ *   icon: (route) => route.meta?.icon
+ * })
+ *
+ * // 带配置选项（使用字符串）
+ * const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes, {
+ *   hide: 'hidden',
+ *   root: 'root',
+ *   label: 'title',
+ *   key: 'path',
+ *   icon: (route) => route.meta?.icon
+ * })
+ */
+declare function useAutoMenu(routes: MaybeRefOrGetter<RouteRecordRaw[]>, options?: Options): {
+  menuOptions: vue0.ComputedRef<MenuOption[]>;
+  flattenedMenuOptions: vue0.ComputedRef<MenuOption[]>;
+};
+type UseAutoMenuReturn = ReturnType<typeof useAutoMenu>;
+//#endregion
+export { UseAutoMenuReturn, useAutoMenu };

package/dist/composables/use-auto-menu.js

@@ -0,0 +1,129 @@
+import { computed, toValue } from "vue";
+
+//#region src/composables/use-auto-menu.ts
+/**
+* 获取配置值，支持函数和字符串两种类型
+* @param route 路由配置
+* @param config 配置项，可以是函数或字符串
+* @param defaultValue 默认值
+* @returns 配置值
+*/
+function getConfigValue(route, config, defaultValue) {
+	if (!config) return defaultValue;
+	if (typeof config === "function") return config(route);
+	return route.meta?.[config] ?? defaultValue;
+}
+/**
+* 创建单个菜单选项
+* @param route 路由配置
+* @param options 配置选项
+* @returns 菜单选项
+*/
+function createMenuOption(route, options) {
+	const { label, key, icon } = options ?? {};
+	return {
+		label: getConfigValue(route, label) ?? route.meta?.title ?? route.name ?? route.path,
+		key: getConfigValue(route, key) ?? route.name?.toString() ?? route.path?.toString(),
+		icon: icon ? () => icon(route) : void 0,
+		meta: route.meta
+	};
+}
+/**
+* 判断路由是否应该隐藏
+* @param route 路由配置
+* @param hide 隐藏条件
+* @returns 是否隐藏
+*/
+function shouldHide(route, hide) {
+	if (!hide) return false;
+	const result = getConfigValue(route, hide);
+	return typeof result === "boolean" ? result : !!result;
+}
+/**
+* 判断路由是否为根路由
+* @param route 路由配置
+* @param root 根路由判断
+* @returns 是否为根路由
+*/
+function isRoot(route, root) {
+	if (!root) return !!route.meta?.root;
+	const result = getConfigValue(route, root);
+	return typeof result === "boolean" ? result : !!result;
+}
+/**
+* 将路由配置转换为菜单配置的递归函数
+* @param routes 路由配置数组
+* @param options 配置选项
+* @returns 菜单配置数组
+*/
+function routes2menu(routes, options) {
+	const { hide, root } = options ?? {};
+	const menuOptions = [];
+	for (const route of routes ?? []) {
+		if (shouldHide(route, hide)) continue;
+		const menu = createMenuOption(route, options);
+		if (route.children?.length) {
+			const rootChildren = route.children.filter((child) => isRoot(child, root));
+			const normalChildren = route.children.filter((child) => !isRoot(child, root));
+			if (normalChildren.length) menu.children = routes2menu(normalChildren, options);
+			if (rootChildren.length) {
+				const rootMenuOptions = rootChildren.filter((child) => !shouldHide(child, hide)).map((child) => createMenuOption(child, options));
+				menuOptions.push(...rootMenuOptions);
+			}
+		}
+		menuOptions.push(menu);
+	}
+	return menuOptions;
+}
+/**
+* 深度扁平化菜单选项
+* @param menuOptions 菜单选项数组
+* @returns 扁平化的菜单选项数组
+*/
+function flattenMenuOptions(menuOptions) {
+	const flattened = [];
+	function processMenu(menu) {
+		flattened.push(menu);
+		if (menu.children?.length) for (const child of menu.children) processMenu(child);
+	}
+	for (const menu of menuOptions) processMenu(menu);
+	return flattened;
+}
+/**
+* 自动菜单组合函数
+* @param routes 路由配置数组
+* @param options 配置选项
+* @returns 包含菜单选项和扁平化菜单选项的对象
+*
+* @example
+* // 基本使用
+* const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes)
+*
+* // 带配置选项（使用函数）
+* const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes, {
+*   hide: (route) => route.meta?.hidden,
+*   root: (route) => route.meta?.root,
+*   label: (route) => route.meta?.title ?? route.name,
+*   key: (route) => route.path,
+*   icon: (route) => route.meta?.icon
+* })
+*
+* // 带配置选项（使用字符串）
+* const { menuOptions, flattenedMenuOptions } = useAutoMenu(routes, {
+*   hide: 'hidden',
+*   root: 'root',
+*   label: 'title',
+*   key: 'path',
+*   icon: (route) => route.meta?.icon
+* })
+*/
+function useAutoMenu(routes, options) {
+	const menuOptions = computed(() => routes2menu(toValue(routes), options));
+	return {
+		menuOptions,
+		flattenedMenuOptions: computed(() => flattenMenuOptions(menuOptions.value))
+	};
+}
+
+//#endregion
+export { useAutoMenu };

package/dist/composables/use-data-request.d.ts

@@ -1,35 +1,59 @@
+import * as vue4 from "vue";
 import * as _vueuse_core0 from "@vueuse/core";
-import * as vue0 from "vue";
 import { UseRequestOptions, UseRequestPlugin } from "vue-hooks-plus/es/useRequest/types";
 
 //#region src/composables/use-data-request.d.ts
+/**
+ * 数据对象类型
+ */
 type DataObject = Record<string, any>;
+/**
+ * 数据请求字段配置
+ * 用于自定义请求参数和响应数据的字段名
+ */
 type DataRequestFields = Record<string, string | undefined> & {
-  page?: string;
-  pageSize?: string;
-  list?: string;
-  count?: string;
+  /** 页码字段名 */page?: string; /** 每页大小字段名 */
+  pageSize?: string; /** 列表数据字段名 */
+  list?: string; /** 总数字段名 */
+  count?: string; /** 行键字段名 */
   rowKey?: string;
 };
+/**
+ * 数据请求配置选项
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ */
 type UseDataRequestOptions<P extends DataObject = DataObject, D extends DataObject = DataObject> = {
-  defaultParams?: Partial<P>;
-  manual?: boolean;
-  fields?: DataRequestFields;
-  requestOptions?: UseRequestOptions<D, P[]>;
+  /** 默认请求参数 */defaultParams?: Partial<P>; /** 是否手动触发请求 */
+  manual?: boolean; /** 字段配置 */
+  fields?: DataRequestFields; /** useRequest 配置选项 */
+  requestOptions?: UseRequestOptions<D, P[]>; /** useRequest 插件 */
   requestPlugins?: UseRequestPlugin<D, P[]>[];
 };
+/**
+ * 数据请求分页信息
+ */
 type UseDataRequestPagination = {
-  page: number;
-  pageSize: number;
+  /** 当前页码 */page: number; /** 每页大小 */
+  pageSize: number; /** 总数据量 */
   itemCount: number;
 };
+/**
+ * 用于处理数据请求的组合式 API
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ * @template R 列表项类型
+ * @param api 请求 API 函数
+ * @param options 配置选项
+ * @returns 数据请求操作对象
+ */
 declare function useDataRequest<P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject>(api: (...args: P[]) => Promise<D>, options?: UseDataRequestOptions<P, D>): {
-  loading: Readonly<vue0.Ref<boolean, boolean>>;
-  data: Readonly<vue0.Ref<D | undefined, D | undefined>>;
-  error: Readonly<vue0.Ref<Error | undefined, Error | undefined>>;
-  params: Readonly<vue0.Ref<[] | P[], [] | P[]>>;
-  list: vue0.ComputedRef<R[]>;
-  pagination: vue0.Ref<{
+  /** 加载状态 */loading: Readonly<vue4.Ref<boolean, boolean>>; /** 响应数据 */
+  data: Readonly<vue4.Ref<D | undefined, D | undefined>>; /** 错误信息 */
+  error: Readonly<vue4.Ref<Error | undefined, Error | undefined>>; /** 请求参数 */
+  params: Readonly<vue4.Ref<[] | P[], [] | P[]>>; /** 列表数据 */
+  list: vue4.ComputedRef<R[]>; /** 分页信息 */
+  pagination: vue4.Ref<{
     page: number;
     pageSize: number;
     itemCount: number;
@@ -37,21 +61,27 @@ declare function useDataRequest<P extends DataObject = DataObject, D extends Dat
     page: number;
     pageSize: number;
     itemCount: number;
-  }>;
-  run: (...params: P[]) => void;
-  runAsync: (...params: P[]) => Promise<D>;
-  refresh: () => void;
-  refreshAsync: () => Promise<D>;
-  cancel: () => void;
-  mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
-  setParams: (_params: Partial<P>) => void;
-  runParams: (_params: Partial<P>) => void;
-  runParamsAsync: (_params: Partial<P>) => Promise<D>;
-  onBefore: _vueuse_core0.EventHookOn<[P[]]>;
-  onSuccess: _vueuse_core0.EventHookOn<[D, P[]]>;
-  onError: _vueuse_core0.EventHookOn<[Error, P[]]>;
+  }>; /** 运行请求 */
+  run: (...params: P[]) => void; /** 异步运行请求 */
+  runAsync: (...params: P[]) => Promise<D>; /** 刷新请求 */
+  refresh: () => void; /** 异步刷新请求 */
+  refreshAsync: () => Promise<D>; /** 取消请求 */
+  cancel: () => void; /** 修改响应数据 */
+  mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void; /** 设置请求参数 */
+  setParams: (_params: Partial<P>) => void; /** 设置参数并运行请求 */
+  runParams: (_params: Partial<P>) => void; /** 设置参数并异步运行请求 */
+  runParamsAsync: (_params: Partial<P>) => Promise<D>; /** 请求前事件 */
+  onBefore: _vueuse_core0.EventHookOn<[P[]]>; /** 请求成功事件 */
+  onSuccess: _vueuse_core0.EventHookOn<[D, P[]]>; /** 请求错误事件 */
+  onError: _vueuse_core0.EventHookOn<[Error, P[]]>; /** 请求完成事件 */
   onFinally: _vueuse_core0.EventHookOn<[P[], D | undefined, Error | undefined]>;
 };
+/**
+ * useDataRequest 返回类型
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ * @template R 列表项类型
+ */
 type UseDataRequestReturns<P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject> = ReturnType<typeof useDataRequest<P, D, R>>;
 //#endregion
 export { DataObject, DataRequestFields, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, useDataRequest };

package/dist/composables/use-data-request.js

@@ -1,8 +1,17 @@
-import { createEventHook } from "@vueuse/core";
 import { computed, ref } from "vue";
+import { createEventHook } from "@vueuse/core";
 import useRequest from "vue-hooks-plus/es/useRequest";
 
 //#region src/composables/use-data-request.ts
+/**
+* 用于处理数据请求的组合式 API
+* @template P 请求参数类型
+* @template D 响应数据类型
+* @template R 列表项类型
+* @param api 请求 API 函数
+* @param options 配置选项
+* @returns 数据请求操作对象
+*/
 function useDataRequest(api, options) {
 	const { defaultParams, manual, fields, requestOptions, requestPlugins } = options ?? {};
 	const _fields = {
@@ -59,15 +68,29 @@ function useDataRequest(api, options) {
 		}
 	}, requestPlugins);
 	const list = computed(() => data.value?.[_fields.list] ?? []);
+	/**
+	* 设置请求参数
+	* @param _params 要设置的参数
+	*/
 	function setParams(_params) {
 		Object.assign(params.value?.[0], _params);
 	}
+	/**
+	* 设置参数并运行请求
+	* @param _params 要设置的参数
+	* @returns 请求结果
+	*/
 	function runParams(_params) {
 		return run({
 			...params.value?.[0],
 			..._params
 		});
 	}
+	/**
+	* 设置参数并异步运行请求
+	* @param _params 要设置的参数
+	* @returns 请求结果 Promise
+	*/
 	function runParamsAsync(_params) {
 		return runAsync({
 			...params.value?.[0],

package/dist/composables/use-loading.d.ts

@@ -1,6 +1,10 @@
 import { LoadingProviderInst } from "../components/loading-provider/index.js";
 
 //#region src/composables/use-loading.d.ts
+/**
+ * 用于获取 Naive UI 加载状态提供者的组合式 API
+ * @returns 加载状态提供者实例
+ */
 declare function useLoading(): LoadingProviderInst | undefined;
 //#endregion
 export { useLoading };