node-hp-scan-to 1.2.1 → 1.3.0

package/dist/test/WalkupScanToCompEvent.test.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mocha_1 = require("mocha");
+const chai_1 = require("chai");
+const path_1 = __importDefault(require("path"));
+const fs = __importStar(require("fs/promises"));
+const WalkupScanToCompEvent_1 = __importDefault(require("../src/WalkupScanToCompEvent"));
+(0, mocha_1.describe)("WalkupScanToCompEvent", () => {
+    (0, mocha_1.describe)("Parsing walkupScanToCompEvent.xml", async () => {
+        let compEvent;
+        before(async () => {
+            const content = await fs.readFile(path_1.default.resolve(__dirname, "./asset/walkupScanToCompEvent.xml"), { encoding: "utf8" });
+            compEvent = await WalkupScanToCompEvent_1.default.createWalkupScanToCompEvent(content);
+        });
+        it("Parse eventType", async () => {
+            (0, chai_1.expect)(compEvent.eventType).to.be.eq("HostSelected");
+        });
+    });
+});
+//# sourceMappingURL=WalkupScanToCompEvent.test.js.map

package/dist/test/WalkupScanToCompEvent.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalkupScanToCompEvent.test.js","sourceRoot":"","sources":["../../test/WalkupScanToCompEvent.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAiC;AACjC,+BAA8B;AAC9B,gDAAwB;AACxB,gDAAkC;AAClC,yFAAiE;AAEjE,IAAA,gBAAQ,EAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAA,gBAAQ,EAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACvD,IAAI,SAAgC,CAAC;QAErC,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,OAAO,GAAW,MAAM,EAAE,CAAC,QAAQ,CACvC,cAAI,CAAC,OAAO,CACV,SAAS,EACT,mCAAmC,CACpC,EACD,EAAE,QAAQ,EAAE,MAAM,EAAE,CACrB,CAAC;YACF,SAAS,GAAG,MAAM,+BAAqB,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAC/B,IAAA,aAAM,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe } from \"mocha\";\nimport { expect } from \"chai\";\nimport path from \"path\";\nimport * as fs from \"fs/promises\";\nimport WalkupScanToCompEvent from \"../src/WalkupScanToCompEvent\";\n\ndescribe(\"WalkupScanToCompEvent\", () => {\n  describe(\"Parsing walkupScanToCompEvent.xml\", async () => {\n    let compEvent: WalkupScanToCompEvent;\n\n    before(async () => {\n      const content: string = await fs.readFile(\n        path.resolve(\n          __dirname,\n          \"./asset/walkupScanToCompEvent.xml\"\n        ),\n        { encoding: \"utf8\" }\n      );\n      compEvent = await WalkupScanToCompEvent.createWalkupScanToCompEvent(content);\n    });\n\n    it(\"Parse eventType\", async () => {\n      expect(compEvent.eventType).to.be.eq(\"HostSelected\");\n    });\n  });\n});\n"]}

package/dist/test/WalkupScanToCompManifest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/WalkupScanToCompManifest.test.js

@@ -0,0 +1,46 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mocha_1 = require("mocha");
+const chai_1 = require("chai");
+const path_1 = __importDefault(require("path"));
+const fs = __importStar(require("fs/promises"));
+const WalkupScanToCompManifest_1 = __importDefault(require("../src/WalkupScanToCompManifest"));
+(0, mocha_1.describe)("WalkupScanToCompManifest", () => {
+    (0, mocha_1.describe)("Parsing walkupScanToCompManifest.xml", async () => {
+        let walkupScanToCompManifest;
+        before(async () => {
+            const content = await fs.readFile(path_1.default.resolve(__dirname, "./asset/walkupScanToCompManifest.xml"), { encoding: "utf8" });
+            walkupScanToCompManifest = await WalkupScanToCompManifest_1.default.createWalkupScanToCompManifest(content);
+        });
+        it("Parse WalkupScanToCompCaps uri", async () => {
+            (0, chai_1.expect)(walkupScanToCompManifest.WalkupScanToCompCapsURI).to.be.eq("/WalkupScanToComp/WalkupScanToCompCaps");
+        });
+    });
+});
+//# sourceMappingURL=WalkupScanToCompManifest.test.js.map

