feat: mqtt alerts (#538)

Author: xninjax

.env-example

@@ -18,6 +18,13 @@ MAX_PRICE_SERIES_3070=
 MAX_PRICE_SERIES_3080=
 MAX_PRICE_SERIES_3090=
 MICROCENTER_LOCATION=
+MQTT_BROKER_ADDRESS=
+MQTT_BROKER_PORT=
+MQTT_CLIENT_ID=
+MQTT_PASSWORD=
+MQTT_QOS=
+MQTT_TOPIC=
+MQTT_USERNAME=
 NVIDIA_ADD_TO_CART_ATTEMPTS=
 NVIDIA_SESSION_TTL=
 OPEN_BROWSER=

README.md

@@ -96,6 +96,13 @@ Here is a list of variables that you can use to customize your newly copied `.en
 | `MAX_PRICE_SERIES_3080` | Maximum price allowed for a match, applies 3080 series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
 | `MAX_PRICE_SERIES_3090` | Maximum price allowed for a match, applies 3090 series cards (does not apply to these sites: Nvidia, Asus, EVGA) | Default: leave empty for no limit, otherwise enter a price (enter whole dollar amounts only, avoid use of: dollar symbols, commas, and periods.) e.g.: `1234` - Cards above `1234` will be skipped. |
 | `MICROCENTER_LOCATION` | Specific MicroCenter location(s) to search | Comma separated, e.g.: `marietta,duluth`, default: `web` |
+| `MQTT_BROKER_ADDRESS` | IP address or URL of MQTT Broker | e.g 192.168.1.xxx or broker.hivemq.com
+| `MQTT_BROKER_PORT` | Network port of MQTT Broker | Default: 1883
+| `MQTT_CLIENT_ID` | Unique ClientID (only if required by MQTT Broker), typically not required when only publishing alerts | eg. client-123456
+| `MQTT_PASSWORD` | MQTT password - only use with MQTT brokers on private networks, if required.  Will not be sent over public networks for safety. | e.g mysecret
+| `MQTT_QOS` | QoS level for published alerts to broker (https://www.npmjs.com/package/mqtt#about-qos) | Default: 0, Can be 0, 1, or 2
+| `MQTT_TOPIC` | Topic to publish alerts to.  Can include %store%, %series%, %brand%, %model% for dynamic topics | Default: nvidia-snatcher/alert e.g nv-alert/%store%/%series%/%brand%/%model%/alert
+| `MQTT_USERNAME` | MQTT username - (only if required by MQTT Broker) | e.g myusername
 | `NVIDIA_ADD_TO_CART_ATTEMPTS` | The maximum number of times the `nvidia-api` add to cart feature will be attempted before failing | Default: `10` |
 | `NVIDIA_SESSION_TTL` | The time in milliseconds to keep the cart active while using `nvidia-api` | Default: `60000` |
 | `OPEN_BROWSER` | Toggle for whether or not the browser should open when item is found | Default: `true` |