vite-uni-dev-tool 1.0.0 → 1.1.0

package/dist/v3/hooks/useScanCode/index.ts

@@ -1,206 +1,206 @@
-import { onHide, onShow, onUnload } from '@dcloudio/uni-app';
-import { ref, watch } from 'vue';
-import type { Ref } from 'vue';
-
-/**
- * android PDA
- *
- * h5 扫码枪
- *
- * @export
- * @param {(code: string) => void} callback
- * @param {{
- *     disabled?: Ref<boolean>;
- *     broadcastAction?: string;
- *     broadcastStringDataLabel?: string;
- *     scanDelay?: number;
- *     onScanEnd: (code: string) => void;
- *   }} [options]
- */
-export default function useScanCode(
-  callback: (code: string) => void,
-  options?: {
-    /** 禁用扫描 */
-    disabled?: Ref<boolean>;
-    /** 广播动作 */
-    broadcastAction?: string;
-    /** 广播标签 */
-    broadcastStringDataLabel?: string;
-    /**
-     * 扫描延迟 单位 ms
-     * 默认 150
-     */
-    scanDelay?: number;
-    /**
-     * 扫描结束
-     * @param {string} code
-     */
-    onScanEnd?: (code: string) => void;
-  },
-) {
-  let main: any;
-  const show = ref(true);
-
-  let lastTime: number | null = null;
-  let nextTime: number | null = null;
-  let lastCode: string | null = null;
-  let nextCode: string | null = null;
-
-  let code = '';
-
-  let _codeQueryTag = false;
-
-  let receiver: PlusAndroidInstanceObject;
-
-  let filter: {
-    addAction: (arg0: string) => void;
-  };
-
-  // #ifdef APP-PLUS
-
-  function startScan() {
-    main.registerReceiver(receiver, filter);
-  }
-
-  function stopScan() {
-    main.unregisterReceiver(receiver);
-  }
-
-  function queryCode(code: string) {
-    if (_codeQueryTag) return false;
-
-    _codeQueryTag = true;
-
-    setTimeout(function () {
-      _codeQueryTag = false;
-    }, options?.scanDelay || 150);
-
-    if (show.value) {
-      callback?.(code);
-      options?.onScanEnd?.(code);
-      // 单独使用该 hooks 时，删除收集
-      // @ts-ignore
-      uni?.__dev_tool_scan_code_collection__?.(code, 'broadcast');
-    }
-  }
-
-  function initScan() {
-    if (!options?.broadcastAction || !options.broadcastStringDataLabel) {
-      throw new Error(
-        'PAD 扫描必须传入 broadcastAction, broadcastStringDataLabel',
-      );
-    }
-
-    main = plus.android.runtimeMainActivity(); //获取activity
-
-    const IntentFilter: any = plus.android.importClass(
-      'android.content.IntentFilter',
-    );
-
-    filter = new IntentFilter();
-
-    filter.addAction(options?.broadcastAction); // 换你的广播动作
-
-    receiver = plus.android.implements(
-      'io.dcloud.feature.internal.reflect.BroadcastReceiver',
-      {
-        onReceive: function (_context: any, intent: any) {
-          plus.android.importClass(intent);
-          const code = intent.getStringExtra(options?.broadcastStringDataLabel); // 换你的广播标签
-          queryCode(code);
-        },
-      },
-    );
-  }
-
-  onShow(() => {
-    initScan();
-    startScan();
-    show.value = !options?.disabled?.value;
-  });
-  onHide(() => {
-    show.value = false;
-    stopScan();
-  });
-  onUnload(() => {
-    show.value = false;
-    stopScan();
-  });
-
-  watch(
-    () => [options?.disabled?.value],
-    () => {
-      show.value = !options?.disabled?.value;
-    },
-  );
-
-  // #endif
-
-  // #ifdef H5
-
-  function queryCodeH5(e: KeyboardEvent) {
-    if (_codeQueryTag) return;
-
-    if (e.key === 'Enter') {
-      e.preventDefault();
-    }
-    if (e.key === 'CapsLock') {
-      e.preventDefault();
-    }
-    nextCode = e.key;
-
-    nextTime = Date.now();
-
-    if (lastCode !== null && lastTime !== null && nextTime - lastTime <= 40) {
-      code += lastCode;
-    } else if (
-      lastCode !== null &&
-      lastTime !== null &&
-      nextTime - lastTime > 100
-    ) {
-      code = '';
-    }
-    lastCode = nextCode;
-    lastTime = nextTime;
-
-    if (e.key === 'Enter' && code.length > 0) {
-      _codeQueryTag = true;
-      setTimeout(function () {
-        _codeQueryTag = false;
-      }, options?.scanDelay || 150);
-      callback?.(code);
-      options?.onScanEnd?.(code);
-      // 单独使用该 hooks 时，删除收集
-      // @ts-ignore
-      uni?.__dev_tool_scan_code_collection__?.(code, 'keypress');
-      code = '';
-    }
-  }
-
-  onShow(() => {
-    show.value = true;
-  });
-  onHide(() => {
-    window.removeEventListener('keypress', queryCodeH5);
-  });
-  onUnload(() => {
-    window.removeEventListener('keypress', queryCodeH5);
-  });
-
-  watch(
-    () => [options?.disabled?.value, show.value],
-    () => {
-      if (!options?.disabled?.value && show.value) {
-        window.removeEventListener('keypress', queryCodeH5);
-        window.addEventListener('keypress', queryCodeH5);
-      } else {
-        window.removeEventListener('keypress', queryCodeH5);
-      }
-    },
-    {
-      immediate: true,
-    },
-  );
-
-  // #endif
-}
+import { onHide, onShow, onUnload } from '@dcloudio/uni-app';
+import { ref, watch } from 'vue';
+import type { Ref } from 'vue';
+
+/**
+ * android PDA
+ *
+ * h5 扫码枪
+ *
+ * @export
+ * @param {(code: string) => void} callback
+ * @param {{
+ *     disabled?: Ref<boolean>;
+ *     broadcastAction?: string;
+ *     broadcastStringDataLabel?: string;
+ *     scanDelay?: number;
+ *     onScanEnd: (code: string) => void;
+ *   }} [options]
+ */
+export default function useScanCode(
+  callback: (code: string) => void,
+  options?: {
+    /** 禁用扫描 */
+    disabled?: Ref<boolean>;
+    /** 广播动作 */
+    broadcastAction?: string;
+    /** 广播标签 */
+    broadcastStringDataLabel?: string;
+    /**
+     * 扫描延迟 单位 ms
+     * 默认 150
+     */
+    scanDelay?: number;
+    /**
+     * 扫描结束
+     * @param {string} code
+     */
+    onScanEnd?: (code: string) => void;
+  },
+) {
+  let main: any;
+  const show = ref(true);
+
+  let lastTime: number | null = null;
+  let nextTime: number | null = null;
+  let lastCode: string | null = null;
+  let nextCode: string | null = null;
+
+  let code = '';
+
+  let _codeQueryTag = false;
+
+  let receiver: PlusAndroidInstanceObject;
+
+  let filter: {
+    addAction: (arg0: string) => void;
+  };
+
+  // #ifdef APP-PLUS
+
+  function startScan() {
+    main.registerReceiver(receiver, filter);
+  }
+
+  function stopScan() {
+    main.unregisterReceiver(receiver);
+  }
+
+  function queryCode(code: string) {
+    if (_codeQueryTag) return false;
+
+    _codeQueryTag = true;
+
+    setTimeout(function () {
+      _codeQueryTag = false;
+    }, options?.scanDelay || 150);
+
+    if (show.value) {
+      callback?.(code);
+      options?.onScanEnd?.(code);
+      // 单独使用该 hooks 时，删除收集
+      // @ts-ignore
+      uni?.__dev_tool_scan_code_collection__?.(code, 'broadcast');
+    }
+  }
+
+  function initScan() {
+    if (!options?.broadcastAction || !options.broadcastStringDataLabel) {
+      throw new Error(
+        'PAD 扫描必须传入 broadcastAction, broadcastStringDataLabel',
+      );
+    }
+
+    main = plus.android.runtimeMainActivity(); //获取activity
+
+    const IntentFilter: any = plus.android.importClass(
+      'android.content.IntentFilter',
+    );
+
+    filter = new IntentFilter();
+
+    filter.addAction(options?.broadcastAction); // 换你的广播动作
+
+    receiver = plus.android.implements(
+      'io.dcloud.feature.internal.reflect.BroadcastReceiver',
+      {
+        onReceive: function (_context: any, intent: any) {
+          plus.android.importClass(intent);
+          const code = intent.getStringExtra(options?.broadcastStringDataLabel); // 换你的广播标签
+          queryCode(code);
+        },
+      },
+    );
+  }
+
+  onShow(() => {
+    initScan();
+    startScan();
+    show.value = !options?.disabled?.value;
+  });
+  onHide(() => {
+    show.value = false;
+    stopScan();
+  });
+  onUnload(() => {
+    show.value = false;
+    stopScan();
+  });
+
+  watch(
+    () => [options?.disabled?.value],
+    () => {
+      show.value = !options?.disabled?.value;
+    },
+  );
+
+  // #endif
+
+  // #ifdef H5
+
+  function queryCodeH5(e: KeyboardEvent) {
+    if (_codeQueryTag) return;
+
+    if (e.key === 'Enter') {
+      e.preventDefault();
+    }
+    if (e.key === 'CapsLock') {
+      e.preventDefault();
+    }
+    nextCode = e.key;
+
+    nextTime = Date.now();
+
+    if (lastCode !== null && lastTime !== null && nextTime - lastTime <= 40) {
+      code += lastCode;
+    } else if (
+      lastCode !== null &&
+      lastTime !== null &&
+      nextTime - lastTime > 100
+    ) {
+      code = '';
+    }
+    lastCode = nextCode;
+    lastTime = nextTime;
+
+    if (e.key === 'Enter' && code.length > 0) {
+      _codeQueryTag = true;
+      setTimeout(function () {
+        _codeQueryTag = false;
+      }, options?.scanDelay || 150);
+      callback?.(code);
+      options?.onScanEnd?.(code);
+      // 单独使用该 hooks 时，删除收集
+      // @ts-ignore
+      uni?.__dev_tool_scan_code_collection__?.(code, 'keypress');
+      code = '';
+    }
+  }
+
+  onShow(() => {
+    show.value = true;
+  });
+  onHide(() => {
+    window.removeEventListener('keypress', queryCodeH5);
+  });
+  onUnload(() => {
+    window.removeEventListener('keypress', queryCodeH5);
+  });
+
+  watch(
+    () => [options?.disabled?.value, show.value],
+    () => {
+      if (!options?.disabled?.value && show.value) {
+        window.removeEventListener('keypress', queryCodeH5);
+        window.addEventListener('keypress', queryCodeH5);
+      } else {
+        window.removeEventListener('keypress', queryCodeH5);
+      }
+    },
+    {
+      immediate: true,
+    },
+  );
+
+  // #endif
+}

