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

package/backend/events/filters/builtin/firebot/custom-variable-name.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/custom-widget-message-name.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/index.d.ts

@@ -1,4 +1,2 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-}))[];
+declare const _default: import("../../../../../types").EventFilter[];
 export default _default;

package/backend/events/filters/builtin/firebot/metadata-key.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/metadata-value.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/new-currency-amount.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/new-view-time.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/previous-currency-amount.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/firebot/previous-view-time.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/index.d.ts

@@ -1,4 +1,2 @@
-declare const _default: (Omit<import("../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-}))[];
+declare const _default: import("../../../../types").EventFilter[];
 export default _default;

package/backend/events/filters/builtin/third-party/donation-amount.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/third-party/donation-from.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/third-party/index.d.ts

@@ -1,4 +1,2 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-}))[];
+declare const _default: import("../../../../../types").EventFilter[];
 export default _default;

package/backend/events/filters/builtin/twitch/bits-badge-tier.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/chat-mode-duration.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/cheer-bits-amount.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/gift-count.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/gift-duration.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/index.d.ts

@@ -1,4 +1,2 @@
-declare const _default: (Omit<import("../../../../../types").EventFilter, "presetValues"> | (Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-}))[];
+declare const _default: import("../../../../../types").EventFilter[];
 export default _default;

package/backend/events/filters/builtin/twitch/lifetime-gift-count.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/message.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/raid-viewer-count.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/reward-name.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/stream-category.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/sub-months.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/username.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/builtin/twitch/watch-streak-count.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export default filter;

package/backend/events/filters/filter-factory.d.ts

