feat: Send Quick Reply Before Message Generation (#4407) * feat: Send Quick Reply Before Message Generation * fix: Use correct event and check for dry runs on before-generation * Replace icon * Skip for events in groups outside of group wrapper * Compatibility with API and slash commands --------- Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

63dcda8609ed82a156e12aa13aa9d5d7732ee964

MAX-TAB <60381043+MAX-TAB@users.noreply.github.com>

Signed

Parents: 40f4792b3286117227c09c4f1cc292bfdd189f59

public/scripts/extensions/quick-reply/api/QuickReplyApi.js+6 -0 Viewed

      * @param {boolean} [props.executeOnChatChange] whether to execute the quick reply when a new chat is loaded
      * @param {boolean} [props.executeOnGroupMemberDraft] whether to execute the quick reply when a group member is selected
      * @param {boolean} [props.executeOnNewChat] whether to execute the quick reply when a new chat is created
+     * @param {boolean} [props.executeBeforeGeneration] whether to execute the quick reply before message generation
      * @param {string} [props.automationId] when not empty, the quick reply will be executed when the WI with the given automation ID is activated
      * @returns {QuickReply} the new quick reply
      */

         executeOnChatChange,
         executeOnGroupMemberDraft,
         executeOnNewChat,
+        executeBeforeGeneration,
         automationId,
     } = {}) {
         const set = this.getSetByName(setName);

         qr.executeOnChatChange = executeOnChatChange ?? false;
         qr.executeOnGroupMemberDraft = executeOnGroupMemberDraft ?? false;
         qr.executeOnNewChat = executeOnNewChat ?? false;
+        qr.executeBeforeGeneration = executeBeforeGeneration ?? false;
         qr.automationId = automationId ?? '';
         qr.onUpdate();
         return qr;

      * @param {boolean} [props.executeOnChatChange] whether to execute the quick reply when a new chat is loaded
      * @param {boolean} [props.executeOnGroupMemberDraft] whether to execute the quick reply when a group member is selected
      * @param {boolean} [props.executeOnNewChat] whether to execute the quick reply when a new chat is created
+     * @param {boolean} [props.executeBeforeGeneration] whether to execute the quick reply before message generation
      * @param {string} [props.automationId] when not empty, the quick reply will be executed when the WI with the given automation ID is activated
      * @returns {QuickReply} the altered quick reply
      */

         executeOnChatChange,
         executeOnGroupMemberDraft,
         executeOnNewChat,
+        executeBeforeGeneration,
         automationId,
     } = {}) {
         const qr = this.getQrByLabel(setName, label);

         qr.executeOnChatChange = executeOnChatChange ?? qr.executeOnChatChange;
         qr.executeOnGroupMemberDraft = executeOnGroupMemberDraft ?? qr.executeOnGroupMemberDraft;
         qr.executeOnNewChat = executeOnNewChat ?? qr.executeOnNewChat;
+        qr.executeBeforeGeneration = executeBeforeGeneration ?? qr.executeBeforeGeneration;
         qr.automationId = automationId ?? qr.automationId;
         qr.onUpdate();
         return qr;

public/scripts/extensions/quick-reply/html/qrEditor.html+4 -0 Viewed

                 <input type="checkbox" id="qr--executeOnGroupMemberDraft">
                 <span><i class="fa-solid fa-fw fa-people-group"></i><span data-i18n="Execute on group member draft">Execute on group member draft</span></span>
             </label>
+            <label class="checkbox_label">
+    			<input type="checkbox" id="qr--executeBeforeGeneration" >
+    			<span><i class="fa-solid fa-fw fa-paper-plane"></i><span data-i18n="Execute before message generation">Execute before message generation</span></span>
+   			</label>
             <div class="flex-container alignItemsBaseline flexFlowColumn flexNoGap" title="Activate this quick reply when a World Info entry with the same Automation ID is triggered.">
                 <small data-i18n="Automation ID:">Automation ID</small>
                 <input type="text" id="qr--automationId" class="text_pole flex1" placeholder="( None )">

public/scripts/extensions/quick-reply/index.js+14 -0 Viewed

                     qr.executeOnChatChange = slot.autoExecute_chatLoad ?? false;
                     qr.executeOnGroupMemberDraft = slot.autoExecute_groupMemberDraft ?? false;
                     qr.executeOnNewChat = slot.autoExecute_newChat ?? false;
+                    qr.executeBeforeGeneration = slot.autoExecute_beforeGeneration ?? false;
                     qr.automationId = slot.automationId ?? '';
                     qr.contextList = (slot.contextMenu ?? []).map(it=>({
                         set: it.preset,

     await autoExec.handleNewChat();
 };
 eventSource.on(event_types.CHAT_CREATED, (...args) => executeIfReadyElseQueue(onNewChat, args));
+const onBeforeGeneration = async (_generationType, _options = {}, isDryRun = false) => {
+    if (isDryRun) {
+        log('Before-generation hook skipped due to dryRun.');
+        return;
+    }
+    if (selected_group && this_chid === undefined) {
+        log('Before-generation hook skipped for event before group wrapper.');
+        return;
+    }
+    await autoExec.handleBeforeGeneration();
+};
+eventSource.on(event_types.GENERATION_AFTER_COMMANDS, (...args) => executeIfReadyElseQueue(onBeforeGeneration, args));

public/scripts/extensions/quick-reply/src/AutoExecuteHandler.js+5 -0 Viewed

         await this.performAutoExecute(this.getCommands('executeOnNewChat'));
+    }
+    async handleBeforeGeneration() {
+        if (!this.checkExecute()) return;
+        await this.performAutoExecute(this.getCommands('executeBeforeGeneration'));
+    }
     /**
      * @param {any[]} entries Set of activated entries
      */

public/scripts/extensions/quick-reply/src/QuickReply.js+9 -0 Viewed

     /**@type {boolean}*/ executeOnChatChange = false;
     /**@type {boolean}*/ executeOnGroupMemberDraft = false;
     /**@type {boolean}*/ executeOnNewChat = false;
+    /**@type {boolean}*/ executeBeforeGeneration = false;
     /**@type {string}*/ automationId = '';
     /**@type {function}*/ onExecute;

                 this.updateContext();
             });
             /**@type {HTMLInputElement}*/
