[WIP] Reddit connector

package.json

@@ -8,7 +8,7 @@
     "core-cli": "node node_modules/@verida/cli-tools/dist/exec.js",
     "dev": "yarn build && yarn symlink-static && nodemon src/server.js",
     "symlink-static": "rm -rf dist/web && ln -s ../src/web dist/web",
-    "build": "rm -rf dist && tsc && rm -rf dist/assets && cp -R assets dist/ && cp -R src/web dist/web",
+    "build": "rm -rf dist && tsc --noCheck && rm -rf dist/assets && cp -R assets dist/ && cp -R src/web dist/web",
     "prestart": "yarn build",
     "start": "node dist/server.js",
     "tests": "ts-mocha './tests/**/*.ts'",
@@ -92,6 +92,7 @@
     "passport": "^0.5.2",
     "passport-facebook": "^3.0.0",
     "passport-google-oauth20": "^2.0.0",
+    "passport-reddit": "^1.1.0",
     "pdf-parse": "^1.1.1",
     "sanitize-html": "^2.13.1",
     "string-strip-html": "8.5.0",

src/providers/reddit/README.md

@@ -0,0 +1,57 @@
+# Reddit Connector
+
+The Reddit connector fetches a user's personal reddit data from the past 3 months.
+
+## Handlers
+
+## Known issues
+
+1. Private chat messages are not supported in the official API, see [here](https://www.reddit.com/r/redditdev/comments/17s83sf/chat_api/)
+
+## Refresh Tokens
+
+<!-- TODO -->
+
+## Unit Tests
+
+This repository contains a suite of unit tests designed to test the core Reddit API and to validate the integration of a Reddit account with the provider's synchronization handlers. The tests ensure that the Reddit data is correctly fetched and processed. The unit tests cover the following aspects:
+
+- Fetching and testing Reddit account.
+- Fetching and testing Reddit account's subreddits, including where the account has the role of contributor, moderator or subscriber.
+- Fetching and testing Reddit account's messages including notifications and private messages.
+- Fetching and testing Reddit account's comments
+- Fetching and testing Reddit account's interactions e.g. listing(posts, comments, etc.) that the user has upvoted, donwvoted, hidden or saved
+
+### Prerequisites
+
+Before running the unit tests, ensure that you have the following set up:
+
+1. **Reddit Account**: A YouTube account with some activity is required. This activity includes uploaded videos, subscriptions, and liked videos.
+
+2. **Reddit Account Data**: Make sure to have an account with some activity e.g. messages sent/received, comments, etc.
+   You can:
+   a. create a testing config file with the expected account information e.g. account name, number of messages, etc.
+   b. Run the tests with the following expected results
+
+   - **Messages**: An account with more than 50 messages.
+   - **Comments**: More than 50 comments by your account.
+   - **Posts**: Have at least a post.
+
+3. **Authorized Application**: Make sure to create an authorized `web app` application and fill in the required information in the `serverconfig.local.json`
+
+### Running the Tests
+
+```bash
+# To run the API tests
+yarn run test tests/providers/reddit/api.test.ts
+# To run the handler tests
+yarn run test tests/providers/reddit/handlers/*.test.ts
+```
+
+## Resources
+
+- [API Overview](https://www.reddit.com/dev/api/)
+- [Reddit Passport](https://github.com/Slotos/passport-reddit)
+- [OAuth2](https://github.com/reddit-archive/reddit/wiki/OAuth2)
+- [API Scopes](https://www.reddit.com/api/v1/scopes)
+- []()

src/providers/reddit/accountCache.ts

@@ -0,0 +1,33 @@
+import { RedditApi } from "./api";
+import { Account } from "./types";
+
+export interface TelegramUserProfile {
+  fullName: string;
+  firstName: string;
+  lastName: string;
+  username?: string;
+}
+
+/**
+ * Helper utility to fetch a user object
+ */
+export class AccountCache {
+  private accountCache: Record<string, Account> = {};
+  private api: RedditApi;
+
+  constructor(api: RedditApi) {
+    this.api = api;
+  }
+
+  public async getAccount(userId: string) {
+    if (this.accountCache[userId]) {
+      return this.accountCache[userId];
+    }
+
+    const user = await this.api.getUser(userId);
+
+    this.accountCache[userId] = user;
+
+    return this.accountCache[userId];
+  }
+}