feat(integration): implement obs-websocket

.eslintignore

@@ -0,0 +1 @@
+webpack.config.js

.eslintrc.json

@@ -6,6 +6,7 @@
     "key-spacing": ["error", { "beforeColon": false, "afterColon": true, "align": "value" }],
     "object-curly-spacing": ["error", "always"],
     "object-curly-newline": ["error", {
+      "ObjectExpression": { "multiline": true, "minProperties": 3 },
       "ImportDeclaration": { "multiline": true, "minProperties": 3 },
       "ExportDeclaration": { "multiline": true, "minProperties": 3 }
     }],

.github/workflows/tests.yml

@@ -55,7 +55,7 @@ jobs:
       run: npm run test:config:sqlite
     - name: Run migration test
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
-      run: node tools/migrationCheck.js
+      run: npm run test:migration
     - name: Run mocha
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
       run: npm test
@@ -98,7 +98,7 @@ jobs:
       run: npm run test:config:postgres
     - name: Run migration test
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
-      run: node tools/migrationCheck.js
+      run: npm run test:migration
     - name: Run mocha
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
       run: npm test
@@ -143,7 +143,7 @@ jobs:
       run: npm run test:config:mysql
     - name: Run migration test
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
-      run: node tools/migrationCheck.js
+      run: npm run test:migration
     - name: Run mocha
       if: "!contains(steps.log.outputs.MESSAGE, '[skip-tests]')"
       run: npm test

Makefile

@@ -24,6 +24,7 @@ dependencies:
 	# How to create node_modules patch: https://opensource.christmas/2019/4
 	patch --forward node_modules/twitch-js/types/index.d.ts < patches/twitch-js-types-2.patch
 	patch --forward node_modules/twitch-js/types/index.d.ts < patches/twitch-js-add-highlight-msgId.patch
+	patch --forward node_modules/obs-websocket-js/types/index.d.ts < patches/obswebsocketTypeExpose.patch
 
 eslint:
 	@echo -ne "\n\t ----- Checking eslint\n"
@@ -51,6 +52,7 @@ else
 endif
 
 bot:
+	@rm -rf dest
 ifeq ($(ENV),production)
 	@echo -ne "\n\t ----- Building bot (strip comments)\n"
 	@npx tsc -p src/bot --removeComments true

locales/en.json

@@ -170,6 +170,10 @@
         "filter": {
           "label": "Filter"
         },
+        "linkFilter": {
+          "label": "Link Overlay Filter",
+          "placeholder": "If using overlay, add link or id of your overlay"
+        },
         "hashtag": {
           "label": "Hashtag or Keyword",
           "placeholder": "#yourHashtagHere or Keyword"
@@ -436,7 +440,8 @@
           "username": "Username on Twitter",
           "displayname": "Screen name on twitter",
           "url": "Tweet link"
-        }
+        },
+        "sceneName": "Name of scene"
       }
     },
     "page-settings": {
@@ -746,6 +751,7 @@
     "user-parted-channel": "user parted a channel",
     "follow": "new follow",
     "tip": "new tip",
+    "obs-scene-changed": "OBS scene changed",
     "unfollow": "unfollow",
     "subscription": "new subscription",
     "subgift": "new subgift",

locales/en/integrations/obswebsocket.json

@@ -0,0 +1,7 @@
+{
+  "runTask": {
+    "EntityNotFound": "$sender, there is no action set for id:$id!",
+    "ParameterError": "$sender, you need to specify id!",
+    "UnknownError": "$sender, something went wrong. Check bot logs for additional informations."
+  }
+}

locales/en/ui.menu.json

@@ -86,5 +86,6 @@
   "texttospeech": "Text To Speech",
   "lastfm": "Last.fm",
   "pubg": "PLAYERUNKNOWN'S BATTLEGROUNDS",
-  "levels": "Levels"
+  "levels": "Levels",
+  "obswebsocket": "OBS Websocket"
 }

locales/en/ui/integrations/obswebsocket.json

@@ -0,0 +1,57 @@
+{
+  "settings": {
+    "enabled": "Status",
+    "accessBy": {
+      "title": "Access by",
+      "help": "Direct - connect directly from a bot | Overlay - connect via overlay browser source"
+    },
+    "address": "Address",
+    "password": "Password"
+  },
+  "noSourceSelected": "No source selected",
+  "noSceneSelected": "No scene selected",
+  "empty": "No action sets were created yet.",
+  "emptyAfterSearch": "No action sets were found by your search for <strong>\"$search\"</strong>.",
+  "command": "Command",
+  "new": "Create new OBS Websocket action set",
+  "actions": "Actions",
+  "name": {
+    "name": "Name"
+  },
+  "SetCurrentScene": {
+    "name": "SetCurrentScene"
+  },
+  "StartReplayBuffer": {
+    "name": "StartReplayBuffer"
+  },
+  "StopReplayBuffer": {
+    "name": "StopReplayBuffer"
+  },
+  "SaveReplayBuffer": {
+    "name": "SaveReplayBuffer"
+  },
+  "WaitMs": {
+    "name": "Wait X miliseconds"
+  },
+  "Log": {
+    "name": "Log message"
+  },
+  "StartRecording": {
+    "name": "StartRecording"
+  },
+  "StopRecording": {
+    "name": "StopRecording"
+  },
+  "PauseRecording": {
+    "name": "PauseRecording"
+  },
+  "ResumeRecording": {
+    "name": "ResumeRecording"
+  },
+  "SetMute": {
+    "name": "SetMute"
+  },
+  "SetVolume": {
+    "name": "SetVolume"
+  }
+}