Merge branch 'main' of https://github.com/crowbartools/firebot-custom-scripts-types

Author: ebiggz

README.md

@@ -1,2 +1,5 @@
-# firebot-custom-scripts-types
- TypeScript types for Firebot's Custom Scripts
+TypeScript types for Firebot's Custom Scripts
+
+```shell
+npm i -D @crowbartools/firebot-custom-scripts-types
+```

types/modules/command-manager.d.ts

@@ -81,19 +81,21 @@ export type CommandDefinition = {
     fallbackSubcommand?: SubCommand | undefined;
 };
 
+type UserCommand = {
+    trigger: string;
+    args: string[];
+    triggeredSubcmd?: CommandDefinition;
+    isInvalidSubcommandTrigger: boolean;
+    triggeredArg?: string;
+    subcommandId?: string;
+    commandSender: string;
+    senderRoles: string[];
+};
+
 type SystemCommandTriggerEvent = {
     command: CommandDefinition;
     commandOptions: Record<string, any>;
-    userCommand: {
-        trigger: string;
-        args: string[];
-        triggeredSubcmd?: CommandDefinition;
-        isInvalidSubcommandTrigger: boolean;
-        triggeredArg?: string;
-        subcommandId?: string;
-        commandSender: string;
-        senderRoles: string[];
-    };
+    userCommand: UserCommand;
 };
 
 type BasicCommandDefinition = Omit<

types/modules/game-manager.d.ts

@@ -98,5 +98,5 @@ export type GameManager = {
    * @param game that should be registered.
    */
   registerGame: (game: FirebotGame) => void;
-  getGameSettings: (string) => GameSettings;
+  getGameSettings: (gameId: string) => GameSettings;
 };