feat(plugin): add support for compound events

Author: feildmaster

src/base/api/utils.js

@@ -12,7 +12,6 @@ import some from '../../utils/some.js';
 import TabManager from '../../utils/tabbedView.js';
 import rand from '../../utils/rand.js';
 import SettingType from '../../utils/settings/types/setting.js';
-import compound from '../../utils/compoundEvent.js';
 
 const utils = api.mod.utils;
 
@@ -39,4 +38,3 @@ utils.tabManager = TabManager;
 utils.VarStore = VarStore;
 utils.rand = rand;
 utils.SettingType = SettingType;
-utils.compoundEvent = compound;

src/base/plugin/events.js

@@ -2,38 +2,49 @@ import eventManager from '../../utils/eventManager.js';
 import wrap from '../../utils/2.pokemon.js';
 import { registerModule } from '../../utils/plugin.js';
 import { capturePluginError } from '../../utils/sentry.js';
+import compoundEvent from '../../utils/compoundEvent.js';
 
 wrap(() => {
   const options = ['cancelable', 'canceled', 'singleton', 'async'];
 
   const name = 'events';
   function mod(plugin) {
+    function wrapper(fn, event) {
+      function listener(...args) {
+        try {
+          fn.call(this, ...args);
+        } catch (e) {
+          capturePluginError(plugin, e, {
+            args,
+            ...this,
+          });
+          plugin.logger.error(`Event error (${event}):\n`, e, '\n', JSON.stringify({
+            args,
+            event: this,
+          }));
+        }
+      }
+      listener.plugin = plugin;
+      return listener;
+    }
     const obj = {
       ...eventManager,
-      on(event = '', fn) {
+      compound(...events) {
+        const fn = events.pop();
         if (typeof fn !== 'function') throw new Error('Must pass a function');
+        if (!events.length) throw new Error('Must pass events');
+        if (events.length === 1) throw new Error('Use `events.on` for single events');
 
-        function pluginListener(...args) {
-          try {
-            fn.call(this, ...args);
-          } catch (e) {
-            capturePluginError(plugin, e, {
-              args,
-              ...this,
-            });
-            plugin.logger.error(`Event error (${event}):\n`, e, '\n', JSON.stringify({
-              args,
-              event: this,
-            }));
-          }
-        }
-        pluginListener.plugin = plugin;
+        compoundEvent(...events, wrapper(fn, `Compound[${events.join(';')}]`));
+      },
+      on(event, fn) {
+        if (typeof fn !== 'function') throw new Error('Must pass a function');
 
         if (event.split(' ').includes(':loaded')) {
           plugin.logger.warn('Event manager: `:loaded` is deprecated, ask author to update to `:preload`!');
         }
 
-        eventManager.on.call(obj, event, pluginListener);
+        eventManager.on.call(obj, event, wrapper(fn, event));
       },
       emit(...args) {
         return eventManager.emit(...args);

src/utils/compoundEvent.js

@@ -8,11 +8,13 @@ export default function compound(...events) {
   let triggered = 0;
   // TODO: cache data
   function trigger(event, ...data) {
-    if (cache[event].triggered) return;
-    cache[event].triggered = this.singleton ? 'singleton' : true;
-    triggered += 1;
+    if (!cache[event].triggered) {
+      cache[event].triggered = this.singleton ? 'singleton' : true;
+      triggered += 1;
+    }
 
-    if (triggered === events.length) {
+    if (triggered >= events.length) {
+      console.log('triggered');
       events.forEach((ev) => {
         const e = cache[ev];
         // Only reset if not singleton