Merge pull request #3564 from SillyTavern/rename-past-chats-event Add `RENAMED_PAST_CHAT` event

cf14b75091e9bab8ab55dedf7cc9f45f66ca2fdc

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

Signed

Parents: 2a6568814828de6c906a3674ef931da23474aa27 eab4e8aebc0c870f05eedc8566ed15c65c1e6d9e

public/script.js+35 -10 Viewed

     CHARACTER_DELETED: 'characterDeleted',
     CHARACTER_DUPLICATED: 'character_duplicated',
     CHARACTER_RENAMED: 'character_renamed',
+    CHARACTER_RENAMED_IN_PAST_CHAT: 'character_renamed_in_past_chat',
     /** @deprecated The event is aliased to STREAM_TOKEN_RECEIVED. */
     SMOOTH_STREAM_TOKEN_RECEIVED: 'stream_token_received',
     STREAM_TOKEN_RECEIVED: 'stream_token_received',

     is_send_press = value;
+}
+/**
+ * Renames the currently selected character, updating relevant references and optionally renaming past chats.
+ *
+ * If no name is provided, a popup prompts for a new name. If the new name matches the current name,
+ * the renaming process is aborted. The function sends a request to the server to rename the character
+ * and handles updates to other related fields such as tags, lore, and author notes.
+ *
+ * If the renaming is successful, the character list is reloaded and the renamed character is selected.
+ * Optionally, past chats can be renamed to reflect the new character name.
+ *
+ * @param {string?} [name=null] - The new name for the character. If not provided, a popup will prompt for it.
+ * @param {object} [options] - Additional options.
+ * @param {boolean} [options.silent=false] - If true, suppresses popups and warnings.
+ * @param {boolean?} [options.renameChats=null] - If true, renames past chats to reflect the new character name.
+ * @returns {Promise<boolean>} - Returns true if the character was successfully renamed, false otherwise.
+ */
 export async function renameCharacter(name = null, { silent = false, renameChats = null } = {}) {
     if (!name && silent) {
         toastr.warning(t`No character name provided.`, t`Rename Character`);

                 // Also rename as a group member
                 await renameGroupMember(oldAvatar, newAvatar, newValue);
-                const renamePastChatsConfirm = renameChats !== null ? renameChats
+                const renamePastChatsConfirm = renameChats !== null
-                    : silent ? false : await callPopup(`<h3>Character renamed!</h3>
+                    ? renameChats
-                <p>Past chats will still contain the old character name. Would you like to update the character name in previous chats as well?</p>
+                    : silent
-                <i><b>Sprites folder (if any) should be renamed manually.</b></i>`, 'confirm');
+                        ? false
+                        : await Popup.show.confirm(
+                            t`Character renamed!`,
+                            `<p>${t`Past chats will still contain the old character name. Would you like to update the character name in previous chats as well?`}</p>
+                            <i><b>${t`Sprites folder (if any) should be renamed manually.`}</b></i>`,
+                        ) == POPUP_RESULT.AFFIRMATIVE;
                 if (renamePastChatsConfirm) {
-                    await renamePastChats(newAvatar, newValue);
+                    await renamePastChats(oldAvatar, newAvatar, newValue);
                     await reloadCurrentChat();
                     toastr.success(t`Character renamed and past chats updated!`, t`Rename Character`);
                 } else {

+    }
     catch (error) {
         // Reloading to prevent data corruption
-        if (!silent) await callPopup(t`Something went wrong. The page will be reloaded.`, 'text');
+        if (!silent) await Popup.show.text(t`Rename Character`, t`Something went wrong. The page will be reloaded.`);
         else toastr.error(t`Something went wrong. The page will be reloaded.`, t`Rename Character`);
         console.log('Renaming character error:', error);

     return true;
+}
-async function renamePastChats(newAvatar, newValue) {
+async function renamePastChats(oldAvatar, newAvatar, newName) {
     const pastChats = await getPastCharacterChats();
     for (const { file_name } of pastChats) {

                 method: 'POST',
                 headers: getRequestHeaders(),
                 body: JSON.stringify({
-                    ch_name: newValue,
+                    ch_name: newName,
                     file_name: fileNameWithoutExtension,
                     avatar_url: newAvatar,
                 }),

@@ -6413,15 +6436,17 @@ async function renamePastChats(newAvatar, newValue) {
6413	}	6436	}
6414		6437
6415	if (message.name !== undefined) {	6438	if (message.name !== undefined) {
6416	message.name = newValue;	6439	message.name = newName;
6417	}	6440	}
6418	}	6441	}
6419		6442
		6443	await eventSource.emit(event_types.CHARACTER_RENAMED_IN_PAST_CHAT, currentChat, oldAvatar, newAvatar);
		6444
6420	const saveChatResponse = await fetch('/api/chats/save', {	6445	const saveChatResponse = await fetch('/api/chats/save', {
6421	method: 'POST',	6446	method: 'POST',
6422	headers: getRequestHeaders(),	6447	headers: getRequestHeaders(),
6423	body: JSON.stringify({	6448	body: JSON.stringify({
6424	ch_name: newValue,	6449	ch_name: newName,
6425	file_name: fileNameWithoutExtension,	6450	file_name: fileNameWithoutExtension,
6426	chat: currentChat,	6451	chat: currentChat,
6427	avatar_url: newAvatar,	6452	avatar_url: newAvatar,