feat(api): Add rudimentary web control panel

.env-example

@@ -31,3 +31,4 @@ TWITTER_ACCESS_TOKEN_KEY=
 TWITTER_ACCESS_TOKEN_SECRET=
 TWITTER_TWEET_TAGS=
 USER_AGENT="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36"
+WEB_PORT="1337"

README.md

@@ -97,6 +97,7 @@ Here is a list of variables that you can use to customize your newly copied `.en
 | `TWITTER_ACCESS_TOKEN_KEY` | Twitter Token Key |
 | `TWITTER_ACCESS_TOKEN_SECRET` | Twitter Token Secret |
 | `TWITTER_TWEET_TAGS` | Optional list of hashtags to append to the tweet message | Eg: "`#NVIDIA` `#NVIDIAINSTOCK`" |
+| `WEB_PORT` | Starts a webserver to be able to control the bot while it is running; optional | Default: disabled |
 
 > :point_right: If you have multi-factor authentication (MFA), you will need to create an [app password](https://myaccount.google.com/apppasswords) and use this instead of your Gmail password.
 

src/__test__/notification-test.ts

@@ -1,4 +1,4 @@
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {sendNotification} from '../notification';
 
 const link: Link = {

src/config.ts

@@ -83,3 +83,10 @@ export const Config = {
 	page,
 	store
 };
+
+export function setConfig(newConfig: any) {
+	const writeConfig = Config as any;
+	for (const key of Object.keys(newConfig)) {
+		writeConfig[key] = newConfig[key];
+	}
+}

src/index.ts

@@ -1,10 +1,11 @@
 import {Config} from './config';
 import {Logger} from './logger';
-import {Stores} from './store/model';
 import {adBlocker} from './adblocker';
 import {getSleepTime} from './util';
 import puppeteer from 'puppeteer-extra';
+import {startAPIServer} from './web';
 import stealthPlugin from 'puppeteer-extra-plugin-stealth';
+import {storeList} from './store/model';
 import {tryLookupAndLoop} from './store';
 
 puppeteer.use(stealthPlugin());
@@ -37,14 +38,16 @@ async function main() {
 		headless: Config.browser.isHeadless
 	});
 
-	for (const store of Stores) {
+	for (const store of storeList.values()) {
 		Logger.debug(store.links);
 		if (store.setupAction !== undefined) {
 			store.setupAction(browser);
 		}
 
 		setTimeout(tryLookupAndLoop, getSleepTime(), browser, store);
 	}
+
+	startAPIServer();
 }
 
 /**

src/notification/desktop.ts

@@ -1,4 +1,4 @@
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import notifier from 'node-notifier';
 
 export function sendDesktopNotification(cartUrl: string, link: Link) {

src/notification/discord.ts

@@ -1,6 +1,6 @@
 import {MessageBuilder, Webhook} from 'discord-webhook-node';
 import {Config} from '../config';
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {Logger} from '../logger';
 
 const hook = new Webhook(Config.notifications.discord.webHookUrl);

src/notification/email.ts

@@ -1,5 +1,5 @@
 import {Config} from '../config';
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {Logger} from '../logger';
 import Mail from 'nodemailer/lib/mailer';
 import nodemailer from 'nodemailer';

src/notification/notification.ts

@@ -1,5 +1,5 @@
 import {Config} from '../config';
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {playSound} from './sound';
 import {sendDesktopNotification} from './desktop';
 import {sendDiscordMessage} from './discord';

src/notification/sms.ts

@@ -1,5 +1,5 @@
 import {Config} from '../config';
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {Logger} from '../logger';
 import Mail from 'nodemailer/lib/mailer';
 import nodemailer from 'nodemailer';

src/notification/twitter.ts

@@ -1,5 +1,5 @@
 import {Config} from '../config';
-import {Link} from '../store/model';
+import {Link} from '../store/model/types';
 import {Logger} from '../logger';
 import Twitter from 'twitter';
 

src/store/lookup.ts

@@ -1,5 +1,5 @@
 import {Browser, Page, Response} from 'puppeteer';
-import {Link, Store} from './model';
+import {Link, Store} from './model/types';
 import {closePage, delay, getSleepTime} from '../util';
 import {Config} from '../config';
 import {Logger} from '../logger';
@@ -43,6 +43,10 @@ function filterSeries(series: string) {
  * @param store Vendor of graphics cards.
  */
 async function lookup(browser: Browser, store: Store) {
+	if (Config.store.stores.length > 0 && !Config.store.stores.includes(store.name)) {
+		return;
+	}
+
 	/* eslint-disable no-await-in-loop */
 	for (const link of store.links) {
 		if (!filterSeries(link.series)) {

src/store/model/adorama.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const Adorama: Store = {
 	labels: {

src/store/model/amazon-ca.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const AmazonCa: Store = {
 	labels: {

src/store/model/amazon.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const Amazon: Store = {
 	labels: {

src/store/model/asus.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const Asus: Store = {
 	labels: {

src/store/model/bandh.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const BAndH: Store = {
 	labels: {

src/store/model/bestbuy.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const BestBuy: Store = {
 	labels: {

src/store/model/evga-eu.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const EvgaEu: Store = {
 	labels: {

src/store/model/evga.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const Evga: Store = {
 	labels: {

src/store/model/helpers/nvidia.ts

@@ -1,7 +1,7 @@
 import {Browser, Response} from 'puppeteer';
 import {NvidiaRegionInfo, regionInfos} from '../nvidia';
 import {Config} from '../../../config';
-import {Link} from '../store';
+import {Link} from '../types';
 import {Logger} from '../../../logger';
 import open from 'open';
 import {timestampUrlParameter} from '../../timestamp-url-parameter';

src/store/model/index.ts

@@ -6,19 +6,16 @@ import {Asus} from './asus';
 import {BAndH} from './bandh';
 import {BestBuy} from './bestbuy';
 import {BestBuyCa} from './bestbuy-ca';
-import {Config} from '../../config';
 import {Evga} from './evga';
 import {EvgaEu} from './evga-eu';
-import {Logger} from '../../logger';
 import {MicroCenter} from './microcenter';
 import {NewEgg} from './newegg';
 import {NewEggCa} from './newegg-ca';
 import {Nvidia} from './nvidia';
 import {OfficeDepot} from './officedepot';
-import {Store} from './store';
 import {Zotac} from './zotac';
 
-const masterList = new Map([
+export const storeList = new Map([
 	[Adorama.name, Adorama],
 	[Amazon.name, Amazon],
 	[AmazonCa.name, AmazonCa],
@@ -36,20 +33,19 @@ const masterList = new Map([
 	[Zotac.name, Zotac]
 ]);
 
-const list = new Map();
-
-for (const name of Config.store.stores) {
-	if (masterList.has(name)) {
-		list.set(name, masterList.get(name));
-	} else {
-		const logString = `No store named ${name}, skipping.`;
-		Logger.warn(logString);
+const brands = new Set();
+const series = new Set();
+for (const store of storeList.values()) {
+	for (const link of store.links) {
+		brands.add(link.brand);
+		series.add(link.series);
 	}
 }
 
-const logString = `Selected stores: ${Array.from(list.keys()).join(', ')}`;
-Logger.info(logString);
-
-export const Stores = Array.from(list.values()) as Store[];
+export function getAllBrands() {
+	return Array.from(brands);
+}
 
-export * from './store';
+export function getAllSeries() {
+	return Array.from(series);
+}

src/store/model/microcenter.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const MicroCenter: Store = {
 	labels: {

src/store/model/newegg-ca.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const NewEggCa: Store = {
 	labels: {

src/store/model/newegg.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const NewEgg: Store = {
 	labels: {

src/store/model/nvidia.ts

@@ -1,5 +1,5 @@
 import {generateLinks, generateSetupAction} from './helpers/nvidia';
-import {Store} from './store';
+import {Store} from './types';
 
 // Region/country set by config file, silently ignores null / missing values and defaults to usa
 

src/store/model/officedepot.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const OfficeDepot: Store = {
 	labels: {

src/store/model/zotac.ts

@@ -1,4 +1,4 @@
-import {Store} from './store';
+import {Store} from './types';
 
 export const Zotac: Store = {
 	labels: {