scanonweb 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BrainySoft
+
+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/README.md

@@ -0,0 +1,203 @@
+# ScanOnWeb
+
+ScanOnWeb 是一个用于与本地扫描服务程序通信的 JavaScript SDK。它通过 WebSocket 连接与本地扫描托盘程序进行通信，提供完整的扫描功能。
+
+## 特性
+
+- 🔌 WebSocket 通信，支持多端口自动连接
+- 📄 支持多种扫描模式（彩色、黑白、灰度）
+- 🖼️ 支持图像处理（旋转、编辑、删除）
+- 📤 支持多种上传格式（PDF、TIFF、JPG）
+- 🔧 支持双面扫描、自动进纸等高级功能
+- 📱 支持多种模块格式（UMD、ESM、CJS）
+- 🎯 TypeScript 支持
+
+## 安装
+
+```bash
+npm install scanonweb
+```
+
+## 使用方法
+
+### ES6 模块
+
+```javascript
+import ScanOnWeb from 'scanonweb';
+
+const scanner = new ScanOnWeb();
+
+// 设置事件回调
+scanner.onGetDevicesListEvent = (msg) => {
+  console.log('扫描设备列表:', msg);
+};
+
+scanner.onScanFinishedEvent = (msg) => {
+  console.log('扫描完成:', msg);
+};
+
+// 开始扫描
+scanner.startScan();
+```
+
+### CommonJS
+
+```javascript
+const ScanOnWeb = require('scanonweb');
+
+const scanner = new ScanOnWeb();
+// ... 使用方法同上
+```
+
+### 浏览器 UMD
+
+```html
+<script src="node_modules/scanonweb/dist/scanonweb.umd.min.js"></script>
+<script>
+  const scanner = new ScanOnWeb();
+  
+  scanner.onScanFinishedEvent = function(msg) {
+    console.log('扫描完成:', msg);
+  };
+  
+  scanner.startScan();
+</script>
+```
+
+### Vue 3 使用示例
+
+```vue
+<template>
+  <div>
+    <button @click="startScan">开始扫描</button>
+    <button @click="getDevices">获取设备列表</button>
+  </div>
+</template>
+
+<script setup>
+import { onMounted, ref } from 'vue';
+import ScanOnWeb from 'scanonweb';
+
+const scanner = ref(null);
+
+onMounted(() => {
+  scanner.value = new ScanOnWeb();
+  
+  // 设置回调函数
+  scanner.value.onGetDevicesListEvent = (msg) => {
+    console.log('设备列表:', msg);
+  };
+  
+  scanner.value.onScanFinishedEvent = (msg) => {
+    console.log('扫描完成:', msg);
+  };
+});
+
+const startScan = () => {
+  scanner.value?.startScan();
+};
+
+const getDevices = () => {
+  scanner.value?.loadDevices();
+};
+</script>
+```
+
+## API 文档
+
+### 构造函数
+
+```javascript
+const scanner = new ScanOnWeb();
+```
+
+### 配置参数
+
+扫描配置参数可以通过 `scanner.scaner_work_config` 访问和修改：
+
+```javascript
+scanner.scaner_work_config = {
+  showUI: false,           // 是否显示扫描控件工作界面
+  dpi_x: 300,             // DPI 分辨率 X
+  dpi_y: 300,             // DPI 分辨率 Y
+  deviceIndex: 0,         // 选中的扫描仪设备索引
+  showDialog: false,      // 是否显示设备内置对话框
+  autoFeedEnable: true,   // 是否使用自动进纸器
+  autoFeed: false,        // 是否自动装填纸张
+  dupxMode: false,        // 是否使用双面扫描模式
+  autoDeskew: false,      // 是否使用自动纠偏模式
+  autoBorderDetection: false, // 是否使用自动边框检测
+  colorMode: 'RGB',       // 色彩模式: 'RGB', 'BW', 'GRAY'
+  transMode: 'memory'     // 数据传输模式: 'memory', 'file', 'native'
+};
+```
+
+### 主要方法
+
+#### 设备管理
+- `loadDevices()` - 加载所有可用的扫描设备
+- `selectScanDevice(deviceIndex)` - 选择扫描设备
+
+#### 扫描操作
+- `startScan()` - 开始扫描
+- `clearAll()` - 清除全部扫描结果
+
+#### 图像操作
+- `getImageCount()` - 获取图像总数
+- `getAllImage()` - 获取所有图像
+- `getImageById(index)` - 获取指定索引的图像
+- `rotateImage(index, angle)` - 旋转图像
+- `deleteImageByIndex(index)` - 删除指定图像
+
+#### 上传功能
+- `uploadAllImageAsPdfToUrl(url, id, desc)` - 以PDF格式上传所有图像
+- `uploadAllImageAsTiffToUrl(url, id, desc)` - 以TIFF格式上传所有图像
+- `uploadJpgImageByIndex(url, id, desc, index)` - 以JPG格式上传指定图像
+
+### 事件回调
+
+设置事件回调函数来处理扫描过程中的各种事件：
+
+```javascript
+// 获取设备列表回调
+scanner.onGetDevicesListEvent = (msg) => {
+  console.log('设备列表:', msg);
+};
+
+// 扫描完成回调
+scanner.onScanFinishedEvent = (msg) => {
+  console.log('扫描完成，图像数量:', msg.imageCount);
+};
+
+// 选择设备回调
+scanner.onSelectScanDeviceEvent = (msg) => {
+  console.log('设备选择完成:', msg);
+};
+
+// 获取图像回调
+scanner.onGetImageByIdEvent = (msg) => {
+  console.log('获取图像:', msg);
+};
+```
+
+## 系统要求
+
+- 需要安装对应的扫描托盘服务程序
+- 支持的浏览器：Chrome、Firefox、Safari、Edge
+- Node.js >= 14.0.0（用于服务端）
+
+## 许可证
+
+MIT License
+
+## 技术支持
+
+如需更多文档帮助请访问官网：https://www.brainysoft.cn
+
+## 更新日志
+
+### 1.0.1
+- 初始版本发布
+- 支持基本扫描功能
+- 支持多种输出格式
+- 添加 TypeScript 支持