package/dist/test/WalkupScanToCompManifest.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalkupScanToCompManifest.test.js","sourceRoot":"","sources":["../../test/WalkupScanToCompManifest.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAiC;AACjC,+BAA8B;AAC9B,gDAAwB;AACxB,gDAAkC;AAClC,+FAAuE;AAEvE,IAAA,gBAAQ,EAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,IAAA,gBAAQ,EAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QAC1D,IAAI,wBAAkD,CAAC;QAEvD,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,OAAO,GAAW,MAAM,EAAE,CAAC,QAAQ,CACvC,cAAI,CAAC,OAAO,CACV,SAAS,EACT,sCAAsC,CACvC,EACD,EAAE,QAAQ,EAAE,MAAM,EAAE,CACrB,CAAC;YACF,wBAAwB,GAAG,MAAM,kCAAwB,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;QACpG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,IAAA,aAAM,EAAC,wBAAwB,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,wCAAwC,CAAC,CAAC;QAC9G,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AAEL,CAAC,CAAC,CAAC","sourcesContent":["import { describe } from \"mocha\";\nimport { expect } from \"chai\";\nimport path from \"path\";\nimport * as fs from \"fs/promises\";\nimport WalkupScanToCompManifest from \"../src/WalkupScanToCompManifest\";\n\ndescribe(\"WalkupScanToCompManifest\", () => {\n  describe(\"Parsing walkupScanToCompManifest.xml\", async () => {\n    let walkupScanToCompManifest: WalkupScanToCompManifest;\n\n    before(async () => {\n      const content: string = await fs.readFile(\n        path.resolve(\n          __dirname,\n          \"./asset/walkupScanToCompManifest.xml\"\n        ),\n        { encoding: \"utf8\" }\n      );\n      walkupScanToCompManifest = await WalkupScanToCompManifest.createWalkupScanToCompManifest(content);\n    });\n\n    it(\"Parse WalkupScanToCompCaps uri\", async () => {\n      expect(walkupScanToCompManifest.WalkupScanToCompCapsURI).to.be.eq(\"/WalkupScanToComp/WalkupScanToCompCaps\");\n    });\n  });\n\n});\n"]}

package/dist/test/clean.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/clean.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mocha_1 = require("mocha");
+const HPApi_1 = __importDefault(require("../src/HPApi"));
+(0, mocha_1.describe)("EtagEventTable", () => {
+    (0, mocha_1.describe)("Parsing eventTable.xml", async () => {
+        before(async () => {
+            HPApi_1.default.setDeviceIP("192.168.1.53");
+        });
+        it("Clean all destinations", async () => {
+            const dests = await HPApi_1.default.getWalkupScanToCompDestinations();
+            for (let i = 0; i < dests.destinations.length; i++) {
+                await HPApi_1.default.removeDestination(dests.destinations[i]);
+            }
+        });
+    });
+});
+//# sourceMappingURL=clean.js.map

