@crowbartools/firebot-types 5.67.0-alpha19 → 5.67.0-alpha20

package/types/control-deck.d.ts

@@ -0,0 +1,146 @@
+import type { EffectList } from "./effects";
+/**
+ * Reserved page id for the "Pinned" shadow page. Buttons with this pageId are
+ * replicated onto every real page (unless a page button overrides the slot)
+ */
+export declare const CONTROL_DECK_PINNED_PAGE_ID = "pinned";
+export type ControlDeckControlType = "button" | "folder";
+/** An image icon — either a local file path or a URL. */
+export type ControlDeckImageIcon = {
+    type: "image";
+    /** Whether `path` is a local file path or a URL */
+    source: "local" | "url";
+    /** Local file path (source "local") or URL (source "url") */
+    path: string;
+};
+/** A Lucide icon referenced by name. */
+export type ControlDeckGlyphIcon = {
+    type: "glyph";
+    /** The Lucide icon name */
+    name: string;
+    /** Optional CSS color; defaults to the control's text color */
+    color?: string;
+};
+export type ControlDeckNoneIcon = {
+    type: "none";
+};
+/** An emoji icon referenced by its unicode character. */
+export type ControlDeckEmojiIcon = {
+    type: "emoji";
+    /** The emoji character (eg "🔥") */
+    emoji: string;
+};
+export type ControlDeckIcon = ControlDeckImageIcon | ControlDeckGlyphIcon | ControlDeckEmojiIcon | ControlDeckNoneIcon;
+export type ControlDeckInputType = "text" | "number" | "toggle" | "preset";
+type ControlDeckInputBase = {
+    /** Unique name of the input, used to access the value in effects */
+    name: string;
+    description?: string;
+};
+export type ControlDeckTextInput = ControlDeckInputBase & {
+    type: "text";
+};
+export type ControlDeckNumberInput = ControlDeckInputBase & {
+    type: "number";
+};
+export type ControlDeckToggleInput = ControlDeckInputBase & {
+    type: "toggle";
+};
+export type ControlDeckPresetInput = ControlDeckInputBase & {
+    type: "preset";
+    options: string[];
+};
+export type ControlDeckUserInput = ControlDeckInputBase & {
+    type: "user";
+};
+export type ControlDeckControlInput = ControlDeckTextInput | ControlDeckNumberInput | ControlDeckToggleInput | ControlDeckPresetInput | ControlDeckUserInput;
+export type ControlDeckControlPosition = {
+    col: number;
+    row: number;
+};
+export type ControlDeckControlSize = {
+    /** Number of grid columns the control spans (default 1) */
+    width: number;
+    /** Number of grid rows the control spans (default 1) */
+    height: number;
+};
+export type ControlDeckControl = {
+    id: string;
+    name: string;
+    type: ControlDeckControlType;
+    /** The page this control belongs to */
+    pageId: string;
+    /** The parent folder control id, or null when placed at the page root */
+    parentId: string | null;
+    /** The icon shown on the control */
+    icon: ControlDeckIcon;
+    backgroundColor?: string;
+    /** Placement within the deck's grid */
+    position?: ControlDeckControlPosition;
+    /** How many grid cells the control spans (default 1x1) */
+    size?: ControlDeckControlSize;
+    /** Effects to run when the control is pressed. Only used when type is "button" */
+    effectList?: EffectList;
+    /**
+     * Inputs the user is prompted for when the control is pressed on the hosted
+     * page. The provided values are sent with the press and are available to
+     * effects via $controlDeckInput
+     */
+    inputs?: ControlDeckControlInput[];
+    /**
+     * Whether a folder control should automatically return to the parent page after a button within it is pressed. Only used when type is "folder".
+     */
+    autoReturn?: boolean;
+};
+export type ControlDeckGrid = {
+    cols: number;
+    rows: number;
+};
+export type ControlDeckPage = {
+    id: string;
+    name: string;
+};
+export type ControlDeck = {
+    id: string;
+    name: string;
+    grid: ControlDeckGrid;
+    /** Ordered list of pages. A deck always has at least one page. */
+    pages: ControlDeckPage[];
+    controls: ControlDeckControl[];
+};
+export type ControlDeckOrientationMode = "dynamic" | "fixed";
+export type ControlDeckSettings = {
+    enabled: boolean;
+    /** Optional global PIN required to access the hosted page and trigger controls */
+    pin?: string;
+    /**
+     * How the hosted grid responds to device rotation.
+     * - "fixed": grid keeps its designed dimensions regardless of orientation
+     * - "dynamic": grid rotates to best fill the screen for the current orientation
+     */
+    orientationMode?: ControlDeckOrientationMode;
+};
+export type ControlDeckResolvedIcon = {
+    type: "image";
+    url: string;
+} | {
+    type: "glyph";
+    name: string;
+    color?: string;
+} | {
+    type: "emoji";
+    emoji: string;
+};
+/**
+ * A control as projected to the hosted Control Deck page. Server-only fields
+ * (the raw effect list and local icon path) are removed, and the resolved
+ * `icon` the page should render is added.
+ */
+export type ControlDeckControlView = Omit<ControlDeckControl, "icon" | "effectList"> & {
+    icon?: ControlDeckResolvedIcon;
+};
+/** A deck as projected to the hosted Control Deck page. */
+export type ControlDeckView = Omit<ControlDeck, "controls"> & {
+    controls: ControlDeckControlView[];
+};
+export {};

