node-hp-scan-to 1.6.1 → 1.7.2

package/README.md

@@ -9,173 +9,270 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/manuc66/node-hp-scan-to/badge)](https://www.codefactor.io/repository/github/manuc66/node-hp-scan-to)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to?ref=badge_shield)
 
-# node-hp-scan-to
+**`node-hp-scan-to`** is a Node.js application that replicates HP's "_Scan to Computer_" functionality by [reverse engineering](protocol_doc/HP%20Officejet%206500%20E710n-z.md) the original protocol, allowing you to scan documents directly from your HP printer's scanner to your Linux, Windows, or macOS computer.
+
+Unlike the original HP program, `node-hp-scan-to` is cross-platform and can be ran on a bare-metal desktop or server, or in a container on Docker or Kubernetes. It can also be integrated with third-party document management solutions such as [Paperless-ngx](https://docs.paperless-ngx.com/) and [Nextcloud](https://Nextcloud.com/).
+
+**Disclaimer:** `node-hp-scan-to` is not endorsed by nor affiliated with HP. The reverse engineering of the original HP Windows application's interaction with the device has been done independently.
+
+<!-- TOC -->
+
+- [Features](#features)
+  - [Supported Devices](#supported-devices)
+  - [Supported Functions](#supported-functions)
+  - [App Features](#app-features)
+- [Installation](#installation)
+  - [Using NodeJS](#using-nodejs)
+  - [Using Docker](#using-docker)
+- [Usage](#usage)
+  - [Command Line (CLI)](#command-line-cli)
+    - [CLI Options](#cli-options)
+    - [CLI Commands](#cli-commands)
+  - [Run with Docker](#run-with-docker)
+    - [Public Pre-Built Docker image](#public-pre-built-docker-image)
+    - [Docker Environment Variables](#docker-environment-variables)
+    - [Example for Docker](#example-for-docker)
+    - [Example for Docker Compose](#example-for-docker-compose)
+  - [Run with Kubernetes](#run-with-kubernetes)
+- [Build Source Code](#build-source-code)
+  - [Debugging](#debugging)
+- [💖 Support this project](#-support-this-project)
+- [🙏 Special Thanks](#-special-thanks)
+- [License](#license)
 
-The `node-hp-scan-to` is a Node.js application that replicates the functionality of the "Scan to Computer" from HP. 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)
+<!-- /TOC -->
 
-Its primary purpose is to enable users to scan documents directly from an HP device and seamlessly transfer them to a computer. Unlike the original program, this program is designed to be compatible with Linux (including Docker), and is expected to work on Windows and macOS, making it accessible to a wider range of users and usages. 
+## Features
+
+### Supported Devices
+
+This app has been developed and tested with the following HP All-in-One Printers:
 
-## Supported devices
-It has been developed and tested with the following HP All-in-One Printers:
 - HP DeskJet 3520
 - HP OfficeJet 6500A Plus
 - HP Smart Tank Plus 570 series
+- HP OfficeJet Pro 9019e
+
+Users have reported it also working on:
 
-Additionally, it has been reported to work on several other HP printer models.
-- HP DeskJet 3050 All-in-One - J610a
-- HP DeskJet 3775 All-in-One
-- HP DeskJet 4670 All-in-One
-- HP DeskJet 5525
-- HP Envy 4504 All-in-One
-- HP OfficeJet 3830
-- HP OfficeJet 5230
-- HP OfficeJet 5740
-- HP OfficeJet 6700 Premium
-- HP OfficeJet 6950
-- HP OfficeJet 8010 series
-- HP OfficeJet 8012
-- HP OfficeJet 8014
-- HP OfficeJet Pro 7720 Wide Format All-in-One
-- HP OfficeJet Pro 8025e
-- HP OfficeJet Pro 9012e
+- HP DeskJet 3050 (J610a), 3775, 4670, 5525
+- HP Envy 4504, 4520, 7640
+- HP OfficeJet 250 Mobile, 3830, 5230, 5740, 6700 Premium, 6950, 8010 series, 8025e, 9012e
 - HP PageWide 377dw MFP
 
-There are good chances it also works on your HP All-in-One Printer.
+There is a good chance it also works on other unlisted HP All-in-One Printer.
 
-Please note that the `node-hp-scan-to` project is not endorsed by nor affiliated with HP. The reverse engineering of the original HP Windows application's interaction with the device has been done independently.
+### Supported Functions
 
-## Supported device features
-- ✔️ JPG scan output
-- ✔️ PDF document scan output
-- ✔️ Scan from automatic document feeder
-- ✔️ Dual side with automatic document feeder
-- ✔️ Multi page from platen
+- ✔️ JPG and PDF document scan output
+- ✔️ Automatic document feeder (ADF) support with dual-side scanning
+- ✔️ Multi-page platen scanning
 - ✔️ Automatic IP address discovery
 
-## Provided features
-- ✔️ Prebuilt Docker images (multi arch)
-- ✔️ Command line support (Cross platform)
-- ✔️ Customizable file names
-- ✔️ Customizable resolution
-- ✔️ Customizable label on the device
-- ✔️ Multi platform: Linux, Windows and most probably macOS
-- ✔️ Mutile target supported: folder, [paperless-ngx](https://docs.paperless-ngx.com/) api upload, nextcloud webdav upload
-- ✔️ Clear all registered target
-- ✔️ Automatic scan when automatic document feeder is getting loaded
+### App Features
+
+- ✔️ Multi-platform: Linux, Windows, and macOS
+- ✔️ Prebuilt Docker images (multi-architecture)
+- ✔️ Command line (CLI) support
+- ✔️ Customizable file names, resolutions, and device labels
+- ✔️ Clear all registered targets
+- ✔️ Mutiple output target support:
+  - Local folders
+  - [Paperless-ngx API](https://docs.paperless-ngx.com/api/) upload
+  - [Nextcloud WebDAV](https://docs.Nextcloud.com/server/latest/user_manual/en/files/access_webdav.html) upload
+
+## Installation
+
+### Using NodeJS
+
+- You must have [NodeJS installed](https://nodejs.org/en/download)
+
+- In a Terminal, run: `npm install node-hp-scan-to`
+
+### Using Docker
+
+- You must have [Docker installed](https://www.docker.com/get-started/)
+
+- In a Terminal, run: `docker run -d -e IP="IP_ADDRESS_OF_PRINTER" -e PGID=1000 -e PUID=1000 docker.io/manuc66/node-hp-scan-to`
+
+- For more Docker options, see the [Run with Docker](#run-with-docker) section
+
+- For running with Docker Compose, see the [Example for Docker Compose](#example-for-docker-compose) section
 
 ## Usage
 
-### Command line
+### Command Line (CLI)
+
+Running the app with NodeJS using the `npx` command:
+
 `npx node-hp-scan-to`
 
-- `-a` or `--address` followed by the ip address of the printer, i.e. `-a 192.168.0.5`.
-- `--device-up-polling-interval` is the polling interval in milliseconds to detect if the device is up or not
-- `-l` or `--label` The label to display on the printer (default is the hostname).
-- `-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.
-- `-t` or `--temp-directory` Temp directory used for processing. 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.
-- `-r` or `--resolution` Resolution in DPI of the scans (defaults is 200).
-- `-w` or `--width` followed by an integer, the with in pixel of the scans (default: 2481)
-- `-h` or `--height` followed by an integer, the height in pixel of the scans (default: 3507)
-- `-s` or `--paperless-post-document-url` followed by the paperless post document url (example: https://domain.tld/api/documents/post_document/)
-- `-o` or `--paperless-token` followed by te paperless-ngx api token
-- `--nextcloud-url` followed by the nextcloud url (example: https://domain.tld)
-- `--nextcloud-username` followed by the nextcloud username, must have write access to the upload folder
-- `--nextcloud-password` followed by the nextcloud app password for the username. Either this or `nextcloud-password-file` is required. If both are provided, `nextcloud-password-file` is used.
-- `--nextcloud-password-file` File name that contains the nextcloud app password for the username. Either this or `nextcloud-password` is required. If both are provided, `nextcloud-password-file` is used.
-- `--nextcloud-upload-folder` followed by the upload folder where documents or images are uploaded (default: scan)
-- `-k` or `--keep-files`: if set the scanned files will not be deleted, after uploading to paperless-ngx or nextcloud
-- `-D, --debug"` enables debug logs.
-
-#### `listen command`
-This is the default mode, it will listen the device for new job and trigger based on the selection on the device.
-
-Do run `npx node-hp-scan-to listen --help` to get command line usage help
-
-#### `adf-autoscan`
-This will trigger a scan job as soon as the adf is loaded with paper
-
-Do run `npx node-hp-scan-to adf-autoscan --help` to get command line usage help
-
-You can also set the environment `MAIN_COMMAND` to `adf-autoscan` with docker
-
-#### `clear-registrations`
-This will clear all registered target on the device (useful for trial and error and debugging)
-Do run `npx node-hp-scan-to clear-registrations --help` to get command line usage help
-
-You can also set the environment `MAIN_COMMAND` to `clear-registrations` with docker
-
-### Run with docker
-
-Public Pre-built Docker image:
-- https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to (take master: `docker pull manuc66/node-hp-scan-to:master`) 
-
-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`.
-
-Exhaustive list of supported environment variables and their meaning, or correspondence with [command-line flags](#command-line):
-- `PUID`: id of user that will run the program
-- `PGID`: id of group that will run the program
-- `IP`: command-line flag `-a`/`--address`
-- `PATTERN`: command-line flag `-p`/`--pattern`
-- `LABEL`: command-line flag `-l`/`--label`
-- `NAME`: command-line flag `-n`/`--name`
-- `DIR`: command-line flag `-d`/`--directory`
-- `TEMP_DIR`: command-line flag `-t`/`--temp-directory`
-- `RESOLUTION`: command-line flag `-r`/`--resolution`
-- `PAPERLESS_POST_DOCUMENT_URL`: the paperless post document url (if provided with token, a pdf is uploaded to paperless-ngx) for example: `PAPERLESS_POST_DOCUMENT_URL= "http://<paperless-host>:<port>/api/documents/post_document/"`
-- `PAPERLESS_TOKEN`: the paperless api token for example: `PAPERLESS_TOKEN= "xxxxxxxxxxxx..."`
-- `NEXTCLOUD_URL`: the nextcloud URL, for example `https://nextcloud.example.tld`
-- `NEXTCLOUD_UPLOAD_FOLDER`: upload folder where documents or images are uploaded. User must have write permission on this folder. If not provided, `scan` is used
-- `NEXTCLOUD_USERNAME`: nextcloud user name
-- `NEXTCLOUD_PASSWORD`: password of nextcloud user. Either this or `NEXTCLOUD_PASSWORD_FILE` is required. If both are provided, value of `NEXTCLOUD_PASSWORD_FILE` is used.
-- `NEXTCLOUD_PASSWORD_FILE`: file name containing password of nextcloud user. Either this or `NEXTCLOUD_PASSWORD` is required. If both are provided, this value is used. For example: `NEXTCLOUD_PASSWORD_FILE=./nextcloud_password.secret`. Preferably for use in [docker compose secrets](https://docs.docker.com/reference/compose-file/secrets/)
-- `$KEEP_FILES`: if set the scanned files will not be deleted, after uploading to paperless-ngx or nextcloud
-- `CMDLINE`: additional command-line flags that will be put at the end of the command.
-
-__To enable debug logs set the environment variable `CMDLINE` to `-D`.__
-
-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 override it by enforcing the `hostname`, or using the `LABEL` environment variable.
-
-#### Example for docker:
+Main options:
+
+- `-a, --address <ip>`: Printer IP (e.g., `192.168.0.5`)
+- `-d, --directory <path>`: Save scans to (e.g., `~/scans`)
+
+Example usage:
+
+`npx node-hp-scan-to -a 192.168.0.5 -d ~/scans`
+
+#### CLI Options
+
+Run `npx node-hp-scan-to --help` to see the full list of options below:
+
+| Option                          | Description                                                                                                      | Example/Default                                      |
+|---------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
+| `-a`, `--address`               | Printer IP address.                                                                                              | `-a 192.168.0.5` (no default)                        |
+| `-d`, `--directory`             | Directory to save scanned documents. Defaults to `/tmp/scan-to-pc<random value>` if not set.                     | `-d /tmp/scan-to-pc1234`                             |
+| `-D`, `--debug`                 | Enable debug logging.                                                                                            | `-D` (disabled by default)                          |
+| `-h`, `--height`                | Scan height in pixels. Defaults to 3507.                                                                         | `-h 3507`                                            |
+| `-k`, `--keep-files`            | Retain scanned files after uploading to Paperless-ngx or Nextcloud (disabled by default).                        | `-k` (disabled by default)                          |
+| `-l`, `--label`                 | The name of the computer running this app. Defaults to the hostname.                                             | `-l <hostname>` (default: system hostname)           |
+| `-n`, `--name`                  | Printer name (quote if it contains spaces).                                                                      | `-n "Officejet 6500 E710n-z"` (no default)           |
+| `-o`, `--paperless-token`       | Paperless-ngx API token.                                                                                         | `-o xxxxxxxxxxxx` (no default)                      |
+| `-p`, `--pattern`               | Filename pattern (no extension). Use quotes for static text, supports date/time masks (see [dateformat docs](https://www.npmjs.com/package/dateformat#mask-options)). Defaults to `scan<increasing number>_page<page number>`. | `-p scan1_page1`                                    |
+| `-r`, `--resolution`            | Scan resolution in DPI. Defaults to 200.                                                                         | `-r 200`                                             |
+| `-s`, `--paperless-post-document-url` | Paperless-ngx API URL for uploading documents.                                                             | `-s https://domain.tld/api/documents/post_document/` (no default) |
+| `-t`, `--temp-directory`        | Temporary directory for processing. Defaults to `/tmp/scan-to-pc<random value>` if not set.                      | `-t /tmp/scan-to-pc5678`                             |
+| `-w`, `--width`                 | Scan width in pixels. Defaults to 2481.                                                                          | `-w 2481`                                            |
+| `--device-up-polling-interval`  | Polling interval (in milliseconds) to check if the printer is online.                                            | `--device-up-polling-interval 5000` (no default)     |
+| `--nextcloud-password`          | Nextcloud app password. Required unless `--nextcloud-password-file` is used. Overrides if both are provided.     | `--nextcloud-password mypassword` (no default)      |
+| `--nextcloud-password-file`     | File containing the Nextcloud app password. Required unless `--nextcloud-password` is used. Takes precedence if both are provided. | `--nextcloud-password-file /path/to/file` (no default) |
+| `--nextcloud-upload-folder`     | Nextcloud folder for uploads. Defaults to `scan`.                                                                | `--nextcloud-upload-folder scan`                    |
+| `--nextcloud-url`               | Nextcloud instance URL.                                                                                          | `--nextcloud-url https://domain.tld` (no default)   |
+| `--nextcloud-username`          | Nextcloud username with write access to the upload folder.                                                       | `--nextcloud-username user` (no default)            |
+
+**Notes:**
+
+- Date/time patterns for `--pattern` follow the [dateformat](https://www.npmjs.com/package/dateformat) library’s “Mask options” section.
+
+- Defaults like `/tmp/scan-to-pc<random value>` include a random suffix in practice (e.g., `/tmp/scan-to-pc1234`).
+
+#### CLI Commands
+
+##### `listen`
+
+By default, this app runs the `listen` command as the default mode. It will listen to the print for new job and trigger based on the selection on the device.
+
+Run `npx node-hp-scan-to listen --help` to get the full list of command options.
+
+##### `adf-autoscan`
+
+Running `npx node-hp-scan-to adf-autoscan` will automatically trigger a scan job as soon as the ADF (automatic document feeder) on the printer's scanner is loaded with paper.
+
+Run `npx node-hp-scan-to adf-autoscan --help` to get command line usage help.
+
+You can also set the environment variable `MAIN_COMMAND="adf-autoscan"` with Docker. Example:
+
+```sh
+docker run -e MAIN_COMMAND="adf-autoscan" CMDLINE=--debug docker.io/manuc66/node-hp-scan-to:latest
+```
+
+##### `clear-registrations`
+
+Running `npx node-hp-scan-to clear-registratons` will clear all registered targets on the device (useful for trial and error and debugging).
+
+Run `npx node-hp-scan-to clear-registrations --help` to get command line usage help.
+
+You can also set the environment variable `MAIN_COMMAND="clear-registrations"` with Docker. Example:
+
+```sh
+docker run -e MAIN_COMMAND="clear-registrations" docker.io/manuc66/node-hp-scan-to:latest
+```
+
+### Run with Docker
+
+#### Public Pre-Built Docker image
+
+- <https://hub.docker.com/repository/docker/manuc66/node-hp-scan-to>
+
+Be aware that with Docker you have to specify the IP address of the printer via the `IP` environment variable, because the Bonjour service discovery protocol uses multicast network traffic, which by default doesn't work in Docker.
+
+You could however use Docker's [macvlan](https://docs.docker.com/engine/network/drivers/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 that of the user running the container (usually `PUID=1000` and `PGID=1000`).
+
+#### Docker Environment Variables
+
+List of supported environment variables and their meaning, or correspondence with [command-line flags](#cli-options):
+
+| Environment Variable            | Description                                                                                              | Corresponding CLI Flag or Notes                                                                                   |
+|---------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| `CMDLINE`                       | Additional command-line flags added at the end of the command                                            | Set to `-D` to enable debug logs                                                                                |
+| `DIR`                           | Directory to use                                                                                         | `-d` / `--directory`                                                                                            |
+| `IP`                            | IP address for the program                                                                               | `-a` / `--address`                                                                                              |
+| `KEEP_FILES`                    | If set, scanned files are not deleted after uploading to Paperless-ngx or Nextcloud                      |                                                                                                                  |
+| `LABEL`                         | Label to apply                                                                                           | `-l` / `--label`                                                                                                |
+| `NAME`                          | Name to set                                                                                              | `-n` / `--name`                                                                                                 |
+| `NEXTCLOUD_PASSWORD`            | Password of Nextcloud user (either this or `NEXTCLOUD_PASSWORD_FILE` is required; file takes precedence) |                                                                                                                  |
+| `NEXTCLOUD_PASSWORD_FILE`       | File containing Nextcloud user password (either this or `NEXTCLOUD_PASSWORD` is required; takes precedence) | Example: `./nextcloud_password.secret` (preferred for Docker Compose secrets)                                   |
+| `NEXTCLOUD_UPLOAD_FOLDER`       | Upload folder for documents or images (user must have write permission; defaults to `scan` if not set)   |                                                                                                                  |
+| `NEXTCLOUD_URL`                 | Nextcloud URL                                                                                            | Example: `https://nextcloud.example.tld`                                                                        |
+| `NEXTCLOUD_USERNAME`            | Nextcloud username                                                                                       |                                                                                                                  |
+| `PAPERLESS_POST_DOCUMENT_URL`   | Paperless-ngx post document URL (if provided with token, a PDF is uploaded)                              | Example: `http://<paperless-host>:<port>/api/documents/post_document/`                                          |
+| `PAPERLESS_TOKEN`               | Paperless-ngx API token                                                                                  | Example: `xxxxxxxxxxxx...`                                                                                      |
+| `PATTERN`                       | Pattern to use                                                                                           | `-p` / `--pattern`                                                                                              |
+| `PGID`                          | ID of the group that will run the program                                                                |                                                                                                                  |
+| `PUID`                          | ID of the user that will run the program                                                                 |                                                                                                                  |
+| `RESOLUTION`                    | Resolution setting                                                                                       | `-r` / `--resolution`                                                                                           |
+| `TEMP_DIR`                      | Temporary directory                                                                                      | `-t` / `--temp-directory`                                                                                       |
+
+**Additional Notes:**
+
+- The name shown on the printer’s display is the hostname of the Docker container, which defaults to a random value. You can override it by setting the `hostname` or using the `LABEL` environment variable.
+
+- To enable debug logs set the environment variable `CMDLINE` to `-D`
+
+#### Example for Docker
+
+To build a local Docker image from this repo:
+
 ```sh
-git clone ...
+git clone https://github.com/manuc66/node-hp-scan-to.git
 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
+docker run -e IP=192.168.0.5 -e PGID=1000 -e PUID=1000 --hostname myComputer node-hp-scan-to
 ```
 
-#### Example for docker-compose:
-Write the following `docker-compose.yml` file into this directory:
-```yml
-version: "3"
+#### Example for Docker Compose
+
+Create the following `docker-compose.yml` file into this directory:
 
+```yml
 services:
   node-hp-scan-to:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    container_name: node-hp-scan-to
+    image: docker.io/manuc66/node-hp-scan-to:latest
+    restart: unless-stopped
+    hostname: node-hp-scan-to
     environment:
+      # REQUIRED - Change the next line to the IP address of your HP printer/scanner:
       - IP=192.168.0.5
-      - LABEL=scan
-      - PATTERN="scan"_dd.mm.yyyy_hh:MM:ss
+      # Name that your container will appear as to your printer:
+      - LABEL=node-hp-scan-to
+      # Set the timezone, such as "Europe/London":
+      - TZ=UTC
+      # Set the created filename pattern:
+      - PATTERN="scan"_dd-mm-yyyy_hh-MM-ss
+      # Run the Docker container as the same user ID as the host system:
       - PGID=1000
       - PUID=1000
-      - TZ=Europe/London
+      # Optional - enable autoscanning a document when loaded into the scanner:
+      # - MAIN_COMMAND=adf-autoscan
+      # If you need to pass additional configuration flag use the CMDLINE env, thy will be appened to the
+      # - CMDLINE=--debug --pdf
+      # If using Paperless-ngx, you can use its API to upload files:
+      # - PAPERLESS_POST_DOCUMENT_URL="http://<paperless-host>:<port>/api/documents/post_document/"
+      # - PAPERLESS_TOKEN= "xxxxxxxxxxxx..."
     volumes:
-      - /some/host/directory/or/volume:/scan
-    restart: always
+      - ./scan:/scan
 ```
-Then run `docker-compose up -d --build`.
 
-#### Example for Kubernetes:
-Apply the following manifest (the PersistentVolumeClaim must also be deployed beforehand):
+Then run `docker-compose up -d`
+
+### Run with Kubernetes
+
+Apply the following manifest (the `PersistentVolumeClaim` must also be deployed beforehand):
+
 ```yml
 apiVersion: apps/v1
 kind: Deployment
@@ -224,24 +321,30 @@ spec:
             claimName: incoming-scans
 ```
 
-### How to run from the code
-If you wish to test it by cloning this repository:
+## Build Source Code
+
+How to build and run the project's source code:
+
 ```sh
-git clone ...
+git clone https://github.com/manuc66/node-hp-scan-to.git
 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 -a 192.168.1.4 # or -n "Officejet 6500 E710n-z"
+# Start the program with the printer's IP address:
+node dist/index.js -a 192.168.1.5 
+# Or start it with the name of the printer:
+# node dist/index.js -n "Officejet 6500 E710n-z"
 ```
 
-#### 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`.
+### Debugging
+
+I'm using Visual Studio Code to debug this application, so instead of running _ts-node_, just run `code .` and press F5 to start debugging.
+
+You may want to set your printers ip or name in `.vscode/launch.json`
 
 ## 💖 Support this project
 
-Thank you so much to everyone who has already supported this project! Your generosity is greatly appreciated and it motivates me to keep improving and maintaining this project.
+Thank you so much to everyone who has already supported this project! Your generosity is greatly appreciated, and it motivates me to keep improving and maintaining this project.
 
 If this project has helped you save money or time, or simply made your life easier, you can support me by buying me a cup of coffee:
 
@@ -255,4 +358,5 @@ Thank you for your support!
 A special thank you to [JetBrains](https://www.jetbrains.com/) for supporting this project with a free license for their amazing development tools. Their support helps make this project possible.
 
 ## License
+
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmanuc66%2Fnode-hp-scan-to?ref=badge_large)

package/dist/Destination.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const xml2js_1 = require("xml2js");
 const util = __importStar(require("util"));

package/dist/Destination.js.map

@@ -1 +1 @@
-{"version":3,"file":"Destination.js","sourceRoot":"","sources":["../src/Destination.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;AAEb,mCAAyC;AACzC,2CAA6B;AAE7B,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAU5B,MAAqB,WAAW;IAM9B,YAAY,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;IAED,KAAK,CAAC,KAAK;QACT,IAAI,cAAc,GAAW,0CAA0C,CAAC;QACxE,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,cAAc;gBACZ,wJAAwJ;oBACxJ,yGAAyG,CAAC;SAC7G;aAAM;YACL,cAAc;gBACZ,0JAA0J;oBAC1J,qHAAqH,CAAC;SACzH;QAED,cAAc;YACZ,iGAAiG;gBACjG,mFAAmF;gBACnF,kCAAkC;gBAClC,0BAA0B,CAAC;QAE7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CACjC,MAAM,CAAC,WAAW,CACnB,CAAC,cAAc,CAAC,CAAC;QAElB,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3D,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACnD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAI,gBAAO,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,GAAG,CAAC;SACZ;IACH,CAAC;CACF;AA/CD,8BA+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    const builder = new Builder();\n    const xml = builder.buildObject(parsed);\n    if (this.toComp) {\n      return xml.replace(/WalkupScan/g, \"WalkupScanToComp\");\n    } else {\n      return xml;\n    }\n  }\n}\n"]}
+{"version":3,"file":"Destination.js","sourceRoot":"","sources":["../src/Destination.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEb,mCAAyC;AACzC,2CAA6B;AAE7B,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAU5B,MAAqB,WAAW;IAM9B,YAAY,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;IAED,KAAK,CAAC,KAAK;QACT,IAAI,cAAc,GAAW,0CAA0C,CAAC;QACxE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,cAAc;gBACZ,wJAAwJ;oBACxJ,yGAAyG,CAAC;QAC9G,CAAC;aAAM,CAAC;YACN,cAAc;gBACZ,0JAA0J;oBAC1J,qHAAqH,CAAC;QAC1H,CAAC;QAED,cAAc;YACZ,iGAAiG;gBACjG,mFAAmF;gBACnF,kCAAkC;gBAClC,0BAA0B,CAAC;QAE7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CACjC,MAAM,CAAC,WAAW,CACnB,CAAC,cAAc,CAAC,CAAC;QAElB,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3D,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;QACnD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAI,gBAAO,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;CACF;AA/CD,8BA+CC"}

package/dist/DeviceCapabilities.d.ts

@@ -5,4 +5,6 @@ export interface DeviceCapabilities {
     platenMaxHeight: number | null;
     adfMaxWidth: number | null;
     adfMaxHeight: number | null;
+    adfDuplexMaxWidth: number | null;
+    adfDuplexMaxHeight: number | null;
 }

package/dist/DeviceCapabilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeviceCapabilities.js","sourceRoot":"","sources":["../src/DeviceCapabilities.ts"],"names":[],"mappings":"","sourcesContent":["export interface DeviceCapabilities {\n  supportsMultiItemScanFromPlaten: boolean;\n  useWalkupScanToComp: boolean;\n  platenMaxWidth: number | null;\n  platenMaxHeight: number | null;\n  adfMaxWidth: number | null;\n  adfMaxHeight: number | null;\n}\n"]}
+{"version":3,"file":"DeviceCapabilities.js","sourceRoot":"","sources":["../src/DeviceCapabilities.ts"],"names":[],"mappings":""}

package/dist/DiscoveryTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"DiscoveryTree.js","sourceRoot":"","sources":["../src/DiscoveryTree.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AACb,mCAAgC;AAChC,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAC5B,+BAAiC;AACjC,MAAM,WAAW,GAAG,IAAA,gBAAS,EAA4B,MAAM,CAAC,WAAW,CAAC,CAAC;AAW7E,MAAqB,aAAa;IAGhC,YAAY,IAAuB;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAe;QAC9C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,2BAA2B;QAC7B,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CACJ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,qCAAqC,CACzE,CAAC;QACF,IAAI,8BAA8B,KAAK,SAAS,EAAE;YAChD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;SAC9D;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,qBAAqB;QACvB,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,yBAAyB,CAAC,CAAC;QACrE,IAAI,8BAA8B,KAAK,SAAS,EAAE;YAChD,OAAO,IAAI,CAAC;SACb;QACD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,kBAAkB;QACpB,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,4BAA4B,CAAC,CAAC;QACxE,IAAI,8BAA8B,KAAK,SAAS,EAAE;YAChD,OAAO,IAAI,CAAC;SACb;QACD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;CACF;AAxCD,gCAwCC","sourcesContent":["\"use strict\";\nimport { Parser } from \"xml2js\";\nconst parser = new Parser();\nimport { promisify } from \"util\";\nconst parseString = promisify<string, DiscoveryTreeData>(parser.parseString);\n\nexport interface DiscoveryTreeData {\n  \"ledm:DiscoveryTree\": {\n    \"ledm:SupportedIfc\": {\n      \"ledm:ManifestURI\": string[];\n      \"dd:ResourceType\": string[];\n    }[];\n  };\n}\n\nexport default class DiscoveryTree {\n  private readonly data: DiscoveryTreeData;\n\n  constructor(data: DiscoveryTreeData) {\n    this.data = data;\n  }\n  static async createDiscoveryTree(content: string): Promise<DiscoveryTree> {\n    const parsed = await parseString(content);\n    return new DiscoveryTree(parsed);\n  }\n\n  get WalkupScanToCompManifestURI(): string | null {\n    const hpLedmWalkupScanToCompManifest = this.data[\"ledm:DiscoveryTree\"][\n      \"ledm:SupportedIfc\"\n    ].find(\n      (x) => x[\"dd:ResourceType\"][0] === \"ledm:hpLedmWalkupScanToCompManifest\",\n    );\n    if (hpLedmWalkupScanToCompManifest !== undefined) {\n      return hpLedmWalkupScanToCompManifest[\"ledm:ManifestURI\"][0];\n    }\n    return null;\n  }\n  get WalkupScanManifestURI(): string | null {\n    const hpLedmWalkupScanToCompManifest = this.data[\"ledm:DiscoveryTree\"][\n      \"ledm:SupportedIfc\"\n    ].find((x) => x[\"dd:ResourceType\"][0] === \"hpCnxWalkupScanManifest\");\n    if (hpLedmWalkupScanToCompManifest === undefined) {\n      return null;\n    }\n    return hpLedmWalkupScanToCompManifest[\"ledm:ManifestURI\"][0];\n  }\n  get ScanJobManifestURI(): string | null {\n    const hpLedmWalkupScanToCompManifest = this.data[\"ledm:DiscoveryTree\"][\n      \"ledm:SupportedIfc\"\n    ].find((x) => x[\"dd:ResourceType\"][0] === \"ledm:hpLedmScanJobManifest\");\n    if (hpLedmWalkupScanToCompManifest === undefined) {\n      return null;\n    }\n    return hpLedmWalkupScanToCompManifest[\"ledm:ManifestURI\"][0];\n  }\n}\n"]}
+{"version":3,"file":"DiscoveryTree.js","sourceRoot":"","sources":["../src/DiscoveryTree.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AACb,mCAAgC;AAChC,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAC5B,+BAAiC;AACjC,MAAM,WAAW,GAAG,IAAA,gBAAS,EAA4B,MAAM,CAAC,WAAW,CAAC,CAAC;AAW7E,MAAqB,aAAa;IAGhC,YAAY,IAAuB;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAe;QAC9C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,IAAI,2BAA2B;QAC7B,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CACJ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,qCAAqC,CACzE,CAAC;QACF,IAAI,8BAA8B,KAAK,SAAS,EAAE,CAAC;YACjD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,qBAAqB;QACvB,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,yBAAyB,CAAC,CAAC;QACrE,IAAI,8BAA8B,KAAK,SAAS,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,kBAAkB;QACpB,MAAM,8BAA8B,GAAG,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CACpE,mBAAmB,CACpB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,4BAA4B,CAAC,CAAC;QACxE,IAAI,8BAA8B,KAAK,SAAS,EAAE,CAAC;YACjD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,8BAA8B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;CACF;AAxCD,gCAwCC"}

package/dist/Event.js.map

@@ -1 +1 @@
-{"version":3,"file":"Event.js","sourceRoot":"","sources":["../src/Event.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAeb,MAAqB,KAAK;IAExB,YAAY,IAAe;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,cAAc;QAChB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YACjE,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACrD,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAClD,CAAC;YAEF,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;SACrE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,YAAY;QACd,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YACjE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACnD,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAChD,CAAC;YAEF,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,wBAAwB,KAAK,WAAW,CAAC;IACvD,CAAC;CACF;AAvCD,wBAuCC","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    if (Object.prototype.hasOwnProperty.call(this.data, \"ev:Payload\")) {\n      const destination = this.data[\"ev:Payload\"].find((v) =>\n        v[\"dd:ResourceType\"][\"0\"].includes(\"Destination\"),\n      );\n\n      return destination ? destination[\"dd:ResourceURI\"][\"0\"] : undefined;\n    }\n    return undefined;\n  }\n\n  get compEventURI(): string | undefined {\n    if (Object.prototype.hasOwnProperty.call(this.data, \"ev:Payload\")) {\n      const compEvent = this.data[\"ev:Payload\"].find((v) =>\n        v[\"dd:ResourceType\"][\"0\"].includes(\"CompEvent\"),\n      );\n\n      return compEvent ? compEvent[\"dd:ResourceURI\"][\"0\"] : undefined;\n    }\n    return undefined;\n  }\n\n  get isScanEvent(): boolean {\n    return this.unqualifiedEventCategory === \"ScanEvent\";\n  }\n}\n"]}
+{"version":3,"file":"Event.js","sourceRoot":"","sources":["../src/Event.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;AAeb,MAAqB,KAAK;IAExB,YAAY,IAAe;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,cAAc;QAChB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,CAAC;YAClE,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACrD,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAClD,CAAC;YAEF,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,YAAY;QACd,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,CAAC;YAClE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACnD,CAAC,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAChD,CAAC;YAEF,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,wBAAwB,KAAK,WAAW,CAAC;IACvD,CAAC;CACF;AAvCD,wBAuCC"}

package/dist/EventTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"EventTable.js","sourceRoot":"","sources":["../src/EventTable.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;AAEb,oDAA2C;AAC3C,mCAAgC;AAChC,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAC5B,+BAAiC;AACjC,MAAM,WAAW,GAAG,IAAA,gBAAS,EAAyB,MAAM,CAAC,WAAW,CAAC,CAAC;AAa1E,MAAqB,UAAU;IAE7B,YAAY,IAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAC/B,OAAe,EACf,YAAoB;QAEpB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO;YACL,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM;QACR,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9C,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE;YACxD,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,eAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACxD;aAAM;YACL,OAAO,EAAE,CAAC;SACX;IACH,CAAC;CACF;AAzBD,6BAyBC","sourcesContent":["\"use strict\";\n\nimport Event, { EventData } from \"./Event\";\nimport { Parser } from \"xml2js\";\nconst parser = new Parser();\nimport { promisify } from \"util\";\nconst parseString = promisify<string, EventTableData>(parser.parseString);\n\nexport interface EtagEventTable {\n  etag: string;\n  eventTable: EventTable;\n}\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  static async createEtagEventTable(\n    content: string,\n    etagReceived: string,\n  ): Promise<EtagEventTable> {\n    const parsed = await parseString(content);\n    return {\n      etag: etagReceived,\n      eventTable: new EventTable(parsed),\n    };\n  }\n\n  get events() {\n    const 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"]}
+{"version":3,"file":"EventTable.js","sourceRoot":"","sources":["../src/EventTable.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;AAEb,oDAA2C;AAC3C,mCAAgC;AAChC,MAAM,MAAM,GAAG,IAAI,eAAM,EAAE,CAAC;AAC5B,+BAAiC;AACjC,MAAM,WAAW,GAAG,IAAA,gBAAS,EAAyB,MAAM,CAAC,WAAW,CAAC,CAAC;AAa1E,MAAqB,UAAU;IAE7B,YAAY,IAAoB;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAC/B,OAAe,EACf,YAAoB;QAEpB,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO;YACL,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,IAAI,MAAM;QACR,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9C,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACzD,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,eAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAzBD,6BAyBC"}