@hlw-uni/mp-vue 2.1.51 → 2.1.54

package/dist/composables/validate/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * useValidate - 校验工具 composable
- */
-export declare function useValidate(): {
-    phone: (value: string) => boolean;
-    email: (value: string) => boolean;
-    url: (value: string) => boolean;
-    idCard: (value: string) => boolean;
-    carNumber: (value: string) => boolean;
-    password: (value: string) => boolean;
-    empty: (value: unknown) => boolean;
-};

package/dist/error.d.ts

@@ -1 +0,0 @@
-export declare function getErrorMessage(error: unknown): string;

package/src/composables/_internal/unwrap.ts

@@ -1,19 +0,0 @@
-/**
- * Adapter 返回值解包：兼容业务方传「已解包 T」或「ThinkAdmin envelope { code, data }」。
- *
- * 业务方写法：
- *   setConfigAd({ getConfig: getAdConfig })            // 直接传 envelope-returning 函数
- *   setConfigAd({ getConfig: async () => myUnwrapped })  // 也支持已解包
- *
- * 鸭子类型识别：raw 是对象且有 number 类型的 code 字段 → 当 envelope 处理。
- */
-export type AdapterPayload<T> = T | null | { code: number; data?: T; info?: string };
-
-export function unwrapPayload<T>(raw: AdapterPayload<T>): T | null {
-    if (raw == null) return null;
-    if (typeof raw === "object" && "code" in raw && typeof (raw as { code: unknown }).code === "number") {
-        const env = raw as { code: number; data?: T };
-        return env.code === 1 && env.data ? env.data : null;
-    }
-    return raw as T;
-}

package/src/composables/ad/index.ts

