node-hp-scan-to 1.3.0 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-hp-scan-to",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Scan document to Computer for HP All-in-One Printers",
   "keywords": [
     "Officejet",
@@ -32,7 +32,7 @@
     "README.md"
   ],
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.20.0"
   },
   "author": {
     "email": "manuc66@gmail.com",
@@ -54,16 +54,16 @@
     "@types/config": "^3.3.0",
     "@types/dateformat": "^5.0.0",
     "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.0",
+    "@types/node": "^20.1.7",
     "@types/xml2js": "^0.4.11",
     "chai": "^4.3.6",
     "chai-string": "^1.5.0",
     "codecov": "^3.8.3",
     "eslint": "^8.25.0",
     "mocha": "^10.1.0",
-    "nodemon": "^2.0.20",
+    "nodemon": "^3.0.1",
     "nyc": "^15.1.0",
-    "prettier": "^2.7.1",
+    "prettier": "^3.0.0",
     "ts-mockito": "^2.6.1",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.2",
@@ -72,10 +72,10 @@
   "dependencies": {
     "axios": "^1.1.3",
     "bonjour": "^3.5.0",
-    "commander": "^10.0.0",
+    "commander": "^11.0.0",
     "config": "^3.3.8",
     "dateformat": "^4.6.3",
     "jspdf": "^2.5.1",
-    "xml2js": "^0.4.23"
+    "xml2js": "^0.6.0"
   }
 }

package/src/Destination.ts

