Chore: Add persona lifecycle events (`PERSONA_CREATED`, `PERSONA_UPDATED`, `PERSONA_RENAMED`, `PERSONA_DELETED`) (#5443) * Add persona lifecycle events (created, updated, renamed, deleted) and emit them throughout persona management functions * fix: await event emissions * fix: await event in convertCharacterToPersona * fix: await PERSONA_UPDATED in callbacks * fix: delete multiple personas without reloading the chat * fix: add CHAT_RENAMED event and adjust welcome screen pin update logic --------- Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

7d3d1231a9891c587689834c39a851c29cfb49a4

Wolfsblvt <wolfsblvt@gmail.com>

Signed

Parents: 24379db88dc97936153175eb5a6a8b57c284534a

public/script.js+3 -0 Viewed

         if (currentChatId) {
             await reloadCurrentChat();
+        }
+        const eventData = { avatarId: body.avatar_url, groupId, oldFileName: body.original_file, newFileName: body.renamed_file };
+        await eventSource.emit(event_types.CHAT_RENAMED, eventData);
     } catch {
         await delay(500);
         await callGenericPopup('An error has occurred. Chat was not renamed.', POPUP_TYPE.TEXT);

public/scripts/events.js+5 -0 Viewed

     FORCE_SET_BACKGROUND: 'force_set_background',
     CHAT_DELETED: 'chat_deleted',
     CHAT_CREATED: 'chat_created',
+    CHAT_RENAMED: 'chat_renamed',
     GROUP_CHAT_DELETED: 'group_chat_deleted',
     GROUP_CHAT_CREATED: 'group_chat_created',
     GENERATE_BEFORE_COMBINE_PROMPTS: 'generate_before_combine_prompts',

     WORLDINFO_SCAN_DONE: 'worldinfo_scan_done',
     MEDIA_ATTACHMENT_DELETED: 'media_attachment_deleted',
     PERSONA_CHANGED: 'persona_changed',
+    PERSONA_CREATED: 'persona_created',
+    PERSONA_UPDATED: 'persona_updated',
+    PERSONA_RENAMED: 'persona_renamed',
+    PERSONA_DELETED: 'persona_deleted',
     TTS_JOB_STARTED: 'tts_job_started',
     TTS_AUDIO_READY: 'tts_audio_ready',
     TTS_JOB_COMPLETE: 'tts_job_complete',

public/scripts/personas.js+46 -14 Viewed

 } from '../script.js';
 import { persona_description_positions, power_user } from './power-user.js';
 import { getTokenCountAsync } from './tokenizers.js';
-import { PAGINATION_TEMPLATE, clearInfoBlock, debounce, delay, download, ensureImageFormatSupported, flashHighlight, getBase64Async, getCharIndex, isFalseBoolean, isTrueBoolean, onlyUnique, parseJsonFile, setInfoBlock, localizePagination, renderPaginationDropdown, paginationDropdownChangeHandler, addLongPressEvent } from './utils.js';
+import { PAGINATION_TEMPLATE, clearInfoBlock, debounce, delay, download, ensureImageFormatSupported, flashHighlight, getBase64Async, getCharIndex, isFalseBoolean, isTrueBoolean, onlyUnique, parseJsonFile, setInfoBlock, localizePagination, renderPaginationDropdown, paginationDropdownChangeHandler, addLongPressEvent, uuidv4 } from './utils.js';
 import { debounce_timeout } from './constants.js';
 import { FILTER_TYPES, FilterHelper } from './filters.js';
 import { groups, selected_group } from './group-chats.js';

@@ -217,11 +217,12 @@ function getUserAvatarBlock(avatarId) {
217	/**	217	/**
218	* Initialize missing personas in the power user settings.	218	* Initialize missing personas in the power user settings.
219	* @param {string[]} avatarsList List of avatar file names	219	* @param {string[]} avatarsList List of avatar file names
		220	* @returns {Promise<void>}
220	*/	221	*/
221	function addMissingPersonas(avatarsList) {	222	async function addMissingPersonas(avatarsList) {
222	for (const persona of avatarsList) {	223	for (const persona of avatarsList) {
223	if (!power_user.personas[persona]) {	224	if (!power_user.personas[persona]) {
224	initPersona(persona, '[Unnamed Persona]', '', '');	225	await initPersona(persona, '[Unnamed Persona]', '', '', { silent: true });
225	}	226	}
226	}	227	}
227	}	228	}

+        }
         // If any persona is missing from the power user settings, we add it
