Merge pull request #2901 from SillyTavern/connection-profile-omit Add ability to omit settings from Connection Profile

9612af6e9af4effcecb280296fb61504958d9362

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

Signed

Parents: b025765a1eafb8b80a33f5a33b4b099f4568908f 50fd3a20281a4737317ca855af6772a271b7a4c5

public/scripts/extensions/connection-manager/edit.html+12 -0 Viewed

 +<div>
 +    <h3>Included settings:</h3>
 +    <div class="justifyLeft flex-container flexFlowColumn flexNoGap">
 +        {{#each settings}}
 +        <label class="checkbox_label">
 +            <input type="checkbox" value="{{@key}}" name="exclude"{{#if this}} checked{{/if}}>
 +            <span>{{@key}}</span>
 +        </label>
 +        {{/each}}
 +    </div>
 +    <h3>Profile name:</h3>
 +</div>

public/scripts/extensions/connection-manager/index.js+90 -10 Viewed

 import { event_types, eventSource, main_api, saveSettingsDebounced } from '../../../script.js';
 import { extension_settings, renderExtensionTemplateAsync } from '../../extensions.js';
 import { callGenericPopup, Popup, POPUP_RESULT, POPUP_TYPE } from '../../popup.js';
 import { SlashCommand } from '../../slash-commands/SlashCommand.js';
 import { SlashCommandAbortController } from '../../slash-commands/SlashCommandAbortController.js';
 import { ARGUMENT_TYPE, SlashCommandArgument, SlashCommandNamedArgument } from '../../slash-commands/SlashCommandArgument.js';

  * @property {string} [context] Context Template
  * @property {string} [instruct-state] Instruct Mode
  * @property {string} [tokenizer] Tokenizer
 + * @property {string[]} [exclude] Commands to exclude
  */
 /**

 async function readProfileFromCommands(mode, profile, cleanUp = false) {
     const commands = mode === 'cc' ? CC_COMMANDS : TC_COMMANDS;
     const opposingCommands = mode === 'cc' ? TC_COMMANDS : CC_COMMANDS;
 +    const excludeList = Array.isArray(profile.exclude) ? profile.exclude : [];
     for (const command of commands) {
         try {
 +            if (excludeList.includes(command)) {
 +                continue;
 +            }
++
             const args = getNamedArguments();
             const result = await SlashCommandParser.commands[command].callback(args, '');
             if (result) {

 async function createConnectionProfile(forceName = null) {
     const mode = main_api === 'openai' ? 'cc' : 'tc';
     const id = uuidv4();
 +    /** @type {ConnectionProfile} */
     const profile = {
         id,
         mode,
 +        exclude: [],
     };
     await readProfileFromCommands(mode, profile);
     const profileForDisplay = makeFancyProfile(profile);
     const template = $(await renderExtensionTemplateAsync(MODULE_NAME, 'profile', { profile: profileForDisplay }));
 +    template.find('input[name="exclude"]').on('input', function () {
 +        const fancyName = String($(this).val());
 +        const keyName = Object.entries(FANCY_NAMES).find(x => x[1] === fancyName)?.[0];
 +        if (!keyName) {
 +            console.warn('Key not found for fancy name:', fancyName);
 +            return;
 +        }
++
 +        if (!Array.isArray(profile.exclude)) {
 +            profile.exclude = [];
 +        }
++
 +        const excludeState = !$(this).prop('checked');
 +        if (excludeState) {
 +            profile.exclude.push(keyName);
 +        } else {
 +            const index = profile.exclude.indexOf(keyName);
 +            index !== -1 && profile.exclude.splice(index, 1);
 +        }
 +    });
     const isNameTaken = (n) => extension_settings.connectionManager.profiles.some(p => p.name === n);
     const suggestedName = getUniqueName(collapseSpaces(`${profile.api ?? ''} ${profile.model ?? ''} - ${profile.preset ?? ''}`), isNameTaken);
     const name = forceName ?? await callGenericPopup(template, POPUP_TYPE.INPUT, suggestedName, { rows: 2 });

         return null;
+    }
 -    profile.name = name;
 +    if (Array.isArray(profile.exclude)) {
 +        for (const command of profile.exclude) {
 +            delete profile[command];
 +        }
 +    }
++
 +    profile.name = String(name);
     return profile;
+}

     const profile = extension_settings.connectionManager.profiles.find(p => p.id === selectedProfile);
     if (profile) {
         const profileForDisplay = makeFancyProfile(profile);
         const templatetemplateParams = await renderExtensionTemplateAsync(MODULE_NAME, 'view', { profile: profileForDisplay });
 +        if (Array.isArray(profile.exclude) && profile.exclude.length > 0) {
 +            templateParams.omitted = profile.exclude.map(e => FANCY_NAMES[e]).join(', ');
 +        }
 +        const template = await renderExtensionTemplateAsync(MODULE_NAME, 'view', templateParams);
         detailsContent.innerHTML = template;
     } else {
         detailsContent.textContent = 'No profile selected';

         await eventSource.emit(event_types.CONNECTION_PROFILE_LOADED, NONE);
     });
     const renameButtoneditButton = document.getElementById('rename_connection_profileedit_connection_profile');
     renameButtoneditButton.addEventListener('click', async () => {
         const selectedProfile = extension_settings.connectionManager.selectedProfile;
         const profile = extension_settings.connectionManager.profiles.find(p => p.id === selectedProfile);
         if (!profile) {

             return;
+        }
 -        const newName = await Popup.show.input('Enter a new name', null, profile.name, { rows: 2 });
 +        if (!Array.isArray(profile.exclude)) {
 +            profile.exclude = [];
 +        }
++
 +        let saveChanges = false;
 +        const commands = profile.mode === 'cc' ? CC_COMMANDS : TC_COMMANDS;
 +        const settings = commands.reduce((acc, command) => {
 +            const fancyName = FANCY_NAMES[command];
 +            acc[fancyName] = !profile.exclude.includes(command);
 +            return acc;
 +        }, {});
 +        const template = $(await renderExtensionTemplateAsync(MODULE_NAME, 'edit', { name: profile.name, settings }));
 +        const newName = await callGenericPopup(template, POPUP_TYPE.INPUT, profile.name, {
 +            customButtons: [{
 +                text: 'Save and Update',
 +                classes: ['popup-button-ok'],
 +                result: POPUP_RESULT.AFFIRMATIVE,
 +                action: () => {
 +                    saveChanges = true;
 +                },
 +            }],
 +        });
++
         if (!newName) {
             return;
+        }
         if (profile.name !== newName && extension_settings.connectionManager.profiles.some(p => p.name === newName)) {
             toastr.error('A profile with the same name already exists.');
             return;
+        }
 -        profile.name = newName;
 +        const newExcludeList = template.find('input[name="exclude"]:not(:checked)').map(function () {
 +            return Object.entries(FANCY_NAMES).find(x => x[1] === String($(this).val()))?.[0];
 +        }).get();
++
 +        if (newExcludeList.length !== profile.exclude.length || !newExcludeList.every(e => profile.exclude.includes(e))) {
 +            profile.exclude = newExcludeList;
 +            for (const command of newExcludeList) {
 +                delete profile[command];
 +            }
 +            if (saveChanges) {
 +                await updateConnectionProfile(profile);
 +            } else {
 +                toastr.info('Press "Update" to record them into the profile.', 'Included settings list updated');
 +            }
 +        }
++
 +        if (profile.name !== newName) {
 +            toastr.success('Connection profile renamed.');
 +            profile.name = String(newName);
 +        }
++
         saveSettingsDebounced();
         renderConnectionProfiles(profiles);
 -        toastr.success('Connection profile renamed', '', { timeOut: 1500 });
 +        await renderDetailsContent(detailsContent);
     });
     /** @type {HTMLElement} */

public/scripts/extensions/connection-manager/profile.html+12 -3 Viewed

     <h2 data-i18n="Creating a Connection Profile">
         Creating a Connection Profile
     </h2>
     <uldiv class="justifyLeft flex-container flexFlowColumn flexNoGap">
         {{#each profile}}
 -        <li><strong data-i18n="{{@key}}">{{@key}}:</strong>&nbsp;{{this}}</li>
 +        <label class="checkbox_label">
 +            <input type="checkbox" value="{{@key}}" name="exclude" checked>
 +            <span><strong data-i18n="{{@key}}">{{@key}}:</strong>&nbsp;{{this}}</span>
 +        </label>
         {{/each}}
     </uldiv>
 +    <div class="marginTop5">
 +        <small>
 +            <b>Hint:</b>
 +            <i>Click on the setting name to omit it from the profile.</i>
 +        </small>
 +    </div>
     <h3 data-i18n="Enter a name:">
         Enter a name:
     </h3>

public/scripts/extensions/connection-manager/settings.html+1 -1 Viewed

         <i id="view_connection_profile" class="menu_button fa-solid fa-info-circle" title="View connection profile details" data-i18n="[title]View connection profile details"></i>
         <i id="create_connection_profile" class="menu_button fa-solid fa-file-circle-plus" title="Create a new connection profile" data-i18n="[title]Create a new connection profile"></i>
         <i id="update_connection_profile" class="menu_button fa-solid fa-save" title="Update a connection profile" data-i18n="[title]Update a connection profile"></i>
         <i id="rename_connection_profileedit_connection_profile" class="menu_button fa-solid fa-pencil" title="RenameEdit a connection profile" data-i18n="[title]RenameEdit a connection profile"></i>
         <i id="reload_connection_profile" class="menu_button fa-solid fa-recycle" title="Reload a connection profile" data-i18n="[title]Reload a connection profile"></i>
         <i id="delete_connection_profile" class="menu_button fa-solid fa-trash-can" title="Delete a connection profile" data-i18n="[title]Delete a connection profile"></i>
     </div>

public/scripts/extensions/connection-manager/view.html+5 -0 Viewed

     <li><strong data-i18n="{{@key}}">{{@key}}:</strong>&nbsp;{{this}}</li>
     {{/each}}
 </ul>
 +{{#if omitted}}
 +<div class="margin5">
 +    <strong data-i18n="Omitted Settings:">Omitted Settings:</strong>&nbsp;<span>{{omitted}}</span>
 +</div>
 +{{/if}}