Merge branch 'staging' into disk-cache

834c9751f8c71bcb7503263b6b708d7f0061d720

Cohee <18619528+Cohee1207@users.noreply.github.com>

Parents: a20c8978f9d7e8e0117bc383a73845cbbc82fe90 50334890a64b14949690e40ff215c56b5bd2e7da

.github/workflows/pr-auto-manager.yml+7 -0 Viewed

 name: 🔀 Pull Request Manager
 on:
+  workflow_dispatch: # Allow to manually call this workflow
   pull_request_target:
     types: [opened, synchronize, reopened, edited, labeled, unlabeled, closed]
   pull_request_review_comment:

     # Only needs to run when code is changed
     if: github.event.action == 'opened' || github.event.action == 'synchronize'
+    # Override permissions, linter likely needs write access to issues
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
     steps:
       - name: Checkout Repository
         # Checkout

public/script.js+3 -2 Viewed

@@ -2069,8 +2069,9 @@ export function messageFormatting(mes, ch_name, isSystem, isUser, messageId, san
2069	}	2069	}
2070		2070
2071	// Prompt bias replacement should be applied on the raw message	2071	// Prompt bias replacement should be applied on the raw message
2072	if (!power_user.show_user_prompt_bias && ch_name && !isUser && !isSystem) {	2072	const replacedPromptBias = power_user.user_prompt_bias && substituteParams(power_user.user_prompt_bias);
2073	mes = mes.replaceAll(substituteParams(power_user.user_prompt_bias), '');	2073	if (!power_user.show_user_prompt_bias && ch_name && !isUser && !isSystem && replacedPromptBias && mes.startsWith(replacedPromptBias)) {
		2074	mes = mes.slice(replacedPromptBias.length);
2074	}	2075	}
2075		2076
2076	if (!isSystem) {	2077	if (!isSystem) {

public/scripts/custom-request.js+148 -44 Viewed

 import { getTextGenServer } from './textgen-settings.js';
 import { extractReasoningFromData } from './reasoning.js';
 import { formatInstructModeChat, formatInstructModePrompt, names_behavior_types } from './instruct-mode.js';
+import { getStreamingReply, tryParseStreamingError } from './openai.js';
+import EventSourceStream from './sse-stream.js';
 // #region Type Definitions
 /**
  * @typedef {Object} TextCompletionRequestBase
+ * @property {boolean?} [stream=false] - Whether to stream the response
  * @property {number} max_tokens - Maximum number of tokens to generate
  * @property {string} [model] - Optional model name
  * @property {string} api_type - Type of API to use

 /**
  * @typedef {Object} TextCompletionPayloadBase
+ * @property {boolean?} [stream=false] - Whether to stream the response
  * @property {string} prompt - The text prompt for completion
  * @property {number} max_tokens - Maximum number of tokens to generate
  * @property {number} max_new_tokens - Alias for max_tokens

 /**
  * @typedef {Object} ChatCompletionPayloadBase
+ * @property {boolean?} [stream=false] - Whether to stream the response
  * @property {ChatCompletionMessage[]} messages - Array of chat messages
  * @property {string} [model] - Optional model name to use for completion
  * @property {string} chat_completion_source - Source provider for chat completion

  * @property {string} reasoning - Extracted reasoning.
  */
+/**
+ * @typedef {Object} StreamResponse
+ * @property {string} text - Generated text.
+ * @property {string[]} swipes - Generated swipes
+ * @property {Object} state - Generated state
+ * @property {string?} [state.reasoning] - Generated reasoning
+ * @property {string?} [state.image] - Generated image
+ */
 // #endregion
 /**
- * Creates & sends a text completion request. Streaming is not supported.
+ * Creates & sends a text completion request.
  */
 export class TextCompletionService {
     static TYPE = 'textgenerationwebui';

      * @param {Record<string, any> & TextCompletionRequestBase & {prompt: string}} custom
      * @returns {TextCompletionPayload}
      */
-    static createRequestData({ prompt, max_tokens, model, api_type, api_server, temperature, min_p, ...props }) {
+    static createRequestData({ stream = false, prompt, max_tokens, model, api_type, api_server, temperature, min_p, ...props }) {
         const payload = {
             ...props,
+            stream,
             prompt,
             max_tokens,
             max_new_tokens: max_tokens,

             api_server: api_server ?? getTextGenServer(api_type),
             temperature,
             min_p,
-            stream: false,
         };
         // Remove undefined values to avoid API errors

      * Sends a text completion request to the specified server
      * @param {TextCompletionPayload} data Request data
      * @param {boolean?} extractData Extract message from the response. Default true
-     * @returns {Promise<ExtractedData | any>} Extracted data or the raw response
+     * @param {AbortSignal?} signal
+     * @returns {Promise<ExtractedData | (() => AsyncGenerator<StreamResponse>)>} If not streaming, returns extracted data; if streaming, returns a function that creates an AsyncGenerator
      * @throws {Error}
      */
-    static async sendRequest(data, extractData = true) {
+    static async sendRequest(data, extractData = true, signal = null) {
-        const response = await fetch(getGenerateUrl(this.TYPE), {
+        if (!data.stream) {
+            const response = await fetch(getGenerateUrl(this.TYPE), {
+                method: 'POST',
+                headers: getRequestHeaders(),
+                cache: 'no-cache',
+                body: JSON.stringify(data),
+                signal: signal ?? new AbortController().signal,
+            });
+            const json = await response.json();
+            if (!response.ok || json.error) {
+                throw json;
+            }
+            if (!extractData) {
+                return json;
+            }
+            return {
+                content: extractMessageFromData(json, this.TYPE),
+                reasoning: extractReasoningFromData(json, {
+                    mainApi: this.TYPE,
+                    textGenType: data.api_type,
+                    ignoreShowThoughts: true,
+                }),
+            };
+        }
+        const response = await fetch('/api/backends/text-completions/generate', {
             method: 'POST',
             headers: getRequestHeaders(),
             cache: 'no-cache',
             body: JSON.stringify(data),
-            signal: new AbortController().signal,
+            signal: signal ?? new AbortController().signal,
         });
-        const json = await response.json();
+        if (!response.ok) {
-        if (!response.ok || json.error) {
+            const text = await response.text();
-            throw json;
+            tryParseStreamingError(response, text, { quiet: true });
-        }
-        if (!extractData) {
+            throw new Error(`Got response status ${response.status}`);
-            return json;
+        }
-        return {
+        const eventStream = new EventSourceStream();
-            content: extractMessageFromData(json, this.TYPE),
+        response.body.pipeThrough(eventStream);
-            reasoning: extractReasoningFromData(json, {
+        const reader = eventStream.readable.getReader();
-                mainApi: this.TYPE,
+        return async function* streamData() {
-                textGenType: data.api_type,
+            let text = '';
-                ignoreShowThoughts: true,
+            const swipes = [];
-            }),
+            const state = { reasoning: '' };
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done) return;
+                if (value.data === '[DONE]') return;
+                tryParseStreamingError(response, value.data, { quiet: true });
+                let data = JSON.parse(value.data);
+                if (data?.choices?.[0]?.index > 0) {
+                    const swipeIndex = data.choices[0].index - 1;
+                    swipes[swipeIndex] = (swipes[swipeIndex] || '') + data.choices[0].text;
+                } else {
+                    const newText = data?.choices?.[0]?.text || data?.content || '';
+                    text += newText;
+                    state.reasoning += data?.choices?.[0]?.reasoning ?? '';
+                }
+                yield { text, swipes, state };
+            }
         };
+    }

      * @param {string?} [options.presetName] - Name of the preset to use for generation settings
      * @param {string?} [options.instructName] - Name of instruct preset for message formatting
      * @param {boolean} extractData - Whether to extract structured data from response
-     * @returns {Promise<ExtractedData | any>} Extracted data or the raw response
+     * @param {AbortSignal?} [signal]
+     * @returns {Promise<ExtractedData | (() => AsyncGenerator<StreamResponse>)>} If not streaming, returns extracted data; if streaming, returns a function that creates an AsyncGenerator
      * @throws {Error}
      */
     static async processRequest(
         custom,
         options = {},
         extractData = true,
+        signal = null,
     ) {
         const { presetName, instructName } = options;
         let requestData = { ...custom };

         // @ts-ignore
         const data = this.createRequestData(requestData);
-        return await this.sendRequest(data, extractData);
+        return await this.sendRequest(data, extractData, signal);
+    }
     /**

+}
 /**
- * Creates & sends a chat completion request. Streaming is not supported.
+ * Creates & sends a chat completion request.
  */
 export class ChatCompletionService {
     static TYPE = 'openai';

      * @param {ChatCompletionPayload} custom
      * @returns {ChatCompletionPayload}
      */
-    static createRequestData({ messages, model, chat_completion_source, max_tokens, temperature, custom_url, ...props }) {
+    static createRequestData({ stream = false, messages, model, chat_completion_source, max_tokens, temperature, custom_url, ...props }) {
         const payload = {
             ...props,
+            stream,
             messages,
             model,
             chat_completion_source,
             max_tokens,
             temperature,
             custom_url,
-            stream: false,
         };
         // Remove undefined values to avoid API errors

      * Sends a chat completion request
      * @param {ChatCompletionPayload} data Request data
      * @param {boolean?} extractData Extract message from the response. Default true
-     * @returns {Promise<ExtractedData | any>} Extracted data or the raw response
+     * @param {AbortSignal?} signal Abort signal
+     * @returns {Promise<ExtractedData | (() => AsyncGenerator<StreamResponse>)>} If not streaming, returns extracted data; if streaming, returns a function that creates an AsyncGenerator
      * @throws {Error}
      */
-    static async sendRequest(data, extractData = true) {
+    static async sendRequest(data, extractData = true, signal = null) {
         const response = await fetch('/api/backends/chat-completions/generate', {
             method: 'POST',
             headers: getRequestHeaders(),
             cache: 'no-cache',
             body: JSON.stringify(data),
-            signal: new AbortController().signal,
+            signal: signal ?? new AbortController().signal,
         });
-        const json = await response.json();
+        if (!data.stream) {
-        if (!response.ok || json.error) {
+            const json = await response.json();
-            throw json;
+            if (!response.ok || json.error) {
+                throw json;
+            }
+            if (!extractData) {
+                return json;
+            }
+            return {
+                content: extractMessageFromData(json, this.TYPE),
+                reasoning: extractReasoningFromData(json, {
+                    mainApi: this.TYPE,
+                    textGenType: data.chat_completion_source,
+                    ignoreShowThoughts: true,
+                }),
+            };
+        }
-        if (!extractData) {
+        if (!response.ok) {
-            return json;
+            const text = await response.text();
+            tryParseStreamingError(response, text, { quiet: true });
+            throw new Error(`Got response status ${response.status}`);
+        }
-        return {
+        const eventStream = new EventSourceStream();
-            content: extractMessageFromData(json, this.TYPE),
+        response.body.pipeThrough(eventStream);
-            reasoning: extractReasoningFromData(json, {
+        const reader = eventStream.readable.getReader();
-                mainApi: this.TYPE,
+        return async function* streamData() {
-                textGenType: data.chat_completion_source,
+            let text = '';
-                ignoreShowThoughts: true,
+            const swipes = [];
-            }),
+            const state = { reasoning: '', image: '' };
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done) return;
+                const rawData = value.data;
+                if (rawData === '[DONE]') return;
+                tryParseStreamingError(response, rawData, { quiet: true });
+                const parsed = JSON.parse(rawData);
+                const reply = getStreamingReply(parsed, state, {
+                    chatCompletionSource: data.chat_completion_source,
+                    overrideShowThoughts: true,
+                });
+                if (Array.isArray(parsed?.choices) && parsed?.choices?.[0]?.index > 0) {
+                    const swipeIndex = parsed.choices[0].index - 1;
+                    swipes[swipeIndex] = (swipes[swipeIndex] || '') + reply;
+                } else {
+                    text += reply;
+                }
+                yield { text, swipes: swipes, state };
+            }
         };
+    }

      * @param {ChatCompletionPayload} custom
      * @param {Object} options - Configuration options
      * @param {string?} [options.presetName] - Name of the preset to use for generation settings
-     * @param {boolean} extractData - Whether to extract structured data from response
+     * @param {boolean} [extractData=true] - Whether to extract structured data from response
-     * @returns {Promise<ExtractedData | any>} Extracted data or the raw response
+     * @param {AbortSignal?} [signal] - Abort signal
+     * @returns {Promise<ExtractedData | (() => AsyncGenerator<StreamResponse>)>} If not streaming, returns extracted data; if streaming, returns a function that creates an AsyncGenerator
      * @throws {Error}
      */
-    static async processRequest(custom, options, extractData = true) {
+    static async processRequest(custom, options, extractData = true, signal = null) {
         const { presetName } = options;
         let requestData = { ...custom };

@@ -354,7 +458,7 @@ export class ChatCompletionService {
354		458
355	const data = this.createRequestData(requestData);	459	const data = this.createRequestData(requestData);
356		460
357	return await this.sendRequest(data, extractData);	461	return await this.sendRequest(data, extractData, signal);
358	}	462	}
359		463
360	/**	464	/**

public/scripts/extensions/shared.js+10 -6 Viewed

+}
 /**
- * It uses the profiles to send a generate request to the API. Doesn't support streaming.
+ * It uses the profiles to send a generate request to the API.
  */
 export class ConnectionManagerRequestService {
     static defaultSendRequestParams = {
+        stream: false,
+        signal: null,
         extractData: true,
         includePreset: true,
         includeInstruct: true,

      * @param {string} profileId
      * @param {string | (import('../custom-request.js').ChatCompletionMessage & {ignoreInstruct?: boolean})[]} prompt
      * @param {number} maxTokens
-     * @param {{extractData?: boolean, includePreset?: boolean, includeInstruct?: boolean}} custom - default values are true
+     * @param {{stream?: boolean, signal?: AbortSignal, extractData?: boolean, includePreset?: boolean, includeInstruct?: boolean}} custom - default values are true
-     * @returns {Promise<import('../custom-request.js').ExtractedData | any>} Extracted data or the raw response
+     * @returns {Promise<import('../custom-request.js').ExtractedData | (() => AsyncGenerator<import('../custom-request.js').StreamResponse>)>} If not streaming, returns extracted data; if streaming, returns a function that creates an AsyncGenerator
      */
     static async sendRequest(profileId, prompt, maxTokens, custom = this.defaultSendRequestParams) {
-        const { extractData, includePreset, includeInstruct } = { ...this.defaultSendRequestParams, ...custom };
+        const { stream, signal, extractData, includePreset, includeInstruct } = { ...this.defaultSendRequestParams, ...custom };
         const context = SillyTavern.getContext();
         if (context.extensionSettings.disabledExtensions.includes('connection-manager')) {

                     const messages = Array.isArray(prompt) ? prompt : [{ role: 'user', content: prompt }];
                     return await context.ChatCompletionService.processRequest({
+                        stream,
                         messages,
                         max_tokens: maxTokens,
                         model: profile.model,

                         custom_url: profile['api-url'],
                     }, {
                         presetName: includePreset ? profile.preset : undefined,
-                    }, extractData);
+                    }, extractData, signal);
+                }
                 case 'textgenerationwebui': {
                     if (!selectedApiMap.type) {

+                    }
                     return await context.TextCompletionService.processRequest({
+                        stream,
                         prompt,
                         max_tokens: maxTokens,
                         model: profile.model,

                     }, {
                         instructName: includeInstruct ? profile.instruct : undefined,
                         presetName: includePreset ? profile.preset : undefined,
-                    }, extractData);
+                    }, extractData, signal);
+                }
                 default: {
                     throw new Error(`Unknown API type ${selectedApiMap.selected}`);

public/scripts/group-chats.js+4 -3 Viewed

@@ -882,7 +882,7 @@ async function generateGroupWrapper(by_auto_mode, type = null, params = {}) {
882	activatedMembers = activateListOrder(enabledMembers);	882	activatedMembers = activateListOrder(enabledMembers);
883	}	883	}
884	else if (activationStrategy === group_activation_strategy.POOLED) {	884	else if (activationStrategy === group_activation_strategy.POOLED) {
885	activatedMembers = activatePooledOrder(enabledMembers, lastMessage);	885	activatedMembers = activatePooledOrder(enabledMembers, lastMessage, isUserInput);
886	}	886	}
887	else if (activationStrategy === group_activation_strategy.MANUAL && !isUserInput) {	887	else if (activationStrategy === group_activation_strategy.MANUAL && !isUserInput) {
888	activatedMembers = shuffle(enabledMembers).slice(0, 1).map(x => characters.findIndex(y => y.avatar === x)).filter(x => x !== -1);	888	activatedMembers = shuffle(enabledMembers).slice(0, 1).map(x => characters.findIndex(y => y.avatar === x)).filter(x => x !== -1);

  * Activate group members based on the last message.
  * @param {string[]} members List of member avatars
  * @param {Object} lastMessage Last message
+ * @param {boolean} isUserInput Whether the user has input text
  * @returns {number[]} List of character ids
  */
-function activatePooledOrder(members, lastMessage) {
+function activatePooledOrder(members, lastMessage, isUserInput) {
     /** @type {string} */
     let activatedMember = null;
     /** @type {string[]} */
     const spokenSinceUser = [];
     for (const message of chat.slice().reverse()) {
-        if (message.is_user) {
+        if (message.is_user || isUserInput) {
             break;
+        }

public/scripts/openai.js+36 -21 Viewed

  * Handles errors during streaming requests.
  * @param {Response} response
  * @param {string} decoded - response text or decoded stream data
+ * @param {object} [options]
+ * @param {boolean?} [options.quiet=false] Suppress toast messages
  */
-function tryParseStreamingError(response, decoded) {
+export function tryParseStreamingError(response, decoded, { quiet = false } = {}) {
     try {
         const data = JSON.parse(decoded);

@@ -1453,19 +1455,19 @@ function tryParseStreamingError(response, decoded) {
1453	return;	1455	return;
1454	}	1456	}
1455		1457
1456	checkQuotaError(data);	1458	checkQuotaError(data, { quiet });
1457	checkModerationError(data);	1459	checkModerationError(data, { quiet });
1458		1460
1459	// these do not throw correctly (equiv to Error("[object Object]"))	1461	// these do not throw correctly (equiv to Error("[object Object]"))
1460	// if trying to fix "[object Object]" displayed to users, start here	1462	// if trying to fix "[object Object]" displayed to users, start here
1461		1463
1462	if (data.error) {	1464	if (data.error) {
1463	toastr.error(data.error.message \|\| response.statusText, 'Chat Completion API');	1465	!quiet && toastr.error(data.error.message \|\| response.statusText, 'Chat Completion API');
1464	throw new Error(data);	1466	throw new Error(data);
1465	}	1467	}
1466		1468
1467	if (data.message) {	1469	if (data.message) {
1468	toastr.error(data.message, 'Chat Completion API');	1470	!quiet && toastr.error(data.message, 'Chat Completion API');
1469	throw new Error(data);	1471	throw new Error(data);
1470	}	1472	}
1471	}	1473	}

 /**
  * Checks if the response contains a quota error and displays a popup if it does.
  * @param data
+ * @param {object} [options]
+ * @param {boolean?} [options.quiet=false] Suppress toast messages
  * @returns {void}
  * @throws {object} - response JSON
  */
-function checkQuotaError(data) {
+function checkQuotaError(data, { quiet = false } = {}) {
     if (!data) {
         return;
+    }
     if (data.quota_error) {
-        renderTemplateAsync('quotaError').then((html) => Popup.show.text('Quota Error', html));
+        !quiet && renderTemplateAsync('quotaError').then((html) => Popup.show.text('Quota Error', html));
         // this does not throw correctly (equiv to Error("[object Object]"))
         // if trying to fix "[object Object]" displayed to users, start here

+    }
+}
-function checkModerationError(data) {
+/**
+ * @param {any} data
+ * @param {object} [options]
+ * @param {boolean?} [options.quiet=false] Suppress toast messages
+ */
+function checkModerationError(data, { quiet = false } = {}) {
     const moderationError = data?.error?.message?.includes('requires moderation');
-    if (moderationError) {
+    if (moderationError && !quiet) {
         const moderationReason = `Reasons: ${data?.error?.metadata?.reasons?.join(', ') ?? '(N/A)'}`;
         const flaggedText = data?.error?.metadata?.flagged_input ?? '(N/A)';
         toastr.info(flaggedText, moderationReason, { timeOut: 10000 });

  * Extracts the reply from the response data from a chat completions-like source
  * @param {object} data Response data from the chat completions-like source
  * @param {object} state Additional state to keep track of
+ * @param {object} [options] Additional options
+ * @param {string?} [options.chatCompletionSource] Chat completion source
+ * @param {boolean?} [options.overrideShowThoughts] Override show thoughts
  * @returns {string} The reply extracted from the response data
  */
-function getStreamingReply(data, state) {
+export function getStreamingReply(data, state, { chatCompletionSource = null, overrideShowThoughts = null } = {}) {
-    if (oai_settings.chat_completion_source === chat_completion_sources.CLAUDE) {
+    const chat_completion_source = chatCompletionSource ?? oai_settings.chat_completion_source;
-        if (oai_settings.show_thoughts) {
+    const show_thoughts = overrideShowThoughts ?? oai_settings.show_thoughts;
+    if (chat_completion_source === chat_completion_sources.CLAUDE) {
+        if (show_thoughts) {
             state.reasoning += data?.delta?.thinking || '';
+        }
         return data?.delta?.text || '';
-    } else if (oai_settings.chat_completion_source === chat_completion_sources.MAKERSUITE) {
+    } else if (chat_completion_source === chat_completion_sources.MAKERSUITE) {
         const inlineData = data?.candidates?.[0]?.content?.parts?.find(x => x.inlineData)?.inlineData;
         if (inlineData) {
             state.image = `data:${inlineData.mimeType};base64,${inlineData.data}`;
+        }
-        if (oai_settings.show_thoughts) {
+        if (show_thoughts) {
             state.reasoning += (data?.candidates?.[0]?.content?.parts?.filter(x => x.thought)?.map(x => x.text)?.[0] || '');
+        }
         return data?.candidates?.[0]?.content?.parts?.filter(x => !x.thought)?.map(x => x.text)?.[0] || '';
-    } else if (oai_settings.chat_completion_source === chat_completion_sources.COHERE) {
+    } else if (chat_completion_source === chat_completion_sources.COHERE) {
         return data?.delta?.message?.content?.text || data?.delta?.message?.tool_plan || '';
-    } else if (oai_settings.chat_completion_source === chat_completion_sources.DEEPSEEK) {
+    } else if (chat_completion_source === chat_completion_sources.DEEPSEEK) {
-        if (oai_settings.show_thoughts) {
+        if (show_thoughts) {
             state.reasoning += (data.choices?.filter(x => x?.delta?.reasoning_content)?.[0]?.delta?.reasoning_content || '');
+        }
         return data.choices?.[0]?.delta?.content || '';
-    } else if (oai_settings.chat_completion_source === chat_completion_sources.OPENROUTER) {
+    } else if (chat_completion_source === chat_completion_sources.OPENROUTER) {
-        if (oai_settings.show_thoughts) {
+        if (show_thoughts) {
             state.reasoning += (data.choices?.filter(x => x?.delta?.reasoning)?.[0]?.delta?.reasoning || '');
+        }
         return data.choices?.[0]?.delta?.content ?? data.choices?.[0]?.message?.content ?? data.choices?.[0]?.text ?? '';
-    } else if (oai_settings.chat_completion_source === chat_completion_sources.CUSTOM) {
+    } else if (chat_completion_source === chat_completion_sources.CUSTOM) {
-        if (oai_settings.show_thoughts) {
+        if (show_thoughts) {
             state.reasoning +=
                 data.choices?.filter(x => x?.delta?.reasoning_content)?.[0]?.delta?.reasoning_content ??
                 data.choices?.filter(x => x?.delta?.reasoning)?.[0]?.delta?.reasoning ??

public/scripts/slash-commands.js+66 -15 Viewed

 import { SlashCommandAbortController } from './slash-commands/SlashCommandAbortController.js';
 import { SlashCommandNamedArgumentAssignment } from './slash-commands/SlashCommandNamedArgumentAssignment.js';
 import { SlashCommandEnumValue, enumTypes } from './slash-commands/SlashCommandEnumValue.js';
-import { POPUP_TYPE, Popup, callGenericPopup } from './popup.js';
+import { POPUP_RESULT, POPUP_TYPE, Popup, callGenericPopup } from './popup.js';
 import { commonEnumProviders, enumIcons } from './slash-commands/SlashCommandCommonEnumsProvider.js';
 import { SlashCommandBreakController } from './slash-commands/SlashCommandBreakController.js';
 import { SlashCommandExecutionError } from './slash-commands/SlashCommandExecutionError.js';

 import { accountStorage } from './util/AccountStorage.js';
 import { SlashCommandDebugController } from './slash-commands/SlashCommandDebugController.js';
 import { SlashCommandScope } from './slash-commands/SlashCommandScope.js';
+import { t } from './i18n.js';
 export {
     executeSlashCommands, executeSlashCommandsWithOptions, getSlashCommandsHelp, registerSlashCommand,
 };

     SlashCommandParser.addCommandObject(SlashCommand.fromProps({
         name: 'buttons',
         callback: buttonsCallback,
-        returns: 'clicked button label',
+        returns: 'clicked button label (or array of labels if multiple is enabled)',
         namedArgumentList: [
-            new SlashCommandNamedArgument(
+            SlashCommandNamedArgument.fromProps({
-                'labels', 'button labels', [ARGUMENT_TYPE.LIST], true,
+                name: 'labels',
-            ),
+                description: 'button labels',
+                typeList: [ARGUMENT_TYPE.LIST],
+                isRequired: true,
+            }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'multiple',
+                description: 'if enabled multiple buttons can be clicked/toggled, and all clicked buttons are returned as an array',
+                typeList: [ARGUMENT_TYPE.BOOLEAN],
+                enumList: commonEnumProviders.boolean('trueFalse')(),
+                defaultValue: 'false',
+            }),
         ],
         unnamedArgumentList: [
-            new SlashCommandArgument(
+            SlashCommandArgument.fromProps({
-                'text', [ARGUMENT_TYPE.STRING], true,
+                description: 'text',
-            ),
+                typeList: [ARGUMENT_TYPE.STRING],
+                isRequired: true,
+            }),
         ],
         helpString: `
         <div>

+    }
+}
+/**
+ * Displays a popup with buttons based on provided labels and handles button interactions.
+ *
+ * @param {object} args - Named arguments for the command
+ * @param {string} args.labels - JSON string of an array of button labels
+ * @param {string} [args.multiple=false] - Flag indicating if multiple buttons can be toggled
+ * @param {string} text - The text content to be displayed within the popup
+ *
+ * @returns {Promise<string>} - A promise that resolves to a string of the button labels selected
+ *                              If 'multiple' is true, returns a JSON string array of labels.
+ *                              If 'multiple' is false, returns a single label string.
+ */
 async function buttonsCallback(args, text) {
     try {
         /** @type {string[]} */

             return '';
+        }
+        /** @type {Set<number>} */
+        const multipleToggledState = new Set();
+        const multiple = isTrueBoolean(args?.multiple);
         // Map custom buttons to results. Start at 2 because 1 and 0 are reserved for ok and cancel
         const resultToButtonMap = new Map(buttons.map((button, index) => [index + 2, button]));

             for (const [result, button] of resultToButtonMap) {
                 const buttonElement = document.createElement('div');
-                buttonElement.classList.add('menu_button', 'result-control', 'wide100p');
+                buttonElement.classList.add('menu_button', 'wide100p');
-                buttonElement.dataset.result = String(result);
-                buttonElement.addEventListener('click', async () => {
+                if (multiple) {
-                    await popup.complete(result);
+                    buttonElement.classList.add('toggleable');
-                });
+                    buttonElement.dataset.toggleValue = String(result);
+                    buttonElement.addEventListener('click', async () => {
+                        buttonElement.classList.toggle('toggled');
+                        if (buttonElement.classList.contains('toggled')) {
+                            multipleToggledState.add(result);
+                        } else {
+                            multipleToggledState.delete(result);
+                        }
+                    });
+                } else {
+                    buttonElement.classList.add('result-control');
+                    buttonElement.dataset.result = String(result);
+                }
                 buttonElement.innerText = button;
                 buttonContainer.appendChild(buttonElement);
+            }

             popupContainer.style.flexDirection = 'column';
             popupContainer.style.maxHeight = '80vh'; // Limit the overall height of the popup
-            popup = new Popup(popupContainer, POPUP_TYPE.TEXT, '', { okButton: 'Cancel', allowVerticalScrolling: true });
+            popup = new Popup(popupContainer, POPUP_TYPE.TEXT, '', { okButton: multiple ? t`Ok` : t`Cancel`, allowVerticalScrolling: true });
             popup.show()
-                .then((result => resolve(typeof result === 'number' ? resultToButtonMap.get(result) ?? '' : '')))
+                .then((result => resolve(getResult(result))))
                 .catch(() => resolve(''));
+            /** @returns {string} @param {string|number|boolean} result */
+            function getResult(result) {
+                if (multiple) {
+                    const array = result === POPUP_RESULT.AFFIRMATIVE ? Array.from(multipleToggledState).map(r => resultToButtonMap.get(r) ?? '') : [];
+                    return JSON.stringify(array);
+                }
+                return typeof result === 'number' ? resultToButtonMap.get(result) ?? '' : '';
+            }
         });
     } catch {
         return '';

public/style.css+30 -1 Viewed

     pointer-events: none;
+}
+.menu_button.toggleable {
+    padding-left: 20px;
+}
+.menu_button.toggleable.toggled {
+    border-color: var(--active);
+}
+.menu_button.toggleable:not(.toggled) {
+    filter: brightness(80%);
+}
+.menu_button.toggleable::before {
+    font-family: "Font Awesome 6 Free";
+    margin-left: 10px;
+    position: absolute;
+    left: 0;
+}
+.menu_button.toggleable.toggled::before {
+    content: "\f00c";
+    color: var(--active);
+}
+.menu_button.toggleable:not(.toggled)::before {
+    content: "\f00d";
+    color: var(--fullred);
+}
 .fav_on {
     color: var(--golden) !important;
+}

@@ -2921,7 +2950,7 @@ select option:not(:checked) {
2921	}	2950	}
2922		2951
2923	.menu_button.togglable:not(.toggleEnabled) {	2952	.menu_button.togglable:not(.toggleEnabled) {
2924	color: red;	2953	color: var(--fullred);
2925	}	2954	}
2926		2955
2927	.displayBlock {	2956	.displayBlock {