Feat/Link sampler selection lock to TC API Type (#4782) * Update - Revert connection profile change TC commands load order This change was made to prevent preset tied samplers from breaking, such thing doesn't exist anymore. * Update - Unlink preset renaming logic from sampler selection lock * Update - Link TC sampler selection lock to API Type * Fix - Clean comments * Update - Use localforage selectedSamplers and data selectsampler as main sampler selection storage * Fix - ESLint errors * Update - Change lock tooltip with correct description * Fix - Move and await sampler select localforage initializer to finish Tried to move it to the most reasonable place possible that allowed to make an await. * Fix - Make loadTextGenSettings async to load API selected samplers

e8a75c33299b7f164c1af8f531de3a804060a374

Leandro Jofré <leandrotomasjofre@gmail.com>

Signed

Parents: 35949cac0135da800c197891c102409c7ee09c54

public/script.js+1 -1 Viewed

         loadNovelSettings(data, settings.nai_settings ?? settings);
         // TextGen
-        loadTextGenSettings(data, settings);
+        await loadTextGenSettings(data, settings);
         // OpenAI
         loadOpenAISettings(data, settings.oai_settings ?? settings);

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

 ];
 const TC_COMMANDS = [
-    'preset',
     'api',
+    'preset',
     'api-url',
     'model',
     'sysprompt',

public/scripts/preset-manager.js+0 -11 Viewed

 import { POPUP_RESULT, POPUP_TYPE, Popup } from './popup.js';
 import { context_presets, getContextSettings, power_user } from './power-user.js';
 import { reasoning_templates } from './reasoning.js';
-import { getManualPresetSamplers, resetPresetSelectedSamplers, setPresetSamplersState } from './samplerSelect.js';
 import { SlashCommand } from './slash-commands/SlashCommand.js';
 import { ARGUMENT_TYPE, SlashCommandArgument } from './slash-commands/SlashCommandArgument.js';
 import { enumIcons } from './slash-commands/SlashCommandCommonEnumsProvider.js';

             return;
+        }
-        if (apiId === 'textgenerationwebui') {
-            const manualSamplersIterable = Object.entries(getManualPresetSamplers(oldName));
-            for (const [sampler, value] of manualSamplersIterable) {
-                setPresetSamplersState(sampler, value, newName);
-            }
-            await resetPresetSelectedSamplers(oldName, true);
-        }
         const successToast = !presetManager.isAdvancedFormatting() ? t`Preset renamed` : t`Template renamed`;
         toastr.success(successToast);
     });

public/scripts/samplerSelect.js+133 -295 Viewed

     main_api,
     saveSettingsDebounced,
 } from '../script.js';
-import { power_user } from './power-user.js';
 //import { BIAS_CACHE, displayLogitBias, getLogitBiasListResult } from './logit-bias.js';
 //import { getEventSourceStream } from './sse-stream.js';
 //import { getSortableDelay, onlyUnique } from './utils.js';

 const forcedOnColoring = 'color: #89db35;';
 const forcedOffColoring = 'color: #e84f62;';
+const SELECT_SAMPLER = {
-let userDisabledSamplers, userShownSamplers;
+    DATA: 'selectsampler',
+    SHOWN: 'shown',
+    HIDDEN: 'hidden',
+};
 const textGenObjectStore = localforage.createInstance({ name: 'SillyTavern_TextCompletions' });
 let selectedSamplers = {};

     $('#resetSelectedSamplers').off('click').on('click', async function () {
         console.log('saw sampler select reset click');
-        userDisabledSamplers = [];
-        userShownSamplers = [];
-        power_user.selectSamplers.forceShown = [];
-        power_user.selectSamplers.forceHidden = [];
         if (main_api === 'textgenerationwebui') {
             $('#prioritizeManuallySelectedSamplers').toggleClass('toggleEnabled', false);
-            await resetPresetSelectedSamplers(null, true);
+            await resetApiSelectedSamplers(null, true);
+        }
         await validateDisabledSamplers(true);
     });
-    $('#textgen_type').on('change', async function () {
-        console.log('changed TG Type, resetting custom samplers'); //unfortunate, but necessary unless we save custom samplers for each TGTytpe
-        userDisabledSamplers = [];
-        userShownSamplers = [];
-        power_user.selectSamplers.forceShown = [];
-        power_user.selectSamplers.forceHidden = [];
-        await validateDisabledSamplers();
-    });
     if (main_api === 'textgenerationwebui') {
         $('#prioritizeManuallySelectedSamplers').show();
         $('#prioritizeManuallySelectedSamplers').toggleClass('toggleEnabled', isSamplerManualPriorityEnabled());

+    }
     await showPromise;