package/dist/test/clean.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean.js","sourceRoot":"","sources":["../../test/clean.ts"],"names":[],"mappings":";;;;;AAAA,iCAAiC;AAEjC,yDAAiC;AAEjC,IAAA,gBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAA,gBAAQ,EAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,CAAC,KAAK,IAAI,EAAE;YAChB,eAAK,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,KAAK,GAAG,MAAM,eAAK,CAAC,+BAA+B,EAAE,CAAC;YAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAClD,MAAM,eAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;aACtD;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe } from \"mocha\";\nimport { EtagEventTable } from \"../src/EventTable\";\nimport HPApi from \"../src/HPApi\";\n\ndescribe(\"EtagEventTable\", () => {\n  describe(\"Parsing eventTable.xml\", async () => {\n    before(async () => {\n      HPApi.setDeviceIP(\"192.168.1.53\");\n    });\n\n    it(\"Clean all destinations\", async () => {\n      const dests = await HPApi.getWalkupScanToCompDestinations();\n      for (let i = 0; i < dests.destinations.length; i++) {\n        await HPApi.removeDestination(dests.destinations[i]);\n      }\n    });\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-hp-scan-to",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Scan document to Computer for HP All-in-One Printers",
   "keywords": [
     "Officejet",
@@ -15,11 +15,14 @@
   },
   "scripts": {
     "start": "ts-node src/index.ts",
+    "start-debug": "ts-node src/index.ts -D",
     "build": "tsc -p .",
+    "built-start": "tsc -p . && node --trace-warnings ./dist/index.js",
     "start-dev": "nodemon",
     "prepublishOnly": "tsc -p ./ --outDir dist/",
     "prettier": "prettier --write \"src/**/*.ts\"",
-    "test": "./node_modules/.bin/mocha --require ts-node/register ./test/*.test.ts"
+    "test": "npx mocha --require ts-node/register ./test/**/*.test.ts",
+    "test-ci": "npx nyc --reporter=lcov mocha -r ts-node/register ./test/**/*.test.ts && codecov"
   },
   "files": [
     "dist",
@@ -44,29 +47,35 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@types/bonjour": "^3.5.9",
-    "@types/chai": "^4.3.1",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.8",
-    "@types/xml2js": "^0.4.9",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/bonjour": "^3.5.10",
+    "@types/chai": "^4.3.3",
+    "@types/chai-string": "^1.4.2",
+    "@types/config": "^3.3.0",
+    "@types/dateformat": "^5.0.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.0",
+    "@types/xml2js": "^0.4.11",
     "chai": "^4.3.6",
-    "mocha": "^10.0.0",
-    "nodemon": "^2.0.14",
+    "chai-string": "^1.5.0",
+    "codecov": "^3.8.3",
+    "eslint": "^8.25.0",
+    "mocha": "^10.1.0",
+    "nodemon": "^2.0.20",
     "nyc": "^15.1.0",
-    "prettier": "^2.4.1",
+    "prettier": "^2.7.1",
     "ts-mockito": "^2.6.1",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.4.4"
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.2",
+    "yarn": "^1.22.19"
   },
   "dependencies": {
-    "@types/dateformat": "^5.0.0",
-    "axios": "^0.27.2",
+    "axios": "^1.1.3",
     "bonjour": "^3.5.0",
-    "commander": "^9.0.0",
+    "commander": "^10.0.0",
+    "config": "^3.3.8",
     "dateformat": "^4.6.3",
-    "eslint": "^8.15.0",
-    "xml2js": "^0.4.23",
     "jspdf": "^2.5.1",
-    "yarn": "^1.22.18"
+    "xml2js": "^0.4.23"
   }
 }

package/src/Destination.ts

@@ -1,6 +1,6 @@
 "use strict";
 
-import {Parser, Builder} from "xml2js";
+import { Parser, Builder } from "xml2js";
 import * as util from "util";
 
 const parser = new Parser();

package/src/DeviceCapabilities.ts

@@ -0,0 +1,4 @@
+export interface DeviceCapabilities {
+  supportsMultiItemScanFromPlaten: boolean;
+  useWalkupScanToComp: boolean;
+}

package/src/DiscoveryTree.ts

