@crowbartools/firebot-types 5.67.0-alpha17 → 5.67.0-alpha18

package/backend/scripts/executors/script-executor.interface.d.ts

@@ -1,4 +1,4 @@
-import { InstalledPluginConfig, LegacyCustomScript, ScriptBase, ScriptContext, Awaitable, ScriptDetails, AdditionalVariableEvent } from "../../../types";
+import { InstalledPluginConfig, LegacyCustomScript, ScriptBase, ScriptContext, Awaitable, ScriptDetails, AdditionalVariableEvent, AdditionalEffectEvent } from "../../../types";
 import type { ScriptApiContext } from "../script-api";
 declare abstract class IBaseScriptExecutor {
     abstract canHandle(script: ScriptBase | LegacyCustomScript): Awaitable<boolean>;
@@ -7,7 +7,6 @@ declare abstract class IBaseScriptExecutor {
 export interface PluginRegistrations {
     effectIds?: string[];
     variableHandles?: string[];
-    additionalVariableEvents?: AdditionalVariableEvent[];
     eventSourceIds?: string[];
     filterIds?: string[];
     systemCommandIds?: string[];
@@ -18,6 +17,8 @@ export interface PluginRegistrations {
     overlayWidgetIds?: string[];
     httpRoutePrefix?: string;
     websocketListenerName?: string;
+    additionalVariableEvents?: AdditionalVariableEvent[];
+    additionalEffectEvents?: AdditionalEffectEvent[];
 }
 export type PluginExecutionResult = {
     success: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha17",
+  "version": "5.67.0-alpha18",
   "description": "Type definitions and script API for Firebot plugins and custom scripts.",
   "main": "index.js",
   "types": "index.d.ts",

package/types/effects.d.ts

@@ -1,6 +1,7 @@
 import ng from "angular";
 import type { TriggerType, TriggersObject, Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
+import { EventSourceAndId } from "./events";
 type Func<T> = (...args: unknown[]) => T;
 export interface EffectScope<EffectModel> extends ng.IScope {
     effect: EffectModel;
@@ -187,4 +188,13 @@ export type QueueState = {
     mode: QueueMode;
     runEffectsImmediatelyWhenPaused?: boolean;
 };
+export type AdditionalEffectEvent = {
+    effectId: string;
+    eventSourceId: string;
+    eventId: string;
+};
+export type PluginAdditionalEffectEvents = {
+    effectId: string;
+    events: EventSourceAndId[];
+};
 export {};

package/types/plugins.d.ts

@@ -1,7 +1,7 @@
-import type { EffectInstance, EffectList, EffectType } from "./effects";
+import type { EffectInstance, EffectList, EffectType, PluginAdditionalEffectEvents } from "./effects";
 import type { Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
-import type { PluginAdditonalVariableEvents, ReplaceVariable } from "./variables";
+import type { PluginAdditionalVariableEvents, ReplaceVariable } from "./variables";
 import type { EventFilter, EventSource } from "./events";
 import type { SystemCommand } from "./commands";
 import type { RestrictionType } from "./restrictions";
@@ -119,7 +119,6 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
         effects?: DynamicArray<EffectType<any, any>>;
         eventSources?: DynamicArray<EventSource>;
         variables?: DynamicArray<ReplaceVariable>;
-        additionalVariableEvents?: DynamicArray<PluginAdditonalVariableEvents>;
         integrations?: DynamicArray<Integration<any>>;
         filters?: DynamicArray<EventFilter>;
         restrictions?: DynamicArray<RestrictionType<any>>;
@@ -130,6 +129,8 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
         httpRoutes?: DynamicObject<PluginHttpRouteDefinition>;
         websocketListener?: DynamicObject<CustomWebSocketHandler>;
         webhooks?: DynamicObject<PluginWebhooks>;
+        additionalEffectEvents?: DynamicArray<PluginAdditionalEffectEvents>;
+        additionalVariableEvents?: DynamicArray<PluginAdditionalVariableEvents>;
     };
     /** Called when the plugin is loaded */
     onLoad?: (context: ScriptContext<Params>, isInstalling?: boolean) => NoResult;

package/types/script-api.d.ts

@@ -65,13 +65,6 @@ export interface ScriptEventsApi {
     trigger(sourceId: string, eventId: string, meta?: Record<string, unknown>): Promise<void>;
 }
 export interface ScriptEffectsApi {
-    /**
-     * Register an existing effect to be available for an event.
-     * Useful for surfacing built-in effects on script provided events.
-     */
-    addEventToEffect(effectId: string, eventSourceId: string, eventId: string): void;
-    /** Reverse of `addEventToEffect`. */
-    removeEventFromEffect(effectId: string, eventSourceId: string, eventId: string): void;
     /**
      * Run an effect list. Respects the list's run mode and effect queue, if any.
      * Resolves once the effects have been run (queued lists resolve

package/types/variables.d.ts

@@ -49,7 +49,7 @@ export type AdditionalVariableEvent = {
     eventSourceId: string;
     eventId: string;
 };
-export type PluginAdditonalVariableEvents = {
+export type PluginAdditionalVariableEvents = {
     handle: string;
     events: Array<EventSourceAndId>;
 };