zf-dbs 2.0.1 → 2.0.2

package/dist/index.d.ts

@@ -183,9 +183,32 @@ readonly appElement: HTMLElement | null;
 readonly appViewElement: HTMLElement | null;
 }>;
 
-export declare function usePolling<T, D = undefined, Config extends UsePollingConfig<T> = UsePollingConfig<T>>(listener: UsePollingListener<T>, defaultValue?: UsePollingDefaultValue<D>, config?: Config): UsePollingResponse<T, Config, D>;
+/**
+ * 轮询 Hook
+ *
+ * 类型推导效果：
+ * - listener 返回 Promise<User>，state => User | D
+ * - defaultValue 不传，state => User | undefined
+ * - defaultValue 传 0，state => User | 0
+ *
+ * setConfig 只允许修改运行时安全项：
+ * - delay
+ * - leading
+ * - resetOnExecute
+ * - throwError
+ * - onError
+ * - onSuccess
+ *
+ * 不允许修改：
+ * - shallow
+ * - immediate
+ */
+export declare function usePolling<TListener extends UsePollingListener<any>, D = undefined, TConfig extends UsePollingConfig<UsePollingResolvedValue<TListener>> = UsePollingConfig<UsePollingResolvedValue<TListener>>>(listener: TListener, defaultValue?: UsePollingDefaultValue<D>, config?: TConfig): UsePollingResponse<UsePollingResolvedValue<TListener>, TConfig, D>;
 
