Allow for tech to solo/focus incentives (#24)

* Solo works on dashboard

* Implement soloing in backend

* Install deps

Author: duncte123

package.json

@@ -105,7 +105,7 @@
     "html-webpack-plugin": "^5.6.0",
     "markdown-it": "^14.1.0",
     "mini-css-extract-plugin": "^2.7.7",
-    "nodecg-cli": "^8.6.8",
+    "nodecg": "^2.4.3",
     "npm-run-all": "^4.1.5",
     "sass": "~1.32",
     "sass-loader": "^12.6.0",

pnpm-lock.yaml

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "anyOf": [
+    {
+      "type": "number"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}

schemas/soloedBidID.json

@@ -37,6 +37,8 @@ import Vue from 'vue';
 import type { Store } from 'vuex';
 import { namespace } from 'vuex-class';
 import { Module, Mutation, VuexModule, getModule } from 'vuex-module-decorators';
+import { soloedBidID } from '@esa-layouts/extension/util/replicants';
+import { SoloedBidID } from '@esa-layouts/types/schemas/soloedBidID';
 
 const sc = new SpeedcontrolUtilBrowser(nodecg);
 
@@ -111,6 +113,7 @@ export const reps: {
   runDataActiveRunSurrounding: sc.runDataActiveRunSurrounding,
   runDataArray: sc.runDataArray,
   serverTimestamp: nodecg.Replicant('serverTimestamp'),
+  soloedBidID: nodecg.Replicant('soloedBidID'),
   streamDeckData: nodecg.Replicant('streamDeckData'),
   timer: sc.timer,
   ttsVoices: nodecg.Replicant('ttsVoices'),
@@ -151,6 +154,7 @@ export interface ReplicantTypes {
   runDataActiveRunSurrounding: RunDataActiveRunSurrounding;
   runDataArray: RunDataArray;
   serverTimestamp: ServerTimestamp;
+  soloedBidID: SoloedBidID;
   streamDeckData: StreamDeckData;
   timer: Timer;
   ttsVoices: TtsVoices;

src/browser_shared/replicant_store.ts

@@ -15,13 +15,20 @@
       <template v-if="isPinned">mdi-pin-off</template>
       <template v-else>mdi-pin</template>
     </v-icon>
+    <v-spacer />
+    <v-btn elevation="2" :color="isSoloed ? 'warning' : ''" @click="toggleSolo">
+      <v-icon>
+        <template v-if="isSoloed">mdi-crosshairs-gps</template>
+        <template v-else>mdi-crosshairs</template>
+      </v-icon>
+    </v-btn>
   </media-card>
 </template>
 
 <script lang="ts">
 import { Vue, Component, Prop } from 'vue-property-decorator';
 import MediaCard from '@esa-layouts/dashboard/_misc/components/MediaCard.vue';
-import { Bids, Omnibar } from '@esa-layouts/types/schemas';
+import { Bids, Omnibar, SoloedBidID } from '@esa-layouts/types/schemas';
 import { replicantNS } from '@esa-layouts/browser_shared/replicant_store';
 import { storeModule } from '../store';
 
@@ -34,13 +41,26 @@ export default class extends Vue {
   @Prop({ type: Object, required: true }) readonly bid!: Bids[0];
   @Prop({ type: Number, required: true }) readonly index!: number;
   @replicantNS.State((s) => s.reps.omnibar.pin) readonly currentPin!: Omnibar['pin'];
+  @replicantNS.State((s) => s.reps.soloedBidID) readonly soloedBidID!: SoloedBidID;
 
   get isPinned(): boolean {
     return this.currentPin?.type === 'Bid' && this.currentPin.id === this.bid.id;
   }
 
+  get isSoloed(): boolean {
+    return this.soloedBidID === this.bid.id;
+  }
+
   pin(): void {
     storeModule.pinItem({ id: this.bid.id, pinned: !this.isPinned });
   }
+
+  toggleSolo(): void {
+    if (this.isSoloed) {
+      storeModule.clearSolo();
+    } else {
+      storeModule.setSolo(this.bid.id);
+    }
+  }
 }
 </script>

src/dashboard/bids/components/Bid.vue

@@ -1,5 +1,5 @@
 import { replicantModule, ReplicantModule, ReplicantTypes } from '@esa-layouts/browser_shared/replicant_store';
-import { Omnibar } from '@esa-layouts/types/schemas';
+import { Omnibar, SoloedBidID } from '@esa-layouts/types/schemas';
 import Vue from 'vue';
 import Vuex, { Store } from 'vuex';
 import { getModule, Module, Mutation, VuexModule } from 'vuex-module-decorators';
@@ -20,6 +20,22 @@ class OurModule extends VuexModule {
       val: { ...replicantModule.repsTyped.omnibar, pin: pinned ? { type: 'Bid', id } : null },
     });
   }
+
+  @Mutation
+  setSolo(id: number): void {
+    replicantModule.setReplicant<SoloedBidID>({
+      name: 'soloedBidID',
+      val: id,
+    });
+  }
+
+  @Mutation
+  clearSolo(): void {
+    replicantModule.setReplicant<SoloedBidID>({
+      name: 'soloedBidID',
+      val: null,
+    });
+  }
 }
 
 const store = new Store({

src/dashboard/bids/store.ts

@@ -8,7 +8,15 @@ import { v4 as uuid } from 'uuid';
 import { get as nodecg } from './util/nodecg';
 import obs from './util/obs';
 import { mq } from './util/rabbitmq';
-import { assetsDonationAlertAssets, bids, donationAlerts, donationTotalMilestones, omnibar, prizes } from './util/replicants';
+import {
+  assetsDonationAlertAssets,
+  bids,
+  donationAlerts,
+  donationTotalMilestones,
+  omnibar,
+  prizes,
+  soloedBidID,
+} from './util/replicants';
 import { sc } from './util/speedcontrol';
 
 const config = nodecg().bundleConfig;
@@ -20,6 +28,7 @@ function filterUpcomingRuns(run: RunData): boolean {
 
 // Gets next upcoming run from the cache (after refilling it if needed).
 let upcomingRunsCache: RunData[] = [];
+
 function getUpcomingRun(): RunData | undefined {
   // Filter out any already passed runs (according to schedule) from cache.
   upcomingRunsCache = upcomingRunsCache.filter(filterUpcomingRuns);
@@ -38,6 +47,7 @@ function filterPrizes(prize: Prizes[0]): boolean {
 
 // Gets next currently active prize from the cache (after refilling it if needed).
 let prizesCache: Prizes = [];
+
 function getPrize(): Prizes[0] | undefined {
   // Filter out any currently inactive prizes from cache.
   prizesCache = prizesCache.filter(filterPrizes);
@@ -54,6 +64,20 @@ let lastBidId = -1;
 function getClonedBid(): Bids[0] | undefined {
   // Just return nothing if there are no bids to show.
   if (!bids.value.length) return undefined;
+
+  // if we have a solo, show that one
+  if (soloedBidID.value) {
+    const soloedBid = clone(bids.value).find((b) => b.id === soloedBidID.value);
+
+    // Make sure the bid id actually exists.
+    if (soloedBid) {
+      return soloedBid;
+    }
+
+    // remove the solo if the bid was deleted
+    soloedBidID.value = null;
+  }
+
   let filtered = clone(bids.value).filter((b) => b.id !== lastBidId);
   if (!filtered.length) filtered = clone(bids.value);
   const choices = filtered.reduce<{ bid: Bids[0], cumulativeWeight: number }[]>((prev, bid) => {
@@ -75,6 +99,7 @@ function getClonedBid(): Bids[0] | undefined {
 
 // Gets a random active milestone.
 let lastMilestoneId = '';
+
 function getMilestone(): DonationTotalMilestones[0] | undefined {
   const active = clone(donationTotalMilestones.value).filter((m) => m.enabled && m.amount);
   // Just return nothing if there are no active milestones to show.
@@ -88,6 +113,7 @@ function getMilestone(): DonationTotalMilestones[0] | undefined {
 }
 
 let loopsWithoutResult = 0;
+
 async function showNext(): Promise<void> {
   // If there is a pin to start showing.
   const { pin } = omnibar.value;
@@ -130,7 +156,7 @@ async function showNext(): Promise<void> {
       omnibar.value.pin = null;
       // showNext(); This is done in the "omnibar" replicant change listener
     }
-  // If there is alerts in the queue to show.
+    // If there is alerts in the queue to show.
   } else if (omnibar.value.alertQueue.length) {
     const alert = omnibar.value.alertQueue.shift();
     if (alert) {
@@ -176,9 +202,15 @@ async function showNext(): Promise<void> {
     loopsWithoutResult += 1;
     if (next.type === 'UpcomingRun') {
       const run = getUpcomingRun();
-      if (!run) { showNext(); return; }
-      omnibar.value.current = { ...next,
-        props: { ...next.props,
+      if (!run) {
+        showNext();
+        return;
+      }
+
+      omnibar.value.current = {
+        ...next,
+        props: {
+          ...next.props,
           run,
           dash: {
             text: 'Up next',
@@ -190,13 +222,23 @@ async function showNext(): Promise<void> {
       };
     } else if (next.type === 'Prize') {
       const prize = getPrize();
-      if (!prize) { showNext(); return; }
+      if (!prize) {
+        showNext();
+        return;
+      }
+
       omnibar.value.current = { ...next, props: { ...next.props, prize } };
     } else if (next.type === 'Milestone') {
       const milestone = getMilestone();
-      if (!milestone) { showNext(); return; }
-      omnibar.value.current = { ...next,
-        props: { ...next.props,
+      if (!milestone) {
+        showNext();
+        return;
+      }
+
+      omnibar.value.current = {
+        ...next,
+        props: {
+          ...next.props,
           milestone,
           dash: {
             text: 'Upcoming Milestone',
@@ -207,8 +249,14 @@ async function showNext(): Promise<void> {
       };
     } else if (next.type === 'Bid') {
       const bid = getClonedBid();
-      if (!bid) { showNext(); return; }
-      omnibar.value.current = { ...next,
+
+      if (!bid) {
+        showNext();
+        return;
+      }
+
+      omnibar.value.current = {
+        ...next,
         props: {
           ...next.props,
           bid,
@@ -249,8 +297,8 @@ omnibar.on('change', (newVal, oldVal) => {
   // If nothing is currently being shown, and the rotation is filled from being empty,
   // or we get alerts in the queue, trigger the cycle to start up again.
   if (!newVal.current && oldVal
-  && ((newVal.rotation.length && !oldVal.rotation.length)
-  || (newVal.alertQueue.length && !oldVal.alertQueue.length))) {
+    && ((newVal.rotation.length && !oldVal.rotation.length)
+      || (newVal.alertQueue.length && !oldVal.alertQueue.length))) {
     showNext();
   }
 
@@ -304,7 +352,7 @@ nodecg().listenFor('omnibarPlaySound', async (data: { amount?: number } | undefi
             sourceName: config.obs.names.sources.donationSound,
           });
           nodecg().log.debug('[Omnibar] omnibarPlaySound media restarted');
-        // If different, explicitily set it. This also starts the playback.
+          // If different, explicitily set it. This also starts the playback.
         } else {
           await obs.conn.send('SetSourceSettings', {
             sourceName: config.obs.names.sources.donationSound,

src/extension/omnibar.ts

@@ -30,7 +30,7 @@ function processRawBids(rawBids: Tracker.Bid[]): Tracker.FormattedBid[] {
         name: bid.fields.name,
         total: parseFloat(bid.fields.total),
         game: bid.fields.speedrun__name,
-        category: bid.fields.speedrun__category,
+        category: bid.fields.speedrun__category || '',
         endTime: bid.fields.speedrun__endtime
           ? Date.parse(bid.fields.speedrun__endtime) : undefined,
         war: !bid.fields.istarget,

src/extension/tracker/bids.ts

@@ -5,11 +5,14 @@ import {
   BigbuttonPlayerMap,
   CapturePositions,
   Commentators,
-  CommentatorsNew, Countdown,
+  CommentatorsNew,
+  Countdown,
   CurrentRunDelay,
   DelayedTimer,
-  DonationAlerts, DonationReader,
-  DonationReaderNew, DonationsToRead,
+  DonationAlerts,
+  DonationReader,
+  DonationReaderNew,
+  DonationsToRead,
   DonationTotal,
   DonationTotalMilestones,
   GameLayouts,
@@ -25,13 +28,15 @@ import {
   ReaderIntroduction,
   ServerTimestamp,
   StreamDeckData,
-  TaskmasterTimestamps, TtsVoices,
+  TaskmasterTimestamps,
+  TtsVoices,
   UpcomingRunID,
   VideoPlayer,
 } from '@esa-layouts/types/schemas';
 import type NodeCGTypes from '@nodecg/types';
 import { HoraroImportStatus, OengusImportStatus, TwitchAPIData, TwitchChannelInfo } from 'speedcontrol-util/types/schemas';
 import { get as nodecg } from './nodecg';
+import { SoloedBidID } from '@esa-layouts/types/schemas/soloedBidID';
 
 /**
  * This is where you can declare all your replicant to import easily into other files,
@@ -71,6 +76,7 @@ export const otherStreamData = nodecg().Replicant<OtherStreamData>('otherStreamD
 export const prizes = nodecg().Replicant<Prizes>('prizes', { persistent: false }) as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<Prizes>;
 export const readerIntroduction = nodecg().Replicant<ReaderIntroduction>('readerIntroduction') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<ReaderIntroduction>;
 export const serverTimestamp = nodecg().Replicant<ServerTimestamp>('serverTimestamp') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<ServerTimestamp>;
+export const soloedBidID = nodecg().Replicant<SoloedBidID>('soloedBidID') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<SoloedBidID>;
 export const streamDeckData = nodecg().Replicant<StreamDeckData>('streamDeckData') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<StreamDeckData>;
 export const taskmasterTimestamps = nodecg().Replicant<TaskmasterTimestamps>('taskmasterTimestamps') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<TaskmasterTimestamps>;
 export const ttsVoices = nodecg().Replicant<TtsVoices>('ttsVoices') as unknown as NodeCGTypes.ServerReplicantWithSchemaDefault<TtsVoices>;

src/extension/util/replicants.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/additionalDonations.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/bids.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/bigbuttonPlayerMap.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/capturePositions.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/commentators.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/commentatorsNew.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/configschema.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/countdown.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/currentRunDelay.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.

src/types/schemas/delayedTimer.d.ts

@@ -1,3 +1,4 @@
+/* prettier-ignore */
 /* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.