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

package/backend/common/profile-manager.d.ts

@@ -6,7 +6,7 @@ declare class ProfileManager {
     constructor();
     private restartApp;
     logInProfile(profileId: string, restart?: boolean): void;
-    createNewProfile(profileId?: string, restart?: boolean): void;
+    createNewProfile(profileId: string, restart?: boolean): void;
     getLoggedInProfile(restartIfNotLoggedIn?: boolean): string;
     renameProfile(newProfileId: string): void;
     deleteProfile(): void;

package/backend/common/settings-manager.d.ts

@@ -8,6 +8,7 @@ declare class SettingsManager extends EventEmitter {
     private getSettingsFile;
     private getGlobalSettingsFile;
     private handleCorruptSettingsFile;
+    private handleCorruptGlobalSettingsFile;
     private migrateUserSettingsToGlobal;
     private userSettingExists;
     private globalSettingExists;

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/backend/scripts/script-api/context.d.ts

@@ -25,6 +25,8 @@ export interface ScriptApiContext {
     readonly scriptDataDir: string;
     /** Winston child logger pre-tagged with `{ script: scriptId }`. */
     readonly logger: typeof logger;
+    /** True when script is being inspected (e.g. during early detail / manifest retrieval). */
+    readonly isInspecting: boolean;
     /** Register a teardown callback fired when the plugin is unloaded. */
     onDispose(fn: DisposeFn): void;
 }
@@ -36,10 +38,12 @@ export type ScriptApiContextSource = {
     kind: "plugin";
     config: InstalledPluginConfig;
     manifest: Manifest;
+    isInspecting: boolean;
 } | {
     kind: "effect-script";
     fileName: string;
     manifest: Manifest;
+    isInspecting: boolean;
 };
 export declare function createScriptApiContext(source: ScriptApiContextSource): ScriptApiContextHandle;
 export { normalizeName };

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

@@ -35,6 +35,7 @@ declare class ScriptManager {
     reloadPluginConfig(pluginConfig: InstalledPluginConfig, isNewInstall?: boolean): Promise<void>;
     setPluginEnabled(pluginId: string, enabled: boolean): Promise<void>;
     getInstalledPlugins(): Promise<InstalledPlugin[]>;
+    private doGetScriptDetailsByFileName;
     /**
      * Loads a script file (without persisting a config) and returns its details for
      * the install / edit UI.

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha17",
+  "version": "5.67.0-alpha19",
   "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

@@ -6,8 +6,7 @@ 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 { 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 {
@@ -65,13 +64,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,16 @@ export type AdditionalVariableEvent = {
     eventSourceId: string;
     eventId: string;
 };
-export type PluginAdditonalVariableEvents = {
+export type PluginAdditionalVariableEvents = {
     handle: string;
     events: Array<EventSourceAndId>;
 };
+export type VariableConfig = {
+    handle: string;
+    description: string;
+    events: string[];
+    eventMetaKey: string;
+    usage?: string;
+    defaultValue?: unknown;
+    type: ReplaceVariable["definition"]["possibleDataOutput"][number] | ReplaceVariable["definition"]["possibleDataOutput"];
+};