feat(modlog): Implement normalizing raw modlog data

Refactor ModAction to use data from either mod notes or modlog

.dockerignore

@@ -8,11 +8,12 @@ coverage
 .idea
 *.bak
 *.sqlite
+*.sqlite*
 *.json
 *.json5
 *.yaml
 *.yml
-
+*.env
 
 # exceptions
 !heroku.yml

.github/push-hook-sample.json

@@ -0,0 +1,3 @@
+{
+  "ref": "refs/heads/edge"
+}

.github/workflows/publishImage.yml

@@ -1,4 +1,14 @@
-name: Publish Docker image to Dockerhub
+name: Publish Docker image to registries
+
+# Builds image and tags based on the type of push event:
+# * branch push -> tag is branch name IE context-mod:edge
+# * release (tag) -> tag is release name IE context-mod:0.13.0
+#
+# Then pushes tagged images to multiple registries
+#
+# Based on
+# https://github.com/docker/build-push-action/blob/master/docs/advanced/push-multi-registries.md
+# https://github.com/docker/metadata-action
 
 on:
   push:
@@ -13,8 +23,12 @@ on:
 
 jobs:
   push_to_registry:
-    name: Push Docker image to Docker Hub
+    name: Build and Push Docker image to registries
     runs-on: ubuntu-latest
+    # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+    permissions:
+      packages: write
+      contents: read
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
@@ -25,12 +39,22 @@ jobs:
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@v3
         with:
-          images: foxxmd/context-mod
+          images: |
+            foxxmd/context-mod
+            ghcr.io/foxxmd/context-mod
           # generate Docker tags based on the following events/attributes
           tags: |
             type=raw,value=latest,enable=${{ endsWith(github.ref, 'master') }}
@@ -40,7 +64,8 @@ jobs:
             latest=false
       
       - name: Build and push Docker image
-        uses: docker/build-push-action@v2
+        if: ${{ !env.ACT }}
+        uses: docker/build-push-action@v3
         with:
           context: .
           push: ${{ github.event_name != 'pull_request' }}

.gitignore

@@ -336,6 +336,7 @@ web_modules/
 # dotenv environment variables file
 .env
 .env.test
+*.env
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -391,6 +392,7 @@ dist
 *.json5
 
 !src/Schema/*.json
+!.github/push-hook-sample.json
 !docs/**/*.json5
 !docs/**/*.yaml
 !docs/**/*.json

Dockerfile

@@ -120,6 +120,10 @@ ENV NPM_CONFIG_LOGLEVEL debug
 # can set database to use more performant better-sqlite3 since we control everything
 ENV DB_DRIVER=better-sqlite3
 
+# NODE_ARGS are expanded after `node` command in the entrypoint IE "node {NODE_ARGS} src/index.js run"
+# by default enforce better memory mangement by limiting max long-lived GC space to 512MB
+ENV NODE_ARGS="--max_old_space_size=512"
+
 ARG webPort=8085
 ENV PORT=$webPort
 EXPOSE $PORT

README.md