package/types/index.d.ts

@@ -3,6 +3,7 @@ export * from "./auth";
 export * from "./channel-rewards";
 export * from "./chat";
 export * from "./commands";
+export * from "./control-deck";
 export * from "./counters";
 export * from "./currency";
 export * from "./discord";

package/types/notifications.d.ts

@@ -1,4 +1,4 @@
-export type NotificationSource = "external" | "internal" | "script";
+export type NotificationSource = "external" | "internal" | "plugin";
 export type NotificationType = "info" | "tip" | "update" | "alert";
 export type ExternalNotification = {
     id: string;
@@ -11,7 +11,7 @@ export type NotificationBase = {
     message: string;
     type: NotificationType;
     source?: NotificationSource;
-    scriptName?: string;
+    pluginName?: string;
     externalId?: string;
     metadata?: Record<string, unknown>;
 };

package/types/{script-api.d.ts → plugin-api.d.ts}

@@ -8,28 +8,28 @@ import type { InstalledPlugin } from "./plugins";
 import type { PluginWebhook } from "./webhooks";
 import type { ReplaceVariable, VariableConfig } from "./variables";
 import type { FilterConfig, PresetFilterConfig, TextFilterConfig } from "../backend/events/filters/filter-factory";
-export type ScriptLogMethod = (message: string, ...meta: unknown[]) => void;
-export interface ScriptLoggerApi {
-    debug: ScriptLogMethod;
-    info: ScriptLogMethod;
-    warn: ScriptLogMethod;
-    error: ScriptLogMethod;
-}
-export interface ScriptWebhooksApi {
+export type PluginLogMethod = (message: string, ...meta: unknown[]) => void;
+export interface PluginLoggerApi {
+    debug: PluginLogMethod;
+    info: PluginLogMethod;
+    warn: PluginLogMethod;
+    error: PluginLogMethod;
+}
+export interface PluginWebhooksApi {
     /** Look up a webhook by name. */
     get(name: string): PluginWebhook | null;
-    /** All webhooks owned by this script. */
+    /** All webhooks owned by this plugin. */
     list(): PluginWebhook[];
     /** Public URL for a webhook by name, or null if not found. */
     getUrl(name: string): string | null;
 }
 /**
- * Simple per-script storage scoped to the script's data directory.
+ * Simple per-plugin storage scoped to the plugin's data directory.
  * Provides helpers for storing/loading JSON values
  * plus generic file read/write for anything else.
  */
-export interface ScriptStorageApi {
-    /** Absolute path to this script's data directory. */
+export interface PluginStorageApi {
+    /** Absolute path to this plugin's data directory. */
     readonly path: string;
     /** Save a value as JSON under the given key. The key becomes the filename with a `.json` extension. */
     setJson(key: string, value: unknown): Promise<void>;
@@ -51,19 +51,19 @@ export interface ScriptStorageApi {
     /** Delete a file. No-op if it doesn't exist. */
     deleteFile(name: string): Promise<void>;
 }
-export type ScriptEventHandler = (event: TriggeredEvent) => void;
-export interface ScriptEventsApi {
+export type PluginEventHandler = (event: TriggeredEvent) => void;
+export interface PluginEventsApi {
     /**
      * Subscribe to all Firebot events as they trigger. Returns an `unsubscribe`
      * function.
      */
-    onTriggered(handler: ScriptEventHandler): () => void;
+    onTriggered(handler: PluginEventHandler): () => void;
     /**
      * Manually trigger a Firebot event.
      */
     trigger(sourceId: string, eventId: string, meta?: Record<string, unknown>): Promise<void>;
 }
-export interface ScriptEffectsApi {
+export interface PluginEffectsApi {
     /**
      * 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
@@ -71,7 +71,7 @@ export interface ScriptEffectsApi {
      */
     processEffects(context: RunEffectsContext): Promise<unknown>;
 }
-export interface ScriptTwitchApi {
+export interface PluginTwitchApi {
     /** The full Twitch API surface. See {@linkcode TwitchApi}. */
     api: typeof TwitchApi;
 }
@@ -79,25 +79,25 @@ export interface ScriptTwitchApi {
  * Access to this plugin's saved parameter values (the settings configured by
  * the user)
  */
-export interface ScriptParametersApi {
+export interface PluginParametersApi {
     getAll<T extends Record<string, unknown> = Record<string, unknown>>(): T;
 }
-export interface ScriptNotificationsApi {
+export interface PluginNotificationsApi {
     /**
      * Create a new notification. Pass `permanentlySave` as `true` to persist it
      * across restarts.
      */
     add(notification: Pick<Notification, "title" | "message" | "type" | "metadata">, permanentlySave?: boolean): Notification;
-    /** Look up one of this script's notifications by id. */
+    /** Look up one of this plugin's notifications by id. */
     get(id: string): Notification | null;
-    /** All notifications owned by this script. */
+    /** All notifications owned by this plugin. */
     getAll(): Notification[];
-    /** Delete one of this script's notifications by id. */
+    /** Delete one of this plugin's notifications by id. */
     delete(id: string): void;
-    /** Delete all of this script's notifications. */
+    /** Delete all of this plugin's notifications. */
     clearAll(): void;
 }
-export interface ScriptFrontendCommunicatorApi {
+export interface PluginFrontendCommunicatorApi {
     /** Send a synchronous event to the frontend. */
     send<ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): void;
     /**
@@ -116,7 +116,7 @@ export interface ScriptFrontendCommunicatorApi {
      */
     onAsync<ExpectedArgs extends Array<unknown> = [], ReturnPayload = void>(eventName: string, callback: (...args: ExpectedArgs) => Promise<ReturnPayload>): () => void;
 }
-export interface ScriptSettingsApi {
+export interface PluginSettingsApi {
     /**
      * Get a Firebot setting value or its default
      *
@@ -125,7 +125,7 @@ export interface ScriptSettingsApi {
      */
     getSetting<SettingName extends keyof FirebotSettingsTypes>(settingName: SettingName): FirebotSettingsTypes[SettingName];
 }
-export interface ScriptPluginsApi {
+export interface PluginPluginsApi {
     /**
      * Get a list of currently installed plugins installed by the user
      */
@@ -135,7 +135,7 @@ export interface Accounts {
     streamer: FirebotAccount;
     bot: FirebotAccount;
 }
-export interface ScriptWebServerApi {
+export interface PluginWebServerApi {
     /**
      * Sends a custom event over the internal Firebot WebSocket server
      * @param name Name of the event to send. Full event name will be `custom-event:{name}`
@@ -143,46 +143,46 @@ export interface ScriptWebServerApi {
      */
     sendWebSocketEvent(name: string, data?: unknown): any;
 }
-export interface ScriptVariableFactoryApi {
+export interface PluginVariableFactoryApi {
     createEventDataVariable(config: VariableConfig): ReplaceVariable;
 }
-export interface ScriptEventFilterFactoryApi {
+export interface PluginEventFilterFactoryApi {
     createTextFilter(config: TextFilterConfig): EventFilter;
     createNumberFilter(config: FilterConfig): EventFilter;
     createTextOrNumberFilter(config: TextFilterConfig): EventFilter;
     createPresetFilter(config: PresetFilterConfig): EventFilter;
 }
-export interface FirebotScriptApi {
+export interface FirebotPluginApi {
     /** Running Firebot version, e.g. `"5.67.0"`. */
     version: string;
     /** The streamer and bot accounts currently in use. */
     accounts: Accounts;
     /** Scoped logger. */
-    logger: ScriptLoggerApi;
+    logger: PluginLoggerApi;
     /** Access to Firebot settings. */
-    settings: ScriptSettingsApi;
-    /** Webhooks owned by this script. */
-    webhooks: ScriptWebhooksApi;
-    /** Simple persistent storage rooted at this script's data directory. */
-    storage: ScriptStorageApi;
+    settings: PluginSettingsApi;
+    /** Webhooks owned by this plugin. */
+    webhooks: PluginWebhooksApi;
+    /** Simple persistent storage rooted at this plugin's data directory. */
+    storage: PluginStorageApi;
     /** Subscribe to and trigger Firebot events + register event sources. */
-    events: ScriptEventsApi;
+    events: PluginEventsApi;
     /** Run effect lists. */
-    effects: ScriptEffectsApi;
+    effects: PluginEffectsApi;
     /** Access to Firebot's Twitch API wrappers (Helix, chat, auth, etc). */
-    twitch: ScriptTwitchApi;
+    twitch: PluginTwitchApi;
     /** This plugin's saved parameter values. */
-    parameters: ScriptParametersApi;
-    /** Two-way messaging between the script and the frontend. */
-    frontendCommunicator: ScriptFrontendCommunicatorApi;
-    /** Notifications owned by this script. */
-    notifications: ScriptNotificationsApi;
+    parameters: PluginParametersApi;
+    /** Two-way messaging between the plugin and the frontend. */
+    frontendCommunicator: PluginFrontendCommunicatorApi;
+    /** Notifications owned by this plugin. */
+    notifications: PluginNotificationsApi;
     /** Access to installed plugins. */
-    plugins: ScriptPluginsApi;
+    plugins: PluginPluginsApi;
     /** Firebot internal web server functions. */
-    webServer: ScriptWebServerApi;
+    webServer: PluginWebServerApi;
     /** Factory for creating variables based on event data. */
-    variableFactory: ScriptVariableFactoryApi;
+    variableFactory: PluginVariableFactoryApi;
     /** Factory for creating event filters. */
-    eventFilterFactory: ScriptEventFilterFactoryApi;
+    eventFilterFactory: PluginEventFilterFactoryApi;
 }

package/types/plugins.d.ts

@@ -1,4 +1,4 @@
-import type { EffectInstance, EffectList, EffectType, PluginAdditionalEffectEvents } from "./effects";
+import type { EffectType, PluginAdditionalEffectEvents } from "./effects";
 import type { Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
 import type { PluginAdditionalVariableEvents, ReplaceVariable } from "./variables";
@@ -22,13 +22,13 @@ export type InstalledPluginConfig<Params extends GenericParameters = GenericPara
     legacyImport?: boolean;
     parameters: Params;
 };
-export type ScriptContext<Params extends FirebotParams = FirebotParams> = {
+export type PluginContext<Params extends FirebotParams = FirebotParams> = {
     trigger?: Trigger;
     parameters: Params;
 };
-type DynamicObject<T> = T | ((context: ScriptContext) => Awaitable<T>);
-type DynamicArray<T> = Array<T | ((context: ScriptContext) => Awaitable<T>)>;
-export type ScriptType = "script" | "plugin";
+type DynamicObject<T> = T | ((context: PluginContext) => Awaitable<T>);
+type DynamicArray<T> = Array<T | ((context: PluginContext) => Awaitable<T>)>;
+export type PluginType = "script" | "plugin";
 interface ManifestDescription {
     short: string;
     long?: string;
@@ -92,25 +92,15 @@ export interface Manifest {
      * allowing the plugin to provide custom parameter types that can be used in its own parametersSchema.
      */
     initBeforeShowingParams?: boolean;
-    type: ScriptType;
 }
-type EffectScriptResult = {
-    success: boolean;
-    errorMessage?: string;
-    effects?: EffectList | Array<EffectInstance>;
-    onEffectsDone?: () => Awaitable<void>;
-};
-export interface ScriptBase<Params extends FirebotParams = FirebotParams> {
+export interface PluginBase<Params extends FirebotParams = FirebotParams> {
     manifest: Manifest;
     parametersSchema?: FirebotParameterArray<Params>;
 }
-export interface EffectScript<Params extends FirebotParams = FirebotParams> extends ScriptBase<Params> {
-    run: (context: ScriptContext<Params>) => Awaitable<void | EffectScriptResult>;
-}
-export interface Plugin<Params extends FirebotParams = FirebotParams> extends ScriptBase<Params> {
+export interface Plugin<Params extends FirebotParams = FirebotParams> extends PluginBase<Params> {
     /**
      * Automatically handles registration with appropriate managers for definitions
-     * when the script is unloaded, definitions will automagically be unregistered.
+     * when the plugin is unloaded, definitions will automagically be unregistered.
      *
      * Array entries can be direct definitions or functions that return definitions
      * (or promises of definitions) for dynamic registration based on context (e.g. parameter values).
@@ -133,16 +123,16 @@ export interface Plugin<Params extends FirebotParams = FirebotParams> extends Sc
         additionalVariableEvents?: DynamicArray<PluginAdditionalVariableEvents>;
     };
     /** Called when the plugin is loaded */
-    onLoad?: (context: ScriptContext<Params>, isInstalling?: boolean) => NoResult;
+    onLoad?: (context: PluginContext<Params>, isInstalling?: boolean) => NoResult;
     /** Called when Firebot is closing or plugin is disabled / removed  */
-    onUnload?: (context: ScriptContext<Params>, isUninstalling?: boolean) => NoResult;
+    onUnload?: (context: PluginContext<Params>, isUninstalling?: boolean) => NoResult;
     /** Called when the user updates plugin-specific parameters */
-    onParameterUpdate?: (context: ScriptContext<Params>) => NoResult;
+    onParameterUpdate?: (context: PluginContext<Params>) => NoResult;
 }
-export type ScriptDetails = Pick<ScriptBase, "manifest" | "parametersSchema">;
+export type PluginDetails = Pick<PluginBase, "manifest" | "parametersSchema">;
 export type InstalledPlugin = {
     config: InstalledPluginConfig;
-    details: ScriptDetails;
+    details: PluginDetails;
 };
 type LegacyScriptParameters = Record<string, {
     type: any;
@@ -204,5 +194,5 @@ export type LegacyCustomScript = {
     parametersUpdated?: (parameters: Record<string, unknown>) => Awaitable<void>;
     stop?: () => Awaitable<void>;
 };
-export type FirebotScriptApi = import("./script-api").FirebotScriptApi;
-export type { ScriptLoggerApi, ScriptWebhooksApi } from "./script-api";
+export type FirebotPluginApi = import("./plugin-api").FirebotPluginApi;
+export type { PluginLoggerApi as PluginLoggerApi, PluginWebhooksApi as PluginWebhooksApi } from "./plugin-api";

package/types/settings.d.ts

@@ -57,6 +57,10 @@ export type FirebotSettingsTypes = {
     ClearChatFeedMode: "never" | "onlyStreamer" | "always";
     ClearCustomScriptCache: boolean;
     ConnectOnLaunch: boolean;
+    ControlDeckEnabled: boolean;
+    ControlDeckPin?: string;
+    ControlDeckOrientationMode: "dynamic" | "fixed";
+    ControlDeckDefaultDeckId?: string | null;
     CopiedOverlayVersion: string;
     DashboardLayout: {
         dashboardViewerList: string;

package/types/triggers.d.ts

@@ -1,6 +1,6 @@
 import type { FirebotChatMessage } from "./chat";
 import type { CommandDefinition, SubCommand } from "./commands";
-export type TriggerType = "command" | "custom_script" | "startup_script" | "api" | "event" | "hotkey" | "timer" | "scheduled_task" | "counter" | "preset" | "quick_action" | "manual" | "channel_reward" | "power_up" | "overlay_widget";
+export type TriggerType = "command" | "custom_script" | "startup_script" | "api" | "event" | "hotkey" | "timer" | "scheduled_task" | "counter" | "preset" | "quick_action" | "control_deck" | "manual" | "channel_reward" | "power_up" | "overlay_widget";
 export type TriggerMeta = {
     triggerId?: string;
     [x: string]: unknown;

package/types/ui/object-copy-helper.d.ts

@@ -5,4 +5,5 @@ export type ObjectCopyHelper = {
     getCopiedEffects: (trigger: TriggerType, triggerMeta: unknown) => Promise<EffectInstance[]>;
     hasCopiedEffects: () => boolean;
     cloneEffect: (effect: EffectInstance) => EffectInstance;
+    copyAndReplaceIds<T>(obj: T): T;
 };

package/backend/script-log-names.d.ts

@@ -1,3 +0,0 @@
-export declare function registerScriptLogName(scriptId: string, displayName: string): void;
-export declare function unregisterScriptLogName(scriptId: string): void;
-export declare function getScriptLogName(scriptId: string): string | undefined;

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

@@ -1,22 +0,0 @@
-import { ScriptBase, LegacyCustomScript, ScriptContext, ScriptDetails, EffectList } from "../../../types";
-import { IEffectScriptExecutor, EffectScriptExecutionResult } from "./script-executor.interface";
-/**
- * Executor for new-spec EffectScripts (manifest.type === "script")
- */
-export declare class EffectScriptExecutor extends IEffectScriptExecutor {
-    constructor();
-    canHandle(script: ScriptBase | LegacyCustomScript): boolean;
-    getScriptDetails(script: ScriptBase | LegacyCustomScript): ScriptDetails | null;
-    executeScript(script: ScriptBase | LegacyCustomScript, context: ScriptContext): Promise<EffectScriptExecutionResult>;
-    private isEffectScript;
-}
-/**
- * Runs effects returned by a custom script and returns flow-control flags.
- */
-export declare function runEffectsResult(effects: EffectList | Array<{
-    id?: string;
-    type?: string;
-}>, context: ScriptContext, onEffectsDone?: () => unknown): Promise<{
-    stop: boolean;
-    bubbleStop: boolean;
-} | undefined>;

package/backend/scripts/executors/legacy-effect-script-executor.d.ts

@@ -1,12 +0,0 @@
-import { ScriptBase, LegacyCustomScript, ScriptContext, ScriptDetails } from "../../../types";
-import { IEffectScriptExecutor, EffectScriptExecutionResult } from "./script-executor.interface";
-/**
- * Executor for legacy effect scripts (run function with no manifest or startupOnly !== true)
- */
-export declare class LegacyEffectScriptExecutor extends IEffectScriptExecutor {
-    constructor();
-    canHandle(script: ScriptBase | LegacyCustomScript): Promise<boolean>;
-    getScriptDetails(script: ScriptBase | LegacyCustomScript): Promise<ScriptDetails | null>;
-    executeScript(script: ScriptBase | LegacyCustomScript, context: ScriptContext): Promise<EffectScriptExecutionResult>;
-    private isLegacy;
-}

package/backend/scripts/executors/legacy-startup-script-executor.d.ts

@@ -1,15 +0,0 @@
-import { ScriptBase, LegacyCustomScript, InstalledPluginConfig, ScriptDetails } from "../../../types";
-import { IPluginExecutor, PluginExecutionResult } from "./script-executor.interface";
-/**
- * Executor for legacy startup scripts (scripts that export a getScriptManifest function that returns an object with startupOnly: true)
- */
-export declare class LegacyStartUpScript extends IPluginExecutor {
-    constructor();
-    canHandle(script: ScriptBase | LegacyCustomScript): Promise<boolean>;
-    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<PluginExecutionResult>;
-    unloadPlugin(script: ScriptBase | LegacyCustomScript): Promise<void>;
-    updateParameters(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
-    getScriptDetails(script: ScriptBase | LegacyCustomScript): Promise<ScriptDetails>;
-    private buildParameters;
-    private isLegacyScript;
-}

package/backend/scripts/executors/plugin-executor.d.ts

@@ -1,18 +0,0 @@
-import { ScriptBase, LegacyCustomScript, Plugin, InstalledPluginConfig, ScriptDetails } from "../../../types";
-import { IPluginExecutor, PluginRegistrations, PluginExecutionResult } from "./script-executor.interface";
-import { ScriptApiContext } from "../script-api";
-/**
- * Executor for new-spec Plugins (manifest.type === "plugin")
- */
-export declare class PluginExecutor extends IPluginExecutor {
-    constructor();
-    canHandle(script: ScriptBase | LegacyCustomScript): script is Plugin<import("../../../types").FirebotParams>;
-    getScriptDetails(script: ScriptBase | LegacyCustomScript): ScriptDetails | null;
-    executePlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, isInstalling?: boolean, ctx?: ScriptApiContext): Promise<PluginExecutionResult>;
-    unloadPlugin(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig, registrations?: PluginRegistrations, isUninstalling?: boolean): Promise<void>;
-    updateParameters(script: ScriptBase | LegacyCustomScript, config: InstalledPluginConfig): Promise<void>;
-    private registerAll;
-    private runUnregistrations;
-    private buildParameters;
-    private isPlugin;
-}

package/backend/scripts/script-api/index.d.ts

@@ -1,8 +0,0 @@
-import type { FirebotScriptApi } from "../../../types/script-api";
-import type { ScriptApiContext } from "./context";
-/**
- * Composition root for the Firebot Script API
- */
-export declare function buildScriptApi(ctx: ScriptApiContext): FirebotScriptApi;
-export type { ScriptApiContext, ScriptApiContextSource } from "./context";
-export { createScriptApiContext } from "./context";

package/backend/scripts/script-api/internal/define-namespace.d.ts

@@ -1,3 +0,0 @@
-import type { ScriptApiContext } from "../context";
-export type ScriptApiNamespaceFactory<TApi> = (ctx: ScriptApiContext) => TApi;
-export declare function defineScriptApiNamespace<TApi>(factory: ScriptApiNamespaceFactory<TApi>): ScriptApiNamespaceFactory<TApi>;

package/backend/scripts/script-api/internal/script-data-dir.d.ts

@@ -1 +0,0 @@
-export declare function resolveScriptDataDir(scriptId: string): string;

package/backend/scripts/script-api/namespaces/effects.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptEffectsApi } from "../../../../types/script-api";
-export declare const createEffectsApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptEffectsApi>;

package/backend/scripts/script-api/namespaces/event-filter-factory.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptEventFilterFactoryApi } from "../../../../types/script-api";
-export declare const createEventFilterFactoryApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptEventFilterFactoryApi>;

package/backend/scripts/script-api/namespaces/events.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptEventsApi } from "../../../../types/script-api";
-export declare const createEventsApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptEventsApi>;

package/backend/scripts/script-api/namespaces/frontend-communicator.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptFrontendCommunicatorApi } from "../../../../types/script-api";
-export declare const createFrontendCommunicatorApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptFrontendCommunicatorApi>;

package/backend/scripts/script-api/namespaces/http-server.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptWebServerApi } from "../../../../types/script-api";
-export declare const createWebServerApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptWebServerApi>;

package/backend/scripts/script-api/namespaces/logger.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptLoggerApi } from "../../../../types/script-api";
-export declare const createLoggerApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptLoggerApi>;

package/backend/scripts/script-api/namespaces/notifications.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptNotificationsApi } from "../../../../types/script-api";
-export declare const createNotificationsApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptNotificationsApi>;

package/backend/scripts/script-api/namespaces/parameters.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptParametersApi } from "../../../../types/script-api";
-export declare const createParametersApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptParametersApi>;

package/backend/scripts/script-api/namespaces/plugins.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptPluginsApi } from "../../../../types/script-api";
-export declare const createPluginsApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptPluginsApi>;

package/backend/scripts/script-api/namespaces/settings.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptSettingsApi } from "../../../../types/script-api";
-export declare const createSettingsApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptSettingsApi>;

package/backend/scripts/script-api/namespaces/storage.d.ts

@@ -1,6 +0,0 @@
-import type { ScriptStorageApi } from "../../../../types/script-api";
-/**
- * Simple per-script storage. Lets a script easily save/load JSON values or
- * arbitrary files inside its own data directory.
- */
-export declare const createStorageApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptStorageApi>;

package/backend/scripts/script-api/namespaces/twitch.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptTwitchApi } from "../../../../types/script-api";
-export declare const createTwitchApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptTwitchApi>;

package/backend/scripts/script-api/namespaces/variable-factory.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptVariableFactoryApi } from "../../../../types/script-api";
-export declare const createVariableFactoryApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptVariableFactoryApi>;

package/backend/scripts/script-api/namespaces/webhooks.d.ts

@@ -1,2 +0,0 @@
-import type { ScriptWebhooksApi } from "../../../../types/script-api";
-export declare const createWebhooksApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptWebhooksApi>;