Merge pull request #2437 from SillyTavern/echo-command-args Add optional args to /echo command

76b822c6278ca4384385c313cf62f3855511a028

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

Signed

Parents: bb39e852b88eca7cc5ba5caf7ac8565ec2e285fb 5c3b799d6589539d6804b74733bad6f1a7dedd9e

public/scripts/slash-commands.js+69 -8 Viewed

                     new SlashCommandEnumValue('success', 'success', enumTypes.enum, '✅'),
                 ],
             }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'timeout',
+                description: 'time in milliseconds to display the toast message. Set this and \'extendedTimeout\' to 0 to show indefinitely until dismissed.',
+                typeList: [ARGUMENT_TYPE.NUMBER],
+                defaultValue: `${toastr.options.timeOut}`,
+            }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'extendedTimeout',
+                description: 'time in milliseconds to display the toast message. Set this and \'timeout\' to 0 to show indefinitely until dismissed.',
+                typeList: [ARGUMENT_TYPE.NUMBER],
+                defaultValue: `${toastr.options.extendedTimeOut}`,
+            }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'preventDuplicates',
+                description: 'prevent duplicate toasts with the same message from being displayed.',
+                typeList: [ARGUMENT_TYPE.BOOLEAN],
+                defaultValue: 'false',
+                enumList: commonEnumProviders.boolean('trueFalse')(),
+            }),
+            SlashCommandNamedArgument.fromProps({
+                name: 'awaitDismissal',
+                description: 'wait for the toast to be dismissed before continuing.',
+                typeList: [ARGUMENT_TYPE.BOOLEAN],
+                defaultValue: 'false',
+                enumList: commonEnumProviders.boolean('trueFalse')(),
+            }),
         ],
         unnamedArgumentList: [
             new SlashCommandArgument(

+    }
+}
+/**
+ *
+ * @param {{title?: string, severity?: string, timeout?: string, extendedTimeout?: string, preventDuplicates?: string, awaitDismissal?: string}} args - named arguments from the slash command
+ * @param {string} value - The string to echo (unnamed argument from the slash command)
+ * @returns {Promise<string>} The text that was echoed
+ */
 async function echoCallback(args, value) {
     // Note: We don't need to sanitize input, as toastr is set up by default to escape HTML via toastr options
     if (value === '') {
         console.warn('WARN: No argument provided for /echo command');
-        return;
+        return '';
+    }
+    if (args.severity && !['error', 'warning', 'success', 'info'].includes(args.severity)) {
+        toastr.warning(`Invalid severity provided for /echo command: ${args.severity}`);
+        args.severity = null;
+    }
+    const title = args.title ? args.title : undefined;
+    const severity = args.severity ? args.severity : 'info';
+    /** @type {ToastrOptions} */
+    const options = {};
+    if (args.timeout && !isNaN(parseInt(args.timeout))) options.timeOut = parseInt(args.timeout);
+    if (args.extendedTimeout && !isNaN(parseInt(args.extendedTimeout))) options.extendedTimeOut = parseInt(args.extendedTimeout);
+    if (isTrueBoolean(args.preventDuplicates)) options.preventDuplicates = true;
+    // Prepare possible await handling
+    let awaitDismissal = isTrueBoolean(args.awaitDismissal);
+    let resolveToastDismissal;
+    if (awaitDismissal) {
+        options.onHidden = () => resolveToastDismissal(value);
+    }
-    const title = args?.title !== undefined && typeof args?.title === 'string' ? args.title : undefined;
-    const severity = args?.severity !== undefined && typeof args?.severity === 'string' ? args.severity : 'info';
     switch (severity) {
         case 'error':
-            toastr.error(value, title);
+            toastr.error(value, title, options);
             break;
         case 'warning':
-            toastr.warning(value, title);
+            toastr.warning(value, title, options);
             break;
         case 'success':
-            toastr.success(value, title);
+            toastr.success(value, title, options);
             break;
         case 'info':
         default:
-            toastr.info(value, title);
+            toastr.info(value, title, options);
             break;
+    }
-    return value;
+    if (awaitDismissal) {
+        return new Promise((resolve) => {
+            resolveToastDismissal = resolve;
+        });
+    } else {
+        return value;
+    }
+}
 async function addSwipeCallback(_, arg) {
     const lastMessage = chat[chat.length - 1];