@@ -30,6 +30,9 @@ Feature Highlights for **Moderators:**
 * Event notification via Discord
 * [**Web interface**](#web-ui-and-screenshots) for monitoring, administration, and oauth bot authentication
 * [**Placeholders**](/docs/subreddit/actionTemplating.md) (like automoderator) can be configured via a wiki page or raw text and supports [mustache](https://mustache.github.io) templating
+* [**Partial Configurations**](/docs/subreddit/components/README.md#partial-configurations) -- offload parts of your configuration to shared locations to consolidate logic between multiple subreddits
+* [Guest Access](/docs/subreddit/README.md#guest-access) enables collaboration and easier setup by allowing temporary access
+* [Toxic content prediction](/docs/subreddit/components/README.md#moderatehatespeechcom-predictions) using [moderatehatespeech.com](https://moderatehatespeech.com) machine learning model
 
 Feature highlights for **Developers and Hosting (Operators):**
 
@@ -43,6 +46,7 @@ Feature highlights for **Developers and Hosting (Operators):**
   * Historical statistics
 * [Docker container support](/docs/operator/installation.md#docker-recommended)
 * Easy, UI-based [OAuth authentication](/docs/operator/addingBot.md) for adding Bots and moderator dashboard
+* Integration with [InfluxDB](https://www.influxdata.com) for detailed [time-series metrics](/docs/operator/database.md#influx) and a pre-built [Grafana](https://grafana.com) [dashboard](/docs/operator/database.md#grafana)
 
 # Table of Contents
 
@@ -132,6 +136,10 @@ Moderator view/invite and authorization:
 
 ![Invite View](docs/images/oauth-invite.jpg)
 
+A similar helper and invitation experience is available for adding **subreddits to an existing bot.**
+
+![Subreddit Invite View](docs/images/subredditInvite.jpg)
+
 ### Configuration Editor
 
 A built-in editor using [monaco-editor](https://microsoft.github.io/monaco-editor/) makes editing configurations easy:
@@ -145,6 +153,13 @@ A built-in editor using [monaco-editor](https://microsoft.github.io/monaco-edito
 
 ![Configuration View](docs/images/editor.jpg)
 
+### [Grafana Dashboard](/docs/operator/database.md#grafana)
+
+* Overall stats (active bots/subreddits, api calls, per second/hour/minute activity ingest)
+* Over time graphs for events, per subreddit, and for individual rules/check/actions
+
+![Grafana Dashboard](/docs/images/grafana.jpg)
+
 ## License
 
 [MIT](/LICENSE)

act.env.example

@@ -0,0 +1,3 @@
+GITHUB_TOKEN=
+DOCKERHUB_USERNAME=
+DOCKER_PASSWORD=

docker/root/etc/services.d/node/run

@@ -2,6 +2,8 @@
 
 # used https://github.com/linuxserver/docker-plex as a template
 
+# NODE_ARGS can be passed by ENV in docker command like "docker run foxxmd/context-mod -e NODE_ARGS=--optimize_for_size"
+
 exec \
 	s6-setuidgid abc \
-	/usr/local/bin/node /app/src/index.js run
+	/usr/local/bin/node $NODE_ARGS /app/src/index.js run

docs/README.md

@@ -152,6 +152,7 @@ An **Action** is some action the bot can take against the checked Activity (comm
 
 * For **Operator/Bot maintainers** see **[Operation Guide](/docs/operator/README.md)**
 * For **Moderators** 
+  * Start with the [Subreddit/Moderator docs](/docs/subreddit/README.md) or [Moderator Getting Started guide](/docs/subreddit/gettingStarted.md)
   * Refer to the [Subreddit Components Documentation](/docs/subreddit/components) or the [subreddit-ready examples](/docs/subreddit/components/subredditReady)
   * as well as the [schema](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) which has
     * fully annotated configuration data/structure

docs/development.md

@@ -1,5 +1,17 @@
 TODO add more development sections...
 
+# Developing/Testing Github Actions
+
+Use [act](https://github.com/nektos/act) to run Github actions locally.
+
+An example secrets file can be found in the project working directory at [act.env.example](act.env.example)
+
+Modify [push-hook-sample.json](.github/push-hook-sample.json) to point to the local branch you want to run a `push` event trigger on, then run this command from the project working directory:
+
+```bash
+act -e .github/push-hook-sample.json --secret-file act.env
+```
+
 # Mocking Reddit API
 
 Using [MockServer](https://www.mock-server.com/)

docs/operator/README.md

@@ -21,7 +21,7 @@ They are responsible for configuring the software at a high-level and managing a
 
 # Overview
 
-CM is composed of two applications that operate indepedently but are packaged together such that they act as one piece of software:
+CM is composed of two applications that operate independently but are packaged together such that they act as one piece of software:
 
 * **Server** -- Responsible for **running the bot(s)** and providing an API to retrieve information on and interact with them EX start/stop bot, reload config, retrieve operational status, etc.
 * **Client** -- Responsible for serving the **web interface** and handling the bot oauth authentication flow between operators and subreddits/bots.

docs/operator/configuration.md

@@ -136,6 +136,8 @@ You will need have this information available:
 
 See the [**example minimum configuration** below.](#minimum-config)
 
+This configuration can also be **generated** by CM if you start CM with **no configuration defined** and visit the web interface.
+
 # Bots
 
 Configured using the `bots` top-level property. Bot configuration can override and specify many more options than are available at the operator-level. Many of these can also set the defaults for each subreddit the bot runs:

docs/operator/database.md

@@ -130,3 +130,59 @@ retention: 2000
 runs:
   ...
 ```
+
+# Influx
+
+ContextMod supports writing detailed time-series data to [InfluxDB](https://www.influxdata.com/). 
+
+This data can be used to monitor the overall health, performance, and metrics for a ContextMod server. Currently, this data can **only be used by an Operator** as it requires access to the operator configuration and CM instance.
+
+CM supports InfluxDB OSS > 2.3 or InfluxDB Cloud.
+
+**Note:** This is an **advanced feature** and assumes you have enough technical knowledge to follow the documentation provided by each application to deploy and configure them. No support is guaranteed for installation, configuration, or use of Influx and Grafana.
+
+## Supported Metrics
+
+TBA
+
+## Setup
+
+### InfluxDB OSS
+
+* Install [InfluxDB](https://docs.influxdata.com/influxdb/v2.3/install/)
+* [Configure InfluxDB using the UI](https://docs.influxdata.com/influxdb/v2.3/install/#set-up-influxdb-through-the-ui)
+  * You will need **Username**, **Password**, **Organization Name**, and **Bucket Name** later for Grafana setup so make sure to record them somewhere
+* [Create a Token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) with enough permissions to write/read to the bucket you configured
+  * After the token is created **view/copy the token** to clipboard by clicking the token name. You will need this for Grafana setup.
+
+### ContextMod
+
+Add the following block to the top-level of your operator configuration:
+
+```yaml
+influxConfig:
+  credentials:
+    url: 'http://localhost:8086' # URL to your influx DB instance
+    token: '9RtZ5YZ6bfEXAMPLENJsTSKg==' # token created in the previous step
+    org: MyOrg # organization created in the previous step
+    bucket: contextmod # name of the bucket created in the previous step
+```
+
+## Grafana
+
+A pre-built dashboard for [Grafana](https://grafana.com) can be imported to display overall metrics/stats using InfluxDB data.
+
+![Grafana Dashboard](/docs/images/grafana.jpg)
+
+* Create a new Data Source using **InfluxDB** type
+  * Choose **Flux** for the **Query Language**
+  * Fill in the details for **URL**, **Basic Auth Details** and **InfluxDB Details** using the data you created in the [Influx Setup step](#influxdb-oss)
+  * Set **Min time interval** to `60s`
+  * Click **Save and test**
+* Import Dashboard
+  * **Browse** the Dashboard pane
+  * Click **Import** and **upload** the [grafana dashboard json file](/docs/operator/grafana.json)
+    * Chose the data source you created from the **InfluxDB CM** dropdown
+    * Click **Import**
+
+The dashboard can be filtered by **Bots** and **Subreddits** dropdowns at the top of the page to get more specific details.

docs/operator/gettingStarted.md

@@ -4,9 +4,7 @@ This getting started guide is for **Operators** -- that is, someone who wants to
 
 * [Installation](#installation)
 * [Create a Reddit Client](#create-a-reddit-client)
-* [Create a Minimum Configuration](#create-a-minimum-configuration)
-  * [Local Installation](#local-installation)
-  * [Docker Installation](#docker-installation)
+* [Start ContextMod](#start-contextmod)
 * [Add a Bot to CM](#add-a-bot-to-cm)
 * [Access The Dashboard](#access-the-dashboard)
 * [What's Next?](#whats-next)
@@ -19,29 +17,25 @@ Follow the [installation](/docs/operator/installation.md) documentation. It is r
 
 [Create a reddit client](/docs/operator/README.md#provisioning-a-reddit-client)
 
-# Create a Minimum Configuration
+# Start ContextMod 
 
-Using the information you received in the previous step [create a minimum file configuration](/docs/operator/configuration.md#minimum-configuration) save it as `config.yaml` somewhere.
+Start CM using the example command from your [installation](#installation) and visit http://localhost:8085
 
-# Start ContextMod With Configuration
+The First Time Setup page will ask you to input:
 
-## Local Installation
+* Client ID (from [Create a Reddit Client](#create-a-reddit-client))
+* Client Secret (from [Create a Reddit Client](#create-a-reddit-client))
+* Operator -- this is the username of your main Reddit account.
 
-If you [installed CM locally](/docs/installation.md#locally) move your configuration file `config.yaml` to the root of the project directory (where `package.json`) is located.
-
-From the root directory run this command to start CM
-
-```
-node src/index.js run
-```
-
-## Docker Installation
-
-If you [installed CM using Docker](/docs/installation.md#docker-recommended) make note of the directory you saved your minimum configuration to and substitute its full path for `host/path/folder` in the docker command show in the [docker install directions](/docs/operator/installation.md#docker-recommended)
+**Write Config** and then restart CM. You have now created the [minimum configuration](/docs/operator/configuration.md#minimum-configuration) required to run CM.
 
 # Add A Bot to CM
 
-Once CM is up and running use the [CM OAuth Helper](/docs/operator/addingBot.md#cm-oauth-helper-recommended) to add authorize and add a Bot to your CM instance.
+You should automatically be directed to the [Bot Invite Helper](/docs/operator/addingBot.md#cm-oauth-helper-recommended) used to authorize and add a Bot to your CM instance.
+
+Follow the directions here and **create an Authorization Invite** at the bottom of the page. 
+
+Next, login to Reddit with the account you will be using as the Bot and then visit the **Authorization Invite** link you created. Follow the steps there to finish adding the Bot to your CM instance.
 
 # Access The Dashboard
 
@@ -57,4 +51,4 @@ As an operator you should familiarize yourself with how the [operator configurat
 
 If you are also the moderator of the subreddit the bot will be running you should check out the [moderator getting started guide.](/docs/subreddit/gettingStarted.md#setup-wiki-page)
 
-You might also be interested in these [quick tips for using the web interface](/docs/webInterface.md)
+You might also be interested in these [quick tips for using the web interface](/docs/webInterface.md). Additionally, on the dashboard click the **Help** button at the top of the page to get a guided tour of the dashboard.

docs/operator/installation.md

@@ -8,15 +8,19 @@ ContextMod can be run on almost any operating system but it is recommended to us
 
 PROTIP: Using a container management tool like [Portainer.io CE](https://www.portainer.io/products/community-edition) will help with setup/configuration tremendously.
 
-### [Dockerhub](https://hub.docker.com/r/foxxmd/context-mod)
+Images available from these registeries:
 
-An example of starting the container using the [minimum configuration](/docs/operator/operatorConfiguration.md#minimum-config) with a [configuration file](/docs/operator/operatorConfiguration.md#defining-configuration-via-file):
+* [Dockerhub](https://hub.docker.com/r/foxxmd/context-mod) - `docker.io/foxxmd/context-mod`
+* [GHCR](https://github.com/foxxmd/context-mod/pkgs/container/context-mod) - `ghcr.io/foxxmd/context-mod`
+
+An example of starting the container using the [minimum configuration](/docs/operator/configuration.md#minimum-config):
 
 * Bind the directory where your config file, logs, and database are located on your host machine into the container's default `DATA_DIR` by using `-v /host/path/folder:/config`
+  * Note: **You must do this** or else your configuration will be lost next time your container is updated.
 * Expose the web interface using the container port `8085`
 
 ```
-docker run -d -v /host/path/folder:/config -p 8085:8085 foxxmd/context-mod
+docker run -d -v /host/path/folder:/config -p 8085:8085 ghcr.io/foxxmd/context-mod:latest
 ```
 
 The location of `DATA_DIR` in the container can be changed by passing it as an environmental variable EX `-e "DATA_DIR=/home/abc/config`
@@ -33,7 +37,7 @@ To get the UID and GID for the current user run these commands from a terminal:
 * `id -g` -- prints GID
 
 ```
-docker run -d -v /host/path/folder:/config -p 8085:8085 -e PUID=1000 -e PGID=1000 foxxmd/context-mod
+docker run -d -v /host/path/folder:/config -p 8085:8085 -e PUID=1000 -e PGID=1000 ghcr.io/foxxmd/context-mod:latest
 ```
 
 ## Locally
@@ -76,3 +80,21 @@ Be aware that Heroku's [free dyno plan](https://devcenter.heroku.com/articles/fr
 * The **Worker** dyno **will not** go to sleep but you will NOT be able to access the web interface. You can, however, still see how Cm is running by reading the logs for the dyno.
 
 If you want to use a free dyno it is recommended you perform first-time setup (bot authentication and configuration, testing, etc...) with the **Web** dyno, then SWITCH to a **Worker** dyno so it can run 24/7.
+
+# Memory Management
+
+Node exhibits [lazy GC cleanup](https://github.com/FoxxMD/context-mod/issues/90#issuecomment-1190384006) which can result in memory usage for long-running CM instances increasing to unreasonable levels. This problem does not seem to be an issue with CM itself but with Node's GC approach. The increase does not affect CM's performance and, for systems with less memory, the Node *should* limit memory usage based on total available.
+
+In practice CM uses ~130MB for a single bot, single subreddit setup. Up to ~350MB for many (10+) bots or many (20+) subreddits.
+
+If you need to reign in CM's memory usage for some reason this can be addressed by setting an upper limit for memory usage with `node` args by using either:
+
+**--max_old_space_size=**
+
+Value is megabytes. This sets an explicit limit on GC memory usage.
+
+This is set by default in the [Docker](#docker-recommended) container using the env `NODE_ARGS` to `--max_old_space_size=512`. It can be disabled by overriding the ENV.
+
+**--optimize_for_size**
+
+Tells Node to optimize for (less) memory usage rather than some performance optimizations. This option is not memory size dependent. In practice performance does not seem to be affected and it reduces (but not entirely prevents) memory increases over long periods.

docs/subreddit/README.md

@@ -0,0 +1,95 @@
+This section is for **reddit moderators**. It covers how to use a CM bot for your subreddit.
+
+If you are trying to run a ContextMod instance (the actual software) please refer to the [operator section](/docs/operator/README.md).
+
+# Table of Contents
+
+* [Overview](#overview)
+  * [Your Relationship to CM](#your-relationship-to-cm)
+    * [Operator](#operator)
+    * [Your Bot](#your-bot)
+* [Getting Started](#getting-started)
+* [Accessing The Bot](#accessing-the-bot)
+  * [Editing The Bot](#editing-the-bot)
+* [Configuration](#configuration)
+* [Guest Access](#guest-access)
+
+# Overview
+
+The Context Mod **software** can manage multiple **bots** (reddit accounts used as bots, like `/u/MyCMBot`). Each bot can manage (run) multiple **subreddits** which is determined by the subreddits the account is a moderator of.
+
+You, the moderator of a subreddit a CM bot runs in, can access/manage the Bot using the CM software's [web interface](/docs/images/subredditStatus.jpg) and control its behavior using the [web editor.](/docs/images/editor.jpg)
+
+## Your Relationship to CM
+
+It is important to understand the relationship between you (the moderator), the bot, and the operator (the person running the CM software).
+
+The easiest way to think about this is in relation to how you use Automoderator and interact with Reddit as a moderator. As an analogy:
+
+### Operator
+
+The operator is the person running the actual server/machine the Context Mod software is on. 
+
+They are best thought of as **Reddit:**
+
+* Mostly hands-off when it comes to the bot and interacting with your subreddit
+* You must interact with Reddit first before you can use automoderator (login, create a subreddit, etc...)
+
+Unlike reddit, though, there is a greater level of trust required between you and the Operator because what you make the Bot do ultimately affects the Operator since they are the ones actually running your Bot and making API calls to reddit.
+
+### Your Bot
+
+Your bot is like an **invite-only version of Automoderator**:
+
+* Unlike automoderator, you **must** interact with the Operator in order to get the bot working. It is not public for anyone to use.
+* Like automoderator, you **must** create a [configuration](/docs/subreddit/components/README.md) for it do anything.
+  * The bot does not come pre-configured for you. It is a blank slate and requires user input to be useful.
+* Also like automoderator, you are **entirely in control of the bot.**
+  * You can start, stop, and edit its behavior at any time without needing to communicate with the Operator.
+  * CM provides you _tools_, different ways the Bot can detect patterns in your subreddit/users as well as actions it can, and you can decide to use them however you want.
+* Your bot is **only accessible to moderators of your subreddit.**
+
+# Getting Started
+
+The [Getting Started](/docs/subreddit/gettingStarted.md) guide lays out the steps needed to go from nothing to a working Bot. If you are a moderator new to Context Mod this is where you want to begin.
+
+# Accessing The Bot
+
+All bot management and editing is done through the [web interface.](/docs/images/subredditStatus.jpg) The URL used for accessing this interface is given to you by the **Operator** once they have agreed to host your bot/subreddit.
+
+NOTE: This interface is **only access to moderators of your subreddit** and [guests.](#guest-access) You must login to the web interface **with your moderator account** in order to access it.
+
+A **guided tour** that helps show how to manage the bot at a high-level is available on the web interface by clicking the **Help** button in the top-right of the page.
+
+## Editing The Bot
+
+Find the [editor in the web interface](/docs/webInterface.md#editingupdating-your-config) to access the built-in editor for the bot.
+
+[The editor](/docs/images/editor.jpg) should be your all-in-one location for viewing and editing your bot's behavior. **It is equivalent to Automoderator's editor page.**
+
+The editor features:
+
+* syntax validation and highlighting
+* configuration auto-complete and documentation (hover over properties)
+* built-in validation using Microsoft Word "squiggly lines" indicators and an error list at the bottom of the window
+* built-in saving (at the top of the window)
+
+# Configuration
+
+Use the [Configuration Reference](/docs/subreddit/components/README.md) to learn about all the different components available for building a CM configuration.
+
+Additionally, refer to [How It Works](/docs/README.md#how-it-works) and [Core Concepts](/docs/README.md#concepts) to learn the basic of CM configuration.
+
+After you have the basics under your belt you could use the [subreddit-reddit example configurations](/docs/subreddit/components/subredditReady) to familiarize yourself with a complete configuration and ways to use CM.
+
+# Guest Access
+
+CM supports **Guest Access**. Reddit users who are given Guest Access to your bot are allowed to access the web interface even though they are not moderators.
+
+Additionally, they can edit the subreddit's config using the bot. If a Guest edits your config their username will be mentioned in the wiki page edit reason.
+
+Guests can do everything a regular mod can except view/add/remove Guest. They can be removed at any time or set with an expiration date that their access is removed on.
+
+**Guests are helpful if you are new to CM and know reddit users that can help you get started.**
+
+[Add guests from the Subreddit tab in the main interface.](/docs/images/guests.jpg)

docs/subreddit/actionTemplating.md

@@ -1,47 +1,150 @@
-Actions that can submit text (Report, Comment, UserNote) will have their `content` values run through a [Mustache Template](https://mustache.github.io/). This means you can insert data generated by Rules into your text before the Action is performed.
+Actions that can submit text (Report, Comment, UserNote, Message, Ban, Submission) will have their `content` values run through a [Mustache Template](https://mustache.github.io/). This means you can insert data generated by Rules into your text before the Action is performed.
 
 See here for a [cheatsheet](https://gist.github.com/FoxxMD/d365707cf99fdb526a504b8b833a5b78) and [here](https://www.tsmean.com/articles/mustache/the-ultimate-mustache-tutorial/) for a more thorough tutorial.
 
+# Template Data
+
+Some data can always be accessed at the top-level. Example
+
+```
+This action was run from {{manager}} in Check {{check}}.
+
+The bot intro post is {{botLink}}
+
+Message the moderators of this subreddit using this [compose link]({{modmailLink}})
+```
+
+
+
+|     Name      |                                         Description                                         |                                                                         Example                                                                          |
+|---------------|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `manager`     | The name of the subreddit the bot is running in                                             | mealtimevideos                                                                                                                                           |
+| `check`       | The name of the Check that was triggered                                                    | myCheck                                                                                                                                                  |
+| `botLink`     | A link to the bot introduction                                                              | https://www.reddit.com/r/ContextModBot/comments/otz396/introduction_to_contextmodbot                                                                     |
+| `modmailLink` | A link that opens reddit's DM compose with the subject line as the Activity being processed | https://www.reddit.com/message/compose?to=/r/mealtimevideos&message=https://www.reddit.com/r/ContextModBot/comments/otz396/introduction_to_contextmodbot |
+
+
+## Activity Data
+
+**Activity data can be accessed using the `item` variable.** Example
+
+```
+This activity is a {{item.kind}} with {{item.votes}} votes, created {{item.age}} ago.
+```
+Produces:
+
+> This activity is a submission with 10 votes created 5 minutes ago.
+
+### Common
+
 All Actions with `content` have access to this data:
 
-```json5
+|     Name     |                                             Description                                             |                         Example                          |
+|--------------|-----------------------------------------------------------------------------------------------------|----------------------------------------------------------|
+| `kind`       | The Activity type (submission or comment)                                                           | submission                                               |
+| `author`     | Name of the Author of the Activity being processed                                                  | FoxxMD                                                   |
+| `permalink`  | URL to the Activity                                                                                 | https://reddit.com/r/mySuibreddit/comments/ab23f/my_post |
+| `votes`      | Number of upvotes                                                                                   | 69                                                       |
+| `age`        | The age of the Activity in a [human friendly format](https://day.js.org/docs/en/durations/humanize) | 5 minutes                                                |
+| `subreddit`  | The name of the subreddit the Activity is from                                                      | mealtimevideos                                           |
+| `id`         | The `Reddit Thing` ID for the Activity                                                              | t3_0tin1                                                 |
+| `title`      | As comments => the body of the comment. As Submission => title                                      | Test post please ignore                                  |
+| `shortTitle` | The same as `title` but truncated to 15 characters                                                  | test post pleas...                                       |
 
-{
-    item: {
-        kind: 'string', // the type of item (comment/submission)
-        author: 'string', // name of the item author (reddit user)
-        permalink: 'string', // a url to the item
-        url: 'string', // if the item is a Submission then its URL (external for link type submission, reddit link for self-posts)
-        title: 'string', // if the item is a Submission, then the title of the Submission,
-        botLink: 'string' // a link to the bot's FAQ
-    },
-    rules: {
-        // contains all rules that were run and are accessible using the name, lowercased, with all spaces/dashes/underscores removed
-    }
-}
+### Submissions
+
+If the **Activity** is a Submission these additional properties are accessible:
+
+| Name          | Description                                                     | Example                 |
+|---------------|-----------------------------------------------------------------|-------------------------|
+| `upvoteRatio` | The upvote ratio                                                | 100%                    |
+| `nsfw`        | If the submission is marked as NSFW                             | true                    |
+| `spoiler`     | If the submission is marked as a spoiler                        | true                    |
+| `url`         | If the submission was a link then this is the URL for that link | http://example.com      |
+| `title`       | The title of the submission                                     | Test post please ignore |
+
+### Comments
+
+If the **Activity** is a Comment these additional properties are accessible:
+
+| Name | Description                                                  | Example |
+|------|--------------------------------------------------------------|---------|
+| `op` | If the Author is the OP of the Submission this comment is in | true    |
+
+### Moderator
+
+If the **Activity** occurred in a Subreddit the Bot moderates these properties are accessible:
+
+| Name          | Description                         | Example |
+|---------------|-------------------------------------|---------|
+| `reports`     | The number of reports recieved      | 1       |
+| `modReports`  | The number of reports by moderators | 1       |
+| `userReports` | The number of reports by users      | 1       |
+
+## Rule Data
+
+### Summary
+
+A summary of what rules were processed and which were triggered, with results, is available using the `ruleSummary` variable. Example:
 
 ```
+A summary of rules processed for this activity:
 
-The properties of `rules` are accessible using the name, lower-cased, with all spaces/dashes/underscores. If no name is given `kind` is used as `name` Example:
-
+{{ruleSummary}}
 ```
 
-"rules": [
-  {
-    "name": "My Custom-Recent Activity Rule", // mycustomrecentactivityrule
-    "kind": "recentActivity"
-  },
-  {
-    // name = repeatsubmission
-    "kind": "repeatActivity",
-  }
-]
+Would produce:
+> A summary of rules processed for this activity:
+> 
+> * namedRegexRule - ✘
+> * nameAttributionRule - ✓ - 1 Attribution(s) met the threshold of < 20%, with 1 (3%) of 32 Total -- window: 6 months
+> * noXPost ✓ - ✓ 1 of 1 unique items repeated <= 3 times, largest repeat: 1
+
+
+### Individual
+
+Individual **Rules** can be accessed using the name of the rule, **lower-cased, with all spaces/dashes/underscores.** Example:
 
 ```
+Submission was repeated {{rules.noxpost.largestRepeat}} times
+```
+Produces
 
-**To see what data is available for individual Rules [consult the schema](#configuration) for each Rule.**
+> Submission was repeated 7 times
 
-#### Quick Templating Tutorial
+## Action Data
+
+### Summary
+
+A summary of what actions have already been run **when the template is rendered**  is available using the `actionSummary` variable. It is therefore important that the Action you want to produce the summary is run **after** any other Actions you want to get a summary for.
+
+Example:
+
+```
+A summary of actions processed for this activity, so far:
+
+{{actionSummary}}
+```
+
+Would produce:
+> A summary of actions processed for this activity, so far:
+>
+> * approve - ✘ - Item is already approved??
+> * lock - ✓
+> * modnote - ✓ - (SOLID_CONTRIBUTOR) User is good
+
+### Individual
+
+Individual **Actions** can be accessed using the name of the action, **lower-cased, with all spaces/dashes/underscores.** Example:
+
+```
+User was banned for {{actions.exampleban.duration}} for {{actions.exampleban.reason}}
+```
+Produces
+
+> User was banned for 4 days for toxic behavior
+
+# Quick Templating Tutorial
 
 As a quick example for how you will most likely be using templating -- wrapping a variable in curly brackets, `{{variable}}`, will cause the variable value to be rendered instead of the brackets:
 

docs/subreddit/components/README.md

@@ -21,6 +21,8 @@ This list is not exhaustive. [For complete documentation on a subreddit's config
     * [Author](#author)
     * [Regex](#regex)
     * [Repost](#repost)
+    * [Sentiment Analysis](#sentiment-analysis)
+    * [Toxic Content Prediction](#moderatehatespeechcom-predictions)
 * [Rule Sets](#rule-sets)
 * [Actions](#actions)
   * [Named Actions](#named-actions)
@@ -28,6 +30,7 @@ This list is not exhaustive. [For complete documentation on a subreddit's config
   * [List of Actions](#list-of-actions)
     * [Approve](#approve)
     * [Ban](#ban)
+    * [Submission](#submission)
     * [Comment](#comment)
     * [Contributor (Add/Remove)](#contributor)
     * [Dispatch/Delay](#dispatch)
@@ -66,6 +69,7 @@ This list is not exhaustive. [For complete documentation on a subreddit's config
     * [Check Order](#check-order)
     * [Rule Order](#rule-order)
   * [Configuration Re-use and Caching](#configuration-re-use-and-caching)
+  * [Partial Configurations](#partial-configurations)
 * [Subreddit-ready examples](#subreddit-ready-examples)
 
 # Runs
@@ -368,6 +372,18 @@ The **Repost** rule is used to find reposts for both **Submissions** and **Comme
 
 This rule is for searching **all of Reddit** for reposts, as opposed to just the history of the Author of the Activity being checked. If you only want to check for reposts by the Author of the Activity being checked you should use the [Repeat Activity](/docs/subreddit/components/repeatActivity) rule.
 
+### Sentiment Analysis
+
+[**Full Documentation**](/docs/subreddit/components/sentiment)
+
+The **Sentiment Rule** is used to determine the overall emotional intent (negative, neutral, positive) of a Submission or Comment by analyzing the actual text content of the Activity.
+
+### ModerateHateSpeech.com Predictions
+
+[**Full Documentation**](/docs/subreddit/components/mhs)
+
+ContextMod integrates with [moderatehatespeech.com](https://moderatehatespeech.com/) (MHS) [toxic content machine learning model](https://moderatehatespeech.com/framework/) through their API. This rule sends an Activity's content (title or body) to MHS which returns a prediction on whether the content is toxic and actionable by a moderator. Their model is [specifically trained for reddit content.](https://www.reddit.com/r/redditdev/comments/xdscbo/updated_bot_backed_by_moderationoriented_ml_for/)
+
 # Rule Sets
 
 The `rules` list on a `Check` can contain both `Rule` objects and `RuleSet` objects.
@@ -486,11 +502,30 @@ actions:
 
 ### Comment
 
-Reply to the Activity being processed with a comment. [Schema Documentation](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FCommentActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fmaster%2Fsrc%2FSchema%2FApp.json)
+Reply to an Activity with a comment. [Schema Documentation](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FCommentActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fmaster%2Fsrc%2FSchema%2FApp.json)
 
 * If the Activity is a Submission the comment is a top-level reply
 * If the Activity is a Comment the comment is a child reply
 
+#### Templating
+
+`content` can be [templated](#templating) and use [URL Tokens](#url-tokens)
+
+#### Targets
+
+Optionally, specify the Activity CM should reply to. **When not specified CM replies to the Activity being processed using `self`**
+
+Valid values: `self`, `parent`, or a Reddit permalink.
+
+`self` and `parent` are special targets that are relative to the Activity being processed:
+
+* When the Activity being processed is a **Submission** => `parent` logs a warning and does nothing
+* When the Activity being processed is a  **Comment**
+  * `self` => reply to Comment
+  * `parent` => make a top-level Comment in the **Submission** the Comment belong to
+
+If target is not self/parent then CM assumes the value is a **reddit permalink** and will attempt to make a Comment to that Activity
+
 ```yaml
 actions:
   - kind: comment
@@ -498,7 +533,71 @@ actions:
     distinguish: boolean # distinguish as a mod
     sticky: boolean # sticky comment
     lock: boolean # lock the comment after creation
+    targets: string # 'self' or 'parent' or 'https://reddit.com/r/someSubreddit/21nfdi....'
+```
 
+### Submission
+
+Create a Submission [Schema Documentation](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FSubmissionActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fmaster%2Fsrc%2FSchema%2FApp.json)
+
+The Submission type, Link or Self-Post, is determined based on the presence of `url` in the action's configuration.
+
+```yaml
+actions:
+  - kind: submission
+    title: string # required, the title of the submission. can be templated.
+    content: string # the body of the submission. can be templated
+    url: string # if specified the submission will be a Link Submission. can be templated
+    distinguish: boolean # distinguish as a mod
+    sticky: boolean # sticky comment
+    lock: boolean # lock the comment after creation
+    nsfw: boolean # mark submission as NSFW
+    spoiler: boolean # mark submission as a spoiler
+    flairId: string # flair template id for submission
+    flairText: string # flair text for submission
+    targets: string # 'self' or a subreddit name IE mealtimevideos
+```
+
+#### Templating
+
+`content`,`url`, and `title` can be [templated](#templating) and use [URL Tokens](#url-tokens)
+
+TIP: To create a Link Submission pointing to the Activity currently being processed use
+
+```yaml
+actions:
+  - kind: submission
+    url: {{item.permalink}}
+    # ...
+```
+
+#### Targets
+
+Optionally, specify the Subreddit the Submission should be made in. **When not specified CM uses `self`**
+
+Valid values: `self` or Subreddit Name
+
+* `self` => (**Default**) Create Submission in the same Subreddit of the Activity being processed
+* Subreddit Name => Create Submission in given subreddit IE `mealtimevideos`
+  * Your bot must be able to access and be able to post in the given subreddit
+
+Example: 
+
+```yaml
+actions:
+  - kind: comment
+    targets: mealtimevideos
+```
+
+To post to multiple subreddits use a list:
+
+```yaml
+actions:
+  - kind: comment
+    targets:
+      - self
+      - mealtimevideos
+      - anotherSubreddit 
 ```
 
 ### Contributor
@@ -600,31 +699,35 @@ Some other things to note:
 * If the `to` property is not specified then the message is sent to the Author of the Activity being processed
   * `to` may be a **User** (u/aUser) or a **Subreddit** (r/aSubreddit)
   * `to` **cannot** be a Subreddit when `asSubreddit: true` -- IE cannot send subreddit-to-subreddit messages
-* `content` can be [templated](#templating) and use [URL Tokens](#url-tokens)
+  * TIP: `to` can be templated -- to send a message to the subreddit the Activity being processed is in use `'r/{{item.subreddit}}'`
+* `content` and `title` can be [templated](#templating) and use [URL Tokens](#url-tokens)
 
 ```yaml
 actions:
   - kind: message
     asSubreddit: true
-    content: 'A message sent as the subreddit'
-    title: 'Title of the message'
-    to: 'u/aUser' # do not specify 'to' in order default to sending to Author of Activity being processed
+    content: 'A message sent as the subreddit' # can be templated
+    title: 'Title of the message' # can be templated
+    to: 'u/aUser' # do not specify 'to' in order default to sending to Author of Activity being processed. Can also be templated
 ```
 
 ### Remove
 
 Remove the Activity being processed. [Schema Documentation](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FRemoveActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fedge%2Fsrc%2FSchema%2FApp.json)
 
+* **note** can be [templated](#templating)
+* **reasonId** IDs can be found in the [editor](/docs/webInterface.md) using the **Removal Reasons** popup
+
+If neither note nor reasonId are included then no removal reason is added.
+
 ```yaml
 actions:
   - kind: remove
-    spam: boolean # optional, mark as spam on removal
+    spam: false # optional, mark as spam on removal
+    note: 'a moderator-readable note' # optional, a note only visible to moderators (new reddit only)
+    reasonId: '2n0f4674-365e-46d2-8fc7-a337d85d5340' # optional, the ID of a removal reason to add to the removal action (new reddit only)
 ```
 
-#### What About Removal Reason?
-
-Reddit does not support setting a removal reason through the API. Please complain in [r/modsupport](https://www.reddit.com/r/modsupport) or [r/redditdev](https://www.reddit.com/r/redditdev) to help get this added :)
-
 ### Report
 
 Report the Activity being processed. [Schema Documentation](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FReportActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fedge%2Fsrc%2FSchema%2FApp.json)
@@ -656,6 +759,8 @@ actions:
 
 ### Mod Note
 
+[**Full Documentation**](/docs/subreddit/components/modActions/README.md#mod-note-action)
+
 Add a [Mod Note](https://www.reddit.com/r/modnews/comments/t8vafc/announcing_mod_notes/) for the Author of the Activity.
 
 * `type` must be one of the [valid note labels](https://www.reddit.com/dev/api#POST_api_mod_notes): 
@@ -1064,7 +1169,7 @@ If the Check is using `AND` condition for its rules (default) then if either Rul
 
 **It is therefore advantageous to list your lightweight Rules first in each Check.**
 
-### Configuration Re-use and Caching
+## Configuration Re-use and Caching
 
 ContextMod implements caching functionality for:
 
@@ -1088,6 +1193,116 @@ PROTIP: You can monitor the re-use of cache in the `Cache` section of your subre
 
 [Learn more about how Caching works](/docs/operator/caching.md)
 
+## Partial Configurations
+
+ContextMod supports fetching parts of a configuration (a **Fragment**) from an external source. Fragments are an advanced feature and should only be used by users who are familiar with CM's configuration syntax and understand the risks/downsides associates with fragmenting a configuration.
+
+**Fragments** are supported for:
+
+* [Runs](#runs)
+* [Checks](#checks)
+* [Rules](#rules)
+* [Actions](#actions)
+
+### Should You Use Partial Configurations?
+
+* **PROS**
+  * Consolidate shared configuration for many subreddits into one location
+  * Shared configuration can be updated independently of subreddits
+  * Allows sharing access to configuration outside of moderators of a specific subreddit or even reddit
+* **CONS**
+  * Editor does not currently support viewing, editing, or updating Fragments. Only the Fragment URL is visible in a Subreddit's configuration
+    * No editor support for viewing obscures "complete view" of configuration and makes editor less useful for validation
+  * Currently, editor cannot validate individual Fragments. They must be copy-pasted "in place" within a normal configuration.
+  * Using external (non-wiki) sources means **you** are responsible for the security/access to the fragment
+
+In general, Fragments should only be used to offload small, well-tested pieces of a configuration that can be shared between many subreddits. Examples:
+
+* A regex Rule for spam links
+* A Recent Activity Rule for reporting users from freekarma subreddits
+
+### Usage
+
+A Fragment may be either a special string or a Fragment object. The fetched Fragment can be either an object or an array of objects of the type of Fragment being replaced.
+
+**String**
+
+If value starts with `wiki:` then the proceeding value will be used to get a wiki page from the current subreddit
+
+* EX `wiki:botconfig/myFragment` tries to get `https://reddit.com/r/currentSubreddit/wiki/botconfig/myFragment`
+
+If the value starts with `wiki:` and ends with `|someValue` then `someValue` will be used as the base subreddit for the wiki page
+
+* EX `wiki:myFragment/test|ContextModBot` tries to get `https://reddit.com/r/ContextModBot/wiki/myFragment/test`
+
+If the value starts with `url:` then the value is fetched as an external url and expects raw text returned
+
+* EX `url:https://pastebin.com/raw/38qfL7mL` tries to get the text response of `https://pastebin.com/raw/38qfL7mL`
+
+**Object**
+
+The object contains:
+
+* `path` -- REQUIRED string following rules above
+* `ttl` -- OPTIONAL, number of seconds to cache the URL result. Defaults to `WikiTTL`
+
+#### Examples
+
+**Replacing A Rule with a URL Fragment**
+
+```yaml
+runs:
+- checks:
+  - name: Free Karma Alert
+    description: Check if author has posted in 'freekarma' subreddits
+    kind: submission
+    rules:
+      - 'url:https://gist.githubusercontent.com/FoxxMD/0e1ee1ab950ff4d1f0cd26172bae7f8f/raw/0ebfaca903e4a651827effac5775c8718fb6e1f2/fragmentRule.yaml'
+      - name: badSub
+        kind: recentActivity
+        useSubmissionAsReference: false
+        thresholds:
+          # if the number of activities (sub/comment) found CUMULATIVELY in the subreddits listed is
+          # equal to or greater than 1 then the rule is triggered
+          - threshold: '>= 1'
+            subreddits:
+              - MyBadSubreddit
+        window: 7 days
+      actions:
+      - kind: report
+        content: 'uses freekarma subreddits and bad subreddits'
+```
+
+**Replacing A Rule with a URL Fragment (Multiple)**
+
+```yaml
+runs:
+- checks:
+  - name: Free Karma Alert
+    description: Check if author has posted in 'freekarma' subreddits
+    kind: submission
+    rules:
+      - 'url:https://gist.githubusercontent.com/FoxxMD/0e1ee1ab950ff4d1f0cd26172bae7f8f/raw/0ebfaca903e4a651827effac5775c8718fb6e1f2/fragmentRuleArray.yaml'
+    actions:
+      - kind: report
+        content: 'uses freekarma subreddits and bad subreddits'
+```
+
+**Replacing A Rule with a Wiki Fragment**
+
+```yaml
+runs:
+- checks:
+  - name: Free Karma Alert
+    description: Check if author has posted in 'freekarma' subreddits
+    kind: submission
+    rules:
+      - 'wiki:freeKarmaFrag'
+    actions:
+      - kind: report
+        content: 'uses freekarma subreddits'
+```
+
 # Subreddit-Ready Examples
 
 Refer to the [Subreddit-Ready Examples](/docs/subreddit/components/subredditReady) section to find ready-to-use configurations for common scenarios (spam, freekarma blocking, etc...). This is also a good place to familiarize yourself with what complete configurations look like.

docs/subreddit/components/advancedConcepts/ruleSets.json5

@@ -31,7 +31,7 @@
               // if the nested rules pass the condition then the Rule Set triggers the Check
               //
               // AND = all nested rules must be triggered to make the Rule Set trigger
-              // AND = any of the nested Rules will be the Rule Set trigger
+              // OR = any of the nested Rules will be the Rule Set trigger
               "condition": "AND",
               // in this check we use an Attribution >10% on ONLY submissions, which is a lower requirement then the above attribution rule
               // and combine it with a History rule looking for low comment engagement

docs/subreddit/components/advancedConcepts/ruleSets.yaml

@@ -22,7 +22,7 @@ runs:
             # if the nested rules pass the condition then the Rule Set triggers the Check
             #
             # AND = all nested rules must be triggered to make the Rule Set trigger
-            # AND = any of the nested Rules will be the Rule Set trigger
+            # OR = any of the nested Rules will be the Rule Set trigger
           - condition: AND
             # in this check we use an Attribution >10% on ONLY submissions, which is a lower requirement then the above attribution rule
             # and combine it with a History rule looking for low comment engagement

docs/subreddit/components/author/authorFilter.json5

@@ -40,7 +40,7 @@
                   // for this to pass the Author of the Submission must not have the flair "Supreme Memer" and have the name "user1" or "user2"
                   {
                     "flairText": ["Supreme Memer"],
-                    "name": ["user1","user2"]
+                    "names": ["user1","user2"]
                   },
                   {
                     // for this to pass the Author of the Submission must not have the flair "Decent Memer"

docs/subreddit/components/author/authorFilter.yaml

@@ -30,7 +30,7 @@ runs:
                 # for this to pass the Author of the Submission must not have the flair "Supreme Memer" and have the name "user1" or "user2"
                 - flairText:
                     - Supreme Memer
-                  name:
+                  names:
                     - user1
                     - user2
                   # for this to pass the Author of the Submission must not have the flair "Decent Memer"

docs/subreddit/components/mhs/README.md

@@ -0,0 +1,165 @@
+# Table of Contents
+
+* [Overview](#overview)
+  * [MHS Predictions](#mhs-predictions)
+    * [Flagged](#flagged)
+    * [Confidence](#confidence)
+* [Usage](#usage)
+    * [Minimal/Default Config](#minimaldefault-config)
+    * [Full Config](#full-config)
+      * [Historical Matching](#historical-matching)
+* [Examples](#examples)
+
+# Overview
+
+[moderatehatespeech.com](https://moderatehatespeech.com/) (MHS) is a [non-profit initiative](https://moderatehatespeech.com/about/) to identify and fight toxic and hateful content online using programmatic technology such as machine learning models.
+
+They offer a [toxic content prediction model](https://moderatehatespeech.com/framework/)   specifically trained on and for [reddit content](https://www.reddit.com/r/redditdev/comments/xdscbo/updated_bot_backed_by_moderationoriented_ml_for/) as well as partnering [directly with subreddits.](https://moderatehatespeech.com/research/subreddit-program/).
+
+Context Mod leverages their [API](https://moderatehatespeech.com/docs/) for toxic content predictions in the **MHS Rule.**
+
+The **MHS Rule** sends an Activity's content (title or body) to MHS which returns a prediction on whether the content is toxic and actionable by a moderator.
+
+## MHS Predictions
+
+MHS's toxic content predictions return two indicators about the content it analyzed. Both are available as test conditions in ContextMod.
+
+### Flagged
+
+MHS returns a straight "Toxic or Normal" **flag** based on how it classifies the content.
+
+Example
+
+* `Normal` - "I love those pineapples"
+* `Toxic` - "why are we having all these people from shithole countries coming here"
+
+### Confidence
+
+MHS returns how **confident** it is of the flag classification on a scale of 0 to 100.
+
+Example
+
+"why are we having all these people from shithole countries coming here"
+
+* Flag = `Toxic`
+* Confidence = `97.12` -> The model is 97% confident the content is `Toxic`
+
+# Usage
+
+**An MHS Api Key is required to use this Rule**. An API Key can be acquired, for free, by creating an account at [moderatehatespeech.com](https://moderatehatespeech.com).
+
+The Key can be provided by the bot's Operator in the [bot config credentials](https://json-schema.app/view/%23/%23%2Fdefinitions%2FBotInstanceJsonConfig/%23%2Fdefinitions%2FBotCredentialsJsonConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fedge%2Fsrc%2FSchema%2FOperatorConfig.json) or in the subreddit's config in the top-level `credentials` property like this:
+
+```yaml
+credentials:
+  mhs:
+    apiKey: 'myMHSApiKey'
+
+# the rest of your config below
+polling:
+  # ...
+runs:
+  # ...
+```
+
+### Minimal/Default Config
+
+ContextMod provides a reasonable default configuration for the MHS Rule if you do not wish to configure it yourself. The default configuration will trigger the rule if the MHS prediction:
+
+* flags as `toxic`
+* with `90% or greater` confidence
+
+Example
+
+```yaml
+rules:
+  - kind: mhs
+    
+  # rest of your rules here...
+```
+
+### Full Config
+
+
+|   Property   |  Type   |                                        Description                                        | Default |
+|--------------|---------|-------------------------------------------------------------------------------------------|---------|
+| `flagged`    | boolean | Test whether content is flagged as toxic (true) or normal (false)                         | `true`  |
+| `confidence` | string  | Comparison against a number 0 to 100 representing  how confident MHS is in the prediction | `>= 90` |
+| `testOn`     | array   | Which parts of the Activity to send to MHS. Options: `title` and/or `body`                | `body`  |
+
+Example
+
+```yaml
+rules:
+  - kind: mhs
+    criteria:
+      flagged: true # triggers if MHs flags the content as toxic AND
+      confidence: '> 66' # MHS is 66% or more confident in its prediction
+      testOn:  # send the body of the activity to the MHS prediction service
+        - body
+```
+
+#### Historical Matching
+
+Like the [Sentiment](/docs/subreddit/components/sentiment#historical) and [Regex](/docs/subreddit/components/regex#historical) rules CM can also use MHS predictions to check content from the Author's history.
+
+Example
+
+```yaml
+rules:
+  - kind: mhs
+    # ...same config as above but can include below...
+    historical:
+      mustMatchCurrent: true # if true then CM will not check author's history unless current Activity matches MHS prediction criteria
+      totalMatching: '> 1' # comparison for how many activities in history must match to trigger the rule
+      window: 10 # specify the range of activities to check in author's history
+      criteria: #... if specified, overrides parent-level criteria
+```
+
+# Examples
+
+Report if MHS flags as toxic
+
+```yaml
+rules:
+  - kind: mhs
+actions:
+  - kind: report
+    content: 'MHS flagged => {{rules.mhs.summary}}'
+```
+
+Report if MHS flags as toxic with 95% confidence
+
+```yaml
+rules:
+  - kind: mhs
+    confidence: '>= 95'
+actions:
+  - kind: report
+    content: 'MHS flagged => {{rules.mhs.summary}}'
+```
+
+Report if MHS flags as toxic and at least 3 recent activities in last 10 from author's history are also toxic
+
+```yaml
+rules:
+  - kind: mhs
+    historical:
+      window: 10
+      mustMatchCurrent: true
+      totalMatching: '>= 3'
+actions:
+  - kind: report
+    content: 'MHS flagged => {{rules.mhs.summary}}'
+```
+
+Approve if MHS flags as NOT toxic with 95% confidence
+
+```yaml
+rules:
+  - kind: mhs
+    confidence: '>= 95'
+    flagged: false
+actions:
+  - kind: approve
+```

docs/subreddit/components/sentiment/README.md

@@ -0,0 +1,183 @@
+# Table of Contents
+
+* [Overview](#overview)
+  * [Pros And Cons](#pros-and-cons)
+  * [Technical Overview](#technical-overview)
+* [Sentiment Values](#sentiment-values)
+* [Usage](#usage)
+  * [Testing Sentiment Value](#testing-sentiment-value)
+    * [Numerical](#numerical)
+    * [Text](#text)
+  * [Sentiment Rule](#sentiment-rule)
+    * [Historical](#historical)
+* [Examples](#examples)
+
+# Overview
+
+[Sentiment Analysis](https://monkeylearn.com/sentiment-analysis/) (SA) is a form of [Natural Language Processing](https://monkeylearn.com/natural-language-processing/) (NLP) used to extract the overall [sentiment](https://www.merriam-webster.com/dictionary/sentiment) (emotional intent) from a piece of text. Simply, SA is used to determine how positive or negative the emotion of a sentence is.
+
+Examples:
+
+* "I love how curly your hair is" -- very positive
+* "The United States is over 200 years old" -- neutral
+* "Frankly, your face is disgusting and I would hate to meet you" -- very negative
+
+SA can be a powerful signal for determining the intent of a user's comment/submission. However, it should not be the **only** tool as it comes with both strengths and weaknesses.
+
+## Pros and Cons
+
+Pros
+
+* In terms of Reddit API usage, SA is **free**. It requires no API calls and is computationally trivial.
+* Extremely powerful signal for intent since it analyzes the actual text content of an activity
+* Requires almost no setup to use
+  * Can be used as a substitute for regex/keyword matching when looking for hateful/toxic comments
+* English language comprehension is very thorough
+  * Uses 3 independent algorithms to evaluate sentiment
+  * Understands common english slang, internet slang, and emojis
+
+Cons
+
+* Language limited -- only supported for English (most thorough), French, German, and Spanish
+* Less accurate for small word count content (less than 4 words)
+* Does not understand sarcasm/jokes
+* Accuracy depends on use of common words
+* Accuracy depends on clear intent
+  * Heavy nuance, obscure word choice, and hidden meanings are not understood
+
+## Technical Overview
+
+ContextMod attempts to identify the language of the content it is processing. Based on its confidence of the language it will use up to three different NLP libraries to extract sentiment:
+
+* [NLP.js](https://github.com/axa-group/nlp.js/blob/master/docs/v3/sentiment-analysis.md) (english, french, german, and spanish)
+* [vaderSentiment-js](https://github.com/vaderSentiment/vaderSentiment-js/) (english only)
+* [wink-sentiment](https://github.com/winkjs/wink-sentiment) (english only)
+
+The above libraries make use of these Sentiment Analysis algorithms:
+
+* VADER https://github.com/cjhutto/vaderSentiment
+* AFINN http://corpustext.com/reference/sentiment_afinn.html
+* Senticon https://ieeexplore.ieee.org/document/8721408
+* Pattern https://github.com/clips/pattern
+* wink https://github.com/winkjs/wink-sentiment (modified AFINN with emojis)
+
+Each library produces a normalized score: the sum of all the valence values for each recognized token in its lexicon, divided by the number of words/tokens.
+
+ContextMod takes each normalized score and adjusts it to be between -1 and +1. It then adds finds the average of all normalized score to produce a final sentiment between -1 and +1.
+
+# Sentiment Values
+
+Each piece of content ContextMod analyses produces a score from -1 to +1 to represent the sentiment of that content
+
+| Score | Sentiment          |
+|-------|--------------------|
+| -1    |                    |
+| -0.6  | Extremely Negative |
+| -0.3  | Very Negative      |
+| -0.1  | Negative           |
+| 0     | Neutral            |
+| 0.1   | Positive           |
+| 0.3   | Very Positive      |
+| 0.6   | Extremely Positive |
+| 1     |                    |
+
+# Usage
+
+## Testing Sentiment Value
+
+Testing for sentiment in the Sentiment Rule is done using either a **text** or **numerical** comparison.
+
+### Numerical
+
+Similar to other numerical comparisons in CM -- use an equality operator and the number to test for:
+
+* `> 0.1` -- sentiment is at least positive
+* `<= -0.1` -- sentiment is not negative
+
+Testing for *only* neutral sentiment should be done use a text comparison (below).
+
+### Text
+
+Use any of the **Sentiment** text values from the above table to form a test:
+
+* `is very positive`
+* `is neutral`
+* `is extremely negative`
+
+You may also use the `not` operator:
+
+* `is not negative`
+* `is not very negative`
+* `is not neutral`
+
+## Sentiment Rule
+
+An example rule that tests the current comment/submission to see if it has negative sentiment:
+
+```yaml
+sentiment: 'is negative'
+```
+
+It's very simple :)
+
+### Historical
+
+You may also test the Sentiment of Activities from the user's history. (Note: this may use an API call to get history)
+
+```yaml
+sentiment: 'is negative'
+historical:
+  window:
+    count: 50
+  mustMatchCurrent: true # optional, the initial activity being tested must test true ("is positive" must be true) before historical tests are run
+  sentimentVal: 'is very negative' # optional, if the sentiment test to use for historical content is different than the initial test
+  totalMatching: '> 3' # optional, a comparison for how many historical activities must match sentimentVal
+```
+
+# Examples
+
+#### Check with Rules for recent problem subreddit activity and negative sentiment in comment
+
+```yaml
+name: Probably Toxic Comment
+kind: comment
+rules:
+  - kind: recentActivity
+    thresholds:
+      - aProblemSubreddit
+  - kind: sentiment
+    name: negsentiment
+    sentiment: 'is very negative'
+actions:
+  - kind: report
+    content: 'Sentiment of {{rules.negsentiment.averageScore}} {{rules.negsentiment.sentimentTest}}'
+```
+
+#### Check with Rules for recent problem subreddit activity and negative sentiment in comment history from problem subreddits
+
+```yaml
+name: Toxic Comment With History
+kind: comment
+rules:
+  - kind: recentActivity
+    thresholds:
+      - aProblemSubreddit
+      - aSecondProblemSubreddit
+  - kind: sentiment
+    sentiment: 'is very negative'
+    historical:
+      sentimentVal: 'is negative'
+      mustMatchCurrent: true
+      totalMatching: '> 1'
+      window:
+        count: 100
+        filterOn:
+          post:
+            subreddits:
+              include:
+                - name:
+                  - aProblemSubreddit
+                  - aSecondProblemSubreddit
+actions:
+  - kind: remove
+```

docs/subreddit/components/subredditReady/freekarma.json5

@@ -43,7 +43,7 @@
             // remove this after confirming behavior is acceptable
             {
               "kind": "report",
-              "content": "Remove=> {{rules.newtube.totalCount}} activities in freekarma subs"
+              "content": "Remove=> {{rules.freekarma.totalCount}} activities in freekarma subs"
             },
             //
             //

docs/subreddit/components/subredditReady/freekarma.yaml

@@ -25,7 +25,7 @@ runs:
         actions:
           - kind: report
             enable: true
-            content: 'Remove=> {{rules.newtube.totalCount}} activities in freekarma subs'
+            content: 'Remove=> {{rules.freekarma.totalCount}} activities in freekarma subs'
           - kind: remove
             enable: true
           - kind: comment

docs/subreddit/components/userNotes/README.md

@@ -6,6 +6,16 @@ Context Mod supports reading and writing [User Notes](https://www.reddit.com/r/t
 
 [Click here for the Toolbox Quickstart Guide](https://www.reddit.com/r/toolbox/wiki/docs/quick_start)
 
+Valid Note Types:
+
+* `gooduser`
+* `spamwatch`
+* `spamwarn`
+* `abusewarn`
+* `ban`
+* `permban`
+* `botban`
+
 ## Filter
 
 User Notes are an additional criteria on [AuthorCriteria](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) that can be used alongside other Author properties for both [filtering rules and in the AuthorRule.](/docs/subreddit/components/author/)

docs/webInterface.md

@@ -20,6 +20,7 @@
 
 ## Web Dashboard Tips
 
+* Click the **Help** button at the top of the page to get a **guided tour of the dashboard**
 * Use the [**Overview** section](/docs/images/botOperations.png) to control the bot at a high-level
 * You can **manually run** the bot on any activity (comment/submission) by pasting its permalink into the [input field below the Overview section](/docs/images/runInput.png) and hitting one of the **run buttons**
     * **Dry run** will make the bot run on the activity but it will only **pretend** to run actions, if triggered. This is super useful for testing your config without consequences

package-lock.json

@@ -1,17 +1,20 @@
 {
   "name": "redditcontextbot",
-  "version": "0.5.1",
+  "version": "0.11.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "redditcontextbot",
-      "version": "0.5.1",
+      "version": "0.11.4",
       "hasInstallScript": true,
       "license": "ISC",
       "dependencies": {
         "@awaitjs/express": "^0.8.0",
+        "@datasert/cronjs-matcher": "^1.2.0",
         "@googleapis/youtube": "^2.0.0",
+        "@influxdata/influxdb-client": "^1.27.0",
+        "@influxdata/influxdb-client-apis": "^1.27.0",
         "@nlpjs/core": "^4.23.4",
         "@nlpjs/lang-de": "^4.23.4",
         "@nlpjs/lang-en": "^4.23.4",
@@ -29,7 +32,7 @@
         "cache-manager-redis-store": "^2.0.0",
         "commander": "^8.0.0",
         "comment-json": "^4.1.1",
-        "connect-typeorm": "github:FoxxMD/connect-typeorm#typeormBump",
+        "connect-typeorm": "^2.0.0",
         "cookie-parser": "^1.3.5",
         "dayjs": "^1.10.5",
         "deepmerge": "^4.2.2",
@@ -73,8 +76,9 @@
         "string-similarity": "^4.0.4",
         "tcp-port-used": "^1.0.2",
         "triple-beam": "^1.3.0",
-        "typeorm": "^0.3.4",
+        "typeorm": "^0.3.7",
         "typeorm-logger-adaptor": "^1.1.0",
+        "unique-names-generator": "^4.7.1",
         "vader-sentiment": "^1.1.3",
         "webhook-discord": "^3.7.7",
         "wink-sentiment": "^5.0.2",
@@ -653,6 +657,20 @@
         "kuler": "^2.0.0"
       }
     },
+    "node_modules/@datasert/cronjs-matcher": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@datasert/cronjs-matcher/-/cronjs-matcher-1.2.0.tgz",
+      "integrity": "sha512-ht6Vwwa3qssMn/9bphypjG/U8w0DV3GtTS2C6kbAy39rerQFTRzmml9xZNlot1K13gm9K/EEq3DLPEOsH++ICw==",
+      "dependencies": {
+        "@datasert/cronjs-parser": "^1.2.0",
+        "luxon": "^2.1.1"
+      }
+    },
+    "node_modules/@datasert/cronjs-parser": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@datasert/cronjs-parser/-/cronjs-parser-1.2.0.tgz",
+      "integrity": "sha512-7kzYh7F5V3ElX+k3W9w6SKS6WdjqJQ2gIY1y0evldnjAwZxnFzR/Yu9Mv9OeDaCQX+mGAq2MvEnJbwu9oj3CXQ=="
+    },
     "node_modules/@googleapis/youtube": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/@googleapis/youtube/-/youtube-2.0.0.tgz",
@@ -664,6 +682,19 @@
         "node": ">=10.0.0"
       }
     },
+    "node_modules/@influxdata/influxdb-client": {
+      "version": "1.27.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client/-/influxdb-client-1.27.0.tgz",
+      "integrity": "sha512-hOBi+ApIurDd8jFWo+eYjMWWsDRp3wih/U/NOVRoHaTOE8ihSQthi9wfMD4YeVqt4pCN6ygIwo7lEKFXwNuwcA=="
+    },
+    "node_modules/@influxdata/influxdb-client-apis": {
+      "version": "1.27.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client-apis/-/influxdb-client-apis-1.27.0.tgz",
+      "integrity": "sha512-a4gd7CwNRXSsSVt9tm8GzGxuPXngEmQucMdoTZ0YYeWSbKUXz3B/3u9/EqMGEbtq5MdbbB2OKA611hu205UiNg==",
+      "peerDependencies": {
+        "@influxdata/influxdb-client": "*"
+      }
+    },
     "node_modules/@istanbuljs/load-nyc-config": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz",
@@ -2786,9 +2817,9 @@
       }
     },
     "node_modules/connect-typeorm": {
-      "version": "1.2.0",
-      "resolved": "git+ssh://git@github.com/FoxxMD/connect-typeorm.git#a2f0a7225a1c218db0b919142076ce0774c8caa6",
-      "license": "MIT",
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/connect-typeorm/-/connect-typeorm-2.0.0.tgz",
+      "integrity": "sha512-0OcbHJkNMTJjSrbcKGljr4PKgRq13Dds7zQq3+8oaf4syQTgGvGv9OgnXo2qg+Bljkh4aJNzIvW74QOVLn8zrw==",
       "dependencies": {
         "@types/debug": "0.0.31",
         "@types/express-session": "^1.15.5",
@@ -2796,7 +2827,7 @@
         "express-session": "^1.15.6"
       },
       "peerDependencies": {
-        "typeorm": "^0.3.4"
+        "typeorm": "^0.3.0"
       }
     },
     "node_modules/connect-typeorm/node_modules/debug": {
@@ -5780,6 +5811,14 @@
         "node": ">=10"
       }
     },
+    "node_modules/luxon": {
+      "version": "2.5.0",
+      "resolved": "https://registry.npmjs.org/luxon/-/luxon-2.5.0.tgz",
+      "integrity": "sha512-IDkEPB80Rb6gCAU+FEib0t4FeJ4uVOuX1CQ9GsvU3O+JAGIgu0J7sf1OarXKaKDygTZIoJyU6YdZzTFRu+YR0A==",
+      "engines": {
+        "node": ">=12"
+      }
+    },
     "node_modules/make-dir": {
       "version": "3.1.0",
       "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
@@ -9300,9 +9339,9 @@
       }
     },
     "node_modules/typeorm": {
-      "version": "0.3.6",
-      "resolved": "https://registry.npmjs.org/typeorm/-/typeorm-0.3.6.tgz",
-      "integrity": "sha512-DRqgfqcelMiGgWSMbBmVoJNFN2nPNA3EeY2gC324ndr2DZoGRTb9ILtp2oGVGnlA+cu5zgQ6it5oqKFNkte7Aw==",
+      "version": "0.3.7",
+      "resolved": "https://registry.npmjs.org/typeorm/-/typeorm-0.3.7.tgz",
+      "integrity": "sha512-MsPJeP6Zuwfe64c++l80+VRqpGEGxf0CkztIEnehQ+CMmQPSHjOnFbFxwBuZ2jiLqZTjLk2ZqQdVF0RmvxNF3Q==",
       "dependencies": {
         "@sqltools/formatter": "^1.2.2",
         "app-root-path": "^3.0.0",
@@ -9335,12 +9374,12 @@
       },
       "peerDependencies": {
         "@google-cloud/spanner": "^5.18.0",
-        "@sap/hana-client": "^2.11.14",
+        "@sap/hana-client": "^2.12.25",
         "better-sqlite3": "^7.1.2",
         "hdb-pool": "^0.1.6",
-        "ioredis": "^4.28.3",
+        "ioredis": "^5.0.4",
         "mongodb": "^3.6.0",
-        "mssql": "^6.3.1",
+        "mssql": "^7.3.0",
         "mysql2": "^2.2.5",
         "oracledb": "^5.1.0",
         "pg": "^8.5.1",
@@ -9348,7 +9387,7 @@
         "pg-query-stream": "^4.0.0",
         "redis": "^3.1.1 || ^4.0.0",
         "sql.js": "^1.4.0",
-        "sqlite3": "^5.0.2",
+        "sqlite3": "^5.0.3",
         "ts-node": "^10.7.0",
         "typeorm-aurora-data-api-driver": "^2.0.0"
       },
@@ -9726,6 +9765,14 @@
         "node": ">= 0.8.x"
       }
     },
+    "node_modules/unique-names-generator": {
+      "version": "4.7.1",
+      "resolved": "https://registry.npmjs.org/unique-names-generator/-/unique-names-generator-4.7.1.tgz",
+      "integrity": "sha512-lMx9dX+KRmG8sq6gulYYpKWZc9RlGsgBR6aoO8Qsm3qvkSJ+3rAymr+TnV8EDMrIrwuFJ4kruzMWM/OpYzPoow==",
+      "engines": {
+        "node": ">=8"
+      }
+    },
     "node_modules/universalify": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
@@ -10788,6 +10835,20 @@
         "kuler": "^2.0.0"
       }
     },
+    "@datasert/cronjs-matcher": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@datasert/cronjs-matcher/-/cronjs-matcher-1.2.0.tgz",
+      "integrity": "sha512-ht6Vwwa3qssMn/9bphypjG/U8w0DV3GtTS2C6kbAy39rerQFTRzmml9xZNlot1K13gm9K/EEq3DLPEOsH++ICw==",
+      "requires": {
+        "@datasert/cronjs-parser": "^1.2.0",
+        "luxon": "^2.1.1"
+      }
+    },
+    "@datasert/cronjs-parser": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@datasert/cronjs-parser/-/cronjs-parser-1.2.0.tgz",
+      "integrity": "sha512-7kzYh7F5V3ElX+k3W9w6SKS6WdjqJQ2gIY1y0evldnjAwZxnFzR/Yu9Mv9OeDaCQX+mGAq2MvEnJbwu9oj3CXQ=="
+    },
     "@googleapis/youtube": {
       "version": "2.0.0",
       "resolved": "https://registry.npmjs.org/@googleapis/youtube/-/youtube-2.0.0.tgz",
@@ -10796,6 +10857,17 @@
         "googleapis-common": "^5.0.1"
       }
     },
+    "@influxdata/influxdb-client": {
+      "version": "1.27.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client/-/influxdb-client-1.27.0.tgz",
+      "integrity": "sha512-hOBi+ApIurDd8jFWo+eYjMWWsDRp3wih/U/NOVRoHaTOE8ihSQthi9wfMD4YeVqt4pCN6ygIwo7lEKFXwNuwcA=="
+    },
+    "@influxdata/influxdb-client-apis": {
+      "version": "1.27.0",
+      "resolved": "https://registry.npmjs.org/@influxdata/influxdb-client-apis/-/influxdb-client-apis-1.27.0.tgz",
+      "integrity": "sha512-a4gd7CwNRXSsSVt9tm8GzGxuPXngEmQucMdoTZ0YYeWSbKUXz3B/3u9/EqMGEbtq5MdbbB2OKA611hu205UiNg==",
+      "requires": {}
+    },
     "@istanbuljs/load-nyc-config": {
       "version": "1.1.0",
       "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz",
@@ -12549,8 +12621,9 @@
       }
     },
     "connect-typeorm": {
-      "version": "git+ssh://git@github.com/FoxxMD/connect-typeorm.git#a2f0a7225a1c218db0b919142076ce0774c8caa6",
-      "from": "connect-typeorm@github:FoxxMD/connect-typeorm#typeormBump",
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/connect-typeorm/-/connect-typeorm-2.0.0.tgz",
+      "integrity": "sha512-0OcbHJkNMTJjSrbcKGljr4PKgRq13Dds7zQq3+8oaf4syQTgGvGv9OgnXo2qg+Bljkh4aJNzIvW74QOVLn8zrw==",
       "requires": {
         "@types/debug": "0.0.31",
         "@types/express-session": "^1.15.5",
@@ -14850,6 +14923,11 @@
         "yallist": "^4.0.0"
       }
     },
+    "luxon": {
+      "version": "2.5.0",
+      "resolved": "https://registry.npmjs.org/luxon/-/luxon-2.5.0.tgz",
+      "integrity": "sha512-IDkEPB80Rb6gCAU+FEib0t4FeJ4uVOuX1CQ9GsvU3O+JAGIgu0J7sf1OarXKaKDygTZIoJyU6YdZzTFRu+YR0A=="
+    },
     "make-dir": {
       "version": "3.1.0",
       "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
@@ -17557,9 +17635,9 @@
       }
     },
     "typeorm": {
-      "version": "0.3.6",
-      "resolved": "https://registry.npmjs.org/typeorm/-/typeorm-0.3.6.tgz",
-      "integrity": "sha512-DRqgfqcelMiGgWSMbBmVoJNFN2nPNA3EeY2gC324ndr2DZoGRTb9ILtp2oGVGnlA+cu5zgQ6it5oqKFNkte7Aw==",
+      "version": "0.3.7",
+      "resolved": "https://registry.npmjs.org/typeorm/-/typeorm-0.3.7.tgz",
+      "integrity": "sha512-MsPJeP6Zuwfe64c++l80+VRqpGEGxf0CkztIEnehQ+CMmQPSHjOnFbFxwBuZ2jiLqZTjLk2ZqQdVF0RmvxNF3Q==",
       "requires": {
         "@sqltools/formatter": "^1.2.2",
         "app-root-path": "^3.0.0",
@@ -17810,6 +17888,11 @@
       "resolved": "https://registry.npmjs.org/unicode/-/unicode-14.0.0.tgz",
       "integrity": "sha512-BjinxTXkbm9Jomp/YBTMGusr4fxIG67fNGShHIRAL16Ur2GJTq2xvLi+sxuiJmInCmwqqev2BCFKyvbfp/yAkg=="
     },
+    "unique-names-generator": {
+      "version": "4.7.1",
+      "resolved": "https://registry.npmjs.org/unique-names-generator/-/unique-names-generator-4.7.1.tgz",
+      "integrity": "sha512-lMx9dX+KRmG8sq6gulYYpKWZc9RlGsgBR6aoO8Qsm3qvkSJ+3rAymr+TnV8EDMrIrwuFJ4kruzMWM/OpYzPoow=="
+    },
     "universalify": {
       "version": "0.1.2",
       "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redditcontextbot",
-  "version": "0.5.1",
+  "version": "0.11.4",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -8,13 +8,15 @@
     "build": "tsc && npm run bundle-front",
     "bundle-front": "browserify src/Web/assets/browser.js | terser --compress --mangle > src/Web/assets/public/browserBundle.js",
     "start": "node src/index.js run",
-    "schema": "npm run -s schema-app & npm run -s schema-ruleset & npm run -s schema-rule & npm run -s schema-action & npm run -s schema-config",
-    "schema-app": "typescript-json-schema tsconfig.json JSONConfig --out src/Schema/App.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
-    "schema-ruleset": "typescript-json-schema tsconfig.json RuleSetJson --out src/Schema/RuleSet.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
-    "schema-rule": "typescript-json-schema tsconfig.json RuleJson --out src/Schema/Rule.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
-    "schema-action": "typescript-json-schema tsconfig.json ActionJson --out src/Schema/Action.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema": "npm run -s schema-app & npm run -s schema-ruleset & npm run -s schema-rule & npm run -s schema-action & npm run -s schema-check & npm run -s schema-run & npm run -s schema-config",
+    "schema-app": "typescript-json-schema tsconfig.json SubredditConfigData --out src/Schema/App.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema-ruleset": "typescript-json-schema tsconfig.json RuleSetConfigData --out src/Schema/RuleSet.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema-rule": "typescript-json-schema tsconfig.json RuleConfigData --out src/Schema/Rule.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema-check": "typescript-json-schema tsconfig.json ActivityCheckConfigValue --out src/Schema/Check.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema-run": "typescript-json-schema tsconfig.json RunConfigValue --out src/Schema/Run.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
+    "schema-action": "typescript-json-schema tsconfig.json ActionConfigData --out src/Schema/Action.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
     "schema-config": "typescript-json-schema tsconfig.json OperatorJsonConfig --out src/Schema/OperatorConfig.json --required --tsNodeRegister --refs --validationKeywords deprecationMessage",
-    "schemaNotWorking": "./node_modules/.bin/ts-json-schema-generator -f tsconfig.json -p src/JsonConfig.ts -t JSONConfig --out src/Schema/vegaSchema.json",
+    "schemaNotWorking": "./node_modules/.bin/ts-json-schema-generator -f tsconfig.json -p src/SubredditConfigData.ts -t JSONConfig --out src/Schema/vegaSchema.json",
     "circular": "madge --circular --extensions ts src/index.ts",
     "circular-graph": "madge --image graph.svg --circular --extensions ts src/index.ts",
     "postinstall": "patch-package",
@@ -29,7 +31,10 @@
   "license": "ISC",
   "dependencies": {
     "@awaitjs/express": "^0.8.0",
+    "@datasert/cronjs-matcher": "^1.2.0",
     "@googleapis/youtube": "^2.0.0",
+    "@influxdata/influxdb-client": "^1.27.0",
+    "@influxdata/influxdb-client-apis": "^1.27.0",
     "@nlpjs/core": "^4.23.4",
     "@nlpjs/lang-de": "^4.23.4",
     "@nlpjs/lang-en": "^4.23.4",
@@ -47,7 +52,7 @@
     "cache-manager-redis-store": "^2.0.0",
     "commander": "^8.0.0",
     "comment-json": "^4.1.1",
-    "connect-typeorm": "github:FoxxMD/connect-typeorm#typeormBump",
+    "connect-typeorm": "^2.0.0",
     "cookie-parser": "^1.3.5",
     "dayjs": "^1.10.5",
     "deepmerge": "^4.2.2",
@@ -91,8 +96,9 @@
     "string-similarity": "^4.0.4",
     "tcp-port-used": "^1.0.2",
     "triple-beam": "^1.3.0",
-    "typeorm": "^0.3.4",
+    "typeorm": "^0.3.7",
     "typeorm-logger-adaptor": "^1.1.0",
+    "unique-names-generator": "^4.7.1",
     "vader-sentiment": "^1.1.3",
     "webhook-discord": "^3.7.7",
     "wink-sentiment": "^5.0.2",

src/Action/ActionFactory.ts

@@ -3,7 +3,7 @@ import LockAction, {LockActionJson} from "./LockAction";
 import {RemoveAction, RemoveActionJson} from "./RemoveAction";
 import {ReportAction, ReportActionJson} from "./ReportAction";
 import {FlairAction, FlairActionJson} from "./SubmissionAction/FlairAction";
-import Action, {ActionJson, StructuredActionJson} from "./index";
+import Action, {ActionJson, ActionRuntimeOptions, StructuredActionJson} from "./index";
 import {Logger} from "winston";
 import {UserNoteAction, UserNoteActionJson} from "./UserNoteAction";
 import ApproveAction, {ApproveActionConfig} from "./ApproveAction";
@@ -18,38 +18,41 @@ import {CancelDispatchAction, CancelDispatchActionJson} from "./CancelDispatchAc
 import ContributorAction, {ContributorActionJson} from "./ContributorAction";
 import {StructuredFilter} from "../Common/Infrastructure/Filters/FilterShapes";
 import {ModNoteAction, ModNoteActionJson} from "./ModNoteAction";
+import {SubmissionAction, SubmissionActionJson} from "./SubmissionAction";
 
 export function actionFactory
-(config: StructuredActionJson, logger: Logger, subredditName: string, resources: SubredditResources, client: ExtendedSnoowrap, emitter: EventEmitter): Action {
+(config: StructuredActionJson, runtimeOptions: ActionRuntimeOptions): Action {
     switch (config.kind) {
         case 'comment':
-            return new CommentAction({...config as StructuredFilter<CommentActionJson>, logger, subredditName, resources, client, emitter});
+            return new CommentAction({...config as StructuredFilter<CommentActionJson>, ...runtimeOptions});
+        case 'submission':
+            return new SubmissionAction({...config as StructuredFilter<SubmissionActionJson>, ...runtimeOptions});
         case 'lock':
-            return new LockAction({...config as StructuredFilter<LockActionJson>, logger, subredditName, resources, client, emitter});
+            return new LockAction({...config as StructuredFilter<LockActionJson>, ...runtimeOptions});
         case 'remove':
-            return new RemoveAction({...config as StructuredFilter<RemoveActionJson>, logger, subredditName, resources, client, emitter});
+            return new RemoveAction({...config as StructuredFilter<RemoveActionJson>, ...runtimeOptions});
         case 'report':
-            return new ReportAction({...config as StructuredFilter<ReportActionJson>, logger, subredditName, resources, client, emitter});
+            return new ReportAction({...config as StructuredFilter<ReportActionJson>, ...runtimeOptions});
         case 'flair':
-            return new FlairAction({...config as StructuredFilter<FlairActionJson>, logger, subredditName, resources, client, emitter});
+            return new FlairAction({...config as StructuredFilter<FlairActionJson>, ...runtimeOptions});
         case 'userflair':
-            return new UserFlairAction({...config as StructuredFilter<UserFlairActionJson>, logger, subredditName, resources, client, emitter});
+            return new UserFlairAction({...config as StructuredFilter<UserFlairActionJson>, ...runtimeOptions});
         case 'approve':
-            return new ApproveAction({...config as StructuredFilter<ApproveActionConfig>, logger, subredditName, resources, client, emitter});
+            return new ApproveAction({...config as StructuredFilter<ApproveActionConfig>, ...runtimeOptions});
         case 'usernote':
-            return new UserNoteAction({...config as StructuredFilter<UserNoteActionJson>, logger, subredditName, resources, client, emitter});
+            return new UserNoteAction({...config as StructuredFilter<UserNoteActionJson>, ...runtimeOptions});
         case 'ban':
-            return new BanAction({...config as StructuredFilter<BanActionJson>, logger, subredditName, resources, client, emitter});
+            return new BanAction({...config as StructuredFilter<BanActionJson>, ...runtimeOptions});
         case 'message':
-            return new MessageAction({...config as StructuredFilter<MessageActionJson>, logger, subredditName, resources, client, emitter});
+            return new MessageAction({...config as StructuredFilter<MessageActionJson>, ...runtimeOptions});
         case 'dispatch':
-            return new DispatchAction({...config as StructuredFilter<DispatchActionJson>, logger, subredditName, resources, client, emitter});
+            return new DispatchAction({...config as StructuredFilter<DispatchActionJson>, ...runtimeOptions});
         case 'cancelDispatch':
-            return new CancelDispatchAction({...config as StructuredFilter<CancelDispatchActionJson>, logger, subredditName, resources, client, emitter})
+            return new CancelDispatchAction({...config as StructuredFilter<CancelDispatchActionJson>, ...runtimeOptions})
         case 'contributor':
-            return new ContributorAction({...config as StructuredFilter<ContributorActionJson>, logger, subredditName, resources, client, emitter})
+            return new ContributorAction({...config as StructuredFilter<ContributorActionJson>, ...runtimeOptions})
         case 'modnote':
-            return new ModNoteAction({...config as StructuredFilter<ModNoteActionJson>, logger, subredditName, resources, client, emitter})
+            return new ModNoteAction({...config as StructuredFilter<ModNoteActionJson>, ...runtimeOptions})
         default:
             throw new Error('rule "kind" was not recognized.');
     }

src/Action/ApproveAction.ts

@@ -8,6 +8,7 @@ import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTarget, ActionTypes} from "../Common/Infrastructure/Atomic";
 import {asComment, asSubmission} from "../util";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class ApproveAction extends Action {
 
@@ -26,7 +27,7 @@ export class ApproveAction extends Action {
         this.targets = targets;
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
         const touchedEntities = [];
 

src/Action/BanAction.ts

@@ -6,6 +6,18 @@ import {ActionProcessResult, Footer, RuleResult} from "../Common/interfaces";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {truncateStringToLength} from "../util";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
+
+const truncate = truncateStringToLength(100);
+const truncateLongMessage = truncateStringToLength(200);
+
+const truncateIfNotUndefined = (val: string | undefined) => {
+    if(val === undefined) {
+        return undefined;
+    }
+    return truncate(val);
+}
 
 export class BanAction extends Action {
 
@@ -35,17 +47,19 @@ export class BanAction extends Action {
         return 'ban';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
-        const content = this.message === undefined ? undefined : await this.resources.getContent(this.message, item.subreddit);
-        const renderedBody = content === undefined ? undefined : await renderContent(content, item, ruleResults, this.resources.userNotes);
-        const renderedContent = renderedBody === undefined ? undefined : `${renderedBody}${await this.resources.generateFooter(item, this.footer)}`;
+        const renderedBody = await this.renderContent(this.message, item, ruleResults, actionResults);
+        const renderedContent = renderedBody === undefined ? undefined : `${renderedBody}${await this.resources.renderFooter(item, this.footer)}`;
+
+        const renderedReason = truncateIfNotUndefined(await this.renderContent(this.reason, item, ruleResults, actionResults) as string);
+        const renderedNote = truncateIfNotUndefined(await this.renderContent(this.note, item, ruleResults, actionResults) as string);
 
         const touchedEntities = [];
         let banPieces = [];
-        banPieces.push(`Message: ${renderedContent === undefined ? 'None' : `${renderedContent.length > 100 ? `\r\n${renderedContent}` : renderedContent}`}`);
-        banPieces.push(`Reason:  ${this.reason || 'None'}`);
-        banPieces.push(`Note:    ${this.note || 'None'}`);
+        banPieces.push(`Message: ${renderedContent === undefined ? 'None' : `${renderedContent.length > 100 ? `\r\n${truncateLongMessage(renderedContent)}` : renderedContent}`}`);
+        banPieces.push(`Reason:  ${renderedReason || 'None'}`);
+        banPieces.push(`Note:    ${renderedNote || 'None'}`);
         const durText = this.duration === undefined ? 'permanently' : `for ${this.duration} days`;
         this.logger.info(`Banning ${item.author.name} ${durText}${this.reason !== undefined ? ` (${this.reason})` : ''}`);
         this.logger.verbose(`\r\n${banPieces.join('\r\n')}`);
@@ -56,8 +70,8 @@ export class BanAction extends Action {
             const bannedUser = await fetchedSub.banUser({
                 name: fetchedName,
                 banMessage: renderedContent === undefined ? undefined : renderedContent,
-                banReason: this.reason,
-                banNote: this.note,
+                banReason: renderedReason,
+                banNote: renderedNote,
                 duration: this.duration
             });
             touchedEntities.push(bannedUser);
@@ -65,8 +79,14 @@ export class BanAction extends Action {
         return {
             dryRun,
             success: true,
-            result: `Banned ${item.author.name} ${durText}${this.reason !== undefined ? ` (${this.reason})` : ''}`,
-            touchedEntities
+            result: `Banned ${item.author.name} ${durText}${renderedReason !== undefined ? ` (${renderedReason})` : ''}`,
+            touchedEntities,
+            data: {
+                message: renderedContent === undefined ? undefined : renderedContent,
+                reason: renderedReason,
+                note: renderedNote,
+                duration: durText
+            }
         };
     }
 
@@ -97,8 +117,10 @@ export interface BanActionConfig extends ActionConfig, Footer {
      * */
     message?: string
     /**
-     * Reason for ban.
-     * @maxLength 100
+     * Reason for ban. Can use Templating.
+     *
+     * If the length expands to more than 100 characters it will truncated with "..."
+     *
      * @examples ["repeat spam"]
      * */
     reason?: string
@@ -110,8 +132,10 @@ export interface BanActionConfig extends ActionConfig, Footer {
      * */
     duration?: number
     /**
-     * A mod note for this ban
-     * @maxLength 100
+     * A mod note for this ban. Can use Templating.
+     *
+     * If the length expands to more than 100 characters it will truncated with "..."
+     *
      * @examples ["Sock puppet for u/AnotherUser"]
      * */
     note?: string

src/Action/CancelDispatchAction.ts

@@ -12,6 +12,7 @@ import {isSubmission, parseDurationValToDuration} from "../util";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTarget, ActionTypes, InclusiveActionTarget} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class CancelDispatchAction extends Action {
     identifiers?: (string | null)[];
@@ -35,7 +36,7 @@ export class CancelDispatchAction extends Action {
         this.targets = !Array.isArray(target) ? [target] : target;
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         // see note in DispatchAction about missing runtimeDryrun
         const dryRun = this.dryRun;
 

src/Action/CommentAction.ts

@@ -1,12 +1,15 @@
 import Action, {ActionJson, ActionOptions} from "./index";
-import {Comment} from "snoowrap";
+import {Comment, VoteableContent} from "snoowrap";
 import Submission from "snoowrap/dist/objects/Submission";
 import {renderContent} from "../Utils/SnoowrapUtils";
 import {ActionProcessResult, Footer, RequiredRichContent, RichContent, RuleResult} from "../Common/interfaces";
-import {truncateStringToLength} from "../util";
+import {asComment, asSubmission, parseRedditThingsFromLink, truncateStringToLength} from "../util";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
-import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionTarget, ActionTypes, ArbitraryActionTarget} from "../Common/Infrastructure/Atomic";
+import {CMError} from "../Utils/Errors";
+import {SnoowrapActivity} from "../Common/Infrastructure/Reddit";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class CommentAction extends Action {
     content: string;
@@ -14,6 +17,7 @@ export class CommentAction extends Action {
     sticky: boolean = false;
     distinguish: boolean = false;
     footer?: false | string;
+    targets: ArbitraryActionTarget[]
 
     constructor(options: CommentActionOptions) {
         super(options);
@@ -23,71 +27,139 @@ export class CommentAction extends Action {
             sticky = false,
             distinguish = false,
             footer,
+            targets = ['self']
         } = options;
         this.footer = footer;
         this.content = content;
         this.lock = lock;
         this.sticky = sticky;
         this.distinguish = distinguish;
+        if (!Array.isArray(targets)) {
+            this.targets = [targets];
+        } else {
+            this.targets = targets;
+        }
     }
 
     getKind(): ActionTypes {
         return 'comment';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
-        const content = await this.resources.getContent(this.content, item.subreddit);
-        const body = await renderContent(content, item, ruleResults, this.resources.userNotes);
+        const body =  await this.renderContent(this.content, item, ruleResults, actionResults) as string;
 
-        const footer = await this.resources.generateFooter(item, this.footer);
+        const footer = await this.resources.renderFooter(item, this.footer);
 
         const renderedContent = `${body}${footer}`;
         this.logger.verbose(`Contents:\r\n${renderedContent.length > 100 ? `\r\n${renderedContent}` : renderedContent}`);
 
-        if(item.archived) {
-            this.logger.warn('Cannot comment because Item is archived');
-            return {
-                dryRun,
-                success: false,
-                result: 'Cannot comment because Item is archived'
-            };
-        }
+        let allErrors = true;
+        const targetResults: string[] = [];
         const touchedEntities = [];
-        let modifiers = [];
-        let reply: Comment;
-        if(!dryRun) {
-            // @ts-ignore
-           reply = await item.reply(renderedContent);
-           // add to recent so we ignore activity when/if it is discovered by polling
-           await this.resources.setRecentSelf(reply);
-           touchedEntities.push(reply);
-        }
-        if (this.lock) {
-            modifiers.push('Locked');
+
+        for (const target of this.targets) {
+
+            let targetItem = item;
+            let targetIdentifier = target;
+
+            if (target === 'parent') {
+                if (asSubmission(item)) {
+                    const noParent = `[Parent] Submission ${item.name} does not have a parent`;
+                    this.logger.warn(noParent);
+                    targetResults.push(noParent);
+                    continue;
+                }
+                targetItem = await this.resources.getActivity(this.client.getSubmission(item.link_id));
+            } else if (target !== 'self') {
+                const redditThings = parseRedditThingsFromLink(target);
+                let id = '';
+
+                try {
+                    if (redditThings.comment !== undefined) {
+                        id = redditThings.comment.id;
+                        targetIdentifier = `Permalink Comment ${id}`
+                        // @ts-ignore
+                        await this.resources.getActivity(this.client.getSubmission(redditThings.submission.id));
+                        targetItem = await this.resources.getActivity(this.client.getComment(redditThings.comment.id));
+                    } else if (redditThings.submission !== undefined) {
+                        id = redditThings.submission.id;
+                        targetIdentifier = `Permalink Submission ${id}`
+                        targetItem = await this.resources.getActivity(this.client.getSubmission(redditThings.submission.id));
+                    } else {
+                        targetResults.push(`[Permalink] Could not parse ${target} as a reddit permalink`);
+                        continue;
+                    }
+                } catch (err: any) {
+                    targetResults.push(`[${targetIdentifier}] error occurred while fetching activity: ${err.message}`);
+                    this.logger.warn(new CMError(`[${targetIdentifier}] error occurred while fetching activity`, {cause: err}));
+                    continue;
+                }
+            }
+
+            if (targetItem.archived) {
+                const archived = `[${targetIdentifier}] Cannot comment because Item is archived`;
+                this.logger.warn(archived);
+                targetResults.push(archived);
+                continue;
+            }
+
+            let modifiers = [];
+            let reply: Comment;
             if (!dryRun) {
-                // snoopwrap typing issue, thinks comments can't be locked
                 // @ts-ignore
-                await reply.lock();
+                reply = await targetItem.reply(renderedContent);
+                // add to recent so we ignore activity when/if it is discovered by polling
+                await this.resources.setRecentSelf(reply);
+                touchedEntities.push(reply);
             }
-        }
-        if (this.distinguish && !dryRun) {
-            modifiers.push('Distinguished');
-            if(this.sticky) {
-                modifiers.push('Stickied');
+
+            if (this.lock && targetItem.can_mod_post) {
+                if (!targetItem.can_mod_post) {
+                    this.logger.warn(`[${targetIdentifier}] Cannot lock because bot is not a moderator`);
+                } else {
+                    modifiers.push('Locked');
+                    if (!dryRun) {
+                        // snoopwrap typing issue, thinks comments can't be locked
+                        // @ts-ignore
+                        await reply.lock();
+                    }
+                }
             }
-            if(!dryRun) {
-                // @ts-ignore
-                await reply.distinguish({sticky: this.sticky});
+
+            if (this.distinguish) {
+                if (!targetItem.can_mod_post) {
+                    this.logger.warn(`[${targetIdentifier}] Cannot lock Distinguish/Sticky because bot is not a moderator`);
+                } else {
+                    modifiers.push('Distinguished');
+                    if (this.sticky) {
+                        modifiers.push('Stickied');
+                    }
+                    if (!dryRun) {
+                        // @ts-ignore
+                        await reply.distinguish({sticky: this.sticky});
+                    }
+                }
             }
+
+            const modifierStr = modifiers.length === 0 ? '' : ` == ${modifiers.join(' | ')} == =>`;
+            // @ts-ignore
+            targetResults.push(`${targetIdentifier}${modifierStr} created Comment ${dryRun ? 'DRYRUN' : (reply as SnoowrapActivity).name}`)
+            allErrors = false;
         }
 
-        const modifierStr = modifiers.length === 0 ? '' : `[${modifiers.join(' | ')}]`;
+
         return {
             dryRun,
-            success: true,
-            result: `${modifierStr}${truncateStringToLength(100)(body)}`,
+            success: !allErrors,
+            result: `${targetResults.join('\n')}${truncateStringToLength(100)(body)}`,
             touchedEntities,
+            data: {
+                body,
+                bodyShort: truncateStringToLength(100)(body),
+                comments: targetResults,
+                commentsFormatted: targetResults.map(x => `* ${x}`).join('\n')
+            }
         };
     }
 
@@ -97,7 +169,8 @@ export class CommentAction extends Action {
             lock: this.lock,
             sticky: this.sticky,
             distinguish: this.distinguish,
-            footer: this.footer
+            footer: this.footer,
+            targets: this.targets,
         }
     }
 }
@@ -115,6 +188,21 @@ export interface CommentActionConfig extends RequiredRichContent, Footer {
      * Distinguish the comment after creation?
      * */
     distinguish?: boolean,
+
+    /**
+     * Specify where this comment should be made
+     *
+     * Valid values: 'self' | 'parent' | [reddit permalink]
+     *
+     * 'self' and 'parent' are special targets that are relative to the Activity being processed:
+     * * When Activity is Submission => 'parent' does nothing
+     * * When Activity is Comment
+     *    * 'self' => reply to Activity
+     *    * 'parent' => make a top-level comment in the Submission the Comment is in
+     *
+     * If target is not self/parent then CM assumes the value is a reddit permalink and will attempt to make a comment to that Activity
+     * */
+    targets?: ArbitraryActionTarget | ArbitraryActionTarget[]
 }
 
 export interface CommentActionOptions extends CommentActionConfig, ActionOptions {
@@ -124,5 +212,5 @@ export interface CommentActionOptions extends CommentActionConfig, ActionOptions
  * Reply to the Activity. For a submission the reply will be a top-level comment.
  * */
 export interface CommentActionJson extends CommentActionConfig, ActionJson {
-kind: 'comment'
+    kind: 'comment'
 }

src/Action/ContributorAction.ts

@@ -7,6 +7,7 @@ import Comment from "snoowrap/dist/objects/Comment";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTarget, ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class ContributorAction extends Action {
 
@@ -25,7 +26,7 @@ export class ContributorAction extends Action {
         this.actionType = action;
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
 
         const contributors = await this.resources.getSubredditContributors();

src/Action/DispatchAction.ts

@@ -8,6 +8,7 @@ import {activityDispatchConfigToDispatch, isSubmission, parseDurationValToDurati
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTarget, ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class DispatchAction extends Action {
     dispatchData: ActivityDispatchConfig;
@@ -39,7 +40,7 @@ export class DispatchAction extends Action {
         this.targets = !Array.isArray(target) ? [target] : target;
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         // ignore runtimeDryrun here because "real run" isn't causing any reddit api calls to happen
         // -- basically if bot is in dryrun this should still run since we want the "full effect" of the bot
         // BUT if the action explicitly sets 'dryRun: true' then do not dispatch as they probably don't want to it actually going (intention?)

src/Action/LockAction.ts

@@ -5,13 +5,14 @@ import {ActionProcessResult, RuleResult} from "../Common/interfaces";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class LockAction extends Action {
     getKind(): ActionTypes {
         return 'lock';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
         const touchedEntities = [];
         //snoowrap typing issue, thinks comments can't be locked

src/Action/MessageAction.ts

@@ -16,6 +16,7 @@ import {ErrorWithCause} from "pony-cause";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class MessageAction extends Action {
     content: string;
@@ -48,27 +49,30 @@ export class MessageAction extends Action {
         return 'message';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
-        const content = await this.resources.getContent(this.content);
-        const body = await renderContent(content, item, ruleResults, this.resources.userNotes);
 
-        const footer = await this.resources.generateFooter(item, this.footer);
+        const body = await this.renderContent(this.content, item, ruleResults, actionResults);
+        const titleTemplate = this.title ?? `Concerning your ${isSubmission(item) ? 'Submission' : 'Comment'}`;
+        const subject = await this.renderContent(titleTemplate, item, ruleResults, actionResults) as string;
+
+        const footer = await this.resources.renderFooter(item, this.footer);
 
         const renderedContent = `${body}${footer}`;
 
         let recipient = item.author.name;
         if(this.to !== undefined) {
+            const renderedTo = await this.renderContent(this.to, item, ruleResults, actionResults) as string;
             // parse to value
             try {
-                const entityData = parseRedditEntity(this.to, 'user');
+                const entityData = parseRedditEntity(renderedTo, 'user');
                 if(entityData.type === 'user') {
                     recipient = entityData.name;
                 } else {
                     recipient = `/r/${entityData.name}`;
                 }
             } catch (err: any) {
-                throw new ErrorWithCause(`'to' field for message was not in a valid format. See ${REDDIT_ENTITY_REGEX_URL} for valid examples`, {cause: err});
+                throw new ErrorWithCause(`'to' field for message was not in a valid format, given value after templating: ${renderedTo} -- See ${REDDIT_ENTITY_REGEX_URL} for valid examples`, {cause: err});
             }
             if(recipient.includes('/r/') && this.asSubreddit) {
                 throw new SimpleError(`Cannot send a message as a subreddit to another subreddit. Requested recipient: ${recipient}`);
@@ -80,7 +84,7 @@ export class MessageAction extends Action {
             text: renderedContent,
             // @ts-ignore
             fromSubreddit: this.asSubreddit ? await item.subreddit.fetch() : undefined,
-            subject: this.title || `Concerning your ${isSubmission(item) ? 'Submission' : 'Comment'}`,
+            subject: subject,
         };
 
         const msgPreview = `\r\n
@@ -122,7 +126,7 @@ export interface MessageActionConfig extends RequiredRichContent, Footer {
     asSubreddit: boolean
 
     /**
-     * Entity to send message to.
+     * Entity to send message to. It can be templated.
      *
      * If not present Message be will sent to the Author of the Activity being checked.
      *
@@ -134,8 +138,9 @@ export interface MessageActionConfig extends RequiredRichContent, Footer {
      *
      * **Note:** Reddit does not support sending a message AS a subreddit TO another subreddit
      *
-     * @pattern ^\s*(\/[ru]\/|[ru]\/)*(\w+)*\s*$
-     * @examples ["aUserName","u/aUserName","r/aSubreddit"]
+     * **Tip:** To send a message to the subreddit of the Activity us `to: 'r/{{item.subreddit}}'`
+     *
+     * @examples ["aUserName","u/aUserName","r/aSubreddit", "r/{{item.subreddit}}"]
      * */
     to?: string
 

src/Action/ModNoteAction.ts

@@ -9,6 +9,7 @@ import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes, ModUserNoteLabel} from "../Common/Infrastructure/Atomic";
 import {ModNote} from "../Subreddit/ModNotes/ModNote";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 
 export class ModNoteAction extends Action {
@@ -39,13 +40,12 @@ export class ModNoteAction extends Action {
         }
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
 
         const modLabel = this.type !== undefined ? toModNoteLabel(this.type) : undefined;
 
-        const content = await this.resources.getContent(this.content, item.subreddit);
-        const renderedContent = await renderContent(content, item, ruleResults, this.resources.userNotes);
+        const renderedContent = await this.renderContent(this.content, item, ruleResults, actionResults);
         this.logger.verbose(`Note:\r\n(${this.type}) ${renderedContent}`);
 
         // TODO see what changes are made for bulk fetch of notes before implementing this

src/Action/RemoveAction.ts

@@ -4,13 +4,17 @@ import Snoowrap, {Comment, Submission} from "snoowrap";
 import {activityIsRemoved} from "../Utils/SnoowrapUtils";
 import {ActionProcessResult, RuleResult} from "../Common/interfaces";
 import dayjs from "dayjs";
-import {isSubmission} from "../util";
+import {isSubmission, truncateStringToLength} from "../util";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
+const truncate = truncateStringToLength(100);
 export class RemoveAction extends Action {
     spam: boolean;
+    note?: string;
+    reasonId?: string;
 
     getKind(): ActionTypes {
         return 'remove';
@@ -20,21 +24,54 @@ export class RemoveAction extends Action {
         super(options);
         const {
             spam = false,
+            note,
+            reasonId,
         } = options;
         this.spam = spam;
+        this.note = note;
+        this.reasonId = reasonId;
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
         const touchedEntities = [];
+        let removeSummary = [];
         // issue with snoowrap typings, doesn't think prop exists on Submission
         // @ts-ignore
         if (activityIsRemoved(item)) {
             this.logger.warn('It looks like this Item is already removed!');
         }
         if (this.spam) {
+            removeSummary.push('Marked as SPAM');
             this.logger.verbose('Marking as spam on removal');
         }
+        const renderedNote = await this.renderContent(this.note, item, ruleResults, actionResults);
+        let foundReasonId: string | undefined;
+        let foundReason: string | undefined;
+
+        if(this.reasonId !== undefined) {
+            const reason = await this.resources.getSubredditRemovalReasonById(this.reasonId);
+            if(reason === undefined) {
+                const reasonWarn = [`Could not find any Removal Reason with the ID ${this.reasonId}!`];
+                if(renderedNote === undefined) {
+                    reasonWarn.push('Cannot add any Removal Reason because note is also empty!');
+                } else {
+                    reasonWarn.push('Will add Removal Reason but only with note.');
+                }
+                this.logger.warn(reasonWarn.join(''));
+            } else {
+                foundReason = truncate(reason.title);
+                foundReasonId = reason.id;
+                removeSummary.push(`Reason: ${truncate(foundReason)} (${foundReasonId})`);
+            }
+        }
+
+        if(renderedNote !== undefined) {
+            removeSummary.push(`Note: ${truncate(renderedNote)}`);
+        }
+
+        this.logger.verbose(removeSummary.join(' | '));
+
         if (!dryRun) {
             // @ts-ignore
             await item.remove({spam: this.spam});
@@ -44,6 +81,18 @@ export class RemoveAction extends Action {
                 // @ts-ignore
                 item.removed = true;
             }
+
+            if(foundReasonId !== undefined || renderedNote !== undefined) {
+                await this.client.addRemovalReason(item, renderedNote, foundReasonId);
+                item.mod_reason_by = this.resources.botAccount as string;
+                if(renderedNote !== undefined) {
+                    item.removal_reason = renderedNote;
+                }
+                if(foundReason !== undefined) {
+                    item.mod_reason_title = foundReason;
+                }
+            }
+
             await this.resources.resetCacheForItem(item);
             touchedEntities.push(item);
         }
@@ -51,7 +100,8 @@ export class RemoveAction extends Action {
         return {
             dryRun,
             success: true,
-            touchedEntities
+            touchedEntities,
+            result: removeSummary.join(' | ')
         }
     }
 
@@ -66,7 +116,22 @@ export interface RemoveOptions extends Omit<RemoveActionConfig, 'authorIs' | 'it
 }
 
 export interface RemoveActionConfig extends ActionConfig {
+    /** (Optional) Mark Activity as spam */
     spam?: boolean
+    /**  (Optional) A mod-readable note added to the removal reason for this Activity. Can use Templating.
+     *
+     * This note (and removal reasons) are only visible on New Reddit
+     * */
+    note?: string
+    /** (Optional) The ID of the Removal Reason to use
+     *
+     * Removal reasons are only visible on New Reddit
+     *
+     * To find IDs for removal reasons check the "Removal Reasons" popup located in the CM dashboard config editor for your subreddit
+     *
+     * More info on Removal Reasons: https://mods.reddithelp.com/hc/en-us/articles/360010094892-Removal-Reasons
+     * */
+    reasonId?: string
 }
 
 /**

src/Action/ReportAction.ts

@@ -7,6 +7,7 @@ import {ActionProcessResult, RichContent, RuleResult} from "../Common/interfaces
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 // https://www.reddit.com/dev/api/oauth#POST_api_report
 // denotes 100 characters maximum
@@ -25,10 +26,9 @@ export class ReportAction extends Action {
         return 'report';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
-        const content = await this.resources.getContent(this.content, item.subreddit);
-        const renderedContent = await renderContent(content, item, ruleResults, this.resources.userNotes);
+        const renderedContent = (await this.renderContent(this.content, item, ruleResults, actionResults) as string);
         this.logger.verbose(`Contents:\r\n${renderedContent}`);
         const truncatedContent = reportTrunc(renderedContent);
         const touchedEntities = [];

src/Action/SubmissionAction.ts

@@ -0,0 +1,329 @@
+import Action, {ActionJson, ActionOptions} from "./index";
+import {Comment, SubmitLinkOptions, SubmitSelfPostOptions, VoteableContent} from "snoowrap";
+import Submission from "snoowrap/dist/objects/Submission";
+import {renderContent} from "../Utils/SnoowrapUtils";
+import {ActionProcessResult, Footer, RequiredRichContent, RichContent, RuleResult} from "../Common/interfaces";
+import {asComment, asSubmission, parseRedditEntity, parseRedditThingsFromLink, sleep, truncateStringToLength} from "../util";
+import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
+import {runCheckOptions} from "../Subreddit/Manager";
+import {ActionTarget, ActionTypes, ArbitraryActionTarget} from "../Common/Infrastructure/Atomic";
+import {CMError} from "../Utils/Errors";
+import {SnoowrapActivity} from "../Common/Infrastructure/Reddit";
+import Subreddit from "snoowrap/dist/objects/Subreddit";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
+
+export class SubmissionAction extends Action {
+    content?: string;
+    lock: boolean = false;
+    sticky: boolean = false;
+    distinguish: boolean = false;
+    spoiler: boolean = false;
+    nsfw: boolean = false;
+    flairId?: string
+    flairText?: string
+    url?: string
+    title: string
+    footer?: false | string;
+    targets: ('self' | string)[]
+
+    constructor(options: SubmissionActionOptions) {
+        super(options);
+        const {
+            content,
+            lock = false,
+            sticky = false,
+            spoiler = false,
+            distinguish = false,
+            nsfw = false,
+            flairText,
+            flairId,
+            footer,
+            url,
+            title,
+            targets = ['self']
+        } = options;
+        this.footer = footer;
+        this.content = content;
+        this.lock = lock;
+        this.sticky = sticky;
+        if(this.sticky) {
+            this.distinguish = sticky;
+        } else {
+            this.distinguish = distinguish;
+        }
+        this.spoiler = spoiler;
+        this.nsfw = nsfw;
+        this.flairText = flairText;
+        this.flairId = flairId;
+        this.url = url;
+        this.title = title;
+        if (!Array.isArray(targets)) {
+            this.targets = [targets];
+        } else {
+            this.targets = targets;
+        }
+    }
+
+    getKind(): ActionTypes {
+        return 'submission';
+    }
+
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+        const dryRun = this.getRuntimeAwareDryrun(options);
+
+        const title = await this.renderContent(this.title, item, ruleResults, actionResults) as string;
+        this.logger.verbose(`Title: ${title}`);
+
+        const url = await this.renderContent(this.url, item, ruleResults, actionResults);
+
+        this.logger.verbose(`URL: ${url !== undefined ? url : '[No URL]'}`);
+
+        const body = await this.renderContent(this.content, item, ruleResults, actionResults);
+
+        let renderedContent: string | undefined = undefined;
+        if(body !== undefined) {
+            const footer = await this.resources.renderFooter(item, this.footer);
+            renderedContent = `${body}${footer}`;
+            this.logger.verbose(`Contents:\r\n${renderedContent.length > 100 ? `\r\n${renderedContent}` : renderedContent}`);
+        } else {
+           this.logger.verbose(`Contents: [No Body]`);
+        }
+
+
+        let allErrors = true;
+        const targetResults: string[] = [];
+        const touchedEntities = [];
+
+        let submittedOnce = false;
+
+        for (const targetVal of this.targets) {
+
+            //
+            if(submittedOnce) {
+                // delay submissions by 3 seconds (on previous successful call)
+                // to try to spread out load
+                await sleep(3000);
+            }
+
+            let target: Subreddit = item.subreddit;
+            let targetIdentifier = targetVal;
+
+            if (targetVal !== 'self') {
+                const subredditVal = parseRedditEntity(targetVal);
+
+                try {
+                    target = await this.resources.getSubreddit(subredditVal.name);
+                    targetIdentifier = `[Subreddit ${target.display_name}]`;
+                } catch (err: any) {
+                    targetResults.push(`[${targetIdentifier}] error occurred while fetching subreddit: ${err.message}`);
+                    if(!err.logged) {
+                        this.logger.warn(new CMError(`[${targetIdentifier}] error occurred while fetching subreddit`, {cause: err}));
+                    }
+                    continue;
+                }
+            }
+
+            // TODO check if we can post in subreddit
+
+            let modifiers = [];
+            let post: Submission | undefined;
+            if (!dryRun) {
+                let opts: SubmitLinkOptions | SubmitSelfPostOptions;
+                let type: 'self' | 'link';
+                const genericOpts = {
+                    title,
+                    subredditName: target.display_name,
+                    nsfw: this.nsfw,
+                    spoiler: this.spoiler,
+                    flairId: this.flairId,
+                    flairText: this.flairText,
+                };
+                if(url !== undefined) {
+                    type = 'link';
+                    opts = {
+                        ...genericOpts,
+                        url,
+                    };
+                    if(renderedContent !== undefined) {
+                        // @ts-ignore
+                        linkOpts.text = renderedContent;
+                    }
+                } else {
+                    type = 'self';
+                    opts = {
+                        ...genericOpts,
+                        text: renderedContent,
+                    }
+                }
+                // @ts-ignore
+                post = await this.tryPost(type, target, opts);
+                await this.resources.setRecentSelf(post as Submission);
+                if(post !== undefined)  {
+                    touchedEntities.push(post);
+                }
+            }
+
+            if (this.lock) {
+                if (post !== undefined && !post.can_mod_post) {
+                    this.logger.warn(`[${targetIdentifier}] Cannot lock because bot is not a moderator`);
+                } else {
+                    modifiers.push('Locked');
+                    if (!dryRun && post !== undefined) {
+                        // snoopwrap typing issue, thinks comments can't be locked
+                        // @ts-ignore
+                        await post.lock();
+                    }
+                }
+            }
+
+            if (this.distinguish) {
+                if (post !== undefined && !post.can_mod_post) {
+                    this.logger.warn(`[${targetIdentifier}] Cannot Distinguish/Sticky because bot is not a moderator`);
+                } else {
+                    modifiers.push('Distinguished');
+                    if (this.sticky) {
+                        modifiers.push('Stickied');
+                    }
+                    if (!dryRun && post !== undefined) {
+                        // @ts-ignore
+                        await post.distinguish({sticky: this.sticky});
+                    }
+                }
+            }
+
+            const modifierStr = modifiers.length === 0 ? '' : ` == ${modifiers.join(' | ')} == =>`;
+            const targetSummary = `${targetIdentifier} ${modifierStr} created Submission ${dryRun ? 'DRYRUN' : (post as SnoowrapActivity).name}`;
+            // @ts-ignore
+            targetResults.push(targetSummary)
+            this.logger.verbose(targetSummary);
+            allErrors = false;
+        }
+
+
+        return {
+            dryRun,
+            success: !allErrors,
+            result: `${targetResults.join('\n')}${this.url !== undefined ? `\nURL: ${this.url}` : ''}${body !== undefined ? truncateStringToLength(100)(body) : ''}`,
+            touchedEntities,
+            data: {
+                body,
+                bodyShort: body !== undefined ? truncateStringToLength(100)(body) : '',
+                submissions: targetResults.map(x => `* ${x}`).join('\n')
+            }
+        };
+    }
+
+    // @ts-ignore
+    protected async tryPost(type: 'self' | 'link', target: Subreddit, data: SubmitLinkOptions | SubmitSelfPostOptions, maxAttempts = 2): Promise<Submission> {
+        let post: Submission | undefined;
+        let error: any;
+        for (let i = 0; i <= maxAttempts; i++) {
+            try {
+                if (type === 'self') {
+                    // @ts-ignore
+                    post = await target.submitSelfpost(data as SubmitSelfPostOptions);
+                } else {
+                    // @ts-ignore
+                    post = await target.submitLink(data as SubmitLinkOptions);
+                }
+                break;
+            } catch (e: any) {
+                if (e.message.includes('RATELIMIT')) {
+                    // Looks like you've been doing that a lot. Take a break for 5 seconds before trying again
+                    await sleep(5000);
+                    error = e;
+                } else {
+                    throw e;
+                }
+            }
+        }
+        if (error !== undefined) {
+            throw error;
+        }
+        // @ts-ignore
+        return post;
+    }
+
+    protected getSpecificPremise(): object {
+        return {
+            content: this.content,
+            lock: this.lock,
+            sticky: this.sticky,
+            spoiler: this.spoiler,
+            distinguish: this.distinguish,
+            nsfw: this.nsfw,
+            flairId: this.flairId,
+            flairText: this.flairText,
+            url: this.url,
+            text: this.content !== undefined ? truncateStringToLength(50)(this.content) : undefined,
+            footer: this.footer,
+            targets: this.targets,
+        }
+    }
+}
+
+export interface SubmissionActionConfig extends RichContent, Footer {
+    /**
+     * Lock the Submission after creation?
+     * */
+    lock?: boolean,
+    /**
+     * Sticky the Submission after creation?
+     * */
+    sticky?: boolean,
+
+    nsfw?: boolean
+
+    spoiler?: boolean
+
+    /**
+     * The title of this Submission.
+     *
+     * Templated the same as **content**
+     * */
+    title: string
+
+    /**
+     * If Submission should be a Link, the URL to use
+     *
+     * Templated the same as **content**
+     *
+     * PROTIP: To make a Link Submission pointing to the Activity being processed use `{{item.permalink}}` as the URL value
+     * */
+    url?: string
+
+    /**
+     * Flair template to apply to this Submission
+     * */
+    flairId?: string
+
+    /**
+     * Flair text to apply to this Submission
+     * */
+    flairText?: string
+
+    /**
+     * Distinguish as Mod after creation?
+     * */
+    distinguish?: boolean
+
+    /**
+     * Specify where this Submission should be made
+     *
+     * Valid values: 'self' | [subreddit]
+     *
+     * * 'self' -- DEFAULT. Post Submission to same subreddit of Activity being processed
+     * * [subreddit] -- The name of a subreddit to post Submission to. EX mealtimevideos
+     * */
+    targets?: ('self' | string) | ('self' | string)[]
+}
+
+export interface SubmissionActionOptions extends SubmissionActionConfig, ActionOptions {
+}
+
+/**
+ * Reply to the Activity. For a submission the reply will be a top-level comment.
+ * */
+export interface SubmissionActionJson extends SubmissionActionConfig, ActionJson {
+    kind: 'submission'
+}

src/Action/SubmissionAction/FlairAction.ts

@@ -6,6 +6,7 @@ import Comment from 'snoowrap/dist/objects/Comment';
 import {RuleResultEntity} from "../../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../../Subreddit/Manager";
 import {ActionTypes} from "../../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../../Common/Entities/ActionResultEntity";
 
 export class FlairAction extends Action {
     text: string;
@@ -26,7 +27,7 @@ export class FlairAction extends Action {
         return 'flair';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
         let flairParts = [];
         if(this.text !== '') {

src/Action/UserFlairAction.ts

@@ -4,6 +4,7 @@ import {ActionProcessResult, RuleResult} from '../Common/interfaces';
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 export class UserFlairAction extends Action {
   text?: string;
@@ -22,7 +23,7 @@ export class UserFlairAction extends Action {
     return 'userflair';
   }
 
-  async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+  async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
     const dryRun = this.getRuntimeAwareDryrun(options);
     let flairParts = [];
 

src/Action/UserNoteAction.ts

@@ -7,12 +7,13 @@ import Submission from "snoowrap/dist/objects/Submission";
 import {ActionProcessResult, RuleResult} from "../Common/interfaces";
 import {RuleResultEntity} from "../Common/Entities/RuleResultEntity";
 import {runCheckOptions} from "../Subreddit/Manager";
-import {ActionTypes} from "../Common/Infrastructure/Atomic";
+import {ActionTypes, UserNoteType} from "../Common/Infrastructure/Atomic";
+import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 
 
 export class UserNoteAction extends Action {
     content: string;
-    type: string;
+    type: UserNoteType;
     allowDuplicate: boolean;
 
     constructor(options: UserNoteActionOptions) {
@@ -27,10 +28,9 @@ export class UserNoteAction extends Action {
         return 'usernote';
     }
 
-    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
+    async process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult> {
         const dryRun = this.getRuntimeAwareDryrun(options);
-        const content = await this.resources.getContent(this.content, item.subreddit);
-        const renderedContent = await renderContent(content, item, ruleResults, this.resources.userNotes);
+        const renderedContent = (await this.renderContent(this.content, item, ruleResults, actionResults) as string);
         this.logger.verbose(`Note:\r\n(${this.type}) ${renderedContent}`);
 
         if (!this.allowDuplicate) {

src/Action/index.ts

@@ -19,6 +19,8 @@ import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 import {FindOptionsWhere} from "typeorm/find-options/FindOptionsWhere";
 import {ActionTypes} from "../Common/Infrastructure/Atomic";
 import {RunnableBaseJson, RunnableBaseOptions, StructuredRunnableBase} from "../Common/Infrastructure/Runnable";
+import { SubredditResources } from "../Subreddit/SubredditResources";
+import {SnoowrapActivity} from "../Common/Infrastructure/Reddit";
 
 export abstract class Action extends RunnableBase {
     name?: string;
@@ -29,6 +31,8 @@ export abstract class Action extends RunnableBase {
     managerEmitter: EventEmitter;
     // actionEntity: ActionEntity | null = null;
     actionPremiseEntity: ActionPremise | null = null;
+    checkName: string;
+    subredditName: string;
 
     constructor(options: ActionOptions) {
         super(options);
@@ -40,6 +44,7 @@ export abstract class Action extends RunnableBase {
             subredditName,
             dryRun = false,
             emitter,
+            checkName,
         } = options;
 
         this.name = name;
@@ -48,6 +53,8 @@ export abstract class Action extends RunnableBase {
         this.client = client;
         this.logger = logger.child({labels: [`Action ${this.getActionUniqueName()}`]}, mergeArr);
         this.managerEmitter = emitter;
+        this.checkName = checkName;
+        this.subredditName = subredditName;
     }
 
     abstract getKind(): ActionTypes;
@@ -112,7 +119,7 @@ export abstract class Action extends RunnableBase {
         }
     }
 
-    async handle(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionResultEntity> {
+    async handle(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionResultEntity> {
         const {dryRun: runtimeDryrun} = options;
         const dryRun = runtimeDryrun || this.dryRun;
 
@@ -148,10 +155,11 @@ export abstract class Action extends RunnableBase {
                 actRes.runReason = runReason;
                 return actRes;
             }
-            const results = await this.process(item, ruleResults, options);
+            const results = await this.process(item, ruleResults, actionResults, options);
             actRes.success = results.success;
             actRes.dryRun = results.dryRun;
             actRes.result = results.result;
+            actRes.data = results.data;
             actRes.touchedEntities = results.touchedEntities ?? [];
 
             return actRes;
@@ -166,20 +174,31 @@ export abstract class Action extends RunnableBase {
         }
     }
 
-    abstract process(item: Comment | Submission, ruleResults: RuleResultEntity[], options: runCheckOptions): Promise<ActionProcessResult>;
+    abstract process(item: Comment | Submission, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[], options: runCheckOptions): Promise<ActionProcessResult>;
 
     getRuntimeAwareDryrun(options: runCheckOptions): boolean {
         const {dryRun: runtimeDryrun} = options;
         return runtimeDryrun || this.dryRun;
     }
+
+    async renderContent(template: string | undefined, item: SnoowrapActivity, ruleResults: RuleResultEntity[], actionResults: ActionResultEntity[]): Promise<string | undefined> {
+        if(template === undefined) {
+            return undefined;
+        }
+        return await this.resources.renderContent(template, item, ruleResults, actionResults, {manager: this.subredditName, check: this.checkName});
+    }
 }
 
-export interface ActionOptions extends Omit<ActionConfig, 'authorIs' | 'itemIs'>, RunnableBaseOptions {
-    //logger: Logger;
-    subredditName: string;
-    //resources: SubredditResources;
+export interface ActionRuntimeOptions {
+    checkName: string
+    subredditName: string
     client: ExtendedSnoowrap;
-    emitter: EventEmitter
+    emitter: EventEmitter;
+    resources: SubredditResources;
+    logger: Logger;
+}
+
+export interface ActionOptions extends Omit<ActionConfig, 'authorIs' | 'itemIs'>, RunnableBaseOptions, ActionRuntimeOptions {
 }
 
 export interface ActionConfig extends RunnableBaseJson {

src/App.ts

@@ -4,24 +4,27 @@ import {getLogger} from "./Utils/loggerFactory";
 import {DatabaseMigrationOptions, OperatorConfig, OperatorConfigWithFileContext, OperatorFileConfig} from "./Common/interfaces";
 import Bot from "./Bot";
 import LoggedError from "./Utils/LoggedError";
-import {mergeArr, sleep} from "./util";
-import {copyFile} from "fs/promises";
+import {generateRandomName, mergeArr, sleep} from "./util";
+import {copyFile, open} from "fs/promises";
 import {constants} from "fs";
-import {Connection} from "typeorm";
+import {Connection, DataSource, Repository} from "typeorm";
 import {ErrorWithCause} from "pony-cause";
 import {MigrationService} from "./Common/MigrationService";
 import {Invokee} from "./Common/Infrastructure/Atomic";
 import {DatabaseConfig} from "./Common/Infrastructure/Database";
+import {InviteData} from "./Web/Common/interfaces";
+import {BotInvite} from "./Common/Entities/BotInvite";
 
 export class App {
 
     bots: Bot[] = [];
     logger: Logger;
     dbLogger: Logger;
-    database: Connection
+    database: DataSource
     startedAt: Dayjs = dayjs();
     ranMigrations: boolean = false;
     migrationBlocker?: string;
+    friendly?: string;
 
     config: OperatorConfig;
 
@@ -30,6 +33,7 @@ export class App {
     fileConfig: OperatorFileConfig;
 
     migrationService: MigrationService;
+    inviteRepo: Repository<BotInvite>;
 
     constructor(config: OperatorConfigWithFileContext) {
         const {
@@ -49,6 +53,8 @@ export class App {
         this.logger = getLogger(config.logging);
         this.dbLogger = this.logger.child({labels: ['Database']}, mergeArr);
         this.database = database;
+        this.inviteRepo = this.database.getRepository(BotInvite);
+        this.friendly = this.config.api.friendly;
 
         this.logger.info(`Operators: ${name.length === 0 ? 'None Specified' : name.join(', ')}`)
 
@@ -114,6 +120,8 @@ export class App {
             return;
         }
 
+        await this.checkFriendlyName();
+
         if(this.bots.length > 0) {
             this.logger.info('Bots already exist, will stop and destroy these before building new ones.');
             await this.destroy(causedBy);
@@ -133,7 +141,7 @@ export class App {
         for (const b of this.bots) {
             if (b.error === undefined) {
                 try {
-                    await b.testClient();
+                    await b.init();
                     await b.buildManagers();
                     await sleep(2000);
                     b.runManagers(causedBy).catch((err) => {
@@ -161,4 +169,54 @@ export class App {
             await b.destroy(causedBy);
         }
     }
+
+    async checkFriendlyName() {
+        if(this.friendly === undefined) {
+            let randFriendly: string = generateRandomName();
+            this.logger.verbose(`No friendly name set for Server. Generated: ${randFriendly}`);
+
+            const exists = async (name: string) => {
+                const existing = await this.inviteRepo.findBy({instance: name});
+                return existing.length > 0;
+            }
+            while (await exists(randFriendly)) {
+                let oldFriendly = randFriendly;
+                randFriendly = generateRandomName();
+                this.logger.verbose(`${oldFriendly} already exists! Generated: ${randFriendly}`);
+            }
+
+            this.friendly = randFriendly;
+            this.fileConfig.document.setFriendlyName(this.friendly);
+
+            const handle = await open(this.fileConfig.document.location as string, 'w');
+            await handle.writeFile(this.fileConfig.document.toString());
+            await handle.close();
+            this.logger.verbose(`Wrote ${randFriendly} as friendly server name to config.`);
+        }
+    }
+
+    async getInviteById(id: string): Promise<BotInvite | undefined> {
+        const invite = await this.inviteRepo.findOne({where: {id, instance: this.friendly}});
+        if(invite === null) {
+            return undefined;
+        }
+        return invite;
+    }
+
+    async getInviteIds(): Promise<string[]> {
+        if(!this.ranMigrations) {
+            // not ready!
+            return [];
+        }
+        const invites = await this.inviteRepo.findBy({instance: this.friendly});
+        return invites.map(x => x.id);
+    }
+
+    async addInvite(data: InviteData): Promise<InviteData> {
+        return await this.inviteRepo.save(new BotInvite(data));
+    }
+
+    async deleteInvite(id: string): Promise<void> {
+        await this.inviteRepo.delete({ id });
+    }
 }

src/Bot/index.ts

@@ -1,4 +1,5 @@
-import Snoowrap, {Comment, ConfigOptions, RedditUser, Submission, Subreddit} from "snoowrap";
+import Snoowrap, {Comment, ConfigOptions, RedditUser, Submission} from "snoowrap";
+import {Subreddit} from "snoowrap/dist/objects"
 import {Logger} from "winston";
 import dayjs, {Dayjs} from "dayjs";
 import {Duration} from "dayjs/plugin/duration";
@@ -13,13 +14,13 @@ import {
     USER
 } from "../Common/interfaces";
 import {
-    createRetryHandler, difference,
+    createRetryHandler, symmetricalDifference,
     formatNumber, getExceptionMessage, getUserAgent,
     mergeArr,
     parseBool,
     parseDuration, parseMatchMessage, parseRedditEntity,
-    parseSubredditName, RetryOptions,
-    sleep
+    parseSubredditName, partition, RetryOptions,
+    sleep, intersect
 } from "../util";
 import {Manager} from "../Subreddit/Manager";
 import {ExtendedSnoowrap, ProxiedSnoowrap} from "../Utils/SnoowrapClients";
@@ -27,7 +28,15 @@ import {CommentStream, ModQueueStream, SPoll, SubmissionStream, UnmoderatedStrea
 import {BotResourcesManager} from "../Subreddit/SubredditResources";
 import LoggedError from "../Utils/LoggedError";
 import pEvent from "p-event";
-import {SimpleError, isRateLimitError, isRequestError, isScopeError, isStatusError, CMError} from "../Utils/Errors";
+import {
+    SimpleError,
+    isRateLimitError,
+    isRequestError,
+    isScopeError,
+    isStatusError,
+    CMError,
+    ISeriousError, definesSeriousError
+} from "../Utils/Errors";
 import {ErrorWithCause} from "pony-cause";
 import {DataSource, Repository} from "typeorm";
 import {Bot as BotEntity} from '../Common/Entities/Bot';
@@ -41,19 +50,34 @@ import {ManagerRunState} from "../Common/Entities/EntityRunState/ManagerRunState
 import {Invokee, PollOn} from "../Common/Infrastructure/Atomic";
 import {FilterCriteriaDefaults} from "../Common/Infrastructure/Filters/FilterShapes";
 import {snooLogWrapper} from "../Utils/loggerFactory";
+import {InfluxClient} from "../Common/Influx/InfluxClient";
+import {Point} from "@influxdata/influxdb-client";
+import {
+    BotInstanceFunctions, HydratedSubredditInviteData,
+    NormalizedManagerResponse,
+    SubredditInviteData,
+    SubredditInviteDataPersisted, SubredditOnboardingReadiness
+} from "../Web/Common/interfaces";
+import {AuthorEntity} from "../Common/Entities/AuthorEntity";
+import {Guest, GuestEntityData} from "../Common/Entities/Guest/GuestInterfaces";
+import {guestEntitiesToAll, guestEntityToApiGuest} from "../Common/Entities/Guest/GuestEntity";
+import {SubredditInvite} from "../Common/Entities/SubredditInvite";
+import {dayjsDTFormat} from "../Common/defaults";
 
-class Bot {
+class Bot implements BotInstanceFunctions {
 
     client!: ExtendedSnoowrap;
     logger!: Logger;
     logs: LogInfo[] = [];
     wikiLocation: string;
     dryRun?: true | undefined;
+    inited: boolean = false;
     running: boolean = false;
     subreddits: string[];
     excludeSubreddits: string[];
     filterCriteriaDefaults?: FilterCriteriaDefaults
     subManagers: Manager[] = [];
+    moderatedSubreddits: Subreddit[] = []
     heartbeatInterval: number;
     nextHeartbeat: Dayjs = dayjs();
     heartBeating: boolean = false;
@@ -71,6 +95,7 @@ class Bot {
     botName?: string;
     botLink?: string;
     botAccount?: string;
+    botUser?: RedditUser;
     maxWorkers: number;
     startedAt: Dayjs = dayjs();
     sharedStreams: PollOn[] = [];
@@ -90,9 +115,15 @@ class Bot {
 
     config: BotInstanceConfig;
 
+    influxClients: InfluxClient[] = [];
+
     database: DataSource
     invokeeRepo: Repository<InvokeeType>;
     runTypeRepo: Repository<RunStateType>;
+    managerRepo: Repository<ManagerEntity>;
+    authorRepo: Repository<AuthorEntity>;
+    subredditInviteRepo: Repository<SubredditInvite>
+    botRepo: Repository<BotEntity>
     botEntity!: BotEntity
 
     getBotName = () => {
@@ -154,6 +185,10 @@ class Bot {
         this.database = database;
         this.invokeeRepo = this.database.getRepository(InvokeeType);
         this.runTypeRepo = this.database.getRepository(RunStateType);
+        this.managerRepo = this.database.getRepository(ManagerEntity);
+        this.authorRepo = this.database.getRepository(AuthorEntity);
+        this.subredditInviteRepo = this.database.getRepository(SubredditInvite)
+        this.botRepo = this.database.getRepository(BotEntity)
         this.config = config;
         this.dryRun = parseBool(dryRun) === true ? true : undefined;
         this.softLimit = softLimit;
@@ -177,8 +212,11 @@ class Bot {
 
         this.logger.stream().on('log', (log: LogInfo) => {
             if(log.bot !== undefined && log.bot === this.getBotName() && log.subreddit === undefined) {
-                const combinedLogs = [log, ...this.logs];
-                this.logs = combinedLogs.slice(0, 301);
+                this.logs.unshift(log);
+                if(this.logs.length > 300) {
+                    // remove all elements starting from the 300th index (301st item)
+                    this.logs.splice(300);
+                }
             }
         });
 
@@ -311,33 +349,22 @@ class Bot {
         }
     }
 
-    async testClient(initial = true) {
-        try {
-            // @ts-ignore
-            await this.client.getMe();
-            this.logger.info('Test API call successful');
-        } catch (err: any) {
-            if (initial) {
-                this.logger.error('An error occurred while trying to initialize the Reddit API Client which would prevent the entire application from running.');
-            }
-            const hint = getExceptionMessage(err, {
-                401: 'Likely a credential is missing or incorrect. Check clientId, clientSecret, refreshToken, and accessToken',
-                400: 'Credentials may have been invalidated manually or by reddit due to behavior',
-            });
-            let msg = `Error occurred while testing Reddit API client${hint !== undefined ? `: ${hint}` : ''}`;
-            this.error = msg;
-            const clientError = new CMError(msg, {cause: err});
-            clientError.logged = true;
-            this.logger.error(clientError);
-            throw clientError;
-        }
-    }
+    async init() {
+
+        if(this.inited) {
+            return;
+        }
+
+        let user: RedditUser;
+        try {
+            user = await this.testClient();
+        } catch(err: any) {
+            this.logger.error('An error occurred while trying to initialize the Reddit API Client which would prevent the Bot from running.');
+            throw err;
+        }
 
-    async buildManagers(subreddits: string[] = []) {
-        let availSubs = [];
-        // @ts-ignore
-        const user = await this.client.getMe().fetch();
         this.cacheManager.botName = user.name;
+        this.botUser = user;
         this.botLink = `https://reddit.com/user/${user.name}`;
         this.botAccount = `u/${user.name}`;
         this.logger.info(`Reddit API Limit Remaining: ${this.client.ratelimitRemaining}`);
@@ -364,35 +391,87 @@ class Bot {
             this.botEntity = b;
         }
 
+        if(this.config.opInflux !== undefined) {
+            this.influxClients.push(this.config.opInflux.childClient(this.logger, {bot: user.name}));
+            if(this.config.influxConfig !== undefined) {
+                const iClient = new InfluxClient(this.config.influxConfig, this.logger, {bot: user.name});
+                await iClient.isReady();
+                this.influxClients.push(iClient);
+            }
+        }
+
+        this.inited = true;
+    }
+
+    // @ts-ignore
+    async testClient(initial = true) {
+        try {
+            // @ts-ignore
+            const user = await this.client.getMe().fetch();
+            this.logger.info('Test API call successful');
+            return user;
+        } catch (err: any) {
+            if (initial) {
+                this.logger.error('An error occurred while trying to initialize the Reddit API Client which would prevent the entire application from running.');
+            }
+            const hint = getExceptionMessage(err, {
+                401: 'Likely a credential is missing or incorrect. Check clientId, clientSecret, refreshToken, and accessToken',
+                400: 'Credentials may have been invalidated manually or by reddit due to behavior',
+            });
+            let msg = `Error occurred while testing Reddit API client${hint !== undefined ? `: ${hint}` : ''}`;
+            this.error = msg;
+            const clientError = new CMError(msg, {cause: err});
+            clientError.logged = true;
+            this.logger.error(clientError);
+            throw clientError;
+        }
+    }
+
+    async getModeratedSubreddits(refresh = false) {
+
+        if(this.moderatedSubreddits.length > 0 && !refresh) {
+            return this.moderatedSubreddits;
+        }
+
         let subListing = await this.client.getModeratedSubreddits({count: 100});
-        while(!subListing.isFinished) {
+        while (!subListing.isFinished) {
             subListing = await subListing.fetchMore({amount: 100});
         }
-        availSubs = subListing.filter(x => x.display_name !== `u_${user.name}`);
+        const availSubs = subListing.filter(x => x.display_name !== `u_${this.botUser?.name}`);
+        this.moderatedSubreddits = availSubs;
+        return availSubs;
+    }
 
-        this.logger.info(`u/${user.name} is a moderator of these subreddits: ${availSubs.map(x => x.display_name_prefixed).join(', ')}`);
+    async buildManagers(subreddits: string[] = []) {
+        await this.init();
+
+        this.logger.verbose('Syncing subreddits to moderate with managers...');
+
+        const availSubs = await this.getModeratedSubreddits(true);
+
+        this.logger.verbose(`${this.botAccount} is a moderator of these subreddits: ${availSubs.map(x => x.display_name_prefixed).join(', ')}`);
 
         let subsToRun: Subreddit[] = [];
         const subsToUse = subreddits.length > 0 ? subreddits.map(parseSubredditName) : this.subreddits;
         if (subsToUse.length > 0) {
-            this.logger.info(`Operator-defined subreddit constraints detected (CLI argument or environmental variable), will try to run on: ${subsToUse.join(', ')}`);
-            for (const sub of subsToUse) {
+            this.logger.info(`Operator-specified subreddit constraints detected, will only use these: ${subsToUse.join(', ')}`);
+            const availSubsCI = availSubs.map(x => x.display_name.toLowerCase());
+            const [foundSubs, notFoundSubs] = partition(subsToUse, (aSub) => availSubsCI.includes(aSub.toLowerCase()));
+            if(notFoundSubs.length > 0) {
+                this.logger.warn(`Will not run some operator-specified subreddits because they are not modded by, or do not have appropriate mod permissions for, this bot: ${notFoundSubs.join(', ')}`);
+            }
+
+            for (const sub of foundSubs) {
                 const asub = availSubs.find(x => x.display_name.toLowerCase() === sub.toLowerCase())
-                if (asub === undefined) {
-                    this.logger.warn(`Will not run on ${sub} because is not modded by, or does not have appropriate permissions to mod with, for this client.`);
-                } else {
-                    // @ts-ignore
-                    const fetchedSub = await asub.fetch();
-                    subsToRun.push(fetchedSub);
-                }
+                subsToRun.push(asub as Subreddit);
             }
         } else {
             if(this.excludeSubreddits.length > 0) {
-                this.logger.info(`Will run on all moderated subreddits but own profile and user-defined excluded: ${this.excludeSubreddits.join(', ')}`);
+                this.logger.info(`Will run on all moderated subreddits EXCEPT own profile and operator-defined excluded: ${this.excludeSubreddits.join(', ')}`);
                 const normalExcludes = this.excludeSubreddits.map(x => x.toLowerCase());
                 subsToRun = availSubs.filter(x => !normalExcludes.includes(x.display_name.toLowerCase()));
             } else {
-                this.logger.info(`No user-defined subreddit constraints detected, will run on all moderated subreddits EXCEPT own profile (${this.botAccount})`);
+                this.logger.info(`No operator-defined subreddit constraints detected, will run on all moderated subreddits EXCEPT own profile (${this.botAccount})`);
                 subsToRun = availSubs;
             }
         }
@@ -415,30 +494,66 @@ class Bot {
                     return acc;
                 }
             }, []);
-            const notMatched = difference(normalizedOverrideNames, subsToRunNames);
+            const notMatched = symmetricalDifference(normalizedOverrideNames, subsToRunNames);
             if(notMatched.length > 0) {
                 this.logger.warn(`There are overrides defined for subreddits the bot is not running. Check your spelling! Overrides not matched: ${notMatched.join(', ')}`);
             }
         }
 
+        let subManagersChanged = false;
 
-        // get configs for subs we want to run on and build/validate them
+        const subsToRunNames = subsToRun.map(x => x.display_name.toLowerCase());
+
+        // first stop and remove any managers with subreddits not in subsToRun
+        // -- this covers scenario where bot is running and mods of a subreddit de-mod the bot
+        // -- or where the include/exclude subs list changed from operator (not yet implemented)
+        if(this.subManagers.length > 0) {
+            let index = 0;
+            for(const manager of this.subManagers) {
+                if(!subsToRunNames.includes(manager.subreddit.display_name.toLowerCase())) {
+                    subManagersChanged = true;
+                    // determine if bot was de-modded
+                    const deModded = !availSubs.some(x => x.display_name.toLowerCase() === manager.subreddit.display_name.toLowerCase());
+                    this.logger.warn(`Stopping and removing manager for ${manager.subreddit.display_name.toLowerCase()} because it is ${deModded ? 'no longer moderated by this bot' : 'not in the list of subreddits to moderate'}`);
+                    await manager.destroy('system', {reason: deModded ? 'No longer moderated by this bot' : 'Subreddit is not in moderated list'});
+                    this.subManagers.splice(index, 1);
+                }
+                index++;
+            }
+        }
+
+        // then create any managers that don't already exist
+        // -- covers init scenario
+        // -- and in-situ adding subreddits IE bot is modded to a new subreddit while CM is running
+        const subsToInit: string[] = [];
         for (const sub of subsToRun) {
-            try {
-                this.subManagers.push(await this.createManager(sub));
-            } catch (err: any) {
+            if(!this.subManagers.some(x => x.subreddit.display_name === sub.display_name)) {
+                subManagersChanged = true;
+                this.logger.info(`Manager for ${sub.display_name_prefixed} not found in existing managers. Creating now...`);
+                subsToInit.push(sub.display_name);
+                try {
+                    this.subManagers.push(await this.createManager(sub));
+                } catch (err: any) {
 
+                }
             }
         }
-        for(const m of this.subManagers) {
+        for(const subName of subsToInit) {
             try {
-                await this.initManager(m);
+                const m = this.subManagers.find(x => x.subreddit.display_name === subName);
+                await this.initManager(m as Manager);
             } catch (err: any) {
 
             }
         }
 
-        this.parseSharedStreams();
+        if(!subManagersChanged) {
+            this.logger.verbose('All managers were already synced!');
+        } else {
+            this.parseSharedStreams();
+        }
+
+        return subManagersChanged;
     }
 
     parseSharedStreams() {
@@ -550,7 +665,7 @@ class Bot {
             await manager.parseConfiguration('system', true, {suppressNotification: true, suppressChangeEvent: true});
         } catch (err: any) {
             if(err.logged !== true) {
-                const normalizedError = new ErrorWithCause(`Bot could not initialize manager because config was not valid`, {cause: err});
+                const normalizedError = new ErrorWithCause(`Bot could not initialize manager`, {cause: err});
                 // @ts-ignore
                 this.logger.error(normalizedError, {subreddit: manager.subreddit.display_name_prefixed});
             } else {
@@ -559,7 +674,7 @@ class Bot {
         }
     }
 
-    async createManager(sub: Subreddit): Promise<Manager> {
+    async createManager(subVal: Subreddit): Promise<Manager> {
         const {
             flowControlDefaults: {
                 maxGotoDepth: botMaxDefault
@@ -570,6 +685,15 @@ class Bot {
             } = {}
         } = this.config;
 
+        let sub = subVal;
+        // make sure the subreddit is fully fetched
+        // @ts-ignore
+        if(subVal._hasFetched === false) {
+            // @ts-ignore
+            sub = await subVal.fetch();
+        }
+
+
         const override = overrides.find(x => {
             const configName = parseRedditEntity(x.name).name;
             if(configName !== undefined) {
@@ -586,15 +710,15 @@ class Bot {
             databaseConfig: {
                 retention = undefined
             } = {},
+            wikiConfig = this.wikiLocation,
         } = override || {};
 
-        const managerRepo = this.database.getRepository(ManagerEntity);
         const subRepo = this.database.getRepository(SubredditEntity)
         let subreddit = await subRepo.findOne({where: {id: sub.name}});
         if(subreddit === null) {
             subreddit = await subRepo.save(new SubredditEntity({id: sub.name, name: sub.display_name}))
         }
-        let managerEntity = await managerRepo.findOne({
+        let managerEntity = await this.managerRepo.findOne({
             where: {
                 bot: {
                     id: this.botEntity.id
@@ -603,12 +727,15 @@ class Bot {
                     id: subreddit.id
                 }
             },
+            relations: {
+                guests: true
+            }
         });
         if(managerEntity === undefined || managerEntity === null) {
             const invokee = await this.invokeeRepo.findOneBy({name: SYSTEM}) as InvokeeType;
             const runType = await this.runTypeRepo.findOneBy({name: STOPPED}) as RunStateType;
 
-            managerEntity = await managerRepo.save(new ManagerEntity({
+            managerEntity = await this.managerRepo.save(new ManagerEntity({
                 name: sub.display_name,
                 bot: this.botEntity,
                 subreddit: subreddit as SubredditEntity,
@@ -621,7 +748,7 @@ class Bot {
         const manager = new Manager(sub, this.client, this.logger, this.cacheManager, {
             dryRun: this.dryRun,
             sharedStreams: this.sharedStreams,
-            wikiLocation: this.wikiLocation,
+            wikiLocation: wikiConfig,
             botName: this.botName as string,
             maxWorkers: this.maxWorkers,
             filterCriteriaDefaults: this.filterCriteriaDefaults,
@@ -630,6 +757,7 @@ class Bot {
             managerEntity: managerEntity as ManagerEntity,
             statDefaults: (statDefaultsFromOverride ?? databaseStatisticsDefaults) as DatabaseStatisticsOperatorConfig,
             retention,
+            influxClients: this.influxClients,
         });
         // all errors from managers will count towards bot-level retry count
         manager.on('error', async (err) => await this.panicOnRetries(err));
@@ -662,36 +790,50 @@ class Bot {
     }
 
     async checkModInvites() {
-        const subs: string[] = await this.cacheManager.getPendingSubredditInvites();
-        for (const name of subs) {
-            try {
-                // @ts-ignore
-                await this.client.getSubreddit(name).acceptModeratorInvite();
-                this.logger.info(`Accepted moderator invite for r/${name}!`);
-                await this.cacheManager.deletePendingSubredditInvite(name);
-                // @ts-ignore
-                const sub = await this.client.getSubreddit(name);
-                this.logger.info(`Attempting to add manager for r/${name}`);
+        this.logger.debug('Checking onboarding invites...');
+        const expired = this.botEntity.getSubredditInvites().filter(x => x.expiresAt !== undefined && x.expiresAt.isSameOrBefore(dayjs()));
+        for (const exp of expired) {
+            this.logger.debug(`Onboarding invite for ${exp.subreddit} expired at ${exp.expiresAt?.format(dayjsDTFormat)}`);
+            await this.deleteSubredditInvite(exp);
+        }
+
+        for (const subInvite of this.botEntity.getSubredditInvites()) {
+            if (subInvite.canAutomaticallyAccept()) {
                 try {
-                    const manager =  await this.createManager(sub);
-                    this.logger.info(`Starting manager for r/${name}`);
-                    this.subManagers.push(manager);
-                    await this.initManager(manager);
-                    await manager.start('system', {reason: 'Caused by creation due to moderator invite'});
-                    await this.runSharedStreams();
+                    await this.acceptModInvite(subInvite);
+                    await this.deleteSubredditInvite(subInvite);
                 } catch (err: any) {
-                    if (!(err instanceof LoggedError)) {
+                    if(definesSeriousError(err) && !err.isSerious) {
+                        this.logger.warn(err);
+                    } else {
                         this.logger.error(err);
                     }
                 }
-            } catch (err: any) {
-                if (err.message.includes('NO_INVITE_FOUND')) {
-                    this.logger.warn(`No pending moderation invite for r/${name} was found`);
-                } else if (isStatusError(err) && err.statusCode === 403) {
-                    this.logger.error(`Error occurred while checking r/${name} for a pending moderation invite. It is likely that this bot does not have the 'modself' oauth permission. Error: ${err.message}`);
+            } else {
+              this.logger.debug(`Cannot try to automatically accept mod invite for ${subInvite.subreddit} because it has additional settings that require moderator approval`);
+            }
+        }
+    }
+
+    async acceptModInvite(invite: SubredditInvite) {
+        const {subreddit: name} = invite;
+        try {
+            // @ts-ignore
+            await this.client.getSubreddit(name).acceptModeratorInvite();
+            this.logger.info(`Accepted moderator invite for r/${name}!`);
+        } catch (err: any) {
+            if (err.message.includes('NO_INVITE_FOUND')) {
+                throw new SimpleError(`No pending moderation invite for r/${name} was found`, {isSerious: false});
+            } else if (isStatusError(err) && err.statusCode === 403) {
+                let msg = `Error occurred while checking r/${name} for a pending moderation invite.`;
+                if(!this.client.scope.includes('modself')) {
+                    msg = `${msg} This bot must have the 'modself' oauth permission in order to accept invites.`;
                 } else {
-                    this.logger.error(`Error occurred while checking r/${name} for a pending moderation invite. Error: ${err.message}`);
+                    msg = `${msg} If this subreddit is private it is likely no moderation invite exists.`;
                 }
+                throw new CMError(msg, {cause: err})
+            } else {
+                throw new CMError(`Error occurred while checking r/${name} for a pending moderation invite.`, {cause: err});
             }
         }
     }
@@ -742,9 +884,15 @@ class Bot {
     async healthLoop() {
         while (this.running) {
             await sleep(5000);
+            const time = dayjs().valueOf()
+            await this.apiHealthCheck(time);
+            await this.guestModCleanup();
             if (!this.running) {
                 break;
             }
+            for(const m of this.subManagers) {
+                await m.writeHealthMetrics(time);
+            }
             const now = dayjs();
             if (now.isSameOrAfter(this.nextNannyCheck)) {
                 try {
@@ -757,8 +905,17 @@ class Bot {
             }
             if(now.isSameOrAfter(this.nextHeartbeat)) {
                 try {
-                    await this.heartbeat();
+
+                    // run sanity check to see if there is a service issue
+                    try {
+                        await this.testClient(false);
+                    } catch (err: any) {
+                        throw new SimpleError(`Something isn't right! This could be a Reddit API issue (service is down? buggy??) or an issue with the Bot account. Will not run heartbeat operations and will wait until next heartbeat (${dayjs.duration(this.nextHeartbeat.diff(dayjs())).humanize()}) to try again`);
+                    }
+
                     await this.checkModInvites();
+                    await this.buildManagers();
+                    await this.heartbeat();
                 } catch (err: any) {
                     this.logger.error(`Error occurred during heartbeat check: ${err.message}`);
                 }
@@ -770,6 +927,73 @@ class Bot {
         this.emitter.emit('healthStopped');
     }
 
+    getApiUsageSummary() {
+        const depletion = this.apiEstDepletion === undefined ? 'Not Calculated' : this.apiEstDepletion.humanize();
+        return`API Usage Rolling Avg: ${formatNumber(this.apiRollingAvg)}/s | Est Depletion: ${depletion} (${formatNumber(this.depletedInSecs, {toFixed: 0})} seconds)`;
+    }
+
+    async apiHealthCheck(time?: number) {
+
+        const rollingSample = this.apiSample.slice(0, 7)
+        rollingSample.unshift(this.client.ratelimitRemaining);
+        this.apiSample = rollingSample;
+        const diff = this.apiSample.reduceRight((acc: number[], curr, index) => {
+            if (this.apiSample[index + 1] !== undefined) {
+                const d = Math.abs(curr - this.apiSample[index + 1]);
+                if (d === 0) {
+                    return [...acc, 0];
+                }
+                return [...acc, d / 10];
+            }
+            return acc;
+        }, []);
+        const diffTotal = diff.reduce((acc, curr) => acc + curr, 0);
+        if(diffTotal === 0 || diff.length === 0) {
+            this.apiRollingAvg = 0;
+        } else {
+            this.apiRollingAvg = diffTotal / diff.length; // api requests per second
+        }
+        this.depletedInSecs = this.apiRollingAvg === 0 ? Number.POSITIVE_INFINITY :  this.client.ratelimitRemaining / this.apiRollingAvg; // number of seconds until current remaining limit is 0
+        // if depletion/api usage is 0 we need a sane value to use here for both displaying in logs as well as for api nanny. 10 years seems reasonable
+        this.apiEstDepletion = dayjs.duration((this.depletedInSecs === Number.POSITIVE_INFINITY ? {years: 10} : {seconds: this.depletedInSecs}));
+
+        if(this.influxClients.length > 0) {
+            const apiMeasure = new Point('apiHealth')
+                .intField('remaining', this.client.ratelimitRemaining)
+                .stringField('nannyMod', this.nannyMode ?? 'none');
+
+            if(time !== undefined) {
+                apiMeasure.timestamp(time);
+            }
+
+            if(this.apiSample.length > 1) {
+                const curr = this.apiSample[0];
+                const last = this.apiSample[1];
+                if(curr <= last) {
+                    apiMeasure.intField('used', last - curr);
+                }
+            }
+
+            for(const iclient of this.influxClients) {
+                await iclient.writePoint(apiMeasure);
+            }
+        }
+
+    }
+
+    async guestModCleanup() {
+        const now = dayjs();
+
+        for(const m of this.subManagers) {
+            const expiredGuests = m.managerEntity.getGuests().filter(x => x.expiresAt.isBefore(now));
+            if(expiredGuests.length > 0) {
+                m.managerEntity.removeGuestById(expiredGuests.map(x => x.id));
+                m.logger.info(`Removed expired Guest Mods: ${expiredGuests.map(x => x.author.name).join(', ')}`);
+                await this.managerRepo.save(m.managerEntity);
+            }
+        }
+    }
+
     async retentionCleanup() {
         const now = dayjs();
         if(now.isSameOrAfter(this.nextRetentionCheck)) {
@@ -783,15 +1007,8 @@ class Bot {
     }
 
     async heartbeat() {
-        const heartbeat = `HEARTBEAT -- API Remaining: ${this.client.ratelimitRemaining} | Usage Rolling Avg: ~${formatNumber(this.apiRollingAvg)}/s | Est Depletion: ${this.apiEstDepletion === undefined ? 'N/A' : this.apiEstDepletion.humanize()} (${formatNumber(this.depletedInSecs, {toFixed: 0})} seconds)`
-        this.logger.info(heartbeat);
+        this.logger.info(`HEARTBEAT -- ${this.getApiUsageSummary()}`);
 
-        // run sanity check to see if there is a service issue
-        try {
-            await this.testClient(false);
-        } catch (err: any) {
-            throw new SimpleError(`Something isn't right! This could be a Reddit API issue (service is down? buggy??) or an issue with the Bot account. Will not run heartbeat operations and will wait until next heartbeat (${dayjs.duration(this.nextHeartbeat.diff(dayjs())).humanize()}) to try again`);
-        }
         let startedAny = false;
 
         for (const s of this.subManagers) {
@@ -844,6 +1061,7 @@ class Bot {
 
     async runApiNanny() {
         try {
+            this.logger.debug(this.getApiUsageSummary());
             this.nextExpiration = dayjs(this.client.ratelimitExpiration);
             const nowish = dayjs().add(10, 'second');
             if (nowish.isAfter(this.nextExpiration)) {
@@ -867,30 +1085,12 @@ class Bot {
                 }
                 this.nextExpiration = dayjs(this.client.ratelimitExpiration);
             }
-            const rollingSample = this.apiSample.slice(0, 7)
-            rollingSample.unshift(this.client.ratelimitRemaining);
-            this.apiSample = rollingSample;
-            const diff = this.apiSample.reduceRight((acc: number[], curr, index) => {
-                if (this.apiSample[index + 1] !== undefined) {
-                    const d = Math.abs(curr - this.apiSample[index + 1]);
-                    if (d === 0) {
-                        return [...acc, 0];
-                    }
-                    return [...acc, d / 10];
-                }
-                return acc;
-            }, []);
-            this.apiRollingAvg = diff.reduce((acc, curr) => acc + curr, 0) / diff.length; // api requests per second
-            this.depletedInSecs = this.client.ratelimitRemaining / this.apiRollingAvg; // number of seconds until current remaining limit is 0
-            this.apiEstDepletion = dayjs.duration({seconds: this.depletedInSecs});
-            this.logger.debug(`API Usage Rolling Avg: ${formatNumber(this.apiRollingAvg)}/s | Est Depletion: ${this.apiEstDepletion.humanize()} (${formatNumber(this.depletedInSecs, {toFixed: 0})} seconds)`);
-
 
             let hardLimitHit = false;
-            if (typeof this.hardLimit === 'string') {
+            if (typeof this.hardLimit === 'string' && this.apiEstDepletion !== undefined) {
                 const hardDur = parseDuration(this.hardLimit);
                 hardLimitHit = hardDur.asSeconds() > this.apiEstDepletion.asSeconds();
-            } else {
+            } else if(typeof this.hardLimit === 'number') {
                 hardLimitHit = this.hardLimit > this.client.ratelimitRemaining;
             }
 
@@ -899,7 +1099,6 @@ class Bot {
                     return;
                 }
                 this.logger.info(`Detected HARD LIMIT of ${this.hardLimit} remaining`, {leaf: 'Api Nanny'});
-                this.logger.info(`API Remaining: ${this.client.ratelimitRemaining} | Usage Rolling Avg: ${this.apiRollingAvg}/s | Est Depletion: ${this.apiEstDepletion.humanize()} (${formatNumber(this.depletedInSecs, {toFixed: 0})} seconds)`, {leaf: 'Api Nanny'});
                 this.logger.info(`All subreddit event polling has been paused`, {leaf: 'Api Nanny'});
 
                 for (const m of this.subManagers) {
@@ -916,10 +1115,10 @@ class Bot {
             }
 
             let softLimitHit = false;
-            if (typeof this.softLimit === 'string') {
+            if (typeof this.softLimit === 'string' && this.apiEstDepletion !== undefined) {
                 const softDur = parseDuration(this.softLimit);
                 softLimitHit = softDur.asSeconds() > this.apiEstDepletion.asSeconds();
-            } else {
+            } else if(typeof this.softLimit === 'number') {
                 softLimitHit = this.softLimit > this.client.ratelimitRemaining;
             }
 
@@ -928,7 +1127,6 @@ class Bot {
                     return;
                 }
                 this.logger.info(`Detected SOFT LIMIT of ${this.softLimit} remaining`, {leaf: 'Api Nanny'});
-                this.logger.info(`API Remaining: ${this.client.ratelimitRemaining} | Usage Rolling Avg: ${formatNumber(this.apiRollingAvg)}/s | Est Depletion: ${this.apiEstDepletion.humanize()} (${formatNumber(this.depletedInSecs, {toFixed: 0})} seconds)`, {leaf: 'Api Nanny'});
                 this.logger.info('Trying to detect heavy usage subreddits...', {leaf: 'Api Nanny'});
                 let threshold = 0.5;
                 let offenders = this.subManagers.filter(x => {
@@ -986,6 +1184,251 @@ class Bot {
             throw err;
         }
     }
+
+    getManagerNames(): string[] {
+        return this.subManagers.map(x => x.displayLabel);
+    }
+
+    getSubreddits(normalized = true): string[] {
+        return normalized ? this.subManagers.map(x => parseRedditEntity(x.subreddit.display_name).name) : this.subManagers.map(x => x.subreddit.display_name);
+    }
+
+    getGuestManagers(user: string): NormalizedManagerResponse[] {
+        return this.subManagers.filter(x => x.managerEntity.getGuests().map(y => y.author.name).includes(user)).map(x => x.toNormalizedManager());
+    }
+
+    getGuestSubreddits(user: string): string[] {
+        return this.getGuestManagers(user).map(x => x.subredditNormal);
+    }
+
+    getAccessibleSubreddits(user: string, subreddits: string[] = []): string[] {
+        const normalSubs = subreddits.map(x => parseRedditEntity(x).name);
+        const moderatedSubs = intersect(normalSubs, this.getSubreddits());
+        const guestSubs = this.getGuestSubreddits(user);
+        return Array.from(new Set([...guestSubs, ...moderatedSubs]));
+    }
+
+    canUserAccessBot(user: string, subreddits: string[] = []) {
+        return this.getAccessibleSubreddits(user, subreddits).length > 0;
+    }
+
+    canUserAccessSubreddit(subreddit: string, user: string, subreddits: string[] = []): boolean {
+        return this.getAccessibleSubreddits(user, subreddits).includes(parseRedditEntity(subreddit).name);
+    }
+
+    async addGuest(userVal: string | string[], expiresAt: Dayjs, managerVal?: string | string[]) {
+        let managerNames: string[];
+        if(typeof managerVal === 'string') {
+            managerNames = [managerVal];
+        } else if(Array.isArray(managerVal)) {
+            managerNames = managerVal;
+        } else {
+            managerNames = this.subManagers.map(x => x.subreddit.display_name);
+        }
+
+        const cleanSubredditNames = managerNames.map(x => parseRedditEntity(x).name);
+        const userNames = typeof userVal === 'string' ? [userVal] : userVal;
+        const cleanUsers = userNames.map(x => parseRedditEntity(x.trim(), 'user').name);
+
+        const users: AuthorEntity[] = [];
+
+        for(const uName of cleanUsers) {
+            let user = await this.authorRepo.findOne({
+                where: {
+                    name: uName,
+                }
+            });
+
+            if(user === null) {
+                users.push(await this.authorRepo.save(new AuthorEntity({name: uName})));
+            } else {
+                users.push(user);
+            }
+        }
+
+        const newGuestData = users.map(x => ({author: x, expiresAt})) as GuestEntityData[];
+
+        let newGuests = new Map<string, Guest[]>();
+        const updatedManagerEntities: ManagerEntity[] = [];
+        for(const m of this.subManagers) {
+            if(!cleanSubredditNames.includes(m.subreddit.display_name)) {
+                continue;
+            }
+            const filteredGuests = m.managerEntity.addGuest(newGuestData);
+            updatedManagerEntities.push(m.managerEntity);
+            newGuests.set(m.displayLabel, filteredGuests.map(x => guestEntityToApiGuest(x)));
+            m.logger.info(`Added ${cleanUsers.join(', ')} as Guest`);
+        }
+
+        await this.managerRepo.save(updatedManagerEntities);
+
+        return newGuests;
+    }
+
+    async removeGuest(userVal: string | string[], managerVal?: string | string[]) {
+        let managerNames: string[];
+        if(typeof managerVal === 'string') {
+            managerNames = [managerVal];
+        } else if(Array.isArray(managerVal)) {
+            managerNames = managerVal;
+        } else {
+            managerNames = this.subManagers.map(x => x.subreddit.display_name);
+        }
+
+        const cleanSubredditNames = managerNames.map(x => parseRedditEntity(x).name);
+        const userNames = typeof userVal === 'string' ? [userVal] : userVal;
+        const cleanUsers = userNames.map(x => parseRedditEntity(x.trim(), 'user').name);
+
+        let newGuests = new Map<string, Guest[]>();
+        const updatedManagerEntities: ManagerEntity[] = [];
+        for(const m of this.subManagers) {
+            if(!cleanSubredditNames.includes(m.subreddit.display_name)) {
+                continue;
+            }
+            const filteredGuests = m.managerEntity.removeGuestByUser(cleanUsers);
+            updatedManagerEntities.push(m.managerEntity);
+            newGuests.set(m.displayLabel, filteredGuests.map(x => guestEntityToApiGuest(x)));
+            m.logger.info(`Removed ${cleanUsers.join(', ')} from Guests`);
+        }
+
+        await this.managerRepo.save(updatedManagerEntities);
+
+        return newGuests;
+    }
+
+    async addSubredditInvite(data: HydratedSubredditInviteData){
+        let sub: Subreddit;
+        let name: string;
+        if (data.subreddit instanceof Subreddit) {
+            sub = data.subreddit;
+            name = sub.display_name;
+        } else {
+            try {
+                const maybeName = parseRedditEntity(data.subreddit);
+                name = maybeName.name;
+            } catch (e: any) {
+                throw new SimpleError(`Value '${data.subreddit}' is not a valid subreddit name`);
+            }
+            try {
+                const [exists, foundSub] = await this.client.subredditExists(name);
+                if (!exists) {
+                    throw new SimpleError(`No subreddit with the name ${name} exists`);
+                }
+                if (foundSub !== undefined) {
+                    name = foundSub.display_name;
+                }
+            } catch (e: any) {
+                throw e;
+            }
+        }
+
+        if((await this.subredditInviteRepo.findOneBy({subreddit: name}))) {
+            throw new CMError(`Invite for ${name} already exists`);
+        }
+        const invite = new SubredditInvite({
+            subreddit: name,
+            initialConfig: data.initialConfig,
+            guests: data.guests,
+            bot: this.botEntity
+        })
+        await this.subredditInviteRepo.save(invite);
+        this.botEntity.addSubredditInvite(invite);
+        return invite;
+    }
+
+     getSubredditInvites(): SubredditInviteDataPersisted[] {
+        if(this.botEntity !== undefined) {
+            return this.botEntity.getSubredditInvites().map(x => x.toSubredditInviteData());
+        }
+        this.logger.warn('No bot entity found');
+        return [];
+    }
+
+    getInvite(id: string): SubredditInvite | undefined {
+        if(this.botEntity !== undefined) {
+            return this.botEntity.getSubredditInvites().find(x => x.id === id);
+        }
+        this.logger.warn('No bot entity found');
+        return undefined;
+    }
+
+    getOnboardingReadiness(invite: SubredditInvite): SubredditOnboardingReadiness {
+        const hasManager = this.subManagers.some(x => x.subreddit.display_name.toLowerCase() === invite.subreddit.toLowerCase());
+        const isMod = this.moderatedSubreddits.some(x => x.display_name.toLowerCase() === invite.subreddit.toLowerCase());
+        return {
+            hasManager,
+            isMod
+        };
+    }
+
+    async finishOnboarding(invite: SubredditInvite) {
+        const readiness = this.getOnboardingReadiness(invite);
+        if (readiness.hasManager || readiness.isMod) {
+            this.logger.info(`Bot is already a mod of ${invite.subreddit}. Finishing onboarding early.`);
+            await this.deleteSubredditInvite(invite);
+        }
+        try {
+            await this.acceptModInvite(invite);
+        } catch (e: any) {
+            throw e;
+        }
+        try {
+            // rebuild managers to get new subreddit
+            await this.buildManagers();
+            const manager = this.subManagers.find(x => x.subreddit.display_name.toLowerCase() === invite.subreddit.toLowerCase());
+            if (manager === undefined) {
+                throw new CMError('Accepted moderator invitation but could not find manager after rebuilding??');
+            }
+            const {guests = [], initialConfig} = invite;
+
+            // add guests
+            if (guests.length > 0) {
+                await this.addGuest(guests, dayjs().add(1, 'day'), manager.subreddit.display_name);
+            }
+
+            // set initial config
+            if (initialConfig !== undefined) {
+                let data: string;
+                try {
+                    const res = await manager.resources.getExternalResource(initialConfig);
+                    data = res.val;
+                } catch (e: any) {
+                    throw new CMError(`Accepted moderator invitation but error occurred while trying to fetch config from Initial Config value (${initialConfig})`, {cause: e});
+                }
+                try {
+                    await manager.writeConfig(data, 'Generated by Initial Config during onboarding')
+                } catch (e: any) {
+                    throw new CMError(`Accepted moderator invitation but error occurred while trying to set wiki config value from initial config (${initialConfig})`, {cause: e});
+                }
+
+                // it's ok if this fails because we've already done all the onboarding steps. user can still access the dashboard and all settings have been applied (even if they were invalid IE config)
+                manager.parseConfiguration('system', true).catch((err: any) => {
+                    if(err.logged !== true) {
+                        this.logger.error(err, {subreddit: manager.displayLabel});
+                    }
+                })
+            }
+        } catch(e: any) {
+            throw e;
+        } finally {
+            await this.deleteSubredditInvite(invite);
+        }
+    }
+
+    async deleteSubredditInvite(val: string | SubredditInvite) {
+        let invite: SubredditInvite;
+        if(val instanceof SubredditInvite) {
+            invite = val;
+        } else {
+            const maybeInvite = this.botEntity.getSubredditInvites().find(x => x.subreddit === val);
+            if(maybeInvite === undefined) {
+                throw new CMError(`No invite for subreddit ${val} exists for this Bot`);
+            }
+            invite = maybeInvite;
+        }
+        await this.subredditInviteRepo.delete({id: invite.id});
+        this.botEntity.removeSubredditInvite(invite);
+    }
 }
 
 export default Bot;

src/Check/index.ts

@@ -1,19 +1,18 @@
-import {RuleSet, IRuleSet, RuleSetJson, RuleSetObjectJson, isRuleSetJSON} from "../Rule/RuleSet";
-import {IRule, Rule, RuleJSONConfig} from "../Rule";
-import Action, {ActionConfig, ActionJson, StructuredActionJson} from "../Action";
+import {RuleSet, RuleSetConfigData, RuleSetConfigHydratedData, RuleSetConfigObject} from "../Rule/RuleSet";
+import {Rule} from "../Rule";
+import Action, {ActionConfig} from "../Action";
 import {Logger} from "winston";
-import Snoowrap, {Comment, Submission} from "snoowrap";
+import {Comment, Submission} from "snoowrap";
 import {actionFactory} from "../Action/ActionFactory";
 import {ruleFactory} from "../Rule/RuleFactory";
 import {
     asPostBehaviorOptionConfig,
-    boolToString,
-    createAjvFactory, determineNewResults,
-    FAIL, isRuleSetResult,
+    createAjvFactory,
+    FAIL,
+    isRuleSetResult,
     mergeArr,
     PASS,
     resultsSummary,
-    ruleNamesFromResults,
     truncateStringToLength
 } from "../util";
 import {
@@ -22,19 +21,17 @@ import {
     CheckSummary,
     JoinCondition,
     NotificationEventPayload,
-    PostBehavior, PostBehaviorOptionConfig, PostBehaviorOptionConfigStrong, PostBehaviorStrong,
-    RuleResult,
-    RuleSetResult, UserResultCache
+    PostBehavior,
+    PostBehaviorOptionConfigStrong,
+    PostBehaviorStrong,
+    RuleSetResult
 } from "../Common/interfaces";
 import * as RuleSchema from '../Schema/Rule.json';
 import * as RuleSetSchema from '../Schema/RuleSet.json';
 import * as ActionSchema from '../Schema/Action.json';
-import {
-    ActionJson as ActionTypeJson
-} from "../Common/types";
-import  {SubredditResources} from "../Subreddit/SubredditResources";
+import {SubredditResources} from "../Subreddit/SubredditResources";
 import {ExtendedSnoowrap} from '../Utils/SnoowrapClients';
-import {ActionProcessingError, CheckProcessingError, isRateLimitError} from "../Utils/Errors";
+import {ActionProcessingError, CheckProcessingError} from "../Utils/Errors";
 import {ErrorWithCause, stackWithCauses} from "pony-cause";
 import {runCheckOptions} from "../Subreddit/Manager";
 import EventEmitter from "events";
@@ -47,24 +44,28 @@ import {RunnableBase} from "../Common/RunnableBase";
 import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
 import {RuleSetResultEntity} from "../Common/Entities/RuleSetResultEntity";
 import {CheckToRuleResultEntity} from "../Common/Entities/RunnableAssociation/CheckToRuleResultEntity";
-import {
-    JoinOperands,
-    PostBehaviorType,
-    RecordOutputType,
-    recordOutputTypes
-} from "../Common/Infrastructure/Atomic";
-import {
-    MinimalOrFullFilter,
-    MinimalOrFullFilterJson
-} from "../Common/Infrastructure/Filters/FilterShapes";
-import {
-    CommentState,
-    SubmissionState,
-} from "../Common/Infrastructure/Filters/FilterCriteria";
+import {JoinOperands, PostBehaviorType, RecordOutputType, recordOutputTypes} from "../Common/Infrastructure/Atomic";
+import {CommentState, SubmissionState,} from "../Common/Infrastructure/Filters/FilterCriteria";
 import {ActivityType} from "../Common/Infrastructure/Reddit";
-import {RunnableBaseJson, RunnableBaseOptions, StructuredRunnableBase} from "../Common/Infrastructure/Runnable";
-import {RuleJson, StructuredRuleObjectJson, StructuredRuleSetObjectJson} from "../Common/Infrastructure/RuleShapes";
-import {ActionObjectJson, StructuredActionObjectJson} from "../Common/Infrastructure/ActionShapes";
+import {
+    RunnableBaseJson,
+    RunnableBaseOptions,
+    StructuredRunnableBase,
+    TypedRunnableBaseData, TypedStructuredRunnableBase
+} from "../Common/Infrastructure/Runnable";
+import {
+    RuleConfigData, RuleConfigHydratedData,
+    RuleConfigObject,
+    StructuredRuleConfigObject,
+    StructuredRuleSetConfigObject
+} from "../Common/Infrastructure/RuleShapes";
+import {
+    ActionConfigData,
+    ActionConfigHydratedData,
+    ActionConfigObject,
+    StructuredActionObjectJson
+} from "../Common/Infrastructure/ActionShapes";
+import {IncludesData} from "../Common/Infrastructure/Includes";
 
 const checkLogName = truncateStringToLength(25);
 
@@ -155,7 +156,7 @@ export abstract class Check extends RunnableBase implements Omit<ICheck, 'postTr
         if(asPostBehaviorOptionConfig(postFail)) {
             const {
                 behavior = 'next',
-                recordTo = false
+                recordTo = ['influx']
             } = postFail;
             let recordStrong: RecordOutputType[] = [];
             if(typeof recordTo === 'boolean') {
@@ -174,7 +175,7 @@ export abstract class Check extends RunnableBase implements Omit<ICheck, 'postTr
         } else {
             this.postFail = {
                 behavior: postFail,
-                recordTo: []
+                recordTo: ['influx']
             }
         }
 
@@ -192,12 +193,12 @@ export abstract class Check extends RunnableBase implements Omit<ICheck, 'postTr
                 let ruleErrors: any = [];
                 if (valid) {
                     const ruleConfig = r;
-                    this.rules.push(new RuleSet({...ruleConfig as StructuredRuleSetObjectJson, logger: this.logger, subredditName, resources: this.resources, client: this.client}));
+                    this.rules.push(new RuleSet({...ruleConfig as StructuredRuleSetConfigObject, logger: this.logger, subredditName, resources: this.resources, client: this.client}));
                 } else {
                     setErrors = ajv.errors;
                     valid = ajv.validate(RuleSchema, r);
                     if (valid) {
-                        this.rules.push(ruleFactory(r as StructuredRuleObjectJson, this.logger, subredditName, this.resources, this.client));
+                        this.rules.push(ruleFactory(r as StructuredRuleConfigObject, this.logger, subredditName, this.resources, this.client));
                     } else {
                         ruleErrors = ajv.errors;
                         const leastErrorType = setErrors.length < ruleErrors ? 'RuleSet' : 'Rule';
@@ -221,7 +222,14 @@ export abstract class Check extends RunnableBase implements Omit<ICheck, 'postTr
                     this.actions.push(actionFactory({
                         ...aj,
                         dryRun: this.dryRun || aj.dryRun
-                    }, this.logger, subredditName, this.resources, this.client, this.emitter));
+                    }, {
+                        logger: this.logger,
+                        subredditName,
+                        resources: this.resources,
+                        client: this.client,
+                        emitter: this.emitter,
+                        checkName: this.name
+                    }));
                     // @ts-ignore
                     a.logger = this.logger;
                 } else {
@@ -563,7 +571,7 @@ export abstract class Check extends RunnableBase implements Omit<ICheck, 'postTr
             const dr = dryRun || this.dryRun;
             this.logger.debug(`${dr ? 'DRYRUN - ' : ''}Running Actions`);
             for (const a of this.actions) {
-                const res = await a.handle(item, ruleResults, options);
+                const res = await a.handle(item, ruleResults, runActions, options);
                 runActions.push(res);
             }
             this.logger.info(`${dr ? 'DRYRUN - ' : ''}Ran Actions: ${runActions.map(x => x.premise.getFriendlyIdentifier()).join(' | ')}`);
@@ -605,7 +613,7 @@ export interface ICheck extends JoinCondition, PostBehavior, RunnableBaseJson {
 }
 
 export interface CheckOptions extends Omit<ICheck, 'authorIs' | 'itemIs'>, RunnableBaseOptions {
-    rules: Array<StructuredRuleSetObjectJson | StructuredRuleObjectJson>;
+    rules: Array<RuleConfigObject | RuleSetConfigObject>;
     actions: ActionConfig[];
     logger: Logger;
     subredditName: string;
@@ -616,7 +624,15 @@ export interface CheckOptions extends Omit<ICheck, 'authorIs' | 'itemIs'>, Runna
     emitter: EventEmitter
 }
 
-export interface CheckJson extends ICheck {
+/*
+* Can contain actions/rules as:
+*  - full objects
+*  - string to hydrate IE "url:fsdfd"
+*  - named string IE "namedRule"
+*
+* Also can contain itemIs/authorIs as full object or named filter
+* */
+export interface CheckConfigData extends ICheck, RunnableBaseJson {
     /**
      * The type of event (new submission or new comment) this check should be run against
      * @examples ["submission", "comment"]
@@ -631,7 +647,7 @@ export interface CheckJson extends ICheck {
      *
      * **If `rules` is an empty array or not present then `actions` are performed immediately.**
      * */
-    rules?: Array<RuleSetJson | RuleJson>
+    rules?: (RuleSetConfigData | RuleConfigData | string | IncludesData)[]
     /**
      * The `Actions` to run after the check is successfully triggered. ALL `Actions` will run in the order they are listed
      *
@@ -639,7 +655,7 @@ export interface CheckJson extends ICheck {
      *
      * @examples [[{"kind": "comment", "content": "this is the content of the comment", "distinguish": true}, {"kind": "lock"}]]
      * */
-    actions?: Array<ActionTypeJson>
+    actions?: ActionConfigData[]
 
     /**
      * If notifications are configured and this is `true` then an `eventActioned` event will be sent when this check is triggered.
@@ -651,9 +667,49 @@ export interface CheckJson extends ICheck {
     cacheUserResult?: UserResultCacheOptions;
 }
 
-export interface SubmissionCheckJson extends CheckJson {
+export interface SubmissionCheckConfigData extends CheckConfigData, TypedRunnableBaseData<SubmissionState> {
     kind: 'submission'
-    itemIs?: MinimalOrFullFilterJson<SubmissionState>
+}
+
+export interface CommentCheckConfigData extends CheckConfigData, TypedRunnableBaseData<CommentState> {
+    kind: 'comment'
+}
+
+
+/*
+* Can contain actions/rules as:
+*  - full objects
+*  - named string IE "namedRule"
+*
+* Also can contain itemIs/authorIs as full object or named filter
+* */
+export interface CheckConfigHydratedData extends CheckConfigData {
+    rules?: (RuleSetConfigHydratedData | RuleConfigHydratedData)[]
+    actions?: ActionConfigHydratedData[]
+}
+
+export interface SubmissionCheckConfigHydratedData extends CheckConfigHydratedData, TypedRunnableBaseData<SubmissionState> {
+    kind: 'submission'
+}
+
+export interface CommentCheckConfigHydratedData extends CheckConfigHydratedData, TypedRunnableBaseData<CommentState> {
+    kind: 'comment'
+}
+
+/*
+* All actions/rules/filters should now be full objects
+* */
+export interface CheckConfigObject extends Omit<CheckConfigHydratedData, 'itemIs' | 'authorIs'>, StructuredRunnableBase {
+    rules: Array<RuleSetConfigObject | RuleConfigObject>
+    actions: Array<ActionConfigObject>
+}
+
+export interface SubmissionCheckConfigObject extends Omit<CheckConfigObject, 'itemIs' | 'author'>, TypedStructuredRunnableBase<SubmissionState> {
+    kind: 'submission'
+}
+
+export interface CommentCheckConfigObject extends Omit<CheckConfigObject, 'itemIs' | 'author'>, TypedStructuredRunnableBase<CommentState> {
+    kind: 'comment'
 }
 
 /**
@@ -691,33 +747,18 @@ export const userResultCacheDefault: Required<UserResultCacheOptions> = {
     runActions: true,
 }
 
-export interface CommentCheckJson extends CheckJson {
-    kind: 'comment'
-    itemIs?: MinimalOrFullFilterJson<CommentState>
-}
-
-export const asStructuredCommentCheckJson = (val: any): val is CommentCheckStructuredJson => {
+export const asStructuredCommentCheckJson = (val: any): val is CommentCheckConfigObject => {
     return val.kind === 'comment';
 }
 
-export const asStructuredSubmissionCheckJson = (val: any): val is SubmissionCheckStructuredJson => {
+export const asStructuredSubmissionCheckJson = (val: any): val is SubmissionCheckConfigObject => {
     return val.kind === 'submission';
 }
 
-export type CheckStructuredJson = SubmissionCheckStructuredJson | CommentCheckStructuredJson;
-// export interface CheckStructuredJson extends CheckJson {
-//     rules: Array<RuleSetObjectJson | RuleObjectJson>
-//     actions: Array<ActionObjectJson>
-// }
+export type ActivityCheckConfigValue = string | IncludesData | SubmissionCheckConfigData | CommentCheckConfigData;
 
-export interface SubmissionCheckStructuredJson extends Omit<SubmissionCheckJson, 'authorIs' | 'itemIs' | 'rules'>,  StructuredRunnableBase {
-    rules: Array<StructuredRuleSetObjectJson | StructuredRuleObjectJson>
-    actions: Array<ActionObjectJson>
-    itemIs?: MinimalOrFullFilter<SubmissionState>
-}
+export type ActivityCheckConfigData = Exclude<ActivityCheckConfigValue, IncludesData>;
 
-export interface CommentCheckStructuredJson extends Omit<CommentCheckJson, 'authorIs' | 'itemIs' | 'rules'>, StructuredRunnableBase {
-    rules: Array<StructuredRuleSetObjectJson | StructuredRuleObjectJson>
-    actions: Array<ActionObjectJson>
-    itemIs?: MinimalOrFullFilter<CommentState>
-}
+export type ActivityCheckConfigHydratedData = SubmissionCheckConfigHydratedData | CommentCheckConfigHydratedData;
+
+export type ActivityCheckObject = SubmissionCheckConfigObject | CommentCheckConfigObject;

src/Common/ActivitySource.ts

@@ -0,0 +1,34 @@
+import {ActivitySourceData, ActivitySourceTypes} from "./Infrastructure/Atomic";
+import {strToActivitySourceData} from "../util";
+
+export class ActivitySource {
+    type: ActivitySourceTypes
+    identifier?: string
+
+    constructor(data: string | ActivitySourceData) {
+        if (typeof data === 'string') {
+            const {type, identifier} = strToActivitySourceData(data);
+            this.type = type;
+            this.identifier = identifier;
+        } else {
+            this.type = data.type;
+            this.identifier = data.identifier;
+        }
+    }
+
+    matches(desired: ActivitySource): boolean {
+        if(desired.type !== this.type) {
+            return false;
+        }
+        // if this source does not have an identifier (we have already matched type) then it is broad enough to match
+        if(this.identifier === undefined) {
+            return true;
+        }
+        // at this point we know this source has an identifier but desired DOES NOT so this source is more restrictive and does not match
+        if(desired.identifier === undefined) {
+            return false;
+        }
+        // otherwise sources match if identifiers are the same
+        return this.identifier.toLowerCase() === desired.identifier.toLowerCase();
+    }
+}

src/Common/Config/ConfigToObjectOptions.ts

@@ -6,4 +6,5 @@ export interface ConfigToObjectOptions {
     location?: string,
     jsonDocFunc?: (content: string, location?: string) => AbstractConfigDocument<OperatorJsonConfig>,
     yamlDocFunc?: (content: string, location?: string) => AbstractConfigDocument<YamlDocument>
+    allowArrays?: boolean
 }

src/Common/Config/ConfigUtil.ts

@@ -19,6 +19,7 @@ export const parseFromJsonOrYamlToObject = (content: string, options?: ConfigToO
         location,
         jsonDocFunc = (content: string, location?: string) => new JsonConfigDocument(content, location),
         yamlDocFunc = (content: string, location?: string) => new YamlConfigDocument(content, location),
+        allowArrays = false,
     } = options || {};
 
     try {

src/Common/Config/Operator/index.ts

@@ -1,11 +1,14 @@
 import YamlConfigDocument from "../YamlConfigDocument";
 import JsonConfigDocument from "../JsonConfigDocument";
 import {YAMLMap, YAMLSeq, Pair, Scalar} from "yaml";
-import {BotInstanceJsonConfig, OperatorJsonConfig} from "../../interfaces";
+import {BotInstanceJsonConfig, OperatorJsonConfig, WebCredentials} from "../../interfaces";
 import {assign} from 'comment-json';
 
 export interface OperatorConfigDocumentInterface {
     addBot(botData: BotInstanceJsonConfig): void;
+    setFriendlyName(name: string): void;
+    setWebCredentials(data: Required<WebCredentials>): void;
+    setOperator(name: string): void;
     toJS(): OperatorJsonConfig;
 }
 
@@ -29,6 +32,18 @@ export class YamlOperatorConfigDocument extends YamlConfigDocument implements Op
         }
     }
 
+    setFriendlyName(name: string) {
+        this.parsed.addIn(['api', 'friendly'], name);
+    }
+
+    setWebCredentials(data: Required<WebCredentials>) {
+        this.parsed.addIn(['web', 'credentials'], data);
+    }
+
+    setOperator(name: string) {
+        this.parsed.addIn(['operator', 'name'], name);
+    }
+
     toJS(): OperatorJsonConfig  {
         return super.toJS();
     }
@@ -68,6 +83,23 @@ export class JsonOperatorConfigDocument extends JsonConfigDocument implements Op
         }
     }
 
+    setFriendlyName(name: string) {
+        const api = this.parsed.api || {};
+        this.parsed.api = {...api, friendly: name};
+    }
+
+    setWebCredentials(data: Required<WebCredentials>) {
+        const {
+            web = {},
+        } = this.parsed;
+
+        this.parsed.web = {...web, credentials: data};
+    }
+
+    setOperator(name: string) {
+        this.parsed.operator = { name };
+    }
+
     toJS(): OperatorJsonConfig {
         return super.toJS();
     }

src/Common/Entities/ActionResultEntity.ts

@@ -56,6 +56,11 @@ export class ActionResultEntity extends TimeAwareRandomBaseEntity {
     @JoinColumn({name: 'premiseId'})
     premise!: ActionPremise;
 
+    /**
+     * Ephemeral -- only added during actual run time and used for action templating. Is not available after loading from DB.
+     * */
+    data?: any;
+
     touchedEntities: (Submission | Comment | RedditUser | string)[] = []
 
     set itemIs(data: ActivityStateFilterResult | IFilterResult<TypedActivityState> | undefined) {

src/Common/Entities/Activity.ts

@@ -1,11 +1,11 @@
-import {Entity, Column, PrimaryGeneratedColumn, ManyToOne, PrimaryColumn, OneToMany, OneToOne, Index} from "typeorm";
+import {Entity, Column, ManyToOne, PrimaryColumn, OneToMany, Index} from "typeorm";
 import {AuthorEntity} from "./AuthorEntity";
 import {Subreddit} from "./Subreddit";
 import {CMEvent} from "./CMEvent";
-import Submission from "snoowrap/dist/objects/Submission";
-import {Comment} from "snoowrap";
 import {asComment, getActivityAuthorName, parseRedditFullname, redditThingTypeToPrefix} from "../../util";
-import {ActivityType} from "../Infrastructure/Reddit";
+import {activityReports, ActivityType, Report, SnoowrapActivity} from "../Infrastructure/Reddit";
+import {ActivityReport} from "./ActivityReport";
+import dayjs, {Dayjs} from "dayjs";
 
 export interface ActivityEntityOptions {
     id: string
@@ -15,6 +15,7 @@ export interface ActivityEntityOptions {
     permalink: string
     author: AuthorEntity
     submission?: Activity
+    reports?: ActivityReport[]
 }
 
 @Entity()
@@ -69,6 +70,9 @@ export class Activity {
     @OneToMany(type => Activity, obj => obj.submission, {nullable: true})
     comments!: Activity[];
 
+    @OneToMany(type => ActivityReport, act => act.activity, {cascade: ['insert'], eager: true})
+    reports: ActivityReport[] | undefined
+
     constructor(data?: ActivityEntityOptions) {
         if(data !== undefined) {
             this.type = data.type;
@@ -78,10 +82,76 @@ export class Activity {
             this.permalink = data.permalink;
             this.author = data.author;
             this.submission = data.submission;
+            this.reports = data.reports !== undefined ? data.reports : undefined;
         }
     }
 
-    static fromSnoowrapActivity(subreddit: Subreddit, activity: (Submission | Comment)) {
+    /**
+     * @param {SnoowrapActivity} activity
+     * @param {Dayjs|undefined} lastKnownStateTimestamp Override the last good state (useful when tracked through polling)
+     * */
+    syncReports(activity: SnoowrapActivity, lastKnownStateTimestamp?: Dayjs) {
+        if(activity.num_reports > 0 && (this.reports === undefined || activity.num_reports !== this.reports.length)) {
+            if(this.reports === undefined) {
+                this.reports = [];
+            }
+            const reports = activityReports(activity);
+            // match up existing reports
+            const usedReportEntities: string[] = [];
+            const unsyncedReports: Report[] = [];
+            for(const r of reports) {
+                const matchedEntity = this.reports.find(x => !usedReportEntities.includes(x.id) && x.matchReport(r));
+                if(matchedEntity !== undefined) {
+                    usedReportEntities.push(matchedEntity.id);
+                } else {
+                    // found an unsynced report
+                    unsyncedReports.push(r);
+                }
+            }
+
+            // ideally we only have one report but it's possible (probable) there are more
+            //
+            // to simplify tracking over time we will spread out the "create time" for each report to be between NOW
+            // and the last recorded report, or if no reports then the create time of the activity
+
+            // -- the assumptions about tracking should be good enough for most users because:
+            // * default poll interval is 30 seconds so even if there are more than one reports in that time the resolution is high enough for accurate usage (most mods will use "> 1 report in 1 minute" or larger timescales)
+            // * for populating existing reports (CM has not been tracking since activity creation) we don't want to bunch up all reports at the timestamp which could create false positives,
+            //   it's more likely that reports would be spread out than all occurring at the same time.
+
+            // TODO additionally, will allow users to specify minimum required granularity to use when filtering by reports over time
+
+            let lastRecordedTime = lastKnownStateTimestamp;
+            if(lastKnownStateTimestamp === undefined) {
+                lastRecordedTime = this.reports.length > 0 ?
+                    // get the latest create date for existing reports
+                    this.reports.reduce((acc, curr) => curr.createdAt.isAfter(acc) ? curr.createdAt : acc, dayjs('2000-1-1'))
+                    // if no reports then use activity create date
+                    : dayjs(activity.created_utc * 1000);
+            }
+
+            // find the amount of time between now and last good timestamp
+            const missingTimespan = dayjs.duration(dayjs().diff(lastRecordedTime));
+            const granularity = Math.floor(missingTimespan.asSeconds());
+
+            // each report will have its create date spaced out (mostly) equally between now and the last good timestamp
+            //
+            // if only one report stick it in exact middle
+            // if more than one than decrease span by 1/4 so that we don't end up having reports dead-on the last timestamp
+            const increment = Math.floor(unsyncedReports.length === 1 ? (granularity / 2) : ((granularity / 1.25) / unsyncedReports.length));
+
+            for(let i = 0; i < unsyncedReports.length; i++) {
+               const r = new ActivityReport({...unsyncedReports[i], activity: this, granularity});
+               r.createdAt = dayjs().subtract(increment * (i + 1), 'seconds');
+               this.reports.push(r);
+            }
+
+            return true;
+        }
+        return false;
+    }
+
+    static fromSnoowrapActivity(subreddit: Subreddit, activity: SnoowrapActivity, lastKnownStateTimestamp?: dayjs.Dayjs | undefined) {
         let submission: Activity | undefined;
         let type: ActivityType = 'submission';
         let content: string;
@@ -99,7 +169,7 @@ export class Activity {
         const author = new AuthorEntity();
         author.name = getActivityAuthorName(activity.author);
 
-        return new Activity({
+        const entity = new Activity({
             id: activity.name,
             subreddit,
             type,
@@ -107,6 +177,10 @@ export class Activity {
             permalink: activity.permalink,
             author,
             submission
-        })
+        });
+
+        entity.syncReports(activity, lastKnownStateTimestamp);
+
+        return entity;
     }
 }

src/Common/Entities/ActivityReport.ts

@@ -0,0 +1,57 @@
+import {
+    Entity,
+    Column,
+    ManyToOne, JoinColumn, AfterLoad,
+} from "typeorm";
+import {Activity} from "./Activity";
+import {ManagerEntity} from "./ManagerEntity";
+import {TimeAwareRandomBaseEntity} from "./Base/TimeAwareRandomBaseEntity";
+import {Report, ReportType} from "../Infrastructure/Reddit";
+
+@Entity()
+export class ActivityReport extends TimeAwareRandomBaseEntity {
+
+    @Column({nullable: false, length: 500})
+    reason!: string
+
+    @Column({nullable: false, length: 20})
+    type!: ReportType
+
+    @Column({nullable: true, length: 100})
+    author?: string
+
+    @Column("int", {nullable: false})
+    granularity: number = 0;
+
+    @ManyToOne(type => Activity, act => act.reports, {cascade: ['update']})
+    @JoinColumn({name: 'activityId'})
+    activity!: Activity;
+
+    @Column({nullable: false, name: 'activityId'})
+    activityId!: string
+
+    constructor(data?: Report & { activity: Activity, granularity: number }) {
+        super();
+        if (data !== undefined) {
+            this.reason = data.reason;
+            this.type = data.type;
+            this.author = data.author;
+            this.activity = data.activity;
+            this.activityId = data.activity.id;
+            this.granularity = data.granularity
+        }
+    }
+
+    matchReport(report: Report): boolean {
+        return this.reason === report.reason
+            && this.type === report.type
+            && this.author === report.author;
+    }
+
+    @AfterLoad()
+    convertPrimitives() {
+        if(this.author === null) {
+            this.author = undefined;
+        }
+    }
+}

src/Common/Entities/AuthorEntity.ts

@@ -12,4 +12,10 @@ export class AuthorEntity {
 
     @OneToMany(type => Activity, act => act.author)
     activities!: Activity[]
+
+    constructor(data?: any) {
+        if(data !== undefined) {
+            this.name = data.name;
+        }
+    }
 }

src/Common/Entities/Bot.ts

@@ -1,13 +1,90 @@
 import {Entity, Column, PrimaryColumn, OneToMany, PrimaryGeneratedColumn} from "typeorm";
 import {ManagerEntity} from "./ManagerEntity";
 import {RandomIdBaseEntity} from "./Base/RandomIdBaseEntity";
+import {BotGuestEntity, ManagerGuestEntity} from "./Guest/GuestEntity";
+import {Guest, GuestEntityData, HasGuests} from "./Guest/GuestInterfaces";
+import {SubredditInvite} from "./SubredditInvite";
 
 @Entity()
-export class Bot extends RandomIdBaseEntity {
+export class Bot extends RandomIdBaseEntity implements HasGuests {
 
     @Column("varchar", {length: 200})
     name!: string;
 
     @OneToMany(type => ManagerEntity, obj => obj.bot)
     managers!: Promise<ManagerEntity[]>
+
+    @OneToMany(type => BotGuestEntity, obj => obj.guestOf, {eager: true, cascade: ['insert', 'remove', 'update']})
+    guests!: BotGuestEntity[]
+
+    @OneToMany(type => SubredditInvite, obj => obj.bot, {eager: true, cascade: ['insert', 'remove', 'update']})
+    subredditInvites!: SubredditInvite[]
+
+    getGuests() {
+        const g = this.guests;
+        if (g === undefined) {
+            return [];
+        }
+        //return g.map(x => ({id: x.id, name: x.author.name, expiresAt: x.expiresAt})) as Guest[];
+        return g;
+    }
+
+    addGuest(val: GuestEntityData | GuestEntityData[]) {
+        const reqGuests = Array.isArray(val) ? val : [val];
+        const guests = this.guests;
+        for (const g of reqGuests) {
+            const existing = guests.find(x => x.author.name.toLowerCase() === g.author.name.toLowerCase());
+            if (existing !== undefined) {
+                // update existing guest expiresAt
+                existing.expiresAt = g.expiresAt;
+            } else {
+                guests.push(new BotGuestEntity({...g, guestOf: this}));
+            }
+        }
+        this.guests = guests
+        return guests;
+    }
+
+    removeGuestById(val: string | string[]) {
+        const reqGuests = Array.isArray(val) ? val : [val];
+        const guests = this.guests;
+        const filteredGuests = guests.filter(x => reqGuests.includes(x.id));
+        this.guests = filteredGuests;
+        return filteredGuests;
+    }
+
+    removeGuestByUser(val: string | string[]) {
+        const reqGuests = (Array.isArray(val) ? val : [val]).map(x => x.trim().toLowerCase());
+        const guests = this.guests;
+        const filteredGuests = guests.filter(x => reqGuests.includes(x.author.name.toLowerCase()));
+        this.guests =filteredGuests;
+        return filteredGuests;
+    }
+
+    removeGuests() {
+        this.guests = []
+        return [];
+    }
+
+    getSubredditInvites(): SubredditInvite[] {
+        if(this.subredditInvites === undefined) {
+            return [];
+        }
+        return this.subredditInvites;
+    }
+
+    addSubredditInvite(invite: SubredditInvite) {
+        if(this.subredditInvites === undefined) {
+            this.subredditInvites = [];
+        }
+        this.subredditInvites.push(invite);
+    }
+
+    removeSubredditInvite(invite: SubredditInvite) {
+        if(this.subredditInvites === undefined) {
+            return;
+        }
+        const index = this.subredditInvites.findIndex(x => x.id === invite.id);
+        this.subredditInvites.splice(index, 1);
+    }
 }

src/Common/Entities/BotInvite.ts

@@ -1,13 +1,12 @@
 import {Column, Entity, PrimaryColumn} from "typeorm";
-import {TimeAwareBaseEntity} from "../Entities/Base/TimeAwareBaseEntity";
+import {TimeAwareBaseEntity} from "./Base/TimeAwareBaseEntity";
 import {InviteData} from "../../Web/Common/interfaces";
 import dayjs, {Dayjs} from "dayjs";
+import {TimeAwareRandomBaseEntity} from "./Base/TimeAwareRandomBaseEntity";
+import {parseRedditEntity} from "../../util";
 
-@Entity()
-export class Invite extends TimeAwareBaseEntity implements InviteData {
-
-    @PrimaryColumn('varchar', {length: 255})
-    id!: string
+@Entity({name: 'BotInvite'})
+export class BotInvite extends TimeAwareRandomBaseEntity implements InviteData {
 
     @Column("varchar", {length: 50})
     clientId!: string;
@@ -30,6 +29,12 @@ export class Invite extends TimeAwareBaseEntity implements InviteData {
     @Column()
     overwrite?: boolean;
 
+    @Column("simple-json")
+    guests?: string[]
+
+    @Column("text")
+    initialConfig?: string
+
     @Column("simple-json", {nullable: true})
     subreddits?: string[];
 
@@ -51,10 +56,9 @@ export class Invite extends TimeAwareBaseEntity implements InviteData {
         }
     }
 
-    constructor(data?: InviteData & { id: string, expiresIn?: number }) {
+    constructor(data?: InviteData) {
         super();
         if (data !== undefined) {
-            this.id = data.id;
             this.permissions = data.permissions;
             this.subreddits = data.subreddits;
             this.instance = data.instance;
@@ -63,9 +67,16 @@ export class Invite extends TimeAwareBaseEntity implements InviteData {
             this.redirectUri = data.redirectUri;
             this.creator = data.creator;
             this.overwrite = data.overwrite;
+            this.initialConfig = data.initialConfig;
+            if(data.guests !== undefined && data.guests !== null && data.guests.length > 0) {
+                const cleanGuests = data.guests.filter(x => x !== '').map(x => parseRedditEntity(x, 'user').name);
+                if(cleanGuests.length > 0) {
+                    this.guests = cleanGuests;
+                }
+            }
 
-            if (data.expiresIn !== undefined && data.expiresIn !== 0) {
-                this.expiresAt = dayjs().add(data.expiresIn, 'seconds');
+            if (data.expiresAt !== undefined && data.expiresAt !== 0) {
+                this.expiresAt = dayjs(data.expiresAt);
             }
         }
     }

src/Common/Entities/DispatchedEntity.ts

@@ -21,7 +21,7 @@ import Submission from "snoowrap/dist/objects/Submission";
 import Comment from "snoowrap/dist/objects/Comment";
 import {ColumnDurationTransformer} from "./Transformers";
 import { RedditUser } from "snoowrap/dist/objects";
-import {ActivitySourceTypes, DurationVal, NonDispatchActivitySource, onExistingFoundBehavior} from "../Infrastructure/Atomic";
+import {ActivitySourceTypes, DurationVal, NonDispatchActivitySourceValue, onExistingFoundBehavior} from "../Infrastructure/Atomic";
 
 @Entity({name: 'DispatchedAction'})
 export class DispatchedEntity extends TimeAwareRandomBaseEntity {
@@ -53,7 +53,7 @@ export class DispatchedEntity extends TimeAwareRandomBaseEntity {
     identifier?: string
 
     @Column("varchar", {nullable: true, length: 200})
-    cancelIfQueued?: boolean | NonDispatchActivitySource | NonDispatchActivitySource[]
+    cancelIfQueued?: boolean | NonDispatchActivitySourceValue | NonDispatchActivitySourceValue[]
 
     @Column({nullable: true})
     onExistingFound?: onExistingFoundBehavior
@@ -127,7 +127,7 @@ export class DispatchedEntity extends TimeAwareRandomBaseEntity {
             } else if (cVal === 'false') {
                 this.cancelIfQueued = false;
             } else if (cVal.includes('[')) {
-                this.cancelIfQueued = JSON.parse(cVal) as NonDispatchActivitySource[];
+                this.cancelIfQueued = JSON.parse(cVal) as NonDispatchActivitySourceValue[];
             }
         }
         if(this.goto === null) {

src/Common/Entities/Guest/GuestEntity.ts

@@ -0,0 +1,119 @@
+import {ChildEntity, Column, Entity, JoinColumn, ManyToOne, TableInheritance} from "typeorm";
+import {AuthorEntity} from "../AuthorEntity";
+import { ManagerEntity } from "../ManagerEntity";
+import { Bot } from "../Bot";
+import {TimeAwareRandomBaseEntity} from "../Base/TimeAwareRandomBaseEntity";
+import dayjs, {Dayjs} from "dayjs";
+import {Guest, GuestAll, GuestEntityData} from "./GuestInterfaces";
+
+export interface GuestOptions<T extends ManagerEntity | Bot> extends GuestEntityData {
+    guestOf: T
+}
+
+@Entity({name: 'Guests'})
+@TableInheritance({ column: { type: "varchar", name: "type" } })
+export abstract class GuestEntity<T extends ManagerEntity | Bot> extends TimeAwareRandomBaseEntity {
+
+    @ManyToOne(type => AuthorEntity, undefined, {cascade: ['insert'], eager: true})
+    @JoinColumn({name: 'authorName'})
+    author!: AuthorEntity;
+
+    @Column({ name: 'expiresAt', nullable: true })
+    _expiresAt?: Date = new Date();
+
+    public get expiresAt(): Dayjs {
+        return dayjs(this._expiresAt);
+    }
+
+    public set expiresAt(d: Dayjs | undefined) {
+        if(d === undefined) {
+            this._expiresAt = d;
+        } else {
+            this._expiresAt = d.utc().toDate();
+        }
+    }
+
+    expiresAtTimestamp(): number | undefined {
+        if(this._expiresAt !== undefined) {
+           return this.expiresAt.valueOf();
+        }
+        return undefined;
+    }
+
+    protected constructor(data?: GuestOptions<T>) {
+        super();
+        if(data !== undefined) {
+            this.author = data.author;
+            this.expiresAt = data.expiresAt;
+        }
+    }
+}
+
+@ChildEntity('manager')
+export class ManagerGuestEntity extends GuestEntity<ManagerEntity> {
+
+    type: string = 'manager';
+
+    @ManyToOne(type => ManagerEntity, act => act.guests, {nullable: false, orphanedRowAction: 'delete'})
+    @JoinColumn({name: 'guestOfId', referencedColumnName: 'id'})
+    guestOf!: ManagerEntity
+
+    constructor(data?: GuestOptions<ManagerEntity>) {
+        super(data);
+        if(data !== undefined) {
+            this.guestOf = data.guestOf;
+        }
+    }
+}
+
+@ChildEntity('bot')
+export class BotGuestEntity extends GuestEntity<Bot> {
+
+    type: string = 'bot';
+
+    @ManyToOne(type => Bot, act => act.guests, {nullable: false, orphanedRowAction: 'delete'})
+    @JoinColumn({name: 'guestOfId', referencedColumnName: 'id'})
+    guestOf!: Bot
+
+    constructor(data?: GuestOptions<Bot>) {
+        super(data);
+        if(data !== undefined) {
+            this.guestOf = data.guestOf;
+            this.author = data.author;
+        }
+    }
+}
+
+export const guestEntityToApiGuest = (val: GuestEntity<any>): Guest => {
+    return {
+        id: val.id,
+        name: val.author.name,
+        expiresAt: val.expiresAtTimestamp(),
+    }
+}
+
+interface ContextualGuest extends Guest {
+    subreddit: string
+}
+
+export const guestEntitiesToAll = (val: Map<string, Guest[]>): GuestAll[] => {
+    const contextualGuests: ContextualGuest[] = Array.from(val.entries()).map(([sub, guests]) => guests.map(y => ({...y, subreddit: sub} as ContextualGuest))).flat(3);
+
+    const userMap = contextualGuests.reduce((acc, curr) => {
+        let u: GuestAll | undefined = acc.get(curr.name);
+        if (u === undefined) {
+            u = {name: curr.name, expiresAt: curr.expiresAt, subreddits: [curr.subreddit]};
+        } else {
+            if (!u.subreddits.includes(curr.subreddit)) {
+                u.subreddits.push(curr.subreddit);
+            }
+            if ((u.expiresAt === undefined && curr.expiresAt !== undefined) || (u.expiresAt !== undefined && curr.expiresAt !== undefined && curr.expiresAt < u.expiresAt)) {
+                u.expiresAt = curr.expiresAt;
+            }
+        }
+        acc.set(curr.name, u);
+        return acc;
+    }, new Map<string, GuestAll>());
+
+    return Array.from(userMap.values());
+}

src/Common/Entities/Guest/GuestInterfaces.ts

@@ -0,0 +1,28 @@
+import { Dayjs } from "dayjs"
+import {AuthorEntity} from "../AuthorEntity";
+
+export interface Guest {
+    id: string
+    name: string
+    expiresAt?: number
+}
+
+export interface GuestAll {
+    name: string
+    expiresAt?: number
+    subreddits: string[]
+}
+
+
+export interface GuestEntityData {
+    expiresAt?: Dayjs
+    author: AuthorEntity
+}
+
+export interface HasGuests {
+    getGuests: () => GuestEntityData[]
+    addGuest: (val: GuestEntityData | GuestEntityData[]) => GuestEntityData[]
+    removeGuestById: (val: string | string[]) => GuestEntityData[]
+    removeGuestByUser: (val: string | string[]) => GuestEntityData[]
+    removeGuests: () => GuestEntityData[]
+}

src/Common/Entities/ManagerEntity.ts

@@ -15,12 +15,14 @@ import {RunEntity} from "./RunEntity";
 import {Bot} from "./Bot";
 import {RandomIdBaseEntity} from "./Base/RandomIdBaseEntity";
 import {ManagerRunState} from "./EntityRunState/ManagerRunState";
-import { QueueRunState } from "./EntityRunState/QueueRunState";
+import {QueueRunState} from "./EntityRunState/QueueRunState";
 import {EventsRunState} from "./EntityRunState/EventsRunState";
 import {RulePremise} from "./RulePremise";
 import {ActionPremise} from "./ActionPremise";
-import { RunningStateTypes } from "../../Subreddit/Manager";
+import {RunningStateTypes} from "../../Subreddit/Manager";
 import {EntityRunState} from "./EntityRunState/EntityRunState";
+import {GuestEntity, ManagerGuestEntity} from "./Guest/GuestEntity";
+import {Guest, GuestEntityData, HasGuests} from "./Guest/GuestInterfaces";
 
 export interface ManagerEntityOptions {
     name: string
@@ -36,12 +38,12 @@ export type RunningStateEntities = {
 };
 
 @Entity({name: 'Manager'})
-export class ManagerEntity extends RandomIdBaseEntity implements RunningStateEntities {
+export class ManagerEntity extends RandomIdBaseEntity implements RunningStateEntities, HasGuests {
 
     @Column("varchar", {length: 200})
     name!: string;
 
-    @ManyToOne(type => Bot, sub => sub.managers, {cascade: ['insert'], eager: true})
+    @ManyToOne(type => Bot, sub => sub.managers, {eager: true})
     bot!: Bot;
 
     @ManyToOne(type => Subreddit, sub => sub.activities, {cascade: ['insert'], eager: true})
@@ -56,12 +58,15 @@ export class ManagerEntity extends RandomIdBaseEntity implements RunningStateEnt
     @OneToMany(type => ActionPremise, obj => obj.manager)
     actions!: Promise<ActionPremise[]>
 
-    @OneToMany(type => CheckEntity, obj => obj.manager) // note: we will create author property in the Photo class below
+    @OneToMany(type => CheckEntity, obj => obj.manager)
     checks!: Promise<CheckEntity[]>
 
-    @OneToMany(type => RunEntity, obj => obj.manager) // note: we will create author property in the Photo class below
+    @OneToMany(type => RunEntity, obj => obj.manager)
     runs!: Promise<RunEntity[]>
 
+    @OneToMany(type => ManagerGuestEntity, obj => obj.guestOf, {eager: true, cascade: ['insert', 'remove', 'update']})
+    guests!: ManagerGuestEntity[]
+
     @OneToOne(() => EventsRunState, {cascade: ['insert', 'update'], eager: true})
     @JoinColumn()
     eventsState!: EventsRunState
@@ -85,4 +90,50 @@ export class ManagerEntity extends RandomIdBaseEntity implements RunningStateEnt
             this.managerState = data.managerState;
         }
     }
+
+    getGuests(): ManagerGuestEntity[] {
+        const g = this.guests;
+        if (g === undefined) {
+            return [];
+        }
+        //return g.map(x => ({id: x.id, name: x.author.name, expiresAt: x.expiresAt})) as Guest[];
+        return g;
+    }
+
+   addGuest(val: GuestEntityData | GuestEntityData[]) {
+        const reqGuests = Array.isArray(val) ? val : [val];
+        const guests = this.getGuests();
+        for (const g of reqGuests) {
+            const existing = guests.find(x => x.author.name.toLowerCase() === g.author.name.toLowerCase());
+            if (existing !== undefined) {
+                // update existing guest expiresAt
+                existing.expiresAt = g.expiresAt;
+            } else {
+                guests.push(new ManagerGuestEntity({...g, guestOf: this}));
+            }
+        }
+        this.guests = guests;
+        return guests;
+    }
+
+    removeGuestById(val: string | string[]) {
+        const reqGuests = Array.isArray(val) ? val : [val];
+        const guests = this.getGuests();
+        const filteredGuests = guests.filter(x => !reqGuests.includes(x.id));
+        this.guests = filteredGuests
+        return filteredGuests;
+    }
+
+    removeGuestByUser(val: string | string[]) {
+        const reqGuests = (Array.isArray(val) ? val : [val]).map(x => x.trim().toLowerCase());
+        const guests = this.getGuests();
+        const filteredGuests = guests.filter(x => !reqGuests.includes(x.author.name.toLowerCase()));
+        this.guests = filteredGuests;
+        return filteredGuests;
+    }
+
+    removeGuests() {
+        this.guests = [];
+        return [];
+    }
 }

src/Common/Entities/SubredditInvite.ts

@@ -0,0 +1,99 @@
+import {AfterLoad, Column, Entity, JoinColumn, ManyToOne, PrimaryColumn} from "typeorm";
+import {InviteData, SubredditInviteData, SubredditInviteDataPersisted} from "../../Web/Common/interfaces";
+import dayjs, {Dayjs} from "dayjs";
+import {TimeAwareRandomBaseEntity} from "./Base/TimeAwareRandomBaseEntity";
+import {AuthorEntity} from "./AuthorEntity";
+import {Bot} from "./Bot";
+
+@Entity()
+export class SubredditInvite extends TimeAwareRandomBaseEntity implements SubredditInviteData {
+
+    @PrimaryColumn("varchar", {length: 255})
+    subreddit!: string;
+
+    @Column("simple-json", {nullable: true})
+    guests?: string[]
+
+    @Column("text")
+    initialConfig?: string
+
+    @PrimaryColumn("varchar", {length: 200})
+    messageId?: string
+
+    @ManyToOne(type => Bot, bot => bot.subredditInvites, {nullable: false, orphanedRowAction: 'delete'})
+    @JoinColumn({name: 'botId', referencedColumnName: 'id'})
+    bot!: Bot;
+
+    @Column({name: 'expiresAt', nullable: true})
+    _expiresAt?: Date;
+
+    public get expiresAt(): Dayjs | undefined {
+        if (this._expiresAt === undefined) {
+            return undefined;
+        }
+        return dayjs(this._expiresAt);
+    }
+
+    public set expiresAt(d: Dayjs | undefined) {
+        if (d === undefined) {
+            this._expiresAt = d;
+        } else {
+            this._expiresAt = d.utc().toDate();
+        }
+    }
+
+    constructor(data?: SubredditInviteData & { expiresIn?: number, bot: Bot }) {
+        super();
+        if (data !== undefined) {
+            this.subreddit = data.subreddit;
+            this.initialConfig = data.initialConfig === null ? undefined : data.initialConfig;
+            this.guests = data.guests === null || data.guests === undefined ? [] : data.guests;
+            this.bot = data.bot;
+
+
+            if (data.expiresIn !== undefined && data.expiresIn !== 0) {
+                this.expiresAt = dayjs().add(data.expiresIn, 'seconds');
+            }
+        }
+    }
+
+    toSubredditInviteData(): SubredditInviteDataPersisted {
+        return {
+            id: this.id,
+            subreddit: this.subreddit,
+            initialConfig: this.getInitialConfig(),
+            guests: this.getGuests(),
+            expiresAt: this.expiresAt !== undefined ? this.expiresAt.unix() : undefined,
+        }
+    }
+
+    getGuests(): string[] {
+        if(this.guests === null || this.guests === undefined) {
+            return [];
+        }
+        return this.guests;
+    }
+
+    getInitialConfig(): string | undefined {
+        if(this.initialConfig === null) {
+            return undefined;
+        }
+        return this.initialConfig;
+    }
+
+    canAutomaticallyAccept() {
+        return this.getGuests().length === 0 && this.getInitialConfig() === undefined;
+        // TODO setup inbox checking to look for reply to messageId (eventually!)
+    }
+
+    @AfterLoad()
+    fixNullable() {
+        if(this.guests === null) {
+            this.guests = undefined;
+        }
+        if(this.initialConfig === null) {
+            this.initialConfig = undefined;
+        }
+    }
+
+}

src/Common/ImageData.ts

@@ -1,15 +1,17 @@
 import fetch from "node-fetch";
 import {Submission} from "snoowrap/dist/objects";
 import {URL} from "url";
-import {absPercentDifference, getSharpAsync, isValidImageURL} from "../util";
+import {absPercentDifference, getExtension, getSharpAsync, isValidImageURL} from "../util";
 import {Sharp} from "sharp";
-import {blockhash} from "./blockhash/blockhash";
-import {SimpleError} from "../Utils/Errors";
+import {blockhashAndFlipped} from "./blockhash/blockhash";
+import {CMError, SimpleError} from "../Utils/Errors";
+import {FileHandle, open} from "fs/promises";
+import {ImageHashCacheData} from "./Infrastructure/Atomic";
 
 export interface ImageDataOptions {
     width?: number,
     height?: number,
-    url: string,
+    path: URL,
     variants?: ImageData[]
 }
 
@@ -17,19 +19,20 @@ class ImageData {
 
     width?: number
     height?: number
-    url: URL
+    path: URL
     variants: ImageData[] = []
     preferredResolution?: [number, number]
     sharpImg!: Sharp
-    hashResult!: string
+    hashResult?: string
+    hashResultFlipped?: string
     actualResolution?: [number, number]
 
     constructor(data: ImageDataOptions, aggressive = false) {
         this.width = data.width;
         this.height = data.height;
-        this.url = new URL(data.url);
-        if (!aggressive && !isValidImageURL(`${this.url.origin}${this.url.pathname}`)) {
-            throw new Error('URL did not end with a valid image extension');
+        this.path = data.path;
+        if (!aggressive && !isValidImageURL(`${this.path.origin}${this.path.pathname}`)) {
+            throw new Error('Path did not end with a valid image extension');
         }
         this.variants = data.variants || [];
     }
@@ -39,55 +42,90 @@ class ImageData {
         return await (await this.sharp()).clone().toFormat(format).toBuffer();
     }
 
-    async hash(bits: number, useVariantIfPossible = true): Promise<string> {
-        if(this.hashResult === undefined) {
+    async hash(bits: number = 16, useVariantIfPossible = true): Promise<Required<ImageHashCacheData>> {
+        if (this.hashResult === undefined || this.hashResultFlipped === undefined) {
             let ref: ImageData | undefined;
-            if(useVariantIfPossible && this.preferredResolution !== undefined) {
+            if (useVariantIfPossible && this.preferredResolution !== undefined) {
                 ref = this.getSimilarResolutionVariant(this.preferredResolution[0], this.preferredResolution[1]);
             }
-            if(ref === undefined) {
+            if (ref === undefined) {
                 ref = this;
             }
-            this.hashResult = await blockhash((await ref.sharp()).clone(), bits);
+            const [hash, hashFlipped] = await blockhashAndFlipped((await ref.sharp()).clone(), bits);
+            this.hashResult = hash;
+            this.hashResultFlipped = hashFlipped;
         }
-        return this.hashResult;
+        return {original: this.hashResult, flipped: this.hashResultFlipped};
     }
 
     async sharp(): Promise<Sharp> {
         if (this.sharpImg === undefined) {
+            let animated = false;
+            let getBuffer: () => Promise<Buffer>;
+            let fileHandle: FileHandle | undefined;
             try {
-                const response = await fetch(this.url.toString())
-                if (response.ok) {
-                    const ct = response.headers.get('Content-Type');
-                    if (ct !== null && ct.includes('image')) {
-                        const sFunc = await getSharpAsync();
-                        // if image is animated then we want to extract the first frame and convert it to a regular image
-                        // so we can compare two static images later (also because sharp can't use resize() on animated images)
-                        if(['gif','webp'].some(x => ct.includes(x))) {
-                            this.sharpImg = await sFunc(await (await sFunc(await response.buffer(), {pages: 1, animated: false})).png().toBuffer());
-                        } else {
-                            this.sharpImg = await sFunc(await response.buffer());
-                        }
-                        const meta = await this.sharpImg.metadata();
-                        if (this.width === undefined || this.height === undefined) {
-                            this.width = meta.width;
-                            this.height = meta.height;
-                        }
-                        this.actualResolution = [meta.width as number, meta.height as number];
-                    } else {
-                        throw new SimpleError(`Content-Type for fetched URL ${this.url} did not contain "image"`);
+                if (this.path.protocol === 'file:') {
+                    try {
+                        animated = ['gif', 'webp'].includes(getExtension(this.path.pathname));
+                        fileHandle = await open(this.path, 'r');
+                        getBuffer = async () => await (fileHandle as FileHandle).readFile();
+                    } catch (err: any) {
+                        throw new CMError(`Unable to retrieve local file ${this.path.toString()}`, {cause: err});
                     }
                 } else {
-                    throw new SimpleError(`URL response was not OK: (${response.status})${response.statusText}`);
+                    try {
+                        const response = await fetch(this.path.toString())
+                        if (response.ok) {
+                            const ct = response.headers.get('Content-Type');
+                            if (ct !== null && ct.includes('image')) {
+                                animated = ['gif', 'webp'].some(x => ct.includes(x));
+                                getBuffer = async () => await response.buffer();
+                            } else {
+                                throw new SimpleError(`Content-Type for fetched URL ${this.path.toString()} did not contain "image"`);
+                            }
+                        } else {
+                            throw new SimpleError(`Fetching ${this.path.toString()} => URL response was not OK: (${response.status})${response.statusText}`);
+                        }
+
+                    } catch (err: any) {
+                        if (!(err instanceof SimpleError)) {
+                            throw new CMError(`Error occurred while fetching response from URL ${this.path.toString()}`, {cause: err});
+                        } else {
+                            throw err;
+                        }
+                    }
+                }
+            } catch (err: any) {
+                throw new CMError('Unable to fetch image resource', {cause: err, isSerious: false});
+            }
+
+            try {
+
+                const sFunc = await getSharpAsync();
+                // if image is animated then we want to extract the first frame and convert it to a regular image
+                // so we can compare two static images later (also because sharp can't use resize() on animated images)
+                if (animated) {
+                    this.sharpImg = await sFunc(await (await sFunc(await getBuffer(), {
+                        pages: 1,
+                        animated: false
+                    }).trim().greyscale()).png().withMetadata().toBuffer());
+                } else {
+                    this.sharpImg = await sFunc(await sFunc(await getBuffer()).trim().greyscale().withMetadata().toBuffer());
                 }
 
+                if(fileHandle !== undefined) {
+                    await fileHandle.close();
+                }
+
+                const meta = await this.sharpImg.metadata();
+                if (this.width === undefined || this.height === undefined) {
+                    this.width = meta.width;
+                    this.height = meta.height;
+                }
+                this.actualResolution = [meta.width as number, meta.height as number];
 
             } catch (err: any) {
-                if(!(err instanceof SimpleError)) {
-                    throw new Error(`Error occurred while fetching response from URL: ${err.message}`);
-                } else {
-                    throw err;
-                }
+                throw new CMError('Error occurred while converting image buffer to Sharp object', {cause: err});
             }
         }
         return this.sharpImg;
@@ -107,8 +145,8 @@ class ImageData {
         return this.width !== undefined && this.height !== undefined;
     }
 
-    get baseUrl() {
-        return `${this.url.origin}${this.url.pathname}`;
+    get basePath() {
+        return `${this.path.origin}${this.path.pathname}`;
     }
 
     setPreferredResolutionByWidth(prefWidth: number) {
@@ -225,10 +263,23 @@ class ImageData {
         return [refSharp, compareSharp, width, height];
     }
 
+    toHashCache(): ImageHashCacheData {
+        return {
+            original: this.hashResult,
+            flipped: this.hashResultFlipped
+        }
+    }
+
+    setFromHashCache(data: ImageHashCacheData) {
+        const {original, flipped} = data;
+        this.hashResult = original;
+        this.hashResultFlipped = flipped;
+    }
+
     static fromSubmission(sub: Submission, aggressive = false): ImageData {
         const url = new URL(sub.url);
         const data: any = {
-            url,
+            path: url,
         };
         let variants = [];
         if (sub.preview !== undefined && sub.preview.enabled && sub.preview.images.length > 0) {
@@ -237,7 +288,7 @@ class ImageData {
             data.width = ref.width;
             data.height = ref.height;
 
-            variants = firstImg.resolutions.map(x => new ImageData(x));
+            variants = firstImg.resolutions.map(x => new ImageData({...x, path: new URL(x.url)}));
             data.variants = variants;
         }
         return new ImageData(data, aggressive);

src/Common/Influx/InfluxClient.ts

@@ -0,0 +1,115 @@
+import {InfluxConfig} from "./interfaces";
+import {InfluxDB, Point, WriteApi, setLogger} from "@influxdata/influxdb-client";
+import {HealthAPI} from "@influxdata/influxdb-client-apis";
+import dayjs, {Dayjs} from "dayjs";
+import {Logger} from "winston";
+import {mergeArr} from "../../util";
+import {CMError} from "../../Utils/Errors";
+
+export interface InfluxClientConfig extends InfluxConfig {
+    client?: InfluxDB
+    ready?: boolean
+}
+
+export class InfluxClient {
+    config: InfluxConfig;
+    client: InfluxDB;
+    write: WriteApi;
+    health: HealthAPI;
+
+    tags: Record<string, string>;
+
+    logger: Logger;
+
+    ready: boolean;
+    lastReadyAttempt: Dayjs | undefined;
+
+    constructor(config: InfluxClientConfig, logger: Logger, tags: Record<string, string> = {}) {
+
+        const {client, ready = false, ...rest} = config;
+
+        this.logger = logger.child({
+            labels: ['Influx']
+        }, mergeArr);
+
+        this.config = rest;
+        this.ready = ready;
+        if(client !== undefined) {
+            this.client = client;
+        } else {
+           this.client = InfluxClient.createClient(this.config);
+           setLogger(this.logger);
+        }
+        this.write = this.client.getWriteApi(config.credentials.org, config.credentials.bucket, 'ms');
+        this.tags = tags;
+        this.write.useDefaultTags(tags);
+        this.health = new HealthAPI(this.client);
+    }
+
+    async isReady() {
+        if (this.ready) {
+            return true;
+        }
+        if (this.lastReadyAttempt === undefined || dayjs().diff(this.lastReadyAttempt, 's') >= 10) {
+            if (!(await this.testConnection())) {
+                this.logger.warn('Influx endpoint is not ready');
+            } else {
+                this.ready = true;
+            }
+        } else {
+            this.logger.debug(`Influx endpoint testing throttled. Waiting another ${10 - dayjs().diff(this.lastReadyAttempt, 's')} seconds`);
+        }
+        return this.ready;
+    }
+
+    async testConnection() {
+        try {
+            const result = await this.health.getHealth();
+            if (result.status === 'fail') {
+                return false;
+            }
+            return true;
+        } catch (e: any) {
+            this.logger.error(new CMError(`Testing health of Influx endpoint failed`, {cause: e, isSerious: false}));
+            return false;
+        }
+    }
+
+    async writePoint(data: Point | Point[]) {
+        if (await this.isReady()) {
+            if (Array.isArray(data)) {
+                this.write.writePoints(data);
+            } else {
+                this.write.writePoint(data);
+            }
+        }
+    }
+
+    async flush() {
+        if (await this.isReady()) {
+            try {
+                await this.write.flush(true);
+            } catch (e: any) {
+                this.logger.error(new CMError('Failed to flush data to Influx', {cause: e}));
+            }
+        }
+    }
+
+    static createClient(config: InfluxConfig): InfluxDB {
+        return new InfluxDB({
+            url: config.credentials.url,
+            token: config.credentials.token,
+            writeOptions: {
+                defaultTags: config.defaultTags
+            }
+        });
+    }
+
+    childClient(logger: Logger, tags: Record<string, string> = {}) {
+        return new InfluxClient({
+            ...this.config,
+            client: this.client,
+            ready: this.ready
+        }, logger, {...this.tags, ...tags});
+    }
+}

src/Common/Influx/interfaces.ts

@@ -0,0 +1,13 @@
+import {InfluxDB, WriteApi} from "@influxdata/influxdb-client/dist";
+
+export interface InfluxConfig {
+    credentials: InfluxCredentials
+    defaultTags?: Record<string, string>
+}
+
+export interface InfluxCredentials {
+    url: string
+    token: string
+    org: string
+    bucket: string
+}

src/Common/Infrastructure/ActionShapes.ts

@@ -1,5 +1,8 @@
 import {StructuredRunnableBase} from "./Runnable";
 import {ActionJson} from "../types";
+import {IncludesData} from "./Includes";
 
-export type ActionObjectJson = Exclude<ActionJson, string>;
-export type StructuredActionObjectJson = Omit<ActionObjectJson, 'authorIs' | 'itemIs'> & StructuredRunnableBase
+export type ActionConfigData = ActionJson;
+export type ActionConfigHydratedData = Exclude<ActionConfigData, IncludesData>;
+export type ActionConfigObject = Exclude<ActionConfigHydratedData, string>;
+export type StructuredActionObjectJson = Omit<ActionConfigObject, 'authorIs' | 'itemIs'> & StructuredRunnableBase

src/Common/Infrastructure/Atomic.ts

@@ -1,3 +1,5 @@
+import {ActivityType} from "./Reddit";
+
 /**
  * A duration and how to compare it against a value
  *
@@ -15,6 +17,22 @@
 
 export type DurationComparor = string;
 
+/**
+ * A relative datetime description
+ *
+ * May be either:
+ *
+ * * day of the week (monday, tuesday, etc...)
+ * * cron expression IE `* * 15 *`
+ *
+ * See https://crontab.guru/ for generating expressions
+ *
+ * https://regexr.com/6u3cc
+ *
+ * @pattern ((?:(?:(?:(?:\d+,)+\d+|(?:\d+(?:\/|-|#)\d+)|\d+L?|\*(?:\/\d+)?|L(?:-\d+)?|\?|[A-Z]{3}(?:-[A-Z]{3})?) ?){5,7})$)|(mon|tues|wed|thurs|fri|sat|sun){1}
+ * */
+export type RelativeDateTimeMatch = string;
+
 /**
  * A string containing a comparison operator and a value to compare against
  *
@@ -148,10 +166,18 @@ export type RecordOutputOption = boolean | RecordOutputType | RecordOutputType[]
 export type PostBehaviorType = 'next' | 'stop' | 'nextRun' | string;
 export type onExistingFoundBehavior = 'replace' | 'skip' | 'ignore';
 export type ActionTarget = 'self' | 'parent';
+export type ArbitraryActionTarget = ActionTarget | string;
 export type InclusiveActionTarget = ActionTarget | 'any';
-export type DispatchSource = 'dispatch' | `dispatch:${string}`;
-export type NonDispatchActivitySource = 'poll' | `poll:${PollOn}` | 'user' | `user:${string}`;
-export type ActivitySourceTypes = 'poll' | 'dispatch' | 'user'; // TODO
+export const SOURCE_POLL = 'poll';
+export type SourcePollStr = 'poll';
+export const SOURCE_DISPATCH = 'dispatch';
+export type SourceDispatchStr = 'dispatch';
+export const SOURCE_USER = 'user';
+export type SourceUserStr = 'user';
+
+export type DispatchSourceValue = SourceDispatchStr | `dispatch:${string}`;
+export type NonDispatchActivitySourceValue = SourcePollStr | `poll:${PollOn}` | SourceUserStr | `user:${string}`;
+export type ActivitySourceTypes = SourcePollStr | SourceDispatchStr | SourceUserStr; // TODO
 // https://github.com/YousefED/typescript-json-schema/issues/426
 // https://github.com/YousefED/typescript-json-schema/issues/425
 // @pattern ^(((poll|dispatch)(:\w+)?)|user)$
@@ -169,11 +195,17 @@ export type ActivitySourceTypes = 'poll' | 'dispatch' | 'user'; // TODO
  *
  *
  * */
-export type ActivitySource = NonDispatchActivitySource | DispatchSource;
+export type ActivitySourceValue = NonDispatchActivitySourceValue | DispatchSourceValue;
+
+export interface ActivitySourceData {
+    type: ActivitySourceTypes
+    identifier?: string
+}
 
 export type ConfigFormat = 'json' | 'yaml';
 export type ActionTypes =
     'comment'
+    | 'submission'
     | 'lock'
     | 'remove'
     | 'report'
@@ -249,3 +281,196 @@ export type ModActionType =
     'REMOVAL' |
     'SPAM' |
     'APPROVAL';
+
+export type UserNoteType =
+    'gooduser' |
+    'spamwatch' |
+    'spamwarn' |
+    'abusewarn' |
+    'ban' |
+    'permban' |
+    'botban' |
+    string;
+
+export const userNoteTypes = ['gooduser', 'spamwatch', 'spamwarn', 'abusewarn', 'ban', 'permban', 'botban'];
+
+export type ConfigFragmentValidationFunc = (data: object, fetched: boolean) => boolean;
+
+export interface WikiContext {
+    wiki: string
+    subreddit?: string
+}
+
+export interface ExternalUrlContext {
+    url: string
+}
+
+export interface UrlContext {
+    value: string
+    context: WikiContext | ExternalUrlContext
+}
+
+export interface ImageHashCacheData {
+    original?: string
+    flipped?: string
+}
+
+// https://www.reddit.com/message/compose?to=/r/mealtimevideos&message=https://www.reddit.com/r/ContextModBot/comments/otz396/introduction_to_contextmodbot
+
+export interface BaseTemplateData {
+    botLink: string
+    modmailLink?: string
+    manager?: string
+    check?: string
+    //[key: string]: any
+}
+
+export interface ActivityTemplateData {
+    kind: ActivityType
+    author: string
+    votes: number
+    age: string
+    permalink: string
+    id: string
+    subreddit: string
+    title: string
+    shortTitle: string
+}
+
+export interface ModdedActivityTemplateData {
+    reports: number
+    modReports: number
+    userReports: number
+}
+
+export interface SubmissionTemplateData extends ActivityTemplateData, Partial<ModdedActivityTemplateData> {
+    nsfw: boolean
+    spoiler: boolean
+    op: boolean
+    upvoteRatio: string
+    url: string
+}
+
+export interface CommentTemplateData extends ActivityTemplateData, Partial<ModdedActivityTemplateData> {
+    op: boolean
+}
+
+export interface SubredditTemplateData {
+    subredditBreakdownFormatted: string
+    subredditBreakdown?: {
+        totalFormatted: string
+        submissionFormatted: string
+        commentFormatted: string
+    }
+}
+
+export interface RuleResultTemplateData {
+    kind: string
+    triggered: boolean
+    result: string
+    [key: string]: any
+}
+
+export interface ActionResultTemplateData {
+    kind: string
+    success: boolean
+    result: string
+    [key: string]: any
+}
+
+export interface ActionResultsTemplateData {
+    actionSummary: string
+    actions: {
+        [key: string]: ActionResultTemplateData
+    }
+}
+
+export interface RuleResultsTemplateData {
+    ruleSummary: string
+    rules: {
+        [key: string]: RuleResultTemplateData
+    }
+}
+
+export interface GenericContentTemplateData extends BaseTemplateData, Partial<RuleResultsTemplateData>, Partial<ActionResultsTemplateData> {
+    item?: (SubmissionTemplateData | CommentTemplateData)
+}
+
+export type ModerationActionType =
+    'banuser'
+    | 'unbanuser'
+    | 'spamlink'
+    | 'removelink'
+    | 'approvelink'
+    | 'spamcomment'
+    | 'removecomment'
+    | 'approvecomment'
+    | 'addmoderator'
+    | 'showcomment'
+    | 'invitemoderator'
+    | 'uninvitemoderator'
+    | 'acceptmoderatorinvite'
+    | 'removemoderator'
+    | 'addcontributor'
+    | 'removecontributor'
+    | 'editsettings'
+    | 'editflair'
+    | 'distinguish'
+    | 'marknsfw'
+    | 'wikibanned'
+    | 'wikicontributor'
+    | 'wikiunbanned'
+    | 'wikipagelisted'
+    | 'removewikicontributor'
+    | 'wikirevise'
+    | 'wikipermlevel'
+    | 'ignorereports'
+    | 'unignorereports'
+    | 'setpermissions'
+    | 'setsuggestedsort'
+    | 'sticky'
+    | 'unsticky'
+    | 'setcontestmode'
+    | 'unsetcontestmode'
+    | 'lock'
+    | 'unlock'
+    | 'muteuser'
+    | 'unmuteuser'
+    | 'createrule'
+    | 'editrule'
+    | 'reorderrules'
+    | 'deleterule'
+    | 'spoiler'
+    | 'unspoiler'
+    | 'modmail_enrollment'
+    | 'community_styling'
+    | 'community_widgets'
+    | 'markoriginalcontent'
+    | 'collections'
+    | 'events'
+    | 'hidden_award'
+    | 'add_community_topics'
+    | 'remove_community_topics'
+    | 'create_scheduled_post'
+    | 'edit_scheduled_post'
+    | 'delete_scheduled_post'
+    | 'submit_scheduled_post'
+    | 'edit_post_requirements'
+    | 'invitesubscriber'
+    | 'submit_content_rating_survey'
+    | 'adjust_post_crowd_control_level'
+    | 'enable_post_crowd_control_filter'
+    | 'disable_post_crowd_control_filter'
+    | 'deleteoverriddenclassification'
+    | 'overrideclassification'
+    | 'reordermoderators'
+    | 'snoozereports'
+    | 'unsnoozereports'
+    | 'addnote'
+    | 'deletenote'
+    | 'addremovalreason'
+    | 'createremovalreason'
+    | 'updateremovalreason'
+    | 'deleteremovalreason';
+
+export const moderatorActionTypes = ['banuser', 'unbanuser', 'spamlink', 'removelink', 'approvelink', 'spamcomment', 'removecomment', 'approvecomment', 'addmoderator', 'showcomment', 'invitemoderator', 'uninvitemoderator', 'acceptmoderatorinvite', 'removemoderator', 'addcontributor', 'removecontributor', 'editsettings', 'editflair', 'distinguish', 'marknsfw', 'wikibanned', 'wikicontributor', 'wikiunbanned', 'wikipagelisted', 'removewikicontributor', 'wikirevise', 'wikipermlevel', 'ignorereports', 'unignorereports', 'setpermissions', 'setsuggestedsort', 'sticky', 'unsticky', 'setcontestmode', 'unsetcontestmode', 'lock', 'unlock', 'muteuser', 'unmuteuser', 'createrule', 'editrule', 'reorderrules', 'deleterule', 'spoiler', 'unspoiler', 'modmail_enrollment', 'community_styling', 'community_widgets', 'markoriginalcontent', 'collections', 'events', 'hidden_award', 'add_community_topics', 'remove_community_topics', 'create_scheduled_post', 'edit_scheduled_post', 'delete_scheduled_post', 'submit_scheduled_post', 'edit_post_requirements', 'invitesubscriber', 'submit_content_rating_survey', 'adjust_post_crowd_control_level', 'enable_post_crowd_control_filter', 'disable_post_crowd_control_filter', 'deleteoverriddenclassification', 'overrideclassification', 'reordermoderators', 'snoozereports', 'unsnoozereports', 'addnote', 'deletenote', 'addremovalreason', 'createremovalreason', 'updateremovalreason', 'deleteremovalreason'];

src/Common/Infrastructure/Comparisons.ts

@@ -2,8 +2,9 @@ import {StringOperator} from "./Atomic";
 import {Duration} from "dayjs/plugin/duration";
 import InvalidRegexError from "../../Utils/InvalidRegexError";
 import dayjs, {Dayjs, OpUnitType} from "dayjs";
-import {SimpleError} from "../../Utils/Errors";
-import { parseDuration } from "../../util";
+import {CMError, SimpleError} from "../../Utils/Errors";
+import {escapeRegex, parseDuration, parseDurationFromString, parseStringToRegex} from "../../util";
+import {ReportType} from "./Reddit";
 
 export interface DurationComparison {
     operator: StringOperator,
@@ -15,8 +16,10 @@ export interface GenericComparison extends HasDisplayText {
     value: number,
     isPercent: boolean,
     extra?: string,
+    groups?: Record<string, string>
     displayText: string,
     duration?: Duration
+    durationText?: string
 }
 
 export interface HasDisplayText {
@@ -53,18 +56,20 @@ export const parseGenericValueComparison = (val: string, options?: {
     const groups = matches.groups as any;
 
     let duration: Duration | undefined;
+    let durationText: string | undefined;
 
-    if(typeof groups.extra === 'string' && groups.extra.trim() !== '') {
-        try {
-            duration = parseDuration(groups.extra, false);
-        } catch (e) {
-            // if it returns an invalid regex just means they didn't
-            if (requireDuration || !(e instanceof InvalidRegexError)) {
-                throw e;
-            }
+    try {
+        const durationResult = parseDurationFromString(val, false);
+        if(durationResult.length > 1) {
+            throw new SimpleError(`Must only have one Duration value, found ${durationResult.length} in: ${val}`);
+        }
+        duration = durationResult[0].duration;
+        durationText = durationResult[0].original;
+    } catch (e) {
+        // if it returns an invalid regex just means they didn't
+        if (requireDuration || !(e instanceof InvalidRegexError)) {
+            throw e;
         }
-    } else if(requireDuration) {
-        throw new SimpleError(`Comparison must contain a duration value but none was found. Given: ${val}`);
     }
 
     const displayParts = [`${groups.opStr} ${groups.value}`];
@@ -73,13 +78,33 @@ export const parseGenericValueComparison = (val: string, options?: {
         displayParts.push('%');
     }
 
+    const {
+        opStr,
+        value,
+        percent,
+        extra,
+        ...rest
+    } = matches.groups || {};
+
+    const extraGroups: Record<string,string> = {};
+    let hasExtraGroups = false;
+
+    for(const [k,v] of Object.entries(rest)) {
+        if(typeof v === 'string' && v.trim() !== '') {
+            extraGroups[k] = v;
+            hasExtraGroups = true;
+        }
+    }
+
     return {
         operator: groups.opStr as StringOperator,
         value: Number.parseFloat(groups.value),
         isPercent: hasPercent,
         extra: groups.extra,
+        groups: hasExtraGroups ? extraGroups : undefined,
         displayText: displayParts.join(''),
-        duration
+        duration,
+        durationText,
     }
 }
 const GENERIC_VALUE_PERCENT_COMPARISON = /^\s*(?<opStr>>|>=|<|<=)\s*(?<value>\d+)\s*(?<percent>%)?(?<extra>.*)$/
@@ -93,18 +118,16 @@ export const parseGenericValueOrPercentComparison = (val: string, options?: {req
 const DURATION_COMPARISON_REGEX: RegExp = /^\s*(?<opStr>>|>=|<|<=)\s*(?<time>\d+)\s*(?<unit>days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)\s*$/;
 const DURATION_COMPARISON_REGEX_URL = 'https://regexr.com/609n8';
 export const parseDurationComparison = (val: string): DurationComparison => {
-    const matches = val.match(DURATION_COMPARISON_REGEX);
-    if (matches === null) {
-        throw new InvalidRegexError(DURATION_COMPARISON_REGEX, val, DURATION_COMPARISON_REGEX_URL)
+    const result = parseGenericValueComparison(val, {requireDuration: true});
+    if(result.isPercent) {
+        throw new InvalidRegexError(DURATION_COMPARISON_REGEX, val, DURATION_COMPARISON_REGEX_URL, 'Duration comparison value cannot be a percentage');
     }
-    const groups = matches.groups as any;
-    const dur: Duration = dayjs.duration(groups.time, groups.unit);
-    if (!dayjs.isDuration(dur)) {
-        throw new SimpleError(`Parsed value '${val}' did not result in a valid Dayjs Duration`);
+    if(result.value < 0) {
+        throw new InvalidRegexError(DURATION_COMPARISON_REGEX, val, DURATION_COMPARISON_REGEX_URL,'Duration value cannot be negative');
     }
     return {
-        operator: groups.opStr as StringOperator,
-        duration: dur
+        operator: result.operator as StringOperator,
+        duration: result.duration as Duration
     }
 }
 export const dateComparisonTextOp = (val1: Dayjs, strOp: StringOperator, val2: Dayjs, granularity?: OpUnitType): boolean => {
@@ -139,3 +162,51 @@ export const comparisonTextOp = (val1: number, strOp: string, val2: number): boo
             throw new Error(`${strOp} was not a recognized operator`);
     }
 }
+
+export interface ReportComparison extends Omit<GenericComparison, 'groups'> {
+    reportType?: ReportType
+    reasonRegex?: RegExp
+    reasonMatch?: string
+}
+
+const REPORT_COMPARISON = /^\s*(?<opStr>>|>=|<|<=)\s*(?<value>\d+)(?<percent>\s*%)?(?:\s+(?<reportType>mods?|users?))?(?:\s+(?<reasonMatch>["'].*["']|\/.*\/))?.*(?<time>\d+)?\s*(?<unit>days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)?\s*$/i
+const REPORT_REASON_LITERAL = /["'](.*)["']/i
+export const parseReportComparison = (str: string): ReportComparison => {
+    const generic = parseGenericValueComparison(str, {reg: REPORT_COMPARISON});
+
+
+    const {
+        groups: {
+            reportType,
+            reasonMatch
+        } = {},
+        ...rest
+    } = generic;
+
+    const result: ReportComparison = {...rest, reasonMatch};
+
+    if(reportType !== undefined) {
+        if(reportType.toLocaleLowerCase().includes('mod')) {
+            result.reportType = 'mod' as ReportType;
+        } else if (reportType.toLocaleLowerCase().includes('user')) {
+            result.reportType = 'user' as ReportType;
+        }
+    }
+    if(reasonMatch !== undefined) {
+        const literalMatch = reasonMatch.match(REPORT_REASON_LITERAL);
+        if(literalMatch !== null) {
+            const cleanLiteralMatch = `/.*${escapeRegex(literalMatch[1].trim())}.*/`;
+            result.reasonRegex = parseStringToRegex(cleanLiteralMatch, 'i');
+            if(result.reasonRegex === undefined) {
+                throw new CMError(`Could not convert reason match value to Regex: ${cleanLiteralMatch}`, {isSerious: false})
+            }
+        } else {
+            result.reasonRegex = parseStringToRegex(reasonMatch, 'i');
+            if(result.reasonRegex === undefined) {
+                throw new CMError(`Could not convert reason match value to Regex: ${reasonMatch}`, {isSerious: false})
+            }
+        }
+    }
+
+    return result;
+}

src/Common/Infrastructure/Filters/FilterCriteria.ts

@@ -4,7 +4,7 @@ import {
     DurationComparor,
     ModeratorNameCriteria,
     ModeratorNames, ModActionType,
-    ModUserNoteLabel
+    ModUserNoteLabel, RelativeDateTimeMatch
 } from "../Atomic";
 import {ActivityType} from "../Reddit";
 import {GenericComparison, parseGenericValueComparison} from "../Comparisons";
@@ -245,10 +245,11 @@ export const authorCriteriaProperties = ['name', 'flairCssClass', 'flairText', '
  * */
 export interface AuthorCriteria {
     /**
-     * A list of reddit usernames (case-insensitive) to match against. Do not include the "u/" prefix
+     * A list of reddit usernames (case-insensitive) or regular expressions to match against. Do not include the "u/" prefix
+     *
      *
      *  EX to match against /u/FoxxMD and /u/AnotherUser use ["FoxxMD","AnotherUser"]
-     * @examples ["FoxxMD","AnotherUser"]
+     * @examples ["FoxxMD","AnotherUser", "/.*Foxx.\/*i"]
      * */
     name?: string[],
     /**
@@ -405,21 +406,56 @@ export interface ActivityState {
     approved?: boolean | ModeratorNames | ModeratorNames[] | ModeratorNameCriteria
     score?: CompareValue
     /**
-     * A string containing a comparison operator and a value to compare against
+     * A string containing a comparison operator, a value to compare against, an (optional) report type filter, an (optional) qualifier for report reason, and an (optional) time constraint
      *
-     * The syntax is `(< OR > OR <= OR >=) <number>`
+     * The syntax is `(< OR > OR <= OR >=) number[%] [type] [reasonQualifier] [timeValue] [timeUnit]`
+     *
+     * If only comparison and number is given then defaults to TOTAL reports on an Activity.
      *
      * * EX `> 2`  => greater than 2 total reports
      *
-     * Defaults to TOTAL reports on an Activity. Suffix the value with the report type to check that type:
+     * Type (optional) determines which type of reports to look at:
      *
-     * * EX `> 3 mod` => greater than 3 mod reports
-     * * EX `>= 1 user` => greater than 1 user report
+     * * `mod` -- mod reports
+     *   * EX `> 3 mod` => greater than 3 mod reports
+     * * `user` -- user reports
+     *   * EX `> 3 user` => greater than 3 user reports
      *
-     * @pattern ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
+     * Report reason qualifiers can be:
+     *
+     * * enclosed double or single quotes -- report reason contains
+     *   * EX `> 1 "misinformation" => greater than 1 report with reason containing "misinformation"
+     * * enclosed in backslashes -- match regex
+     *   * EX `> 1 \harassment towards .*\` => greater than 1 report with reason matching regex \harassment towards .*\
+     *
+     * Type and reason qualifiers can be used together:
+     *
+     * EX `> 2 user "misinformation" => greater than 2 user reports with reasons containing "misinformation"
+     *
+     * The time constraint filter reports created between NOW and [timeConstraint] in the past:
+     *
+     * * `> 3 in 30 minutes` => more than 3 reports created between NOW and 30 minutes ago
+     * * `> 2 user "misinformation" in 2 hours` => more than 2 user reports containing "misinformation" created between NOW and 2 hours ago
+     *
+     * @pattern ^\s*(>|>=|<|<=)\s*(\d+)(\s*%)?(\s+(?:mods?|users?))?(\s+(?:["'].*["']|\/.*\/))?.*(\d+)?\s*(days?|weeks?|months?|years?|hours?|minutes?|seconds?|milliseconds?)?\s*$
      * */
-    reports?: CompareValue
+    reports?: string
     age?: DurationComparor
+
+    /**
+     * A relative datetime description to match the date the Activity was created
+     *
+     * May be either:
+     *
+     * * day of the week (monday, tuesday, etc...)
+     * * cron expression IE `* * 15 *`
+     *
+     * See https://crontab.guru/ for generating expressions
+     *
+     * https://regexr.com/6u3cc
+     *
+     * */
+    createdOn?: RelativeDateTimeMatch | RelativeDateTimeMatch[]
     /**
      * Test whether the activity is present in dispatched/delayed activities
      *
@@ -434,7 +470,7 @@ export interface ActivityState {
     dispatched?: boolean | string | string[]
 
 
-    // can use ActivitySource | ActivitySource[] here because of issues with generating json schema, see ActivitySource comments
+    // cant use ActivitySource | ActivitySource[] here because of issues with generating json schema, see ActivitySource comments
     /**
      * Test where the current activity was sourced from.
      *
@@ -487,6 +523,18 @@ export interface SubmissionState extends ActivityState {
      * Is the submission a reddit-hosted image or video?
      * */
     isRedditMediaDomain?: boolean
+
+    /**
+     * Compare the upvote ratio for this Submission, expressed as a whole number
+     *
+     * Can be either a comparison string or a number. If a number then CM assumes upvote ratio must be greater than or equal to this.
+     *
+     * Example:
+     *
+     * * `< 90` => less than 90% upvoted
+     * * 45 => greater than or equal to 45% upvoted
+     * */
+    upvoteRatio?: number | CompareValue
 }
 
 export const cmActivityProperties = ['submissionState', 'score', 'reports', 'removed', 'deleted', 'filtered', 'age', 'title'];

src/Common/Infrastructure/Includes.ts

@@ -0,0 +1,45 @@
+import {ConfigFormat} from "./Atomic";
+
+export interface IncludesData {
+    /**
+     * The special-form path to the config fragment to retrieve.
+     *
+     * If value starts with `wiki:` then the proceeding value will be used to get a wiki page from the current subreddit
+     *
+     *  * EX `wiki:botconfig/mybot` tries to get `https://reddit.com/r/currentSubreddit/wiki/botconfig/mybot`
+     *
+     * If the value starts with `wiki:` and ends with `|someValue` then `someValue` will be used as the base subreddit for the wiki page
+     *
+     * * EX `wiki:replytemplates/test|ContextModBot` tries to get `https://reddit.com/r/ContextModBot/wiki/replytemplates/test`
+     *
+     * If the value starts with `url:` then the value is fetched as an external url and expects raw text returned
+     *
+     * * EX `url:https://pastebin.com/raw/38qfL7mL` tries to get the text response of `https://pastebin.com/raw/38qfL7mL`
+     * */
+    path: string
+    /**
+     * An unused hint about the content type. Not implemented yet
+     * */
+    type?: ConfigFormat
+    /**
+     * Control caching for the config fragment.
+     *
+     * If not specified the value for `wikiTTL` will be used
+     *
+     * * If true then value is cached forever
+     * * If false then value is never cached
+     * * If a number then the number of seconds to cache value
+     * * If 'response' then CM will attempt to use Cache-Control or Expires headers from the response to determine how long to cache the value
+     * */
+    ttl?: number | boolean | 'response'
+}
+
+export type IncludesUrl = `url:${string}`;
+export type IncludesWiki = `wiki:${string}`;
+export type IncludesString = IncludesUrl | IncludesWiki;
+
+export type IncludesType = string | IncludesData;
+
+export const asIncludesData = (val: any): val is IncludesData => {
+    return val !== null && typeof val === 'object' && 'path' in val;
+}

src/Common/Infrastructure/Reddit.ts

@@ -30,3 +30,76 @@ export interface CachedFetchedActivitiesResult {
 export interface FetchedActivitiesResult extends CachedFetchedActivitiesResult {
     post: SnoowrapActivity[]
 }
+
+export type ReportType = 'mod' | 'user';
+
+export interface Report {
+    reason: string
+    type: ReportType
+    author?: string
+    snoozed: boolean
+    canSnooze: boolean
+}
+
+export type RawRedditUserReport = [
+    string, // reason
+    number, // number of reports with this reason
+    boolean, // is report snoozed
+    boolean // can the reports be snoozed
+];
+
+export type RawRedditModReport = [string, string];
+
+export const activityReports = (activity: SnoowrapActivity): Report[] => {
+    const reports: Report[] = [];
+    for(const r of (activity.user_reports as unknown as RawRedditUserReport[])) {
+        const report = {
+            reason: r[0],
+            type: 'user' as ReportType,
+            snoozed: r[2],
+            canSnooze: r[3]
+        };
+        for(let i = 0; i < r[1]; i++) {
+            reports.push(report);
+        }
+    }
+
+    for(const r of (activity.mod_reports as unknown as RawRedditModReport[])) {
+        reports.push({
+            reason: r[0],
+            type: 'mod' as ReportType,
+            author: r[1],
+            snoozed: false,
+            canSnooze: false
+        })
+    }
+    return reports;
+}
+
+export interface RawSubredditRemovalReasonData {
+    data: {
+        [key: string]: SubredditRemovalReason
+    },
+    order: [string]
+}
+
+export interface SubredditRemovalReason {
+    message: string
+    id: string,
+    title: string
+}
+
+export interface SubredditActivityAbsoluteBreakdown {
+    count: number
+    name: string
+}
+
+export interface SubredditActivityBreakdown extends SubredditActivityAbsoluteBreakdown {
+    percent: number
+}
+
+export interface SubredditActivityBreakdownByType {
+    total: SubredditActivityBreakdown[]
+    submission: SubredditActivityBreakdown[]
+    comment: SubredditActivityBreakdown[]
+}

src/Common/Infrastructure/RuleShapes.ts

@@ -1,10 +1,12 @@
 import {StructuredRunnableBase} from "./Runnable";
-import {RuleSetObjectJson} from "../../Rule/RuleSet";
+import {RuleSetConfigObject} from "../../Rule/RuleSet";
 import {RuleObjectJsonTypes} from "../types";
+import {IncludesData} from "./Includes";
 
-export type RuleJson = RuleObjectJsonTypes | string;
-export type RuleObjectJson = Exclude<RuleJson, string>
-export type StructuredRuleObjectJson = Omit<RuleObjectJson, 'authorIs' | 'itemIs'> & StructuredRunnableBase
-export type StructuredRuleSetObjectJson = Omit<RuleSetObjectJson, 'rules'> & {
-    rules: StructuredRuleObjectJson[]
+export type RuleConfigData = RuleObjectJsonTypes | string | IncludesData;
+export type RuleConfigHydratedData = Exclude<RuleConfigData, IncludesData>
+export type RuleConfigObject = Exclude<RuleConfigHydratedData, string>
+export type StructuredRuleConfigObject = Omit<RuleConfigObject, 'authorIs' | 'itemIs'> & StructuredRunnableBase
+export type StructuredRuleSetConfigObject = Omit<RuleSetConfigObject, 'rules'> & {
+    rules: StructuredRuleConfigObject[]
 }

src/Common/Infrastructure/Runnable.ts

@@ -10,11 +10,16 @@ export interface RunnableBaseOptions extends Omit<RunnableBaseJson, 'itemIs' | '
     authorIs?: MinimalOrFullFilter<AuthorCriteria>
 }
 
-export interface StructuredRunnableBase {
+export interface StructuredRunnableBase extends RunnableBaseJson {
     itemIs?: MinimalOrFullFilter<TypedActivityState>
     authorIs?: MinimalOrFullFilter<AuthorCriteria>
 }
 
+export interface TypedStructuredRunnableBase<T> extends TypedRunnableBaseData<T> {
+    itemIs?: MinimalOrFullFilter<T>
+    authorIs?: MinimalOrFullFilter<AuthorCriteria>
+}
+
 export interface RunnableBaseJson {
     /**
      * A list of criteria to test the state of the `Activity` against before running the check.
@@ -31,3 +36,10 @@ export interface RunnableBaseJson {
      * */
     authorIs?: MinimalOrFullFilterJson<AuthorCriteria>
 }
+
+export interface TypedRunnableBaseData<T extends TypedActivityState> extends RunnableBaseJson {
+    /**
+     * If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail.
+     * */
+    authorIs?: MinimalOrFullFilterJson<AuthorCriteria>
+}

src/Common/MigrationService.ts

@@ -5,6 +5,7 @@ import {DatabaseMigrationOptions} from "./interfaces";
 import {copyFile} from "fs/promises";
 import {constants} from "fs";
 import {ErrorWithCause} from "pony-cause";
+import {CMError} from "../Utils/Errors";
 
 export interface ExistingTable {
     table: Table
@@ -118,9 +119,10 @@ export class MigrationService {
                 try {
                     await this.backupDatabase();
                     continueBCBackedup = true;
-                } catch (err) {
-                    // @ts-ignore
-                    this.dbLogger.error(err, {leaf: 'Backup'});
+                } catch (err: any) {
+                    if(!(err instanceof CMError) || !err.logged) {
+                        this.dbLogger.error(err, {leaf: 'Backup'});
+                    }
                 }
             } else {
                 this.dbLogger.info('Configuration DID NOT specify migrations may be executed if automated backup is successful. Will not try to create a backup.');
@@ -154,25 +156,34 @@ YOU SHOULD BACKUP YOUR EXISTING DATABASE BEFORE CONTINUING WITH MIGRATIONS.`);
 
     async backupDatabase() {
         try {
-            if (this.database.options.type === 'sqljs' && this.database.options.location !== undefined) {
+            let location: string | undefined;
+            const canBackup = ['sqljs','better-sqlite3'].includes(this.database.options.type);
+            if(canBackup) {
+                if(this.database.options.type === 'sqljs') {
+                    location = this.database.options.location === ':memory:' ? undefined : this.database.options.location;
+                } else {
+                    location = this.database.options.database === ':memory:' || (typeof this.database.options.database !== 'string') ? undefined : this.database.options.database;
+                }
+            }
+            if (canBackup && location !== undefined) {
                 try {
                     const ts = Date.now();
-                    const backupLocation = `${this.database.options.location}.${ts}.bak`
+                    const backupLocation = `${location}.${ts}.bak`
                     this.dbLogger.info(`Detected sqljs (sqlite) database. Will try to make a backup at ${backupLocation}`, {leaf: 'Backup'});
-                    await copyFile(this.database.options.location, backupLocation, constants.COPYFILE_EXCL);
+                    await copyFile(location, backupLocation, constants.COPYFILE_EXCL);
                     this.dbLogger.info('Successfully created backup!', {leaf: 'Backup'});
                 } catch (err: any) {
                     throw new ErrorWithCause('Cannot make an automated backup of your configured database.', {cause: err});
                 }
             } else {
                 let msg = 'Cannot make an automated backup of your configured database.';
-                if (this.database.options.type !== 'sqljs') {
-                    msg += ' Only SQlite (sqljs database type) is implemented for automated backups right now, sorry :( You will need to manually backup your database.';
+                if (!canBackup) {
+                    msg += ' Only SQlite (sqljs or better-sqlite3 database type) is implemented for automated backups right now, sorry :( You will need to manually backup your database.';
                 } else {
                     // TODO don't throw for this??
                     msg += ' Database location is not defined (probably in-memory).';
                 }
-                throw new Error(msg);
+                throw new CMError(msg, {logged: true});
             }
         } catch (e: any) {
             this.dbLogger.error(e, {leaf: 'Backup'});

src/Common/Migrations/Database/MigrationUtil.ts

@@ -0,0 +1,92 @@
+import {QueryRunner, TableIndex} from "typeorm";
+
+/**
+ * Boilerplate for creating generic index
+ * */
+export const index = (prefix: string, columns: string[], unique = true) => new TableIndex({
+    name: `IDX_${unique ? 'UN_' : ''}${prefix}_${columns.join('-')}`,
+    columnNames: columns,
+    isUnique: unique,
+});
+/**
+ * Create index on id column
+ * */
+export const idIndex = (prefix: string, unique: boolean) => index(prefix, ['id'], unique);
+
+/**
+ * Boilerplate primary key column for random ID
+ * */
+export const randomIdColumn = () => ({
+    name: 'id',
+    type: 'varchar',
+    length: '20',
+    isPrimary: true,
+    isUnique: true,
+});
+
+/**
+ * Create a time data column based on database type
+ * */
+export const timeAtColumn = (columnName: string, dbType: string, nullable?: boolean) => {
+    const dbSpecifics = dbType === 'postgres' ? {
+        type: 'timestamptz'
+    } : {
+        type: 'datetime',
+        // required to get millisecond precision on mysql/mariadb
+        // https://mariadb.com/kb/en/datetime/
+        // https://dev.mysql.com/doc/refman/8.0/en/fractional-seconds.html
+        length: '3',
+    }
+    return {
+        name: columnName,
+        isNullable: nullable ?? false,
+        ...dbSpecifics
+    }
+}
+export const createdAtColumn = (type: string) => timeAtColumn('createdAt', type);
+const updatedAtColumn = (type: string) => timeAtColumn('updatedAt', type);
+const createdUpdatedAtColumns = (type: string) => [
+    timeAtColumn('createdAt', type),
+    timeAtColumn('updatedAt', type)
+];
+export const createdAtIndex = (prefix: string) => index(prefix, ['createdAt'], false);
+
+const updatedAtIndex = (prefix: string) => index(prefix, ['updatedAt'], false);
+const createdUpdatedAtIndices = (prefix: string) => {
+    return [
+        createdAtIndex(prefix),
+        updatedAtIndex(prefix)
+    ]
+}
+/**
+ * Boilerplate for filter (itemIs, authorIs) FK column -- uses FK is filter ID
+ * */
+const filterColumn = (name: string) => ({
+    name,
+    type: 'varchar',
+    length: '20',
+    isNullable: true
+});
+const authorIsColumn = () => filterColumn('authorIs');
+const itemIsColumn = () => filterColumn('itemIs');
+export const filterColumns = () => ([authorIsColumn(), itemIsColumn()]);
+const authorIsIndex = (prefix: string) => index(prefix, ['authorIs']);
+const itemIsIndex = (prefix: string) => index(prefix, ['itemIs']);
+export const filterIndices = (prefix: string) => {
+    return [
+        authorIsIndex(prefix),
+        itemIsIndex(prefix)
+    ]
+}
+
+export const tableHasData = async (runner: QueryRunner, name: string): Promise<boolean | null> => {
+    const countRes = await runner.query(`select count(*) from ${name}`);
+    let hasRows = null;
+    if (Array.isArray(countRes) && countRes[0] !== null) {
+        const {
+            'count(*)': count
+        } = countRes[0] || {};
+        hasRows = count !== 0;
+    }
+    return hasRows;
+}

src/Common/Migrations/Database/Server/1642180264563-initApi.ts

@@ -1,86 +1,12 @@
-import {MigrationInterface, QueryRunner, Table, TableIndex, TableColumn, TableForeignKey} from "typeorm";
-
-const randomIdColumn = () => ({
-    name: 'id',
-    type: 'varchar',
-    length: '20',
-    isPrimary: true,
-    isUnique: true,
-});
-
-const timeAtColumn = (columnName: string, dbType: string, nullable?: boolean) => {
-    const dbSpecifics = dbType === 'postgres' ? {
-        type: 'timestamptz'
-    } : {
-        type: 'datetime',
-        // required to get millisecond precision on mysql/mariadb
-        // https://mariadb.com/kb/en/datetime/
-        // https://dev.mysql.com/doc/refman/8.0/en/fractional-seconds.html
-        length: '3',
-    }
-    return {
-        name: columnName,
-        isNullable: nullable ?? false,
-        ...dbSpecifics
-    }
-}
-
-const createdAtColumn = (type: string) => timeAtColumn('createdAt', type);
-const updatedAtColumn = (type: string) => timeAtColumn('updatedAt', type);
-
-const createdUpdatedAtColumns = (type: string) => [
-    timeAtColumn('createdAt', type),
-    timeAtColumn('updatedAt', type)
-];
-
-
-const createdAtIndex = (prefix: string) => new TableIndex({
-    name: `IDX_${prefix}_createdAt`,
-    columnNames: ['createdAt']
-});
-
-const updatedAtIndex = (prefix: string) => new TableIndex({
-    name: `IDX_${prefix}_updatedAt`,
-    columnNames: ['updatedAt']
-})
-
-const createdUpdatedAtIndices = (prefix: string) => {
-    return [
-        createdAtIndex(prefix),
-        updatedAtIndex(prefix)
-    ]
-}
-
-const filterColumn = (name: string) => ({
-    name,
-    type: 'varchar',
-    length: '20',
-    isNullable: true
-});
-
-const authorIsColumn = () => filterColumn('authorIs');
-const itemIsColumn = () => filterColumn('itemIs');
-
-const filterColumns = () => ([authorIsColumn(), itemIsColumn()]);
-
-const authorIsIndex = (prefix: string) => new TableIndex({
-    name: `IDX_${prefix}_authorIs`,
-    columnNames: ['authorIs'],
-    isUnique: true,
-});
-
-const itemIsIndex = (prefix: string) => new TableIndex({
-    name: `IDX_${prefix}_itemIs`,
-    columnNames: ['itemIs'],
-    isUnique: true
-});
-
-const filterIndices = (prefix: string) => {
-    return [
-        authorIsIndex(prefix),
-        itemIsIndex(prefix)
-    ]
-}
+import {MigrationInterface, QueryRunner, Table, TableIndex} from "typeorm";
+import {
+    createdAtColumn,
+    createdAtIndex,
+    filterColumns,
+    filterIndices,
+    randomIdColumn,
+    timeAtColumn
+} from "../MigrationUtil";
 
 export class initApi1642180264563 implements MigrationInterface {
     name = 'initApi1642180264563'

src/Common/Migrations/Database/Server/1653586738904-indexes.ts

@@ -1,12 +1,5 @@
-import {MigrationInterface, QueryRunner, Table, TableIndex} from "typeorm"
-
-const index = (prefix: string, columns: string[], unique = true) => new TableIndex({
-    name: `IDX_${unique ? 'UN_' : ''}${prefix}_${columns.join('-')}_MIG`,
-    columnNames: columns,
-    isUnique: unique,
-});
-
-const idIndex = (prefix: string, unique: boolean) => index(prefix, ['id'], unique);
+import {MigrationInterface, QueryRunner, Table} from "typeorm"
+import {idIndex, index} from "../MigrationUtil";
 
 export class indexes1653586738904 implements MigrationInterface {
 

src/Common/Migrations/Database/Server/1657632517934-reportTracking.ts

@@ -0,0 +1,62 @@
+import {MigrationInterface, QueryRunner, Table, TableIndex} from "typeorm"
+import {createdAtColumn, createdAtIndex, idIndex, index, randomIdColumn} from "../MigrationUtil";
+
+export class reportTracking1657632517934 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+
+        const dbType = queryRunner.connection.driver.options.type;
+
+        await queryRunner.createTable(
+            new Table({
+                name: 'ActivityReport',
+                columns: [
+                    randomIdColumn(),
+                    {
+                        name: 'activityId',
+                        type: 'varchar',
+                        length: '20',
+                        isNullable: false
+                    },
+                    {
+                        name: 'reason',
+                        type: 'varchar',
+                        length: '500',
+                        isNullable: false
+                    },
+                    {
+                        name: 'type',
+                        type: 'varchar',
+                        length: '200',
+                        isNullable: false
+                    },
+                    {
+                        name: 'author',
+                        type: 'varchar',
+                        length: '100',
+                        isNullable: true
+                    },
+                    {
+                        name: 'granularity',
+                        type: 'int',
+                        isNullable: false
+                    },
+                    createdAtColumn(dbType),
+                ],
+                indices: [
+                    idIndex('ActivityReport', true),
+                    index('ActivityReport', ['activityId'], false),
+                    index('ActivityReportReason', ['reason'], false),
+                    createdAtIndex('report'),
+                ]
+            }),
+            true,
+            true,
+            true
+        );
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Server/1658930394548-Guests.ts

@@ -0,0 +1,50 @@
+import {MigrationInterface, QueryRunner, Table} from "typeorm"
+import {createdAtColumn, createdAtIndex, idIndex, index, randomIdColumn, timeAtColumn} from "../MigrationUtil";
+
+export class Guests1658930394548 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const dbType = queryRunner.connection.driver.options.type;
+
+        await queryRunner.createTable(
+            new Table({
+                name: 'Guests',
+                columns: [
+                    randomIdColumn(),
+                    {
+                        name: 'authorName',
+                        type: 'varchar',
+                        length: '200',
+                        isNullable: false,
+                    },
+                    {
+                        name: 'type',
+                        type: 'varchar',
+                        isNullable: false,
+                        length: '50'
+                    },
+                    {
+                        name: 'guestOfId',
+                        type: 'varchar',
+                        length: '20',
+                        isNullable: true
+                    },
+                    timeAtColumn('expiresAt', dbType, true),
+                    createdAtColumn(dbType),
+                ],
+                indices: [
+                    idIndex('Guests', true),
+                    createdAtIndex('guests'),
+                    index('guest', ['expiresAt'], false)
+                ]
+            }),
+            true,
+            true,
+            true
+        );
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Server/1660228987769-invites.ts

@@ -0,0 +1,145 @@
+import {MigrationInterface, QueryRunner, Table, TableColumn} from "typeorm"
+import {createdAtColumn, createdAtIndex, idIndex, index, randomIdColumn, tableHasData, timeAtColumn} from "../MigrationUtil";
+
+export class invites1660228987769 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const dbType = queryRunner.connection.driver.options.type;
+
+        await queryRunner.createTable(
+            new Table({
+                name: 'SubredditInvite',
+                columns: [
+                    {
+                        name: 'id',
+                        type: 'varchar',
+                        length: '255',
+                        isPrimary: true,
+                    },
+                    {
+                        name: 'botId',
+                        type: 'varchar',
+                        length: '20',
+                        isNullable: false
+                    },
+                    {
+                        name: 'subreddit',
+                        type: 'varchar',
+                        length: '255',
+                        isNullable: false
+                    },
+                    {
+                        name: 'guests',
+                        type: 'text',
+                        isNullable: true
+                    },
+                    {
+                        name: 'initialConfig',
+                        type: 'text',
+                        isNullable: true
+                    },
+                    createdAtColumn(dbType),
+                    timeAtColumn('expiresAt', dbType, true)
+                ],
+            }),
+            true,
+            true,
+            true
+        );
+
+        if (await queryRunner.hasTable('Invite')) {
+
+            await queryRunner.renameTable('Invite', 'BotInvite');
+            const table = await queryRunner.getTable('BotInvite') as Table;
+
+            await queryRunner.addColumns(table, [
+                new TableColumn({
+                    name: 'initialConfig',
+                    type: 'text',
+                    isNullable: true
+                }),
+                new TableColumn({
+                    name: 'guests',
+                    type: 'text',
+                    isNullable: true
+                })
+            ]);
+
+            queryRunner.connection.logger.logSchemaBuild(`Table 'Invite' has been renamed 'BotInvite'. If there are existing rows on this table they will need to be recreated.`);
+
+        } else {
+
+            await queryRunner.createTable(
+                new Table({
+                    name: 'BotInvite',
+                    columns: [
+                        {
+                            name: 'id',
+                            type: 'varchar',
+                            length: '255',
+                            isPrimary: true,
+                        },
+                        {
+                            name: 'clientId',
+                            type: 'varchar',
+                            length: '255',
+                        },
+                        {
+                            name: 'clientSecret',
+                            type: 'varchar',
+                            length: '255',
+                        },
+                        {
+                            name: 'redirectUri',
+                            type: 'text',
+                        },
+                        {
+                            name: 'creator',
+                            type: 'varchar',
+                            length: '255',
+                        },
+                        {
+                            name: 'permissions',
+                            type: 'text'
+                        },
+                        {
+                            name: 'instance',
+                            type: 'varchar',
+                            length: '255',
+                            isNullable: true
+                        },
+                        {
+                            name: 'overwrite',
+                            type: 'boolean',
+                            isNullable: true,
+                        },
+                        {
+                            name: 'subreddits',
+                            type: 'text',
+                            isNullable: true
+                        },
+                        {
+                            name: 'guests',
+                            type: 'text',
+                            isNullable: true
+                        },
+                        {
+                            name: 'initialConfig',
+                            type: 'text',
+                            isNullable: true
+                        },
+                        createdAtColumn(dbType),
+                        timeAtColumn('expiresAt', dbType, true)
+                    ],
+                }),
+                true,
+                true,
+                true
+            );
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Server/1661183583080-submission.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import {ActionType} from "../../../Entities/ActionType";
+
+export class submission1661183583080 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.getRepository(ActionType).save([
+            new ActionType('submission')
+        ]);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Server/1663001719622-subredditInvite.ts

@@ -0,0 +1,22 @@
+import {MigrationInterface, QueryRunner, Table, TableColumn} from "typeorm"
+
+export class subredditInvite1663001719622 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const table = await queryRunner.getTable('SubredditInvite') as Table;
+
+        await queryRunner.addColumns(table, [
+            new TableColumn(                    {
+                name: 'messageId',
+                type: 'varchar',
+                length: '200',
+                isUnique: true,
+                isNullable: true
+            }),
+        ]);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Server/1663609045418-mhs.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import {RuleType} from "../../../Entities/RuleType";
+
+export class mhs1663609045418 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.getRepository(RuleType).save([
+            new RuleType('mhs'),
+        ]);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/Migrations/Database/Web/1660588028346-removeInvites.ts

@@ -0,0 +1,33 @@
+import {MigrationInterface, QueryRunner} from "typeorm"
+import {tableHasData} from "../MigrationUtil";
+
+export class removeInvites1660588028346 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        const dbType = queryRunner.connection.driver.options.type;
+
+        if (dbType === 'sqljs' && await queryRunner.hasTable('Invite')) {
+            // const countRes = await queryRunner.query('select count(*) from Invite');
+            // let hasNoRows = null;
+            // if (Array.isArray(countRes) && countRes[0] !== null) {
+            //     const {
+            //         'count(*)': count
+            //     } = countRes[0] || {};
+            //     hasNoRows = count === 0;
+            // }
+
+            const hasRows = await tableHasData(queryRunner, 'Invite');
+
+            if (hasRows === false) {
+                await queryRunner.dropTable('Invite');
+            } else {
+                let prefix = hasRows === null ? `Could not determine if SQL.js 'web' database had the table 'Invite' --` : `SQL.js 'web' database had the table 'Invite' and it is not empty --`
+                queryRunner.connection.logger.logSchemaBuild(`${prefix} This table is being replaced by 'BotInvite' table in 'app' database. If you have existing invites you will need to recreate them.`);
+            }
+        }
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+
+}

src/Common/WebEntities/ClientSession.ts

@@ -1,5 +1,5 @@
 import { ISession } from "connect-typeorm";
-import { Column, Entity, Index, PrimaryColumn } from "typeorm";
+import { Column, Entity, Index, PrimaryColumn, DeleteDateColumn } from "typeorm";
 @Entity()
 export class ClientSession implements ISession {
     @Index()
@@ -12,6 +12,6 @@ export class ClientSession implements ISession {
     @Column("text")
     public json = "";
 
-    @Column({ name: 'destroyedAt', nullable: true })
+    @DeleteDateColumn({ name: 'destroyedAt', nullable: true })
     destroyedAt?: Date;
 }

src/Common/blockhash/blockhash.ts

@@ -107,8 +107,7 @@ var bmvbhash_even = function(data: BlockImageData, bits: number) {
     return bits_to_hexhash(result);
 };
 
-var bmvbhash = function(data: BlockImageData, bits: number) {
-    var result = [];
+var bmvbhash = function(data: BlockImageData, bits: number, calculateFlipped: boolean = false): string | [string, string] {
 
     var i, j, x, y;
     var block_width, block_height;
@@ -198,30 +197,51 @@ var bmvbhash = function(data: BlockImageData, bits: number) {
         }
     }
 
-    for (i = 0; i < bits; i++) {
-        for (j = 0; j < bits; j++) {
-            result.push(blocks[i][j]);
+    const blocksFlipped: number[][] | undefined = calculateFlipped ? [] : undefined;
+    if(blocksFlipped !== undefined) {
+        for(const row of blocks) {
+            const flippedRow = [...row];
+            flippedRow.reverse();
+            blocksFlipped.push(flippedRow);
         }
     }
 
-    translate_blocks_to_bits(result, block_width * block_height);
-    return bits_to_hexhash(result);
+    if(blocksFlipped !== undefined) {
+        const result = [];
+        const resultFlip = [];
+        for (i = 0; i < bits; i++) {
+            for (j = 0; j < bits; j++) {
+                result.push(blocks[i][j]);
+                resultFlip.push(blocksFlipped[i][j])
+            }
+        }
+
+        translate_blocks_to_bits(result, block_width * block_height);
+        translate_blocks_to_bits(resultFlip, block_width * block_height);
+        return [bits_to_hexhash(result), bits_to_hexhash(resultFlip)];
+    } else {
+        const result = [];
+        for (i = 0; i < bits; i++) {
+            for (j = 0; j < bits; j++) {
+                result.push(blocks[i][j]);
+            }
+        }
+
+        translate_blocks_to_bits(result, block_width * block_height);
+        return bits_to_hexhash(result);
+    }
 };
 
-var blockhashData = function(imgData: BlockImageData, bits: number, method: number) {
-    var hash;
+var blockhashData = function(imgData: BlockImageData, bits: number, method: number, calculateFlipped: boolean): string | [string, string] {
 
     if (method === 1) {
-        hash = bmvbhash_even(imgData, bits);
+        return bmvbhash_even(imgData, bits);
     }
     else if (method === 2) {
-        hash = bmvbhash(imgData, bits);
-    }
-    else {
-        throw new Error("Bad hashing method");
+        return bmvbhash(imgData, bits, calculateFlipped);
     }
 
-    return hash;
+    throw new Error("Bad hashing method");
 };
 
 export const blockhash = async function(src: Sharp, bits: number, method: number = 2): Promise<string> {
@@ -230,5 +250,14 @@ export const blockhash = async function(src: Sharp, bits: number, method: number
         width: info.width,
         height: info.height,
         data: buff,
-    }, bits, method);
+    }, bits, method, false) as string;
+};
+
+export const blockhashAndFlipped = async function(src: Sharp, bits: number, method: number = 2): Promise<[string, string]> {
+    const {data: buff, info} = await src.ensureAlpha().raw().toBuffer({resolveWithObject: true});
+    return blockhashData({
+        width: info.width,
+        height: info.height,
+        data: buff,
+    }, bits, method, true) as [string, string];
 };

src/Common/defaults.ts

@@ -2,6 +2,9 @@ import {HistoricalStatsDisplay} from "./interfaces";
 import path from "path";
 import {FilterCriteriaDefaults} from "./Infrastructure/Filters/FilterShapes";
 
+export const dayjsDTFormat = 'YYYY-MM-DD HH:mm:ssZ';
+export const dayjsTimeFormat = 'HH:mm:ss z';
+
 export const cacheOptDefaults = {ttl: 60, max: 500, checkPeriod: 600};
 export const cacheTTLDefaults = {
     authorTTL: 60,
@@ -42,4 +45,4 @@ export const filterCriteriaDefault: FilterCriteriaDefaults = {
 export const defaultDataDir = path.resolve(__dirname, '../..');
 export const defaultConfigFilenames = ['config.json', 'config.yaml'];
 
-export const VERSION = '0.11.1';
+export const VERSION = '0.12.2';

src/Common/interfaces.ts

@@ -6,7 +6,6 @@ import Comment from "snoowrap/dist/objects/Comment";
 import RedditUser from "snoowrap/dist/objects/RedditUser";
 import {DataSource} from "typeorm";
 import {JsonOperatorConfigDocument, YamlOperatorConfigDocument} from "./Config/Operator";
-import {CommentCheckJson, SubmissionCheckJson} from "../Check";
 import {SafeDictionary} from "ts-essentials";
 import {RuleResultEntity} from "./Entities/RuleResultEntity";
 import {Dayjs} from "dayjs";
@@ -22,7 +21,7 @@ import {
     DurationVal,
     EventRetentionPolicyRange,
     JoinOperands,
-    NonDispatchActivitySource,
+    NonDispatchActivitySourceValue,
     NotificationEventType,
     NotificationProvider,
     onExistingFoundBehavior,
@@ -43,8 +42,16 @@ import {
     ItemOptions
 } from "./Infrastructure/Filters/FilterShapes";
 import {LoggingOptions, LogLevel, StrongLoggingOptions} from "./Infrastructure/Logging";
-import {DatabaseConfig, DatabaseDriver, DatabaseDriverConfig, DatabaseDriverType} from "./Infrastructure/Database";
+import {
+    DatabaseConfig,
+    DatabaseDriver,
+    DatabaseDriverConfig,
+    DatabaseDriverType
+} from "./Infrastructure/Database";
 import {ActivityType} from "./Infrastructure/Reddit";
+import {InfluxDB, WriteApi} from "@influxdata/influxdb-client";
+import {InfluxConfig} from "./Influx/interfaces";
+import {InfluxClient} from "./Influx/InfluxClient";
 
 
 export interface ReferenceSubmission {
@@ -725,19 +732,14 @@ export interface SearchAndReplaceRegExp {
 }
 
 export interface NamedGroup {
-    [name: string]: string
-}
-
-export interface GlobalRegExResult {
-    match: string,
-    groups: string[],
-    named: NamedGroup | undefined
+    [name: string]: any
 }
 
 export interface RegExResult {
-    matched: boolean,
-    matches: string[],
-    global: GlobalRegExResult[]
+    match: string,
+    groups: string[],
+    index: number
+    named: NamedGroup
 }
 
 export type StrongCache = {
@@ -1058,6 +1060,16 @@ export interface SubredditOverrides {
          * */
         retention?: EventRetentionPolicyRange
     }
+
+    /**
+     * The relative URL to the ContextMod wiki page EX `https://reddit.com/r/subreddit/wiki/<path>`
+     *
+     * This will override the default relative URL as well as any URL set at the bot-level
+     *
+     * @default "botconfig/contextbot"
+     * @examples ["botconfig/contextbot"]
+     * */
+    wikiConfig?: string
 }
 
 /**
@@ -1119,6 +1131,8 @@ export interface BotInstanceJsonConfig {
         retention?: EventRetentionPolicyRange
     }
 
+    influxConfig?: InfluxConfig
+
     /**
      * Settings related to bot behavior for subreddits it is managing
      * */
@@ -1374,6 +1388,8 @@ export interface OperatorJsonConfig {
         retention?: EventRetentionPolicyRange
     }
 
+    influxConfig?: InfluxConfig
+
     /**
      * Set global snoowrap options as well as default snoowrap config for all bots that don't specify their own
      * */
@@ -1473,20 +1489,6 @@ export interface OperatorJsonConfig {
             storage?: 'database' | 'cache'
         }
 
-        /**
-         * Settings related to oauth flow invites
-         * */
-        invites?: {
-            /**
-            * Number of seconds an invite should be valid for
-             *
-             * If `0` or not specified (default) invites do not expire
-            *
-            * @default 0
-            * @examples [0]
-            * */
-            maxAge?: number
-        }
         /**
          * The default log level to filter to in the web interface
          *
@@ -1542,11 +1544,30 @@ export interface OperatorJsonConfig {
         secret?: string,
         /**
          * A friendly name for this server. This will override `friendly` in `BotConnection` if specified.
+         *
+         * If none is set one is randomly generated.
          * */
         friendly?: string,
     }
 
     credentials?: ThirdPartyCredentialsJsonConfig
+
+    dev?: {
+        /**
+         * Invoke `process.memoryUsage()` on an interval and send metrics to Influx
+         *
+         * Only works if Influx config is provided
+         * */
+        monitorMemory?: boolean
+        /**
+        * Interval, in seconds, to invoke `process.memoryUsage()` at
+        *
+        * Defaults to 15 seconds
+        *
+        * @default 15
+        * */
+        monitorMemoryInterval?: number
+    };
 }
 
 export interface RequiredOperatorRedditCredentials extends RedditCredentials {
@@ -1564,6 +1585,9 @@ export interface ThirdPartyCredentialsJsonConfig {
     youtube?: {
         apiKey: string
     }
+    mhs?: {
+        apiKey: string
+    }
     [key: string]: any
 }
 
@@ -1580,6 +1604,7 @@ export interface BotInstanceConfig extends BotInstanceJsonConfig {
     database: DataSource
     snoowrap: SnoowrapOptions
     databaseStatisticsDefaults: DatabaseStatisticsOperatorConfig
+    opInflux?: InfluxClient,
     subreddits: {
         names?: string[],
         exclude?: string[],
@@ -1620,6 +1645,7 @@ export interface OperatorConfig extends OperatorJsonConfig {
         retention?: EventRetentionPolicyRange
     }
     database: DataSource
+    influx?: InfluxClient,
     web: {
         database: DataSource,
         databaseConfig: {
@@ -1634,9 +1660,6 @@ export interface OperatorConfig extends OperatorJsonConfig {
             secret?: string,
             storage?: 'database' | 'cache'
         },
-        invites: {
-          maxAge: number
-        },
         logLevel?: LogLevel,
         maxLogs: number,
         clients: BotConnection[]
@@ -1651,6 +1674,10 @@ export interface OperatorConfig extends OperatorJsonConfig {
     databaseStatisticsDefaults: DatabaseStatisticsOperatorConfig
     bots: BotInstanceConfig[]
     credentials: ThirdPartyCredentialsJsonConfig
+    dev: {
+        monitorMemory: boolean
+        monitorMemoryInterval: number
+    }
 }
 
 export interface OperatorFileConfig {
@@ -1706,6 +1733,7 @@ export interface ActionProcessResult {
     dryRun: boolean,
     result?: string
     touchedEntities?: (Submission | Comment | RedditUser | string)[]
+    data?: any
 }
 
 export interface EventActivity {
@@ -1901,8 +1929,6 @@ export interface TextMatchOptions {
     caseSensitive?: boolean
 }
 
-export type ActivityCheckJson = SubmissionCheckJson | CommentCheckJson;
-
 export interface PostBehaviorOptionConfig {
     recordTo?: RecordOutputOption
     behavior?: PostBehaviorType
@@ -1941,7 +1967,7 @@ export type RequiredItemCrit = Required<(CommentState & SubmissionState)>;
 
 export interface ActivityDispatchConfig {
     identifier?: string
-    cancelIfQueued?: boolean | NonDispatchActivitySource | NonDispatchActivitySource[]
+    cancelIfQueued?: boolean | NonDispatchActivitySourceValue | NonDispatchActivitySourceValue[]
     goto?: string
     onExistingFound?: onExistingFoundBehavior
     tardyTolerant?: boolean | DurationVal

src/Common/types.ts

@@ -19,8 +19,11 @@ import {DispatchActionJson} from "../Action/DispatchAction";
 import {CancelDispatchActionJson} from "../Action/CancelDispatchAction";
 import {ContributorActionJson} from "../Action/ContributorAction";
 import {SentimentRuleJSONConfig} from "../Rule/SentimentRule";
+import {MHSRuleJSONConfig} from "../Rule/MHSRule";
 import {ModNoteActionJson} from "../Action/ModNoteAction";
+import {IncludesData} from "./Infrastructure/Includes";
+import { SubmissionActionJson } from "../Action/SubmissionAction";
 
-export type RuleObjectJsonTypes = RecentActivityRuleJSONConfig | RepeatActivityJSONConfig | AuthorRuleJSONConfig | AttributionJSONConfig | HistoryJSONConfig | RegexRuleJSONConfig | RepostRuleJSONConfig | SentimentRuleJSONConfig
+export type RuleObjectJsonTypes = RecentActivityRuleJSONConfig | RepeatActivityJSONConfig | AuthorRuleJSONConfig | AttributionJSONConfig | HistoryJSONConfig | RegexRuleJSONConfig | RepostRuleJSONConfig | SentimentRuleJSONConfig | MHSRuleJSONConfig
 
-export type ActionJson = CommentActionJson | FlairActionJson | ReportActionJson | LockActionJson | RemoveActionJson | ApproveActionJson | BanActionJson | UserNoteActionJson | MessageActionJson | UserFlairActionJson | DispatchActionJson | CancelDispatchActionJson | ContributorActionJson | ModNoteActionJson | string;
+export type ActionJson = CommentActionJson | SubmissionActionJson | FlairActionJson | ReportActionJson | LockActionJson | RemoveActionJson | ApproveActionJson | BanActionJson | UserNoteActionJson | MessageActionJson | UserFlairActionJson | DispatchActionJson | CancelDispatchActionJson | ContributorActionJson | ModNoteActionJson | string | IncludesData;