@hlw-uni/mp-vue 2.1.52 → 2.1.55

package/src/composables/utils/index.ts

@@ -2,160 +2,183 @@
  * 小程序通用工具。
  */
 
-export interface DownloadFileOptions {
-    /** 下载地址 */
+export interface DownloadOpt {
     url: string;
-    /** 文件保存路径，可选 */
-    filePath?: string;
-    /** HTTP 请求头，可选 */
+    path?: string;
     header?: Record<string, string>;
-    /** 下载进度回调，可选 */
-    onProgress?: (progress: number, totalBytesWritten: number, totalBytesExpectedToWrite: number) => void;
+    progress?: (value: number, done: number, total: number) => void;
 }
 
-export interface DownloadFileResult {
-    /** 是否成功 */
-    success: boolean;
-    /** 临时文件路径 */
-    tempFilePath?: string;
-    /** 状态码 */
-    statusCode?: number;
-    /** 错误信息 */
-    errMsg?: string;
+export interface DownloadRes {
+    ok: boolean;
+    path?: string;
+    code?: number;
+    msg?: string;
 }
 
-export type TapEvent = {
-    currentTarget?: { dataset?: Record<string, any> };
-    target?: { dataset?: Record<string, any> };
-};
+function withQuery(url: string, qs: string) {
+    if (!qs) return url;
+    return `${url}${url.includes("?") ? "&" : "?"}${qs}`;
+}
 
-/**
- * 剪贴板、下载与相册保存工具集合。
- */
-export function useUtils() {
-    /**
-     * 复制文本到剪贴板，可选显示成功提示。
-     * 也可直接作为 tap 事件处理函数，从 data-copy 读取文本。
-     */
-    function copy(data: string | TapEvent, showToast = true): Promise<boolean> {
-        if (typeof data !== "string") {
-            const dataset = data?.currentTarget?.dataset || data?.target?.dataset;
-            const text = dataset?.copy;
-            if (text == null || text === "") return Promise.resolve(false);
-            return copy(String(text), dataset?.copyToast !== "false");
-        }
+function toQuery(data: Record<string, unknown>) {
+    return Object.entries(data)
+        .filter(([, val]) => val !== undefined && val !== null)
+        .map(([key, val]) => `${encodeURIComponent(key)}=${encodeURIComponent(String(val))}`)
+        .join("&");
+}
+
+function signText(url: string) {
+    const [path, qs] = url.split("?");
+    return qs ? `${qs.split("&").filter(Boolean).sort().join("&")}&` : `${path}&`;
+}
+
+function toNumber(val: unknown, def: number): number {
+    const next = Number(val);
+    return Number.isFinite(next) ? next : def;
+}
+
+function toBoolean(val: unknown, def: boolean): boolean {
+    if (typeof val === "boolean") return val;
+    if (val === 0 || val === "0") return false;
+    if (val === 1 || val === "1") return true;
+    return def;
+}
 
-        return new Promise((resolve) => {
+export function useUtils() {
+    function copy(text: string, tip = true): Promise<boolean> {
+        return new Promise((ok) => {
             uni.setClipboardData({
-                data,
+                data: text,
                 showToast: false,
                 success: () => {
-                    if (showToast) {
+                    if (tip) {
                         uni.showToast({ title: "复制成功", icon: "none", duration: 1500 });
                     }
-                    resolve(true);
+                    ok(true);
                 },
-                fail: () => resolve(false),
+                fail: () => ok(false),
             });
         });
     }
 
-    /**
-     * 从事件 dataset 的 data-copy 字段读取文本并复制。
-     */
-    function copyFromEvent(event: TapEvent) {
-        return copy(event);
-    }
-
-    /**
-     * 读取当前剪贴板文本内容。
-     */
     function paste(): Promise<string> {
-        return new Promise((resolve) => {
+        return new Promise((ok) => {
             uni.getClipboardData({
-                success: (res) => resolve(res.data),
-                fail: () => resolve(""),
+                success: (res) => ok(res.data),
+                fail: () => ok(""),
             });
         });
     }
 
-    /**
-     * 将本地图片保存到系统相册。
-     */
-    function saveImage(filePath: string): Promise<boolean> {
-        return new Promise((resolve) => {
+    function auth() {
+        uni.showModal({
+            title: "提示",
+            content: "需要授权相册权限",
+            confirmText: "去设置",
+            success: (res) => {
+                if (res.confirm) uni.openSetting();
+            },
+        });
+    }
+
+    function saveImage(path: string): Promise<boolean> {
+        return new Promise((ok) => {
             uni.saveImageToPhotosAlbum({
-                filePath,
+                filePath: path,
                 success: () => {
                     uni.showToast({ title: "保存成功", icon: "success" });
-                    resolve(true);
+                    ok(true);
                 },
                 fail: (err) => {
-                    if (err.errMsg.includes("auth deny") || err.errMsg.includes("authorize")) {
-                        uni.showModal({
-                            title: "提示",
-                            content: "需要授权相册权限",
-                            confirmText: "去设置",
-                            success: (res) => {
-                                if (res.confirm) uni.openSetting();
-                            },
-                        });
+                    const msg = String(err.errMsg || "");
+                    if (msg.includes("auth deny") || msg.includes("authorize")) {
+                        auth();
                     } else {
                         uni.showToast({ title: "保存失败", icon: "none" });
                     }
-                    resolve(false);
+                    ok(false);
                 },
             });
         });
     }
 
-    /**
-     * 下载文件并返回下载结果。
-     */
-    function downloadFile(options: DownloadFileOptions): Promise<DownloadFileResult> {
-        return new Promise((resolve) => {
+    function saveVideo(path: string): Promise<boolean> {
+        return new Promise((ok) => {
+            uni.saveVideoToPhotosAlbum({
+                filePath: path,
+                success: () => {
+                    uni.showToast({ title: "保存成功", icon: "success" });
+                    ok(true);
+                },
+                fail: (err) => {
+                    const msg = String(err.errMsg || "");
+                    if (msg.includes("auth deny") || msg.includes("authorize")) {
+                        auth();
+                    } else {
+                        uni.showToast({ title: "保存失败", icon: "none" });
+                    }
+                    ok(false);
+                },
+            });
+        });
+    }
+
+    function download(opt: DownloadOpt): Promise<DownloadRes> {
+        return new Promise((ok) => {
             const task = uni.downloadFile({
-                url: options.url,
-                filePath: options.filePath,
-                header: options.header,
+                url: opt.url,
+                filePath: opt.path,
+                header: opt.header,
                 success: (res) => {
                     if (res.statusCode === 200) {
-                        resolve({ success: true, tempFilePath: res.tempFilePath, statusCode: res.statusCode });
+                        ok({ ok: true, path: res.tempFilePath, code: res.statusCode });
                     } else {
-                        resolve({ success: false, statusCode: res.statusCode, errMsg: `下载失败，状态码：${res.statusCode}` });
+                        ok({ ok: false, code: res.statusCode, msg: `下载失败，状态码：${res.statusCode}` });
                     }
                 },
-                fail: (err) => resolve({ success: false, errMsg: err.errMsg }),
+                fail: (err) => ok({ ok: false, msg: err.errMsg }),
             });
 
-            if (options.onProgress) {
+            if (opt.progress) {
                 task.onProgressUpdate((res) => {
-                    options.onProgress!(res.progress, res.totalBytesWritten, res.totalBytesExpectedToWrite);
+                    opt.progress!(res.progress, res.totalBytesWritten, res.totalBytesExpectedToWrite);
                 });
             }
         });
     }
 
-    /**
-     * 下载远程图片并直接保存到相册。
-     */
-    async function downloadAndSaveImage(url: string, onProgress?: (progress: number) => void): Promise<boolean> {
+    async function saveImageUrl(url: string, progress?: (value: number) => void): Promise<boolean> {
         try {
             uni.showLoading({ title: "下载中...", mask: true });
+            const res = await download({ url, progress: progress ? (value) => progress(value) : undefined });
+            uni.hideLoading();
 
-            const result = await downloadFile({
-                url,
-                onProgress: onProgress ? (progress) => onProgress(progress) : undefined,
-            });
+            if (!res.ok || !res.path) {
+                uni.showToast({ title: res.msg || "下载失败", icon: "none" });
+                return false;
+            }
+
+            return await saveImage(res.path);
+        } catch {
+            uni.hideLoading();
+            uni.showToast({ title: "操作失败", icon: "none" });
+            return false;
+        }
+    }
 
+    async function saveVideoUrl(url: string, progress?: (value: number) => void): Promise<boolean> {
+        try {
+            uni.showLoading({ title: "下载中...", mask: true });
+            const res = await download({ url, progress: progress ? (value) => progress(value) : undefined });
             uni.hideLoading();
 
-            if (!result.success || !result.tempFilePath) {
-                uni.showToast({ title: result.errMsg || "下载失败", icon: "none" });
+            if (!res.ok || !res.path) {
+                uni.showToast({ title: res.msg || "下载失败", icon: "none" });
                 return false;
             }
 
-            return await saveImage(result.tempFilePath);
+            return await saveVideo(res.path);
         } catch {
             uni.hideLoading();
             uni.showToast({ title: "操作失败", icon: "none" });
@@ -163,5 +186,18 @@ export function useUtils() {
         }
     }
 
-    return { copy, copyFromEvent, paste, saveImage, downloadFile, downloadAndSaveImage };
+    return {
+        withQuery,
+        toQuery,
+        signText,
+        toNumber,
+        toBoolean,
+        copy,
+        paste,
+        saveImage,
+        saveVideo,
+        download,
+        saveImageUrl,
+        saveVideoUrl,
+    };
 }

package/src/hlw.ts

@@ -1,37 +1,29 @@
 /**
  * hlw - 全局命名空间工厂
- * 提供 $msg、$device、$http、$utils、$color 的统一访问入口。
- *
- * 注意：广告能力请直接 `import { useAd } from "@hlw-uni/mp-vue"`，不再通过 hlw.$ad 暴露。
+ * 提供 $msg、$device、$request、$utils 的统一访问入口。
  */
 import { useMsg } from '@/composables/msg';
 import { useDevice, type DeviceInfo } from '@/composables/device';
-import { http } from '@/composables/http';
+import { useRequest } from '@/composables/request';
 import { useUtils } from '@/composables/utils';
-import { useColor } from '@/composables/color';
 
 export interface HlwInstance {
   $msg: ReturnType<typeof useMsg>;
   $device: DeviceInfo;
-  $http: typeof http;
+  $request: ReturnType<typeof useRequest>;
   $utils: ReturnType<typeof useUtils>;
-  $color: ReturnType<typeof useColor>;
 }
 
 let _msg: ReturnType<typeof useMsg> | null = null;
-let _device: ReturnType<typeof useDevice> | null = null;
 let _utils: ReturnType<typeof useUtils> | null = null;
-let _color: ReturnType<typeof useColor> | null = null;
 
 export const hlw: HlwInstance = {
   /** 延迟创建消息提示实例。 */
   get $msg() { return (_msg ??= useMsg()); },
   /** 延迟读取并缓存设备信息。 */
-  get $device() { return (_device ??= useDevice()).value!; },
-  /** 复用全局 HTTP 实例。 */
-  $http: http,
+  get $device() { return useDevice().info; },
+  /** 复用全局请求实例。 */
+  $request: useRequest(),
   /** 延迟创建通用工具实例。 */
   get $utils() { return (_utils ??= useUtils()); },
-  /** 延迟创建颜色工具实例。 */
-  get $color() { return (_color ??= useColor()); },
 };

package/src/index.ts

@@ -3,14 +3,13 @@
  *
  * 2.0 起合并了原 @hlw-uni/mp-core 全部内容。
  * 业务方一处 import，无需再分包：
- *   import { useAd, useMsg, useColor, useThemePageStyle, ... } from "@hlw-uni/mp-vue";
+ *   import { useMsg, useThemePageStyle, ... } from "@hlw-uni/mp-vue";
  *
  * UI 组件（hlw-page / hlw-button / hlw-ad 等）走 easycom 自动注册，不在这里 export。
  */
 
 // Composables / 工具 / Theme
 export * from "./composables";
-export { getErrorMessage } from "./error";
 
 // 类型
 export type { HlwMenuItem } from "./components/hlw-menu/types";
@@ -20,7 +19,7 @@ export type { HlwPagingRef, HlwPagingInstance } from "./components/hlw-paging/ty
 export { useThemeStore } from "./stores/theme";
 
 // App 根上下文
-export { useApp, setupInterceptors } from "./app";
+export { useApp } from "./app";
 
 // hlw 全局命名空间
 export { hlw, type HlwInstance } from "./hlw";

package/dist/composables/_internal/unwrap.d.ts

@@ -1,15 +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 declare function unwrapPayload<T>(raw: AdapterPayload<T>): T | null;

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

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

package/dist/composables/algo/uuid.d.ts

@@ -1,17 +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 declare function useUuid(): {
-    v4: () => string;
-};

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

@@ -1,8 +0,0 @@
-/**
- * 颜色处理工具。
- */
-export declare function useColor(): {
-    varsToStyle: (vars: Record<string, string>) => string;
-    hexToRgba: (hex: string, alpha: number) => string;
-    darkenHex: (hex: string, amount?: number) => string;
-};

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

@@ -1,32 +0,0 @@
-import { AdapterPayload } from '../_internal/unwrap';
-import { ComputedRef } from 'vue';
-
-/** 后端返回的客服配置（按 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;
-}
-/**
- * 注入业务回调（应用启动时调用一次；不调用则 useContact 始终返回空字段）。
- */
-export declare function setConfigContact(a: ContactAdapter): void;
-/**
- * 返回 v-bind 友好的客服配置 computed（首次调用会异步拉一次配置）。
- */
-export declare function useContact(): ComputedRef<ContactBindProps>;

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

@@ -1,9 +0,0 @@
-/**
- * useFormat — 格式化工具 composable
- */
-export declare function useFormat(): {
-    date: (date: Date | number | string, format?: string) => string;
-    fileSize: (bytes: number) => string;
-    phone: (value: string) => string;
-    money: (amount: number, decimals?: number, decPoint?: string, thousandsSep?: string) => string;
-};

package/dist/composables/http/client.d.ts

@@ -1,66 +0,0 @@
-import { ref } from 'vue';
-import { ApiResponse, RequestConfig, RequestInterceptor, ResponseInterceptor, ErrorInterceptor, UploadConfig, UploadResult } from './types';
-
-/** 组件内请求返回的状态对象。 */
-export interface UseRequestReturn<T = unknown> {
-    loading: ReturnType<typeof ref<boolean>>;
-    data: ReturnType<typeof ref<T | null>>;
-    error: ReturnType<typeof ref<Error | null>>;
-    run: (config: RequestConfig) => Promise<ApiResponse<T>>;
-    get: (url: string, data?: unknown) => Promise<ApiResponse<T>>;
-    post: (url: string, data?: unknown) => Promise<ApiResponse<T>>;
-    put: (url: string, data?: unknown) => Promise<ApiResponse<T>>;
-    del: (url: string, data?: unknown) => Promise<ApiResponse<T>>;
-}
-export declare class HttpClient {
-    private _reqInterceptors;
-    private _resInterceptors;
-    private _errInterceptors;
-    private _baseURL;
-    private _defaultHeaders;
-    private _noCache;
-    /**
-     * 创建 HttpClient 实例并初始化默认配置。
-     */
-    constructor(options?: {
-        baseURL?: string;
-        headers?: Record<string, string>;
-        noCache?: boolean;
-    });
-    /** 运行时设置 baseURL。 */
-    setBaseURL(url: string): void;
-    /** 注册请求拦截器，并返回注销函数。 */
-    onRequest(fn: RequestInterceptor): () => void;
-    /** 注册响应拦截器，并返回注销函数。 */
-    onResponse<T = unknown>(fn: ResponseInterceptor<T>): () => void;
-    /** 注册错误拦截器，并返回注销函数。 */
-    onError(fn: ErrorInterceptor): () => void;
-    /**
-     * 执行一次全局请求，自动串联请求与响应拦截器。
-     */
-    request<T = unknown>(config: RequestConfig): Promise<ApiResponse<T>>;
-    /**
-     * 创建组件内可复用的请求状态对象。
-     */
-    useRequest<T = unknown>(): UseRequestReturn<T>;
-    /**
-     * 根据上传类型选择适配器并执行文件上传。
-     */
-    upload(config: UploadConfig): Promise<UploadResult>;
-    /**
-     * 拼接 baseURL，并在开启防缓存时追加时间戳参数。
-     */
-    private _buildUrl;
-    /**
-     * 调用 uni.request 发起底层网络请求。
-     */
-    private _doRequest;
-    /**
-     * 顺序执行已注册的错误拦截器。
-     */
-    private _applyErrorInterceptors;
-}
-/**
- * 全局 HTTP 实例。
- */
-export declare const http: HttpClient;

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

@@ -1,8 +0,0 @@
-/**
- * HTTP 模块统一导出
- */
-export { http, HttpClient } from './client';
-export { useRequest, useUpload } from './useRequest';
-export type { ApiResponse, PageResult, RequestConfig, RequestInterceptor, ResponseInterceptor, ErrorInterceptor, UploadConfig, UploadResult } from './types';
-export type { UseRequestReturn } from './client';
-export * from './adapters';

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

@@ -1,7 +0,0 @@
-/**
- * useLoading - 全局 Loading 状态
- */
-export declare function useLoading(): {
-    showLoading: (message?: string) => void;
-    hideLoading: () => void;
-};

package/dist/composables/page-meta/index.d.ts

@@ -1,18 +0,0 @@
-/**
- * usePageMeta - 页面元信息 composable
- */
-export interface PageMeta {
-    title?: string;
-    navigationBarTitleText?: string;
-    navigationBarBackgroundColor?: string;
-    navigationBarTextStyle?: "white" | "black";
-    backgroundColor?: string;
-    enablePullDownRefresh?: boolean;
-}
-/**
- * 页面导航栏与背景元信息工具。
- */
-export declare function usePageMeta(): {
-    setTitle: (title: string) => void;
-    setOptions: (options: PageMeta) => void;
-};

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

@@ -1,16 +0,0 @@
-/// <reference types="@dcloudio/types" />
-/// <reference types="@dcloudio/types" />
-/**
- * useStorage - 本地存储 composable
- */
-export interface StorageInstance {
-    get: <T = unknown>(key: string) => T | null;
-    set: <T>(key: string, value: T) => boolean;
-    remove: (key: string) => boolean;
-    clear: () => boolean;
-    info: () => UniApp.GetStorageInfoSuccess | null;
-}
-/**
- * 本地存储读写工具。
- */
-export declare function useStorage(): StorageInstance;

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/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 };
-}