chore: updates for 5.63.0 (#30)

- moves script params over to firebot params 
- adds notification manager + repl var factory to script modules

Author: ebiggz

types/index.d.ts

@@ -28,56 +28,9 @@ import { Utils } from "./modules/utils";
 import { ConditionManager } from "./modules/condition-manager";
 import { RestrictionManager } from "./modules/restriction-manager";
 import { IntegrationManager } from "./modules/integration-manager";
-
-export type BaseParameter = {
-    description?: string;
-    secondaryDescription?: string;
-    showBottomHr?: boolean;
-};
-
-export type StringParameter = BaseParameter & {
-    type: "string";
-    useTextArea?: boolean;
-    default: string;
-};
-
-export type PasswordParameter = BaseParameter & {
-    type: "password";
-    default: string;
-};
-
-export type BooleanParameter = BaseParameter & {
-    type: "boolean";
-    default: boolean;
-};
-
-export type NumberParameter = BaseParameter & {
-    type: "number";
-    default: number;
-};
-
-export type EnumParameter<G = string | number> = BaseParameter & {
-    type: "enum";
-    options: Array<G>;
-    default: string | number;
-};
-
-export type FilepathParameter = BaseParameter & {
-    type: "filepath";
-    fileOptions?: {
-        directoryOnly: boolean;
-        filters: Array<{
-            name: string;
-            extensions: string[];
-        }>;
-        title: string;
-        buttonLabel: string;
-    };
-};
-
-export type EffectListParameter = BaseParameter & {
-    type: "effectlist";
-};
+import { ReplaceVariableFactory } from "./modules/replace-variable-factory";
+import { ParametersConfig } from "./modules/firebot-parameters";
+import { NotificationManager } from "./modules/notification-manager";
 
 export type UserAccount = {
     username: string;
@@ -124,9 +77,11 @@ export type ScriptModules = {
     JsonDb: unknown;
     logger: Logger;
     moment: typeof Moment;
+    notificationManager: NotificationManager;
     path: typeof Path;
     quotesManager: QuotesManager;
     replaceVariableManager: ReplaceVariableManager;
+    replaceVariableFactory: ReplaceVariableFactory;
     resourceTokenManager: ResourceTokenManager;
     request: unknown;
     restrictionManager: RestrictionManager;
@@ -139,9 +94,13 @@ export type ScriptModules = {
     [x: string]: unknown;
 };
 
-export type RunRequestParameters<P> = {
-    [K in keyof P]: P[K] extends Array<infer G> ? G : P[K];
-};
+type ValidParamKeys<T> = {
+    [P in keyof T]: Exclude<T[P], undefined> extends void | undefined | null
+        ? never
+        : P;
+}[keyof T];
+
+export type RunRequestParameters<P> = Pick<P, ValidParamKeys<P>>;
 
 export type RunRequest<P extends Record<string, unknown>> = {
     parameters: RunRequestParameters<P>;
@@ -157,27 +116,6 @@ export type RunRequest<P extends Record<string, unknown>> = {
     trigger: Effects.Trigger;
 };
 
-export type ScriptParameter =
-    | StringParameter
-    | PasswordParameter
-    | BooleanParameter
-    | NumberParameter
-    | EnumParameter;
-
-export type DefaultParametersConfig<P> = {
-    [K in keyof P]: P[K] extends string
-        ? StringParameter | PasswordParameter | FilepathParameter
-        : P[K] extends number
-        ? NumberParameter
-        : P[K] extends boolean
-        ? BooleanParameter
-        : P[K] extends Array<infer G>
-        ? EnumParameter<G>
-        : P[K] extends Firebot.EffectList
-        ? EffectListParameter
-        : ScriptParameter;
-};
-
 export type ScriptReturnObject = {
     success: boolean;
     errorMessage?: string;
@@ -191,7 +129,7 @@ export namespace Firebot {
             | CustomScriptManifest
             | PromiseLike<CustomScriptManifest>;
 
-        getDefaultParameters(): DefaultParametersConfig<P>;
+        getDefaultParameters(): ParametersConfig<P>;
 
         /**
          * Called at app start and when the script is added to Firebot

types/modules/firebot-parameters.d.ts

@@ -1,32 +1,48 @@
 import { Firebot } from "..";
 
-type BaseParameter = {
+export type BaseParameter = {
+    /**
+     * The title of the parameter
+     * Supports markdown
+     */
     title: string;
+    /**
+     * The description of the parameter
+     * Supports markdown
+     */
     description?: string;
+    /**
+     * @deprecated use `title` and `description` instead
+     */
+    secondaryDescription?: string;
+    /**
+     * Shown under the parameter as muted text
+     * Supports markdown
+     */
     tip?: string;
     showBottomHr?: boolean;
     validation?: {
         required?: boolean;
     };
 };
 
-type StringParameter = BaseParameter & {
+export type StringParameter = BaseParameter & {
     type: "string";
     useTextArea?: boolean;
     default: string;
 };
 
-type PasswordParameter = BaseParameter & {
+export type PasswordParameter = BaseParameter & {
     type: "password";
     default: string;
 };
 
-type BooleanParameter = BaseParameter & {
+export type BooleanParameter = BaseParameter & {
     type: "boolean";
     default: boolean;
 };
 
-type NumberParameter = BaseParameter & {
+export type NumberParameter = BaseParameter & {
     type: "number";
     placeholder?: string;
     default: number;
@@ -36,13 +52,18 @@ type NumberParameter = BaseParameter & {
     };
 };
 
-type EnumParameter = BaseParameter & {
+export type EnumParameter<G = string | number> = BaseParameter & {
     type: "enum";
-    options: Array<string | number>;
-    default: string | number;
+    options: Array<G>;
+    default: G | undefined;
+    searchable?: boolean;
+    /**
+     * Only used if `searchable` is true
+     */
+    placeholder?: string;
 };
 
-type FilepathParameter = BaseParameter & {
+export type FilepathParameter = BaseParameter & {
     type: "filepath";
     fileOptions?: {
         directoryOnly: boolean;
@@ -55,25 +76,25 @@ type FilepathParameter = BaseParameter & {
     };
 };
 
-type EffectListParameter = BaseParameter & {
+export type EffectListParameter = BaseParameter & {
     type: "effectlist";
 };
 
-type DiscordChannelWebhookParameter = BaseParameter & {
+export type DiscordChannelWebhookParameter = BaseParameter & {
     type: "discord-channel-webhooks";
 };
 
-type CurrencySelectParameter = BaseParameter & {
+export type CurrencySelectParameter = BaseParameter & {
     type: "currency-select";
     default?: string;
 };
 
-type ChatterSelectParameter = BaseParameter & {
+export type ChatterSelectParameter = BaseParameter & {
     type: "chatter-select";
     default?: "Bot" | "Streamer";
 };
 
-type EditableListParameter = BaseParameter & {
+export type EditableListParameter = BaseParameter & {
     type: "editable-list";
     default?: string[];
     settings: {
@@ -85,12 +106,14 @@ type EditableListParameter = BaseParameter & {
     };
 };
 
-type MultiselectParameter = BaseParameter & {
+export type MultiselectParameter<
+    T extends string | number = string | number
+> = BaseParameter & {
     type: "multiselect";
-    default?: string[] | number[];
+    default?: T[];
     settings: {
         options: Array<{
-            id: string | number;
+            id: T;
             name: string;
         }>;
     };
@@ -104,7 +127,7 @@ export type RolePercentageParameterValue = {
     }>;
 };
 
-type RolePercentagesParameter = BaseParameter & {
+export type RolePercentagesParameter = BaseParameter & {
     type: "role-percentages";
     default?: RolePercentageParameterValue;
 };
@@ -117,7 +140,7 @@ export type RoleNumberParameterValue = {
     }>;
 };
 
-type RoleNumberParameter = BaseParameter & {
+export type RoleNumberParameter = BaseParameter & {
     type: "role-numbers";
     default?: RoleNumberParameterValue;
     settings: {
@@ -128,6 +151,42 @@ type RoleNumberParameter = BaseParameter & {
     };
 };
 
+export type ButtonParameter = BaseParameter & {
+    type: "button";
+    /**
+     * The event name that will be sent to the backend when the button is clicked
+     */
+    backendEventName: string;
+    buttonText: string;
+    size?: "extraSmall" | "small" | "large";
+    buttonType?:
+        | "default"
+        | "primary"
+        | "success"
+        | "info"
+        | "warning"
+        | "danger"
+        | "link";
+    tooltip?: string;
+    tooltipPlacement?:
+        | "top"
+        | "top-left"
+        | "top-right"
+        | "bottom"
+        | "bottom-left"
+        | "bottom-right"
+        | "left"
+        | "left-top"
+        | "left-bottom"
+        | "right"
+        | "right-top"
+        | "right-bottom";
+};
+
+export type UnknownParameter = BaseParameter & {
+    [key: string]: unknown;
+};
+
 type FirebotParameter =
     | StringParameter
     | PasswordParameter
@@ -141,22 +200,29 @@ type FirebotParameter =
     | EditableListParameter
     | MultiselectParameter
     | RolePercentagesParameter
-    | RoleNumberParameter;
+    | RoleNumberParameter
+    | ButtonParameter
+    | UnknownParameter;
 
-type DefaultParametersConfig<P> = {
+export type ParametersConfig<P> = {
     [K in keyof P]: P[K] extends string
         ?
               | StringParameter
               | PasswordParameter
               | FilepathParameter
               | ChatterSelectParameter
               | CurrencySelectParameter
+              | EnumParameter<string>
         : P[K] extends number
-        ? NumberParameter
+        ? NumberParameter | EnumParameter<number>
         : P[K] extends boolean
-        ? BooleanParameter
-        : P[K] extends Array<string> | Array<number>
-        ? EnumParameter | MultiselectParameter | EditableListParameter
+        ? BooleanParameter | EnumParameter<boolean>
+        : P[K] extends Array<string>
+        ? MultiselectParameter<string> | EditableListParameter
+        : P[K] extends Array<number>
+        ? MultiselectParameter<number>
+        : P[K] extends void | undefined | null
+        ? ButtonParameter
         : P[K] extends RolePercentageParameterValue
         ? RolePercentagesParameter
         : P[K] extends RoleNumberParameterValue
@@ -169,11 +235,11 @@ type DefaultParametersConfig<P> = {
 type FirebotParamCategory<ParamConfig extends Record<string, unknown>> = {
     title: string;
     sortRank?: number;
-    settings: DefaultParametersConfig<ParamConfig>;
+    settings: ParametersConfig<ParamConfig>;
 };
 
 export type FirebotParams = Record<string, Record<string, unknown>>;
 
 export type FirebotParameterCategories<Config extends FirebotParams> = {
     [Category in keyof Config]: FirebotParamCategory<Config[Category]>;
-};
+};