-    if (main_api === 'textgenerationwebui') await savePresetSelectedSamplers();
+    if (main_api === 'textgenerationwebui') await saveApiSelectedSamplers();
+}
-function setSamplerListListeners() {
+function getRelatedDOMElement(samplerName) {
-    // Goal 2: hide unchecked samplers from DOM
-    let listContainer = $('#apiSamplersList');
-    listContainer.find('input').off('change').on('change', async function () {
-        const samplerName = this.name.replace('_checkbox', '');
     let relatedDOMElement = $(`#${samplerName}_${main_api}`).parent();
     let targetDisplayType = 'flex';
+    let displayname;
     if (samplerName === 'json_schema') {
         relatedDOMElement = $('#json_schema_block');
         targetDisplayType = 'block';
+        displayname = 'JSON Schema Block';
+    }
     if (samplerName === 'grammar_string') {
         relatedDOMElement = $('#grammar_block_ooba');
         targetDisplayType = 'block';
+        displayname = 'Grammar Block';
+    }
     if (samplerName === 'guidance_scale') {
         relatedDOMElement = $('#cfg_block_ooba');
         targetDisplayType = 'block';
+        displayname = 'CFG Block';
+    }
     if (samplerName === 'mirostat_mode') {
         relatedDOMElement = $('#mirostat_block_ooba');
         targetDisplayType = 'block';
+        displayname = 'Mirostat Block';
+    }
     if (samplerName === 'dry_multiplier') {
         relatedDOMElement = $('#dryBlock');
         targetDisplayType = 'block';
+        displayname = 'DRY Rep Pen Block';
+    }
     if (samplerName === 'xtc_probability') {
         relatedDOMElement = $('#xtc_block');
         targetDisplayType = 'block';
+        displayname = 'XTC Block';
+    }
     if (samplerName === 'dynatemp') {
         relatedDOMElement = $('#dynatemp_block_ooba');
         targetDisplayType = 'block';
+        displayname = 'DynaTemp Block';
+    }
     if (samplerName === 'banned_tokens') {

     if (samplerName === 'sampler_order') { //this is for kcpp sampler order
         relatedDOMElement = $('#sampler_order_block_kcpp');
+        displayname = 'KCPP Sampler Order Block';
+    }
     if (samplerName === 'samplers') { //this is for lcpp sampler order
         relatedDOMElement = $('#sampler_order_block_lcpp');
+        displayname = 'LCPP Sampler Order Block';
+    }
     if (samplerName === 'sampler_priority') { //this is for ooba's sampler priority
         relatedDOMElement = $('#sampler_priority_block_ooba');
+        displayname = 'Ooba Sampler Priority Block';
+    }
     if (samplerName === 'samplers_priorities') { //this is for aphrodite's sampler priority
         relatedDOMElement = $('#sampler_priority_block_aphrodite');
+        displayname = 'Aphrodite Sampler Priority Block';
+    }
     if (samplerName === 'penalty_alpha') { //contrastive search only has one sampler, does it need its own block?
         relatedDOMElement = $('#contrastiveSearchBlock');
+        displayname = 'Contrast Search Block';
+    }
     if (samplerName === 'num_beams') { // num_beams is the killswitch for Beam Search
         relatedDOMElement = $('#beamSearchBlock');
         targetDisplayType = 'block';
+        displayname = 'Beam Search Block';
+    }
     if (samplerName === 'smoothing_factor') { // num_beams is the killswitch for Beam Search
         relatedDOMElement = $('#smoothingBlock');
         targetDisplayType = 'block';
+        displayname = 'Smoothing Block';
+    }
+    return { relatedDOMElement, targetDisplayType, displayname };
+}
+function setSamplerListListeners() {
+    // Goal 2: hide unchecked samplers from DOM
+    let listContainer = $('#apiSamplersList');
+    listContainer.find('input').off('change').on('change', async function () {
+        const samplerName = this.name.replace('_checkbox', '');
+        const { relatedDOMElement, targetDisplayType } = getRelatedDOMElement(samplerName);
         // Get the current state of the custom data attribute
-        const previousState = relatedDOMElement.data('selectsampler');
+        const previousState = relatedDOMElement.data(SELECT_SAMPLER.DATA);
+        const isChecked = $(this).prop('checked');
-        if ($(this).prop('checked') === false) {
+        const popupInputLabel = $(this).parent().find('.sampler_name');
-            //console.log('saw clicking checkbox from on to off...');
-            if (previousState === 'shown') {
+        if (isChecked === false) {
-                console.log('saw previously custom shown sampler');
+            if (previousState === SELECT_SAMPLER.SHOWN) {
-                //console.log('removing from custom force show list');
+                console.log('saw previously custom shown sampler => new state:', isChecked, samplerName);
-                relatedDOMElement.removeData('selectsampler');
+                relatedDOMElement.removeData(SELECT_SAMPLER.DATA);
-                $(this).parent().find('.sampler_name').removeAttr('style');
+                popupInputLabel.removeAttr('style');
-                power_user?.selectSamplers?.forceShown.splice(power_user?.selectSamplers?.forceShown.indexOf(samplerName), 1);
+            } else {
-                console.log(power_user?.selectSamplers?.forceShown);
+                console.log('saw previous untouched sampler => new state:', isChecked, samplerName);
+                relatedDOMElement.data(SELECT_SAMPLER.DATA, SELECT_SAMPLER.HIDDEN);
+                popupInputLabel.attr('style', forcedOffColoring);
+            }
         } else {
-                console.log('saw previous untouched sampler');
+            if (previousState === SELECT_SAMPLER.HIDDEN) {
-                //console.log(`adding ${samplerName} to force hide list`);
+                console.log('saw previously custom hidden sampler => new state:', isChecked, samplerName);
-                relatedDOMElement.data('selectsampler', 'hidden');
+                relatedDOMElement.removeData(SELECT_SAMPLER.DATA);
-                console.log(relatedDOMElement.data('selectsampler'));
+                popupInputLabel.removeAttr('style');
-                power_user.selectSamplers.forceHidden.push(samplerName);
-                $(this).parent().find('.sampler_name').attr('style', forcedOffColoring);
-                console.log(power_user.selectSamplers.forceHidden);
-            }
-        } else { // going from unchecked to checked
-            //console.log('saw clicking checkbox from off to on...');
-            if (previousState === 'hidden') {
-                console.log('saw previously custom hidden sampler');
-                //console.log('removing from custom force hide list');
-                relatedDOMElement.removeData('selectsampler');
-                $(this).parent().find('.sampler_name').removeAttr('style');
-                power_user?.selectSamplers?.forceHidden.splice(power_user?.selectSamplers?.forceHidden.indexOf(samplerName), 1);
-                console.log(power_user?.selectSamplers?.forceHidden);
             } else {
-                console.log('saw previous untouched sampler');
+                console.log('saw previous untouched sampler => new state:', isChecked, samplerName);
-                //console.log(`adding ${samplerName} to force shown list`);
+                relatedDOMElement.data(SELECT_SAMPLER.DATA, SELECT_SAMPLER.SHOWN);
-                relatedDOMElement.data('selectsampler', 'shown');
+                popupInputLabel.attr('style', forcedOnColoring);
-                console.log(relatedDOMElement.data('selectsampler'));
-                power_user.selectSamplers.forceShown.push(samplerName);
-                $(this).parent().find('.sampler_name').attr('style', forcedOnColoring);
-                console.log(power_user.selectSamplers.forceShown);
+            }
+        }
         await saveSettingsDebounced();
-        const shouldDisplay = $(this).prop('checked') ? targetDisplayType : 'none';
+        const shouldDisplay = isChecked ? targetDisplayType : 'none';
         relatedDOMElement.css('display', shouldDisplay);
-        if (main_api === 'textgenerationwebui') {
+        if (main_api === 'textgenerationwebui') setApiSamplersState(samplerName, shouldDisplay !== 'none');
-            setPresetSamplersState(samplerName, shouldDisplay !== 'none');
-        }
-        console.log(samplerName, relatedDOMElement.data('selectsampler'), shouldDisplay);
+        console.log(samplerName, relatedDOMElement.data(SELECT_SAMPLER.DATA), shouldDisplay);
     });
+}

         return availableSamplers;
+    }
-    const samplersActivatedManually = (main_api === 'textgenerationwebui') ? getManualActivePresetSamplers() : [];
+    const samplersActivatedManually = (main_api === 'textgenerationwebui') ? getActiveManualApiSamplers() : [];
     const prioritizeManualSamplerSelect = (main_api === 'textgenerationwebui') ? isSamplerManualPriorityEnabled() : false;
     const samplersListHTML = availableSamplers.reduce((html, sampler) => {
-        let customColor, displayname;
+        let customColor;
-        let targetDOMelement = $(`#${sampler}_${main_api}`);
+        let { relatedDOMElement, displayname } = getRelatedDOMElement(sampler);
-        if (sampler === 'sampler_order') { //this is for kcpp sampler order
-            targetDOMelement = $('#sampler_order_block_kcpp');
-            displayname = 'KCPP Sampler Order Block';
-        }
-        if (sampler === 'samplers') { //this is for lcpp sampler order
-            targetDOMelement = $('#sampler_order_block_lcpp');
-            displayname = 'LCPP Sampler Order Block';
-        }
-        if (sampler === 'sampler_priority') { //this is for ooba's sampler priority
-            targetDOMelement = $('#sampler_priority_block_ooba');
-            displayname = 'Ooba Sampler Priority Block';
-        }
-        if (sampler === 'samplers_priorities') { //this is for aphrodite's sampler priority
-            targetDOMelement = $('#sampler_priority_block_aphrodite');
-            displayname = 'Aphrodite Sampler Priority Block';
-        }
-        if (sampler === 'penalty_alpha') { //contrastive search only has one sampler, does it need its own block?
-            targetDOMelement = $('#contrastiveSearchBlock');
-            displayname = 'Contrast Search Block';
-        }
-        if (sampler === 'num_beams') { // num_beams is the killswitch for Beam Search
-            targetDOMelement = $('#beamSearchBlock');
-            displayname = 'Beam Search Block';
-        }
-        if (sampler === 'smoothing_factor') { // num_beams is the killswitch for Beam Search
-            targetDOMelement = $('#smoothingBlock');
-            displayname = 'Smoothing Block';
-        }
-        if (sampler === 'dry_multiplier') {
+        const isManuallyActivated = samplersActivatedManually.includes(sampler);
-            targetDOMelement = $('#dryBlock');
+        const displayModified = relatedDOMElement.data(SELECT_SAMPLER.DATA);
-            displayname = 'DRY Rep Pen Block';
+        const isInDefaultState = !displayModified;
-        }
-        if (sampler === 'xtc_probability') {
-            targetDOMelement = $('#xtc_block');
-            displayname = 'XTC Block';
-        }
-        if (sampler === 'dynatemp') {
+        const shouldBeChecked = () => {
-            targetDOMelement = $('#dynatemp_block_ooba');
+            let finalState = isElementVisibleInDOM(relatedDOMElement[0]);
-            displayname = 'DynaTemp Block';
-        }
-        if (sampler === 'json_schema') {
+            if (prioritizeManualSamplerSelect) {
-            targetDOMelement = $('#json_schema_block');
+                finalState = isManuallyActivated;
-            displayname = 'JSON Schema Block';
+            }
-        if (sampler === 'grammar_string') {
+            else if (!isInDefaultState) {
-            targetDOMelement = $('#grammar_block_ooba');
+                finalState = displayModified === SELECT_SAMPLER.SHOWN;
-            displayname = 'Grammar Block';
+                customColor = finalState ? forcedOnColoring : forcedOffColoring;
+            }
-        if (sampler === 'guidance_scale') {
+            return finalState;
-            targetDOMelement = $('#cfg_block_ooba');
+        };
-            displayname = 'CFG Block';
-        }
-        if (sampler === 'mirostat_mode') {
+        console.log(sampler, relatedDOMElement.prop('id'), isInDefaultState, shouldBeChecked());
-            targetDOMelement = $('#mirostat_block_ooba');
-            displayname = 'Mirostat Block';
-        }
-        const isManuallyActivated = samplersActivatedManually.includes(sampler);
+        if (displayname === undefined) displayname = sampler;
-        const isInForceHiddenArray = userDisabledSamplers.includes(sampler);
+        if (main_api === 'textgenerationwebui') setApiSamplersState(sampler, shouldBeChecked());
-        const isInForceShownArray = userShownSamplers.includes(sampler);
-        let isVisibleInDOM = isElementVisibleInDOM(targetDOMelement[0]);
-        const isInDefaultState = () => {
-            if (isVisibleInDOM && isInForceShownArray) { return false; }
-            else if (!isVisibleInDOM && isInForceHiddenArray) { return false; }
-            else { return true; }
-        };
-        const shouldBeChecked = () => {
-            if (prioritizeManualSamplerSelect) {
-                return isManuallyActivated;
-            }
-            else if (isInForceHiddenArray) {
-                customColor = forcedOffColoring;
-                return false;
-            }
-            else if (isInForceShownArray) {
-                customColor = forcedOnColoring;
-                return true;
-            }
-            else { return isVisibleInDOM; }
-        };
-        console.log(sampler, targetDOMelement.prop('id'), isInDefaultState(), isInForceShownArray, isInForceHiddenArray, shouldBeChecked());
-        if (displayname === undefined) { displayname = sampler; }
-        if (main_api === 'textgenerationwebui') setPresetSamplersState(sampler, shouldBeChecked());
         return html + `
-        <div class="sampler_view_list_item wide50p flex-container">
+        <label class="sampler_view_list_item wide50p flex-container">
             <input type="checkbox" name="${sampler}_checkbox" ${shouldBeChecked() ? 'checked' : ''}>
             <small class="sampler_name" style="${customColor}">${displayname}</small>
-        </div>
+        </label>`;
-        `;
     }, '');
     return samplersListHTML;

         return;
+    }
-    const samplersActivatedManually = (main_api === 'textgenerationwebui') ? getManualActivePresetSamplers() : [];
+    const samplersActivatedManually = (main_api === 'textgenerationwebui') ? getActiveManualApiSamplers() : [];
     const prioritizeManualSamplerSelect = (main_api === 'textgenerationwebui') ? isSamplerManualPriorityEnabled() : false;
     for (const sampler of APISamplers) {
-        let relatedDOMElement = $(`#${sampler}_${main_api}`).parent();
+        const { relatedDOMElement, targetDisplayType } = getRelatedDOMElement(sampler);
-        let targetDisplayType = 'flex';
-        if (sampler === 'json_schema') {
-            relatedDOMElement = $('#json_schema_block');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'grammar_string') {
-            relatedDOMElement = $('#grammar_block_ooba');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'guidance_scale') {
-            relatedDOMElement = $('#cfg_block_ooba');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'mirostat_mode') {
-            relatedDOMElement = $('#mirostat_block_ooba');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'dynatemp') {
-            relatedDOMElement = $('#dynatemp_block_ooba');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'banned_tokens') {
-            relatedDOMElement = $('#banned_tokens_block_ooba');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'sampler_order') { //this is for kcpp sampler order
-            relatedDOMElement = $('#sampler_order_block_kcpp');
-        }
-        if (sampler === 'samplers') { //this is for lcpp sampler order
-            relatedDOMElement = $('#sampler_order_block_lcpp');
-        }
-        if (sampler === 'sampler_priority') { //this is for ooba's sampler priority
-            relatedDOMElement = $('#sampler_priority_block_ooba');
-        }
-        if (sampler === 'samplers_priorities') { //this is for aphrodite's sampler priority
-            relatedDOMElement = $('#sampler_priority_block_aphrodite');
-        }
-        if (sampler === 'dry_multiplier') {
-            relatedDOMElement = $('#dryBlock');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'xtc_probability') {
-            relatedDOMElement = $('#xtc_block');
-            targetDisplayType = 'block';
-        }
-        if (sampler === 'penalty_alpha') { //contrastive search only has one sampler, does it need its own block?
-            relatedDOMElement = $('#contrastiveSearchBlock');
-        }
-        if (sampler === 'num_beams') { // num_beams is the killswitch for Beam Search
-            relatedDOMElement = $('#beamSearchBlock');
-        }
-        if (sampler === 'smoothing_factor') { // num_beams is the killswitch for Beam Search
-            relatedDOMElement = $('#smoothingBlock');
-        }
-        if (power_user?.selectSamplers?.forceHidden.includes(sampler)) {
-            //default handling for standard sliders
-            relatedDOMElement.data('selectsampler', 'hidden');
-            relatedDOMElement.css('display', 'none');
-        } else if (power_user?.selectSamplers?.forceShown.includes(sampler)) {
-            relatedDOMElement.data('selectsampler', 'shown');
-            relatedDOMElement.css('display', targetDisplayType);
-        } else {
-            if (relatedDOMElement.data('selectsampler') === 'hidden') {
-                relatedDOMElement.removeAttr('selectsampler');
-                relatedDOMElement.css('display', targetDisplayType);
-            }
-            if (relatedDOMElement.data('selectsampler') === 'shown') {
-                relatedDOMElement.removeAttr('selectsampler');
-                relatedDOMElement.css('display', 'none');
-            }
-        }
         if (prioritizeManualSamplerSelect) {
             const isManuallyActivated = samplersActivatedManually.includes(sampler);
             relatedDOMElement.css('display', isManuallyActivated ? targetDisplayType : 'none');
+        } else {
+            const selectSamplerData = relatedDOMElement.data(SELECT_SAMPLER.DATA);
+            relatedDOMElement.css('display', selectSamplerData === SELECT_SAMPLER.SHOWN ? targetDisplayType : 'none');
+        }
+        relatedDOMElement.removeData(SELECT_SAMPLER.DATA);
+    }
-    if (redraw) {
+    if (!prioritizeManualSamplerSelect && main_api === 'textgenerationwebui') {
-        if (main_api === 'textgenerationwebui') showTGSamplerControls();
+        showTGSamplerControls();
+    }
+    if (redraw) {
         let samplersHTML = await listSamplers(main_api);
         $('#apiSamplersList').empty().append(samplersHTML.toString());
         setSamplerListListeners();

 /**
  * Initializes the configuration object for manually selected samplers.
+ * @returns void
  */
-export async function loadPresetSelectedSamplers() {
+export async function loadApiSelectedSamplers() {
     try {
         console.debug('Text Completions: loading selected samplers');
         selectedSamplers = await textGenObjectStore.getItem('selectedSamplers') || {};

 /**
  * Synchronizes the local forage instance with the selected samplers configuration object.
+ * @returns void
  */
-export async function savePresetSelectedSamplers() {
+export async function saveApiSelectedSamplers() {
     try {
         console.debug('Text Completions: saving selected samplers');
         await textGenObjectStore.setItem('selectedSamplers', selectedSamplers);

 /**
  * Resets the selected samplers configuration object from the local forage instance.
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @param {boolean} silent Suppresses the toastr message confirming that the data was deleted.
+ * @returns void
  */
-export async function resetPresetSelectedSamplers(presetName = '', silent = false) {
+export async function resetApiSelectedSamplers(tcApiType = '', silent = false) {
     try {
-        if (!textgenerationwebui_settings?.preset && !presetName) return;
+        if (!textgenerationwebui_settings?.type && !tcApiType) return;
-        if (!presetName) presetName = textgenerationwebui_settings.preset;
+        if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-        if (!selectedSamplers[presetName]) return;
+        if (!selectedSamplers[tcApiType]) return;
         console.debug('Text Completions: resetting selected samplers');
-        delete selectedSamplers[presetName];
+        delete selectedSamplers[tcApiType];
-        await savePresetSelectedSamplers();
+        await saveApiSelectedSamplers();
         if (!silent) toastr.success('Selected samplers cleared.');
     } catch (error) {
         console.log('Text Completions: unable to reset selected preset samplers', error);

  * Saves the visibility state for selected samplers into the configuration object.
  * @param {string} samplerName Target sampler key name
  * @param {string|boolean} state Visibility state of the target sampler
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @returns void
  */
-export function setPresetSamplersState(samplerName, state, presetName = '') {
+export function setApiSamplersState(samplerName, state, tcApiType = '') {
-    if (!textgenerationwebui_settings?.preset && !presetName) return;
+    if (!textgenerationwebui_settings?.type && !tcApiType) return;
-    if (!presetName) presetName = textgenerationwebui_settings.preset;
+    if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-    if (!selectedSamplers[presetName]) selectedSamplers[presetName] = {};
+    if (!selectedSamplers[tcApiType]) selectedSamplers[tcApiType] = {};
-    const presetSamplers = selectedSamplers[presetName];
+    const presetSamplers = selectedSamplers[tcApiType];
     presetSamplers[samplerName] = String(state) === 'true';
+}
 /**
- * Returns the local forage object belonging to the active/selected TC preset
+ * Returns the local forage object belonging to the active/selected TC API Type
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @returns {object} Full localforage object with manual selections
  */
-export function getManualPresetSamplers(presetName = '') {
+export function getAllManualApiSamplers(tcApiType = '') {
-    if (!textgenerationwebui_settings?.preset && !presetName) return {};
+    if (!textgenerationwebui_settings?.type && !tcApiType) return {};
-    if (!presetName) presetName = textgenerationwebui_settings.preset;
+    if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-    if (!selectedSamplers[presetName]) selectedSamplers[presetName] = {};
+    if (!selectedSamplers[tcApiType]) selectedSamplers[tcApiType] = {};
-    return selectedSamplers[presetName];
+    return selectedSamplers[tcApiType];
+}
 /**
- * Returns the key names of all the preset samplers activated manually.
+ * Returns the key names of all the manually activated API Type samplers.
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @returns {string[]} Array of sampler key names
  */
-export function getManualActivePresetSamplers(presetName = '') {
+export function getActiveManualApiSamplers(tcApiType = '') {
-    if (!textgenerationwebui_settings?.preset && !presetName) return [];
+    if (!textgenerationwebui_settings?.type && !tcApiType) return [];
-    if (!presetName) presetName = textgenerationwebui_settings.preset;
+    if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-    if (!selectedSamplers[presetName]) selectedSamplers[presetName] = {};
+    if (!selectedSamplers[tcApiType]) selectedSamplers[tcApiType] = {};
     try {
-        const presetSamplers = Object.entries(selectedSamplers[presetName]);
+        const presetSamplers = Object.entries(selectedSamplers[tcApiType]);
         return presetSamplers
             .filter(([key, val]) => val === true && key !== 'st_manual_priority')

 /**
  * @param {string|boolean} state Target state of the feature
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @returns void
  */
-export function toggleSamplerManualPriority(state = false, presetName = '') {
+export function toggleSamplerManualPriority(state = false, tcApiType = '') {
-    if (!textgenerationwebui_settings?.preset && !presetName) return;
+    if (!textgenerationwebui_settings?.type && !tcApiType) return;
-    if (!presetName) presetName = textgenerationwebui_settings.preset;
+    if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-    if (!selectedSamplers[presetName]) selectedSamplers[presetName] = {};
+    if (!selectedSamplers[tcApiType]) selectedSamplers[tcApiType] = {};
-    const presetSamplers = selectedSamplers[presetName];
+    const presetSamplers = selectedSamplers[tcApiType];
     presetSamplers.st_manual_priority = String(state) === 'true';
+}
 /**
- * @param {string?} presetName Name of the target preset - It picks the current active TC preset name by default
+ * @param {string?} tcApiType Name of the target API Type - It picks the currently active TC API type name by default
  * @returns {boolean}
  */
-export function isSamplerManualPriorityEnabled(presetName = '') {
+export function isSamplerManualPriorityEnabled(tcApiType = '') {
-    if (!textgenerationwebui_settings?.preset && !presetName) return false;
+    if (!textgenerationwebui_settings?.type && !tcApiType) return false;
-    if (!presetName) presetName = textgenerationwebui_settings.preset;
+    if (!tcApiType) tcApiType = textgenerationwebui_settings.type;
-    if (!selectedSamplers[presetName]) selectedSamplers[presetName] = {};
+    if (!selectedSamplers[tcApiType]) selectedSamplers[tcApiType] = {};
-    return selectedSamplers[presetName]?.st_manual_priority ?? false;
+    return selectedSamplers[tcApiType]?.st_manual_priority ?? false;
+}
 export async function initCustomSelectedSamplers() {
-    userDisabledSamplers = power_user?.selectSamplers?.forceHidden || [];
-    userShownSamplers = power_user?.selectSamplers?.forceShown || [];
-    power_user.selectSamplers = {};
-    power_user.selectSamplers.forceHidden = userDisabledSamplers;
-    power_user.selectSamplers.forceShown = userShownSamplers;
     await saveSettingsDebounced();
     $('#samplerSelectButton').off('click').on('click', showSamplerSelectPopup);
+}

public/scripts/templates/samplerSelector.html+1 -1 Viewed

                 <i class="fa-solid fa-lock"></i>
                 <span data-i18n="Prioritize">Prioritize</span>
             </div>
-            <div class="margin5 fa-solid fa-exclamation-circle" data-i18n="[title]Toggle on to force the samplers selected in this menu to be shown when switching to this preset. By default, SillyTavern automatically selects samplers used or needed by the selected API Type in the API Connections panel." title="Toggle on to force the samplers selected in this menu to be shown when switching to this preset. By default, SillyTavern automatically selects samplers used or needed by the selected API Type in the API Connections panel."></div>
+            <div class="margin5 fa-solid fa-exclamation-circle" data-i18n="[title]Toggle on to force the samplers selected in this menu to be shown when switching to the current API Type (API Connections Panel). By default, SillyTavern automatically selects samplers used or needed by the selected API Type." title="Toggle on to force the samplers selected in this menu to be shown when switching to the current API Type (API Connections Panel). By default, SillyTavern automatically selects samplers used or needed by the selected API Type."></div>
         </div>
         <!--<div class="flex-container alignItemsBaseline">
             <div class="menu_button menu_button_icon" title="Create a new sampler">

public/scripts/textgen-settings.js+13 -18 Viewed

 import { BIAS_CACHE, createNewLogitBiasEntry, displayLogitBias, getLogitBiasListResult } from './logit-bias.js';
 import { power_user, registerDebugFunction } from './power-user.js';
-import { getManualActivePresetSamplers, isSamplerManualPriorityEnabled, loadPresetSelectedSamplers } from './samplerSelect.js';
+import { getActiveManualApiSamplers, loadApiSelectedSamplers, isSamplerManualPriorityEnabled } from './samplerSelect.js';
 import { SECRET_KEYS, writeSecret } from './secrets.js';
 import { getEventSourceStream } from './sse-stream.js';
 import { getCurrentDreamGenModelTokenizer, getCurrentOpenRouterModelTokenizer, loadAphroditeModels, loadDreamGenModels, loadFeatherlessModels, loadGenericModels, loadInfermaticAIModels, loadMancerModels, loadOllamaModels, loadOpenRouterModels, loadTabbyModels, loadTogetherAIModels, loadVllmModels } from './textgen-models.js';

         setSettingByName(name, value, true);
+    }
     setGenerationParamsFromPreset(preset);
-    showSamplerControls(null, true);
     BIAS_CACHE.delete(BIAS_KEY);
     displayLogitBias(preset.logit_bias, BIAS_KEY);
     saveSettingsDebounced();

     return result;
+}
-export function loadTextGenSettings(data, loadedSettings) {
+export async function loadTextGenSettings(data, loadedSettings) {
+    await loadApiSelectedSamplers();
     textgenerationwebui_presets = convertPresets(data.textgenerationwebui_presets);
     textgenerationwebui_preset_names = data.textgenerationwebui_preset_names ?? [];
     Object.assign(settings, loadedSettings.textgenerationwebui_settings ?? {});

     $('#textgen_type').val(settings.type);
     $('#openrouter_providers_text').val(settings.openrouter_providers).trigger('change');
-    loadPresetSelectedSamplers();
+    showSamplerControls(settings.type);
-    showSamplerControls();
     BIAS_CACHE.delete(BIAS_KEY);
     displayLogitBias(settings.logit_bias, BIAS_KEY);

+}
 export function initTextGenSettings() {
-    loadPresetSelectedSamplers();
     $('#send_banned_tokens_textgenerationwebui').on('change', function () {
         const checked = !!$(this).prop('checked');
         toggleBannedStringsKillSwitch(checked,

 /**
  * Hides and shows preset samplers from the left panel.
  * @param {string?} apiType API Type selected in API Connections - Currently selected one by default
- * @param {boolean?} isPresetSwitch Wheter the trigger comes from a preset switch - false by default
  * @returns void
  */
-function showSamplerControls(apiType = null, isPresetSwitch = false) {
+function showSamplerControls(apiType = null) {
-    const prioritizeManualSamplerSelect = isSamplerManualPriorityEnabled();
+    $('#textgenerationwebui_api-settings [data-tg-samplers]').each(function(idx, elem) {
+        const typeSpecificControlled = $(elem).data('tg-type') !== undefined;
-    if (isPresetSwitch && !prioritizeManualSamplerSelect) return;
-    $('#textgenerationwebui_api-settings [data-tg-samplers]:not([data-tg-type])').each(function() {
+        if (!typeSpecificControlled) $(this).show();
-        $(this).show();
     });
     showTypeSpecificControls(apiType ?? settings.type);
-    const samplersActivatedManually = getManualActivePresetSamplers();
+    const prioritizeManualSamplerSelect = isSamplerManualPriorityEnabled(apiType ?? settings.type);
+    const samplersActivatedManually = getActiveManualApiSamplers(apiType ?? settings.type);
     if (!samplersActivatedManually?.length || !prioritizeManualSamplerSelect) return;

     });
+}
-function showTypeSpecificControls(type) {
+function showTypeSpecificControls(apiType) {
     $('[data-tg-type]').each(function () {
         const mode = String($(this).attr('data-tg-type-mode') ?? '').toLowerCase().trim();
         const tgTypes = $(this).attr('data-tg-type').split(',').map(x => x.trim());
         if (mode === 'except') {
-            $(this)[tgTypes.includes(type) ? 'hide' : 'show']();
+            $(this)[tgTypes.includes(apiType) ? 'hide' : 'show']();
             return;
+        }
         for (const tgType of tgTypes) {
-            if (tgType === type || tgType == 'all') {
+            if (tgType === apiType || tgType == 'all') {
                 $(this).show();
                 return;
             } else {