@nova-kits/hooks 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 floral-rice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/config.d.ts

@@ -0,0 +1,59 @@
+import { type InjectionKey, type App, type Component } from 'vue';
+export interface HooksConfig {
+    /**
+     * 显示加载中的 toast
+     * @returns toast 实例，用于取消显示
+     */
+    showToast: () => any;
+    /**
+     * 取消 toast 显示
+     * @param toast toast 实例
+     */
+    cancelToast: (toast: any) => void;
+    /**
+     * 显示错误信息
+     * @param err 错误对象
+     */
+    showError: (err: Error) => void;
+    /**
+     * 显示加载中状态
+     * @returns 加载中组件或 null
+     */
+    showLoading: () => Component | null;
+    /**
+     * 错误结果展示
+     * @param err 错误对象
+     * @param refresh 刷新函数
+     * @returns 错误展示组件或 null
+     */
+    errorResult: (err: Error, refresh: () => void) => Component | null;
+    /**
+     * 设置主题色
+     * @param val 颜色值
+     */
+    setPrimaryColor: (val: string) => void;
+    /**
+     * 默认 throttle 时间，便于移动端使用
+     */
+    requestThrottleInterval: number;
+    /**
+     * request lock 防止 useRequest 重复调用
+     */
+    requestLock?: boolean;
+}
+export declare const defaultHooksConfig: HooksConfig;
+export declare const HOOKS_CONFIG_KEY: InjectionKey<HooksConfig>;
+/**
+ * 获取 hooks 配置
+ */
+export declare function useHooksConfig(): HooksConfig;
+/**
+ * 提供 hooks 配置
+ */
+export declare function provideHooksConfig(config: Partial<HooksConfig>): void;
+/**
+ * 创建 hooks 插件，用于全局配置
+ */
+export declare function createHooksPlugin(config: Partial<HooksConfig>): {
+    install(app: App): void;
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default as useRequest } from './useRequest';
+export { useHooksConfig, provideHooksConfig, createHooksPlugin, type HooksConfig } from './config';

package/dist/index.esm.js

@@ -0,0 +1,102 @@
+import { inject as F, provide as K, ref as t, onMounted as _, watch as j, onUnmounted as x } from "vue";
+import { debounce as G, throttle as M } from "lodash-es";
+const a = (e) => {
+  console.warn(`please implement: ${e}`);
+}, I = {
+  showToast() {
+    return a("showToast"), null;
+  },
+  cancelToast() {
+    a("cancelToast");
+  },
+  showError(e) {
+    console.error(e);
+  },
+  errorResult() {
+    return a("errorResult"), null;
+  },
+  setPrimaryColor() {
+    a("setPrimaryColor");
+  },
+  showLoading() {
+    return a("showLoading"), null;
+  },
+  requestThrottleInterval: 0,
+  requestLock: !1
+}, R = /* @__PURE__ */ Symbol("hooks-config");
+function N() {
+  return F(R, I);
+}
+function U(e) {
+  K(R, { ...I, ...e });
+}
+function z(e) {
+  return {
+    install(w) {
+      U(e);
+    }
+  };
+}
+function A(e, w = {}) {
+  const r = N(), {
+    onSuccess: q,
+    onError: g,
+    throttleInterval: k = r.requestThrottleInterval || 0,
+    debounceInterval: p = 0,
+    loadingState: T = !0,
+    onLoading: u,
+    toast: H = !1,
+    manual: i = !0,
+    defaultData: L = null,
+    refreshDeps: y = [],
+    onFinally: S,
+    lock: b = r.requestLock || !1,
+    showError: O
+  } = w, C = O || r.showError, c = t(!1), E = t(L), n = t(!1), v = t(0), h = t(!1), l = t(null), P = () => {
+    H && !l.value && (l.value = r.showToast() || !0), T && (c.value = !0), u && u(!0);
+  }, d = () => {
+    l.value && (r.cancelToast(l.value), l.value = null), n.value && (T && (c.value = !1), u && u(!1));
+  }, s = async (...m) => {
+    if (h.value)
+      return;
+    b && (h.value = !0), v.value += 1, P();
+    const D = v.value;
+    try {
+      const o = await e(...m);
+      n.value && D === v.value ? (d(), q?.(o, m), i || (E.value = o)) : n.value || d();
+    } catch (o) {
+      d(), g ? g(o, m, () => {
+        C(o);
+      }) : C(o);
+    } finally {
+      S?.(), h.value = !1;
+    }
+  };
+  let f;
+  return p ? f = G(s, p) : k ? f = M(s, k, { trailing: !1 }) : f = s, _(() => {
+    n.value = !0, i || s();
+  }), y.length > 0 && !i && j(y, () => {
+    s();
+  }), x(() => {
+    n.value = !1;
+  }), {
+    /**
+     * 手动执行函数
+     */
+    run: f,
+    /**
+     * loading状态
+     */
+    loading: c,
+    /**
+     * 数据
+     */
+    data: E
+  };
+}
+export {
+  z as createHooksPlugin,
+  U as provideHooksConfig,
+  N as useHooksConfig,
+  A as useRequest
+};

package/dist/index.umd.cjs

