Merge branch 'edge'

* Implement a DTO class for activity source to make parts usage (type, identifier) and matching easier
* Implement regex to parse type and identifier from activity source string
* Refactor activity source interface/types to better distinguish as string, data, and class

README.md

@@ -31,6 +31,8 @@ Feature Highlights for **Moderators:**
 * [**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):**
 
@@ -134,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:

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/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/components/README.md

@@ -22,6 +22,7 @@ This list is not exhaustive. [For complete documentation on a subreddit's config
     * [Regex](#regex)
     * [Repost](#repost)
     * [Sentiment Analysis](#sentiment-analysis)
+    * [Toxic Content Prediction](#moderatehatespeechcom-predictions)
 * [Rule Sets](#rule-sets)
 * [Actions](#actions)
   * [Named Actions](#named-actions)
@@ -377,6 +378,12 @@ This rule is for searching **all of Reddit** for reposts, as opposed to just the
 
 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.

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/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/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

package-lock.json

@@ -11,6 +11,7 @@
       "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",
@@ -656,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",
@@ -5796,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",
@@ -10812,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",
@@ -14886,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",

package.json

@@ -31,6 +31,7 @@
   "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",

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";
@@ -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';
@@ -43,10 +52,17 @@ import {FilterCriteriaDefaults} from "../Common/Infrastructure/Filters/FilterSha
 import {snooLogWrapper} from "../Utils/loggerFactory";
 import {InfluxClient} from "../Common/Influx/InfluxClient";
 import {Point} from "@influxdata/influxdb-client";
-import {BotInstanceFunctions, NormalizedManagerResponse} from "../Web/Common/interfaces";
+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 implements BotInstanceFunctions {
 
@@ -61,6 +77,7 @@ class Bot implements BotInstanceFunctions {
     excludeSubreddits: string[];
     filterCriteriaDefaults?: FilterCriteriaDefaults
     subManagers: Manager[] = [];
+    moderatedSubreddits: Subreddit[] = []
     heartbeatInterval: number;
     nextHeartbeat: Dayjs = dayjs();
     heartBeating: boolean = false;
@@ -105,6 +122,8 @@ class Bot implements BotInstanceFunctions {
     runTypeRepo: Repository<RunStateType>;
     managerRepo: Repository<ManagerEntity>;
     authorRepo: Repository<AuthorEntity>;
+    subredditInviteRepo: Repository<SubredditInvite>
+    botRepo: Repository<BotEntity>
     botEntity!: BotEntity
 
     getBotName = () => {
@@ -168,6 +187,8 @@ class Bot implements BotInstanceFunctions {
         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;
@@ -406,18 +427,27 @@ class Bot implements BotInstanceFunctions {
         }
     }
 
+    async getModeratedSubreddits(refresh = false) {
+
+        if(this.moderatedSubreddits.length > 0 && !refresh) {
+            return this.moderatedSubreddits;
+        }
+
+        let subListing = await this.client.getModeratedSubreddits({count: 100});
+        while (!subListing.isFinished) {
+            subListing = await subListing.fetchMore({amount: 100});
+        }
+        const availSubs = subListing.filter(x => x.display_name !== `u_${this.botUser?.name}`);
+        this.moderatedSubreddits = availSubs;
+        return availSubs;
+    }
+
     async buildManagers(subreddits: string[] = []) {
         await this.init();
 
         this.logger.verbose('Syncing subreddits to moderate with managers...');
 
-        let availSubs: Subreddit[] = [];
-
-        let subListing = await this.client.getModeratedSubreddits({count: 100});
-        while(!subListing.isFinished) {
-            subListing = await subListing.fetchMore({amount: 100});
-        }
-        availSubs = subListing.filter(x => x.display_name !== `u_${this.botUser?.name}`);
+        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(', ')}`);
 
@@ -635,7 +665,7 @@ class Bot implements BotInstanceFunctions {
             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 {
@@ -760,21 +790,50 @@ class Bot implements BotInstanceFunctions {
     }
 
     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);
-            } 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.error(`Error occurred while checking r/${name} for a pending moderation invite. Error: ${err.message}`);
+        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 {
+                    await this.acceptModInvite(subInvite);
+                    await this.deleteSubredditInvite(subInvite);
+                } catch (err: any) {
+                    if(definesSeriousError(err) && !err.isSerious) {
+                        this.logger.warn(err);
+                    } else {
+                        this.logger.error(err);
+                    }
                 }
+            } 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 {
+                    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});
             }
         }
     }
@@ -1236,6 +1295,140 @@ class Bot implements BotInstanceFunctions {
 
         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/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/Entities/Bot.ts

@@ -65,4 +65,26 @@ export class Bot extends RandomIdBaseEntity implements HasGuests {
         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/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/ManagerEntity.ts

@@ -43,7 +43,7 @@ export class ManagerEntity extends RandomIdBaseEntity implements RunningStateEnt
     @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})

src/Common/Entities/SubredditInvite.ts

@@ -1,5 +1,5 @@
-import {Column, Entity, JoinColumn, ManyToOne, PrimaryColumn} from "typeorm";
-import {InviteData, SubredditInviteData} from "../../Web/Common/interfaces";
+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";
@@ -8,6 +8,7 @@ import {Bot} from "./Bot";
 @Entity()
 export class SubredditInvite extends TimeAwareRandomBaseEntity implements SubredditInviteData {
 
+    @PrimaryColumn("varchar", {length: 255})
     subreddit!: string;
 
     @Column("simple-json", {nullable: true})
@@ -16,6 +17,9 @@ export class SubredditInvite extends TimeAwareRandomBaseEntity implements Subred
     @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;
@@ -38,12 +42,13 @@ export class SubredditInvite extends TimeAwareRandomBaseEntity implements Subred
         }
     }
 
-    constructor(data?: SubredditInviteData & { expiresIn?: number }) {
+    constructor(data?: SubredditInviteData & { expiresIn?: number, bot: Bot }) {
         super();
         if (data !== undefined) {
             this.subreddit = data.subreddit;
-            this.initialConfig = data.initialConfig;
-            this.guests = data.guests;
+            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) {
@@ -51,4 +56,44 @@ export class SubredditInvite extends TimeAwareRandomBaseEntity implements Subred
             }
         }
     }
+
+    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/Infrastructure/Atomic.ts

@@ -17,6 +17,22 @@ import {ActivityType} from "./Reddit";
 
 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
  *
@@ -152,9 +168,16 @@ 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)$
@@ -172,7 +195,12 @@ 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 =

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";
@@ -441,6 +441,21 @@ export interface ActivityState {
      * */
     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
      *

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/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,

src/Common/interfaces.ts

@@ -21,7 +21,7 @@ import {
     DurationVal,
     EventRetentionPolicyRange,
     JoinOperands,
-    NonDispatchActivitySource,
+    NonDispatchActivitySourceValue,
     NotificationEventType,
     NotificationProvider,
     onExistingFoundBehavior,
@@ -1585,6 +1585,9 @@ export interface ThirdPartyCredentialsJsonConfig {
     youtube?: {
         apiKey: string
     }
+    mhs?: {
+        apiKey: string
+    }
     [key: string]: any
 }
 
@@ -1964,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,10 +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 | SubmissionActionJson | FlairActionJson | ReportActionJson | LockActionJson | RemoveActionJson | ApproveActionJson | BanActionJson | UserNoteActionJson | MessageActionJson | UserFlairActionJson | DispatchActionJson | CancelDispatchActionJson | ContributorActionJson | ModNoteActionJson | string | IncludesData;

src/Rule/MHSRule.ts

@@ -0,0 +1,420 @@
+import {Rule, RuleJSONConfig, RuleOptions} from "./index";
+import {Comment} from "snoowrap";
+import Submission from "snoowrap/dist/objects/Submission";
+import {
+    asComment, boolToString,
+    formatNumber,
+    triggeredIndicator, windowConfigToWindowCriteria
+} from "../util";
+import got, {HTTPError} from 'got';
+import dayjs from 'dayjs';
+import {map as mapAsync} from 'async';
+import {
+    comparisonTextOp,
+    GenericComparison,
+    parseGenericValueOrPercentComparison,
+} from "../Common/Infrastructure/Comparisons";
+import {ActivityWindowConfig, ActivityWindowCriteria} from "../Common/Infrastructure/ActivityWindow";
+import {RuleResult} from "../Common/interfaces";
+import {SnoowrapActivity} from "../Common/Infrastructure/Reddit";
+import {CMError} from "../Utils/Errors";
+import objectHash from "object-hash";
+
+const formatConfidence = (val: number) => formatNumber(val * 100, {
+    suffix: '%',
+    toFixed: 2
+});
+
+export class MHSRule extends Rule {
+
+    criteria: MHSCriteria
+
+    historical?: HistoricalMHS;
+
+    ogConfig: MHSConfig
+
+    constructor(options: MHSRuleOptions) {
+        super(options);
+
+        if (this.resources.thirdPartyCredentials.mhs?.apiKey === undefined) {
+            throw new CMError(`MHS (moderatehatespeech.com) API Key has not been specified. It must be present in the bot config or top-level subreddit 'credentials' property.`);
+        }
+
+        const {
+            criteria,
+            historical,
+        } = options;
+
+        this.ogConfig = {
+            criteria,
+            historical
+        };
+
+        const {
+            flagged = true,
+            confidence = '>= 90',
+            testOn = ['body']
+        } = criteria || {};
+
+        this.criteria = {
+            flagged,
+            confidence: confidence !== undefined ? parseGenericValueOrPercentComparison(confidence) : undefined,
+            testOn,
+        }
+
+        if (options.historical !== undefined) {
+            const {
+                window,
+                criteria: historyCriteria,
+                mustMatchCurrent = false,
+                totalMatching = '> 0',
+            } = options.historical
+
+            let usedCriteria: MHSCriteria;
+            if (historyCriteria === undefined) {
+                usedCriteria = this.criteria;
+            } else {
+                const {
+                    flagged: historyFlagged = true,
+                    confidence: historyConfidence = '>= 90',
+                    testOn: historyTestOn = ['body']
+                } = historyCriteria || {};
+                usedCriteria = {
+                    flagged: historyFlagged,
+                    confidence: historyConfidence !== undefined ? parseGenericValueOrPercentComparison(historyConfidence) : undefined,
+                    testOn: historyTestOn,
+                }
+            }
+
+            this.historical = {
+                criteria: usedCriteria,
+                window: windowConfigToWindowCriteria(window),
+                mustMatchCurrent,
+                totalMatching: parseGenericValueOrPercentComparison(totalMatching),
+            };
+        }
+    }
+
+    getKind(): string {
+        return 'mhs';
+    }
+
+    getSpecificPremise(): object {
+        return this.ogConfig;
+    }
+
+    protected async process(item: Submission | Comment): Promise<[boolean, RuleResult]> {
+
+        let ogResult = await this.testActivity(item, this.criteria);
+        let historicResults: MHSCriteriaResult[] | undefined;
+        let historicalCriteriaTest: string | undefined;
+
+        if (this.historical !== undefined && (!this.historical.mustMatchCurrent || ogResult.passed)) {
+            const {
+                criteria,
+                window,
+            } = this.historical;
+            const history = await this.resources.getAuthorActivities(item.author, window);
+
+            historicResults = await mapAsync(history, async (x: SnoowrapActivity) => await this.testActivity(x, criteria)); // history.map(x => this.testActivity(x, sentiment));
+        }
+
+        const logSummary: string[] = [];
+
+        let triggered = false;
+        let humanWindow: string | undefined;
+        let historicalPassed: string | undefined;
+        let totalMatchingText: string | undefined;
+
+        if (historicResults === undefined) {
+            triggered = ogResult.passed;
+            logSummary.push(`Current Activity MHS Test: ${ogResult.summary}`);
+            if (!triggered && this.historical !== undefined && this.historical.mustMatchCurrent) {
+                logSummary.push(`Did not check Historical because 'mustMatchCurrent' is true`);
+            }
+        } else {
+            const {
+                totalMatching,
+                criteria,
+            } = this.historical as HistoricalMHS;
+
+            historicalCriteriaTest = mhsCriteriaTestDisplay(criteria);
+
+            totalMatchingText = totalMatching.displayText;
+            const allResults = historicResults
+            const passed = allResults.filter(x => x.passed);
+
+            const firstActivity = allResults[0].activity;
+            const lastActivity = allResults[allResults.length - 1].activity;
+
+            const humanRange = dayjs.duration(dayjs(firstActivity.created_utc * 1000).diff(dayjs(lastActivity.created_utc * 1000))).humanize();
+
+            humanWindow = `${allResults.length} Activities (${humanRange})`;
+
+            const {operator, value, isPercent} = totalMatching;
+            if (isPercent) {
+                const passPercentVal = passed.length / allResults.length
+                triggered = comparisonTextOp(passPercentVal, operator, (value / 100));
+                historicalPassed = `${passed.length} (${formatNumber(passPercentVal)}%)`;
+            } else {
+                triggered = comparisonTextOp(passed.length, operator, value);
+                historicalPassed = `${passed.length}`;
+            }
+            logSummary.push(`${triggeredIndicator(triggered)} ${historicalPassed} historical activities of ${humanWindow} passed MHS criteria '${historicalCriteriaTest}' which ${triggered ? 'MET' : 'DID NOT MEET'} threshold '${totalMatching.displayText}'`);
+        }
+
+        const result = logSummary.join(' || ');
+        this.logger.verbose(result);
+
+        return Promise.resolve([triggered, this.getResult(triggered, {
+            result,
+            data: {
+                results: {
+                    triggered,
+                    criteriaTest: mhsCriteriaTestDisplay(this.criteria),
+                    historicalCriteriaTest,
+                    window: humanWindow,
+                    totalMatching: totalMatchingText
+                }
+            }
+        })]);
+    }
+
+    protected async testActivity(a: SnoowrapActivity, criteria: MHSCriteria): Promise<MHSCriteriaResult> {
+        const content = [];
+        if (asComment(a)) {
+            content.push(a.body);
+        } else {
+            if (criteria.testOn.includes('title')) {
+                content.push(a.title);
+            }
+            if (criteria.testOn.includes('body') && a.is_self) {
+                content.push(a.selftext);
+            }
+        }
+        const mhsResult = await this.getMHSResponse(content.join(' '));
+
+        const {
+            flagged,
+            confidence
+        } = criteria;
+
+        let flaggedPassed: boolean | undefined;
+        let confPassed: boolean | undefined;
+
+        let summary = [];
+
+        if (confidence !== undefined) {
+            const {operator, value} = confidence;
+            confPassed = comparisonTextOp(mhsResult.confidence * 100, operator, value);
+            summary.push(`Confidence test (${confidence.displayText}) ${confPassed ? 'PASSED' : 'DID NOT PASS'} MHS confidence of ${formatConfidence(mhsResult.confidence)}`)
+        }
+
+        if (flagged !== undefined) {
+            flaggedPassed = flagged ? mhsResult.class === 'flag' : mhsResult.class === 'normal';
+            summary.push(`Flagged pass condition of ${flagged} (${flagged ? 'toxic' : 'normal'}) ${flaggedPassed ? 'MATCHED' : 'DID NOT MATCH'} MHS flag '${mhsResult.class === 'flag' ? 'toxic' : 'normal'}' ${confidence === undefined ? ` (${formatConfidence(mhsResult.confidence)} confidence)` : ''}`);
+        }
+
+        const passed = (flaggedPassed === undefined || flaggedPassed) && (confPassed === undefined || confPassed);
+
+        return {
+            activity: a,
+            criteria,
+            mhsResult,
+            passed,
+            summary: `${triggeredIndicator(passed)} ${summary.join(' | ')}`
+        }
+    }
+
+    protected async getMHSResponse(content: string): Promise<MHSResponse> {
+        const hash = objectHash.sha1({content});
+        const key = `mhs-${hash}`;
+        if (this.resources.wikiTTL !== false) {
+            let res = await this.resources.cache.get(key) as undefined | null | MHSResponse;
+            if(res !== undefined && res !== null) {
+                // don't cache bad responses
+                if(res.response.toLowerCase() === 'success')
+                {
+                    return res;
+                }
+            }
+            res = await this.callMHS(content);
+            if(res.response.toLowerCase() === 'success') {
+                await this.resources.cache.set(key, res, {ttl: this.resources.wikiTTL});
+            }
+            return res;
+        }
+        return this.callMHS(content);
+    }
+
+    protected async callMHS(content: string): Promise<MHSResponse> {
+        try {
+            return await got.post(`https://api.moderatehatespeech.com/api/v1/moderate/`, {
+                headers: {
+                    'Content-Type': `application/json`,
+                },
+                json: {
+                    token: this.resources.thirdPartyCredentials.mhs?.apiKey,
+                    text: content
+                },
+            }).json() as MHSResponse;
+        } catch (err: any) {
+            let error: string | undefined = undefined;
+            if (err instanceof HTTPError) {
+                error = err.response.statusMessage;
+                if (typeof err.response.body === 'string') {
+                    error = `(${err.response.statusCode}) ${err.response.body}`;
+                }
+            }
+            throw new CMError(`MHS request failed${error !== undefined ? ` with error: ${error}` : ''}`, {cause: err});
+        }
+    }
+}
+
+const mhsCriteriaTestDisplay = (criteria: MHSCriteria) => {
+    const summary = [];
+    if (criteria.flagged !== undefined) {
+        summary.push(`${criteria.flagged ? 'IS FLAGGED' : 'IS NOT FLAGGED'} as toxic`);
+    }
+    if (criteria.confidence !== undefined) {
+        summary.push(`MHS confidence is ${criteria.confidence.displayText}`);
+    }
+    return summary.join(' AND ');
+}
+
+interface MHSResponse {
+    confidence: number
+    response: string
+    class: 'flag' | 'normal'
+}
+
+interface MHSCriteriaResult {
+    mhsResult: MHSResponse
+    criteria: MHSCriteria
+    passed: boolean
+    summary: string,
+    activity: SnoowrapActivity
+}
+
+/**
+ * Test the content of Activities from the Author history against MHS criteria
+ *
+ * If this is defined then the `totalMatching` threshold must pass for the Rule to trigger
+ *
+ * If `criteria` is defined here it overrides the top-level `criteria` value
+ *
+ * */
+interface HistoricalMHSConfig {
+    window: ActivityWindowConfig
+
+    criteria?: MHSCriteriaConfig
+
+    /**
+     * When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history
+     *
+     * @default false
+     * */
+    mustMatchCurrent?: boolean
+
+    /**
+     * A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test
+     *
+     * The syntax is `(< OR > OR <= OR >=) <number>[percent sign]`
+     *
+     * * EX `> 12`  => greater than 12 activities passed given `criteria` test
+     * * EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test
+     *
+     * @pattern ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
+     * @default "> 0"
+     * @examples ["> 0","> 10%"]
+     * */
+    totalMatching: string
+}
+
+interface HistoricalMHS extends Omit<HistoricalMHSConfig, | 'window' | 'totalMatching' | 'criteria'> {
+    window: ActivityWindowCriteria
+    criteria: MHSCriteria
+    totalMatching: GenericComparison
+}
+
+/**
+ * Criteria used to trigger based on MHS results
+ *
+ * If both `flagged` and `confidence` are specified then both conditions must pass.
+ *
+ * By default, only `flagged` is defined as `true`
+ * */
+interface MHSCriteriaConfig {
+    /**
+     * Test if MHS considers content flagged as toxic or not
+     *
+     * @default true
+     * */
+    flagged?: boolean
+
+    /**
+     * A string containing a comparison operator and a value to compare against the confidence returned from MHS
+     *
+     * The syntax is `(< OR > OR <= OR >=) <number>`
+     *
+     * * EX `> 50`  => MHS confidence is greater than 50%
+     *
+     * @pattern ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
+     * @examples ["> 50"]
+     * */
+    confidence?: string
+    /**
+     * Which content from an Activity to send to MHS
+     *
+     * Only used if the Activity being tested is a Submission -- Comments can be only tested against their body
+     *
+     * If more than one type of content is specified then all text is tested together as one string
+     *
+     * @default ["body"]
+     * */
+    testOn?: ('title' | 'body')[]
+}
+
+interface MHSCriteria extends Omit<MHSCriteriaConfig, 'confidence'> {
+    confidence?: GenericComparison
+    testOn: ('title' | 'body')[]
+}
+
+interface MHSConfig {
+
+    criteria?: MHSCriteriaConfig
+
+    /**
+     * run MHS on Activities from the Author history
+     *
+     * If this is defined then the `totalMatching` threshold must pass for the Rule to trigger
+     *
+     * If `criteria` is defined here it overrides the top-level `criteria` value
+     *
+     * */
+    historical?: HistoricalMHSConfig
+}
+
+export interface MHSRuleOptions extends MHSConfig, RuleOptions {
+}
+
+/**
+ * Test content of an Activity against the MHS toxicity model for reddit content
+ *
+ * Running this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.
+ *
+ * More info:
+ *
+ * * https://moderatehatespeech.com/docs/
+ * * https://moderatehatespeech.com/
+ *
+ * */
+export interface MHSRuleJSONConfig extends MHSConfig, RuleJSONConfig {
+    /**
+     * @examples ["mhs"]
+     * @default mhs
+     * */
+    kind: 'mhs'
+}
+
+export default MHSRule;

src/Rule/RecentActivityRule.ts

@@ -188,8 +188,10 @@ export class RecentActivityRule extends Rule {
         if (inferredSubmissionAsRef) {
             if (!asSubmission(item)) {
                 this.logger.warn('Cannot use post as reference because triggered item is not a Submission');
+                viableActivity = [];
             } else if (item.is_self) {
                 this.logger.warn('Cannot use post as reference because triggered Submission is not a link type');
+                viableActivity = [];
             } else {
                 const itemId = item.id;
                 const referenceUrl = await item.url;

src/Rule/RuleFactory.ts

@@ -12,6 +12,7 @@ import {RepostRule, RepostRuleJSONConfig} from "./RepostRule";
 import {StructuredFilter} from "../Common/Infrastructure/Filters/FilterShapes";
 import {SentimentRule, SentimentRuleJSONConfig} from "./SentimentRule";
 import {StructuredRuleConfigObject} from "../Common/Infrastructure/RuleShapes";
+import {MHSRuleJSONConfig, MHSRule} from "./MHSRule";
 
 export function ruleFactory
 (config: StructuredRuleConfigObject, logger: Logger, subredditName: string, resources: SubredditResources, client: Snoowrap): Rule {
@@ -42,6 +43,9 @@ export function ruleFactory
         case 'sentiment':
             cfg = config as StructuredFilter<SentimentRuleJSONConfig>;
             return new SentimentRule({...cfg, logger, subredditName, resources, client});
+        case 'mhs':
+            cfg = config as StructuredFilter<MHSRuleJSONConfig>;
+            return new MHSRule({...cfg, logger, subredditName, resources, client});
         default:
             throw new Error(`Rule with kind '${config.kind}' was not recognized.`);
     }

src/Rule/index.ts

@@ -185,5 +185,5 @@ export interface RuleJSONConfig extends IRule {
      * The kind of rule to run
      * @examples ["recentActivity", "repeatActivity", "author", "attribution", "history"]
      */
-    kind: 'recentActivity' | 'repeatActivity' | 'author' | 'attribution' | 'history' | 'regex' | 'repost' | 'sentiment'
+    kind: 'recentActivity' | 'repeatActivity' | 'author' | 'attribution' | 'history' | 'regex' | 'repost' | 'sentiment' | 'mhs'
 }

src/Schema/Action.json

@@ -764,6 +764,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -2508,6 +2522,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },

src/Schema/App.json

@@ -28,6 +28,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -1636,6 +1650,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -1687,6 +1704,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -2754,6 +2785,55 @@
             },
             "type": "object"
         },
+        "HistoricalMHSConfig": {
+            "description": "Test the content of Activities from the Author history against MHS criteria\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value",
+            "properties": {
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "mustMatchCurrent": {
+                    "default": false,
+                    "description": "When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history",
+                    "type": "boolean"
+                },
+                "totalMatching": {
+                    "default": "> 0",
+                    "description": "A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 12`  => greater than 12 activities passed given `criteria` test\n* EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test",
+                    "examples": [
+                        "> 0",
+                        "> 10%"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "window": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/DurationObject"
+                        },
+                        {
+                            "$ref": "#/definitions/FullActivityWindowConfig"
+                        },
+                        {
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        }
+                    ],
+                    "description": "A value to define the range of Activities to retrieve.\n\nAcceptable values:\n\n**`ActivityWindowCriteria` object**\n\nAllows specify multiple range properties and more specific behavior\n\n**A `number` of Activities to retrieve**\n\n* EX `100` => 100 Activities\n\n*****\n\nAny of the below values that specify the amount of time to subtract from `NOW` to create a time range IE `NOW <---> [duration] ago`\n\nAcceptable values:\n\n**A `string` consisting of a value and a [Day.js](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) time UNIT**\n\n* EX `9 days` => Range is `NOW <---> 9 days ago`\n\n**A [Day.js](https://day.js.org/docs/en/durations/creating) `object`**\n\n* EX `{\"days\": 90, \"minutes\": 15}` => Range is `NOW <---> 90 days and 15 minutes ago`\n\n**An [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) `string`**\n\n* EX `PT15M` => 15 minutes => Range is `NOW <----> 15 minutes ago`",
+                    "examples": [
+                        "90 days"
+                    ]
+                }
+            },
+            "required": [
+                "totalMatching",
+                "window"
+            ],
+            "type": "object"
+        },
         "HistoricalSentimentConfig": {
             "description": "Test the Sentiment of Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `sentiment` is defined here it overrides the top-level `sentiment` value",
             "properties": {
@@ -3223,6 +3303,126 @@
             ],
             "type": "object"
         },
+        "MHSCriteriaConfig": {
+            "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`",
+            "properties": {
+                "confidence": {
+                    "description": "A string containing a comparison operator and a value to compare against the confidence returned from MHS\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 50`  => MHS confidence is greater than 50%",
+                    "examples": [
+                        "> 50"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "flagged": {
+                    "default": true,
+                    "description": "Test if MHS considers content flagged as toxic or not",
+                    "type": "boolean"
+                },
+                "testOn": {
+                    "default": [
+                        "body"
+                    ],
+                    "description": "Which content from an Activity to send to MHS\n\nOnly used if the Activity being tested is a Submission -- Comments can be only tested against their body\n\nIf more than one type of content is specified then all text is tested together as one string",
+                    "items": {
+                        "enum": [
+                            "body",
+                            "title"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "MHSRuleJSONConfig": {
+            "description": "Test content of an Activity against the MHS toxicity model for reddit content\n\nRunning this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.\n\nMore info:\n\n* https://moderatehatespeech.com/docs/\n* https://moderatehatespeech.com/",
+            "properties": {
+                "authorIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/AuthorCriteria"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<AuthorCriteria>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<AuthorCriteria>"
+                        }
+                    ],
+                    "description": "If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail."
+                },
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "historical": {
+                    "$ref": "#/definitions/HistoricalMHSConfig",
+                    "description": "run MHS on Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value"
+                },
+                "itemIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/SubmissionState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/CommentState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<TypedActivityState>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<TypedActivityState>"
+                        }
+                    ],
+                    "description": "A list of criteria to test the state of the `Activity` against before running the check.\n\nIf any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.\n\n* @examples [[{\"over_18\": true, \"removed': false}]]"
+                },
+                "kind": {
+                    "default": "mhs",
+                    "description": "The kind of rule to run",
+                    "enum": [
+                        "mhs"
+                    ],
+                    "examples": [
+                        "mhs"
+                    ],
+                    "type": "string"
+                },
+                "name": {
+                    "description": "An optional, but highly recommended, friendly name for this rule. If not present will default to `kind`.\n\nCan only contain letters, numbers, underscore, spaces, and dashes\n\nname is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.",
+                    "examples": [
+                        "myNewRule"
+                    ],
+                    "pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "kind"
+            ],
+            "type": "object"
+        },
         "MessageActionJson": {
             "description": "Send a private message to the Author of the Activity.",
             "properties": {
@@ -5168,6 +5368,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "type": "string"
                             }
@@ -5961,6 +6164,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -6012,6 +6218,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -6223,6 +6443,17 @@
         "ThirdPartyCredentialsJsonConfig": {
             "additionalProperties": {},
             "properties": {
+                "mhs": {
+                    "properties": {
+                        "apiKey": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "apiKey"
+                    ],
+                    "type": "object"
+                },
                 "youtube": {
                     "properties": {
                         "apiKey": {

src/Schema/Check.json

@@ -42,6 +42,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -1459,6 +1473,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -1510,6 +1527,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -2468,6 +2499,55 @@
             },
             "type": "object"
         },
+        "HistoricalMHSConfig": {
+            "description": "Test the content of Activities from the Author history against MHS criteria\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value",
+            "properties": {
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "mustMatchCurrent": {
+                    "default": false,
+                    "description": "When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history",
+                    "type": "boolean"
+                },
+                "totalMatching": {
+                    "default": "> 0",
+                    "description": "A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 12`  => greater than 12 activities passed given `criteria` test\n* EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test",
+                    "examples": [
+                        "> 0",
+                        "> 10%"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "window": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/DurationObject"
+                        },
+                        {
+                            "$ref": "#/definitions/FullActivityWindowConfig"
+                        },
+                        {
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        }
+                    ],
+                    "description": "A value to define the range of Activities to retrieve.\n\nAcceptable values:\n\n**`ActivityWindowCriteria` object**\n\nAllows specify multiple range properties and more specific behavior\n\n**A `number` of Activities to retrieve**\n\n* EX `100` => 100 Activities\n\n*****\n\nAny of the below values that specify the amount of time to subtract from `NOW` to create a time range IE `NOW <---> [duration] ago`\n\nAcceptable values:\n\n**A `string` consisting of a value and a [Day.js](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) time UNIT**\n\n* EX `9 days` => Range is `NOW <---> 9 days ago`\n\n**A [Day.js](https://day.js.org/docs/en/durations/creating) `object`**\n\n* EX `{\"days\": 90, \"minutes\": 15}` => Range is `NOW <---> 90 days and 15 minutes ago`\n\n**An [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) `string`**\n\n* EX `PT15M` => 15 minutes => Range is `NOW <----> 15 minutes ago`",
+                    "examples": [
+                        "90 days"
+                    ]
+                }
+            },
+            "required": [
+                "totalMatching",
+                "window"
+            ],
+            "type": "object"
+        },
         "HistoricalSentimentConfig": {
             "description": "Test the Sentiment of Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `sentiment` is defined here it overrides the top-level `sentiment` value",
             "properties": {
@@ -2937,6 +3017,126 @@
             ],
             "type": "object"
         },
+        "MHSCriteriaConfig": {
+            "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`",
+            "properties": {
+                "confidence": {
+                    "description": "A string containing a comparison operator and a value to compare against the confidence returned from MHS\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 50`  => MHS confidence is greater than 50%",
+                    "examples": [
+                        "> 50"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "flagged": {
+                    "default": true,
+                    "description": "Test if MHS considers content flagged as toxic or not",
+                    "type": "boolean"
+                },
+                "testOn": {
+                    "default": [
+                        "body"
+                    ],
+                    "description": "Which content from an Activity to send to MHS\n\nOnly used if the Activity being tested is a Submission -- Comments can be only tested against their body\n\nIf more than one type of content is specified then all text is tested together as one string",
+                    "items": {
+                        "enum": [
+                            "body",
+                            "title"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "MHSRuleJSONConfig": {
+            "description": "Test content of an Activity against the MHS toxicity model for reddit content\n\nRunning this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.\n\nMore info:\n\n* https://moderatehatespeech.com/docs/\n* https://moderatehatespeech.com/",
+            "properties": {
+                "authorIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/AuthorCriteria"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<AuthorCriteria>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<AuthorCriteria>"
+                        }
+                    ],
+                    "description": "If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail."
+                },
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "historical": {
+                    "$ref": "#/definitions/HistoricalMHSConfig",
+                    "description": "run MHS on Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value"
+                },
+                "itemIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/SubmissionState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/CommentState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<TypedActivityState>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<TypedActivityState>"
+                        }
+                    ],
+                    "description": "A list of criteria to test the state of the `Activity` against before running the check.\n\nIf any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.\n\n* @examples [[{\"over_18\": true, \"removed': false}]]"
+                },
+                "kind": {
+                    "default": "mhs",
+                    "description": "The kind of rule to run",
+                    "enum": [
+                        "mhs"
+                    ],
+                    "examples": [
+                        "mhs"
+                    ],
+                    "type": "string"
+                },
+                "name": {
+                    "description": "An optional, but highly recommended, friendly name for this rule. If not present will default to `kind`.\n\nCan only contain letters, numbers, underscore, spaces, and dashes\n\nname is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.",
+                    "examples": [
+                        "myNewRule"
+                    ],
+                    "pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "kind"
+            ],
+            "type": "object"
+        },
         "MessageActionJson": {
             "description": "Send a private message to the Author of the Activity.",
             "properties": {
@@ -4742,6 +4942,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "type": "string"
                             }
@@ -5405,6 +5608,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -5456,6 +5662,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },

src/Schema/OperatorConfig.json

@@ -187,6 +187,17 @@
         },
         "BotCredentialsJsonConfig": {
             "properties": {
+                "mhs": {
+                    "properties": {
+                        "apiKey": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "apiKey"
+                    ],
+                    "type": "object"
+                },
                 "reddit": {
                     "$ref": "#/definitions/RedditCredentials"
                 },
@@ -523,6 +534,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -935,7 +960,7 @@
                 "file": {
                     "allOf": [
                         {
-                            "$ref": "#/definitions/Omit<DailyRotateFileTransportOptions,\"stream\"|\"log\"|\"dirname\"|\"options\"|\"handleRejections\"|\"format\"|\"handleExceptions\"|\"logv\"|\"close\">"
+                            "$ref": "#/definitions/Omit<DailyRotateFileTransportOptions,\"stream\"|\"log\"|\"options\"|\"dirname\"|\"handleRejections\"|\"format\"|\"handleExceptions\"|\"logv\"|\"close\">"
                         },
                         {
                             "properties": {
@@ -1382,7 +1407,7 @@
             ],
             "type": "object"
         },
-        "Omit<DailyRotateFileTransportOptions,\"stream\"|\"log\"|\"dirname\"|\"options\"|\"handleRejections\"|\"format\"|\"handleExceptions\"|\"logv\"|\"close\">": {
+        "Omit<DailyRotateFileTransportOptions,\"stream\"|\"log\"|\"options\"|\"dirname\"|\"handleRejections\"|\"format\"|\"handleExceptions\"|\"logv\"|\"close\">": {
             "properties": {
                 "auditFile": {
                     "description": "A string representing the name of the name of the audit file. (default: './hash-audit.json')",
@@ -1835,6 +1860,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -2049,6 +2088,17 @@
         "ThirdPartyCredentialsJsonConfig": {
             "additionalProperties": {},
             "properties": {
+                "mhs": {
+                    "properties": {
+                        "apiKey": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "apiKey"
+                    ],
+                    "type": "object"
+                },
                 "youtube": {
                     "properties": {
                         "apiKey": {

src/Schema/Rule.json

@@ -28,6 +28,9 @@
         {
             "$ref": "#/definitions/SentimentRuleJSONConfig"
         },
+        {
+            "$ref": "#/definitions/MHSRuleJSONConfig"
+        },
         {
             "type": "string"
         }
@@ -60,6 +63,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -764,6 +781,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -1317,6 +1348,55 @@
             },
             "type": "object"
         },
+        "HistoricalMHSConfig": {
+            "description": "Test the content of Activities from the Author history against MHS criteria\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value",
+            "properties": {
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "mustMatchCurrent": {
+                    "default": false,
+                    "description": "When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history",
+                    "type": "boolean"
+                },
+                "totalMatching": {
+                    "default": "> 0",
+                    "description": "A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 12`  => greater than 12 activities passed given `criteria` test\n* EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test",
+                    "examples": [
+                        "> 0",
+                        "> 10%"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "window": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/DurationObject"
+                        },
+                        {
+                            "$ref": "#/definitions/FullActivityWindowConfig"
+                        },
+                        {
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        }
+                    ],
+                    "description": "A value to define the range of Activities to retrieve.\n\nAcceptable values:\n\n**`ActivityWindowCriteria` object**\n\nAllows specify multiple range properties and more specific behavior\n\n**A `number` of Activities to retrieve**\n\n* EX `100` => 100 Activities\n\n*****\n\nAny of the below values that specify the amount of time to subtract from `NOW` to create a time range IE `NOW <---> [duration] ago`\n\nAcceptable values:\n\n**A `string` consisting of a value and a [Day.js](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) time UNIT**\n\n* EX `9 days` => Range is `NOW <---> 9 days ago`\n\n**A [Day.js](https://day.js.org/docs/en/durations/creating) `object`**\n\n* EX `{\"days\": 90, \"minutes\": 15}` => Range is `NOW <---> 90 days and 15 minutes ago`\n\n**An [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) `string`**\n\n* EX `PT15M` => 15 minutes => Range is `NOW <----> 15 minutes ago`",
+                    "examples": [
+                        "90 days"
+                    ]
+                }
+            },
+            "required": [
+                "totalMatching",
+                "window"
+            ],
+            "type": "object"
+        },
         "HistoricalSentimentConfig": {
             "description": "Test the Sentiment of Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `sentiment` is defined here it overrides the top-level `sentiment` value",
             "properties": {
@@ -1694,6 +1774,126 @@
             ],
             "type": "object"
         },
+        "MHSCriteriaConfig": {
+            "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`",
+            "properties": {
+                "confidence": {
+                    "description": "A string containing a comparison operator and a value to compare against the confidence returned from MHS\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 50`  => MHS confidence is greater than 50%",
+                    "examples": [
+                        "> 50"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "flagged": {
+                    "default": true,
+                    "description": "Test if MHS considers content flagged as toxic or not",
+                    "type": "boolean"
+                },
+                "testOn": {
+                    "default": [
+                        "body"
+                    ],
+                    "description": "Which content from an Activity to send to MHS\n\nOnly used if the Activity being tested is a Submission -- Comments can be only tested against their body\n\nIf more than one type of content is specified then all text is tested together as one string",
+                    "items": {
+                        "enum": [
+                            "body",
+                            "title"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "MHSRuleJSONConfig": {
+            "description": "Test content of an Activity against the MHS toxicity model for reddit content\n\nRunning this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.\n\nMore info:\n\n* https://moderatehatespeech.com/docs/\n* https://moderatehatespeech.com/",
+            "properties": {
+                "authorIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/AuthorCriteria"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<AuthorCriteria>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<AuthorCriteria>"
+                        }
+                    ],
+                    "description": "If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail."
+                },
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "historical": {
+                    "$ref": "#/definitions/HistoricalMHSConfig",
+                    "description": "run MHS on Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value"
+                },
+                "itemIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/SubmissionState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/CommentState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<TypedActivityState>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<TypedActivityState>"
+                        }
+                    ],
+                    "description": "A list of criteria to test the state of the `Activity` against before running the check.\n\nIf any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.\n\n* @examples [[{\"over_18\": true, \"removed': false}]]"
+                },
+                "kind": {
+                    "default": "mhs",
+                    "description": "The kind of rule to run",
+                    "enum": [
+                        "mhs"
+                    ],
+                    "examples": [
+                        "mhs"
+                    ],
+                    "type": "string"
+                },
+                "name": {
+                    "description": "An optional, but highly recommended, friendly name for this rule. If not present will default to `kind`.\n\nCan only contain letters, numbers, underscore, spaces, and dashes\n\nname is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.",
+                    "examples": [
+                        "myNewRule"
+                    ],
+                    "pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "kind"
+            ],
+            "type": "object"
+        },
         "ModLogCriteria": {
             "properties": {
                 "action": {
@@ -3242,6 +3442,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },

src/Schema/RuleSet.json

@@ -28,6 +28,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -732,6 +746,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -1285,6 +1313,55 @@
             },
             "type": "object"
         },
+        "HistoricalMHSConfig": {
+            "description": "Test the content of Activities from the Author history against MHS criteria\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value",
+            "properties": {
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "mustMatchCurrent": {
+                    "default": false,
+                    "description": "When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history",
+                    "type": "boolean"
+                },
+                "totalMatching": {
+                    "default": "> 0",
+                    "description": "A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 12`  => greater than 12 activities passed given `criteria` test\n* EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test",
+                    "examples": [
+                        "> 0",
+                        "> 10%"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "window": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/DurationObject"
+                        },
+                        {
+                            "$ref": "#/definitions/FullActivityWindowConfig"
+                        },
+                        {
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        }
+                    ],
+                    "description": "A value to define the range of Activities to retrieve.\n\nAcceptable values:\n\n**`ActivityWindowCriteria` object**\n\nAllows specify multiple range properties and more specific behavior\n\n**A `number` of Activities to retrieve**\n\n* EX `100` => 100 Activities\n\n*****\n\nAny of the below values that specify the amount of time to subtract from `NOW` to create a time range IE `NOW <---> [duration] ago`\n\nAcceptable values:\n\n**A `string` consisting of a value and a [Day.js](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) time UNIT**\n\n* EX `9 days` => Range is `NOW <---> 9 days ago`\n\n**A [Day.js](https://day.js.org/docs/en/durations/creating) `object`**\n\n* EX `{\"days\": 90, \"minutes\": 15}` => Range is `NOW <---> 90 days and 15 minutes ago`\n\n**An [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) `string`**\n\n* EX `PT15M` => 15 minutes => Range is `NOW <----> 15 minutes ago`",
+                    "examples": [
+                        "90 days"
+                    ]
+                }
+            },
+            "required": [
+                "totalMatching",
+                "window"
+            ],
+            "type": "object"
+        },
         "HistoricalSentimentConfig": {
             "description": "Test the Sentiment of Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `sentiment` is defined here it overrides the top-level `sentiment` value",
             "properties": {
@@ -1662,6 +1739,126 @@
             ],
             "type": "object"
         },
+        "MHSCriteriaConfig": {
+            "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`",
+            "properties": {
+                "confidence": {
+                    "description": "A string containing a comparison operator and a value to compare against the confidence returned from MHS\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 50`  => MHS confidence is greater than 50%",
+                    "examples": [
+                        "> 50"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "flagged": {
+                    "default": true,
+                    "description": "Test if MHS considers content flagged as toxic or not",
+                    "type": "boolean"
+                },
+                "testOn": {
+                    "default": [
+                        "body"
+                    ],
+                    "description": "Which content from an Activity to send to MHS\n\nOnly used if the Activity being tested is a Submission -- Comments can be only tested against their body\n\nIf more than one type of content is specified then all text is tested together as one string",
+                    "items": {
+                        "enum": [
+                            "body",
+                            "title"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "MHSRuleJSONConfig": {
+            "description": "Test content of an Activity against the MHS toxicity model for reddit content\n\nRunning this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.\n\nMore info:\n\n* https://moderatehatespeech.com/docs/\n* https://moderatehatespeech.com/",
+            "properties": {
+                "authorIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/AuthorCriteria"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<AuthorCriteria>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<AuthorCriteria>"
+                        }
+                    ],
+                    "description": "If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail."
+                },
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "historical": {
+                    "$ref": "#/definitions/HistoricalMHSConfig",
+                    "description": "run MHS on Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value"
+                },
+                "itemIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/SubmissionState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/CommentState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<TypedActivityState>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<TypedActivityState>"
+                        }
+                    ],
+                    "description": "A list of criteria to test the state of the `Activity` against before running the check.\n\nIf any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.\n\n* @examples [[{\"over_18\": true, \"removed': false}]]"
+                },
+                "kind": {
+                    "default": "mhs",
+                    "description": "The kind of rule to run",
+                    "enum": [
+                        "mhs"
+                    ],
+                    "examples": [
+                        "mhs"
+                    ],
+                    "type": "string"
+                },
+                "name": {
+                    "description": "An optional, but highly recommended, friendly name for this rule. If not present will default to `kind`.\n\nCan only contain letters, numbers, underscore, spaces, and dashes\n\nname is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.",
+                    "examples": [
+                        "myNewRule"
+                    ],
+                    "pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "kind"
+            ],
+            "type": "object"
+        },
         "ModLogCriteria": {
             "properties": {
                 "action": {
@@ -3210,6 +3407,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -3510,6 +3721,9 @@
                     {
                         "$ref": "#/definitions/SentimentRuleJSONConfig"
                     },
+                    {
+                        "$ref": "#/definitions/MHSRuleJSONConfig"
+                    },
                     {
                         "type": "string"
                     }

src/Schema/Run.json

@@ -39,6 +39,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -1456,6 +1470,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -1507,6 +1524,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },
@@ -2535,6 +2566,55 @@
             },
             "type": "object"
         },
+        "HistoricalMHSConfig": {
+            "description": "Test the content of Activities from the Author history against MHS criteria\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value",
+            "properties": {
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "mustMatchCurrent": {
+                    "default": false,
+                    "description": "When `true` the original Activity being checked MUST pass its criteria before the Rule considers any history",
+                    "type": "boolean"
+                },
+                "totalMatching": {
+                    "default": "> 0",
+                    "description": "A string containing a comparison operator and a value to compare Activities from history that pass the given `criteria` test\n\nThe syntax is `(< OR > OR <= OR >=) <number>[percent sign]`\n\n* EX `> 12`  => greater than 12 activities passed given `criteria` test\n* EX `<= 10%` => less than 10% of all Activities from history passed given `criteria` test",
+                    "examples": [
+                        "> 0",
+                        "> 10%"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "window": {
+                    "anyOf": [
+                        {
+                            "$ref": "#/definitions/DurationObject"
+                        },
+                        {
+                            "$ref": "#/definitions/FullActivityWindowConfig"
+                        },
+                        {
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        }
+                    ],
+                    "description": "A value to define the range of Activities to retrieve.\n\nAcceptable values:\n\n**`ActivityWindowCriteria` object**\n\nAllows specify multiple range properties and more specific behavior\n\n**A `number` of Activities to retrieve**\n\n* EX `100` => 100 Activities\n\n*****\n\nAny of the below values that specify the amount of time to subtract from `NOW` to create a time range IE `NOW <---> [duration] ago`\n\nAcceptable values:\n\n**A `string` consisting of a value and a [Day.js](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) time UNIT**\n\n* EX `9 days` => Range is `NOW <---> 9 days ago`\n\n**A [Day.js](https://day.js.org/docs/en/durations/creating) `object`**\n\n* EX `{\"days\": 90, \"minutes\": 15}` => Range is `NOW <---> 90 days and 15 minutes ago`\n\n**An [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) `string`**\n\n* EX `PT15M` => 15 minutes => Range is `NOW <----> 15 minutes ago`",
+                    "examples": [
+                        "90 days"
+                    ]
+                }
+            },
+            "required": [
+                "totalMatching",
+                "window"
+            ],
+            "type": "object"
+        },
         "HistoricalSentimentConfig": {
             "description": "Test the Sentiment of Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `sentiment` is defined here it overrides the top-level `sentiment` value",
             "properties": {
@@ -3004,6 +3084,126 @@
             ],
             "type": "object"
         },
+        "MHSCriteriaConfig": {
+            "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`",
+            "properties": {
+                "confidence": {
+                    "description": "A string containing a comparison operator and a value to compare against the confidence returned from MHS\n\nThe syntax is `(< OR > OR <= OR >=) <number>`\n\n* EX `> 50`  => MHS confidence is greater than 50%",
+                    "examples": [
+                        "> 50"
+                    ],
+                    "pattern": "^\\s*(>|>=|<|<=)\\s*(\\d+)\\s*(%?)(.*)$",
+                    "type": "string"
+                },
+                "flagged": {
+                    "default": true,
+                    "description": "Test if MHS considers content flagged as toxic or not",
+                    "type": "boolean"
+                },
+                "testOn": {
+                    "default": [
+                        "body"
+                    ],
+                    "description": "Which content from an Activity to send to MHS\n\nOnly used if the Activity being tested is a Submission -- Comments can be only tested against their body\n\nIf more than one type of content is specified then all text is tested together as one string",
+                    "items": {
+                        "enum": [
+                            "body",
+                            "title"
+                        ],
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "MHSRuleJSONConfig": {
+            "description": "Test content of an Activity against the MHS toxicity model for reddit content\n\nRunning this Rule with no configuration will use a default configuration that will cause the Rule to trigger if MHS flags the content of the Activity as toxic.\n\nMore info:\n\n* https://moderatehatespeech.com/docs/\n* https://moderatehatespeech.com/",
+            "properties": {
+                "authorIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/AuthorCriteria"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<AuthorCriteria>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<AuthorCriteria>"
+                        }
+                    ],
+                    "description": "If present then these Author criteria are checked before running the Check. If criteria fails then the Check will fail."
+                },
+                "criteria": {
+                    "$ref": "#/definitions/MHSCriteriaConfig",
+                    "description": "Criteria used to trigger based on MHS results\n\nIf both `flagged` and `confidence` are specified then both conditions must pass.\n\nBy default, only `flagged` is defined as `true`"
+                },
+                "historical": {
+                    "$ref": "#/definitions/HistoricalMHSConfig",
+                    "description": "run MHS on Activities from the Author history\n\nIf this is defined then the `totalMatching` threshold must pass for the Rule to trigger\n\nIf `criteria` is defined here it overrides the top-level `criteria` value"
+                },
+                "itemIs": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "#/definitions/SubmissionState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/CommentState"
+                                    },
+                                    {
+                                        "$ref": "#/definitions/NamedCriteria<TypedActivityState>"
+                                    },
+                                    {
+                                        "type": "string"
+                                    }
+                                ]
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "$ref": "#/definitions/FilterOptionsJson<TypedActivityState>"
+                        }
+                    ],
+                    "description": "A list of criteria to test the state of the `Activity` against before running the check.\n\nIf any set of criteria passes the Check will be run. If the criteria fails then the Check will fail.\n\n* @examples [[{\"over_18\": true, \"removed': false}]]"
+                },
+                "kind": {
+                    "default": "mhs",
+                    "description": "The kind of rule to run",
+                    "enum": [
+                        "mhs"
+                    ],
+                    "examples": [
+                        "mhs"
+                    ],
+                    "type": "string"
+                },
+                "name": {
+                    "description": "An optional, but highly recommended, friendly name for this rule. If not present will default to `kind`.\n\nCan only contain letters, numbers, underscore, spaces, and dashes\n\nname is used to reference Rule result data during Action content templating. See CommentAction or ReportAction for more details.",
+                    "examples": [
+                        "myNewRule"
+                    ],
+                    "pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "kind"
+            ],
+            "type": "object"
+        },
         "MessageActionJson": {
             "description": "Send a private message to the Author of the Activity.",
             "properties": {
@@ -4809,6 +5009,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "type": "string"
                             }
@@ -5602,6 +5805,9 @@
                             {
                                 "$ref": "#/definitions/SentimentRuleJSONConfig"
                             },
+                            {
+                                "$ref": "#/definitions/MHSRuleJSONConfig"
+                            },
                             {
                                 "$ref": "#/definitions/RuleSetConfigData"
                             },
@@ -5653,6 +5859,20 @@
                     ],
                     "description": "* true/false => test whether Activity is approved or not\n* string or list of strings => test which moderator approved this Activity"
                 },
+                "createdOn": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        }
+                    ],
+                    "description": "A relative datetime description to match the date the Activity was created\n\nMay be either:\n\n* day of the week (monday, tuesday, etc...)\n* cron expression IE `* * 15 *`\n\nSee https://crontab.guru/ for generating expressions\n\nhttps://regexr.com/6u3cc"
+                },
                 "deleted": {
                     "type": "boolean"
                 },

src/Subreddit/Manager.ts

@@ -9,8 +9,15 @@ import {
     createRetryHandler,
     determineNewResults,
     findLastIndex,
-    formatNumber, frequencyEqualOrLargerThanMin, getActivityAuthorName, isComment, isSubmission, likelyJson5,
-    mergeArr, normalizeName,
+    formatNumber,
+    frequencyEqualOrLargerThanMin,
+    generateFullWikiUrl,
+    getActivityAuthorName,
+    isComment,
+    isSubmission,
+    likelyJson5,
+    mergeArr,
+    normalizeName,
     parseRedditEntity,
     pollingInfo,
     resultsSummary,
@@ -67,7 +74,7 @@ import {
     isRateLimitError,
     isSeriousError,
     isStatusError,
-    RunProcessingError
+    RunProcessingError, SimpleError
 } from "../Utils/Errors";
 import {ErrorWithCause, stackWithCauses} from "pony-cause";
 import {Run} from "../Run";
@@ -87,8 +94,7 @@ import {InvokeeType} from "../Common/Entities/InvokeeType";
 import {RunStateType} from "../Common/Entities/RunStateType";
 import {EntityRunState} from "../Common/Entities/EntityRunState/EntityRunState";
 import {
-    ActivitySource,
-    DispatchSource,
+    ActivitySourceValue,
     EventRetentionPolicyRange,
     Invokee,
     PollOn,
@@ -121,7 +127,7 @@ export interface runCheckOptions {
     force?: boolean,
     gotoContext?: string
     maxGotoDepth?: number
-    source: ActivitySource
+    source: ActivitySourceValue
     initialGoto?: string
     activitySource: ActivitySourceData
     disableDispatchDelays?: boolean
@@ -595,6 +601,34 @@ export class Manager extends EventEmitter implements RunningStates {
         return this.runs.map(x => x.commentChecks);
     }
 
+    async setResourceManager(config: Partial<SubredditResourceConfig> = {}) {
+        const {
+            footer,
+            logger = this.logger,
+            subreddit = this.subreddit,
+            caching,
+            credentials,
+            client = this.client,
+            botEntity = this.botEntity,
+            managerEntity = this.managerEntity,
+            statFrequency = this.statDefaults.minFrequency,
+            retention = this.retentionOverride,
+        } = config;
+
+        this.resources = await this.cacheManager.set(this.subreddit.display_name, {
+            footer: footer === undefined && this.resources !== undefined ? this.resources.footer : footer,
+            logger,
+            subreddit,
+            caching,
+            credentials,
+            client,
+            botEntity,
+            managerEntity,
+            statFrequency,
+            retention,
+        });
+    }
+
     protected async parseConfigurationFromObject(configObj: object, suppressChangeEvent: boolean = false) {
         try {
             const configBuilder = new ConfigBuilder({logger: this.logger});
@@ -620,7 +654,7 @@ export class Manager extends EventEmitter implements RunningStates {
 
             this.displayLabel = nickname || `${this.subreddit.display_name_prefixed}`;
 
-            if (footer !== undefined) {
+            if (footer !== undefined && this.resources !== undefined) {
                 this.resources.footer = footer;
             }
 
@@ -660,7 +694,7 @@ export class Manager extends EventEmitter implements RunningStates {
                 statFrequency: realStatFrequency,
                 retention: this.retentionOverride ?? retention
             };
-            this.resources = await this.cacheManager.set(this.subreddit.display_name, resourceConfig);
+            await this.setResourceManager(resourceConfig);
             this.resources.setLogger(this.logger);
 
             this.logger.info('Subreddit-specific options updated');
@@ -780,39 +814,17 @@ export class Manager extends EventEmitter implements RunningStates {
             try {
                 try {
                     // @ts-ignore
-                    wiki = await this.subreddit.getWikiPage(this.wikiLocation).fetch();
+                    wiki = await this.getWikiPage();
                 } catch (err: any) {
-                    if(isStatusError(err) && err.statusCode === 404) {
-                        // see if we can create the page
-                        if (!this.client.scope.includes('wikiedit')) {
-                            throw new ErrorWithCause(`Page does not exist and could not be created because Bot does not have oauth permission 'wikiedit'`, {cause: err});
+                    if(err.cause !== undefined && isStatusError(err.cause) && err.cause.statusCode === 404) {
+                        // try to create it
+                        try {
+                            wiki = await this.writeConfig('', 'Empty configuration created for ContextMod');
+                        } catch (e: any) {
+                            throw new CMError(`Parsing config from wiki page failed because ${err.message} AND creating empty page failed`, {cause: e});
                         }
-                        const modPermissions = await this.getModPermissions();
-                        if (!modPermissions.includes('all') && !modPermissions.includes('wiki')) {
-                            throw new ErrorWithCause(`Page does not exist and could not be created because Bot not have mod permissions for creating wiki pages. Must have 'all' or 'wiki'`, {cause: err});
-                        }
-                        if(!this.client.scope.includes('modwiki')) {
-                            throw new ErrorWithCause(`Bot COULD create wiki config page but WILL NOT because it does not have the oauth permissions 'modwiki' which is required to set page visibility and editing permissions. Safety first!`, {cause: err});
-                        }
-                        // @ts-ignore
-                        wiki = await this.subreddit.getWikiPage(this.wikiLocation).edit({
-                            text: '',
-                            reason: 'Empty configuration created for ContextMod'
-                        });
-                        this.logger.info(`Wiki page at ${this.wikiLocation} did not exist so bot created it!`);
-
-                        // 0 = use subreddit wiki permissions
-                        // 1 = only approved wiki contributors
-                        // 2 = only mods may edit and view
-                        // @ts-ignore
-                        await this.subreddit.getWikiPage(this.wikiLocation).editSettings({
-                            permissionLevel: 2,
-                            // don't list this page on r/[subreddit]/wiki/pages
-                            listed: false,
-                        });
-                        this.logger.info('Bot set wiki page visibility to MODS ONLY');
                     } else {
-                        throw err;
+                        throw new CMError('Reading config from wiki failed', {cause: err});
                     }
                 }
                 const revisionDate = dayjs.unix(wiki.revision_date);
@@ -841,12 +853,7 @@ export class Manager extends EventEmitter implements RunningStates {
                 this.lastWikiRevision = revisionDate;
                 sourceData = await wiki.content_md;
             } catch (err: any) {
-                let hint = '';
-                if(isStatusError(err) && err.statusCode === 403) {
-                    hint = ` -- HINT: Either the page is restricted to mods only and the bot's reddit account does have the mod permission 'all' or 'wiki' OR the bot does not have the 'wikiread' oauth permission`;
-                }
-                const msg = `Could not read wiki configuration. Please ensure the page https://reddit.com${this.subreddit.url}wiki/${this.wikiLocation} exists and is readable${hint}`;
-                throw new ErrorWithCause(msg, {cause: err});
+                throw err;
             }
 
             if (sourceData.replace('\r\n', '').trim() === '') {
@@ -880,12 +887,13 @@ export class Manager extends EventEmitter implements RunningStates {
 
             return true;
         } catch (err: any) {
-            const error = new ErrorWithCause('Failed to parse subreddit configuration', {cause: err});
-            // @ts-ignore
-           //error.logged = true;
-            this.logger.error(error);
+            if(this.resources === undefined) {
+                // if we fail to get a valid config and there is no existing resource then just create a default one
+                // -- also ensures that if one already exists we don't overwrite it
+                await this.setResourceManager()
+            }
             this.validConfigLoaded = false;
-            throw error;
+            throw new ErrorWithCause('Failed to parse subreddit configuration', {cause: err});
         }
     }
 
@@ -1799,6 +1807,104 @@ export class Manager extends EventEmitter implements RunningStates {
         }
     }
 
+    async setWikiPermissions(location: string = this.wikiLocation) {
+        if(!this.client.scope.includes('modwiki')) {
+            throw new SimpleError(`Cannot check or set permissions for wiki because bot does not have the 'modwiki' oauth permission`);
+        }
+
+        const settings = await this.subreddit.getWikiPage(location).getSettings();
+        const reasons = [];
+        if(settings.listed) {
+            reasons.push(`Page is listed (visible from r/${this.subreddit.display_name}/wiki/pages) but should be delisted.`)
+        }
+        // 0 = use subreddit wiki permissions
+        // 1 = only approved wiki contributors
+        // 2 = only mods may edit and view
+        if(settings.permissionLevel === 0) {
+            reasons.push(`Page editing level is set to 'inherit from general wiki settings' but should be set to contributors/mods only`);
+        }
+        if (reasons.length > 0) {
+            this.logger.debug(`Updating wiki page permissions because: ${reasons.join(' | ')}`)
+            // @ts-ignore
+            await this.subreddit.getWikiPage(location).editSettings({
+                permissionLevel: 2,
+                // don't list this page on r/[subreddit]/wiki/pages
+                listed: false,
+            });
+            this.logger.info('Bot set wiki page visibility to MODS ONLY and delisted the page');
+        }
+    }
+
+    async writeConfig(data: string, reason?: string, location: string = this.wikiLocation) {
+
+        const oauthErrors = [];
+        if (!this.client.scope.includes('wikiedit')) {
+            oauthErrors.push(`missing oauth permission 'wikiedit' is required to edit wiki pages`);
+        }
+        if (!this.client.scope.includes('modwiki')) {
+            oauthErrors.push(`missing oauth permission 'modwiki' which is required to set page visibility and editing permissions.`);
+        }
+
+        if(oauthErrors.length > 0) {
+            throw new SimpleError(`Cannot edit wiki page ${generateFullWikiUrl(this.subreddit, location)} because: ${oauthErrors.join(' | ')}`);
+        }
+
+        try {
+            // @ts-ignore
+            const wiki = await this.subreddit.getWikiPage(location).edit({
+                text: data,
+                reason: reason,
+            });
+            this.logger.debug(`Wrote config to ${location}`);
+            try {
+                await this.setWikiPermissions(location);
+            } catch (e: any) {
+                if (e.message.includes('modwiki')) {
+                    this.logger.warn(e);
+                } else {
+                    throw new CMError(`Successfully edited wiki page ${generateFullWikiUrl(this.subreddit, location)} but an error occurred while checking/setting page permissions`, {cause: e});
+                }
+            }
+            return wiki;
+        } catch (err: any) {
+            if (isStatusError(err)) {
+                const modPermissions = await this.getModPermissions();
+                if (!modPermissions.includes('all') && !modPermissions.includes('wiki')) {
+                    throw new ErrorWithCause(`Could not create wiki page ${generateFullWikiUrl(this.subreddit, location)} because Bot not have mod permissions for creating wiki pages. Must have 'all' or 'wiki'`, {cause: err});
+                }
+            } else {
+                throw err;
+            }
+        }
+    }
+
+    // @ts-ignore
+    async getWikiPage(location: string = this.wikiLocation) {
+        let wiki: WikiPage;
+        try {
+            // @ts-ignore
+            wiki = await this.subreddit.getWikiPage(location).fetch();
+        } catch (err: any) {
+            if (isStatusError(err)) {
+                const error = err.statusCode === 404 ? 'does not exist' : 'is not accessible';
+                let reasons = [];
+                if (!this.client.scope.includes('wikiread')) {
+                    reasons.push(`Bot does not have 'wikiread' oauth permission`);
+                } else {
+                    const modPermissions = await this.getModPermissions();
+                    if (!modPermissions.includes('all') && !modPermissions.includes('wiki')) {
+                        reasons.push(`Bot does not have required mod permissions ('all'  or 'wiki') to read restricted wiki pages`);
+                    }
+                }
+
+                throw new CMError(`Wiki page ${generateFullWikiUrl(this.subreddit, location)} ${error} (${err.statusCode})${reasons.length > 0 ? ` because: ${reasons.join(' | ')}` : '.'}`, {cause: err});
+            } else {
+                throw new CMError(`Wiki page ${generateFullWikiUrl(this.subreddit, location)} could not be read`, {cause: err});
+            }
+        }
+        return wiki;
+    }
+
     toNormalizedManager(): NormalizedManagerResponse {
         return {
             name: this.displayLabel,

src/Subreddit/SubredditResources.ts

@@ -41,7 +41,6 @@ import {
     redisScanIterator,
     removeUndefinedKeys,
     shouldCacheSubredditStateCriteriaResult,
-    strToActivitySource,
     subredditStateIsNameOnly,
     testMaybeStringRegex,
     toStrongSubredditState,
@@ -58,7 +57,7 @@ import {
     filterByTimeRequirement,
     asSubreddit,
     modActionCriteriaSummary,
-    parseRedditFullname, asStrongImageHashCache
+    parseRedditFullname, asStrongImageHashCache, matchesRelativeDateTime
 } from "../util";
 import LoggedError from "../Utils/LoggedError";
 import {
@@ -119,12 +118,12 @@ import {
     UserNoteCriteria
 } from "../Common/Infrastructure/Filters/FilterCriteria";
 import {
-    ActivitySource, ConfigFragmentValidationFunc, DurationVal,
+    ActivitySourceValue, ConfigFragmentValidationFunc, DurationVal,
     EventRetentionPolicyRange, ImageHashCacheData,
     JoinOperands,
     ModActionType,
-    ModeratorNameCriteria, ModUserNoteLabel, statFrequencies, StatisticFrequency,
-    StatisticFrequencyOption
+    ModeratorNameCriteria, ModUserNoteLabel, RelativeDateTimeMatch, statFrequencies, StatisticFrequency,
+    StatisticFrequencyOption, WikiContext
 } from "../Common/Infrastructure/Atomic";
 import {
     AuthorOptions, FilterCriteriaPropertyResult,
@@ -162,8 +161,9 @@ import {parseFromJsonOrYamlToObject} from "../Common/Config/ConfigUtil";
 import ConfigParseError from "../Utils/ConfigParseError";
 import {ActivityReport} from "../Common/Entities/ActivityReport";
 import {ActionResultEntity} from "../Common/Entities/ActionResultEntity";
+import {ActivitySource} from "../Common/ActivitySource";
 
-export const DEFAULT_FOOTER = '\r\n*****\r\nThis action was performed by [a bot.]({{botLink}}) Mention a moderator or [send a modmail]({{modmailLink}}) if you any ideas, questions, or concerns about this action.';
+export const DEFAULT_FOOTER = '\r\n*****\r\nThis action was performed by [a bot.]({{botLink}}) Mention a moderator or [send a modmail]({{modmailLink}}) if you have any ideas, questions, or concerns about this action.';
 
 /**
  * Only used for migrating stats from cache to db
@@ -223,7 +223,7 @@ export class SubredditResources {
     protected useSubredditAuthorCache!: boolean;
     protected authorTTL: number | false = cacheTTLDefaults.authorTTL;
     protected subredditTTL: number | false = cacheTTLDefaults.subredditTTL;
-    protected wikiTTL: number | false = cacheTTLDefaults.wikiTTL;
+    public wikiTTL: number | false = cacheTTLDefaults.wikiTTL;
     protected submissionTTL: number | false = cacheTTLDefaults.submissionTTL;
     protected commentTTL: number | false = cacheTTLDefaults.commentTTL;
     protected filterCriteriaTTL: number | false = cacheTTLDefaults.filterCriteriaTTL;
@@ -1141,6 +1141,18 @@ export class SubredditResources {
         return mods;
     }
 
+    async getSubredditModeratorPermissions(rawUserVal: RedditUser | string, rawSubredditVal?: Subreddit | string): Promise<string[]> {
+        const mods = await this.getSubredditModerators(rawSubredditVal);
+        const user = rawUserVal instanceof RedditUser ? rawUserVal.name : rawUserVal;
+
+        const mod = mods.find(x => x.name.toLowerCase() === user.toLowerCase());
+        if(mod === undefined) {
+            return [];
+        }
+        // @ts-ignore
+        return mod.mod_permissions as string[];
+    }
+
     async getSubredditContributors(): Promise<RedditUser[]> {
         const subName = this.subreddit.display_name;
         const hash = `sub-${subName}-contributors`;
@@ -1685,21 +1697,31 @@ export class SubredditResources {
         return filteredListing;
     }
 
-    async getExternalResource(val: string, subredditArg?: Subreddit): Promise<{val: string, fromCache: boolean, response?: Response, hash?: string}> {
-        const subreddit = subredditArg || this.subreddit;
-        let cacheKey;
-        const wikiContext = parseWikiContext(val);
-        if (wikiContext !== undefined) {
-            cacheKey = `${subreddit.display_name}-content-${wikiContext.wiki}${wikiContext.subreddit !== undefined ? `|${wikiContext.subreddit}` : ''}`;
-        }
-        const extUrl = wikiContext === undefined ? parseExternalUrl(val) : undefined;
-        if (extUrl !== undefined) {
-            cacheKey = extUrl;
+    async getExternalResource(val: string, subredditArg?: Subreddit, defaultTo: 'url' | 'wiki' | undefined = undefined): Promise<{ val: string, fromCache: boolean, response?: Response, hash?: string }> {
+        let wikiContext = parseWikiContext(val);
+
+        let extUrl = wikiContext === undefined ? parseExternalUrl(val) : undefined;
+
+        if (extUrl === undefined && wikiContext === undefined) {
+            if (defaultTo === 'url') {
+                extUrl = val;
+            } else if (defaultTo === 'wiki') {
+                wikiContext = {wiki: val};
+            }
         }
 
-        if (cacheKey === undefined) {
-            return {val, fromCache: false, hash: cacheKey};
+        if (wikiContext !== undefined) {
+            return await this.getWikiPage(wikiContext, subredditArg !== undefined ? subredditArg.display_name : undefined);
         }
+        if (extUrl !== undefined) {
+            return await this.getCachedUrlResult(extUrl);
+        }
+
+        return {val, fromCache: false};
+    }
+
+    async getCachedUrlResult(extUrl: string): Promise<{ val: string, fromCache: boolean, response?: Response, hash?: string }> {
+        const cacheKey = extUrl;
 
         // try to get cached value first
         if (this.wikiTTL !== false) {
@@ -1715,46 +1737,60 @@ export class SubredditResources {
             }
         }
 
-        let wikiContent: string;
-        let response: Response | undefined;
+        try {
+            const [wikiContentVal, responseVal] = await fetchExternalResult(extUrl as string, this.logger);
+            return {val: wikiContentVal, fromCache: false, response: responseVal, hash: cacheKey};
+        } catch (err: any) {
+            throw new CMError(`Error occurred while trying to fetch the url ${extUrl}`, {cause: err});
+        }
+    }
 
-        // no cache hit, get from source
-        if (wikiContext !== undefined) {
-            let sub;
-            if (wikiContext.subreddit === undefined || wikiContext.subreddit.toLowerCase() === subreddit.display_name) {
-                sub = subreddit;
+    async getWikiPage(data: WikiContext, subredditArg?: string): Promise<{ val: string, fromCache: boolean, response?: Response, hash?: string }> {
+        const {
+            subreddit = subredditArg ?? this.subreddit.display_name,
+            wiki
+        } = data;
+
+        const cacheKey = `${subreddit}-content-${wiki}${data.subreddit !== undefined ? `|${data.subreddit}` : ''}`;
+
+        if (this.wikiTTL !== false) {
+            await this.stats.cache.content.identifierRequestCount.set(cacheKey, (await this.stats.cache.content.identifierRequestCount.wrap(cacheKey, () => 0) as number) + 1);
+            this.stats.cache.content.requestTimestamps.push(Date.now());
+            this.stats.cache.content.requests++;
+            const cachedContent = await this.cache.get(cacheKey);
+            if (cachedContent !== undefined && cachedContent !== null) {
+                this.logger.debug(`Content Cache Hit: ${cacheKey}`);
+                return {val: cachedContent as string, fromCache: true, hash: cacheKey};
             } else {
-                sub = this.client.getSubreddit(wikiContext.subreddit);
-            }
-            try {
-                // @ts-ignore
-                const wikiPage = sub.getWikiPage(wikiContext.wiki);
-                wikiContent = await wikiPage.content_md;
-            } catch (err: any) {
-                let msg = `Could not read wiki page for an unknown reason. Please ensure the page 'https://reddit.com${sub.display_name_prefixed}/wiki/${wikiContext.wiki}' exists and is readable`;
-                if(err.statusCode !== undefined) {
-                    if(err.statusCode === 404) {
-                        msg = `Could not find a wiki page at https://reddit.com${sub.display_name_prefixed}/wiki/${wikiContext.wiki} -- Reddit returned a 404`;
-                    } else if(err.statusCode === 403 || err.statusCode === 401) {
-                        msg = `Bot either does not have permission visibility permissions for the wiki page at https://reddit.com${sub.display_name_prefixed}wiki/${wikiContext.wiki} (due to subreddit restrictions) or the bot does have have oauth permissions to read wiki pages (operator error). Reddit returned a ${err.statusCode}`;
-                    }
-                }
-                this.logger.error(msg, err);
-                throw new LoggedError(msg);
-            }
-        } else {
-            try {
-                const [wikiContentVal, responseVal] = await fetchExternalResult(extUrl as string, this.logger);
-                wikiContent = wikiContentVal;
-                response = responseVal;
-            } catch (err: any) {
-                const msg = `Error occurred while trying to fetch the url ${extUrl}`;
-                this.logger.error(msg, err);
-                throw new LoggedError(msg);
+                this.stats.cache.content.miss++;
             }
         }
 
-        return {val: wikiContent, fromCache: false, response, hash: cacheKey};
+        let sub = this.client.getSubreddit(subreddit);
+
+        try {
+            // @ts-ignore
+            const wikiPage = sub.getWikiPage(wikiContext.wiki);
+            const wikiContent = await wikiPage.content_md;
+            return {val: wikiContent, fromCache: false, hash: cacheKey};
+        } catch (err: any) {
+            if (isStatusError(err)) {
+                const error = err.statusCode === 404 ? 'does not exist' : 'is not accessible';
+                let reasons = [];
+                if (!this.client.scope.includes('wikiread')) {
+                    reasons.push(`Bot does not have 'wikiread' oauth permission`);
+                } else {
+                    const modPermissions = await this.getSubredditModeratorPermissions(this.botName, subreddit);
+                    if (!modPermissions.includes('all') && !modPermissions.includes('wiki')) {
+                        reasons.push(`Bot does not have required mod permissions ('all'  or 'wiki') to read restricted wiki pages`);
+                    }
+                }
+
+                throw new CMError(`Wiki page ${location} ${error} (${err.statusCode})${reasons.length > 0 ? `because: ${reasons.join(' | ')}` : '.'}`, {cause: err});
+            } else {
+                throw new CMError(`Wiki page ${location} could not be read`, {cause: err});
+            }
+        }
     }
 
     async getContent(val: string, subredditArg?: Subreddit): Promise<string> {
@@ -1909,6 +1945,11 @@ export class SubredditResources {
             includeIdentifier = false,
         } = options || {};
 
+        // return early if there are no states to filter by!
+        if(states.length === 0) {
+            return items;
+        }
+
         let passedItems: (Comment | Submission)[] = [];
         let unpassedItems: (Comment | Submission)[] = [];
 
@@ -2049,7 +2090,7 @@ export class SubredditResources {
         return res;
     }
 
-    async testItemCriteria(i: (Comment | Submission), activityStateObj: NamedCriteria<TypedActivityState>, logger: Logger, include = true, source?: ActivitySource): Promise<FilterCriteriaResult<TypedActivityState>> {
+    async testItemCriteria(i: (Comment | Submission), activityStateObj: NamedCriteria<TypedActivityState>, logger: Logger, include = true, source?: ActivitySourceValue): Promise<FilterCriteriaResult<TypedActivityState>> {
         const {criteria: activityState} = activityStateObj;
         if(Object.keys(activityState).length === 0) {
             return {
@@ -2213,7 +2254,7 @@ export class SubredditResources {
         })() as boolean;
     }
 
-    async isItem (item: Submission | Comment, stateCriteria: TypedActivityState, logger: Logger, include: boolean, source?: ActivitySource): Promise<FilterCriteriaResult<(SubmissionState & CommentState)>> {
+    async isItem (item: Submission | Comment, stateCriteria: TypedActivityState, logger: Logger, include: boolean, source?: ActivitySourceValue): Promise<FilterCriteriaResult<(SubmissionState & CommentState)>> {
 
         //const definedStateCriteria = (removeUndefinedKeys(stateCriteria) as RequiredItemCrit);
 
@@ -2304,10 +2345,12 @@ export class SubredditResources {
                         } else {
                             propResultsMap.source!.found = source;
 
-                            const requestedSourcesVal: string[] = !Array.isArray(itemOptVal) ? [itemOptVal] as string[] : itemOptVal as string[];
-                            const requestedSources = requestedSourcesVal.map(x => strToActivitySource(x).toLowerCase());
+                            const itemSource = new ActivitySource(source);
 
-                            propResultsMap.source!.passed = criteriaPassWithIncludeBehavior(requestedSources.some(x => source.toLowerCase().trim() === x.toLowerCase().trim()), include);
+                            const requestedSourcesVal: string[] = !Array.isArray(itemOptVal) ? [itemOptVal] as string[] : itemOptVal as string[];
+                            const requestedSources = requestedSourcesVal.map(x => new ActivitySource(x));
+
+                            propResultsMap.source!.passed = criteriaPassWithIncludeBehavior(requestedSources.some(x => x.matches(itemSource)), include);
                             break;
                         }
                     case 'score':
@@ -2443,6 +2486,23 @@ export class SubredditResources {
                         propResultsMap.age!.passed = criteriaPassWithIncludeBehavior(ageTest, include);
                         propResultsMap.age!.found = created.format('MMMM D, YYYY h:mm A Z');
                         break;
+                    case 'createdOn':
+                        const createdAt = dayjs.unix(await item.created);
+                        propResultsMap.createdOn!.found = createdAt.format('MMMM D, YYYY h:mm A Z');
+                        propResultsMap.createdOn!.passed = false;
+
+                        const expressions = Array.isArray(itemOptVal) ? itemOptVal as RelativeDateTimeMatch[] : [itemOptVal] as RelativeDateTimeMatch[];
+                        try {
+                            for (const expr of expressions) {
+                                if (matchesRelativeDateTime(expr, createdAt)) {
+                                    propResultsMap.createdOn!.passed = true;
+                                    break;
+                                }
+                            }
+                        } catch(err: any) {
+                            propResultsMap.createdOn!.reason = err.message;
+                        }
+                        break;
                     case 'title':
                         if(asComment(item)) {
                             const titleWarn ='`title` is not allowed in `itemIs` criteria when the main Activity is a Comment';
@@ -3728,7 +3788,7 @@ export const checkAuthorFilter = async (item: (Submission | Comment), filter: Au
     return [true, undefined, {criteriaResults: allCritResults, join: 'OR', passed: true}];
 }
 
-export const checkItemFilter = async (item: (Submission | Comment), filter: ItemOptions, resources: SubredditResources, options?: {logger?: Logger, source?: ActivitySource, includeIdentifier?: boolean}): Promise<[boolean, ('inclusive' | 'exclusive' | undefined), FilterResult<TypedActivityState>]> => {
+export const checkItemFilter = async (item: (Submission | Comment), filter: ItemOptions, resources: SubredditResources, options?: {logger?: Logger, source?: ActivitySourceValue, includeIdentifier?: boolean}): Promise<[boolean, ('inclusive' | 'exclusive' | undefined), FilterResult<TypedActivityState>]> => {
 
     const {
         logger: parentLogger = NoopLogger,
@@ -3886,7 +3946,7 @@ export const checkItemFilter = async (item: (Submission | Comment), filter: Item
     return [true, undefined, {criteriaResults: allCritResults, join: 'OR', passed: true}];
 }
 
-export const checkCommentSubmissionStates = async (item: Comment, submissionStates: SubmissionState[], resources: SubredditResources, logger: Logger, source?: ActivitySource, excludeCondition?: JoinOperands): Promise<[boolean, FilterCriteriaPropertyResult<CommentState>]> => {
+export const checkCommentSubmissionStates = async (item: Comment, submissionStates: SubmissionState[], resources: SubredditResources, logger: Logger, source?: ActivitySourceValue, excludeCondition?: JoinOperands): Promise<[boolean, FilterCriteriaPropertyResult<CommentState>]> => {
     // test submission state first since it's more likely(??) we have crit results or cache data for this submission than for the comment
 
     // get submission

src/Utils/SnoowrapClients.ts

@@ -3,7 +3,7 @@ import {Submission, Subreddit, Comment} from "snoowrap/dist/objects";
 import {parseSubredditName} from "../util";
 import {ModUserNoteLabel} from "../Common/Infrastructure/Atomic";
 import {CreateModNoteData, ModNote, ModNoteRaw, ModNoteSnoowrapPopulated} from "../Subreddit/ModNotes/ModNote";
-import {CMError, SimpleError} from "./Errors";
+import {CMError, isStatusError, SimpleError} from "./Errors";
 import {RawSubredditRemovalReasonData, SnoowrapActivity} from "../Common/Infrastructure/Reddit";
 
 // const proxyFactory = (endpoint: string) => {
@@ -66,6 +66,28 @@ export class ExtendedSnoowrap extends Snoowrap {
         return await this.oauthRequest({uri: '/api/info', method: 'get', qs: { sr_name: names.join(',')}}) as Listing<Subreddit>;
     }
 
+    async subredditExists(name: string): Promise<[boolean, Subreddit?]> {
+        try {
+            // @ts-ignore
+            const sub = await this.getSubreddit(name).fetch();
+            return [true, sub];
+        } catch (e: any) {
+            if (isStatusError(e)) {
+                switch (e.statusCode) {
+                    case 403:
+                        // we know that the sub exists but it is private
+                        return [true, undefined];
+                    case 404:
+                        return [false, undefined];
+                    default:
+                        throw e;
+                }
+            } else {
+                throw e;
+            }
+        }
+    }
+
     async assignUserFlairByTemplateId(options: { flairTemplateId: string, username: string, subredditName: string }): Promise<any> {
         return await this.oauthRequest({
             uri: `/r/${options.subredditName}/api/selectflair`,

src/Web/Client/ClientBotInstance.ts

@@ -1,6 +1,6 @@
 import {
     BotInstance,
-    BotInstanceResponse,
+    BotInstanceResponse, BotSubredditInviteResponse,
     CMInstanceInterface,
     ManagerResponse,
     NormalizedManagerResponse
@@ -15,6 +15,7 @@ export class ClientBotInstance implements BotInstance {
     managers: NormalizedManagerResponse[];
     nanny?: string | undefined;
     running: boolean;
+    invites: BotSubredditInviteResponse[]
 
     constructor(data: BotInstanceResponse, instance: CMInstanceInterface) {
         this.instance = instance;
@@ -24,6 +25,7 @@ export class ClientBotInstance implements BotInstance {
         this.managers = data.managers.map(x => ({...x, subredditNormal: parseRedditEntity(x.subreddit).name}));
         this.nanny = data.nanny;
         this.running = data.running;
+        this.invites = data.invites === undefined || data.invites === null ? [] : data.invites;
     }
 
     getManagerNames(): string[] {
@@ -56,6 +58,14 @@ export class ClientBotInstance implements BotInstance {
        return this.getAccessibleSubreddits(user, subreddits).includes(parseRedditEntity(subreddit).name);
     }
 
+    getInvites() {
+        return this.invites;
+    }
+
+    getInvite(val: string) {
+        return this.invites.find(x => x.id === val);
+    }
+
 }
 
 export default ClientBotInstance;

src/Web/Client/index.ts

@@ -33,7 +33,7 @@ import tcpUsed from "tcp-port-used";
 import http from "http";
 import jwt from 'jsonwebtoken';
 import {Server as SocketServer} from "socket.io";
-import got from 'got';
+import got, {HTTPError} from 'got';
 import sharedSession from "express-socket.io-session";
 import dayjs from "dayjs";
 import httpProxy from 'http-proxy';
@@ -56,7 +56,13 @@ import {MigrationService} from "../../Common/MigrationService";
 import {RuleResultEntity} from "../../Common/Entities/RuleResultEntity";
 import {RuleSetResultEntity} from "../../Common/Entities/RuleSetResultEntity";
 import { PaginationAwareObject } from "../Common/util";
-import {BotInstance, BotStatusResponse, CMInstanceInterface, InviteData} from "../Common/interfaces";
+import {
+    BotInstance,
+    BotStatusResponse,
+    BotSubredditInviteResponse,
+    CMInstanceInterface, HeartbeatResponse,
+    InviteData, SubredditInviteDataPersisted
+} from "../Common/interfaces";
 import {open} from "fs/promises";
 
 const emitter = new EventEmitter();
@@ -593,7 +599,18 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         next();
     }
 
-    app.getAsync('/auth/helper', helperAuthed, instanceWithPermissions, instancesViewData, (req, res) => {
+    const initHeartbeat = async (req: express.Request, res: express.Response, next: Function) => {
+        if(!init) {
+            for(const c of clients) {
+                await refreshClient(c);
+            }
+            init = true;
+            loopHeartbeat();
+        }
+        next();
+    };
+
+    app.getAsync('/auth/helper', initHeartbeat, helperAuthed, instanceWithPermissions, instancesViewData, (req, res) => {
         return res.render('helper', {
             redirectUri: clientCredentials.redirectUri,
             clientId: clientCredentials.clientId,
@@ -604,7 +621,7 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         });
     });
 
-    app.getAsync('/auth/invite/:inviteId', async (req, res) => {
+    app.getAsync('/auth/invite/:inviteId', initHeartbeat, async (req, res) => {
         const {inviteId} = req.params;
 
         if (inviteId === undefined) {
@@ -699,7 +716,7 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         }
     });
 
-    app.getAsync('/auth/init/:inviteId', async (req: express.Request, res: express.Response) => {
+    app.getAsync('/auth/init/:inviteId', initHeartbeat, async (req: express.Request, res: express.Response) => {
         const { inviteId } = req.params;
         if(inviteId === undefined) {
             return res.render('error', {error: '`invite` param is missing from URL'});
@@ -822,6 +839,8 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         next();
     }
 
+
+
     // const authenticatedRouter = Router();
     // authenticatedRouter.use([ensureAuthenticated, defaultSession]);
     // app.use(authenticatedRouter);
@@ -837,7 +856,7 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
     //     logger.debug(`Got proxy response: ${res.statusCode} for ${req.url}`);
     // });
 
-    app.useAsync('/api/', [ensureAuthenticatedApi, defaultSession, instanceWithPermissions, botWithPermissions(false), createUserToken], (req: express.Request, res: express.Response) => {
+    app.useAsync('/api/', [ensureAuthenticatedApi, initHeartbeat, defaultSession, instanceWithPermissions, botWithPermissions(false), createUserToken], (req: express.Request, res: express.Response) => {
         req.headers.Authorization = `Bearer ${req.token}`
 
         const instance = req.instance as CMInstanceInterface;
@@ -889,17 +908,6 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         next();
     }*/
 
-    const initHeartbeat = async (req: express.Request, res: express.Response, next: Function) => {
-        if(!init) {
-            for(const c of clients) {
-                await refreshClient(c);
-            }
-            init = true;
-            loopHeartbeat();
-        }
-        next();
-    };
-
     const redirectBotsNotAuthed = async (req: express.Request, res: express.Response, next: Function) => {
         if(cmInstances.length === 1 && cmInstances[0].error === 'Missing credentials: refreshToken, accessToken') {
             // assuming user is doing first-time setup and this is the default localhost bot
@@ -1046,8 +1054,139 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         });
     });
 
-    app.getAsync('/bot/invites', defaultSession, async (req: express.Request, res: express.Response) => {
-        res.render('modInvites', {
+    app.getAsync('/bot/invites/subreddit/:inviteId', initHeartbeat, ensureAuthenticated, defaultSession, async (req: express.Request, res: express.Response) => {
+
+        const {inviteId} = req.params;
+
+        if (inviteId === undefined) {
+            return res.render('error', {error: '`invite` param is missing from URL'});
+        }
+
+        let validInstance: CMInstance | undefined = undefined;
+        let validInvite: BotSubredditInviteResponse | undefined = undefined;
+        let validBot: BotInstance | undefined = undefined;
+        for(const instance of cmInstances) {
+            for(const bot of instance.bots) {
+                validInvite  = bot.getInvite(inviteId);
+                if(validInvite !== undefined) {
+                    validInstance = instance;
+                    validBot = bot;
+                    break;
+                }
+            }
+        }
+
+        if(validInvite === undefined) {
+            // try refreshing clients first
+            await refreshClients(true);
+        }
+
+        for(const instance of cmInstances) {
+            for(const bot of instance.bots) {
+                validInvite  = bot.getInvite(inviteId);
+                if(validInvite !== undefined) {
+                    validInstance = instance;
+                    validBot = bot;
+                    break;
+                }
+            }
+        }
+
+        if(validInvite === undefined || validInstance === undefined || validBot === undefined) {
+            return res.render('error', {error: 'Either no invite exists with the given ID or you are not a moderator of the subreddit this invite is for.'});
+        }
+
+        const user = req.user as Express.User;
+
+        // @ts-ignore
+        if(!user.subreddits.some(x => x.toLowerCase() === validInvite.subreddit.toLowerCase())) {
+            return res.render('error', {error: 'Either no invite exists with the given ID or you are not a moderator of the subreddit this invite is for.'});
+        }
+
+        try {
+            const invite = await got.get(`${validInstance.normalUrl}/bot/invite/${validInvite.id}?bot=${validBot.botName}`, {
+                headers: {
+                    'Authorization': `Bearer ${validInstance.getToken()}`,
+                }
+            }).json() as SubredditInviteDataPersisted;
+
+            const {guests, ...rest} = invite;
+            const guestStr = guests !== undefined && guests !== null && guests.length > 0 ? guests.join(',') : '';
+
+            return res.render('subredditOnboard/onboard', {
+                invite: {...rest, guests: guestStr},
+                bot: validBot.botName,
+                title: `Subreddit Onboarding`,
+            });
+
+        } catch (err: any) {
+            logger.error(err);
+            return res.render('error', {error: `Error occurred while retriving invite data: ${err.message}`});
+        }
+    });
+
+    app.postAsync('/bot/invites/subreddit/:inviteId', ensureAuthenticated, defaultSession, async (req: express.Request, res: express.Response) => {
+
+        const {inviteId} = req.params;
+
+        if (inviteId === undefined) {
+            return res.status(400).send('`invite` param is missing from URL')
+        }
+
+        let validInstance: CMInstance | undefined = undefined;
+        let validInvite: BotSubredditInviteResponse | undefined = undefined;
+        let validBot: BotInstance | undefined = undefined;
+        for(const instance of cmInstances) {
+            for(const bot of instance.bots) {
+                validInvite  = bot.getInvite(inviteId);
+                if(validInvite !== undefined) {
+                    validInstance = instance;
+                    validBot = bot;
+                    break;
+                }
+            }
+        }
+
+        if(validInvite === undefined || validInstance === undefined || validBot === undefined) {
+            return res.status(400).send('Either no invite exists with the given ID or you are not a moderator of the subreddit this invite is for.')
+        }
+
+        const user = req.user as Express.User;
+
+        // @ts-ignore
+        if(!user.subreddits.some(x => x.toLowerCase() === validInvite.subreddit.toLowerCase())) {
+            return res.status(400).send('Either no invite exists with the given ID or you are not a moderator of the subreddit this invite is for.')
+        }
+
+        try {
+            await got.post(`${validInstance.normalUrl}/bot/invite/${validInvite.id}?bot=${validBot.botName}`, {
+                json: req.body,
+                headers: {
+                    'Authorization': `Bearer ${validInstance.getToken()}`,
+                }
+            })
+
+            return res.status(200);
+
+        } catch (err: any) {
+            logger.error(err);
+            res.status(500)
+            let msg = err.message;
+            if(err instanceof HTTPError && typeof err.response.body === 'string') {
+                msg = err.response.body
+            }
+            return res.send(msg);
+        }
+    });
+
+    app.getAsync('/bot/invites/subreddit', initHeartbeat, ensureAuthenticated, defaultSession, instanceWithPermissions, botWithPermissions(true), async (req: express.Request, res: express.Response) => {
+        res.render('subredditOnboard/helper', {
+            title: `Create Subreddit Invite`,
+        });
+    });
+
+    app.getAsync('/bot/invites', initHeartbeat, ensureAuthenticated, defaultSession, async (req: express.Request, res: express.Response) => {
+        res.render('subredditOnboard/manager', {
             title: `Pending Moderation Invites`,
         });
     });
@@ -1061,7 +1200,7 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         });
     });
 
-    app.getAsync('/guest', [ensureAuthenticatedApi, defaultSession, instanceWithPermissions, botWithPermissions(true)], async (req: express.Request, res: express.Response) => {
+    app.getAsync('/guest', [ensureAuthenticatedApi, initHeartbeat, defaultSession, instanceWithPermissions, botWithPermissions(true)], async (req: express.Request, res: express.Response) => {
         const {subreddit} = req.query as any;
         return res.status(req.user?.isSubredditGuest(req.bot, subreddit) ? 200 : 403).send();
     });
@@ -1107,7 +1246,7 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
         return res.send();
     });
 
-    app.getAsync('/events', [ensureAuthenticatedApi, defaultSession, instanceWithPermissions, botWithPermissions(true), createUserToken], async (req: express.Request, res: express.Response) => {
+    app.getAsync('/events', [ensureAuthenticatedApi, initHeartbeat, defaultSession, instanceWithPermissions, botWithPermissions(true), createUserToken], async (req: express.Request, res: express.Response) => {
         const {subreddit, page = 1, permalink, related, author} = req.query as any;
         const resp = await got.get(`${(req.instance as CMInstanceInterface).normalUrl}/events`, {
             headers: {
@@ -1475,14 +1614,18 @@ const webClient = async (options: OperatorConfigWithFileContext) => {
 
     const loopHeartbeat = async () => {
         while(true) {
-            for(const c of clients) {
-                await refreshClient(c);
-            }
+            await refreshClients();
             // sleep for 10 seconds then do heartbeat check again
             await sleep(10000);
         }
     }
 
+    const refreshClients = async (force = false) => {
+        for(const c of clients) {
+            await refreshClient(c, force);
+        }
+    }
+
     const addBot = async (inviteId: string, botPayload: any) => {
 
         const cmInstance = cmInstances.find(x => x.invites.includes(inviteId));

src/Web/Common/User/ServerUser.ts

@@ -16,24 +16,24 @@ class ServerUser extends CMUser<App, Bot, Manager> {
     }
 
     canAccessInstance(val: App): boolean {
-        return this.isOperator || val.bots.filter(x => x.canUserAccessBot(this.name, this.subreddits)).length > 0;
+        return this.isOperator || this.machine || val.bots.filter(x => x.canUserAccessBot(this.name, this.subreddits)).length > 0;
     }
 
     canAccessBot(val: Bot): boolean {
-        return this.isOperator || val.canUserAccessBot(this.name, this.subreddits);
+        return this.isOperator || this.machine || val.canUserAccessBot(this.name, this.subreddits);
     }
 
     accessibleBots(bots: Bot[]): Bot[] {
-        return this.isOperator ? bots : bots.filter(x => x.canUserAccessBot(this.name, this.subreddits));
+        return (this.isOperator || this.machine) ? bots : bots.filter(x => x.canUserAccessBot(this.name, this.subreddits));
     }
 
     canAccessSubreddit(val: Bot, name: string): boolean {
         const normalName = parseRedditEntity(name).name;
-        return this.isOperator || this.accessibleSubreddits(val).some(x => x.toNormalizedManager().subredditNormal === normalName);
+        return this.isOperator || this.machine || this.accessibleSubreddits(val).some(x => x.toNormalizedManager().subredditNormal === normalName);
     }
 
     accessibleSubreddits(bot: Bot): Manager[] {
-        if(this.isOperator) {
+        if(this.isOperator || this.machine) {
             return bot.subManagers;
         }
 

src/Web/Common/interfaces.ts

@@ -3,6 +3,7 @@ import {BotConnection, LogInfo, ManagerStats} from "../../Common/interfaces";
 import {Guest, GuestAll} from "../../Common/Entities/Guest/GuestInterfaces";
 import {URL} from "url";
 import {Dayjs} from "dayjs";
+import {Subreddit} from "snoowrap/dist/objects";
 
 export interface BotStats {
     startedAtHuman: string,
@@ -90,6 +91,10 @@ export interface NormalizedManagerResponse extends ManagerResponse {
     subredditNormal: string
 }
 
+export interface BotSubredditInviteResponse {
+    subreddit: string
+    id: string
+}
 
 export interface BotInstanceResponse {
     botName: string
@@ -98,6 +103,12 @@ export interface BotInstanceResponse {
     managers: ManagerResponse[]
     nanny?: string
     running: boolean
+    invites: BotSubredditInviteResponse[]
+}
+
+export interface SubredditOnboardingReadiness {
+    hasManager: boolean
+    isMod: boolean
 }
 
 export interface BotInstanceFunctions {
@@ -108,6 +119,7 @@ export interface BotInstanceFunctions {
     getGuestSubreddits: (user: string) => string[]
     canUserAccessBot: (user: string, subreddits: string[]) => boolean
     canUserAccessSubreddit: (subreddit: string, user: string, subreddits: string[]) => boolean
+    getInvite(val: string): BotSubredditInviteResponse | undefined
 }
 
 export interface BotInstance extends BotInstanceResponse, BotInstanceFunctions {
@@ -162,3 +174,11 @@ export interface SubredditInviteData {
     initialConfig?: string
     expiresAt?: number | Dayjs
 }
+
+export interface HydratedSubredditInviteData extends Omit<SubredditInviteData, 'subreddit'>{
+    subreddit: string | Subreddit
+}
+
+export interface SubredditInviteDataPersisted extends SubredditInviteData {
+    id: string
+}

src/Web/Server/routes/authenticated/applicationRoutes.ts

@@ -29,6 +29,7 @@ export const heartbeat = (opData: OperatorData) => {
                     guests: y.managerEntity.getGuests().map(x => guestEntityToApiGuest(x)),
                 })),
                 running: x.running,
+                invites: x.getSubredditInvites().map(y => ({subreddit: y.subreddit, id: y.id}))
             })),
             operators: opData.name,
             operatorDisplay: opData.display,

src/Web/Server/routes/authenticated/user/index.ts

@@ -237,12 +237,7 @@ const saveGuestWikiEdit = async (req: Request, res: Response) => {
     const {location, data, reason = 'Updated through CM Web', create = false} = req.body as any;
 
     try {
-        // @ts-ignore
-        const wiki = await req.manager?.subreddit.getWikiPage(location) as WikiPage;
-        await wiki.edit({
-            text: data,
-            reason: `${reason} by Guest Mod ${req.user?.name}`,
-        });
+        await req.manager?.writeConfig(data, `${reason} by Guest Mod ${req.user?.name}`)
     } catch (err: any) {
         res.status(500);
         return res.send(err.message);

src/Web/Server/routes/authenticated/user/invites.ts

@@ -4,17 +4,61 @@ import {CMError} from "../../../../../Utils/Errors";
 
 const getSubredditInvites = async (req: Request, res: Response) => {
 
-    return res.json(await req.serverBot.cacheManager.getPendingSubredditInvites());
+    return res.json(await req.serverBot.getSubredditInvites());
 };
 export const getSubredditInvitesRoute = [authUserCheck(), botRoute(), getSubredditInvites];
+
+const getSubredditInvite = async (req: Request, res: Response) => {
+
+    const {id} = req.params;
+    const invite = await req.serverBot.getInvite(id);
+    if(invite !== undefined) {
+        const {bot, ...inviteRest} = invite;
+        const readiness = req.serverBot.getOnboardingReadiness(invite);
+        return res.json({...inviteRest, ...readiness});
+    }
+    return res.status(404);
+};
+export const getSubredditInviteRoute = [authUserCheck(['operator', 'machine']), botRoute(), getSubredditInvite];
+
+const acceptSubredditInvite = async (req: Request, res: Response) => {
+
+    const {id} = req.params;
+    const invite = await req.serverBot.getInvite(id);
+    if(invite !== undefined) {
+        const {initialConfig, guests} = req.body as any;
+        invite.initialConfig = initialConfig;
+        invite.guests = guests;
+
+        try {
+            await req.serverBot.finishOnboarding(invite);
+            return res.status(200);
+        } catch(e: any) {
+            const errorParts = [e.message];
+            if(e instanceof CMError && e.cause !== undefined) {
+                errorParts.push(e.cause?.message);
+            }
+            res.status(500)
+            return res.send(e.message);
+        }
+    }
+    return res.status(404);
+};
+export const acceptSubredditInviteRoute = [authUserCheck(['operator', 'machine']), botRoute(), acceptSubredditInvite];
+
 const addSubredditInvite = async (req: Request, res: Response) => {
 
-    const {subreddit} = req.body as any;
+    const {subreddit, initialConfig, guests} = req.body as any;
     if (subreddit === undefined || subreddit === null || subreddit === '') {
         return res.status(400).send('subreddit must be defined');
     }
     try {
-        await req.serverBot.cacheManager.addPendingSubredditInvite(subreddit);
+        const invite = await req.serverBot.addSubredditInvite({
+            subreddit,
+            initialConfig,
+            guests,
+        });
+        return res.status(200).send(invite.id);
     } catch (e: any) {
         if (e instanceof CMError) {
             req.logger.warn(e);
@@ -24,16 +68,15 @@ const addSubredditInvite = async (req: Request, res: Response) => {
             return res.status(500).send(e.message);
         }
     }
-    return res.status(200).send();
 };
 export const addSubredditInviteRoute = [authUserCheck(), botRoute(), addSubredditInvite];
 const deleteSubredditInvite = async (req: Request, res: Response) => {
 
-    const {subreddit} = req.query as any;
+    const {subreddit, id} = req.query as any;
     if (subreddit === undefined || subreddit === null || subreddit === '') {
         return res.status(400).send('subreddit must be defined');
     }
-    await req.serverBot.cacheManager.deletePendingSubredditInvite(subreddit);
+    await req.serverBot.deleteSubredditInvite(subreddit);
     return res.status(200).send();
 };
 export const deleteSubredditInviteRoute = [authUserCheck(), botRoute(), deleteSubredditInvite];

src/Web/Server/server.ts

@@ -36,10 +36,12 @@ import { sleep } from '../../util';
 import {Invokee} from "../../Common/Infrastructure/Atomic";
 import {Point} from "@influxdata/influxdb-client";
 import {
+    acceptSubredditInviteRoute,
     addBotInviteRoute,
     addSubredditInviteRoute,
     deleteSubredditInviteRoute,
     getBotInviteRoute,
+    getSubredditInviteRoute,
     getSubredditInvitesRoute
 } from "./routes/authenticated/user/invites";
 
@@ -190,6 +192,10 @@ const rcbServer = async function (options: OperatorConfigWithFileContext) {
 
     server.getAsync('/bot/invite', ...getSubredditInvitesRoute);
 
+    server.getAsync('/bot/invite/:id', ...getSubredditInviteRoute);
+
+    server.postAsync('/bot/invite/:id', ...acceptSubredditInviteRoute);
+
     server.postAsync('/bot/invite', ...addSubredditInviteRoute);
 
     server.deleteAsync('/bot/invite', ...deleteSubredditInviteRoute);

src/Web/assets/views/partials/subredditsTab.ejs

@@ -20,7 +20,7 @@
                     <li class="my-3 px-3">
                     <span class="rounded-md py-2 px-3 border">
                     <a class="font-normal pointer hover:font-bold" href="/bot/invites?instance=<%= instanceId %>&bot=<%= botData.system.name %>">
-                        Add Subreddit +
+                        Manage Subreddits Invites +
                     </a>
                     </span>
                     </li>

src/Web/assets/views/subredditOnboard/helper.ejs

@@ -0,0 +1,150 @@
+<html lang="en">
+<%- include('../partials/head', {title: 'Subreddit Onboarding Helper'}) %>
+<body class="bg-gray-900 text-white font-sans">
+<div class="min-w-screen min-h-screen">
+    <%- include('../partials/header') %>
+    <div class="container mx-auto mt-5">
+        <div class="grid grid-cols-1 gap-5">
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Choose subreddit(s) to onboard</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                    <div class="my-2 ml-5">
+                        <div class="space-y-3">
+                            <div>Specify which subreddits this bot should recognize moderator invites from.</div>
+                            <div>CM will NOT recognize (or accept) moderator invites from Subreddits you have not created an Onboarding invite for.</div>
+                            <div>Subreddits should be seperated with a comma.</div>
+                            <input id="subreddits" style="max-width:800px; display: block;"
+                                   class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
+                                   placeholder="aSubreddit,aSecondSubreddit,aThirdSubreddit">
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Settings that require Subreddit approval</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                    <div class="space-y-3 mb-6">
+                    <div><strong>If any of these settings are specified then a moderator will need to login to CM to complete the onboarding process even after sending the moderator invite to the bot.</strong> If none of these settings are specified CM will automatically accept the moderator invite.</div>
+                        <div>The moderator completing onboarding will also be able to opt-out or change any of these settings.</div>
+                    </div>
+                    <div class="text-lg text-semibold my-3">(Optional) Specify initial Guest Access</div>
+                    <div class="my-2 ml-5">
+                        <div class="space-y-3">
+                            <div>Specify Reddit users who should be automatically added with <b>Guest Access</b> to these subreddits once onboarding is complete.</div>
+                            <div>If you are already a moderator on all of the subreddits being added you can skip this step.</div>
+                            <div>Adding initial Guest Access is useful when you (the operator) want to setup configs for subreddits you are not a moderator of. This step reduces friction for onboarding as it eliminates the need for moderators to login to the dashboard and manually give you Guest Access.</div>
+                            <input id="guestMods" style="max-width:800px; display: block;"
+                                   class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
+                                   placeholder="RedditUser1,RedditUser2">
+                        </div>
+                    </div>
+                    <div class="text-lg text-semibold my-3">(Optional) Set initial Config
+                    </div>
+                    <div class="ml-5">
+                        <div class="space-y-2">
+                            <div>If specified, this is a normal URL or <a target="_blank" href="https://github.com/FoxxMD/context-mod/tree/master/docs/subreddit/components#url-tokens"><span class="font-mono">wiki:</span> token</a> pointing to a configuration that CM should automatically write to the Subreddit's config during onboarding.</div>
+                            <input id="initialConfig" style="max-width:800px; display: block;"
+                                   class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
+                                   placeholder="https://...">
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Create Onboaring Invites</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                        <div class="space-y-3">
+                            <div class="text-lg text-semibold my-3"><a id="doAuth" href="">Click to generate Onboarding Invites</a></div>
+                            <div>Unique links will be generated for each subreddit.</div>
+                            <ul class="list-inside list-disc" id="inviteLinks"></ul>
+                            <div id="errorWrapper" class="font-semibold hidden">Errors:
+                                <ul id="errorList" class="list-inside list-disc"></ul>
+                            </div>
+                        </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<%- include('../partials/footer') %>
+<script>
+    function setError(val) {
+        if(val === null) {
+            document.querySelector("#errorWrapper").classList.add('hidden');
+            document.querySelector('#errorList').innerHTML = '';
+        } else {
+            document.querySelector("#errorWrapper").classList.remove('hidden');
+            const node = document.createElement("LI");
+            node.appendChild(document.createTextNode(val));
+            document.querySelector("#errorList").appendChild(node);
+        }
+    }
+
+    function addLink(sub, val) {
+        if(val === null) {
+            document.querySelector('#inviteLinks').innerHTML = '';
+        } else {
+            const node = document.createElement("LI");
+            node.appendChild(document.createTextNode(`${sub}: `));
+            node.insertAdjacentHTML('beforeend', `<a class="font-semibold" href="${document.location.origin}/bot/invites/subreddit/${val}">${document.location.origin}/bot/invites/subreddit/${val}</a>`);
+            document.querySelector("#inviteLinks").appendChild(node);
+        }
+    }
+
+    document.querySelector('#doAuth').addEventListener('click', e => {
+        e.preventDefault();
+        const subredditVal = document.querySelector('#subreddits').value.trim();
+
+        if(subredditVal === '') {
+            setError('Subreddits cannot be empty!');
+            return;
+        } else {
+            setError(null);
+        }
+
+        const subreddits = subredditVal.split(',').map(x => x.trim());
+
+        const body = {};
+        const config = document.querySelector('#initialConfig').value.trim();
+        if(config !== '') {
+            body.initialConfig = config;
+        }
+        const guests = document.querySelector('#guestMods').value.trim();
+        if(guests !== '') {
+            body.guests = guests.split(',').map(x => x.trim());
+        }
+
+        for(const sub of subreddits) {
+            fetch(`/api/bot/invite${document.location.search}`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'Accept': 'application/json',
+                },
+                body: JSON.stringify({...body, subreddit: sub})
+            }).then((resp) => {
+                if(!resp.ok) {
+
+                    document.querySelector("#errorWrapper").classList.remove('hidden');
+                    resp.text().then(t => {
+                        setError(`${sub}: ${t}`);
+                    });
+                } else {
+                    document.querySelector("#errorWrapper").classList.add('hidden');
+                    document.querySelector('#subreddits').value = '';
+                    resp.text().then(t => {
+                        addLink(sub, t);
+                    });
+                }
+            });
+        }
+    })
+</script>
+</body>
+</html>

src/Web/assets/views/subredditOnboard/manager.ejs

@@ -1,19 +1,17 @@
 <html lang="en">
-<%- include('partials/head', {title: 'CM Accept Moderator Invitations From'}) %>
+<%- include('../partials/head', {title: 'CM Manage Subreddit Onboarding'}) %>
 <body class="bg-gray-900 text-white">
 <div class="min-w-screen min-h-screen font-sans">
-    <%- include('partials/title', {title: 'Accept Moderator Invitations From'}) %>
+    <%- include('../partials/title', {title: 'Manage Subreddit Onboarding'}) %>
     <div class="container mx-auto">
         <div class="grid">
             <div class="bg-gray-600">
                 <div class="p-6 md:px-10 md:py-6">
                     <div id="error" class="font-semibold"></div>
-                    <ul id="sublist" class="list-inside list-disc">
+                    <ul id="sublist" class="list-inside list-disc mb-5">
                         <li id="noSubs">Not accepting any invitations...</li>
                     </ul>
-                    <input id="subName" style="min-width:500px;"
-                           class="text-black placeholder-gray-500 rounded ml-3 mt-2 mb-3 mt-3 p-2"
-                           placeholder="Subreddit to accept invite from..."> <a id="addSub" class="ml-3" href="">Add</a>
+                    <a id="subredditInviteHelper" href="/bot/invites/subreddit">Create Subreddit Onboarding Invites</a>
                 </div>
             </div>
         </div>
@@ -50,44 +48,39 @@
             }
         });
 
-        document.querySelector('#addSub').addEventListener('click', e => {
-            e.preventDefault();
+        let helperLink = document.querySelector('#subredditInviteHelper');
+        const url = new URL(helperLink.href)
+        for (let [k,v] of new URLSearchParams(window.location.search).entries()){
+            url.searchParams.set(k,v)
+        }
+        helperLink.href = url.toString();
 
-            const subNameElm = document.querySelector('#subName');
-            subName = subNameElm.value;
-
-            fetch(`/api/bot/invite${document.location.search}`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'Accept': 'application/json',
-                },
-                body: JSON.stringify({
-                    subreddit: document.querySelector('#subName').value,
-                })
-            }).then((resp) => {
-                if (!resp.ok) {
-                    document.querySelector("#errorWrapper").classList.remove('hidden');
-                    resp.text().then(t => {
-                        document.querySelector("#error").innerHTML = t;
-                    });
-                } else {
-                    const ns = document.querySelector('#noSubs');
-                    if(ns !== null) {
-                        document.querySelector('#noSubs').style = 'display: none;';
-                    }
-                    addSubredditElement(subName);
-                    subNameElm.value = '';
-                }
-            });
-        });
-
-        function addSubredditElement(sub) {
+        function addSubredditElement(data) {
+            const {
+                subreddit: sub,
+                guests,
+                initialConfig,
+                expiresAt,
+                id,
+            } = data;
             var node = document.createElement("LI");
             node.id = `subInvite-${sub}`;
             var textNode = document.createTextNode(sub);
             node.appendChild(textNode);
             node.insertAdjacentHTML('beforeend', `<a href="" class="removeSub" id="removeSub-${sub}" data-subreddit="${sub}"><span style="display:inline; margin-left: 10px" class="iconify-inline" data-icon="icons8:cancel"></span></a>`);
+
+            const parts = [
+                `<li><a href="${document.location.origin}/bot/invites/subreddit/${id}">${document.location.origin}/bot/invites/subreddit/${id}</a></li>`
+            ];
+            if(guests !== null && guests !== undefined) {
+                parts.push(`<li>Guests: ${guests.join(', ')}`);
+            }
+            if(initialConfig !== null && initialConfig !== undefined) {
+                parts.push(`<li>Initial Config: <a href="${initialConfig}">${initialConfig}</a>`);
+            }
+
+            node.insertAdjacentHTML('beforeend',`<ul class="list-inside list-disc mb-5">${parts.join('\n')}</ul`)
+
             sl.appendChild(node);
             document.querySelector(`#removeSub-${sub}`).addEventListener('click', e => {
                 e.preventDefault();

src/Web/assets/views/subredditOnboard/onboard.ejs

@@ -0,0 +1,139 @@
+<html lang="en">
+<%- include('../partials/head', {title: 'Subreddit Onboarding Helper'}) %>
+<body class="bg-gray-900 text-white font-sans">
+<div class="min-w-screen min-h-screen">
+    <%- include('../partials/title', {title: 'Subreddit Onboarding'}) %>
+    <div class="container mx-auto mt-5">
+        <div class="grid grid-cols-1 gap-5">
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Hello 👋</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                    <div class="my-2 ml-5">
+                        <div class="space-y-3">
+                            <div>This is the onboarding invitation to setup
+                                <strong><a href="https://reddit.com/<%= bot %>"><%= bot %></a></strong> as a
+                                <a taget="_blank" href="https://github.com/FoxxMD/context-mod">Context Mod</a> (CM) bot on the subreddit
+                                <strong><a href="https://reddit.com/r/<%= invite.subreddit %>">r/<%= invite.subreddit %></a></strong>.
+
+                                <% if (invite.isMod || invite.hasManager) { %>
+                                    <div> <strong>Good news!</strong> <%= bot %> is already a moderator of this subreddit. "Finishing" onboarding below will have no effect on your bot. If you want to set Guest Access or a Config please do so from the <a href="/">Dashboard</a>.</div>
+                                <% } %>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Initial Settings</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                    <div class="space-y-3 mb-6">
+                    <div>The settings below, if specified, will automatically be applied when you finish onboarding.</div>
+                    </div>
+                    <div class="text-lg text-semibold my-3">Guest Access</div>
+                    <div class="my-2 ml-5">
+                        <div class="space-y-3">
+                            <div><strong>Guest Access</strong> allows Reddit Users who are not moderators of this subreddit to access the bot's dashboard and edit its configuration.
+                                This is useful when you want help from outside your mod team with setting up CM but don't want to set the user as Moderator of your subreddit.</div>
+                            <div>Separate multiple users with commas. Users listed will have Guest Access for 24 hours.</div>
+                            <input id="guestMods" style="max-width:800px; display: block;"
+                                   class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
+                                   placeholder="RedditUser1,RedditUser2" value="<%= invite.guests %>">
+                        </div>
+                    </div>
+                    <div class="text-lg text-semibold my-3">Initial Config
+                    </div>
+                    <div class="ml-5">
+                        <div class="space-y-2">
+                            <div>A normal URL or <a target="_blank" href="https://github.com/FoxxMD/context-mod/tree/master/docs/subreddit/components#url-tokens"><span class="font-mono">wiki:</span> token</a> pointing to a configuration that CM should automatically write to the Subreddit's config during onboarding.</div>
+                            <input id="initialConfig" style="max-width:800px; display: block;"
+                                   class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
+                                   placeholder="https://..."
+                                    value="<%= invite.initialConfig %>">
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="bg-gray-600">
+                <div class="bg-gray-700">
+                    <div class="text-xl px-4 p-2">Finish Onboaring</div>
+                </div>
+                <div class="p-6 md:px-10 md:py-6">
+                        <div class="space-y-3">
+                            <div>Some things to know:</div>
+                            <ul class="list-disc list-inside">
+                                <li>Like Automoderator, CM will NOT RUN if it does not have a configuration set.</li>
+                                <li>To run correctly <%= bot %> must at least have the <strong>Manage Wiki Pages</strong> Mod permission.</li>
+                                <li>Click the <strong>Help</strong> link on the top-right of the Dashboard, after finishing onboarding, to get a guided tour of the bot's interface or check out the Dashboard <a href="https://github.com/FoxxMD/context-mod/blob/master/docs/webInterface.md">Tips and Tricks</a> documentation.</li>
+                            </ul>
+                            <div id="finishOnboarding" class="text-lg text-semibold my-3"><a id="doOnboarding" href="">Click to finish Onboarding</a></div>
+                            <div id="errorWrapper" class="font-semibold hidden">Errors:
+                                <ul id="errorList" class="list-inside list-disc"></ul>
+                            </div>
+                        </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<%- include('../partials/footer') %>
+<script>
+    function setError(val) {
+        if(val === null) {
+            document.querySelector("#errorWrapper").classList.add('hidden');
+            document.querySelector('#errorList').innerHTML = '';
+        } else {
+            document.querySelector("#errorWrapper").classList.remove('hidden');
+            const node = document.createElement("LI");
+            node.innerHTML = val;
+            document.querySelector("#errorList").appendChild(node);
+        }
+    }
+
+    document.querySelector('#doOnboarding').addEventListener('click', e => {
+        e.preventDefault();
+
+        const body = {};
+        const config = document.querySelector('#initialConfig').value.trim();
+        if(config !== '') {
+            body.initialConfig = config;
+        }
+        const guests = document.querySelector('#guestMods').value.trim();
+        if(guests !== '') {
+            body.guests = guests.split(',').map(x => x.trim());
+        }
+
+        fetch(`/bot/invites/subreddit/<%= invite.id%>`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+            },
+            body: JSON.stringify(body)
+        }).then((resp) => {
+            if(!resp.ok) {
+                document.querySelector("#errorWrapper").classList.remove('hidden');
+                resp.text().then(t => {
+                    let msg = t;
+                    if(t.toLowerCase().includes('accepted moderator')) {
+                        msg = `${t}<br/><br/>CM is now running but not all Initial Settings were applied. Please finish applying them using the dashboard. <a href="/">Click here</a> to go to the dashboard.`;
+                        setError(msg);
+                    } else {
+                        setError(msg);
+                    }
+                });
+            } else {
+                document.querySelector("#errorWrapper").classList.add('hidden');
+                document.querySelector('#finishOnboarding').innerHTML = 'Onboarding complete! Redirecting you to the Dashboard...';
+                setTimeout(() => {
+                    window.location.href = window.location.origin;
+                }, 5000);
+            }
+        });
+    })
+</script>
+</body>
+</html>

src/util.ts

@@ -1,13 +1,14 @@
 import winston, {Logger} from "winston";
 import dayjs, {Dayjs} from 'dayjs';
 import {Duration} from 'dayjs/plugin/duration.js';
+import * as cronjs from '@datasert/cronjs-matcher';
 import Ajv from "ajv";
 import {InvalidOptionArgumentError} from "commander";
 import {deflateSync, inflateSync} from "zlib";
 import pixelmatch from 'pixelmatch';
 import os from 'os';
 import pathUtil from 'path';
-import {Response} from 'node-fetch';
+import fetch, {Response} from 'node-fetch';
 import crypto, {createHash} from 'crypto';
 import {
     ActionResult,
@@ -17,7 +18,8 @@ import {
     CheckSummary,
     ImageComparisonResult,
     ItemCritPropHelper,
-    LogInfo, NamedGroup,
+    LogInfo,
+    NamedGroup,
     PollingOptionsStrong,
     PostBehaviorOptionConfig,
     RegExResult,
@@ -41,7 +43,6 @@ import {create as createMemoryStore} from './Utils/memoryStore';
 import {LEVEL, MESSAGE} from "triple-beam";
 import {Comment, PrivateMessage, RedditUser, Submission, Subreddit} from "snoowrap/dist/objects";
 import reRegExp from '@stdlib/regexp-regexp';
-import fetch from "node-fetch";
 import ImageData from "./Common/ImageData";
 import {Sharp, SharpOptions} from "sharp";
 import {ErrorWithCause, stackWithCauses} from "pony-cause";
@@ -70,19 +71,23 @@ import {
     UserNoteCriteria
 } from "./Common/Infrastructure/Filters/FilterCriteria";
 import {
-    ActivitySource,
+    ActivitySourceValue,
     ActivitySourceTypes,
     CacheProvider,
     ConfigFormat,
-    DurationVal, ExternalUrlContext, ImageHashCacheData,
+    DurationVal,
+    ExternalUrlContext,
+    ImageHashCacheData,
     ModUserNoteLabel,
     modUserNoteLabels,
     RedditEntity,
-    RedditEntityType,
+    RedditEntityType, RelativeDateTimeMatch,
     statFrequencies,
     StatisticFrequency,
-    StatisticFrequencyOption, UrlContext,
-    WikiContext
+    StatisticFrequencyOption,
+    UrlContext,
+    WikiContext,
+    ActivitySourceData
 } from "./Common/Infrastructure/Atomic";
 import {
     AuthorOptions,
@@ -116,7 +121,7 @@ import {
 } from "./Common/Infrastructure/ActivityWindow";
 import {RunnableBaseJson} from "./Common/Infrastructure/Runnable";
 import Snoowrap from "snoowrap";
-import { uniqueNamesGenerator, adjectives, colors, animals } from 'unique-names-generator';
+import {adjectives, animals, colors, uniqueNamesGenerator} from 'unique-names-generator';
 import {ActionResultEntity} from "./Common/Entities/ActionResultEntity";
 
 
@@ -217,8 +222,26 @@ const errorAwareFormat = {
     }
 }
 
-const isProbablyError = (val: any, errName = 'error') => {
-    return typeof val === 'object' && val.name !== undefined && val.name.toLowerCase().includes(errName);
+const isProbablyError = (val: any, explicitErrorName?: string) => {
+    if(typeof val !== 'object' || val === null) {
+        return false;
+    }
+    const {name, stack} = val;
+    if(explicitErrorName !== undefined) {
+        if(name !== undefined && name.toLowerCase().includes(explicitErrorName)) {
+            return true;
+        }
+        if(stack !== undefined && stack.trim().toLowerCase().indexOf(explicitErrorName.toLowerCase()) === 0) {
+            return true;
+        }
+        return false;
+    } else if(stack !== undefined) {
+        return true;
+    } else if(name !== undefined && name.toLowerCase().includes('error')) {
+        return true;
+    }
+
+    return false;
 }
 
 export const PASS = '✓';
@@ -709,8 +732,7 @@ export const deflateUserNotes = (usersObject: object) => {
     const binaryData = deflateSync(jsonString);
 
     // Convert binary data to a base64 string with a Buffer
-    const blob = Buffer.from(binaryData).toString('base64');
-    return blob;
+    return Buffer.from(binaryData).toString('base64');
 }
 
 export const isActivityWindowConfig = (val: any): val is FullActivityWindowConfig => {
@@ -766,6 +788,34 @@ export const parseDuration = (val: string, strict = true): Duration => {
     return res[0].duration;
 }
 
+// https://stackoverflow.com/a/63729682
+const RELATIVE_DATETIME_REGEX: RegExp = /(?<cron>(?:(?:(?:(?:\d+,)+\d+|(?:\d+(?:\/|-|#)\d+)|\d+L?|\*(?:\/\d+)?|L(?:-\d+)?|\?|[A-Z]{3}(?:-[A-Z]{3})?) ?){5,7})$)|(?<dayofweek>mon|tues|wed|thurs|fri|sat|sun){1}/i;
+const RELATIVE_DATETIME_REGEX_URL = 'https://regexr.com/6u3cc';
+
+// https://day.js.org/docs/en/get-set/day
+const dayOfWeekMap: Record<string, number> = {
+    sun: 0,
+    mon: 1,
+    tues: 2,
+    wed: 3,
+    thurs: 4,
+    fri: 5,
+    sat: 6,
+};
+
+export const matchesRelativeDateTime = (expr: RelativeDateTimeMatch, dt: Dayjs) => {
+    const res = parseRegexSingleOrFail(RELATIVE_DATETIME_REGEX, expr);
+    if (res === undefined) {
+        throw new InvalidRegexError(RELATIVE_DATETIME_REGEX, expr, RELATIVE_DATETIME_REGEX_URL);
+    }
+    if (res.named.dayofweek !== undefined) {
+        return dayOfWeekMap[res.named.dayofweek] === dt.day();
+    }
+    // assume 5-point cron expression
+    // the matcher requires datetime second field to be 0 https://github.com/datasert/cronjs/issues/31
+    return cronjs.isTimeMatches(res.named.cron, dt.set('second', 0).toISOString());
+}
+
 const SUBREDDIT_NAME_REGEX: RegExp = /^\s*(?:\/r\/|r\/)*(\w+)*\s*$/;
 const SUBREDDIT_NAME_REGEX_URL = 'https://regexr.com/61a1d';
 export const parseSubredditName = (val:string): string => {
@@ -2674,17 +2724,30 @@ export const isCommentState = (state: TypedActivityState): state is CommentState
 const DISPATCH_REGEX: RegExp = /^dispatch:/i;
 const POLL_REGEX: RegExp = /^poll:/i;
 const USER_REGEX: RegExp = /^user:/i;
-export const asActivitySource = (val: string): val is ActivitySource => {
+const ACTIVITY_SOURCE_REGEX: RegExp = /^(?<type>dispatch|poll|user)(?:$|:(?<identifier>[^\s\r\n]+)$)/i
+const ACTIVITY_SOURCE_REGEX_URL = 'https://regexr.com/6uqn6';
+export const asActivitySourceValue = (val: string): val is ActivitySourceValue => {
     if(['dispatch','poll','user'].some(x => x === val)) {
         return true;
     }
     return DISPATCH_REGEX.test(val) || POLL_REGEX.test(val) || USER_REGEX.test(val);
 }
 
-export const strToActivitySource = (val: string): ActivitySource => {
+export const asActivitySource = (val: any): val is ActivitySourceData => {
+    return null !== val && typeof val === 'object' && 'type' in val;
+}
+
+export const strToActivitySourceData = (val: string): ActivitySourceData => {
     const cleanStr = val.trim();
-    if (asActivitySource(cleanStr)) {
-        return cleanStr;
+    if (asActivitySourceValue(cleanStr)) {
+        const res = parseRegexSingleOrFail(ACTIVITY_SOURCE_REGEX, cleanStr);
+        if (res === undefined) {
+            throw new InvalidRegexError(ACTIVITY_SOURCE_REGEX, cleanStr, ACTIVITY_SOURCE_REGEX_URL, 'Could not parse activity source');
+        }
+        return {
+            type: res.named.type,
+            identifier: res.named.identifier
+        }
     }
     throw new SimpleError(`'${cleanStr}' is not a valid ActivitySource. Must be one of: dispatch, dispatch:[identifier], poll, poll:[identifier], user, or user:[identifier]`);
 }
@@ -2964,3 +3027,8 @@ export const generateRandomName = () => {
 export const asStrongImageHashCache = (data: ImageHashCacheData): data is Required<ImageHashCacheData> => {
     return data.original !== undefined && data.flipped !== undefined;
 }
+
+export const generateFullWikiUrl = (subreddit: Subreddit | string, location: string) => {
+    const subName = subreddit instanceof Subreddit ? subreddit.url : `r/${subreddit}/`;
+    return `https://reddit.com${subName}wiki/${location}`
+}

tests/itemCriteria.test.ts

@@ -0,0 +1,292 @@
+import {describe, it} from 'mocha';
+import {assert} from 'chai';
+import dayjs from "dayjs";
+import dduration, {Duration, DurationUnitType} from 'dayjs/plugin/duration.js';
+import utc from 'dayjs/plugin/utc.js';
+import advancedFormat from 'dayjs/plugin/advancedFormat';
+import tz from 'dayjs/plugin/timezone';
+import relTime from 'dayjs/plugin/relativeTime.js';
+import sameafter from 'dayjs/plugin/isSameOrAfter.js';
+import samebefore from 'dayjs/plugin/isSameOrBefore.js';
+import weekOfYear from 'dayjs/plugin/weekOfYear.js';
+import {SubredditResources} from "../src/Subreddit/SubredditResources";
+import {NoopLogger} from '../src/Utils/loggerFactory';
+import {Subreddit, Comment, Submission} from 'snoowrap/dist/objects';
+import Snoowrap from "snoowrap";
+import {getResource, getSnoowrap, getSubreddit, sampleActivity} from "./testFactory";
+import {Subreddit as SubredditEntity} from "../src/Common/Entities/Subreddit";
+import {Activity} from '../src/Common/Entities/Activity';
+
+dayjs.extend(dduration);
+dayjs.extend(utc);
+dayjs.extend(relTime);
+dayjs.extend(sameafter);
+dayjs.extend(samebefore);
+dayjs.extend(tz);
+dayjs.extend(advancedFormat);
+dayjs.extend(weekOfYear);
+
+describe('Item Criteria', function () {
+    let resource: SubredditResources;
+    let snoowrap: Snoowrap;
+    let subreddit: Subreddit;
+    let subredditEntity: SubredditEntity;
+
+    before(async () => {
+        resource = await getResource();
+        snoowrap = await getSnoowrap();
+        subreddit = await getSubreddit();
+        subredditEntity = await resource.database.getRepository(SubredditEntity).save(new SubredditEntity({
+            id: subreddit.id,
+            name: subreddit.name
+        }));
+    });
+
+    describe('Moderator accessible criteria', function () {
+
+        describe('Reports criteria', function () {
+
+            let sub: Submission;
+            let activity: Activity;
+
+            before(async () => {
+                try {
+                    sub = new Submission({
+                        title: 'test',
+                        id: 't3_je93j',
+                        name: 't3_je93j',
+                        created: dayjs().subtract(10, 'minutes').unix(),
+                        created_utc: dayjs().subtract(10, 'minutes').unix(),
+                        num_reports: 7,
+                        user_reports: [
+                            ['misinformation', 1, false, true],
+                            ['personal attack', 3, false, true]
+                        ],
+                        mod_reports: [
+                            ['suspicious activity', 1, false, true],
+                            ['hate', 2, false, true]
+                        ],
+                        subreddit,
+                        permalink: 'test',
+                        author: 'aUser'
+                    }, snoowrap, false);
+
+                    activity = Activity.fromSnoowrapActivity(subredditEntity, sub);
+                    await resource.database.getRepository(Activity).save(activity);
+                } catch (e: any) {
+                    throw e;
+                }
+            });
+
+            it('Matches number of reports', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '> 2'}, NoopLogger, true)).passed);
+            });
+            it('Matches number of user reports', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '> 3 user'}, NoopLogger, true)).passed);
+            });
+            it('Matches number of mod reports', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '< 4 mod'}, NoopLogger, true)).passed);
+            });
+            it('Matches report reason literal', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '> 0 "misinformation"'}, NoopLogger, true)).passed);
+            });
+            it('Matches report reason regex', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '> 0 /misi.*/'}, NoopLogger, true)).passed);
+            });
+            it('Matches report time period', async function () {
+                assert.isTrue((await resource.isItem(sub, {reports: '> 0 in 20 minutes'}, NoopLogger, true)).passed);
+            });
+        });
+
+        it('Should detect if activity is removed when a moderator', async function () {
+            assert.isTrue((await resource.isItem(sampleActivity.moddable.commentRemoved(), {removed: true}, NoopLogger, true)).passed);
+        });
+        it('Should detect if activity is filtered when a moderator', async function () {
+            assert.isTrue((await resource.isItem(sampleActivity.moddable.commentFiltered(), {filtered: true}, NoopLogger, true)).passed);
+        });
+        it('Should detect if activity is approved when a moderator', async function () {
+            assert.isTrue((await resource.isItem(new Comment({
+                approved: true
+            }, snoowrap, false), {approved: true}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect if activity is marked as spam when a moderator', async function () {
+            assert.isTrue((await resource.isItem(new Comment({
+                spam: true,
+                can_mod_post: true,
+            }, snoowrap, false), {spam: true}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(new Comment({
+                spam: false,
+                can_mod_post: true
+            }, snoowrap, false), {spam: false}, NoopLogger, true)).passed);
+        });
+    });
+
+    describe('Publicly accessible criteria', function () {
+
+        // TODO dispatched
+
+        it('should detect broad source', async function() {
+            const sub = new Submission({
+            }, snoowrap, false);
+            assert.isTrue((await resource.isItem(sub, {source: 'dispatch'}, NoopLogger, true, 'dispatch:test')).passed);
+            assert.isFalse((await resource.isItem(sub, {source: 'poll'}, NoopLogger, true, 'dispatch:test')).passed);
+            assert.isTrue((await resource.isItem(sub, {source: 'poll'}, NoopLogger, true, 'poll')).passed);
+        })
+
+        it('should detect source with identifier', async function() {
+            const sub = new Submission({
+            }, snoowrap, false);
+            assert.isTrue((await resource.isItem(sub, {source: 'dispatch:test'}, NoopLogger, true, 'dispatch:test')).passed);
+            assert.isFalse((await resource.isItem(sub, {source: 'user:test'}, NoopLogger, true, 'user')).passed);
+        })
+
+        it('Should detect score (upvotes)', async function () {
+            const sub = new Submission({
+                score: 100,
+            }, snoowrap, false);
+            assert.isTrue((await resource.isItem(sub, {score: '> 50'}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(sub, {score: '< 101'}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect if activity is removed', async function () {
+            assert.isTrue((await resource.isItem(sampleActivity.public.activityRemoved(), {removed: true}, NoopLogger, true)).passed);
+        });
+        it('Should detect if activity is deleted', async function () {
+            assert.isTrue((await resource.isItem(sampleActivity.public.submissionDeleted(), {deleted: true}, NoopLogger, true)).passed);
+        });
+
+        it('Should fail if trying to detect approved and not a moderator', async function () {
+            assert.isFalse((await resource.isItem(new Comment({
+                approved_by: undefined
+            }, snoowrap, false), {approved: true}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect age', async function () {
+            const time = dayjs().subtract(5, 'minutes').unix();
+            const sub = new Submission({
+                created: time,
+            }, snoowrap, false);
+            assert.isTrue((await resource.isItem(sub, {age: '> 4 minutes'}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(sub, {age: '< 10 minutes'}, NoopLogger, true)).passed);
+        });
+
+        it('Should match created day of week', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                created: 1664220502,
+            }, snoowrap, false), {createdOn: 'monday'}, NoopLogger, true)).passed);
+        });
+
+        it('Should match created cron expression', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                created: 1664220502,
+            }, snoowrap, false), {createdOn: '* * 26 * *'}, NoopLogger, true)).passed);
+        });
+
+        it('Should match title literal on submission', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                title: 'foo test',
+            }, snoowrap, false), {title: 'foo'}, NoopLogger, true)).passed);
+        });
+
+        it('Should match title regex on submission', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                title: 'foo test',
+            }, snoowrap, false), {title: '/foo .*/i'}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect reddit media domain on submission', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                is_reddit_media_domain: true,
+            }, snoowrap, false), {isRedditMediaDomain: true}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(new Submission({
+                is_reddit_media_domain: false,
+            }, snoowrap, false), {isRedditMediaDomain: false}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect if author is OP', async function () {
+            // for comments
+            assert.isTrue((await resource.isItem(new Comment({
+                is_submitter: true,
+            }, snoowrap, false), {op: true}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(new Comment({
+                is_submitter: false,
+            }, snoowrap, false), {op: false}, NoopLogger, true)).passed);
+
+            // for submission
+            assert.isTrue((await resource.isItem(new Submission({}, snoowrap, false), {op: true}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect comment depth', async function () {
+            assert.isTrue((await resource.isItem(new Comment({
+                depth: 2,
+            }, snoowrap, false), {depth: '> 1'}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect upvote ratio on submission', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                upvote_ratio: 0.55,
+            }, snoowrap, false), {upvoteRatio: '> 33'}, NoopLogger, true)).passed);
+        });
+
+        it('Should detect specific link flair template', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                link_flair_template_id: 'test',
+            }, snoowrap, false), {flairTemplate: 'test'}, NoopLogger, true)).passed);
+            assert.isTrue((await resource.isItem(new Submission({
+                link_flair_template_id: 'test',
+            }, snoowrap, false), {flairTemplate: ['foo','test']}, NoopLogger, true)).passed);
+            assert.isFalse((await resource.isItem(new Submission({
+                link_flair_template_id: 'test',
+            }, snoowrap, false), {flairTemplate: ['foo']}, NoopLogger, true)).passed);
+        });
+        it('Should detect any link flair template', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                link_flair_template_id: 'test',
+            }, snoowrap, false), {flairTemplate: true}, NoopLogger, true)).passed);
+        });
+        it('Should detect no link flair template', async function () {
+            assert.isTrue((await resource.isItem(new Submission({
+                link_flair_template_id: null
+            }, snoowrap, false), {flairTemplate: false}, NoopLogger, true)).passed);
+        });
+
+        for(const prop of ['link_flair_text', 'link_flair_css_class']) {
+            it(`Should detect specific ${prop}`, async function () {
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: 'test',
+                }, snoowrap, false), {[prop]: 'test'}, NoopLogger, true)).passed);
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: 'test',
+                }, snoowrap, false), {[prop]: ['foo','test']}, NoopLogger, true)).passed);
+                assert.isFalse((await resource.isItem(new Submission({
+                    [prop]: 'test',
+                }, snoowrap, false), {[prop]: ['foo']}, NoopLogger, true)).passed);
+            });
+            it(`Should detect any ${prop}`, async function () {
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: 'test',
+                }, snoowrap, false), {[prop]: true}, NoopLogger, true)).passed);
+            });
+            it(`Should detect no ${prop}`, async function () {
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: null
+                }, snoowrap, false), {[prop]: false}, NoopLogger, true)).passed);
+            });
+        }
+
+        for(const prop of ['pinned', 'spoiler', 'is_self', 'over_18', 'locked', 'distinguished']) {
+            it(`Should detect activity with ${prop} attribute`, async function () {
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: true,
+                }, snoowrap, false), {[prop]: true}, NoopLogger, true)).passed);
+                assert.isTrue((await resource.isItem(new Submission({
+                    [prop]: false,
+                }, snoowrap, false), {[prop]: false}, NoopLogger, true)).passed);
+            });
+        }
+
+        // TODO submissionState
+    });
+});
+