@@ -1,28 +1,17 @@
-import { Awaitable, EventFilter, FilterSettings, PresetValue } from "../../../types";
-type EventData = {
-    eventSourceId: string;
-    eventId: string;
-    eventMeta: Record<string, unknown>;
-};
-type FilterEvent = Omit<EventData, "eventMeta">;
-type FilterConfig = {
-    id: string;
-    name: string;
-    description: string;
-    events: Array<FilterEvent>;
+import { Awaitable, EventData, EventFilter, FilterSettings, PresetValue } from "../../../types";
+export type FilterConfig = Pick<EventFilter, "id" | "name" | "description" | "events"> & {
     eventMetaKey: string | ((eventData: EventData, filterSettings: FilterSettings) => string);
+};
+export type TextFilterConfig = FilterConfig & {
     caseInsensitive?: boolean;
 };
-type PresetFilterConfig = FilterConfig & {
+export type PresetFilterConfig = FilterConfig & {
     presetValues: (...args: unknown[]) => Awaitable<PresetValue[]>;
     valueIsStillValid?(filterSettings: FilterSettings, ...args: unknown[]): Awaitable<boolean>;
     getSelectedValueDisplay?(filterSettings: FilterSettings, ...args: unknown[]): Awaitable<string>;
     allowIsNot?: boolean;
 };
-export declare function createTextFilter({ eventMetaKey, caseInsensitive, ...config }: Omit<FilterConfig, "presetValues" | "allowIsNot">): Omit<EventFilter, "presetValues">;
-export declare function createNumberFilter({ eventMetaKey, ...config }: Omit<FilterConfig, "caseInsensitive" | "presetValues" | "allowIsNot">): Omit<EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
-export declare function createTextOrNumberFilter({ eventMetaKey, caseInsensitive, ...config }: Omit<FilterConfig, "presetValues" | "allowIsNot">): Omit<EventFilter, "presetValues">;
-export declare function createPresetFilter({ eventMetaKey, presetValues, getSelectedValueDisplay, valueIsStillValid, allowIsNot, ...config }: Omit<PresetFilterConfig, "caseInsensitive">): EventFilter;
-export {};
+export declare function createTextFilter({ eventMetaKey, caseInsensitive, ...config }: TextFilterConfig): EventFilter;
+export declare function createNumberFilter({ eventMetaKey, ...config }: FilterConfig): EventFilter;
+export declare function createTextOrNumberFilter({ eventMetaKey, caseInsensitive, ...config }: TextFilterConfig): EventFilter;
+export declare function createPresetFilter({ eventMetaKey, presetValues, getSelectedValueDisplay, valueIsStillValid, allowIsNot, ...config }: PresetFilterConfig): EventFilter;

package/backend/integrations/builtin/streamloots/filters/card-name.d.ts

@@ -1,2 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues">;
+declare const filter: import("../../../../../types").EventFilter;
 export = filter;

package/backend/integrations/builtin/streamloots/filters/chest-quantity.d.ts

@@ -1,4 +1,2 @@
-declare const filter: Omit<import("../../../../../types").EventFilter, "presetValues" | "valueType"> & {
-    valueType: "number";
-};
+declare const filter: import("../../../../../types").EventFilter;
 export = filter;

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

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

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

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

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

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

package/backend/scripts/script-manager.d.ts

@@ -32,7 +32,7 @@ declare class ScriptManager {
      * Handle a config change. Starts/stops as needed, and on a still-enabled plugin
      * either re-loads (if file may have changed) or invokes onParameterUpdate.
      */
-    reloadPluginConfig(pluginConfig: InstalledPluginConfig): Promise<void>;
+    reloadPluginConfig(pluginConfig: InstalledPluginConfig, isNewInstall?: boolean): Promise<void>;
     setPluginEnabled(pluginId: string, enabled: boolean): Promise<void>;
     getInstalledPlugins(): Promise<InstalledPlugin[]>;
     /**

package/backend/variables/variable-factory.d.ts

@@ -1,5 +1,5 @@
 import type { ReplaceVariable } from "../../types/variables";
-type VariableConfig = {
+export type VariableConfig = {
     handle: string;
     description: string;
     events: string[];
@@ -9,4 +9,3 @@ type VariableConfig = {
     type: ReplaceVariable["definition"]["possibleDataOutput"][number] | ReplaceVariable["definition"]["possibleDataOutput"];
 };
 export declare function createEventDataVariable({ events, eventMetaKey, type, defaultValue, ...definition }: VariableConfig): ReplaceVariable;
-export {};

package/backend/webhooks/webhook-config-manager.d.ts

@@ -1,5 +1,4 @@
-import type { ScriptWebhook, WebhookConfig } from "../../types";
-import type { ScriptWebhookEventHandler } from "../../types/script-api";
+import type { PluginWebhook, PluginWebhookEventHandler, WebhookConfig } from "../../types";
 import JsonDbManager from "../database/json-db-manager";
 type ExtraEvents = {
     "webhook-received": (data: {
@@ -15,12 +14,12 @@ declare class WebhookConfigManager extends JsonDbManager<WebhookConfig, ExtraEve
     getWebhookUrlById(webhookId: string): string;
     private toPublic;
     findPluginWebhookByName(pluginId: string, webhookName: string): WebhookConfig;
-    getPluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
-    getAllPluginWebhooks(pluginId: string): ScriptWebhook[];
-    savePluginWebhook(pluginId: string, webhookName: string): ScriptWebhook;
+    getPluginWebhook(pluginId: string, webhookName: string): PluginWebhook;
+    getAllPluginWebhooks(pluginId: string): PluginWebhook[];
+    savePluginWebhook(pluginId: string, webhookName: string): PluginWebhook;
     deletePluginWebhook(pluginId: string, webhookName: string): boolean;
     getPluginWebhookUrl(pluginId: string, webhookName: string): string;
-    registerPluginHandler(pluginId: string, handler: ScriptWebhookEventHandler): boolean;
+    registerPluginHandler(pluginId: string, handler: PluginWebhookEventHandler): boolean;
     unregisterPluginHandler(pluginId: string): boolean;
 }
 declare const webhookConfigManager: WebhookConfigManager;

package/package.json

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

package/types/events.d.ts

@@ -22,20 +22,20 @@ export type EventSource = {
     events: EventDefinition[];
 };
 export type PresetValue = {
-    value: any;
+    value: unknown;
     display: string;
 };
 export type FilterSettings = {
     type: string;
     comparisonType: ComparisonType;
-    value: any;
+    value: unknown;
 };
 export type EventSourceAndId = {
     eventSourceId: string;
     eventId: string;
 };
 export type EventData = EventSourceAndId & {
-    eventMeta: Record<string, any>;
+    eventMeta: Record<string, unknown>;
 };
 export type EventFilter = {
     id: string;
@@ -43,7 +43,7 @@ export type EventFilter = {
     description: string;
     events: EventSourceAndId[];
     comparisonTypes: string[];
-    valueType: "text" | "preset";
+    valueType: "text" | "number" | "preset";
     presetValues?(...args: unknown[]): Awaitable<PresetValue[]>;
     valueIsStillValid?(filterSettings: FilterSettings, ...args: unknown[]): Awaitable<boolean>;
     getSelectedValueDisplay?(filterSettings: FilterSettings, ...args: unknown[]): Awaitable<string>;

package/types/plugins.d.ts

@@ -1,7 +1,7 @@
 import type { EffectInstance, EffectList, EffectType } from "./effects";
 import type { Trigger } from "./triggers";
 import type { Awaitable } from "./util-types";
-import type { ReplaceVariable } from "./variables";
+import type { PluginAdditonalVariableEvents, ReplaceVariable } from "./variables";
 import type { EventFilter, EventSource } from "./events";
 import type { SystemCommand } from "./commands";
 import type { RestrictionType } from "./restrictions";
@@ -119,6 +119,7 @@ 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>>;
@@ -203,4 +204,4 @@ export type LegacyCustomScript = {
     stop?: () => Awaitable<void>;
 };
 export type FirebotScriptApi = import("./script-api").FirebotScriptApi;
-export type { ScriptLoggerApi, ScriptWebhooksApi, ScriptWebhook, ScriptWebhookEvent } from "./script-api";
+export type { ScriptLoggerApi, ScriptWebhooksApi } from "./script-api";

package/types/script-api.d.ts

@@ -1,10 +1,14 @@
-import type { TriggeredEvent } from "./events";
+import type { EventFilter, TriggeredEvent } from "./events";
 import type { RunEffectsContext } from "./effects";
 import type { TwitchApi } from "../backend/streaming-platforms/twitch/api";
 import type { Notification } from "./notifications";
 import type { FirebotAccount } from "./accounts";
 import type { FirebotSettingsTypes } from "./settings";
 import type { InstalledPlugin } from "./plugins";
+import type { PluginWebhook } from "./webhooks";
+import { ReplaceVariable } from "./variables";
+import type { VariableConfig } from "../backend/variables/variable-factory";
+import type { FilterConfig, PresetFilterConfig, TextFilterConfig } from "../backend/events/filters/filter-factory";
 export type ScriptLogMethod = (message: string, ...meta: unknown[]) => void;
 export interface ScriptLoggerApi {
     debug: ScriptLogMethod;
@@ -12,22 +16,11 @@ export interface ScriptLoggerApi {
     warn: ScriptLogMethod;
     error: ScriptLogMethod;
 }
-export interface ScriptWebhook {
-    id: string;
-    name: string;
-}
-export interface ScriptWebhookEvent {
-    webhook: ScriptWebhook;
-    payload: unknown;
-    rawPayload?: string;
-    headers: Record<string, string>;
-}
-export type ScriptWebhookEventHandler = (event: ScriptWebhookEvent) => void;
 export interface ScriptWebhooksApi {
     /** Look up a webhook by name. */
-    get(name: string): ScriptWebhook | null;
+    get(name: string): PluginWebhook | null;
     /** All webhooks owned by this script. */
-    list(): ScriptWebhook[];
+    list(): PluginWebhook[];
     /** Public URL for a webhook by name, or null if not found. */
     getUrl(name: string): string | null;
 }
@@ -158,6 +151,15 @@ export interface ScriptWebServerApi {
      */
     sendWebSocketEvent(name: string, data?: unknown): any;
 }
+export interface ScriptVariableFactoryApi {
+    createEventDataVariable(config: VariableConfig): ReplaceVariable;
+}
+export interface ScriptEventFilterFactoryApi {
+    createTextFilter(config: TextFilterConfig): EventFilter;
+    createNumberFilter(config: FilterConfig): EventFilter;
+    createTextOrNumberFilter(config: TextFilterConfig): EventFilter;
+    createPresetFilter(config: PresetFilterConfig): EventFilter;
+}
 export interface FirebotScriptApi {
     /** Running Firebot version, e.g. `"5.67.0"`. */
     version: string;
@@ -187,4 +189,8 @@ export interface FirebotScriptApi {
     plugins: ScriptPluginsApi;
     /** Firebot internal web server functions. */
     webServer: ScriptWebServerApi;
+    /** Factory for creating variables based on event data. */
+    variableFactory: ScriptVariableFactoryApi;
+    /** Factory for creating event filters. */
+    eventFilterFactory: ScriptEventFilterFactoryApi;
 }

package/types/variables.d.ts

@@ -1,3 +1,4 @@
+import type { EventSourceAndId } from "./events";
 import type { Trigger, TriggersObject, TriggerType, TriggerMeta } from "./triggers";
 import type { Awaitable } from "./util-types";
 export { Trigger, TriggersObject, TriggerType, TriggerMeta };
@@ -43,3 +44,12 @@ export type RegisteredVariable = {
     evaluator(trigger: Trigger, ...args: unknown[]): Awaitable<unknown>;
     getSuggestions: (triggerType: TriggerType, triggerMeta?: TriggerMeta) => Awaitable<VariableUsage[]>;
 };
+export type AdditionalVariableEvent = {
+    handle: string;
+    eventSourceId: string;
+    eventId: string;
+};
+export type PluginAdditonalVariableEvents = {
+    handle: string;
+    events: Array<EventSourceAndId>;
+};

package/types/webhooks.d.ts

@@ -1,10 +1,20 @@
-import type { ScriptWebhookEventHandler } from "./script-api";
 export type WebhookConfig = {
     id: string;
     name: string;
     scriptId?: string;
 };
+export interface PluginWebhook {
+    id: string;
+    name: string;
+}
+export interface PluginWebhookEvent {
+    webhook: PluginWebhook;
+    payload: unknown;
+    rawPayload?: string;
+    headers: Record<string, string>;
+}
+export type PluginWebhookEventHandler = (event: PluginWebhookEvent) => void;
 export type PluginWebhooks = {
     webhookNames: string[];
-    handler: ScriptWebhookEventHandler;
+    handler: PluginWebhookEventHandler;
 };