@@ -1,412 +0,0 @@
-/**
- * useAd —— 完整的广告业务封装
- *
- * 内置了：
- *   - 6 个 unit_id 配置（store 缓存，调 getConfig 拉一次）
- *   - 激励视频：广告加载 loading → onShown 自动关闭 → 中途关闭挽留 modal → 看完调业务方的 claim 发奖
- *   - 插屏：一行调用
- *   - 底层 SDK 适配（onLoad / offClose / show 兜底 / 实例缓存）
- *
- * 业务侧使用方式：
- *
- *   1. 在 App.vue 注入「全局」回调（拿配置 + 校验登录）：
- *
- *      import { setConfigAd } from "@hlw-uni/mp-vue";
- *      import { getAdConfig } from "@/api/ad";
- *      import { useUserStore } from "@/store";
- *
- *      setConfigAd({
- *          getConfig: async () => {
- *              const res = await getAdConfig();
- *              return res.code === 1 && res.data ? res.data : null;
- *          },
- *          isAuth: () => !!useUserStore().token,
- *      });
- *
- *   2. 任意页面拉配置 / 用 unit_id 渲染：
- *
- *      const { config, loadConfig, showPopup } = useAd();
- *      await loadConfig();
- *      <hlw-ad type="banner" :unit-id="config.banner" />
- *
- *   3. 看广告领奖励（业务方按场景传不同的 claim 接口）：
- *
- *      const ok = await showReward(async () => {
- *          const res = await claimAdReward();
- *          return res.code === 1
- *              ? { ok: true, reward: res.data?.reward }
- *              : { ok: false, msg: res.info };
- *      });
- *
- *      // 不传 claim 就是纯展示，看完即返回 true
- *      const ok = await showReward();
- */
-
-import { defineStore, storeToRefs } from "pinia";
-import { ref, computed } from "vue";
-import { useMsg, type HlwMsg } from "../msg";
-import { unwrapPayload, type AdapterPayload } from "../_internal/unwrap";
-
-/** showPopup 默认延迟（ms）：避免一进页面就弹打扰用户 */
-const DEFAULT_POPUP_DELAY_MS = 3000;
-
-/** 6 种广告类型 */
-export type AdType = "banner" | "grid" | "custom" | "video" | "reward" | "popup";
-
-/** 广告配置 —— 字段名跟后端表列名对齐（plugin_qz_mp.{type}_unit_id） */
-export interface AdConfig {
-    banner_unit_id: string;
-    grid_unit_id: string;
-    custom_unit_id: string;
-    video_unit_id: string;
-    reward_unit_id: string;
-    popup_unit_id: string;
-    /** VIP 屏蔽展示型广告（reward 除外）：0=否，1=屏蔽 banner/grid/custom/video/popup */
-    vip_no_ad?: 0 | 1;
-}
-
-/** 广告错误对象（onError 回调参数） */
-export interface AdError {
-    errCode: number;
-    errMsg: string;
-}
-
-/**
- * 业务回调注入接口 —— setConfigAd 时由项目提供。
- *
- * getConfig 支持两种返回：
- *   - 已解包：直接返回 AdConfig 或 null
- *   - ThinkAdmin envelope：返回 { code, data } 对象，库自动按 code===1 解包
- *
- * 业务方可以直接传 envelope-returning 的接口函数引用：
- *   setConfigAd({ getConfig: getAdConfig })
- */
-export interface AdAdapter {
-    getConfig: () => Promise<AdapterPayload<AdConfig>>;
-    /** 是否已登录；不传 = 不校验（showReward 调用前会问一次） */
-    isAuth?: () => boolean;
-    /** 是否 VIP；配合 config.vip_no_ad=1 时屏蔽展示型广告（reward 不受影响） */
-    isVip?: () => boolean;
-    /**
-     * 用户级强制屏蔽：返回 true 直接屏蔽展示型广告（reward 不受影响），
-     * 优先级高于 mp.vip_no_ad + isVip 的联合判断；不传 = 不强制。
-     */
-    userNoAd?: () => boolean;
-}
-
-/** 激励视频关闭回调返回 */
-export interface AdCloseResult {
-    /** 用户是否完整观看 */
-    isEnded: boolean;
-}
-
-const EMPTY: AdConfig = {
-    banner_unit_id: "",
-    grid_unit_id: "",
-    custom_unit_id: "",
-    video_unit_id: "",
-    reward_unit_id: "",
-    popup_unit_id: "",
-    vip_no_ad: 0,
-};
-
-let adapter: AdAdapter | null = null;
-
-/** 进行中的 loadConfig promise；并发调用时复用，避免冷启动多发请求 */
-let pending: Promise<void> | null = null;
-
-/**
- * 注入业务回调，应用启动时调用一次。
- * 不调用也不会崩，但 loadConfig / showReward 会无效。
- */
-export function setConfigAd(a: AdAdapter): void {
-    adapter = a;
-}
-
-const useAdStore = defineStore("hlw_ad", () => {
-    const config = ref<AdConfig>({ ...EMPTY });
-    const loaded = ref(false);
-    return { config, loaded };
-});
-
-/* ============================================================
- * 内部状态：消息单例 + 广告实例缓存
- * ============================================================ */
-
-let _msg: HlwMsg | null = null;
-const msg = (): HlwMsg => (_msg ??= useMsg());
-
-interface RewardedEntry {
-    ad: any;
-    /** 同一 unit_id 是否在 load 中，避免并发 */
-    loading: boolean;
-}
-const rewardedCache = new Map<string, RewardedEntry>();
-const interstitialCache = new Map<string, any>();
-
-/* ============================================================
- * 公共 composable
- * ============================================================ */
-
-export function useAd() {
-    const store = useAdStore();
-    const { loaded } = storeToRefs(store);
-
-    /**
-     * 真实生效的广告配置；以下任一命中即屏蔽展示型 unit_id（reward 保留）：
-     *   1. adapter.userNoAd() === true  —— 用户级强制屏蔽，优先级最高
-     *   2. raw.vip_no_ad === 1 && adapter.isVip() —— 小程序级 VIP 隐藏开关
-     */
-    const config = computed<AdConfig>(() => {
-        const raw = store.config;
-        const userForce = adapter?.userNoAd?.() === true;
-        const vipHide   = raw.vip_no_ad === 1 && adapter?.isVip?.() === true;
-        if (userForce || vipHide) {
-            return { ...EMPTY, reward_unit_id: raw.reward_unit_id, vip_no_ad: 1 };
-        }
-        return raw;
-    });
-
-    /**
-     * 拉取广告配置（小程序冷启动后调一次即可）。
-     * 并发调用复用同一次请求；`force=true` 跳过 loaded/pending 短路重新拉。
-     */
-    async function loadConfig(force = false): Promise<void> {
-        if (loaded.value && !force) return;
-        if (pending && !force) return pending;
-        if (!adapter?.getConfig) {
-            console.warn("[useAd] adapter.getConfig 未注入；先调用 setConfigAd()");
-            return;
-        }
-        const fn = adapter.getConfig;
-        const flight = (async () => {
-            try {
-                const cfg = unwrapPayload(await fn());
-                if (cfg) {
-                    store.config = cfg;
-                    store.loaded = true;
-                }
-            } catch (e) {
-                console.warn("[useAd] load config failed", e);
-            } finally {
-                if (pending === flight) pending = null;
-            }
-        })();
-        pending = flight;
-        return flight;
-    }
-
-    /** 取指定类型的 unit_id（hlw-ad 组件 / 业务直接调时用），自动应用 VIP 屏蔽 */
-    function getUnitId(type: AdType): string {
-        return (config.value[`${type}_unit_id` as keyof AdConfig] as string) || "";
-    }
-
-    /**
-     * 显示激励视频 —— 播一次、关闭后调 onClose（带 isEnded），其它都交给业务。
-     *
-     *   showReward(({ isEnded }) => {
-     *       if (!isEnded) confirm().then(goon => goon && tapReward());
-     *       else claimAdReward().then(...);
-     *   });
-     *
-     * @param onClose 关闭回调；不传则只播。retry / toast / 发奖全在业务侧自己写。
-     */
-    async function showReward(onClose?: (res: AdCloseResult) => void | Promise<void>): Promise<void> {
-        const unitId = getUnitId("reward");
-        if (!unitId) {
-            msg().toast("激励广告未配置");
-            return;
-        }
-        if (adapter?.isAuth && !adapter.isAuth()) {
-            msg().toast("请先登录");
-            return;
-        }
-        const closeRes = await playRewardedOnce(unitId);
-        if (onClose) await onClose(closeRes);
-    }
-
-    /**
-     * 显示插屏广告
-     * @returns true=展示成功；false=配置缺失 / show 失败（如近期已展示过）
-     */
-    /**
-     * 显示插屏广告，默认延迟 3000ms 避免一进页面就弹打扰；传 0 立即弹。
-     * @returns true=展示成功；false=配置缺失 / show 失败（如近期已展示过）
-     *
-     * 实现注意：用 setTimeout + .then() 串接而非 async/await，保持 WX 插屏
-     * ad.show() 的调用栈跟 setTimeout 回调一致 —— 小程序引擎对插屏的合法
-     * 触发时机敏感，async/await 多插的 microtask 会被判为"非合法触发"导致
-     * 静默不弹。
-     */
-    function showPopup(delayMs: number = DEFAULT_POPUP_DELAY_MS): Promise<boolean> {
-        return new Promise<boolean>((resolve) => {
-            setTimeout(() => {
-                loadConfig().then(() => {
-                    const unitId = getUnitId("popup");
-                    if (!unitId) {
-                        resolve(false);
-                        return;
-                    }
-                    showInterstitialAd(unitId).then(resolve);
-                });
-            }, delayMs);
-        });
-    }
-
-    return {
-        // 状态
-        config,
-        loaded,
-        // 方法
-        loadConfig,
-        getUnitId,
-        showReward,
-        showPopup,
-        confirm: confirmModal,
-    };
-}
-
-/* ============================================================
- * 内部 helper：业务流程层
- * ============================================================ */
-
-/** 播放一次激励视频，期间显示加载提示，广告 UI 弹出后自动 hide */
-async function playRewardedOnce(unitId: string): Promise<AdCloseResult> {
-    msg().showLoading("广告加载中");
-    let hidden = false;
-    const hide = () => {
-        if (hidden) return;
-        hidden = true;
-        msg().hideLoading();
-    };
-    try {
-        const isEnded = await showRewardedAd(unitId, { onShown: hide });
-        return { isEnded };
-    } finally {
-        // 兜底：如果 onShown 没触发（show 直接 reject 等），最终也得关 loading
-        hide();
-    }
-}
-
-/**
- * 激励视频中途关闭挽留弹窗 —— 通过 useAd().confirm 暴露给业务方：
- *
- *   const { showReward, confirm } = useAd();
- *   showReward(async ({ isEnded }) => {
- *       if (!isEnded) return { ok: false, retry: await confirm() };
- *       const r = await claimAdReward();
- *       return r.code === 1 ? { ok: true, reward: r.data?.reward } : { ok: false, msg: r.info };
- *   });
- *
- * @returns true=用户选「继续观看」 / false=放弃
- */
-function confirmModal(): Promise<boolean> {
-    return new Promise((resolve) => {
-        uni.showModal({
-            title: "提示",
-            content: "看完广告才可以领取奖励哦，要继续观看吗？",
-            confirmText: "继续观看",
-            cancelText: "放弃",
-            success: (r) => resolve(!!r.confirm),
-            fail: () => resolve(false),
-        });
-    });
-}
-
-/* ============================================================
- * 内部 helper：底层 SDK 适配
- * ============================================================ */
-
-/**
- * 底层激励视频包装：onClose / onError 解绑 + load + show 兜底
- *
- * @param hooks.onShown 广告 UI 已渲染时回调（业务用来关 loading）
- */
-function showRewardedAd(unitId: string, hooks?: { onShown?: () => void }): Promise<boolean> {
-    return new Promise((resolve) => {
-        let entry = rewardedCache.get(unitId);
-        if (!entry) {
-            const ad: any = uni.createRewardedVideoAd({ adUnitId: unitId });
-            if (!ad) { resolve(false); return; }
-            ad.onError?.((err: AdError) => {
-                console.warn(`[useAd] reward onError (${unitId})`, err);
-            });
-            entry = { ad, loading: false };
-            rewardedCache.set(unitId, entry);
-        }
-        const { ad } = entry;
-
-        let closeHandler: ((res: { isEnded: boolean }) => void) | null = null;
-        let errorHandler: ((err: AdError) => void) | null = null;
-        const cleanup = () => {
-            if (closeHandler) { ad.offClose?.(closeHandler); closeHandler = null; }
-            if (errorHandler) { ad.offError?.(errorHandler); errorHandler = null; }
-        };
-        closeHandler = (res) => {
-            cleanup();
-            resolve(!!(res && res.isEnded));
-        };
-        errorHandler = (err) => {
-            console.warn(`[useAd] reward show error (${unitId})`, err);
-            cleanup();
-            resolve(false);
-        };
-        ad.onClose(closeHandler);
-        ad.onError(errorHandler);
-
-        const doShow = () =>
-            ad.show()
-                .then(() => {
-                    try { hooks?.onShown?.(); } catch (e) { console.warn("[useAd] onShown error", e); }
-                })
-                .catch(() => {
-                    cleanup();
-                    resolve(false);
-                });
-
-        if (entry.loading) {
-            Promise.resolve().then(doShow);
-        } else {
-            entry.loading = true;
-            ad.load()
-                .then(doShow)
-                .catch(doShow)
-                .finally(() => { if (entry) entry.loading = false; });
-        }
-    });
-}
-
-/** 底层插屏广告包装：实例按 unitId 缓存复用，show 失败 console.warn 不重试（频控/网络等失败重试也救不了） */
-function showInterstitialAd(unitId: string): Promise<boolean> {
-    return new Promise((resolve) => {
-        let ad: any = interstitialCache.get(unitId);
-        if (!ad) {
-            // 老基础库可能没有这个 API（对应官方 if (wx.createInterstitialAd)）
-            if (typeof uni.createInterstitialAd !== "function") {
-                console.warn("[useAd] 当前基础库不支持插屏广告");
-                resolve(false);
-                return;
-            }
-            ad = uni.createInterstitialAd({ adUnitId: unitId });
-            if (!ad) { resolve(false); return; }
-            ad.onError?.((err: AdError) => {
-                console.warn(`[useAd] popup onError (${unitId})`, err);
-            });
-            interstitialCache.set(unitId, ad);
-        }
-        ad.show()
-            .then(() => resolve(true))
-            .catch((err: any) => {
-                console.warn(`[useAd] popup show error (${unitId})`, err);
-                resolve(false);
-            });
-    });
-}
-
-/** 销毁全部广告实例并清空缓存（业务一般不用，hot reload 时调） */
-export function destroyAds(): void {
-    rewardedCache.forEach((e) => e.ad?.destroy?.());
-    rewardedCache.clear();
-    interstitialCache.forEach((ad) => ad?.destroy?.());
-    interstitialCache.clear();
-}

