Add new methods

Author: yushulx

README.md

@@ -42,7 +42,7 @@ By default, the REST API's host address is set to `http://127.0.0.1:18622`.
 
 ## Node.js API
 - `getDevices(host, scannerType)` - Get all available scanners. It returns an array of scanner objects.
-- `scanDocument(host, parameters, timeout)` - Create a scanner job by feeding one or multiple physical documents. It returns the job id.
+- `createJob(host, parameters)` - Create a scanner job by feeding one or multiple physical documents. It returns the job id.
 - `getImageFile(host, jobId, directory)` - Get one document image by job id. The directory specifies the physical location to save the images. It returns the image path.
 - `getImageFiles(host, jobId, directory)` - Get document images by job id. The directory specifies the physical location to save the images. It returns an array of image paths.
 - `deleteJob(host, jobId)` - Delete a scan job by job id. It can interrupt the scan process.

examples/REST/app.js

@@ -20,7 +20,7 @@ app.get('/devices', (req, res) => {
     });
 });
 
-app.post('/scandocument', async (req, res) => {
+app.post('/createJob', async (req, res) => {
     const data = req.body;
 
     let parameters = {
@@ -38,7 +38,7 @@ app.post('/scandocument', async (req, res) => {
         IfDuplexEnabled: false,
     };
 
-    let job = await docscan4nodejs.scanDocument(dynamsoftService, parameters);
+    let job = await docscan4nodejs.createJob(dynamsoftService, parameters);
     let json = JSON.parse(job);
     let jobId = json.jobuid;
     let filename = await docscan4nodejs.getImageFile(dynamsoftService, jobId, './public');

examples/REST/public/index.html

@@ -62,7 +62,7 @@ <h1> Document Scanning Sample</h1>
 
             async function acquireImage() {
                 if (devices.length > 0 && selectSources.selectedIndex >= 0) {
-                    const response = await fetch('/scandocument', {
+                    const response = await fetch('/createJob', {
                         method: 'POST',
                         headers: {
                             'Content-Type': 'application/json'

examples/command-line/app.js

@@ -54,6 +54,7 @@ function askQuestion() {
                         let parameters = {
                             license: "DLS2eyJoYW5kc2hha2VDb2RlIjoiMjAwMDAxLTE2NDk4Mjk3OTI2MzUiLCJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSIsInNlc3Npb25QYXNzd29yZCI6IndTcGR6Vm05WDJrcEQ5YUoifQ==",
                             device: devices[index].device,
+                            autoRun: false
                         };
 
                         parameters.config = {
@@ -66,21 +67,34 @@ function askQuestion() {
                             IfDuplexEnabled: false,
                         };
 
-                        docscan4nodejs.scanDocument(host, parameters).then((job) => {
+                        docscan4nodejs.createJob(host, parameters).then((job) => {
                             try {
                                 let json = JSON.parse(job);
-                                let jobid = json.jobuid;
+                                let jobId = json.jobuid;
+
                                 (async () => {
-                                    let images = await docscan4nodejs.getImageFiles(host, jobid, './');
+                                    let status = await docscan4nodejs.checkJob(host, jobId);
+                                    console.log('Job status:', status);
+
+                                    let caps = await docscan4nodejs.getScannerCapabilities(host, jobId);
+                                    console.log('Capabilities:', caps);
+
+                                    let updateStatus = await docscan4nodejs.updateJob(host, jobId, {
+                                        status: docscan4nodejs.JobStatus.RUNNING
+                                    });
+                                    console.log('Update status:', updateStatus);
+
+                                    let images = await docscan4nodejs.getImageFiles(host, jobId, './');
                                     for (let i = 0; i < images.length; i++) {
                                         console.log('Image ' + i + ': ' + images[i]);
                                     }
-                                    await docscan4nodejs.deleteJob(host, jobid);
+                                    await docscan4nodejs.deleteJob(host, jobId);
                                     askQuestion();
                                 })();
                             }
                             catch (error) {
                                 console.error('Job creation failed:', error.message);
+                                askQuestion();
                             }
                         });
                     }

examples/web/app.js

@@ -45,10 +45,13 @@ io.on('connection', (socket) => {
                     IfDuplexEnabled: false,
                 };
 
-                let job = await docscan4nodejs.scanDocument(host, parameters);
+                let job = await docscan4nodejs.createJob(host, parameters);
                 let json = JSON.parse(job);
                 let jobId = json.jobuid;
 
+                let status = await docscan4nodejs.checkJob(host, jobId);
+                console.log('Job status:', status);
+
                 let streams = await docscan4nodejs.getImageStreams(host, jobId);
                 for (let i = 0; i < streams.length; i++) {
                     await new Promise((resolve, reject) => {

index.js

@@ -15,6 +15,11 @@ const ScannerType = {
     WIATWAINSCANNER: 0x800
 };
 
+const JobStatus = {
+    RUNNING: 'running',
+    CANCELED: 'canceled',
+};
+
 // Unified HTTP/HTTPS request handler
 function request(options) {
     return new Promise((resolve, reject) => {
@@ -171,6 +176,7 @@ async function getDevices(host, scannerType) {
     try {
         const response = await request({
             url,
+            method: 'GET',
             json: true
         });
 
@@ -185,7 +191,7 @@ async function getDevices(host, scannerType) {
 }
 
 // Create new scan job
-async function scanDocument(host, parameters) {
+async function createJob(host, parameters) {
     const url = `${host}/api/device/scanners/jobs`;
 
     try {
@@ -207,6 +213,24 @@ async function scanDocument(host, parameters) {
     }
 }
 
+// Retrive the job status
+async function checkJob(host, jobId) {
+    const url = `${host}/api/device/scanners/jobs/${jobId}`;
+
+    try {
+        const response = await request({
+            url,
+            method: 'GET',
+            json: true
+        });
+
+        return response.status === 200 ? response.data : '';
+    } catch (error) {
+        console.error('Scan job creation failed:', error.message);
+        return '';
+    }
+}
+
 // Delete existing scan job
 async function deleteJob(host, jobId) {
     if (!jobId) return;
@@ -222,6 +246,46 @@ async function deleteJob(host, jobId) {
     }
 }
 
+// Update existing scan job status (e.g. 'running', canceled)
+async function updateJob(host, jobId, parameters) {
+    const url = `${host}/api/device/scanners/jobs/${jobId}`;
+
+    try {
+        const response = await request({
+            url,
+            method: 'PATCH',
+            headers: {
+                'Content-Type': 'application/json',
+                'Content-Length': Buffer.byteLength(JSON.stringify(parameters))
+            },
+            body: parameters
+        });
+
+        return response.status === 200 ? response.data : '';
+    } catch (error) {
+        console.error('Scan job creation failed:', error.message);
+        return '';
+    }
+}
+
+async function getScannerCapabilities(host, jobId) {
+    const url = `${host}/api/device/scanners/jobs/${jobId}/scanner/capabilities`;
+
+    try {
+        const response = await request({
+            url,
+            method: 'GET',
+            json: true
+        });
+
+        return response.status === 200 ? response.data : '';
+    }
+    catch (error) {
+        console.error('Scan job creation failed:', error.message);
+        return '';
+    }
+}
+
 // Get multiple image files
 async function getImageFiles(host, jobId, directory) {
     const images = [];
@@ -249,13 +313,17 @@ async function getImageStreams(host, jobId) {
 }
 
 module.exports = {
+    ScannerType,
+    JobStatus,
+    getServerInfo,
     getDevices,
-    scanDocument,
+    createJob,
     deleteJob,
+    updateJob,
+    checkJob,
     getImageFile,
     getImageStream,
     getImageFiles,
     getImageStreams,
-    ScannerType,
-    getServerInfo
+    getScannerCapabilities
 };