tests/snoowrapUtils.test.ts

@@ -4,66 +4,42 @@ import {mock, spy, when, instance} from 'ts-mockito';
 import Snoowrap from "snoowrap";
 import {Submission, Comment} from "snoowrap/dist/objects";
 import {activityIsDeleted, activityIsFiltered, activityIsRemoved} from "../src/Utils/SnoowrapUtils";
-
-const mockSnoowrap = new Snoowrap({userAgent: 'test', accessToken: 'test'});
+import {sampleActivity} from "./testFactory";
 
 describe('Activity state recognition', function () {
     describe('activity is removed', function () {
         describe('when bot is a moderator', function () {
             it('submission not removed when filtered by automod', function () {
 
-                assert.isFalse(activityIsRemoved(new Submission({
-                    can_mod_post: true,
-                    banned_at_utc: 12345,
-                    removed_by_category: 'automod_filtered'
-                }, mockSnoowrap, true)));
+                assert.isFalse(activityIsRemoved(sampleActivity.moddable.activityFilteredByAutomod()));
 
             })
             it('submission is removed when not filtered by automod', function () {
 
-                assert.isTrue(activityIsRemoved(new Submission({
-                    can_mod_post: true,
-                    banned_at_utc: 12345,
-                    removed_by_category: 'mod'
-                }, mockSnoowrap, true)));
+                assert.isTrue(activityIsRemoved(sampleActivity.moddable.activityRemovedByMod()));
 
             })
             it('comment is removed', function () {
 
-                assert.isTrue(activityIsRemoved(new Comment({
-                    can_mod_post: true,
-                    banned_at_utc: 12345,
-                    removed: true,
-                    replies: ''
-                }, mockSnoowrap, true)));
+                assert.isTrue(activityIsRemoved(sampleActivity.moddable.commentRemoved()));
+                assert.isTrue(activityIsRemoved(sampleActivity.moddable.commentRemovedByMod()));
 
             })
         })
         describe('when bot is not a moderator', function () {
             it('submission is deleted by moderator', function () {
 
-                assert.isTrue(activityIsRemoved(new Submission({
-                    can_mod_post: false,
-                    removed_by_category: 'moderator'
-                }, mockSnoowrap, true)));
+                assert.isTrue(activityIsRemoved(sampleActivity.public.submissionRemoved()));
 
             })
             it('submission is deleted by user or other', function () {
 
-                assert.isTrue(activityIsRemoved(new Submission({
-                    can_mod_post: false,
-                    removed_by_category: 'deleted'
-                }, mockSnoowrap, true)));
-
+                assert.isTrue(activityIsRemoved(sampleActivity.moddable.submissionDeleted()));
             })
 
             it('comment body is removed', function () {
 
-                assert.isTrue(activityIsRemoved(new Comment({
-                    can_mod_post: false,
-                    body: '[removed]',
-                    replies: ''
-                }, mockSnoowrap, true)));
+                assert.isTrue(activityIsRemoved(sampleActivity.public.commentRemoved()));
 
             })
         })
@@ -71,31 +47,17 @@ describe('Activity state recognition', function () {
 
     describe('activity is filtered', function() {
         it('not filtered when user is not a moderator', function() {
-            assert.isFalse(activityIsFiltered(new Submission({
-                can_mod_post: false,
-                banned_at_utc: 12345,
-                removed_by_category: 'mod'
-            }, mockSnoowrap, true)));
+            assert.isFalse(activityIsFiltered(sampleActivity.public.activityRemoved()));
         })
 
         it('submission is filtered', function () {
 
-            assert.isTrue(activityIsFiltered(new Submission({
-                can_mod_post: true,
-                banned_at_utc: 12345,
-                removed_by_category: 'automod_filtered'
-            }, mockSnoowrap, true)));
-
+            assert.isTrue(activityIsFiltered(sampleActivity.moddable.activityFilteredByAutomod()));
         })
 
         it('comment is filtered', function () {
 
-            assert.isTrue(activityIsFiltered(new Comment({
-                can_mod_post: true,
-                banned_at_utc: 12345,
-                removed: false,
-                replies: ''
-            }, mockSnoowrap, true)));
+            assert.isTrue(activityIsFiltered(sampleActivity.moddable.commentFiltered()));
 
         })
     })
@@ -104,25 +66,14 @@ describe('Activity state recognition', function () {
 
         it('submission is deleted', function () {
 
-            assert.isTrue(activityIsDeleted(new Submission({
-                can_mod_post: true,
-                banned_at_utc: 12345,
-                removed_by_category: 'deleted'
-            }, mockSnoowrap, true)));
+            assert.isTrue(activityIsDeleted(sampleActivity.moddable.submissionDeleted()));
+            assert.isTrue(activityIsDeleted(sampleActivity.public.submissionDeleted()));
 
         })
 
         it('comment is deleted', function () {
 
-            assert.isTrue(activityIsDeleted(new Comment({
-                can_mod_post: true,
-                banned_at_utc: 12345,
-                removed: false,
-                replies: '',
-                author: {
-                    name: '[deleted]'
-                }
-            }, mockSnoowrap, true)));
+            assert.isTrue(activityIsDeleted(sampleActivity.moddable.commentDeleted()));
 
         })
 

tests/testFactory.ts

@@ -0,0 +1,196 @@
+import {OperatorConfig, OperatorJsonConfig} from "../src/Common/interfaces";
+import Snoowrap from "snoowrap";
+import Bot from "../src/Bot/index"
+import {buildOperatorConfigWithDefaults} from "../src/ConfigBuilder";
+import {App} from "../src/App";
+import {YamlOperatorConfigDocument} from "../src/Common/Config/Operator";
+import {NoopLogger} from "../src/Utils/loggerFactory";
+import {ManagerEntity} from "../src/Common/Entities/ManagerEntity";
+import {Bot as BotEntity} from "../src/Common/Entities/Bot";
+import {SubredditResources} from "../src/Subreddit/SubredditResources";
+import {Subreddit, Comment, Submission} from 'snoowrap/dist/objects';
+import dayjs from 'dayjs';
+
+const mockSnoowrap = new Snoowrap({userAgent: 'test', accessToken: 'test'});
+
+const memoryConfig: OperatorJsonConfig = {
+    databaseConfig: {
+        connection: {
+            type: 'sqljs',
+            location: ':memory:'
+        }
+    },
+    logging: {
+        level: 'debug',
+        file: {
+            dirname: false
+        }
+    },
+    bots: [
+        {
+            name: 'test',
+            credentials: {
+                reddit: {
+                    clientId: 'test',
+                    clientSecret: 'test',
+                    accessToken: 'test',
+                    refreshToken: 'test'
+                }
+            }
+        }
+    ]
+};
+
+let config: OperatorConfig;
+let app: App;
+let snoowrap: Snoowrap;
+let bot: Bot;
+let resource: SubredditResources;
+let subreddit: Subreddit;
+
+export const getConfig = async () => {
+    if (config === undefined) {
+        config = await buildOperatorConfigWithDefaults(memoryConfig);
+    }
+    return config;
+}
+
+export const getApp = async () => {
+    if (app === undefined) {
+        const config = await getConfig();
+        app = new App({...config, fileConfig: {document: new YamlOperatorConfigDocument('')}});
+        await app.initDatabase();
+    }
+    return app;
+}
+
+export const getSnoowrap = async () => {
+    if (snoowrap === undefined) {
+        const bot = await getBot();
+        snoowrap = bot.client;
+    }
+    return snoowrap;
+}
+
+export const getBot = async () => {
+    if (bot === undefined) {
+        await getApp();
+        const config = await getConfig();
+        bot = new Bot(config.bots[0], NoopLogger);
+        await bot.cacheManager.set('test', {
+            logger: NoopLogger,
+            subreddit: bot.client.getSubreddit('test'),
+            client: bot.client,
+            statFrequency: 'minute',
+            managerEntity: new ManagerEntity(),
+            botEntity: new BotEntity()
+        });
+    }
+    return bot;
+}
+
+export const getResource = async () => {
+    if (resource === undefined) {
+        const bot = await getBot();
+        resource = bot.cacheManager.get('test') as SubredditResources;
+    }
+    return resource;
+}
+
+// @ts-ignore
+export const getSubreddit = async () => {
+    if (subreddit === undefined) {
+        const snoo = await getSnoowrap();
+        subreddit = new Subreddit({id: 't3_test', name: 'test'}, snoo, true);
+    }
+    // @ts-ignore
+    return subreddit;
+}
+
+export const sampleActivity = {
+    moddable: {
+        commentRemovedByMod: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed_by_category: 'mod'
+            }, snoowrap, true);
+        },
+        activityRemovedByMod: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed_by_category: 'mod'
+            }, snoowrap, true)
+        },
+        activityFilteredByAutomod: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed_by_category: 'automod_filtered'
+            }, snoowrap, true);
+        },
+        commentFiltered: (snoowrap = mockSnoowrap) => {
+            return new Comment({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed: false,
+                replies: ''
+            }, snoowrap, true)
+        },
+        commentRemoved: (snoowrap = mockSnoowrap) => {
+          return new Comment({
+              can_mod_post: true,
+              banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+              removed: true,
+              replies: ''
+          }, snoowrap, true);
+        },
+        submissionDeleted: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed_by_category: 'deleted'
+            }, snoowrap, true);
+        },
+        commentDeleted: (snoowrap = mockSnoowrap) => {
+            return new Comment({
+                can_mod_post: true,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed: false,
+                replies: '',
+                author: {
+                    name: '[deleted]'
+                }
+            }, snoowrap, true);
+        }
+    },
+    public: {
+        submissionRemoved: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: false,
+                removed_by_category: 'moderator'
+            }, snoowrap, true)
+        },
+        submissionDeleted: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: false,
+                removed_by_category: 'deleted'
+            }, snoowrap, true);
+        },
+        commentRemoved: (snoowrap = mockSnoowrap) => {
+            return new Comment({
+                can_mod_post: false,
+                body: '[removed]',
+                replies: ''
+            }, snoowrap, true)
+        },
+        activityRemoved: (snoowrap = mockSnoowrap) => {
+            return new Submission({
+                can_mod_post: false,
+                banned_at_utc: dayjs().subtract(10, 'minutes').unix(),
+                removed_by_category: 'moderator'
+            }, snoowrap, true);
+        }
+    }
+}

