scanonweb 1.0.2 → 2.0.0

package/dist/scanonweb.umd.min.js

@@ -1,9 +1,9 @@
 /*!
- * scanonweb v1.0.2
- * ScanOnWeb - 扫描控件 JavaScript SDK，用于与本地扫描服务程序通信
+ * scanonweb v2.0.0
+ * ScanOnWeb - 扫描控件 JavaScript SDK，支持 v2 协议、scanSource 和增量图像事件
  * https://www.brainysoft.cn
  * 
- * Copyright (c) 2025 BrainySoft
+ * Copyright (c) 2026 BrainySoft
  * Licensed under the MIT license
  */
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).ScanOnWeb=t()}(this,(function(){"use strict";class e{constructor(){this.scaner_work_config={showUI:!1,dpi_x:300,dpi_y:300,deviceIndex:0,showDialog:!1,autoFeedEnable:!0,autoFeed:!1,dupxMode:!1,autoDeskew:!1,autoBorderDetection:!1,colorMode:"RGB",transMode:"memory"},this.h5socket=null,this.imageCount=0,this.tryConnect()}getConnectedServer(e){return console.log("尝试连接托盘扫描服务websocket服务器..."),new Promise(((t,o)=>{const a=new WebSocket(e[0]);a.onopen=()=>{t(a)},a.onerror=e=>{o(e)}})).then((e=>(console.log("连接websocket服务器成功!"),this.initWebsocketCallback(e),console.log("尝试获取扫描设备列表..."),this.loadDevices(),e)),(t=>{if(e.length>1)return this.getConnectedServer(e.slice(1));throw t}))}tryConnect(){this.getConnectedServer(["ws://127.0.0.1:1001","ws://127.0.0.1:2001","ws://127.0.0.1:3001","ws://127.0.0.1:4001","ws://127.0.0.1:5001"])}initWebsocketCallback(e){this.h5socket=e,this.h5socket.onerror=this.onSocketError.bind(this),this.h5socket.onmessage=this.onSocketMessage.bind(this)}onSocketError(e){alert("无法连接扫描服务程序,请检查扫描服务程序是否已经启动！"),console.log("WebSocket error: "+e.data)}isCallbackExist(e){return!(!e||void 0===e||void 0===e)&&"function"==typeof e}onSocketMessage(e){const t=JSON.parse(e.data);switch(t.cmd_type){case"getDevicesList":this.isCallbackExist(this.onGetDevicesListEvent)&&this.onGetDevicesListEvent(t);break;case"scanComplete":this.imageCount=t.imageCount,this.isCallbackExist(this.onScanFinishedEvent)&&this.onScanFinishedEvent(t);break;case"selectScanDevice":this.scaner_work_config.deviceIndex=t.currentIndex,this.scaner_work_config.showDialog=t.showDialog,this.scaner_work_config.autoFeedEnable=t.autoFeedEnable,this.scaner_work_config.autoFeed=t.autoFeed,this.scaner_work_config.dupxMode=t.dupxMode,this.scaner_work_config.autoDeskew=t.autoDeskew,this.scaner_work_config.autoBorderDetection=t.autoBorderDetection,this.isCallbackExist(this.onSelectScanDeviceEvent)&&this.onSelectScanDeviceEvent(t);break;case"getImageCount":this.imageCount=t.imageCount,this.isCallbackExist(this.onGetImageCountEvent)&&this.onGetImageCountEvent(t);break;case"getAllImage":this.imageCount=t.imageCount,this.isCallbackExist(this.onGetAllImageEvent)&&this.onGetAllImageEvent(t);break;case"getImageById":this.imageCount=t.imageCount,this.isCallbackExist(this.onGetImageByIdEvent)&&this.onGetImageByIdEvent(t);break;case"loadImageFromUrl":this.imageCount=t.imageCount,this.isCallbackExist(this.onLoadImageFromUrlEvent)&&this.onLoadImageFromUrlEvent(t);break;case"loadImageFromBase64":this.imageCount=t.imageCount,this.isCallbackExist(this.onLoadImageFromBase64Event)&&this.onLoadImageFromBase64Event(t);break;case"rotateImage":this.imageCount=t.imageCount,this.isCallbackExist(this.onRotateImageEvent)&&this.onRotateImageEvent(t);break;case"getImageSize":this.imageCount=t.imageCount,this.isCallbackExist(this.onGetImageSizeEvent)&&this.onGetImageSizeEvent(t);break;case"uploadAllImageAsPdfToUrl":this.isCallbackExist(this.onUploadAllImageAsPdfToUrlEvent)&&this.onUploadAllImageAsPdfToUrlEvent(t);break;case"uploadAllImageAsTiffToUrl":this.isCallbackExist(this.onUploadAllImageAsTiffToUrlEvent)&&this.onUploadAllImageAsTiffToUrlEvent(t);break;case"uploadJpgImageByIndex":this.isCallbackExist(this.onUploadJpgImageByIndexEvent)&&this.onUploadJpgImageByIndexEvent(t);break;case"upload":this.imageCount=t.imageCount,this.isCallbackExist(this.onUploadEvent)&&this.onUploadEvent(t);break;case"imageEdited":this.isCallbackExist(this.onImageEditedEvent)&&this.onImageEditedEvent(t);break;case"imageDrap":this.isCallbackExist(this.onImageDrapEvent)&&this.onImageDrapEvent(t)}}sendWebSocketCommand(e){try{1===this.h5socket.readyState?this.h5socket.send(JSON.stringify(e)):alert("发送扫描指令失败！请刷新页面或者检查托盘扫描程序是否已经正常运行!")}catch(e){alert("发送扫描指令失败！"+e)}}setLicenseKey(e,t,o,a){const s={cmd_type:"setLicenseKey",licenseMode:e,key1:t,key2:o,url:a};this.sendWebSocketCommand(s)}loadDevices(){this.sendWebSocketCommand({cmd_type:"getDevicesList"})}selectScanDevice(e){const t={cmd_type:"selectScanDevice",deviceIndex:e};this.sendWebSocketCommand(t)}startScan(){const e={cmd_type:"startScan",config:this.scaner_work_config};this.sendWebSocketCommand(e)}clearAll(){this.sendWebSocketCommand({cmd_type:"clearAll"})}getImageCount(){this.sendWebSocketCommand({cmd_type:"getImageCount"})}getAllImage(){this.sendWebSocketCommand({cmd_type:"getAllImage"})}getImageById(e){const t={cmd_type:"getImageById",index:e};this.sendWebSocketCommand(t)}loadImageFromUrl(e,t){if(!t){const o=e.split(".").pop().toLowerCase();t="pdf"===o?"pdf":"tiff"===o||"tif"===o?"tiff":(["jpg","jpeg","png","bmp","gif","webp"].includes(o),"image")}const o={cmd_type:"loadImageFromUrl",url:e,type:t};this.sendWebSocketCommand(o)}loadImageFromBase64(e,t="jpg"){if(e.startsWith("data:")){const o=e.indexOf("base64,");if(-1!==o){const a=e.match(/data:image\/(\w+);/);a&&a[1]&&!t&&(t="jpeg"===a[1]?"jpg":a[1]),e=e.substring(o+7)}}const o={cmd_type:"loadImageFromBase64",base64Data:e,format:t};this.sendWebSocketCommand(o)}rotateImage(e,t){const o={cmd_type:"rotateImage",index:e,angle:t};this.sendWebSocketCommand(o)}getImageSize(e){const t={cmd_type:"getImageSize",index:e};this.sendWebSocketCommand(t)}deleteImageByIndex(e){const t={cmd_type:"deleteImageByIndex",index:e};this.sendWebSocketCommand(t)}uploadAllImageAsPdfToUrl(e,t,o){const a={cmd_type:"uploadAllImageAsPdfToUrl",url:e,id:t,desc:o};this.sendWebSocketCommand(a)}uploadAllImageAsTiffToUrl(e,t,o){const a={cmd_type:"uploadAllImageAsTiffToUrl",url:e,id:t,desc:o};this.sendWebSocketCommand(a)}uploadJpgImageByIndex(e,t,o,a){const s={cmd_type:"uploadJpgImageByIndex",index:a,url:e,id:t,desc:o};this.sendWebSocketCommand(s)}saveAllImageToLocal(e){const t={cmd_type:"saveAllImageToLocal",filename:e};this.sendWebSocketCommand(t)}openClientLocalfile(){this.sendWebSocketCommand({cmd_type:"openClientLocalfile"})}ftpUploadAllImage(e,t,o,a,s,n){const i={cmd_type:"ftpUploadAllImage",serverIp:e,port:t,username:o,password:a,serverPath:s,filename:n};this.sendWebSocketCommand(i)}setUploadButtonVisible(e){const t={cmd_type:"setUploadButtonVisible",visible:e};this.sendWebSocketCommand(t)}setFocus(){this.sendWebSocketCommand({cmd_type:"focus"})}hidden(){this.sendWebSocketCommand({cmd_type:"hidden"})}closeWebSocket(){this.h5socket.close()}loadMultipleImagesFromBase64(e){Array.isArray(e)&&0!==e.length?e.forEach(((e,t)=>{setTimeout((()=>{this.loadImageFromBase64(e.data,e.format||"jpg")}),100*t)})):console.error("loadMultipleImagesFromBase64: 参数必须是非空数组")}loadImageFromCanvas(e,t="jpg",o=.9){if(!(e&&e instanceof HTMLCanvasElement))return void console.error("loadImageFromCanvas: 参数必须是有效的Canvas元素");const a="jpg"===t?"image/jpeg":`image/${t}`,s=e.toDataURL(a,o).split(",")[1];this.loadImageFromBase64(s,t)}loadImageFromFileInput(e){if(!e||!e.files||0===e.files.length)return void console.error("loadImageFromFileInput: 没有选择文件");Array.from(e.files).forEach(((e,t)=>{if(!e.type.startsWith("image/"))return void console.warn(`跳过非图像文件: ${e.name}`);const o=new FileReader;o.onload=o=>{const a=o.target.result,s=e.name.split(".").pop().toLowerCase(),n="jpeg"===s?"jpg":s;setTimeout((()=>{this.loadImageFromBase64(a,n)}),100*t)},o.readAsDataURL(e)}))}}return"undefined"!=typeof module&&module.exports&&(module.exports=e),"undefined"!=typeof window&&(window.ScanOnWeb=e),e}));
+!function(e,o){"object"==typeof exports&&"undefined"!=typeof module?module.exports=o():"function"==typeof define&&define.amd?define(o):(e="undefined"!=typeof globalThis?globalThis:e||self).ScanOnWeb=o()}(this,(function(){"use strict";class e{constructor(){this.protocolVersion=2,this.serverProtocolVersion=null,this.imageCount=0,this.scaner_work_config={showUI:!1,dpi_x:300,dpi_y:300,deviceIndex:0,showDialog:!1,scanSource:"flatbed",autoFeed:!1,dupxMode:!1,autoDeskew:!1,autoBorderDetection:!1,colorMode:"RGB",transMode:"memory"},this.h5socket=null,this.tryConnect()}getConnectedServer(e){return console.log("尝试连接托盘扫描服务websocket服务器..."),new Promise(((o,t)=>{const a=new WebSocket(e[0]);a.onopen=()=>{o(a)},a.onerror=e=>{t(e)}})).then((e=>(console.log("连接websocket服务器成功!"),this.initWebsocketCallback(e),console.log("尝试获取扫描设备列表..."),this.loadDevices(),e)),(o=>{if(e.length>1)return this.getConnectedServer(e.slice(1));throw o}))}tryConnect(){this.getConnectedServer(["ws://127.0.0.1:1001","ws://127.0.0.1:2001","ws://127.0.0.1:3001","ws://127.0.0.1:4001","ws://127.0.0.1:5001"])}initWebsocketCallback(e){this.h5socket=e,this.h5socket.onerror=this.onSocketError.bind(this),this.h5socket.onmessage=this.onSocketMessage.bind(this)}onSocketError(e){alert("无法连接扫描服务程序,请检查扫描服务程序是否已经启动！"),console.log("WebSocket error: "+e.data)}isCallbackExist(e){return!(!e||void 0===e||void 0===e)&&"function"==typeof e}dispatchCallback(e,o){this.isCallbackExist(this[e])&&this[e](o)}toBoolCompat(e){if("boolean"==typeof e)return e;if("number"==typeof e)return 0!==e;if("string"==typeof e){const o=e.trim().toLowerCase();return["1","true","yes","y","on","adf"].includes(o)}return!!e}toIntCompat(e,o){const t=Number(e);return Number.isInteger(t)?t:o}normalizeScanSource(e,o){if("string"==typeof e){const o=e.trim().toLowerCase();if("adf"===o||"feeder"===o||"documentfeeder"===o||"document_feeder"===o||"automatic_document_feeder"===o)return"adf";if("flatbed"===o||"flat_bed"===o||"platen"===o)return"flatbed"}return this.toBoolCompat(o)?"adf":"flatbed"}getLegacyAutoFeedEnable(e){return"adf"===this.normalizeScanSource(e)}shouldIncludeLegacyAutoFeedEnable(){return null===this.serverProtocolVersion||this.serverProtocolVersion<2}normalizeScanConfig(e,o){const t=Object.assign({},this.scaner_work_config,e||{}),a=!o||!1!==o.includeLegacyAutoFeedEnable,s={showUI:this.toBoolCompat(t.showUI),dpi_x:this.toIntCompat(t.dpi_x,300),dpi_y:this.toIntCompat(t.dpi_y,300),deviceIndex:this.toIntCompat(t.deviceIndex,0),showDialog:this.toBoolCompat(t.showDialog),scanSource:this.normalizeScanSource(t.scanSource,t.autoFeedEnable),autoFeed:this.toBoolCompat(t.autoFeed),dupxMode:this.toBoolCompat(t.dupxMode),autoDeskew:this.toBoolCompat(t.autoDeskew),autoBorderDetection:this.toBoolCompat(t.autoBorderDetection),colorMode:t.colorMode||"RGB",transMode:t.transMode||"memory"};return a&&(s.autoFeedEnable=this.getLegacyAutoFeedEnable(s.scanSource)),s}recordServerProtocolVersion(e){const o=this.toIntCompat(e&&e.protocolVersion,1);return this.serverProtocolVersion=o,o}applyIncomingScanConfig(e){this.scaner_work_config.deviceIndex=this.toIntCompat(e.currentIndex,this.scaner_work_config.deviceIndex),Object.prototype.hasOwnProperty.call(e,"showDialog")&&(this.scaner_work_config.showDialog=this.toBoolCompat(e.showDialog)),this.scaner_work_config.scanSource=this.normalizeScanSource(e.scanSource,e.autoFeedEnable),Object.prototype.hasOwnProperty.call(e,"autoFeed")&&(this.scaner_work_config.autoFeed=this.toBoolCompat(e.autoFeed)),Object.prototype.hasOwnProperty.call(e,"dupxMode")&&(this.scaner_work_config.dupxMode=this.toBoolCompat(e.dupxMode)),Object.prototype.hasOwnProperty.call(e,"autoDeskew")&&(this.scaner_work_config.autoDeskew=this.toBoolCompat(e.autoDeskew)),Object.prototype.hasOwnProperty.call(e,"autoBorderDetection")&&(this.scaner_work_config.autoBorderDetection=this.toBoolCompat(e.autoBorderDetection)),"string"==typeof e.colorMode&&e.colorMode&&(this.scaner_work_config.colorMode=e.colorMode),"string"==typeof e.transMode&&e.transMode&&(this.scaner_work_config.transMode=e.transMode),this.scaner_work_config.autoFeedEnable=this.getLegacyAutoFeedEnable(this.scaner_work_config.scanSource)}normalizeIncomingMessage(e){const o=Object.assign({},e||{}),t=this.recordServerProtocolVersion(o),a="string"==typeof o.cmd_type?o.cmd_type:"";switch(o.scanSource||(o.scanSource=this.normalizeScanSource(o.scanSource,o.autoFeedEnable)),a){case"getAllImage":o.cmd_type="imageListSnapshot";break;case"getImageById":o.cmd_type="imageSnapshot";break;case"imageDrap":o.cmd_type="imageMoved"}return o.protocolVersion||(o.protocolVersion=t),o}onSocketMessage(e){const o=JSON.parse(e.data),t=this.normalizeIncomingMessage(o);switch("number"==typeof t.imageCount&&(this.imageCount=t.imageCount),t.cmd_type){case"getDevicesList":this.dispatchCallback("onGetDevicesListEvent",t);break;case"scanComplete":this.dispatchCallback("onScanFinishedEvent",t);break;case"selectScanDevice":this.applyIncomingScanConfig(t),this.dispatchCallback("onSelectScanDeviceEvent",t);break;case"getImageCount":this.dispatchCallback("onGetImageCountEvent",t);break;case"imageListSnapshot":this.dispatchCallback("onImageListSnapshotEvent",t),this.dispatchCallback("onGetAllImageEvent",t);break;case"imageSnapshot":this.dispatchCallback("onImageSnapshotEvent",t),this.dispatchCallback("onGetImageByIdEvent",t);break;case"scanPageAdded":this.dispatchCallback("onScanPageAddedEvent",t);break;case"loadImageFromUrl":this.dispatchCallback("onLoadImageFromUrlEvent",t);break;case"loadImageFromBase64":this.dispatchCallback("onLoadImageFromBase64Event",t);break;case"rotateImage":this.dispatchCallback("onRotateImageEvent",t);break;case"getImageSize":this.dispatchCallback("onGetImageSizeEvent",t);break;case"uploadAllImageAsPdfToUrl":this.dispatchCallback("onUploadAllImageAsPdfToUrlEvent",t);break;case"uploadAllImageAsTiffToUrl":this.dispatchCallback("onUploadAllImageAsTiffToUrlEvent",t);break;case"uploadJpgImageByIndex":this.dispatchCallback("onUploadJpgImageByIndexEvent",t);break;case"upload":this.dispatchCallback("onUploadEvent",t);break;case"imageEdited":this.dispatchCallback("onImageEditedEvent",t);break;case"imageMoved":this.dispatchCallback("onImageMovedEvent",t),this.dispatchCallback("onImageDrapEvent",t);break;case"imageDeleted":this.dispatchCallback("onImageDeletedEvent",t);break;case"imagesCleared":this.dispatchCallback("onImagesClearedEvent",t)}}normalizeOutgoingCommand(e){const o=Object.assign({},e||{});return o.protocolVersion=this.protocolVersion,"startScan"===o.cmd_type&&(o.config=this.normalizeScanConfig(o.config||this.scaner_work_config,{includeLegacyAutoFeedEnable:this.shouldIncludeLegacyAutoFeedEnable()})),o}sendWebSocketCommand(e){try{this.h5socket&&1===this.h5socket.readyState?this.h5socket.send(JSON.stringify(this.normalizeOutgoingCommand(e))):alert("发送扫描指令失败！请刷新页面或者检查托盘扫描程序是否已经正常运行!")}catch(e){alert("发送扫描指令失败！"+e)}}setLicenseKey(e,o,t,a){this.sendWebSocketCommand({cmd_type:"setLicenseKey",licenseMode:e,key1:o,key2:t,url:a})}loadDevices(){this.sendWebSocketCommand({cmd_type:"getDevicesList"})}selectScanDevice(e){this.sendWebSocketCommand({cmd_type:"selectScanDevice",deviceIndex:e})}startScan(){this.sendWebSocketCommand({cmd_type:"startScan",config:this.scaner_work_config})}clearAll(){this.sendWebSocketCommand({cmd_type:"clearAll"})}getImageCount(){this.sendWebSocketCommand({cmd_type:"getImageCount"})}getAllImage(){this.sendWebSocketCommand({cmd_type:"getAllImage"})}getImageById(e){const o={cmd_type:"getImageById"};"string"==typeof e&&e.trim()?o.imageId=e.trim():o.index=e,this.sendWebSocketCommand(o)}loadImageFromUrl(e,o){if(!o){const t=e.split(".").pop().toLowerCase();o="pdf"===t?"pdf":"tiff"===t||"tif"===t?"tiff":(["jpg","jpeg","png","bmp","gif","webp"].includes(t),"image")}this.sendWebSocketCommand({cmd_type:"loadImageFromUrl",url:e,type:o})}loadImageFromBase64(e,o){let t=o||"jpg",a=e;if(a.startsWith("data:")){const e=a.indexOf("base64,");if(-1!==e){if(!o){const e=a.match(/data:image\/(\w+);/);e&&e[1]&&(t="jpeg"===e[1]?"jpg":e[1])}a=a.substring(e+7)}}this.sendWebSocketCommand({cmd_type:"loadImageFromBase64",base64Data:a,format:t})}rotateImage(e,o){this.sendWebSocketCommand({cmd_type:"rotateImage",index:e,angle:o})}getImageSize(e){this.sendWebSocketCommand({cmd_type:"getImageSize",index:e})}deleteImageByIndex(e,o){const t={cmd_type:"deleteImageByIndex",index:e};"string"==typeof o&&o.trim()&&(t.imageId=o.trim()),this.sendWebSocketCommand(t)}moveImage(e,o){this.sendWebSocketCommand({cmd_type:"moveImage",oldIndex:e,newIndex:o})}uploadAllImageAsPdfToUrl(e,o,t){this.sendWebSocketCommand({cmd_type:"uploadAllImageAsPdfToUrl",url:e,id:o,desc:t})}uploadAllImageAsTiffToUrl(e,o,t){this.sendWebSocketCommand({cmd_type:"uploadAllImageAsTiffToUrl",url:e,id:o,desc:t})}uploadJpgImageByIndex(e,o,t,a){this.sendWebSocketCommand({cmd_type:"uploadJpgImageByIndex",index:a,url:e,id:o,desc:t})}saveAllImageToLocal(e){this.sendWebSocketCommand({cmd_type:"saveAllImageToLocal",filename:e})}openClientLocalfile(){this.sendWebSocketCommand({cmd_type:"openClientLocalfile"})}ftpUploadAllImage(e,o,t,a,s,n){this.sendWebSocketCommand({cmd_type:"ftpUploadAllImage",serverIp:e,port:o,username:t,password:a,serverPath:s,filename:n})}setUploadButtonVisible(e){this.sendWebSocketCommand({cmd_type:"setUploadButtonVisible",visible:e})}setFocus(){this.sendWebSocketCommand({cmd_type:"focus"})}hidden(){this.sendWebSocketCommand({cmd_type:"hidden"})}closeWebSocket(){this.h5socket.close()}loadMultipleImagesFromBase64(e){Array.isArray(e)&&0!==e.length?e.forEach(((e,o)=>{setTimeout((()=>{this.loadImageFromBase64(e.data,e.format||"jpg")}),100*o)})):console.error("loadMultipleImagesFromBase64: 参数必须是非空数组")}loadImageFromCanvas(e,o,t){const a=o||"jpg",s="number"==typeof t?t:.9;if(!(e&&e instanceof HTMLCanvasElement))return void console.error("loadImageFromCanvas: 参数必须是有效的Canvas元素");const n="jpg"===a?"image/jpeg":"image/"+a,i=e.toDataURL(n,s).split(",")[1];this.loadImageFromBase64(i,a)}loadImageFromFileInput(e){if(!e||!e.files||0===e.files.length)return void console.error("loadImageFromFileInput: 没有选择文件");Array.from(e.files).forEach(((e,o)=>{if(!e.type.startsWith("image/"))return void console.warn("跳过非图像文件: "+e.name);const t=new FileReader;t.onload=t=>{const a=t.target.result,s=e.name.split(".").pop().toLowerCase(),n="jpeg"===s?"jpg":s;setTimeout((()=>{this.loadImageFromBase64(a,n)}),100*o)},t.readAsDataURL(e)}))}}return"undefined"!=typeof module&&module.exports&&(module.exports=e),"undefined"!=typeof window&&(window.ScanOnWeb=e),e}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "scanonweb",
-  "version": "1.0.2",
-  "description": "ScanOnWeb - 扫描控件 JavaScript SDK，用于与本地扫描服务程序通信",
+  "version": "2.0.0",
+  "description": "ScanOnWeb - 扫描控件 JavaScript SDK，支持 v2 协议、scanSource 和增量图像事件",
   "main": "dist/scanonweb.cjs.js",
   "module": "dist/scanonweb.esm.js",
   "browser": "dist/scanonweb.umd.js",
@@ -13,7 +13,8 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "rollup -c",
+    "build": "npm run clean && rollup -c && npm run copy:types",
+    "copy:types": "node scripts/copy-types.js",
     "dev": "rollup -c -w",
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepublishOnly": "npm run build",

package/src/index.d.ts

@@ -1,73 +1,96 @@
-/**
- * ScanOnWeb - 扫描控件 JavaScript SDK
- * TypeScript 定义文件
- */
+export type ScanSource = "flatbed" | "adf";
+export type ColorMode = "RGB" | "BW" | "GRAY";
+export type TransferMode = "memory" | "file" | "native";
 
-/**
- * 扫描配置参数接口
- */
 export interface ScanConfig {
-  /** 是否显示扫描控件工作界面 */
   showUI: boolean;
-  /** DPI 分辨率 X */
   dpi_x: number;
-  /** DPI 分辨率 Y */
   dpi_y: number;
-  /** 选中的扫描仪硬件设备id索引 */
   deviceIndex: number;
-  /** 是否显示设备内置对话框 */
   showDialog: boolean;
-  /** 是否使用自动进纸器 */
-  autoFeedEnable: boolean;
-  /** 是否自动装填纸张 */
+  scanSource: ScanSource;
   autoFeed: boolean;
-  /** 是否使用双面扫描模式 */
   dupxMode: boolean;
-  /** 是否使用自动纠偏模式 */
   autoDeskew: boolean;
-  /** 是否使用自动边框检测 */
   autoBorderDetection: boolean;
-  /** 色彩模式 */
-  colorMode: 'RGB' | 'BW' | 'GRAY';
-  /** 数据传输模式 */
-  transMode: 'memory' | 'file' | 'native';
+  colorMode: ColorMode;
+  transMode: TransferMode;
+  /** Legacy compatibility only. Prefer `scanSource`. */
+  autoFeedEnable?: boolean;
+}
+
+export interface ImageInfo {
+  index: number;
+  imageId?: string;
+  width?: number;
+  height?: number;
+  imageBase64?: string;
+  [key: string]: any;
 }
 
-/**
- * WebSocket 消息接口
- */
 export interface WebSocketMessage {
-  /** 命令类型 */
   cmd_type: string;
-  /** 图像数量 */
+  protocolVersion?: number;
+  ok?: boolean;
+  success?: boolean;
   imageCount?: number;
-  /** 当前设备索引 */
   currentIndex?: number;
-  /** 其他属性 */
+  currentSelected?: number;
+  selectedImageId?: string | null;
+  imageId?: string;
+  imageIndex?: number;
+  index?: number;
+  oldIndex?: number;
+  newIndex?: number;
+  beforeIndex?: number;
+  afterIndex?: number;
+  beforeImageCount?: number;
+  afterImageCount?: number;
+  scanSource?: ScanSource;
+  autoFeedEnable?: boolean;
+  autoFeed?: boolean;
+  dupxMode?: boolean;
+  autoDeskew?: boolean;
+  autoBorderDetection?: boolean;
+  colorMode?: ColorMode | string;
+  transMode?: TransferMode | string;
+  scanJobId?: string;
+  source?: string;
+  loadedCount?: number;
+  imageAfterCount?: number;
+  images?: string[];
+  imageInfos?: ImageInfo[];
+  imageBase64?: string;
+  devices?: any[];
   [key: string]: any;
 }
 
-/**
- * 扫描控件类
- */
+export interface Base64ImagePayload {
+  data: string;
+  format?: string;
+}
+
 export default class ScanOnWeb {
-  /** 扫描配置参数 */
-  scaner_work_config: ScanConfig;
-  
-  /** WebSocket 连接对象 */
+  protocolVersion: number;
+  serverProtocolVersion: number | null;
+  scaner_work_config: ScanConfig & {
+    /** Legacy compatibility only. Prefer `scanSource`. */
+    autoFeedEnable?: boolean;
+  };
   h5socket: WebSocket | null;
-  
-  /** 扫描结果图像总数 */
   imageCount: number;
 
-  // 事件回调函数（可选）
   onGetDevicesListEvent?: (msg: WebSocketMessage) => void;
   onScanFinishedEvent?: (msg: WebSocketMessage) => void;
   onSelectScanDeviceEvent?: (msg: WebSocketMessage) => void;
   onGetImageCountEvent?: (msg: WebSocketMessage) => void;
+  onImageListSnapshotEvent?: (msg: WebSocketMessage) => void;
+  onImageSnapshotEvent?: (msg: WebSocketMessage) => void;
+  onScanPageAddedEvent?: (msg: WebSocketMessage) => void;
   onGetAllImageEvent?: (msg: WebSocketMessage) => void;
   onGetImageByIdEvent?: (msg: WebSocketMessage) => void;
   onLoadImageFromUrlEvent?: (msg: WebSocketMessage) => void;
+  onLoadImageFromBase64Event?: (msg: WebSocketMessage) => void;
   onRotateImageEvent?: (msg: WebSocketMessage) => void;
   onGetImageSizeEvent?: (msg: WebSocketMessage) => void;
   onUploadAllImageAsPdfToUrlEvent?: (msg: WebSocketMessage) => void;
@@ -75,192 +98,83 @@ export default class ScanOnWeb {
   onUploadJpgImageByIndexEvent?: (msg: WebSocketMessage) => void;
   onUploadEvent?: (msg: WebSocketMessage) => void;
   onImageEditedEvent?: (msg: WebSocketMessage) => void;
+  onImageMovedEvent?: (msg: WebSocketMessage) => void;
   onImageDrapEvent?: (msg: WebSocketMessage) => void;
+  onImageDeletedEvent?: (msg: WebSocketMessage) => void;
+  onImagesClearedEvent?: (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消息事件
-   */
+  dispatchCallback(name: string, msg: WebSocketMessage): void;
+  toBoolCompat(value: any): boolean;
+  toIntCompat(value: any, fallback: number): number;
+  normalizeScanSource(
+    scanSource?: string | null,
+    legacyAutoFeedEnable?: any
+  ): ScanSource;
+  getLegacyAutoFeedEnable(scanSource?: string | null): boolean;
+  shouldIncludeLegacyAutoFeedEnable(): boolean;
+  normalizeScanConfig(
+    config?: Partial<ScanConfig> & { autoFeedEnable?: boolean },
+    options?: { includeLegacyAutoFeedEnable?: boolean }
+  ): ScanConfig & { autoFeedEnable?: boolean };
+  recordServerProtocolVersion(msg: WebSocketMessage): number;
+  applyIncomingScanConfig(msg: WebSocketMessage): void;
+  normalizeIncomingMessage(rawMsg: WebSocketMessage): WebSocketMessage;
   onSocketMessage(event: MessageEvent): void;
-
-  /**
-   * 通过websocket发送数据给webscoket服务端
-   * @param commandData 要发送的命令数据
-   */
+  normalizeOutgoingCommand(commandData: Record<string, any>): Record<string, any>;
   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;
-
-  /**
-   * 加载所有可用的扫描设备
-   */
+  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 旋转角度
-   */
+  getImageById(indexOrImageId: number | string): void;
+  loadImageFromUrl(url: string, type?: string): void;
+  loadImageFromBase64(base64Data: string, format?: string): void;
   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 描述信息
-   */
+  deleteImageByIndex(index: number, imageId?: string): void;
+  moveImage(oldIndex: number, newIndex: number): void;
   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 文件名
-   */
+  uploadJpgImageByIndex(
+    url: string,
+    id: string,
+    desc: string,
+    index: number
+  ): void;
   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 是否可见
-   */
+  ftpUploadAllImage(
+    serverIp: string,
+    port: number,
+    username: string,
+    password: string,
+    serverPath: string,
+    filename: string
+  ): void;
   setUploadButtonVisible(visible: boolean): void;
-
-  /**
-   * 设置焦点
-   */
   setFocus(): void;
-
-  /**
-   * 隐藏窗口
-   */
   hidden(): void;
-
-  /**
-   * 关闭websocket连接
-   */
   closeWebSocket(): void;
+  loadMultipleImagesFromBase64(base64Images: Base64ImagePayload[]): void;
+  loadImageFromCanvas(
+    canvas: HTMLCanvasElement,
+    format?: string,
+    quality?: number
+  ): void;
+  loadImageFromFileInput(fileInput: HTMLInputElement): void;
 }