package/src/composables/algo/index.ts

@@ -1,7 +0,0 @@
-/**
- * 算法集：把通用算法包成 useXxx composable，业务侧统一从这里取。
- *
- * 已有：
- *   - useUuid  RFC 4122 v4，32 字符 hex
- */
-export { useUuid } from "./uuid";

package/src/composables/algo/uuid.ts

@@ -1,27 +0,0 @@
-/**
- * UUID v4 生成器（RFC 4122 v4 算法），返回 32 字符 hex（无连字符）。
- *
- * 用途：当 nonce、idempotency key、临时唯一标识用。
- *
- * 算法：
- *   1. 生成 16 字节随机源
- *   2. byte 6 高 4 位置成 0100 标版本号 v4
- *   3. byte 8 高 2 位置成 10 标变体（RFC 4122）
- *   4. 16 字节转 hex 拼成 32 字符串
- *
- * 注意：随机源用 Math.random（小程序兼容兜底），加密强度有限，
- * 不能用于密钥派生 / token 签发，只能挡重放。
- */
-export function useUuid() {
-    function v4(): string {
-        const bytes: number[] = [];
-        for (let i = 0; i < 16; i++) {
-            bytes.push(Math.floor(Math.random() * 256));
-        }
-        bytes[6] = (bytes[6] & 0x0f) | 0x40;
-        bytes[8] = (bytes[8] & 0x3f) | 0x80;
-        return bytes.map((b) => b.toString(16).padStart(2, "0")).join("");
-    }
-
-    return { v4 };
-}