package/dist/v3/hooks/useWebsocket/README.md

@@ -0,0 +1,79 @@
+# useWebsocket
+
+一个用于在 uni-app 中处理 WebSocket 的 Vue 3 Hook，设计模式参考了 [ahooks useWebSocket](https://ahooks.js.org/zh-CN/hooks/use-web-socket)。
+
+## 作用
+
+- **简化连接管理**：封装了 `uni.connectSocket`，自动管理 `SocketTask` 任务的创建与清理。
+- **响应式状态**：通过 Vue 3 的 `ref` 提供连接状态 (`readyState`) 和最新消息 (`latestMessage`)。
+- **自动重连**：内置重连逻辑，当连接因非人为原因（如网络抖动）断开时，支持配置重连次数和间隔。
+- **心跳机制**：支持配置自动心跳包发送，保持长连接活跃，防止被服务器超时剔除。
+- **生命周期集成**：在组件卸载 (`onUnmounted`) 时自动关闭连接，避免内存泄漏和异常监听。
+- **手动控制**：既支持初始自动连接，也支持手动调用 `connect()` 或 `disconnect()`。
+
+## 参数
+
+```typescript
+const { ... } = useWebsocket(url, options);
+```
+
+### Options
+
+| 参数              | 说明              | 类型                    | 默认值   |
+| ----------------- | ----------------- | ----------------------- | -------- |
+| reconnectLimit    | 重连次数限制      | `number`                | `3`      |
+| reconnectInterval | 重连时间间隔 (ms) | `number`                | `3000`   |
+| heartbeat         | 是否开启心跳检查  | `boolean`               | `false`  |
+| heartbeatInterval | 心跳检查间隔 (ms) | `number`                | `30000`  |
+| heartbeatMessage  | 心跳发送的内容    | `string \| ArrayBuffer` | `'ping'` |
+| manual            | 是否手动控制连接  | `boolean`               | `false`  |
+| protocols         | WebSocket 子协议  | `string[]`              | -        |
+| onOpen            | 连接开启的回调    | `(task, res) => void`   | -        |
+| onClose           | 连接关闭的回调    | `(res) => void`         | -        |
+| onMessage         | 收到消息的回调    | `(res) => void`         | -        |
+| onError           | 连接错误的回调    | `(res) => void`         | -        |
+
+## 返回值
+
+| 属性          | 说明                   | 类型                                    |
+| ------------- | ---------------------- | --------------------------------------- |
+| latestMessage | 最近收到的一条消息内容 | `Ref<OnSocketMessageCallbackResult>`    |
+| readyState    | 当前连接状态           | `Ref<ReadyState>`                       |
+| connect       | 手动连接方法           | `() => void`                            |
+| disconnect    | 手动断开方法           | `() => void`                            |
+| sendMessage   | 发送消息方法           | `(data: string \| ArrayBuffer) => void` |
+
+## 状态定义 (ReadyState)
+
+- `0`: `Connecting` (连接中)
+- `1`: `Open` (已连接)
+- `2`: `Closing` (关闭中)
+- `3`: `Closed` (已关闭)
+
+## 使用示例
+
+```typescript
+import useWebsocket, { ReadyState } from '../hooks/useWebsocket';
+
+const { readyState, latestMessage, sendMessage, connect, disconnect } =
+  useWebsocket('wss://echo.websocket.org', {
+    reconnectLimit: 5,
+    heartbeat: true, // 开启心跳
+    heartbeatInterval: 30000,
+    heartbeatMessage: JSON.stringify({ type: 'ping' }),
+    onOpen: () => {
+      console.log('连接已开启');
+    },
+    onMessage: (res) => {
+      console.log('收到消息:', res.data);
+    },
+  });
+
+// 计算属性：判断是否在线
+const isOnline = computed(() => readyState.value === ReadyState.Open);
+
+// 发送数据
+const send = () => {
+  sendMessage('Hello Antigravity!');
+};
+```