node-hp-scan-to 1.0.1 → 1.2.1

package/README.md

@@ -1,11 +1,92 @@
-# node-hp-scan-to
-
-[![Build Status](https://travis-ci.org/manuc66/node-hp-scan-to.svg?branch=master)](https://travis-ci.org/manuc66/node-hp-scan-to)
-
-Little command line program that allow to send scan from device to computer.
-
-Developed and tested for `Officejet 6500 E710n-z [B21113]` (HP Officejet 6500A Plus)
-
-For this purpose, the original HP Windows application's interaction with the device has been [reverse engineered](protocol_doc/index.md)
-
-This project is not endorsed by nor affiliated with HP.
+# node-hp-scan-to
+
+[![Build Status](https://app.travis-ci.com/manuc66/node-hp-scan-to.svg?branch=master)](https://app.travis-ci.com/manuc66/node-hp-scan-to)
+[![npm](https://img.shields.io/npm/dt/node-hp-scan-to)](https://www.npmjs.com/package/node-hp-scan-to)
+[![Docker Pulls](https://img.shields.io/docker/pulls/manuc66/node-hp-scan-to)](https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to)
+[![Gitter](https://badges.gitter.im/node-hp-scan-to/community.svg)](https://gitter.im/node-hp-scan-to/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+Little command line program that allow to send scan from device to computer.
+
+Developed and tested for the following HP All-in-One Printers:
+- HP Officejet 6500A Plus
+- HP Deskjet 3520
+- HP Smart Tank Plus 570 series
+
+The following printer are also working:
+- Officejet 6700 premium
+- HP Officejet 5740
+- HP OfficeJet Pro 8025e
+
+There are good chances it also works on your HP All-in-One Printer.
+For this purpose, the original HP Windows application's interaction with the device has been [reverse engineered](protocol_doc/HP%20Officejet%206500%20E710n-z.md).
+
+This project is not endorsed by nor affiliated with HP.
+
+## Usage
+```sh
+git clone ...
+cd node-hp-scan-to
+yarn install -d
+yarn build
+# now start the program with the ip or name of the desired printer
+node dist/index.js -ip 192.168.1.4 # or -n "Officejet 6500 E710n-z"
+```
+
+### Command line options
+- `-ip` or `--address` followed by the ip address of the printer, i.e. `-ip 192.168.0.5`. This overrides `-p`.
+- `-n` or `--name` followed by the printer name, it probably contains spaces, so it needs to be quoted, i.e. `-name "Officejet 6500 E710n-z"`
+- `-d` or `--directory` followed by the directory path where the scanned documents should be saved, i.e. `-d ~/Documents/Scans`. Defaults to `/tmp/scan-to-pc<random value>` when not set.
+- `-p` or `--pattern` followed by the pattern for the filename without file extension, i.e. `"scan"_dd.mm.yyyy_hh:MM:ss` to name the scanned file `scan_19.04.2021_17:26:47`. Date and time patterns are replaced by the current date and time, text that should not be replaced need to be inside quotes. Documentation for the pattern can be found [here](https://www.npmjs.com/package/dateformat) in the section `Mask options`. Defaults to `scan<increasing number>_page<page number>` when not set.
+- `-D, --debug"` enables debug logs.
+
+### Run with docker
+Be aware that with docker you have to specify the ip address of the printer via the `IP` environment variable, because 
+bonjour service discovery uses multicast network traffic which by default doesn't work in docker.
+You could however use docker's macvlan networking, this way you can use service discovery and the `NAME` environment variable.
+
+All scanned files are written to the volume `/scan`, the filename can be changed with the `PATTERN` environment variable.
+For the correct permissions to the volume set the environment variables `PUID` and `PGID`.
+
+To enable debug logs set the environment variable `CMDLINE` to `-D`. Can also be used for any other command line parameters.
+
+The name shown on the printer's display is the hostname of the docker container, which defaults to a random value, so you may want to specify it via the `-hostname` argument.
+
+Example for docker:
+```sh
+git clone ...
+cd node-hp-scan-to
+docker build . -t node-hp-scan-to
+docker run -e IP=192.168.0.5 -e PGID=1000 -e PUID=1000 --hostname scan node-hp-scan-to
+```
+
+Example for docker-compose:
+Write the following `docker-compose.yml` file into this directory:
+```yml
+version: "3"
+
+services:
+  node-hp-scan-to:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: node-hp-scan-to
+    hostname: scan
+    environment:
+      - IP=192.168.0.5
+      - PATTERN="scan"_dd.mm.yyyy_hh:MM:ss
+      - PGID=1000
+      - PUID=1000
+      - TZ=Europe/London
+    volumes:
+      - /some/host/directory/or/volume:/scan
+    restart: always
+```
+Then run `docker-compose up -d --build`.
+To 
+
+Public Pre-built Docker image:
+- https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to
+
+## Debugging
+I'm using Visual Studio Code to debug this application, so instead of running ts-node just enter `code .` and press F5 to start debugging.
+You may want to set your printers ip or name in `.vscode/launch.json`.

package/dist/Destination.d.ts

@@ -1,7 +1,8 @@
-export default class Destination {
-    private readonly name;
-    private readonly hostname;
-    private readonly linkType;
-    constructor(name: string, hostname: string);
-    toXML(): Promise<string>;
-}
+export default class Destination {
+    private readonly name;
+    private readonly hostname;
+    private readonly linkType;
+    private readonly toComp;
+    constructor(name: string, hostname: string, toComp: boolean);
+    toXML(): Promise<string>;
+}

package/dist/Destination.js

@@ -1,85 +1,116 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var xml2js_1 = __importDefault(require("xml2js"));
-var util = __importStar(require("util"));
-var parser = new xml2js_1.default.Parser();
-var Destination = /** @class */ (function () {
-    function Destination(name, hostname) {
-        this.name = name;
-        this.hostname = hostname;
-        this.linkType = "Network";
-    }
-    Destination.prototype.toXML = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var rawDestination, parsed, builder;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        rawDestination = '<?xml version="1.0" encoding="UTF-8"?>\n' +
-                            '<WalkupScanDestination xmlns="http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" \n' +
-                            'xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21 WalkupScanDestinations.xsd">\n' +
-                            '<Hostname xmlns="http://www.hp.com/schemas/imaging/con/dictionaries/2009/04/06"></Hostname>\n' +
-                            '<Name xmlns="http://www.hp.com/schemas/imaging/con/dictionaries/1.0/"></Name>\n' +
-                            "<LinkType>Network</LinkType>\n" +
-                            "</WalkupScanDestination>";
-                        return [4 /*yield*/, util.promisify(parser.parseString)(rawDestination)];
-                    case 1:
-                        parsed = _a.sent();
-                        parsed.WalkupScanDestination.Hostname[0]._ = this.hostname;
-                        parsed.WalkupScanDestination.Name[0]._ = this.name;
-                        parsed.WalkupScanDestination.LinkType[0] = this.linkType;
-                        builder = new xml2js_1.default.Builder();
-                        return [2 /*return*/, builder.buildObject(parsed)];
-                }
-            });
-        });
-    };
-    return Destination;
-}());
-exports.default = Destination;
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var xml2js_1 = require("xml2js");
+var util = __importStar(require("util"));
+var parser = new xml2js_1.Parser();
+var Destination = /** @class */ (function () {
+    function Destination(name, hostname, toComp) {
+        this.name = name;
+        this.hostname = hostname;
+        this.linkType = "Network";
+        this.toComp = toComp;
+    }
+    Destination.prototype.toXML = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rawDestination, parsed, builder, xml;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        rawDestination = '<?xml version="1.0" encoding="UTF-8"?>\n';
+                        if (this.toComp) {
+                            rawDestination +=
+                                '<WalkupScanDestination xmlns="http://www.hp.com/schemas/imaging/con/ledm/walkupscan/2010/09/28" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
+                                    'xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/ledm/walkupscan/2010/09/28 WalkupScan.xsd">\n';
+                        }
+                        else {
+                            rawDestination +=
+                                '<WalkupScanDestination xmlns="http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" \n' +
+                                    'xsi:schemaLocation="http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21 WalkupScanDestinations.xsd">\n';
+                        }
+                        rawDestination +=
+                            '\t<Hostname xmlns="http://www.hp.com/schemas/imaging/con/dictionaries/2009/04/06"></Hostname>\n' +
+                                '\t<Name xmlns="http://www.hp.com/schemas/imaging/con/dictionaries/1.0/"></Name>\n' +
+                                "\t<LinkType>Network</LinkType>\n" +
+                                "</WalkupScanDestination>";
+                        return [4 /*yield*/, util.promisify(parser.parseString)(rawDestination)];
+                    case 1:
+                        parsed = _a.sent();
+                        parsed.WalkupScanDestination.Hostname[0]._ = this.hostname;
+                        parsed.WalkupScanDestination.Name[0]._ = this.name;
+                        parsed.WalkupScanDestination.LinkType[0] = this.linkType;
+                        builder = new xml2js_1.Builder();
+                        xml = builder.buildObject(parsed);
+                        if (this.toComp) {
+                            return [2 /*return*/, xml.replace(/WalkupScan/g, "WalkupScanToComp")];
+                        }
+                        else {
+                            return [2 /*return*/, xml];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return Destination;
+}());
+exports.default = Destination;
 //# sourceMappingURL=Destination.js.map

package/dist/Destination.js.map

@@ -1 +1 @@
-{"version":3,"file":"Destination.js","sourceRoot":"","sources":["../src/Destination.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEb,kDAA4B;AAC5B,yCAA6B;AAC7B,IAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,MAAM,EAAE,CAAC;AAUnC;IAKE,qBAAY,IAAY,EAAE,QAAgB;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEK,2BAAK,GAAX;;;;;;wBACM,cAAc,GAChB,0CAA0C;4BAC1C,0JAA0J;4BAC1J,qHAAqH;4BACrH,+FAA+F;4BAC/F,iFAAiF;4BACjF,gCAAgC;4BAChC,0BAA0B,CAAC;wBAEd,qBAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,EAAA;;wBAAjE,MAAM,GAAG,SAAqF;wBAEpG,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAC3D,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;wBACnD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAErD,OAAO,GAAG,IAAI,gBAAM,CAAC,OAAO,EAAE,CAAC;wBACnC,sBAAO,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAC;;;;KACpC;IACH,kBAAC;AAAD,CAAC,AA9BD,IA8BC","sourcesContent":["\"use strict\";\r\n\r\nimport xml2js from \"xml2js\";\r\nimport * as util from \"util\";\r\nconst parser = new xml2js.Parser();\r\n\r\ntype WalkupScanDestinationData =  {\r\n  WalkupScanDestination: {\r\n    Hostname: { _: string }[];\r\n    Name: { _: string }[];\r\n    LinkType: string[];\r\n  };\r\n}\r\n\r\nexport default class Destination {\r\n  private readonly name: string;\r\n  private readonly hostname: string;\r\n  private readonly linkType: string;\r\n\r\n  constructor(name: string, hostname: string) {\r\n    this.name = name;\r\n    this.hostname = hostname;\r\n    this.linkType = \"Network\";\r\n  }\r\n\r\n  async toXML() {\r\n    let rawDestination =\r\n      '<?xml version=\"1.0\" encoding=\"UTF-8\"?>\\n' +\r\n      '<WalkupScanDestination xmlns=\"http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \\n' +\r\n      'xsi:schemaLocation=\"http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21 WalkupScanDestinations.xsd\">\\n' +\r\n      '<Hostname xmlns=\"http://www.hp.com/schemas/imaging/con/dictionaries/2009/04/06\"></Hostname>\\n' +\r\n      '<Name xmlns=\"http://www.hp.com/schemas/imaging/con/dictionaries/1.0/\"></Name>\\n' +\r\n      \"<LinkType>Network</LinkType>\\n\" +\r\n      \"</WalkupScanDestination>\";\r\n\r\n    const parsed = await util.promisify(parser.parseString)(rawDestination) as WalkupScanDestinationData;\r\n\r\n    parsed.WalkupScanDestination.Hostname[0]._ = this.hostname;\r\n    parsed.WalkupScanDestination.Name[0]._ = this.name;\r\n    parsed.WalkupScanDestination.LinkType[0] = this.linkType;\r\n\r\n    let builder = new xml2js.Builder();\r\n    return builder.buildObject(parsed);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Destination.js","sourceRoot":"","sources":["../src/Destination.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEb,iCAAuC;AACvC,yCAA6B;AAE7B,IAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAU5B;IAME,qBAAY,IAAY,EAAE,QAAgB,EAAE,MAAe;QACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEK,2BAAK,GAAX;;;;;;wBACM,cAAc,GAAW,0CAA0C,CAAC;wBACxE,IAAI,IAAI,CAAC,MAAM,EAAE;4BACf,cAAc;gCACZ,wJAAwJ;oCACxJ,yGAAyG,CAAC;yBAC7G;6BAAM;4BACL,cAAc;gCACZ,0JAA0J;oCAC1J,qHAAqH,CAAC;yBACzH;wBAED,cAAc;4BACZ,iGAAiG;gCACjG,mFAAmF;gCACnF,kCAAkC;gCAClC,0BAA0B,CAAC;wBAEd,qBAAM,IAAI,CAAC,SAAS,CACjC,MAAM,CAAC,WAAW,CACnB,CAAC,cAAc,CAAC,EAAA;;wBAFX,MAAM,GAAG,SAEE;wBAEjB,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAC3D,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;wBACnD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;wBAErD,OAAO,GAAG,IAAI,gBAAO,EAAE,CAAC;wBACxB,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;wBACtC,IAAI,IAAI,CAAC,MAAM,EAAE;4BACf,sBAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,EAAC;yBACvD;6BAAM;4BACL,sBAAO,GAAG,EAAC;yBACZ;;;;;KACF;IACH,kBAAC;AAAD,CAAC,AA/CD,IA+CC","sourcesContent":["\"use strict\";\n\nimport {Parser, Builder} from \"xml2js\";\nimport * as util from \"util\";\n\nconst parser = new Parser();\n\ntype WalkupScanDestinationData = {\n  WalkupScanDestination: {\n    Hostname: { _: string }[];\n    Name: { _: string }[];\n    LinkType: string[];\n  };\n};\n\nexport default class Destination {\n  private readonly name: string;\n  private readonly hostname: string;\n  private readonly linkType: string;\n  private readonly toComp: boolean;\n\n  constructor(name: string, hostname: string, toComp: boolean) {\n    this.name = name;\n    this.hostname = hostname;\n    this.linkType = \"Network\";\n    this.toComp = toComp;\n  }\n\n  async toXML() {\n    let rawDestination: string = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>\\n';\n    if (this.toComp) {\n      rawDestination +=\n        '<WalkupScanDestination xmlns=\"http://www.hp.com/schemas/imaging/con/ledm/walkupscan/2010/09/28\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ' +\n        'xsi:schemaLocation=\"http://www.hp.com/schemas/imaging/con/ledm/walkupscan/2010/09/28 WalkupScan.xsd\">\\n';\n    } else {\n      rawDestination +=\n        '<WalkupScanDestination xmlns=\"http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \\n' +\n        'xsi:schemaLocation=\"http://www.hp.com/schemas/imaging/con/rest/walkupscan/2009/09/21 WalkupScanDestinations.xsd\">\\n';\n    }\n\n    rawDestination +=\n      '\\t<Hostname xmlns=\"http://www.hp.com/schemas/imaging/con/dictionaries/2009/04/06\"></Hostname>\\n' +\n      '\\t<Name xmlns=\"http://www.hp.com/schemas/imaging/con/dictionaries/1.0/\"></Name>\\n' +\n      \"\\t<LinkType>Network</LinkType>\\n\" +\n      \"</WalkupScanDestination>\";\n\n    const parsed = await util.promisify<string, WalkupScanDestinationData>(\n      parser.parseString\n    )(rawDestination);\n\n    parsed.WalkupScanDestination.Hostname[0]._ = this.hostname;\n    parsed.WalkupScanDestination.Name[0]._ = this.name;\n    parsed.WalkupScanDestination.LinkType[0] = this.linkType;\n\n    let builder = new Builder();\n    let xml = builder.buildObject(parsed);\n    if (this.toComp) {\n      return xml.replace(/WalkupScan/g, \"WalkupScanToComp\");\n    } else {\n      return xml;\n    }\n  }\n}\n"]}

package/dist/Event.d.ts

@@ -1,17 +1,21 @@
-export declare type EventData = {
-    "dd:UnqualifiedEventCategory": string[];
-    "ev:Payload": {
-        "0": {
-            "dd:ResourceURI": {
-                "0": string;
-            };
-        };
-    };
-};
-export default class Event {
-    private readonly data;
-    constructor(data: EventData);
-    readonly unqualifiedEventCategory: string;
-    readonly resourceURI: string;
-    readonly isScanEvent: boolean;
-}
+export declare type EventData = {
+    "dd:UnqualifiedEventCategory": string[];
+    "dd:AgingStamp": string[];
+    "ev:Payload": {
+        "dd:ResourceURI": {
+            "0": string;
+        };
+        "dd:ResourceType": {
+            "0": string;
+        };
+    }[];
+};
+export default class Event {
+    private readonly data;
+    constructor(data: EventData);
+    get unqualifiedEventCategory(): string;
+    get agingStamp(): string;
+    get destinationURI(): string | undefined;
+    get compEventURI(): string | undefined;
+    get isScanEvent(): boolean;
+}

package/dist/Event.js

@@ -1,31 +1,47 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var Event = /** @class */ (function () {
-    function Event(data) {
-        this.data = data;
-    }
-    Object.defineProperty(Event.prototype, "unqualifiedEventCategory", {
-        get: function () {
-            return this.data["dd:UnqualifiedEventCategory"][0];
-        },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Event.prototype, "resourceURI", {
-        get: function () {
-            return this.data["ev:Payload"]["0"]["dd:ResourceURI"]["0"];
-        },
-        enumerable: true,
-        configurable: true
-    });
-    Object.defineProperty(Event.prototype, "isScanEvent", {
-        get: function () {
-            return this.unqualifiedEventCategory === "ScanEvent";
-        },
-        enumerable: true,
-        configurable: true
-    });
-    return Event;
-}());
-exports.default = Event;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Event = /** @class */ (function () {
+    function Event(data) {
+        this.data = data;
+    }
+    Object.defineProperty(Event.prototype, "unqualifiedEventCategory", {
+        get: function () {
+            return this.data["dd:UnqualifiedEventCategory"][0];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event.prototype, "agingStamp", {
+        get: function () {
+            return this.data["dd:AgingStamp"][0];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event.prototype, "destinationURI", {
+        get: function () {
+            var destination = this.data["ev:Payload"].find(function (v) { return v["dd:ResourceType"]["0"].includes("Destination"); });
+            return destination ? destination["dd:ResourceURI"]["0"] : undefined;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event.prototype, "compEventURI", {
+        get: function () {
+            var compEvent = this.data["ev:Payload"].find(function (v) { return v["dd:ResourceType"]["0"].includes("CompEvent"); });
+            return compEvent ? compEvent["dd:ResourceURI"]["0"] : undefined;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Event.prototype, "isScanEvent", {
+        get: function () {
+            return this.unqualifiedEventCategory === "ScanEvent";
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return Event;
+}());
+exports.default = Event;
 //# sourceMappingURL=Event.js.map

package/dist/Event.js.map

@@ -1 +1 @@
-{"version":3,"file":"Event.js","sourceRoot":"","sources":["../src/Event.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAab;IAEE,eAAY,IAAe;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sBAAI,2CAAwB;aAA5B;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;;;OAAA;IAED,sBAAI,8BAAW;aAAf;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC;QAC7D,CAAC;;;OAAA;IAED,sBAAI,8BAAW;aAAf;YACE,OAAO,IAAI,CAAC,wBAAwB,KAAK,WAAW,CAAC;QACvD,CAAC;;;OAAA;IACH,YAAC;AAAD,CAAC,AAjBD,IAiBC","sourcesContent":["\"use strict\";\r\n\r\nexport type EventData = {\r\n  \"dd:UnqualifiedEventCategory\": string[];\r\n  \"ev:Payload\": {\r\n    \"0\": {\r\n      \"dd:ResourceURI\": {\r\n        \"0\": string\r\n      };\r\n    }\r\n  };\r\n};\r\n\r\nexport default class Event {\r\n  private readonly data: EventData;\r\n  constructor(data: EventData) {\r\n    this.data = data;\r\n  }\r\n\r\n  get unqualifiedEventCategory(): string {\r\n    return this.data[\"dd:UnqualifiedEventCategory\"][0];\r\n  }\r\n\r\n  get resourceURI(): string {\r\n    return this.data[\"ev:Payload\"][\"0\"][\"dd:ResourceURI\"][\"0\"];\r\n  }\r\n\r\n  get isScanEvent(): boolean {\r\n    return this.unqualifiedEventCategory === \"ScanEvent\";\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Event.js","sourceRoot":"","sources":["../src/Event.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAeb;IAEE,eAAY,IAAe;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sBAAI,2CAAwB;aAA5B;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;;;OAAA;IAED,sBAAI,6BAAU;aAAd;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC;;;OAAA;IAED,sBAAI,iCAAc;aAAlB;YACE,IAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAjD,CAAiD,CAAC,CAAC;YAEzG,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,CAAC;;;OAAA;IAED,sBAAI,+BAAY;aAAhB;YACE,IAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAA/C,CAA+C,CAAC,CAAC;YAErG,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;;;OAAA;IAED,sBAAI,8BAAW;aAAf;YACE,OAAO,IAAI,CAAC,wBAAwB,KAAK,WAAW,CAAC;QACvD,CAAC;;;OAAA;IACH,YAAC;AAAD,CAAC,AA7BD,IA6BC","sourcesContent":["\"use strict\";\n\nexport type EventData = {\n  \"dd:UnqualifiedEventCategory\": string[];\n  \"dd:AgingStamp\": string[];\n  \"ev:Payload\": {\n    \"dd:ResourceURI\": {\n      \"0\": string;\n    },\n    \"dd:ResourceType\": {\n      \"0\": string;\n    };\n  }[];\n};\n\nexport default class Event {\n  private readonly data: EventData;\n  constructor(data: EventData) {\n    this.data = data;\n  }\n\n  get unqualifiedEventCategory(): string {\n    return this.data[\"dd:UnqualifiedEventCategory\"][0];\n  }\n\n  get agingStamp(): string {\n    return this.data[\"dd:AgingStamp\"][0];\n  }\n\n  get destinationURI(): string | undefined {\n    const destination = this.data[\"ev:Payload\"].find(v => v[\"dd:ResourceType\"][\"0\"].includes(\"Destination\"));\n\n    return destination ? destination[\"dd:ResourceURI\"][\"0\"] : undefined;\n  }\n\n  get compEventURI(): string | undefined {\n    const compEvent = this.data[\"ev:Payload\"].find(v => v[\"dd:ResourceType\"][\"0\"].includes(\"CompEvent\"));\n\n    return compEvent ? compEvent[\"dd:ResourceURI\"][\"0\"] : undefined;\n  }\n\n  get isScanEvent(): boolean {\n    return this.unqualifiedEventCategory === \"ScanEvent\";\n  }\n}\n"]}

package/dist/EventTable.d.ts

@@ -1,11 +1,11 @@
-import Event, { EventData } from "./Event";
-export interface EventTableData {
-    "ev:EventTable"?: {
-        "ev:Event"?: EventData[];
-    };
-}
-export default class EventTable {
-    private readonly data;
-    constructor(data: EventTableData);
-    readonly events: Event[];
-}
+import Event, { EventData } from "./Event";
+export interface EventTableData {
+    "ev:EventTable"?: {
+        "ev:Event"?: EventData[];
+    };
+}
+export default class EventTable {
+    private readonly data;
+    constructor(data: EventTableData);
+    get events(): Event[];
+}

package/dist/EventTable.js

@@ -1,27 +1,27 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var Event_1 = __importDefault(require("./Event"));
-var EventTable = /** @class */ (function () {
-    function EventTable(data) {
-        this.data = data;
-    }
-    Object.defineProperty(EventTable.prototype, "events", {
-        get: function () {
-            var eventTable = this.data["ev:EventTable"];
-            if (eventTable != null && eventTable["ev:Event"] != null) {
-                return eventTable["ev:Event"].map(function (x) { return new Event_1.default(x); });
-            }
-            else {
-                return [];
-            }
-        },
-        enumerable: true,
-        configurable: true
-    });
-    return EventTable;
-}());
-exports.default = EventTable;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Event_1 = __importDefault(require("./Event"));
+var EventTable = /** @class */ (function () {
+    function EventTable(data) {
+        this.data = data;
+    }
+    Object.defineProperty(EventTable.prototype, "events", {
+        get: function () {
+            var eventTable = this.data["ev:EventTable"];
+            if (eventTable != null && eventTable["ev:Event"] != null) {
+                return eventTable["ev:Event"].map(function (x) { return new Event_1.default(x); });
+            }
+            else {
+                return [];
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return EventTable;
+}());
+exports.default = EventTable;
 //# sourceMappingURL=EventTable.js.map

package/dist/EventTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventTable.js","sourceRoot":"","sources":["../src/EventTable.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;AAEb,kDAAyC;AAQzC;IAEE,oBAAY,IAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sBAAI,8BAAM;aAAV;YACE,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC5C,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE;gBACxD,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,IAAI,eAAK,CAAC,CAAC,CAAC,EAAZ,CAAY,CAAC,CAAC;aACtD;iBAAM;gBACL,OAAO,EAAE,CAAC;aACX;QACH,CAAC;;;OAAA;IACH,iBAAC;AAAD,CAAC,AAdD,IAcC","sourcesContent":["\"use strict\";\r\n\r\nimport Event, {EventData} from \"./Event\";\r\n\r\nexport interface EventTableData {\r\n  \"ev:EventTable\"? : {\r\n    \"ev:Event\"?: EventData[]\r\n  }\r\n}\r\n\r\nexport default class EventTable {\r\n  private readonly data: EventTableData;\r\n  constructor(data: EventTableData) {\r\n    this.data = data;\r\n  }\r\n\r\n  get events() {\r\n    let eventTable = this.data[\"ev:EventTable\"];\r\n    if (eventTable != null && eventTable[\"ev:Event\"] != null) {\r\n      return eventTable[\"ev:Event\"].map(x => new Event(x));\r\n    } else {\r\n      return [];\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EventTable.js","sourceRoot":"","sources":["../src/EventTable.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;AAEb,kDAA2C;AAQ3C;IAEE,oBAAY,IAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sBAAI,8BAAM;aAAV;YACE,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC5C,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE;gBACxD,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,IAAI,eAAK,CAAC,CAAC,CAAC,EAAZ,CAAY,CAAC,CAAC;aACxD;iBAAM;gBACL,OAAO,EAAE,CAAC;aACX;QACH,CAAC;;;OAAA;IACH,iBAAC;AAAD,CAAC,AAdD,IAcC","sourcesContent":["\"use strict\";\n\nimport Event, { EventData } from \"./Event\";\n\nexport interface EventTableData {\n  \"ev:EventTable\"?: {\n    \"ev:Event\"?: EventData[];\n  };\n}\n\nexport default class EventTable {\n  private readonly data: EventTableData;\n  constructor(data: EventTableData) {\n    this.data = data;\n  }\n\n  get events() {\n    let eventTable = this.data[\"ev:EventTable\"];\n    if (eventTable != null && eventTable[\"ev:Event\"] != null) {\n      return eventTable[\"ev:Event\"].map((x) => new Event(x));\n    } else {\n      return [];\n    }\n  }\n}\n"]}