Renaming a lorebook now re-links itself to cards using it (with a confirmation prompt) (#5323) * renaming a lorebook prompts to update existing links * used suggested api and logic * add world property to shallow function * Fix type error in assignLorebookToChat invoke * Remove debug console logs * Fix activeCharacterUpdated * Extract updateWorldInfoLinks into a func * Invert if for an early return --------- Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

a794a3780aea7e289b42957e7c7a7019d6ec68d6

SoniaNvm <sonianevermindwaifu@gmail.com>

Signed

Parents: 4839c76fb556ac879f4333e49db762f22f52f6e3

public/scripts/world-info.js+89 -11 Viewed

 import { Fuse } from '../lib.js';
-import { saveSettings, substituteParams, getRequestHeaders, chat_metadata, this_chid, characters, saveCharacterDebounced, menu_type, eventSource, event_types, getExtensionPromptByName, saveMetadata, getCurrentChatId, extension_prompt_roles, create_save, createOrEditCharacter, name1 } from '../script.js';
+import { saveSettings, substituteParams, getRequestHeaders, chat_metadata, this_chid, characters, saveCharacterDebounced, menu_type, eventSource, event_types, getExtensionPromptByName, saveMetadata, getCurrentChatId, extension_prompt_roles, create_save, createOrEditCharacter, name1, getOneCharacter, select_selected_character } from '../script.js';
 import { download, debounce, initScrollHeight, resetScrollHeight, parseJsonFile, extractDataFromPng, getFileBuffer, getCharaFilename, getSortableDelay, escapeRegex, PAGINATION_TEMPLATE, navigation_option, waitUntilCondition, isTrueBoolean, setValueByPath, flashHighlight, select2ModifyOptions, getSelect2OptionId, dynamicSelect2DataViaAjax, highlightRegex, select2ChoiceClickSubscribe, isFalseBoolean, getSanitizedFilename, checkOverwriteExistingData, getStringHash, parseStringArray, cancelDebounce, findChar, onlyUnique, equalsIgnoreCaseAndAccents, uuidv4, normalizeArray, getUniqueName, logSlashCommandWarn, addLongPressEvent } from './utils.js';
 import { extension_settings, getContext } from './extensions.js';
 import { NOTE_MODULE_NAME, metadata_keys, shouldWIAddPrompt } from './authors-note.js';

     await saveWorldInfo(newName, data, true);
     await deleteWorldInfo(oldName);
+    await updateWorldInfoLinks(oldName, newName);
+    if (entryPreviouslySelected !== -1) {
+        const wiElement = getWIElement(newName);
+        wiElement.prop('selected', true);
+        $('#world_info').trigger('change');
+    }
+    const selectedIndex = world_names.indexOf(newName);
+    if (selectedIndex !== -1) {
+        $('#world_editor_select').val(selectedIndex).trigger('change');
+    }
+}
+/**
+ * Retargets all character lore links from an old world info name to a new one, with an optional confirmation for primary lorebook links
+ * @param {string} oldName Previous WI file name
+ * @param {string} newName New WI file name
+ * @returns {Promise<void>}
+ */
+async function updateWorldInfoLinks(oldName, newName) {
     const existingCharLores = world_info.charLore?.filter((e) => e.extraBooks.includes(oldName));
     if (existingCharLores && existingCharLores.length > 0) {
         existingCharLores.forEach((charLore) => {

         saveSettingsDebounced();
+    }
-    if (entryPreviouslySelected !== -1) {
+    // find all characters using the old lorebook name as their primary world
-        const wiElement = getWIElement(newName);
+    const linkedChIDs = [];
-        wiElement.prop('selected', true);
+    characters.forEach((character, chid) => {
-        $('#world_info').trigger('change');
+        if (character.data?.extensions?.world === oldName) {
+            linkedChIDs.push(chid);
+        }
+    });
-    const selectedIndex = world_names.indexOf(newName);
+    if (!linkedChIDs.length) {
-    if (selectedIndex !== -1) {
+        return;
-        $('#world_editor_select').val(selectedIndex).trigger('change');
+    }
+    // Trigger the confirmation popup
+    const updatePastLinksConfirm = await Popup.show.confirm(
+        t`World/Lorebook renamed!`,
+        `<p>${t`Auxiliary Lorebook links have been updated. Would you like to update primary lorebook links for ${linkedChIDs.length} character(s) as well?`}</p>`,
+    ) == POPUP_RESULT.AFFIRMATIVE;
+    if (updatePastLinksConfirm) {
+        let activeCharacterUpdated = false;
+        for (const chid of linkedChIDs) {
+            const character = characters[chid];
+            try {
+                // /merge-attributes API call to update the file on the backend silently
+                const response = await fetch('/api/characters/merge-attributes', {
+                    method: 'POST',
+                    headers: getRequestHeaders(),
+                    body: JSON.stringify({
+                        avatar: character.avatar,
+                        data: {
+                            extensions: {
+                                world: newName,
+                            },
+                        },
+                    }),
+                });
+                if (!response.ok) {
+                    throw new Error(`Merge API returned ${response.status}`);
+                }
+                // used to update the data in the browser's memory
+                await getOneCharacter(character.avatar);
+                // Flag if the currently open character was affected
+                if (String(chid) === String(this_chid)) {
+                    activeCharacterUpdated = true;
+                }
+                toastr.success(`Successfully updated link for ${character.name}.`);
+            } catch (e) {
+                toastr.error(`Failed to update link for ${character.name}.`);
+                console.error(`Backend update for character ${character.name} failed:`, e);
+            }
+        }
+        // update the UI fields
+        // only required if the currently selected character was changed
+        if (activeCharacterUpdated) {
+            select_selected_character(this_chid, { switchMenu: false });
+            setWorldInfoButtonClass(this_chid, true);
+        }
+    }
+}

 /**
  * Assigns a lorebook to the current chat.
- * @param {JQuery.ClickEvent<Document, undefined, any, any>} event Pointer event
+ * @param {Object} options - The options for assigning the lorebook.
+ * @param {boolean} options.shiftKey - Whether the Shift key is pressed.
+ * @param {boolean} options.altKey - Whether the Alt key is pressed.
  * @returns {Promise<void>}
  */
-export async function assignLorebookToChat(event) {
+export async function assignLorebookToChat({ shiftKey, altKey }) {
     const selectedName = chat_metadata[METADATA_KEY];
-    if (selectedName && !event.shiftKey && !event.altKey) {
+    if (selectedName && !shiftKey && !altKey) {
         openWorldInfoEditor(selectedName);
         return;
+    }

src/endpoints/characters.js+1 -0 Viewed

             tags: _.get(character, 'data.tags', []),
             extensions: {
                 fav: _.get(character, 'data.extensions.fav', false),
+                world: _.get(character, 'data.extensions.world', ''),
             },
         },
     };