Add "name" argument to /hide and /unhide. Add default value for unnamed argument

1026e1f8e9675af890bc392583c8e81bc285d6ef

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

Parents: ebe30dceac64e88939ce2561cd9858f503581e75
4 files changed, +96 -23Ignore whitespace
public/scripts/chats.js+3 -1
@@ -130,9 +130,10 @@ function getConverter(type) {
130130 * @param {number} start Starting message ID
131131 * @param {number} end Ending message ID (inclusive)
132132 * @param {boolean} unhide If true, unhide the messages instead.
133+ * @param {string} nameFitler Optional name filter
133134 * @returns {Promise<void>}
134135 */
135136export async function hideChatMessageRange(start, end, unhide, nameFitler = null) {
136137 if (isNaN(start)) return;
137138 if (!end) end = start;
138139 const hide = !unhide;
@@ -140,6 +141,7 @@ export async function hideChatMessageRange(start, end, unhide) {
140141 for (let messageId = start; messageId <= end; messageId++) {
141142 const message = chat[messageId];
142143 if (!message) continue;
144+ if (nameFitler && message.name !== nameFitler) continue;
143145
144146 message.is_system = hide;
145147
public/scripts/slash-commands.js+38 -18
@@ -667,11 +667,21 @@ export function initDefaultSlashCommands() {
667667 SlashCommandParser.addCommandObject(SlashCommand.fromProps({
668668 name: 'hide',
669669 callback: hideMessageCallback,
670+ namedArgumentList: [
671+ SlashCommandNamedArgument.fromProps({
672+ name: 'name',
673+ description: 'only hide messages from a certain character or persona',
674+ typeList: [ARGUMENT_TYPE.STRING],
675+ enumProvider: commonEnumProviders.messageNames,
676+ isRequired: false,
677+ acceptsMultiple: false,
678+ }),
679+ ],
670680 unnamedArgumentList: [
671681 SlashCommandArgument.fromProps({
672682 description: 'message index (starts with 0) or range, defaults to the last message index if not provided',
673683 typeList: [ARGUMENT_TYPE.NUMBER, ARGUMENT_TYPE.RANGE],
674684 isRequired: truefalse,
675685 enumProvider: commonEnumProviders.messages(),
676686 }),
677687 ],
@@ -680,11 +690,21 @@ export function initDefaultSlashCommands() {
680690 SlashCommandParser.addCommandObject(SlashCommand.fromProps({
681691 name: 'unhide',
682692 callback: unhideMessageCallback,
693+ namedArgumentList: [
694+ SlashCommandNamedArgument.fromProps({
695+ name: 'name',
696+ description: 'only unhide messages from a certain character or persona',
697+ typeList: [ARGUMENT_TYPE.STRING],
698+ enumProvider: commonEnumProviders.messageNames,
699+ isRequired: false,
700+ acceptsMultiple: false,
701+ }),
702+ ],
683703 unnamedArgumentList: [
684704 SlashCommandArgument.fromProps({
685705 description: 'message index (starts with 0) or range, defaults to the last message index if not provided',
686706 typeList: [ARGUMENT_TYPE.NUMBER, ARGUMENT_TYPE.RANGE],
687707 isRequired: truefalse,
688708 enumProvider: commonEnumProviders.messages(),
689709 }),
690710 ],
@@ -3034,37 +3054,37 @@ async function askCharacter(args, text) {
30343054 return await slashCommandReturnHelper.doReturn(args.return ?? 'pipe', message, { objectToStringFunc: x => x.mes });
30353055}
30363056
30373057async function hideMessageCallback(_args, argvalue) {
30383058 if (!argvalue) {
30393059 console.warnlog('WARN: No argumentrange provided. forHiding /hidethe commandlast message.');
3040- return '';
30413060 }
30423061
30433062 const range = value ? stringToRange(argvalue, 0, chat.length - 1) : { start: chat.length - 1, end: chat.length - 1 };
30443063
30453064 if (!range) {
30463065 console.warn(`WARN: Invalid range provided for /hide command: ${argvalue}`);
30473066 return '';
30483067 }
30493068
3050- await hideChatMessageRange(range.start, range.end, false);
3069+ const nameFilter = String(args.name ?? '').trim();
3070+ await hideChatMessageRange(range.start, range.end, false, nameFilter);
30513071 return '';
30523072}
30533073
30543074async function unhideMessageCallback(_args, argvalue) {
30553075 if (!argvalue) {
30563076 console.warnlog('WARN: No argumentrange provided. forUnhiding /unhidethe commandlast message');
3057- return '';
30583077 }
30593078
30603079 const range = value ? stringToRange(argvalue, 0, chat.length - 1) : { start: chat.length - 1, end: chat.length - 1 };
30613080
30623081 if (!range) {
30633082 console.warn(`WARN: Invalid range provided for /unhide command: ${argvalue}`);
30643083 return '';
30653084 }
30663085
3067- await hideChatMessageRange(range.start, range.end, true);
3086+ const nameFilter = String(args.name ?? '').trim();
3087+ await hideChatMessageRange(range.start, range.end, true, nameFilter);
30683088 return '';
30693089}
30703090
public/scripts/slash-commands/SlashCommandCommonEnumsProvider.js+12 -3
@@ -3,6 +3,7 @@ import { extension_settings } from '../extensions.js';
33import { getGroupMembers, groups } from '../group-chats.js';
44import { power_user } from '../power-user.js';
55import { searchCharByName, getTagsList, tags, tag_map } from '../tags.js';
6+import { onlyUnique } from '../utils.js';
67import { world_names } from '../world-info.js';
78import { SlashCommandClosure } from './SlashCommandClosure.js';
89import { SlashCommandEnumValue, enumTypes } from './SlashCommandEnumValue.js';
@@ -251,15 +252,23 @@ export const commonEnumProviders = {
251252 * @param {boolean} [options.allowVars=false] - Whether to add enum option for variable names
252253 * @returns {(executor:SlashCommandExecutor, scope:SlashCommandScope) => SlashCommandEnumValue[]}
253254 */
254255 messages: ({ allowIdAfter = false, allowVars = false } = {}) => (_executor, scope) => {
256+ const nameFilter = executor.namedArgumentList.find(it => it.name == 'name')?.value || '';
255257 return [
256258 ...chat.map((message, index) => new SlashCommandEnumValue(String(index), `${message.name}: ${message.mes}`, enumTypes.number, message.is_user ? enumIcons.user : message.is_system ? enumIcons.system : enumIcons.assistant)).filter(value => !nameFilter || value.description.startsWith(`${nameFilter}:`)),
257259 ...allowIdAfter ? [new SlashCommandEnumValue(String(chat.length), '>> After Last Message >>', enumTypes.enum, '➕')] : [],
258260 ...allowVars ? commonEnumProviders.variables('all')(_executor, scope) : [],
259261 ];
260262 },
261263
262264 /**
265+ * All names used in the current chat.
266+ *
267+ * @returns {SlashCommandEnumValue[]}
268+ */
269+ messageNames: () => chat.map((message) => message.name).filter(onlyUnique).sort(Intl.Collator().compare).map(name => new SlashCommandEnumValue(name)),
270+
271+ /**
263272 * All existing worlds / lorebooks
264273 *
265274 * @returns {SlashCommandEnumValue[]}
public/scripts/utils.js+43 -1
@@ -6,7 +6,7 @@ import {
66} from '../lib.js';
77
88import { getContext } from './extensions.js';
99import { characters, getRequestHeaders, this_chid, user_avatar } from '../script.js';
1010import { isMobile } from './RossAscends-mods.js';
1111import { collapseNewlines, power_user } from './power-user.js';
1212import { debounce_timeout } from './constants.js';
@@ -2197,6 +2197,48 @@ export async function showFontAwesomePicker(customList = null) {
21972197}
21982198
21992199/**
2200+ * Finds a persona by name, with optional filtering and precedence for avatars
2201+ * @param {object} [options={}] - The options for the search
2202+ * @param {string?} [options.name=null] - The name to search for
2203+ * @param {boolean} [options.allowAvatar=true] - Whether to allow searching by avatar
2204+ * @param {boolean} [options.insensitive=true] - Whether the search should be case insensitive
2205+ * @param {boolean} [options.preferCurrentPersona=true] - Whether to prefer the current persona(s)
2206+ * @param {boolean} [options.quiet=false] - Whether to suppress warnings
2207+ * @returns {PersonaViewModel} The persona object
2208+ * @typedef {object} PersonaViewModel
2209+ * @property {string} avatar - The avatar of the persona
2210+ * @property {string} name - The name of the persona
2211+ */
2212+export function findPersona({ name = null, allowAvatar = true, insensitive = true, preferCurrentPersona = true, quiet = false } = {}) {
2213+ /** @type {PersonaViewModel[]} */
2214+ const personas = Object.entries(power_user.personas).map(([avatar, name]) => ({ avatar, name }));
2215+ const matches = (/** @type {PersonaViewModel} */ persona) => !name || (allowAvatar && persona.avatar === name) || (insensitive ? equalsIgnoreCaseAndAccents(persona.name, name) : persona.name === name);
2216+
2217+ // If we have a current persona and prefer it, return that if it matches
2218+ const currentPersona = personas.find(a => a.avatar === user_avatar);
2219+ if (preferCurrentPersona && currentPersona && matches(currentPersona)) {
2220+ return currentPersona;
2221+ }
2222+
2223+ // If allowAvatar is true, search by avatar first
2224+ if (allowAvatar && name) {
2225+ const personaByAvatar = personas.find(a => a.avatar === name);
2226+ if (personaByAvatar && matches(personaByAvatar)) {
2227+ return personaByAvatar;
2228+ }
2229+ }
2230+
2231+ // Search for matching personas by name
2232+ const matchingPersonas = personas.filter(a => matches(a));
2233+ if (matchingPersonas.length > 1) {
2234+ if (!quiet) toastr.warning('Multiple personas found for given conditions.');
2235+ else console.warn('Multiple personas found for given conditions. Returning the first match.');
2236+ }
2237+
2238+ return matchingPersonas[0] || null;
2239+}
2240+
2241+/**
22002242 * Finds a character by name, with optional filtering and precedence for avatars
22012243 * @param {object} [options={}] - The options for the search
22022244 * @param {string?} [options.name=null] - The name to search for