+            const executeBeforeGeneration = dom.querySelector('#qr--executeBeforeGeneration');
+            executeBeforeGeneration.checked = this.executeBeforeGeneration;
+            executeBeforeGeneration.addEventListener('click', ()=>{
+                this.executeBeforeGeneration = executeBeforeGeneration.checked;
+                this.updateContext();
+            });
+            /**@type {HTMLInputElement}*/
             const executeOnNewChat = dom.querySelector('#qr--executeOnNewChat');
             executeOnNewChat.checked = this.executeOnNewChat;
             executeOnNewChat.addEventListener('click', ()=>{

             executeOnChatChange: this.executeOnChatChange,
             executeOnGroupMemberDraft: this.executeOnGroupMemberDraft,
             executeOnNewChat: this.executeOnNewChat,
+            executeBeforeGeneration: this.executeBeforeGeneration,
             automationId: this.automationId,
         };
+    }

public/scripts/extensions/quick-reply/src/SlashCommandHandler.js+4 -0 Viewed

             if (qr.executeOnChatChange) icons += '💬';
             if (qr.executeOnNewChat) icons += '🆕';
             if (qr.executeOnGroupMemberDraft) icons += enumIcons.group;
+            if (qr.executeBeforeGeneration) icons += '✈️';
             return icons;
+        }

             new SlashCommandNamedArgument('load', 'auto execute on chat load, e.g., load=true', [ARGUMENT_TYPE.BOOLEAN], false, false, 'false'),
             new SlashCommandNamedArgument('new', 'auto execute on new chat, e.g., new=true', [ARGUMENT_TYPE.BOOLEAN], false, false, 'false'),
             new SlashCommandNamedArgument('group', 'auto execute on group member selection, e.g., group=true', [ARGUMENT_TYPE.BOOLEAN], false, false, 'false'),
+            new SlashCommandNamedArgument('generation', 'auto execute before message generation, e.g., generation=true', [ARGUMENT_TYPE.BOOLEAN], false, false, 'false'),
             new SlashCommandNamedArgument('title', 'title / tooltip to be shown on button, e.g., title="My Fancy Button"', [ARGUMENT_TYPE.STRING], false),
         ];
         const qrUpdateArgs = [

                     executeOnChatChange: isTrueBoolean(args.load),
                     executeOnNewChat: isTrueBoolean(args.new),
                     executeOnGroupMemberDraft: isTrueBoolean(args.group),
+                    executeBeforeGeneration: isTrueBoolean(args.generation),
                     automationId: args.automationId ?? '',
                 },
             );

                     executeOnChatChange: args.load === undefined ? undefined : isTrueBoolean(args.load),
                     executeOnGroupMemberDraft: args.group === undefined ? undefined : isTrueBoolean(args.group),
                     executeOnNewChat: args.new === undefined ? undefined : isTrueBoolean(args.new),
+                    executeBeforeGeneration: args.generation === undefined ? undefined : isTrueBoolean(args.generation),
                     automationId: args.automationId ?? '',
                 },
             );