@@ -45,7 +45,7 @@ export default class Destination {
       "</WalkupScanDestination>";
 
     const parsed = await util.promisify<string, WalkupScanDestinationData>(
-      parser.parseString
+      parser.parseString,
     )(rawDestination);
 
     parsed.WalkupScanDestination.Hostname[0]._ = this.hostname;

package/src/DeviceCapabilities.ts

@@ -1,4 +1,8 @@
 export interface DeviceCapabilities {
   supportsMultiItemScanFromPlaten: boolean;
   useWalkupScanToComp: boolean;
+  platenMaxWidth: number | null;
+  platenMaxHeight: number | null;
+  adfMaxWidth: number | null;
+  adfMaxHeight: number | null;
 }

package/src/DiscoveryTree.ts

@@ -28,7 +28,7 @@ export default class DiscoveryTree {
     const hpLedmWalkupScanToCompManifest = this.data["ledm:DiscoveryTree"][
       "ledm:SupportedIfc"
     ].find(
-      (x) => x["dd:ResourceType"][0] === "ledm:hpLedmWalkupScanToCompManifest"
+      (x) => x["dd:ResourceType"][0] === "ledm:hpLedmWalkupScanToCompManifest",
     );
     if (hpLedmWalkupScanToCompManifest !== undefined) {
       return hpLedmWalkupScanToCompManifest["ledm:ManifestURI"][0];

package/src/Event.ts

@@ -28,9 +28,9 @@ export default class Event {
   }
 
   get destinationURI(): string | undefined {
-    if (this.data.hasOwnProperty("ev:Payload")) {
+    if (Object.prototype.hasOwnProperty.call(this.data, "ev:Payload")) {
       const destination = this.data["ev:Payload"].find((v) =>
-        v["dd:ResourceType"]["0"].includes("Destination")
+        v["dd:ResourceType"]["0"].includes("Destination"),
       );
 
       return destination ? destination["dd:ResourceURI"]["0"] : undefined;
@@ -39,9 +39,9 @@ export default class Event {
   }
 
   get compEventURI(): string | undefined {
-    if (this.data.hasOwnProperty("ev:Payload")) {
+    if (Object.prototype.hasOwnProperty.call(this.data, "ev:Payload")) {
       const compEvent = this.data["ev:Payload"].find((v) =>
-        v["dd:ResourceType"]["0"].includes("CompEvent")
+        v["dd:ResourceType"]["0"].includes("CompEvent"),
       );
 
       return compEvent ? compEvent["dd:ResourceURI"]["0"] : undefined;

package/src/EventTable.ts

@@ -25,7 +25,7 @@ export default class EventTable {
 
   static async createEtagEventTable(
     content: string,
-    etagReceived: string
+    etagReceived: string,
   ): Promise<EtagEventTable> {
     const parsed = await parseString(content);
     return {

package/src/HPApi.ts

@@ -46,7 +46,7 @@ export default class HPApi {
   private static logDebug(
     callId: number,
     isRequest: boolean,
-    msg: object | string
+    msg: object | string,
   ): void {
     if (debug) {
       const id = String(callId).padStart(4, "0");
@@ -56,7 +56,7 @@ export default class HPApi {
   }
 
   private static async callAxios(
-    request: AxiosRequestConfig
+    request: AxiosRequestConfig,
   ): Promise<AxiosResponse<string>> {
     callCount++;
     if (request.timeout === 0) {
@@ -111,7 +111,7 @@ export default class HPApi {
     while (!(await HPApi.isAlive())) {
       if (first) {
         console.log(
-          `Device ip: ${printerIP} is down! [${new Date().toISOString()}]`
+          `Device ip: ${printerIP} is down! [${new Date().toISOString()}]`,
         );
       }
       first = false;
@@ -119,7 +119,7 @@ export default class HPApi {
     }
     if (!first) {
       console.log(
-        `Device ip: ${printerIP} is up again! [${new Date().toISOString()}]`
+        `Device ip: ${printerIP} is up again! [${new Date().toISOString()}]`,
       );
     }
   }
@@ -140,7 +140,7 @@ export default class HPApi {
   }
 
   static async getWalkupScanDestinations(
-    uri: string = "/WalkupScan/WalkupScanDestinations"
+    uri: string = "/WalkupScan/WalkupScanDestinations",
   ): Promise<WalkupScanDestinations> {
     const response = await HPApi.callAxios({
       baseURL: `http://${printerIP}`,
@@ -168,7 +168,7 @@ export default class HPApi {
       throw new Error(response.statusText);
     } else {
       return WalkupScanToCompDestinations.createWalkupScanToCompDestinations(
-        response.data
+        response.data,
       );
     }
   }
@@ -188,7 +188,7 @@ export default class HPApi {
     }
   }
   static async getWalkupScanToCompManifest(
-    uri: string
+    uri: string,
   ): Promise<WalkupScanToCompManifest> {
     const response = await HPApi.callAxios({
       baseURL: `http://${printerIP}`,
@@ -201,7 +201,7 @@ export default class HPApi {
       throw new Error(response.statusText);
     } else {
       return WalkupScanToCompManifest.createWalkupScanToCompManifest(
-        response.data
+        response.data,
       );
     }
   }
@@ -237,7 +237,7 @@ export default class HPApi {
   }
 
   static async getWalkupScanToCompCaps(
-    uri: string
+    uri: string,
   ): Promise<WalkupScanToCompCaps> {
     const response = await HPApi.callAxios({
       baseURL: `http://${printerIP}`,
@@ -254,7 +254,7 @@ export default class HPApi {
   }
 
   static async getWalkupScanToCompEvent(
-    compEventURI: string
+    compEventURI: string,
   ): Promise<WalkupScanToCompEvent> {
     const response = await HPApi.callAxios({
       baseURL: `http://${printerIP}`,
@@ -271,7 +271,7 @@ export default class HPApi {
   }
 
   static async removeDestination(
-    walkupScanDestination: WalkupScanDestination | WalkupScanToCompDestination
+    walkupScanDestination: WalkupScanDestination | WalkupScanToCompDestination,
   ): Promise<boolean> {
     let path: string;
 
@@ -279,7 +279,7 @@ export default class HPApi {
       let urlInfo = new URL(walkupScanDestination.resourceURI);
       if (urlInfo.pathname === null) {
         throw new Error(
-          `invalid walkupScanDestination.resourceURI: ${walkupScanDestination.resourceURI}`
+          `invalid walkupScanDestination.resourceURI: ${walkupScanDestination.resourceURI}`,
         );
       }
       path = urlInfo.pathname;
@@ -301,7 +301,7 @@ export default class HPApi {
   }
 
   static async registerWalkupScanDestination(
-    destination: Destination
+    destination: Destination,
   ): Promise<string> {
     const xml = await destination.toXML();
     const url = "/WalkupScan/WalkupScanDestinations";
@@ -321,7 +321,7 @@ export default class HPApi {
     }
   }
   static async registerWalkupScanToCompDestination(
-    destination: Destination
+    destination: Destination,
   ): Promise<string> {
     const xml = await destination.toXML();
     const url = "/WalkupScanToComp/WalkupScanToCompDestinations";
@@ -343,7 +343,7 @@ export default class HPApi {
 
   static async getEvents(
     etag = "",
-    decisecondTimeout = 0
+    decisecondTimeout = 0,
   ): Promise<EtagEventTable> {
     let url = this.appendTimeout("/EventMgmt/EventTable", decisecondTimeout);
 
@@ -384,7 +384,7 @@ export default class HPApi {
 
   static placeETagHeader(
     etag: string,
-    headers: RawAxiosRequestHeaders
+    headers: RawAxiosRequestHeaders,
   ): RawAxiosRequestHeaders {
     if (etag !== "") {
       headers["If-None-Match"] = etag;
@@ -403,7 +403,7 @@ export default class HPApi {
   }
 
   static async getDestination(
-    destinationURL: string
+    destinationURL: string,
   ): Promise<WalkupScanDestination | WalkupScanToCompDestination> {
     const response = await HPApi.callAxios({
       baseURL: `http://${printerIP}`,
@@ -418,7 +418,7 @@ export default class HPApi {
       const content = response.data;
       if (destinationURL.includes("WalkupScanToComp")) {
         return WalkupScanToCompDestination.createWalkupScanToCompDestination(
-          content
+          content,
         );
       } else {
         return WalkupScanDestination.createWalkupScanDestination(content);
@@ -488,7 +488,7 @@ export default class HPApi {
 
   static async downloadPage(
     binaryURL: string,
-    destination: string
+    destination: string,
   ): Promise<string> {
     const { data }: AxiosResponse<Stream> = await axios.request<Stream>({
       baseURL: `http://${printerIP}:8080`,

package/src/InputSource.ts

@@ -0,0 +1,4 @@
+export enum InputSource {
+  Adf = "Adf",
+  Platen = "Platen",
+}

package/src/Job.ts

@@ -15,6 +15,8 @@ export interface JobData {
           ImageWidth: string[];
           ImageHeight: string[];
           ScanSettings: {
+            InputSource: string[];
+            ContentType: string[];
             XResolution: string[];
             YResolution: string[];
           }[];
@@ -52,7 +54,7 @@ export default class Job {
     if (this.data["j:Job"].ScanJob[0].PostScanPage) {
       return parseInt(
         this.data["j:Job"].ScanJob[0].PostScanPage[0].PageNumber[0],
-        10
+        10,
       );
     }
     return null;
@@ -84,19 +86,24 @@ export default class Job {
   }
 
   get imageWidth(): number | null {
-    if (!this.data["j:Job"].ScanJob[0].hasOwnProperty("PreScanPage")) {
+    if (
+      !Object.prototype.hasOwnProperty.call(
+        this.data["j:Job"].ScanJob[0],
+        "PreScanPage",
+      )
+    ) {
       return null;
     }
     return parseInt(
       this.data["j:Job"].ScanJob[0].PreScanPage?.[0]?.BufferInfo?.[0]
-        ?.ImageWidth[0] ?? ""
+        ?.ImageWidth[0] ?? "",
     );
   }
   get imageHeight(): number | null {
     if (this.data["j:Job"].ScanJob[0].PreScanPage) {
       return parseInt(
         this.data["j:Job"].ScanJob[0].PreScanPage[0].BufferInfo[0]
-          .ImageHeight[0]
+          .ImageHeight[0],
       );
     }
     return null;
@@ -105,16 +112,21 @@ export default class Job {
     if (this.data["j:Job"].ScanJob[0].PreScanPage) {
       return parseInt(
         this.data["j:Job"].ScanJob[0].PreScanPage?.[0]?.BufferInfo?.[0]
-          ?.ScanSettings?.[0]?.XResolution[0] ?? ""
+          ?.ScanSettings?.[0]?.XResolution[0] ?? "",
       );
     }
     return null;
   }
   get yResolution(): number | null {
-    if (this.data["j:Job"].ScanJob[0].hasOwnProperty("PreScanPage")) {
+    if (
+      Object.prototype.hasOwnProperty.call(
+        this.data["j:Job"].ScanJob[0],
+        "PreScanPage",
+      )
+    ) {
       return parseInt(
         this.data["j:Job"].ScanJob[0].PreScanPage?.[0]?.BufferInfo?.[0]
-          ?.ScanSettings?.[0]?.YResolution[0] ?? ""
+          ?.ScanSettings?.[0]?.YResolution[0] ?? "",
       );
     }
     return null;

package/src/JpegUtil.ts

@@ -39,7 +39,7 @@ export default class JpegUtil {
 
   static setJpgSize(
     buffer: Buffer,
-    size: { height: number; width: number }
+    size: { height: number; width: number },
   ): boolean {
     let sizeWritten = false;
     const parsingSucceed = this.parse(buffer, {
@@ -77,14 +77,14 @@ export default class JpegUtil {
     let heightWritten = false;
     const parsingSucceed = this.parse(buffer, {
       [start_of_Frame_0]: (start: number, length: number) => {
-        // read the the "Start of frame" marker which contains the file size
+        // read the "Start of frame" marker which contains the file size
 
         // write the picture size
         heightWritten = this.writeHeightInStartOfFrame(
           buffer,
           start,
           length,
-          height
+          height,
         );
 
         // stop processing
@@ -122,7 +122,7 @@ export default class JpegUtil {
 
     if (startOfStartOfFrame == null || lengthOfStartOfFrame == null) {
       this.logDebug(
-        "Start of frame 0 not found, either jpeg parsing is broken either the stream is corrupted"
+        "Start of frame 0 not found, either jpeg parsing is broken either the stream is corrupted",
       );
       return null;
     }
@@ -132,7 +132,7 @@ export default class JpegUtil {
         buffer,
         startOfStartOfFrame,
         lengthOfStartOfFrame,
-        numberOfLine
+        numberOfLine,
       )
     ) {
       return numberOfLine;
@@ -144,7 +144,7 @@ export default class JpegUtil {
     buffer: Buffer,
     startOfStartOfFrame: number,
     lengthOfStartOfFrame: number,
-    numberOfLine: number
+    numberOfLine: number,
   ): boolean {
     // write the picture height
     if (6 < lengthOfStartOfFrame) {
@@ -162,7 +162,7 @@ export default class JpegUtil {
   static readNumberOfLineFromDNL(
     buffer: Buffer,
     start: number,
-    length: number
+    length: number,
   ): number | null {
     let numberOfLine: number | null = null;
 
@@ -175,7 +175,9 @@ export default class JpegUtil {
   }
   static parse(
     buffer: Buffer,
-    markerHandler: { [key: string]: (start: number, length: number) => boolean }
+    markerHandler: {
+      [key: string]: (start: number, length: number) => boolean;
+    },
   ): boolean {
     let i: number = 0;
 
@@ -219,7 +221,7 @@ export default class JpegUtil {
   private static getBlockLength(
     buffer: Buffer,
     i: number,
-    marker: string
+    marker: string,
   ): number | null {
     if (
       marker === "FFDA" ||
@@ -245,7 +247,7 @@ export default class JpegUtil {
   private static findCurrentBlockSize(
     buffer: Buffer,
     i: number,
-    current_marker: string
+    current_marker: string,
   ): number | null {
     for (let j = 0; i + j < buffer.length; j++) {
       if (buffer[i + j] === 0xff) {
@@ -258,7 +260,7 @@ export default class JpegUtil {
           }
         } else {
           this.logDebug(
-            `Premature end of stream reach while searching for the block size inside marker ${current_marker}`
+            `Premature end of stream reach while searching for the block size inside marker ${current_marker}`,
           );
           return null;
         }
@@ -270,7 +272,9 @@ export default class JpegUtil {
   private static parseMarker(
     buffer: Buffer,
     i: number,
-    markerHandler: { [key: string]: (start: number, length: number) => boolean }
+    markerHandler: {
+      [key: string]: (start: number, length: number) => boolean;
+    },
   ): boolean {
     let marker = "";
 
@@ -283,7 +287,7 @@ export default class JpegUtil {
       if (buffer[i] != 0xff) {
         this.logDebug(
           "We should be at the begining of the next block, but got: " +
-            buffer[i]
+            buffer[i],
         );
         return false;
       }
@@ -303,7 +307,7 @@ export default class JpegUtil {
       const foundBlockLength = this.getBlockLength(buffer, i, marker);
       if (foundBlockLength == null) {
         this.logDebug(
-          `Was not able to determine block size for marker ${marker}`
+          `Was not able to determine block size for marker ${marker}`,
         );
         return false;
       }

package/src/PathHelper.ts

@@ -1,8 +1,8 @@
 import path from "path";
 import dateformat from "dateformat";
-const { promises: Fs } = require("fs");
-const fs = require("fs");
 import os from "os";
+import { promises as Fs } from "fs";
+import fs from "fs";
 
 export default class PathHelper {
   static getFileForPage(
@@ -10,30 +10,60 @@ export default class PathHelper {
     scanCount: number,
     currentPageNumber: number,
     filePattern: string | undefined,
-    extension: string
+    extension: string,
+    date: Date,
   ): string {
     if (filePattern) {
-      return path.join(
-        folder,
-        `${dateformat(new Date(), filePattern)}.${extension}`
-      );
+      return path.join(folder, `${dateformat(date, filePattern)}.${extension}`);
     }
 
-    return path.join(
-      folder,
-      `scan${scanCount}_page${currentPageNumber}.${extension}`
+    return this.makeUnique(
+      path.join(
+        folder,
+        `scan${scanCount}_page${currentPageNumber}.${extension}`,
+      ),
+      date,
+    );
+  }
+
+  static async getNextScanNumber(
+    folder: string,
+    currentScanCount: number,
+    filePattern: string | undefined,
+  ): Promise<number> {
+    if (filePattern) {
+      return currentScanCount++;
+    }
+    const files = await Fs.readdir(folder);
+    for (let i = currentScanCount + 1; i < Number.MAX_SAFE_INTEGER; i++) {
+      const currentScanCountProbe = `scan${i}`;
+      if (
+        !(
+          files.some((x) => x.startsWith(currentScanCountProbe)) &&
+          files.some(
+            (x) =>
+              x.startsWith(currentScanCountProbe + "_") ||
+              files.some((x) => x.startsWith(currentScanCountProbe + ".")),
+          )
+        )
+      ) {
+        return i;
+      }
+    }
+    return Promise.reject(
+      `Unable to find the valid scan number in folder ${folder}`,
     );
   }
 
-  static makeUnique(filePath: string): string {
+  static makeUnique(filePath: string, date: Date): string {
     if (!fs.existsSync(filePath)) {
       return filePath;
     }
 
     let parsed = path.parse(filePath);
-    let tryName = `${parsed.dir}${path.sep}${parsed.name}${dateformat(
-      new Date(),
-      "yyyymmdd"
+    let tryName = `${parsed.dir}${path.sep}${parsed.name}_${dateformat(
+      date,
+      "yyyymmdd",
     )}${parsed.ext}`;
     if (!fs.existsSync(tryName)) {
       return tryName;
@@ -49,7 +79,7 @@ export default class PathHelper {
       i = String.fromCharCode(i.charCodeAt(0) + 1);
     }
     throw new Error(
-      `Can not create unique file: ${filePath} iterated until: ${tryName}`
+      `Can not create unique file: ${filePath} iterated until: ${tryName}`,
     );
   }
 
@@ -57,13 +87,11 @@ export default class PathHelper {
     folder: string,
     scanCount: number,
     filePattern: string | undefined,
-    extension: string
+    extension: string,
+    date: Date,
   ): string {
     if (filePattern) {
-      return path.join(
-        folder,
-        `${dateformat(new Date(), filePattern)}.${extension}`
-      );
+      return path.join(folder, `${dateformat(date, filePattern)}.${extension}`);
     }
 
     return path.join(folder, `scan${scanCount}.${extension}`);

package/src/ScanCaps.ts

@@ -3,7 +3,23 @@ import { Parser } from "xml2js";
 const parser = new Parser();
 import { promisify } from "util";
 const parseString = promisify<string, ScanCapsData>(parser.parseString);
-export interface ScanCapsData {}
+
+export interface ScanCapsData {
+  ScanCaps: {
+    Platen: {
+      InputSourceCaps: {
+        MaxWidth: number;
+        MaxHeight: number;
+      }[];
+    }[];
+    Adf: {
+      InputSourceCaps: {
+        MaxWidth: number;
+        MaxHeight: number;
+      }[];
+    }[];
+  };
+}
 
 export default class ScanCaps {
   private readonly data: ScanCapsData;
@@ -16,4 +32,30 @@ export default class ScanCaps {
     const parsed = await parseString(content);
     return new ScanCaps(parsed);
   }
+
+  get PlatenMaxWidth(): number | null {
+    return (
+      this.data["ScanCaps"]["Platen"][0]["InputSourceCaps"][0]["MaxWidth"] ||
+      null
+    );
+  }
+
+  get PlatenMaxHeight(): number | null {
+    return (
+      this.data["ScanCaps"]["Platen"][0]["InputSourceCaps"][0]["MaxHeight"] ||
+      null
+    );
+  }
+
+  get AdfMaxWidth(): number | null {
+    return (
+      this.data["ScanCaps"]["Adf"][0]["InputSourceCaps"][0]["MaxWidth"] || null
+    );
+  }
+
+  get AdfMaxHeight(): number | null {
+    return (
+      this.data["ScanCaps"]["Adf"][0]["InputSourceCaps"][0]["MaxHeight"] || null
+    );
+  }
 }

package/src/ScanContent.ts

@@ -16,7 +16,7 @@ export interface ScanPage {
 
 export async function createPdfFrom(
   scanContent: ScanContent,
-  destination: string
+  destination: string,
 ) {
   let doc: jsPDF | null = null;
   for (const element of scanContent.elements) {

package/src/ScanJobManifest.ts

@@ -29,7 +29,7 @@ export default class ScanJobManifest {
     this.data = data;
   }
   static async createScanJobManifest(
-    content: string
+    content: string,
   ): Promise<ScanJobManifest> {
     const parsed = await parseString(content);
     return new ScanJobManifest(parsed);
@@ -39,7 +39,8 @@ export default class ScanJobManifest {
     const scanCaps = this.data["man:Manifest"]["map:ResourceMap"]["0"][
       "map:ResourceNode"
     ].find(
-      (x) => x["map:ResourceType"][0]["scan:ScanResourceType"][0] === "ScanCaps"
+      (x) =>
+        x["map:ResourceType"][0]["scan:ScanResourceType"][0] === "ScanCaps",
     );
 
     if (scanCaps === undefined) {