@@ -0,0 +1 @@
+(function(o,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("vue"),require("lodash-es")):typeof define=="function"&&define.amd?define(["exports","vue","lodash-es"],e):(o=typeof globalThis<"u"?globalThis:o||self,e(o.NovaKits={},o.Vue,o.lodashEs))})(this,(function(o,e,k){"use strict";const r=t=>{console.warn(`please implement: ${t}`)},m={showToast(){return r("showToast"),null},cancelToast(){r("cancelToast")},showError(t){console.error(t)},errorResult(){return r("errorResult"),null},setPrimaryColor(){r("setPrimaryColor")},showLoading(){return r("showLoading"),null},requestThrottleInterval:0,requestLock:!1},p=Symbol("hooks-config");function y(){return e.inject(p,m)}function T(t){e.provide(p,{...m,...t})}function P(t){return{install(C){T(t)}}}function b(t,C={}){const s=y(),{onSuccess:O,onError:q,throttleInterval:H=s.requestThrottleInterval||0,debounceInterval:E=0,loadingState:R=!0,onLoading:i,toast:j=!1,manual:c=!0,defaultData:K=null,refreshDeps:S=[],onFinally:D,lock:F=s.requestLock||!1,showError:M}=C,I=M||s.showError,d=e.ref(!1),L=e.ref(K),l=e.ref(!1),h=e.ref(0),v=e.ref(!1),a=e.ref(null),N=()=>{j&&!a.value&&(a.value=s.showToast()||!0),R&&(d.value=!0),i&&i(!0)},g=()=>{a.value&&(s.cancelToast(a.value),a.value=null),l.value&&(R&&(d.value=!1),i&&i(!1))},u=async(...w)=>{if(v.value)return;F&&(v.value=!0),h.value+=1,N();const _=h.value;try{const n=await t(...w);l.value&&_===h.value?(g(),O?.(n,w),c||(L.value=n)):l.value||g()}catch(n){g(),q?q(n,w,()=>{I(n)}):I(n)}finally{D?.(),v.value=!1}};let f;return E?f=k.debounce(u,E):H?f=k.throttle(u,H,{trailing:!1}):f=u,e.onMounted(()=>{l.value=!0,c||u()}),S.length>0&&!c&&e.watch(S,()=>{u()}),e.onUnmounted(()=>{l.value=!1}),{run:f,loading:d,data:L}}o.createHooksPlugin=P,o.provideHooksConfig=T,o.useHooksConfig=y,o.useRequest=b,Object.defineProperty(o,Symbol.toStringTag,{value:"Module"})}));

package/dist/useRequest/index.d.ts

@@ -0,0 +1,79 @@
+import { type Ref } from 'vue';
+/**
+ * 发起网络请求, 主要面向场景: 提交单据、点击列表打开详情页前请求数据，自动捕获异常
+ * @param request 网络请求方法
+ * @param options 参数
+ * @returns
+ */
+export default function useRequest<T extends (...args: any[]) => Promise<any> | any, K = T extends (...args: any) => Promise<infer U> | infer U ? U : never>(request: T, options?: {
+    /**
+     * loading状态变化监听函数
+     */
+    onLoading?: (loading: boolean) => void;
+    /**
+     * 成功回调
+     * @param res request返回的数据
+     * @param params request的参数
+     */
+    onSuccess?: (res: K, params: Parameters<T>) => void;
+    /**
+     * 错误回调
+     * @param err 异常，抛出异常的时候务必是Error的实例
+     * @param params request的参数
+     * @param showError 调用全局的错误信息提示
+     */
+    onError?: (err: Error, params: Parameters<T>, showError: () => void) => void;
+    /**
+     * 最终回调
+     */
+    onFinally?: () => void;
+    /**
+     * 节流模式的时间
+     */
+    throttleInterval?: number;
+    /**
+     * 防抖模式的时间
+     */
+    debounceInterval?: number;
+    /**
+     * 启用loading状态
+     */
+    loadingState?: boolean;
+    /**
+     * 是否展示加载中的toast
+     */
+    toast?: boolean;
+    /**
+     * 是否需要手动执行 默认 true，非手动模式默认会返回request返回的数据
+     */
+    manual?: boolean;
+    /**
+     * 自动模式data的默认值，否则就是null
+     */
+    defaultData?: K;
+    /**
+     * 非手动模式自动刷新的依赖项
+     */
+    refreshDeps?: Ref<any>[];
+    /**
+     * 在上一次未完成之前，防止重复调用
+     */
+    lock?: boolean;
+    /**
+     * 自定义错误处理，覆盖全局配置
+     */
+    showError?: (err: Error) => void;
+}): {
+    /**
+     * 手动执行函数
+     */
+    run: (...args: Parameters<T>) => void;
+    /**
+     * loading状态
+     */
+    loading: Ref<boolean>;
+    /**
+     * 数据
+     */
+    data: Ref<K>;
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@nova-kits/hooks",
+  "version": "1.0.0",
+  "description": "Nova Kits Vue hooks",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./src/*": "./src/*"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "lodash-es": "^4.17.21"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.24"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
+    "@vitejs/plugin-vue": "^6.0.0",
+    "typescript": "^6.0.3",
+    "vite": "^7.2.4",
+    "vue-tsc": "^3.1.4"
+  },
+  "scripts": {
+    "build": "vite build && vue-tsc --declaration --emitDeclarationOnly --outDir dist"
+  }
+}