package/src/composables/color/index.ts

@@ -1,44 +0,0 @@
-const HEX_RE = /^#[0-9a-fA-F]{6}$/;
-
-/**
- * 解析 6 位十六进制颜色值，返回 RGB 数组。
- */
-function parseHex(hex: string): [number, number, number] {
-    if (!HEX_RE.test(hex)) throw new Error(`Invalid hex color: ${hex}`);
-    return [
-        parseInt(hex.slice(1, 3), 16),
-        parseInt(hex.slice(3, 5), 16),
-        parseInt(hex.slice(5, 7), 16),
-    ];
-}
-
-/**
- * 颜色处理工具。
- */
-export function useColor() {
-    /**
-     * 将 CSS 变量对象拼接成内联 style 字符串。
-     */
-    function varsToStyle(vars: Record<string, string>): string {
-        return Object.entries(vars).map(([k, v]) => `${k}:${v}`).join(";") + ";";
-    }
-
-    /**
-     * 将十六进制颜色转为 rgba 字符串。
-     */
-    function hexToRgba(hex: string, alpha: number): string {
-        const [r, g, b] = parseHex(hex);
-        return `rgba(${r},${g},${b},${alpha})`;
-    }
-
-    /**
-     * 将十六进制颜色按比例压暗。
-     */
-    function darkenHex(hex: string, amount = 0.15): string {
-        const [r, g, b] = parseHex(hex);
-        const d = (c: number) => Math.max(0, Math.round(c * (1 - amount)));
-        return `#${d(r).toString(16).padStart(2, "0")}${d(g).toString(16).padStart(2, "0")}${d(b).toString(16).padStart(2, "0")}`;
-    }
-
-    return { varsToStyle, hexToRgba, darkenHex };
-}