-declare type UsePollingConfig<T> = {
+/**
+ * 原始配置
+ */
+declare type UsePollingConfig<TResult> = {
     delay?: number;
     immediate?: boolean;
     leading?: boolean;
@@ -193,43 +216,95 @@ declare type UsePollingConfig<T> = {
     resetOnExecute?: boolean;
     throwError?: boolean;
     onError?: (error: unknown) => void;
-    onSuccess?: (result: T) => void;
+    onSuccess?: (result: TResult) => void;
 };
 
+/**
+ * 默认值
+ * 允许不传，也允许显式传 undefined
+ */
 declare type UsePollingDefaultValue<T = undefined> = T | undefined;
 
-declare type UsePollingListener<T> = () => Promise<T> | T;
+/**
+ * 轮询监听器
+ * 支持同步值，也支持 Promise
+ */
+declare type UsePollingListener<TResult> = () => TResult | Promise<TResult>;
 
-export declare function usePollingRef<T, D = undefined>(listener: () => Promise<T> | T, defaultValue?: D, config?: UsePollingConfig<T>): globalThis.Ref<UsePollingStateType<T, D>>;
+/**
+ * 允许运行时修改的配置
+ * shallow / immediate 不允许改
+ */
+declare type UsePollingMutableConfig<TResult> = Omit<UsePollingConfig<TResult>, 'shallow' | 'immediate'>;
+
+/**
+ * 仅返回 state 的版本
+ * 参数、类型推导、默认值行为都和 usePolling 完全一致
+ */
+export declare function usePollingRef<TListener extends UsePollingListener<any>, D = undefined, TConfig extends UsePollingConfig<Awaited<ReturnType<TListener>>> = UsePollingConfig<Awaited<ReturnType<TListener>>>>(listener: TListener, defaultValue?: UsePollingDefaultValue<D>, config?: TConfig): UsePollingResponse<Awaited<ReturnType<TListener>>, TConfig, D>['state'];
 
-declare type UsePollingResponse<T, Config extends UsePollingConfig<T>, D = undefined> = {
-    state: UsePollingStateTypeRef<T, Config, D>;
+/**
+ * listener 的最终返回值
+ * Promise<T> 会自动解包成 T
+ */
+declare type UsePollingResolvedValue<TListener extends UsePollingListener<any>> = Awaited<ReturnType<TListener>>;
+
+/**
+ * 对外返回值
+ */
+declare type UsePollingResponse<TResult, TConfig extends UsePollingConfig<TResult>, D = undefined> = {
+    state: UsePollingStateTypeRef<TResult, TConfig, D>;
     isLoading: Ref_2<boolean>;
     error: Ref_2<unknown>;
-    execute: UsePollingResponseExecute<T>;
+    execute: UsePollingResponseExecute<TResult>;
     pause: () => void;
     resume: UsePollingResponseResume;
     reset: () => void;
+    setConfig: (config: UsePollingSetConfig<TResult>) => void;
 };
 
-declare type UsePollingResponseExecute<T> = (config?: UsePollingResponseExecuteConfig<T>) => Promise<void>;
+/**
+ * 主动执行
+ */
+declare type UsePollingResponseExecute<TResult> = (config?: UsePollingResponseExecuteConfig<TResult>) => Promise<void>;
 
-declare type UsePollingResponseExecuteConfig<T> = {
+/**
+ * 执行时可覆盖的配置
+ */
+declare type UsePollingResponseExecuteConfig<TResult> = {
     resetOnExecute?: boolean;
     throwError?: boolean;
     onError?: (error: unknown) => void;
-    onSuccess?: (result: T) => void;
+    onSuccess?: (result: TResult) => void;
 };
 
+/**
+ * 继续轮询
+ */
 declare type UsePollingResponseResume = (config?: UsePollingResponseResumeConfig) => void;
 
+/**
+ * 继续轮询时的配置
+ */
 declare type UsePollingResponseResumeConfig = {
     leading?: boolean;
 };
 
-declare type UsePollingStateType<T, D = undefined> = T | D | undefined;
+/**
+ * setConfig 的入参
+ */
+declare type UsePollingSetConfig<TResult> = Partial<UsePollingMutableConfig<TResult>>;
+
+/**
+ * state 的值类型
+ * 结果类型 + 默认值类型
+ */
+declare type UsePollingStateType<TResult, D = undefined> = TResult | D;
 
-declare type UsePollingStateTypeRef<T, Config extends UsePollingConfig<T>, D = undefined> = Config['shallow'] extends true ? ShallowRef<UsePollingStateType<T, D>> : Ref_2<UsePollingStateType<T, D>>;
+/**
+ * shallow 模式下返回 ShallowRef，否则返回 Ref
+ */
+declare type UsePollingStateTypeRef<TResult, TConfig extends UsePollingConfig<TResult>, D = undefined> = TConfig['shallow'] extends true ? ShallowRef<UsePollingStateType<TResult, D>> : Ref_2<UsePollingStateType<TResult, D>>;
 
 export declare const ZfApp: __VLS_WithTemplateSlots<DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<globalThis.ExtractPropTypes<{}>>, {}, {}>, {
     default?(_: {}): any;

package/dist/index.mjs

@@ -1,22 +1,17 @@
-import { a as b, g as h, m as _, t as E, _ as y } from "./chunks/qN7meZTV.mjs";
-import { z as k, d as B, u as D, b as G } from "./chunks/qN7meZTV.mjs";
-import { _ as x } from "./chunks/Ck0Cdfr_.mjs";
-import { _ as C } from "./chunks/BHHE86vT.mjs";
-import { z as Q } from "./chunks/BHHE86vT.mjs";
-import { ref as a, shallowRef as O, onMounted as A } from "vue";
-import { ElNotification as q } from "element-plus";
-import { Z as X } from "./chunks/DbOTUn3A.mjs";
-const R = function(e) {
+import { a as b, g as O, m as A, t as S, _ as q } from "./chunks/qN7meZTV.mjs";
+import { z as X, d as Y, u as ee, b as oe } from "./chunks/qN7meZTV.mjs";
+import { _ as j } from "./chunks/Ck0Cdfr_.mjs";
+import { _ as N } from "./chunks/BHHE86vT.mjs";
+import { z as ne } from "./chunks/BHHE86vT.mjs";
+import { ref as i, shallowRef as z, onMounted as P, onBeforeUnmount as T } from "vue";
+import { ElNotification as U } from "element-plus";
+import { Z as se } from "./chunks/DbOTUn3A.mjs";
+const L = function(e) {
   return e;
 };
-function S() {
-  return new Promise((e) => {
-    requestAnimationFrame(e);
-  });
-}
-function j(e, t, o) {
-  o = Object.assign({
-    delay: 3e3,
+function Z() {
+  return {
+    delay: b.value?.pollingInterval || 3e3,
     immediate: !0,
     leading: !0,
     resetOnExecute: !1,
@@ -26,146 +21,173 @@ function j(e, t, o) {
     },
     onSuccess: () => {
     }
-  }, o);
-  const n = a(0), r = o.shallow ? O(t) : a(t), s = a(!1), c = a(null), p = async (v) => {
-    const f = Object.assign({}, o, v);
-    n.value++;
-    const w = n.value;
-    s.value = !0, f?.resetOnExecute && (r.value = t);
+  };
+}
+function H() {
+  return new Promise((e) => {
+    requestAnimationFrame(() => e());
+  });
+}
+function I(e, o, t) {
+  const n = Object.assign(Z(), t ?? {}), r = i(0), f = o, p = n.shallow ? z(f) : i(f), d = i(!1), v = i(null), l = i(null), u = i(!0), m = () => {
+    l.value !== null && (clearTimeout(l.value), l.value = null);
+  }, C = (c) => {
+    Object.assign(n, c);
+  }, w = async (c) => {
+    const g = Object.assign(
+      {
+        resetOnExecute: n.resetOnExecute,
+        throwError: n.throwError,
+        onError: n.onError,
+        onSuccess: n.onSuccess
+      },
+      c ?? {}
+    );
+    r.value += 1;
+    const E = r.value;
+    d.value = !0, g.resetOnExecute && (p.value = o);
     try {
-      const l = await Promise.resolve(e());
-      w === n.value && (c.value = null, r.value = l, f?.onSuccess?.(l));
-    } catch (l) {
-      if (w === n.value && (c.value = l, f?.onError?.(l), f?.throwError))
-        throw l;
+      const s = await Promise.resolve(e());
+      E === r.value && (v.value = null, p.value = s, g.onSuccess?.(s));
+    } catch (s) {
+      if (E === r.value && (v.value = s, g.onError?.(s), g.throwError))
+        throw s;
     } finally {
-      w === n.value && (s.value = !1);
+      E === r.value && (d.value = !1);
     }
-  }, i = a(null), d = () => {
-    i.value && clearInterval(i.value), i.value = null;
-  }, m = (v = { leading: o?.leading }) => {
-    d(), v?.leading && p(), i.value || (i.value = setTimeout(async () => {
-      try {
-        await p(), await S();
-      } finally {
-        i.value && m({ leading: !1 });
-      }
-    }, o?.delay));
-  }, g = () => {
-    d(), n.value = 0, r.value = t, s.value = !1, c.value = null, o?.immediate && m();
+  }, _ = () => {
+    m(), !u.value && (l.value = setTimeout(async () => {
+      if (l.value = null, !u.value)
+        try {
+          await w();
+        } catch {
+        } finally {
+          await H(), u.value || _();
+        }
+    }, n.delay));
+  }, h = () => {
+    u.value = !0, m();
+  }, x = (c = { leading: n.leading }) => {
+    u.value = !1, m(), c.leading && w().catch(() => {
+    }), _();
+  }, y = () => {
+    h(), r.value = 0, p.value = o, d.value = !1, v.value = null, n.immediate && x();
   };
-  return A(() => {
-    g();
+  return P(() => {
+    y();
+  }), T(() => {
+    h();
   }), {
-    state: r,
-    isLoading: s,
-    error: c,
-    execute: p,
-    pause: d,
-    resume: m,
-    reset: g
+    state: p,
+    isLoading: d,
+    error: v,
+    execute: w,
+    pause: h,
+    resume: x,
+    reset: y,
+    setConfig: C
   };
 }
-function T(e, t, o) {
-  return j(e, t, o).state;
+function k(e, o, t) {
+  return I(e, o, t).state;
 }
-function z() {
+function R() {
   if (!b.value)
     throw new Error("请先调用 defineAppConfig 进行配置");
   return b.value;
 }
-const u = Object.assign(function(e) {
-  return q({
+const a = Object.assign(function(e) {
+  return U({
     ...e,
-    appendTo: h().appViewElement || document.body || void 0
+    appendTo: O().appViewElement || document.body || void 0
   });
 }, {
   success(e) {
-    return u({
+    return a({
       ...e,
       type: "success"
     });
   },
   info(e) {
-    return u({
+    return a({
       ...e,
       type: "info"
     });
   },
   warning(e) {
-    return u({
+    return a({
       ...e,
       type: "warning"
     });
   },
   error(e) {
-    return u({
+    return a({
       ...e,
       type: "error"
     });
   }
-}), $ = _(() => {
-  const e = z();
+}), G = A(() => {
+  const e = R();
   return {
     ...e.request,
-    errorHandle(t, o, n) {
-      if (e.request.showErrorMessage && u.error({ message: o }), e.request.errorHandle)
-        return e.request.errorHandle(t, o, n);
+    errorHandle(o, t, n) {
+      if (e.request.showErrorMessage && a.error({ message: t }), e.request.errorHandle)
+        return e.request.errorHandle(o, t, n);
     }
   };
 });
-class N extends E {
+class $ extends S {
   /**
    * 发送事件
    * @param {string} name 事件名称
    * @param {unknown[]} args 参数
    */
-  emit(t, ...o) {
-    return o = o.map((n) => JSON.parse(JSON.stringify(n))), console.log(`%c发送UE事件 %c${t}`, "color: #529b2e; font-weight: bold;", "color: #337ecc", ...o), window?.ue?.web?.[t]?.(...o);
+  emit(o, ...t) {
+    return t = t.map((n) => JSON.parse(JSON.stringify(n))), console.log(`%c发送UE事件 %c${o}`, "color: #529b2e; font-weight: bold;", "color: #337ecc", ...t), window?.ue?.web?.[o]?.(...t);
   }
   /**
    * 注册事件
    * @param {string} name 事件名称
    * @param {UnknownFunction} listener 事件处理函数
    */
-  on(t, o) {
-    return console.log(`%c注册UE事件 %c${t}`, "color: #b88230; font-weight: bold;", "color: #337ecc"), window[t] || (window[t] = this.dispatchEvent.bind(this, t)), super.on(t, o);
+  on(o, t) {
+    return console.log(`%c注册UE事件 %c${o}`, "color: #b88230; font-weight: bold;", "color: #337ecc"), window[o] || (window[o] = this.dispatchEvent.bind(this, o)), super.on(o, t);
   }
   /**
    * 注销事件
    * @param {string} name 事件名称
    * @param {UnknownFunction} listener 事件处理函数
    */
-  off(t, o) {
-    console.log(`%c注销UE事件 %c${t}`, "color: #909399; font-weight: bold;", "color: #337ecc");
-    const n = super.off(t, o);
-    return this.listeners(t).length || delete window[t], n;
+  off(o, t) {
+    console.log(`%c注销UE事件 %c${o}`, "color: #909399; font-weight: bold;", "color: #337ecc");
+    const n = super.off(o, t);
+    return this.listeners(o).length || delete window[o], n;
   }
 }
-const F = new N(), J = {
+const K = new $(), Q = {
   install(e) {
-    Object.entries(/* @__PURE__ */ Object.assign({ "./components/zf-app/index.ts": y, "./components/zf-scale-container/index.ts": x, "./components/zf-tween-number/index.ts": C })).forEach(([o, n]) => {
-      const r = n.default, s = o.split("/")[2];
-      e.component(s, r);
+    Object.entries(/* @__PURE__ */ Object.assign({ "./components/zf-app/index.ts": q, "./components/zf-scale-container/index.ts": j, "./components/zf-tween-number/index.ts": N })).forEach(([t, n]) => {
+      const r = n.default, f = t.split("/")[2];
+      e.component(f, r);
     });
   }
 };
 export {
-  N as Ue,
-  k as ZfApp,
-  X as ZfScaleContainer,
-  Q as ZfTweenNumber,
-  J as default,
-  B as defineAppConfig,
-  _ as defineRequest,
-  R as defineService,
-  z as getAppConfig,
-  h as getAppInfo,
-  u as notify,
-  $ as request,
-  F as ue,
-  D as useAppConfig,
-  G as useAppInfo,
-  j as usePolling,
-  T as usePollingRef
+  $ as Ue,
+  X as ZfApp,
+  se as ZfScaleContainer,
+  ne as ZfTweenNumber,
+  Q as default,
+  Y as defineAppConfig,
+  A as defineRequest,
+  L as defineService,
+  R as getAppConfig,
+  O as getAppInfo,
+  a as notify,
+  G as request,
+  K as ue,
+  ee as useAppConfig,
+  oe as useAppInfo,
+  I as usePolling,
+  k as usePollingRef
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "zf-dbs",
   "type": "module",
   "description": "",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",