-        addMissingPersonas(allEntities);
+        await addMissingPersonas(allEntities);
         // Before printing the personas, we check if we should enable/disable search sorting
         verifyPersonaSearchSortRule();

     const personaDescription = await Popup.show.input(t`Enter a description for this persona:`, t`You can always add or change it later.`, '', { rows: 4 });
-    initPersona(avatarId, personaName, personaDescription, '');
+    await initPersona(avatarId, personaName, personaDescription, '');
     if (power_user.persona_show_notifications) {
         toastr.success(t`You can now pick ${personaName} as a persona in the Persona Management menu.`, t`Persona Created`);
+    }

     // Date + name (only ASCII) to make it unique
     const avatarId = `${Date.now()}-${personaName.replace(/[^a-zA-Z0-9]/g, '')}.png`;
-    initPersona(avatarId, personaName, '', personaTitle);
+    await initPersona(avatarId, personaName, '', personaTitle);
     await uploadUserAvatar(default_user_avatar, avatarId);
+}

  * @param {string} personaName Name for the persona
  * @param {string} personaDescription Optional description for the persona
  * @param {string} personaTitle Optional title for the persona
- * @returns {void}
+ * @param {object} [options] Optional settings
+ * @param {boolean} [options.silent=false] If true, no PERSONA_CREATED event is emitted (used for background migrations)
+ * @returns {Promise<void>}
  */
