Refactor /classify-expressions, deprecating... - Update /classify-expressions, deprecating the old "format" - Fix some oversights

7a1b43eb8943b48747bd3efa139e81186346f964

Wolfsblvt <wolfsblvt@gmail.com>

Parents: 697b3b2034c20ea15e48002929b696f85bfb3a64

public/scripts/extensions/expressions/index.js+31 -5 Viewed

 import { isFunctionCallingSupported } from '../../openai.js';
 import { SlashCommandEnumValue, enumTypes } from '../../slash-commands/SlashCommandEnumValue.js';
 import { commonEnumProviders } from '../../slash-commands/SlashCommandCommonEnumsProvider.js';
 +import { slashCommandReturnHelper } from '../../slash-commands/SlashCommandReturnHelper.js';
 +import { SlashCommandClosure } from '../../slash-commands/SlashCommandClosure.js';
 export { MODULE_NAME };
 const MODULE_NAME = 'expressions';

         name: 'classify-expressions',
         aliases: ['expressions'],
         callback: async (args) => {
 -            const list = await getExpressionsList();
 +            /** @type {import('../../slash-commands/SlashCommandReturnHelper.js').SlashCommandReturnType} */
 -            switch (String(args.format).toLowerCase()) {
 +            // @ts-ignore
 +            let returnType = args.return;
++
 +            // Old legacy return type handling
 +            if (args.format) {
 +                toastr.warning(`Legacy argument 'format' with value '${args.format}' is deprecated. Please use 'return' instead. Routing to the correct return type...`, 'Deprecation warning');
 +                const type = String(args?.format).toLowerCase().trim();
 +                switch (type) {
                     case 'json':
 -                    return JSON.stringify(list);
 +                        returnType = 'object';
 +                        break;
                     default:
 -                    return list.join(', ');
 +                        returnType = 'pipe';
 +                        break;
 +                }
+            }
++
 +            // Now the actual new return type handling
 +            const list = await getExpressionsList();
++
 +            return await slashCommandReturnHelper.doReturn(returnType ?? 'pipe', list, { objectToStringFunc: list => list.join(', ') });
         },
         namedArgumentList: [
             SlashCommandNamedArgument.fromProps({
 +                name: 'return',
 +                description: 'The way how you want the return value to be provided',
 +                typeList: [ARGUMENT_TYPE.STRING],
 +                defaultValue: 'pipe',
 +                enumList: slashCommandReturnHelper.enumList({ allowObject: true }),
 +                forceEnum: true,
 +            }),
 +            // TODO remove some day
 +            SlashCommandNamedArgument.fromProps({
                 name: 'format',
                 description: '!!! DEPRECATED - use "return" instead !!! The format to return the list in: comma-separated plain text or JSON array. Default is plain text.',
                 typeList: [ARGUMENT_TYPE.STRING],
                 enumList: [
                     new SlashCommandEnumValue('plain', null, enumTypes.enum, ', '),

public/scripts/slash-commands.js+1 -1 Viewed

             // TODO remove some day
             SlashCommandNamedArgument.fromProps({
                 name: 'format',
                 description: '!!! DEPRECATED - use "return" instead !!! output format)',
                 typeList: [ARGUMENT_TYPE.STRING],
                 isRequired: true,
                 forceEnum: true,

public/scripts/slash-commands/SlashCommandReturnHelper.js+1 -1 Viewed

      */
     enumList: ({ allowPipe = true, allowObject = false, allowChat = false, allowPopup = false, allowTextVersion = true } = {}) => [
         allowPipe && new SlashCommandEnumValue('pipe', 'Return to the pipe for the next command', enumTypes.name, '|'),
         allowObject && new SlashCommandEnumValue('object', 'Return as an object (or array) to the pipe for the next command', enumTypes.variable, enumIcons.dictionary),
         allowChat && new SlashCommandEnumValue('chat-html', 'Sending a chat message with the return value - Can display HTML', enumTypes.command, enumIcons.message),
         allowChat && allowTextVersion && new SlashCommandEnumValue('chat-text', 'Sending a chat message with the return value - Will only display as text', enumTypes.qr, enumIcons.message),
         allowPopup && new SlashCommandEnumValue('popup-html', 'Showing as a popup with the return value - Can display HTML', enumTypes.command, enumIcons.popup),

public/scripts/variables.js+1 -1 Viewed

             // TODO remove some day
             SlashCommandNamedArgument.fromProps({
                 name: 'format',
                 description: '!!! DEPRECATED - use "return" instead !!! output format)',
                 typeList: [ARGUMENT_TYPE.STRING],
                 isRequired: true,
                 forceEnum: true,