Refactor Trigger System / Config

CHANGELOG.md

@@ -8,6 +8,25 @@ You can now shoutout a specific person by adding a Shoutout Command .. or
 With the help of a [very powerful json query library: JSONata](https://jsonata.org) it is now possible to parse trigger payloads (twitch message, raid, etc) and use those as variables for Arguments of Command Blocks.
 (insert screenshot here)
 
+## 2023.1.0
+
+### Features
+
+- New Recipe Command Block: Shoutout a twitch user
+  Example: as Command Block
+
+- Triggers now have inline Recipes (link to recipe example)
+  Example: screenshot and stuff
+
+- Recipe: Command Block -> Config Arguments can now use variables (from the Triggers)
+  Example: parse the chat commands 2nd argument to shoutout
+
+- New Recipe Command Block: Call an URL and reuse it in other commands (thanks to variables :tada:)
+
+### Internal
+
+Refactored the Twitch / Timer Triggers to be more generic for easier way to add more types of triggers.
+
 ## 2022.1.1
 
 ### New Command Block "Random Command Group"

angular.json

@@ -608,6 +608,191 @@
           }
         }
       }
+    },
+    "triggers-twitch": {
+      "projectType": "library",
+      "root": "projects/triggers-twitch",
+      "sourceRoot": "projects/triggers-twitch/src",
+      "prefix": "memebox",
+      "architect": {
+        "build": {
+          "builder": "@nrwl/angular:ng-packagr-lite",
+          "options": {
+            "tsConfig": "projects/triggers-twitch/tsconfig.lib.json",
+            "project": "projects/triggers-twitch/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/triggers-twitch/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/triggers-twitch/src/**/*.ts",
+              "projects/triggers-twitch/src/**/*.html"
+            ]
+          }
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "outputs": ["coverage/projects/triggers-twitch"],
+          "options": {
+            "jestConfig": "projects/triggers-twitch/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
+    },
+    "triggers-timer": {
+      "projectType": "library",
+      "root": "projects/triggers-timer",
+      "sourceRoot": "projects/triggers-timer/src",
+      "prefix": "memebox",
+      "architect": {
+        "build": {
+          "builder": "@nrwl/angular:ng-packagr-lite",
+          "options": {
+            "tsConfig": "projects/triggers-timer/tsconfig.lib.json",
+            "project": "projects/triggers-timer/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/triggers-timer/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/triggers-timer/src/**/*.ts",
+              "projects/triggers-timer/src/**/*.html"
+            ]
+          }
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "outputs": ["coverage/projects/triggers-timer"],
+          "options": {
+            "jestConfig": "projects/triggers-timer/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
+    },
+    "triggers-twitch-contracts": {
+      "projectType": "library",
+      "root": "projects/triggers-twitch-contracts",
+      "sourceRoot": "projects/triggers-twitch-contracts/src",
+      "prefix": "memebox",
+      "architect": {
+        "build": {
+          "builder": "@nrwl/angular:ng-packagr-lite",
+          "options": {
+            "tsConfig": "projects/triggers-twitch-contracts/tsconfig.lib.json",
+            "project": "projects/triggers-twitch-contracts/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/triggers-twitch-contracts/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/triggers-twitch-contracts/src/**/*.ts",
+              "projects/triggers-twitch-contracts/src/**/*.html"
+            ]
+          }
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "outputs": ["coverage/projects/triggers-twitch-contracts"],
+          "options": {
+            "jestConfig": "projects/triggers-twitch-contracts/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
+    },
+    "server-common": {
+      "projectType": "library",
+      "root": "projects/server-common",
+      "sourceRoot": "projects/server-common/src",
+      "prefix": "memebox",
+      "architect": {
+        "build": {
+          "builder": "@nrwl/angular:ng-packagr-lite",
+          "options": {
+            "tsConfig": "projects/server-common/tsconfig.lib.json",
+            "project": "projects/server-common/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/server-common/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/server-common/src/**/*.ts",
+              "projects/server-common/src/**/*.html"
+            ]
+          }
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "outputs": ["coverage/projects/server-common"],
+          "options": {
+            "jestConfig": "projects/server-common/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
+    },
+    "twitch-api": {
+      "projectType": "library",
+      "root": "projects/twitch-api",
+      "sourceRoot": "projects/twitch-api/src",
+      "prefix": "memebox",
+      "architect": {
+        "build": {
+          "builder": "@nrwl/angular:ng-packagr-lite",
+          "options": {
+            "tsConfig": "projects/twitch-api/tsconfig.lib.json",
+            "project": "projects/twitch-api/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/twitch-api/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/twitch-api/src/**/*.ts",
+              "projects/twitch-api/src/**/*.html"
+            ]
+          }
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "outputs": ["coverage/projects/twitch-api"],
+          "options": {
+            "jestConfig": "projects/twitch-api/jest.config.js",
+            "passWithNoTests": true
+          }
+        }
+      }
     }
   },
   "cli": {
@@ -630,6 +815,9 @@
       "prefix": "app",
       "style": "scss",
       "skipTests": true
+    },
+    "@nrwl/angular:component": {
+      "style": "scss"
     }
   }
 }

jest.config.js

@@ -19,4 +19,5 @@ module.exports = {
   rootDir: __dirname,
   preset: 'jest-preset-angular',
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
+  projects: '<rootDir>/projects/twitch-api'
 };

projects/app-state/src/lib/state/app.queries.ts

@@ -1,20 +1,20 @@
-import { Injectable } from "@angular/core";
-import { Query } from "@datorama/akita";
-import { AppState } from "@memebox/contracts";
-import { AppStore } from "./app.store";
+import {Injectable} from "@angular/core";
+import {Query} from "@datorama/akita";
+import {AppState} from "@memebox/contracts";
+import {AppStore} from "./app.store";
+import {RecipeStateQueries} from "@memebox/recipe-core";
 
 @Injectable({
   providedIn: "root"
 })
-export class AppQueries extends Query<AppState> {
+export class AppQueries extends Query<AppState> implements RecipeStateQueries {
   state$ = this.select().pipe(
 
   );
 
   actionList$ = this.select(store => Object.values(store.clips));
   screensList$ = this.select(store => Object.values(store.screen));
-  twitchEvents$ = this.select(store => Object.values(store.twitchEvents));
-  timedEvents$ = this.select(store => Object.values(store.timers));
+  triggers$ = this.select(store => Object.values(store.triggers));
   tagList$ = this.select(store => Object.values(store.tags));
   queueList$ = this.select(store => {
     const allClips = Object.values(store.clips);

projects/contracts/src/lib/actions.ts

@@ -1,5 +1,5 @@
 import {Dictionary, ScreenMediaOverridableProperties} from "./types";
-import {AllTwitchEvents} from "./twitch.connector.types";
+import {AllTwitchEvents} from "../../../triggers-twitch-contracts/src/lib/twitch.connector.types";
 
 // TODO refactor / rename to more understandable names
 
@@ -23,13 +23,24 @@ export const ACTIONS = {
 }
 
 export enum TriggerActionOrigin {
-  Unknown,
-  AppPreview,
-  StreamDeck, // currently also Unknown
-  TwitchEvent,
-  Timer,
-  Meta, // TODO CHECK META
-  Scripts
+  Unknown = 0,
+  AppPreview = 1,
+  StreamDeck = 2, // currently also Unknown
+  /**
+   * @deprecated
+   */
+  TwitchEvent = 3,
+  /**
+   * @deprecated
+   */
+  Timer = 4,
+  /**
+   * @deprecated
+   */
+  Meta = 5,
+  Scripts = 6,
+  Recipe = 7,
+  Triggers = 8
 }
 
 /**

projects/contracts/src/lib/constants.ts

@@ -1,5 +1,3 @@
-import {TwitchEventTypes} from './types';
-
 // TODO merge App / Server Endpoint CONSTANTS
 
 export const ENDPOINTS = {
@@ -10,7 +8,6 @@ export const ENDPOINTS = {
   ERROR: 'error',
   STATE: 'state',
 
-  TIMED_EVENTS: 'timed_events',
   NETWORK_LIST: 'network_ip_list',
 
   OPEN: {
@@ -27,11 +24,12 @@ export const ENDPOINTS = {
     CUSTOM_PORT: '/customPort'
   },
 
-  TWITCH_EVENTS: {
-    PREFIX: 'twitch_events',
+
+  TRIGGER_CONFIGS: {
+    PREFIX: 'trigger_configs',
     TRIGGER_CONFIG_EXAMPLE: '/trigger_config_example',
-    TRIGGER_EVENT: '/trigger_event',
-    LAST_20_EVENTS: '/last_events'
+    TRIGGER_ONE: '/trigger_one',
+    LAST_20_EVENTS: '/last_triggered'
   },
 
   OBS_DATA: {
@@ -73,18 +71,6 @@ export const ENDPOINTS = {
   },
 }
 
-export const TwitchTypesArray = [
-  // TwitchEventTypes.follow,
-  TwitchEventTypes.bits,
-  TwitchEventTypes.channelPoints,
-  // TwitchEventTypes.host,
-  TwitchEventTypes.message,
-  TwitchEventTypes.raid,
-  TwitchEventTypes.ban,
-  TwitchEventTypes.subscription,
-  TwitchEventTypes.gift
-];
-
 export const WEBSOCKET_PATHS = {
   TWITCH_EVENTS: '/ws/twitch_events',
   ACTION_ACTIVITY: '/ws/action_activity',

projects/contracts/src/lib/createInitialState.ts

@@ -1,4 +1,4 @@
-import {SettingsState} from "./types";
+import {SettingsState} from "./types.state";
 
 export function createInitialState (): SettingsState {
   return {
@@ -18,10 +18,9 @@ export function createInitialState (): SettingsState {
         }
       },
     },
-    twitchEvents: {},
+    triggers: {},
     screen: {},
     clips: {},
     tags: {},
-    timers: {}
   }
 }

projects/contracts/src/lib/timed-trigger.types.ts

@@ -0,0 +1,9 @@
+import {TriggerConfig} from "@memebox/contracts";
+
+export interface TimerTriggerConfig extends TriggerConfig {
+  type: 'timer.ms';
+
+  argumentValues: {
+    interval: number
+  };
+}