-export function initPersona(avatarId, personaName, personaDescription, personaTitle) {
+export async function initPersona(avatarId, personaName, personaDescription, personaTitle, { silent = false } = {}) {
     power_user.personas[avatarId] = personaName;
     power_user.persona_descriptions[avatarId] = {
         description: personaDescription || '',

     };
     saveSettingsDebounced();
+    if (!silent) {
+        await eventSource.emit(event_types.PERSONA_CREATED, { avatarId, name: personaName, description: personaDescription || '', title: personaTitle || '' });
+    }
+}
 /**

+    }
     saveSettingsDebounced();
+    await eventSource.emit(event_types.PERSONA_CREATED, { avatarId: overwriteName, name, description, title: '' });
     console.log('Persona for character created');
     toastr.success(t`You can now pick ${name} as a persona in the Persona Management menu.`, t`Persona Created`);

         delete power_user.persona_descriptions[avatarId].title;
         await getUserAvatars(true, avatarId);
         saveSettingsDebounced();
+        await eventSource.emit(event_types.PERSONA_UPDATED, avatarId);
         return;
+    }

@@ -786,6 +795,7 @@ async function editPersonaTitle(popup, avatarId, currentTitle) {
786	console.log(`Updated persona title for ${avatarId} to ${newTitle}`);	795	console.log(`Updated persona title for ${avatarId} to ${newTitle}`);
787	await getUserAvatars(true, avatarId);	796	await getUserAvatars(true, avatarId);
788	saveSettingsDebounced();	797	saveSettingsDebounced();
		798	await eventSource.emit(event_types.PERSONA_UPDATED, avatarId);
789	return;	799	return;
790	}	800	}
791	}	801	}

+    }
     saveSettingsDebounced();
+    await eventSource.emit(event_types.PERSONA_RENAMED, { avatarId, oldName: currentName, newName });
     await getUserAvatars(true, avatarId);
     updatePersonaUIStates();
     setPersonaDescription();

             connections: [],
             title: '',
         };
+        await eventSource.emit(event_types.PERSONA_CREATED, { avatarId: user_avatar, name: name1, description: '', title: '' });
+    }
     switch (type) {

@@ -1113,13 +1125,15 @@ async function deleteUserAvatar() {
1113	}	1125	}
1114		1126
1115	saveSettingsDebounced();	1127	saveSettingsDebounced();
		1128	await eventSource.emit(event_types.PERSONA_DELETED, { avatarId, name });
1116		1129
1117	// Use the existing mechanism to re-render the persona list and choose the next persona here	1130	// Use the existing mechanism to re-render the persona list and choose the next persona here
		1131	personaLastLoadedChatId = uuidv4(); // Force reload by making a dummy chat id
1118	await loadPersonaForCurrentChat({ doRender: true });	1132	await loadPersonaForCurrentChat({ doRender: true });
1119	}	1133	}
1120	}	1134	}
1121		1135
1122	function onPersonaDescriptionInput() {	1136	async function onPersonaDescriptionInput() {
1123	power_user.persona_description = String($('#persona_description').val());	1137	power_user.persona_description = String($('#persona_description').val());
1124	countPersonaDescriptionTokens();	1138	countPersonaDescriptionTokens();
1125		1139

         .text(power_user.persona_description || $('#user_avatar_block').attr('no_desc_text'))
         .toggleClass('text_muted', !power_user.persona_description);
     saveSettingsDebounced();
+    if (power_user.personas[user_avatar]) {
+        await eventSource.emit(event_types.PERSONA_UPDATED, user_avatar);
+    }
+}
-function onPersonaDescriptionDepthValueInput() {
+async function onPersonaDescriptionDepthValueInput() {
     power_user.persona_description_depth = Number($('#persona_depth_value').val());
     if (power_user.personas[user_avatar]) {
         const object = getOrCreatePersonaDescriptor();
         object.depth = power_user.persona_description_depth;
+        saveSettingsDebounced();
+        await eventSource.emit(event_types.PERSONA_UPDATED, user_avatar);
+        return;
+    }
     saveSettingsDebounced();
+}
-function onPersonaDescriptionDepthRoleInput() {
+async function onPersonaDescriptionDepthRoleInput() {
     power_user.persona_description_role = Number($('#persona_depth_role').find(':selected').val());
     if (power_user.personas[user_avatar]) {
         const object = getOrCreatePersonaDescriptor();
         object.role = power_user.persona_description_role;
+        saveSettingsDebounced();
+        await eventSource.emit(event_types.PERSONA_UPDATED, user_avatar);
+        return;
+    }
     saveSettingsDebounced();

         worldSelect.append(option);
+    }
-    worldSelect.on('change', function () {
+    worldSelect.on('change', async function () {
         power_user.persona_description_lorebook = String($(this).val());
         if (power_user.personas[user_avatar]) {

         $('#persona_lore_button').toggleClass('world_set', !!power_user.persona_description_lorebook);
         saveSettingsDebounced();
+        if (power_user.personas[user_avatar]) {
+            await eventSource.emit(event_types.PERSONA_UPDATED, user_avatar);
+        }
     });
     await callGenericPopup(template, POPUP_TYPE.TEXT);
+}
-function onPersonaDescriptionPositionInput() {
+async function onPersonaDescriptionPositionInput() {
     power_user.persona_description_position = Number(
         $('#persona_description_position').find(':selected').val(),
     );

     if (power_user.personas[user_avatar]) {
         const object = getOrCreatePersonaDescriptor();
         object.position = power_user.persona_description_position;
+        saveSettingsDebounced();
+        await eventSource.emit(event_types.PERSONA_UPDATED, user_avatar);
+        $('#persona_depth_position_settings').toggle(power_user.persona_description_position === persona_description_positions.AT_DEPTH);
+        return;
+    }
     saveSettingsDebounced();

@@ -1807,7 +1839,7 @@ async function migrateNonPersonaUser() {
1807	return;	1839	return;
1808	}	1840	}
1809		1841
1810	initPersona(user_avatar, name1, '', '');	1842	await initPersona(user_avatar, name1, '', '', { silent: true });
1811	setPersonaDescription();	1843	setPersonaDescription();
1812	await getUserAvatars(true, user_avatar);	1844	await getUserAvatars(true, user_avatar);
1813	}	1845	}

public/scripts/welcome-screen.js+4 -2 Viewed

             newFileName: newName,
             loader: false,
         });
-        PinnedChatsManager.rename({ avatar: avatarId, group: '', file_name: fileName }, newName);
         await updateRemoteChatName(characterId, newName);
         await refreshWelcomeScreen();
         toastr.success(t`Chat renamed.`);

             newFileName: String(newName),
             loader: false,
         });
-        PinnedChatsManager.rename({ avatar: '', group: groupId, file_name: fileName }, String(newName));
         await refreshWelcomeScreen();
         toastr.success(t`Group chat renamed.`);
     } catch (error) {

@@ -944,4 +942,8 @@ export function initWelcomeScreen() {
944	accountStorage.setItem(assistantAvatarKey, newAvatar);	942	accountStorage.setItem(assistantAvatarKey, newAvatar);
945	}	943	}
946	});	944	});
		945
		946	eventSource.on(event_types.CHAT_RENAMED, async ({ avatarId, groupId, oldFileName, newFileName }) => {
		947	PinnedChatsManager.rename({ avatar: avatarId, group: groupId, file_name: oldFileName }, newFileName);
		948	});
947	}	949	}