tests/utils.test.ts

@@ -1,11 +1,18 @@
 import {describe, it} from 'mocha';
 import {assert} from 'chai';
 import {
-    COMMENT_URL_ID, GH_BLOB_REGEX, GIST_RAW_REGEX,
+    COMMENT_URL_ID,
+    GH_BLOB_REGEX,
+    GIST_RAW_REGEX,
     GIST_REGEX,
     parseDurationFromString,
     parseLinkIdentifier,
-    parseRedditEntity, parseRegexSingleOrFail, REGEXR_REGEX, removeUndefinedKeys, SUBMISSION_URL_ID
+    parseRedditEntity,
+    parseRegexSingleOrFail,
+    REGEXR_REGEX,
+    removeUndefinedKeys,
+    strToActivitySourceData,
+    SUBMISSION_URL_ID
 } from "../src/util";
 import dayjs from "dayjs";
 import dduration, {Duration, DurationUnitType} from 'dayjs/plugin/duration.js';
@@ -15,6 +22,7 @@ import {
     parseGenericValueOrPercentComparison, parseReportComparison
 } from "../src/Common/Infrastructure/Comparisons";
 import {RegExResult} from "../src/Common/interfaces";
+import {SOURCE_DISPATCH, SOURCE_POLL, SOURCE_USER} from "../src/Common/Infrastructure/Atomic";
 
 dayjs.extend(dduration);
 
@@ -357,3 +365,19 @@ describe('Link Recognition', function () {
         });
     })
 })
+
+describe('Activity Source Parsing', function () {
+    it('should parse all activity types', function () {
+        for (const type of [SOURCE_DISPATCH, SOURCE_POLL, SOURCE_USER]) {
+            const source = strToActivitySourceData(type);
+            assert.equal(source.type, type);
+        }
+    });
+    it('should throw if invalid activity source type', function () {
+        assert.throws(() => strToActivitySourceData('jflksdf'));
+    });
+    it('should parse identifier from activity source', function () {
+        const source = strToActivitySourceData('dispatch:test');
+        assert.equal(source.identifier, 'test');
+    });
+})