feat: Add google-cast service and sample (#748)

Author: SteffoSpieler

.prettierrc.js

@@ -12,5 +12,5 @@ module.exports = {
     arrowParens: "always",
     proseWrap: "preserve",
     vueIndentScriptAndStyle: false,
-    endOfLine: "lf",
+    endOfLine: "auto",
 };

README.md

@@ -29,6 +29,7 @@ nodecg-io is the successor of [ChatOverflow](https://github.com/codeoverflow-org
 - Elgato lights
 - GitHub
 - Google APIs
+- Google Cast
 - IntelliJ IDEs
 - IRC (Internet Relay Chat)
 - MIDI Input

package-lock.json

@@ -0,0 +1,35 @@
+import { NodeCG } from "nodecg-types/types/server";
+import { GoogleCastClient } from "nodecg-io-google-cast";
+import { requireService } from "nodecg-io-core";
+
+module.exports = function (nodecg: NodeCG) {
+    nodecg.log.info("Sample bundle for the google-cast service started.");
+
+    const template = requireService<GoogleCastClient>(nodecg, "google-cast");
+
+    let previousDevice: GoogleCastClient | undefined = undefined;
+
+    template?.onAvailable((castDevice) => {
+        nodecg.log.info("google-cast service available.");
+        previousDevice = castDevice;
+
+        const deviceName = castDevice.friendlyName.length !== 0 ? castDevice.friendlyName : castDevice.host;
+
+        castDevice.play("https://www.soundhelix.com/examples/mp3/SoundHelix-Song-4.mp3", (err) => {
+            if (err === null)
+                nodecg.log.info(`Successfully started playing sample media on google cast device ${deviceName}`);
+            else nodecg.log.error(`Failed to play media on google cast device ${deviceName}: ${err}`);
+        });
+    });
+
+    template?.onUnavailable(() => {
+        nodecg.log.info("google-cast service unavailable.");
+
+        if (previousDevice !== undefined) {
+            previousDevice.stop((err) => {
+                if (err !== null) nodecg.log.info("Stopped playback on previous google cast device.");
+            });
+            previousDevice = undefined;
+        }
+    });
+};

samples/google-cast/extension/index.ts

@@ -0,0 +1,20 @@
+{
+    "name": "google-cast",
+    "version": "0.3.0",
+    "private": true,
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-template": "^0.3.0"
+        }
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@types/node": "^18.7.8",
+        "nodecg-types": "^1.9.0",
+        "nodecg-io-core": "^0.3.0",
+        "nodecg-io-google-cast": "^0.3.0",
+        "typescript": "^4.7.4",
+        "nodecg-io-tsconfig": "^1.0.0"
+    }
+}

samples/google-cast/package.json

@@ -0,0 +1,11 @@
+{
+    "extends": "nodecg-io-tsconfig",
+    "references": [
+        {
+            "path": "../../nodecg-io-core"
+        },
+        {
+            "path": "../../services/nodecg-io-google-cast"
+        }
+    ]
+}

samples/google-cast/tsconfig.json

@@ -0,0 +1,32 @@
+import { GoogleCastConfig } from "./index";
+import Device from "chromecast-api/lib/device";
+import { EventEmitter } from "events";
+
+const CONNECT_TIMEOUT = 15000;
+
+export class GoogleCastClient extends Device {
+    static async createClient(config: GoogleCastConfig): Promise<GoogleCastClient> {
+        const device = new GoogleCastClient({
+            name: config.name ?? "",
+            friendlyName: config.friendlyName ?? "",
+            host: config.host,
+        });
+
+        const d = device as GoogleCastClient & {
+            client: EventEmitter;
+        };
+
+        await new Promise((resolve, reject) => {
+            d._tryConnect(() => resolve(undefined));
+
+            d.client.on("error", (err) => {
+                // oh nein
+                reject(err);
+            });
+
+            setTimeout(() => reject(new Error("Connect timeout reached")), CONNECT_TIMEOUT);
+        });
+
+        return device;
+    }
+}

services/nodecg-io-google-cast/extension/castClient.ts

@@ -0,0 +1,53 @@
+import { NodeCG } from "nodecg-types/types/server";
+import { Result, emptySuccess, success, ServiceBundle, Logger } from "nodecg-io-core";
+import { GoogleCastClient } from "./castClient";
+import ChromecastAPI from "chromecast-api";
+
+export interface GoogleCastConfig {
+    name?: string;
+    friendlyName?: string;
+    host: string;
+}
+
+export { GoogleCastClient } from "./castClient";
+
+module.exports = (nodecg: NodeCG) => {
+    new GoogleCastService(nodecg).register();
+};
+
+class GoogleCastService extends ServiceBundle<GoogleCastConfig, GoogleCastClient> {
+    private autoDiscoveryClient = new ChromecastAPI();
+
+    constructor(nodecg: NodeCG) {
+        super(nodecg, "google-cast", __dirname, "../schema.json");
+
+        this.autoDiscoveryClient.on("device", (device) => {
+            if (this.presets === undefined) this.presets = {};
+
+            this.presets[device.friendlyName] = {
+                name: device.name,
+                friendlyName: device.friendlyName,
+                host: device.host,
+            };
+        });
+    }
+
+    async validateConfig(_: GoogleCastConfig): Promise<Result<void>> {
+        return emptySuccess();
+    }
+
+    async createClient(config: GoogleCastConfig, logger: Logger): Promise<Result<GoogleCastClient>> {
+        const client = await GoogleCastClient.createClient(config);
+        logger.info("Successfully created google-cast client.");
+        return success(client);
+    }
+
+    stopClient(client: GoogleCastClient, logger: Logger): void {
+        client.close();
+        logger.info("Successfully stopped google-cast client.");
+    }
+
+    removeHandlers(client: GoogleCastClient): void {
+        client.removeAllListeners();
+    }
+}

services/nodecg-io-google-cast/extension/index.ts

@@ -0,0 +1,50 @@
+{
+    "name": "nodecg-io-google-cast",
+    "version": "0.3.0",
+    "description": "Allows playing media on Google Cast devices.",
+    "homepage": "https://nodecg.io/RELEASE/samples/google-cast",
+    "author": {
+        "name": "CodeOverflow team",
+        "url": "https://github.com/codeoverflow-org"
+    },
+    "contributors": [
+        {
+            "name": "SteffoSpieler",
+            "url": "https://about.steffospieler.de"
+        }
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/codeoverflow-org/nodecg-io.git",
+        "directory": "services/nodecg-io-google-cast"
+    },
+    "files": [
+        "**/*.js",
+        "**/*.js.map",
+        "**/*.d.ts",
+        "*.json"
+    ],
+    "main": "extension/index",
+    "keywords": [
+        "nodecg-io",
+        "nodecg-bundle"
+    ],
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-core": "^0.3.0"
+        }
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^18.7.8",
+        "@types/chromecast-api": "^0.4.1",
+        "nodecg-types": "^1.9.0",
+        "typescript": "^4.7.4",
+        "nodecg-io-tsconfig": "^1.0.0"
+    },
+    "dependencies": {
+        "nodecg-io-core": "^0.3.0",
+        "chromecast-api": "^0.4.0"
+    }
+}

services/nodecg-io-google-cast/package.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "The unique name of the google cast device that is independent of host."
+        },
+        "friendlyName": {
+            "type": "string",
+            "description": "The user configured friendly display name of this google cast device."
+        },
+        "host": {
+            "type": "string",
+            "description": "The network host (ip or mDNS hostname) of this google cast device."
+        }
+    },
+    "required": ["host"]
+}