package/src/composables/contact/index.ts

@@ -1,92 +0,0 @@
-/**
- * useContact —— 客服按钮配置（business-level cache）
- *
- * 后端返回 <button open-type="contact"> 的 4 个微信原生属性，模块级缓存共享给所有客服按钮。
- *
- * 使用方式（业务侧）：
- *
- *   1. App.vue / bootstrap 注入回调：
- *
- *      setConfigContact({
- *          getConfig: async () => {
- *              const res = await getContactConfig();
- *              return res.code === 1 ? res.data : null;
- *          },
- *      });
- *
- *   2. 任意按钮组件：
- *
- *      const contact = useContact();
- *      <hlw-button open-type="contact" v-bind="contact">联系客服</hlw-button>
- */
-import { computed, ref } from "vue";
-import { unwrapPayload, type AdapterPayload } from "../_internal/unwrap";
-
-/** 后端返回的客服配置（按 button open-type=contact 标准属性命名） */
-export interface ContactConfig {
-    send_message_title: string;
-    send_message_path: string;
-    send_message_img: string;
-    show_message_card: boolean;
-}
-
-/**
- * Adapter 注入接口 —— getConfig 支持「已解包」或「ThinkAdmin envelope」两种返回。
- * 业务方可以直接传 envelope-returning 接口：setConfigContact({ getConfig: getContactConfig })
- */
-export interface ContactAdapter {
-    getConfig: () => Promise<AdapterPayload<ContactConfig>>;
-}
-
-/** v-bind 到 button 的 camelCase props（微信原生属性约定） */
-export interface ContactBindProps {
-    sendMessageTitle: string;
-    sendMessagePath: string;
-    sendMessageImg: string;
-    showMessageCard: boolean;
-}
-
-let adapter: ContactAdapter | null = null;
-const config = ref<ContactConfig | null>(null);
-let pending: Promise<void> | null = null;
-
-/**
- * 注入业务回调（应用启动时调用一次；不调用则 useContact 始终返回空字段）。
- */
-export function setConfigContact(a: ContactAdapter): void {
-    adapter = a;
-}
-
-function loadConfig(): Promise<void> {
-    if (config.value) return Promise.resolve();
-    if (pending) return pending;
-    if (!adapter?.getConfig) {
-        console.warn("[useContact] adapter.getConfig 未注入；先调用 setConfigContact()");
-        return Promise.resolve();
-    }
-    pending = adapter.getConfig()
-        .then((raw) => {
-            const cfg = unwrapPayload(raw);
-            if (cfg) config.value = cfg;
-        })
-        .catch((e) => {
-            console.warn("[useContact] load config failed", e);
-        })
-        .finally(() => {
-            pending = null;
-        });
-    return pending;
-}
-
-/**
- * 返回 v-bind 友好的客服配置 computed（首次调用会异步拉一次配置）。
- */
-export function useContact() {
-    void loadConfig();
-    return computed<ContactBindProps>(() => ({
-        sendMessageTitle: config.value?.send_message_title || "",
-        sendMessagePath:  config.value?.send_message_path  || "",
-        sendMessageImg:   config.value?.send_message_img   || "",
-        showMessageCard:  config.value?.show_message_card  ?? false,
-    }));
-}

