GitHub REST API service

nodecg-io-github/extension/index.ts

@@ -0,0 +1,38 @@
+import { NodeCG } from "nodecg-types/types/server";
+import { Result, emptySuccess, success, ServiceBundle } from "nodecg-io-core";
+import { Octokit } from "@octokit/rest";
+
+export interface GitHubConfig {
+    token: string;
+}
+
+export type GitHubClient = Octokit;
+
+module.exports = (nodecg: NodeCG) => {
+    new GitHubService(nodecg, "github", __dirname, "../schema.json").register();
+};
+
+class GitHubService extends ServiceBundle<GitHubConfig, GitHubClient> {
+    async validateConfig(config: GitHubConfig): Promise<Result<void>> {
+        const octokit = new Octokit({
+            auth: config.token,
+        });
+        await octokit.repos.listForAuthenticatedUser({
+            page: 0,
+            per_page: 1,
+        });
+        return emptySuccess();
+    }
+
+    async createClient(config: GitHubConfig): Promise<Result<GitHubClient>> {
+        const client = new Octokit({
+            auth: config.token,
+        });
+        this.nodecg.log.info("Successfully created github client.");
+        return success(client);
+    }
+
+    stopClient(_: GitHubClient): void {
+        // Does not need to be stopped as it has no state or permanent connection.
+    }
+}

nodecg-io-github/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "nodecg-io-github",
+    "version": "0.2.0",
+    "description": "Allows to connect to the GitHub REST API",
+    "homepage": "https://nodecg.io/RELEASE/samples/github",
+    "author": {
+        "name": "noeppi_noeppi",
+        "url": "https://github.com/noeppi-noeppi"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/codeoverflow-org/nodecg-io.git",
+        "directory": "nodecg-io-github"
+    },
+    "files": [
+        "**/*.js",
+        "**/*.js.map",
+        "**/*.d.ts",
+        "*.json"
+    ],
+    "main": "extension/index",
+    "scripts": {
+        "build": "tsc -b",
+        "watch": "tsc -b -w",
+        "clean": "tsc -b --clean"
+    },
+    "keywords": [
+        "nodecg-io",
+        "nodecg-bundle"
+    ],
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-core": "^0.2.0"
+        }
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^15.0.2",
+        "nodecg-types": "^1.8.2",
+        "typescript": "^4.2.4"
+    },
+    "dependencies": {
+        "nodecg-io-core": "^0.2.0",
+        "@octokit/rest": "^18.12.0"
+    }
+}

nodecg-io-github/schema.json

@@ -0,0 +1,12 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "token": {
+            "type": "string",
+            "description": "The GitHub API token."
+        }
+    },
+    "required": ["token"]
+}

nodecg-io-github/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "../tsconfig.common.json"
+}