@@ -0,0 +1,56 @@
+"use strict";
+import { Parser } from "xml2js";
+const parser = new Parser();
+import { promisify } from "util";
+const parseString = promisify<string, DiscoveryTreeData>(parser.parseString);
+
+export interface DiscoveryTreeData {
+  "ledm:DiscoveryTree": {
+    "ledm:SupportedIfc": {
+      "ledm:ManifestURI": string[];
+      "dd:ResourceType": string[];
+    }[];
+  };
+}
+
+export default class DiscoveryTree {
+  private readonly data: DiscoveryTreeData;
+
+  constructor(data: DiscoveryTreeData) {
+    this.data = data;
+  }
+  static async createDiscoveryTree(content: string): Promise<DiscoveryTree> {
+    const parsed = await parseString(content);
+    return new DiscoveryTree(parsed);
+  }
+
+  get WalkupScanToCompManifestURI(): string | null {
+    const hpLedmWalkupScanToCompManifest = this.data["ledm:DiscoveryTree"][
+      "ledm:SupportedIfc"
+    ].find(
+      (x) => x["dd:ResourceType"][0] === "ledm:hpLedmWalkupScanToCompManifest"
+    );
+    if (hpLedmWalkupScanToCompManifest !== undefined) {
+      return hpLedmWalkupScanToCompManifest["ledm:ManifestURI"][0];
+    }
+    return null;
+  }
+  get WalkupScanManifestURI(): string | null {
+    const hpLedmWalkupScanToCompManifest = this.data["ledm:DiscoveryTree"][
+      "ledm:SupportedIfc"
+    ].find((x) => x["dd:ResourceType"][0] === "hpCnxWalkupScanManifest");
+    if (hpLedmWalkupScanToCompManifest === undefined) {
+      return null;
+    }
+    return hpLedmWalkupScanToCompManifest["ledm:ManifestURI"][0];
+  }
+  get ScanJobManifestURI(): string | null {
+    const hpLedmWalkupScanToCompManifest = this.data["ledm:DiscoveryTree"][
+      "ledm:SupportedIfc"
+    ].find((x) => x["dd:ResourceType"][0] === "ledm:hpLedmScanJobManifest");
+    if (hpLedmWalkupScanToCompManifest === undefined) {
+      return null;
+    }
+    return hpLedmWalkupScanToCompManifest["ledm:ManifestURI"][0];
+  }
+}

package/src/Event.ts

@@ -6,7 +6,7 @@ export type EventData = {
   "ev:Payload": {
     "dd:ResourceURI": {
       "0": string;
-    },
+    };
     "dd:ResourceType": {
       "0": string;
     };
@@ -28,15 +28,25 @@ export default class Event {
   }
 
   get destinationURI(): string | undefined {
-    const destination = this.data["ev:Payload"].find(v => v["dd:ResourceType"]["0"].includes("Destination"));
-
-    return destination ? destination["dd:ResourceURI"]["0"] : undefined;
+    if (this.data.hasOwnProperty("ev:Payload")) {
+      const destination = this.data["ev:Payload"].find((v) =>
+        v["dd:ResourceType"]["0"].includes("Destination")
+      );
+
+      return destination ? destination["dd:ResourceURI"]["0"] : undefined;
+    }
+    return undefined;
   }
 
   get compEventURI(): string | undefined {
-    const compEvent = this.data["ev:Payload"].find(v => v["dd:ResourceType"]["0"].includes("CompEvent"));
-
-    return compEvent ? compEvent["dd:ResourceURI"]["0"] : undefined;
+    if (this.data.hasOwnProperty("ev:Payload")) {
+      const compEvent = this.data["ev:Payload"].find((v) =>
+        v["dd:ResourceType"]["0"].includes("CompEvent")
+      );
+
+      return compEvent ? compEvent["dd:ResourceURI"]["0"] : undefined;
+    }
+    return undefined;
   }
 
   get isScanEvent(): boolean {

package/src/EventTable.ts

@@ -1,6 +1,15 @@
 "use strict";
 
 import Event, { EventData } from "./Event";
+import { Parser } from "xml2js";
+const parser = new Parser();
+import { promisify } from "util";
+const parseString = promisify<string, EventTableData>(parser.parseString);
+
+export interface EtagEventTable {
+  etag: string;
+  eventTable: EventTable;
+}
 
 export interface EventTableData {
   "ev:EventTable"?: {
@@ -14,6 +23,17 @@ export default class EventTable {
     this.data = data;
   }
 
+  static async createEtagEventTable(
+    content: string,
+    etagReceived: string
+  ): Promise<EtagEventTable> {
+    const parsed = await parseString(content);
+    return {
+      etag: etagReceived,
+      eventTable: new EventTable(parsed),
+    };
+  }
+
   get events() {
     let eventTable = this.data["ev:EventTable"];
     if (eventTable != null && eventTable["ev:Event"] != null) {