package/src/composables/format/index.ts

@@ -1,48 +0,0 @@
-/**
- * useFormat — 格式化工具 composable
- */
-export function useFormat() {
-    /**
-     * 按指定模板格式化日期时间。
-     */
-    function date(date: Date | number | string, format = "YYYY-MM-DD HH:mm:ss"): string {
-        const d = new Date(date);
-        if (isNaN(d.getTime())) return "";
-
-        const year = d.getFullYear();
-        const month = String(d.getMonth() + 1).padStart(2, "0");
-        const day = String(d.getDate()).padStart(2, "0");
-        const hours = String(d.getHours()).padStart(2, "0");
-        const minutes = String(d.getMinutes()).padStart(2, "0");
-        const seconds = String(d.getSeconds()).padStart(2, "0");
-
-        return format.replace("YYYY", String(year)).replace("MM", month).replace("DD", day).replace("HH", hours).replace("mm", minutes).replace("ss", seconds);
-    }
-
-    /**
-     * 将字节数格式化为更易读的文件大小。
-     */
-    function fileSize(bytes: number): string {
-        if (bytes === 0) return "0 B";
-        const k = 1024;
-        const sizes = ["B", "KB", "MB", "GB", "TB"];
-        const i = Math.floor(Math.log(bytes) / Math.log(k));
-        return `${parseFloat((bytes / Math.pow(k, i)).toFixed(2))} ${sizes[i]}`;
-    }
-
-    /**
-     * 对手机号中间四位进行脱敏。
-     */
-    function phone(value: string): string {
-        return value.replace(/(\d{3})\d{4}(\d{4})/, "$1****$2");
-    }
-
-    /**
-     * 按指定精度与千分位格式输出金额。
-     */
-    function money(amount: number, decimals = 2, decPoint = ".", thousandsSep = ","): string {
-        return amount.toFixed(decimals).replace(/\B(?=(\d{3})+(?!\d))/g, thousandsSep);
-    }
-
-    return { date, fileSize, phone, money };
-}