package/dist/index.d.ts

@@ -0,0 +1,266 @@
+/**
+ * ScanOnWeb - 扫描控件 JavaScript SDK
+ * TypeScript 定义文件
+ */
+
+/**
+ * 扫描配置参数接口
+ */
+export interface ScanConfig {
+  /** 是否显示扫描控件工作界面 */
+  showUI: boolean;
+  /** DPI 分辨率 X */
+  dpi_x: number;
+  /** DPI 分辨率 Y */
+  dpi_y: number;
+  /** 选中的扫描仪硬件设备id索引 */
+  deviceIndex: number;
+  /** 是否显示设备内置对话框 */
+  showDialog: boolean;
+  /** 是否使用自动进纸器 */
+  autoFeedEnable: boolean;
+  /** 是否自动装填纸张 */
+  autoFeed: boolean;
+  /** 是否使用双面扫描模式 */
+  dupxMode: boolean;
+  /** 是否使用自动纠偏模式 */
+  autoDeskew: boolean;
+  /** 是否使用自动边框检测 */
+  autoBorderDetection: boolean;
+  /** 色彩模式 */
+  colorMode: 'RGB' | 'BW' | 'GRAY';
+  /** 数据传输模式 */
+  transMode: 'memory' | 'file' | 'native';
+}
+
+/**
+ * WebSocket 消息接口
+ */
+export interface WebSocketMessage {
+  /** 命令类型 */
+  cmd_type: string;
+  /** 图像数量 */
+  imageCount?: number;
+  /** 当前设备索引 */
+  currentIndex?: number;
+  /** 其他属性 */
+  [key: string]: any;
+}
+
+/**
+ * 扫描控件类
+ */
+export default class ScanOnWeb {
+  /** 扫描配置参数 */
+  scaner_work_config: ScanConfig;
+  
+  /** WebSocket 连接对象 */
+  h5socket: WebSocket | null;
+  
+  /** 扫描结果图像总数 */
+  imageCount: number;
+
+  // 事件回调函数（可选）
+  onGetDevicesListEvent?: (msg: WebSocketMessage) => void;
+  onScanFinishedEvent?: (msg: WebSocketMessage) => void;
+  onSelectScanDeviceEvent?: (msg: WebSocketMessage) => void;
+  onGetImageCountEvent?: (msg: WebSocketMessage) => void;
+  onGetAllImageEvent?: (msg: WebSocketMessage) => void;
+  onGetImageByIdEvent?: (msg: WebSocketMessage) => void;
+  onLoadImageFromUrlEvent?: (msg: WebSocketMessage) => void;
+  onRotateImageEvent?: (msg: WebSocketMessage) => void;
+  onGetImageSizeEvent?: (msg: WebSocketMessage) => void;
+  onUploadAllImageAsPdfToUrlEvent?: (msg: WebSocketMessage) => void;
+  onUploadAllImageAsTiffToUrlEvent?: (msg: WebSocketMessage) => void;
+  onUploadJpgImageByIndexEvent?: (msg: WebSocketMessage) => void;
+  onUploadEvent?: (msg: WebSocketMessage) => void;
+  onImageEditedEvent?: (msg: WebSocketMessage) => void;
+  onImageDrapEvent?: (msg: WebSocketMessage) => void;
+
+  /**
+   * 构造函数
+   */
+  constructor();
+
+  /**
+   * 通过连接多个websocket server端口返回一个可用的websocket连接对象
+   * @param wssUrls WebSocket服务器URL数组
+   * @returns WebSocket连接Promise
+   */
+  getConnectedServer(wssUrls: string[]): Promise<WebSocket>;
+
+  /**
+   * 尝试检测websocket哪个端口可以成功连接
+   */
+  tryConnect(): void;
+
+  /**
+   * 初始化websocket相关的函数绑定
+   * @param server WebSocket服务器实例
+   */
+  initWebsocketCallback(server: WebSocket): void;
+
+  /**
+   * WebSocket错误处理
+   * @param event 错误事件
+   */
+  onSocketError(event: Event): void;
+
+  /**
+   * 判断回调函数是否存在
+   * @param f 要检查的函数
+   * @returns 函数是否存在且为函数类型
+   */
+  isCallbackExist(f: any): f is Function;
+
+  /**
+   * WebSocket消息处理
+   * @param event WebSocket消息事件
+   */
+  onSocketMessage(event: MessageEvent): void;
+
+  /**
+   * 通过websocket发送数据给webscoket服务端
+   * @param commandData 要发送的命令数据
+   */
+  sendWebSocketCommand(commandData: object): void;
+
+  /**
+   * 设置授权信息
+   * @param licenseMode 授权模式
+   * @param key1 授权密钥1
+   * @param key2 授权密钥2
+   * @param licenseServerUrl 授权服务器URL
+   */
+  setLicenseKey(licenseMode: string, key1: string, key2: string, licenseServerUrl: string): void;
+
+  /**
+   * 加载所有可用的扫描设备
+   */
+  loadDevices(): void;
+
+  /**
+   * 设置当前选中的扫描设备id
+   * @param deviceIndex 设备索引
+   */
+  selectScanDevice(deviceIndex: number): void;
+
+  /**
+   * 开始扫描
+   */
+  startScan(): void;
+
+  /**
+   * 清除全部扫描结果
+   */
+  clearAll(): void;
+
+  /**
+   * 获取图像总数
+   */
+  getImageCount(): void;
+
+  /**
+   * 获取所有图像
+   */
+  getAllImage(): void;
+
+  /**
+   * 发送指令获取某一页图像到托盘服务
+   * @param index 图像索引
+   */
+  getImageById(index: number): void;
+
+  /**
+   * 发送指令远程加载服务器端的多页图像到托盘服务
+   * @param url 图像URL
+   */
+  loadImageFromUrl(url: string): void;
+
+  /**
+   * 发送指令旋转某一页图像到托盘服务
+   * @param index 图像索引
+   * @param angle 旋转角度
+   */
+  rotateImage(index: number, angle: number): void;
+
+  /**
+   * 发送指令获取某一页图像的宽度到托盘服务
+   * @param index 图像索引
+   */
+  getImageSize(index: number): void;
+
+  /**
+   * 发送指令删除某一页图像到托盘服务
+   * @param index 图像索引
+   */
+  deleteImageByIndex(index: number): void;
+
+  /**
+   * 以pdf格式上传全部图像到服务器端
+   * @param url 上传URL
+   * @param id 标识ID
+   * @param desc 描述信息
+   */
+  uploadAllImageAsPdfToUrl(url: string, id: string, desc: string): void;
+
+  /**
+   * 以tiff格式上传全部图像到服务器端
+   * @param url 上传URL
+   * @param id 标识ID
+   * @param desc 描述信息
+   */
+  uploadAllImageAsTiffToUrl(url: string, id: string, desc: string): void;
+
+  /**
+   * 以jpg格式上传某一页图像到服务器端
+   * @param url 上传URL
+   * @param id 标识ID
+   * @param desc 描述信息
+   * @param index 图像索引
+   */
+  uploadJpgImageByIndex(url: string, id: string, desc: string, index: number): void;
+
+  /**
+   * 全部图像保存到客户端本地文件
+   * @param filename 文件名
+   */
+  saveAllImageToLocal(filename: string): void;
+
+  /**
+   * 从客户端本地读取图像,通过打开文件对话框选择图像文件
+   */
+  openClientLocalfile(): void;
+
+  /**
+   * ftp上传全部图像文件到服务器端
+   * @param serverIp 服务器IP
+   * @param port 端口
+   * @param username 用户名
+   * @param password 密码
+   * @param serverPath 服务器路径
+   * @param filename 文件名
+   */
+  ftpUploadAllImage(serverIp: string, port: number, username: string, password: string, serverPath: string, filename: string): void;
+
+  /**
+   * 设置上传按钮是否可见
+   * @param visible 是否可见
+   */
+  setUploadButtonVisible(visible: boolean): void;
+
+  /**
+   * 设置焦点
+   */
+  setFocus(): void;
+
+  /**
+   * 隐藏窗口
+   */
+  hidden(): void;
+
+  /**
+   * 关闭websocket连接
+   */
+  closeWebSocket(): void;
+}