Expand WORLD_INFO_FORCE_ACTIVATE API to allow for dynamically modified Lorebook entries

6efa36bdbf2d6f17530a94fd36a3cb825fc1a865

Honey Tree <kalakanlogs@proton.me>

1 files changed, +32 -26Ignore whitespace
public/scripts/world-info.js+32 -26
@@ -130,9 +130,9 @@ const KNOWN_DECORATORS = ['@@activate', '@@dont_activate'];
130 */130 */
131class WorldInfoBuffer {131class WorldInfoBuffer {
132 /**132 /**
133 * @type {object[]} Array of entries that need to be activated no matter what133 * @type {Map<string, object>} Map of entries that need to be activated no matter what
134 */134 */
135 static externalActivations = [];135 static externalActivations = new Map();
136136
137 /**137 /**
138 * @type {string[]} Array of messages sorted by ascending depth138 * @type {string[]} Array of messages sorted by ascending depth
@@ -311,20 +311,20 @@ class WorldInfoBuffer {
311 }311 }
312312
313 /**313 /**
314 * Check if the current entry is externally activated.314 * Get the externally activated version of the entry, if there is one.
315 * @param {object} entry WI entry to check315 * @param {object} entry WI entry to check
316 * @returns {boolean} True if the entry is forcefully activated316 * @returns {object|null} the external version if the entry is forcefully activated, null otherwise
317 */317 */
318 isExternallyActivated(entry) {318 getExternallyActivated(entry) {
319 // Entries could be copied with structuredClone, so we need to compare them by string representation319 // Entries could be copied with structuredClone, so we need to compare them by string representation
320 return WorldInfoBuffer.externalActivations.some(x => JSON.stringify(x) === JSON.stringify(entry));320 return WorldInfoBuffer.externalActivations.get(`${entry.world}.${entry.uid}`);
321 }321 }
322322
323 /**323 /**
324 * Clean-up the external effects for entries.324 * Clean-up the external effects for entries.
325 */325 */
326 resetExternalEffects() {326 resetExternalEffects() {
327 WorldInfoBuffer.externalActivations.splice(0, WorldInfoBuffer.externalActivations.length);327 WorldInfoBuffer.externalActivations = new Map();
328 }328 }
329329
330 /**330 /**
@@ -751,7 +751,7 @@ export async function getWorldInfoPrompt(chat, maxContext, isDryRun) {
751 worldInfoString = worldInfoBefore + worldInfoAfter;751 worldInfoString = worldInfoBefore + worldInfoAfter;
752752
753 if (!isDryRun && activatedWorldInfo.allActivatedEntries && activatedWorldInfo.allActivatedEntries.size > 0) {753 if (!isDryRun && activatedWorldInfo.allActivatedEntries && activatedWorldInfo.allActivatedEntries.size > 0) {
754 const arg = Array.from(activatedWorldInfo.allActivatedEntries);754 const arg = Array.from(activatedWorldInfo.allActivatedEntries.values());
755 await eventSource.emit(event_types.WORLD_INFO_ACTIVATED, arg);755 await eventSource.emit(event_types.WORLD_INFO_ACTIVATED, arg);
756 }756 }
757757
@@ -868,7 +868,13 @@ export function setWorldInfoSettings(settings, data) {
868 });868 });
869869
870 eventSource.on(event_types.WORLDINFO_FORCE_ACTIVATE, (entries) => {870 eventSource.on(event_types.WORLDINFO_FORCE_ACTIVATE, (entries) => {
871 WorldInfoBuffer.externalActivations.push(...entries);871 for (const entry of entries) {
872 if (!Object.hasOwn(entry, 'world') || !Object.hasOwn(entry, 'uid')) {
873 console.error('WORLDINFO_FORCE_ACTIVATE requires all entries to have both world and uid fields, entry IGNORED');
874 } else {
875 WorldInfoBuffer.externalActivations.set(`${entry.world}.${entry.uid}`, entry);
876 }
877 }
872 });878 });
873879
874 // Add slash commands880 // Add slash commands
@@ -3698,7 +3704,7 @@ function parseDecorators(content) {
3698 * @param {string[]} chat The chat messages to scan, in reverse order.3704 * @param {string[]} chat The chat messages to scan, in reverse order.
3699 * @param {number} maxContext The maximum context size of the generation.3705 * @param {number} maxContext The maximum context size of the generation.
3700 * @param {boolean} isDryRun Whether to perform a dry run.3706 * @param {boolean} isDryRun Whether to perform a dry run.
3701 * @typedef {{ worldInfoBefore: string, worldInfoAfter: string, EMEntries: any[], WIDepthEntries: any[], allActivatedEntries: Set<any> }} WIActivated3707 * @typedef {{ worldInfoBefore: string, worldInfoAfter: string, EMEntries: any[], WIDepthEntries: any[], allActivatedEntries: Map<string, any> }} WIActivated
3702 * @returns {Promise<WIActivated>} The world info activated.3708 * @returns {Promise<WIActivated>} The world info activated.
3703 */3709 */
3704export async function checkWorldInfo(chat, maxContext, isDryRun) {3710export async function checkWorldInfo(chat, maxContext, isDryRun) {
@@ -3724,7 +3730,7 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
3724 let scanState = scan_state.INITIAL;3730 let scanState = scan_state.INITIAL;
3725 let token_budget_overflowed = false;3731 let token_budget_overflowed = false;
3726 let count = 0;3732 let count = 0;
3727 let allActivatedEntries = new Set();3733 let allActivatedEntries = new Map();
3728 let failedProbabilityChecks = new Set();3734 let failedProbabilityChecks = new Set();
3729 let allActivatedText = '';3735 let allActivatedText = '';
37303736
@@ -3742,7 +3748,7 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
3742 !isDryRun && timedEffects.checkTimedEffects();3748 !isDryRun && timedEffects.checkTimedEffects();
37433749
3744 if (sortedEntries.length === 0) {3750 if (sortedEntries.length === 0) {
3745 return { worldInfoBefore: '', worldInfoAfter: '', WIDepthEntries: [], EMEntries: [], allActivatedEntries: new Set() };3751 return { worldInfoBefore: '', worldInfoAfter: '', WIDepthEntries: [], EMEntries: [], allActivatedEntries: new Map() };
3746 }3752 }
37473753
3748 /** @type {number[]} Represents the delay levels for entries that are delayed until recursion */3754 /** @type {number[]} Represents the delay levels for entries that are delayed until recursion */
@@ -3789,7 +3795,7 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
3789 }3795 }
37903796
3791 // Already processed, considered and then skipped entries should still be skipped3797 // Already processed, considered and then skipped entries should still be skipped
3792 if (failedProbabilityChecks.has(entry) || allActivatedEntries.has(entry)) {3798 if (failedProbabilityChecks.has(entry) || allActivatedEntries.has(`${entry.world}.${entry.uid}`)) {
3793 continue;3799 continue;
3794 }3800 }
37953801
@@ -3858,6 +3864,12 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
3858 continue;3864 continue;
3859 }3865 }
38603866
3867 if (buffer.getExternallyActivated(entry)) {
3868 log('externally activated');
3869 activatedNow.add(buffer.getExternallyActivated(entry));
3870 continue;
3871 }
3872
3861 if (entry.decorators.includes('@@activate')) {3873 if (entry.decorators.includes('@@activate')) {
3862 log('activated by @@activate decorator');3874 log('activated by @@activate decorator');
3863 activatedNow.add(entry);3875 activatedNow.add(entry);
@@ -3876,12 +3888,6 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
3876 continue;3888 continue;
3877 }3889 }
38783890
3879 if (buffer.isExternallyActivated(entry)) {
3880 log('externally activated');
3881 activatedNow.add(entry);
3882 continue;
3883 }
3884
3885 if (isSticky) {3891 if (isSticky) {
3886 log('activated because active sticky');3892 log('activated because active sticky');
3887 activatedNow.add(entry);3893 activatedNow.add(entry);
@@ -4039,7 +4045,7 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
4039 break;4045 break;
4040 }4046 }
40414047
4042 allActivatedEntries.add(entry);4048 allActivatedEntries.set(`${entry.world}.${entry.uid}`, entry);
4043 console.debug(`[WI] Entry ${entry.uid} activation successful, adding to prompt`, entry);4049 console.debug(`[WI] Entry ${entry.uid} activation successful, adding to prompt`, entry);
4044 }4050 }
40454051
@@ -4123,7 +4129,7 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
41234129
4124 // Appends from insertion order 999 to 1. Use unshift for this purpose4130 // Appends from insertion order 999 to 1. Use unshift for this purpose
4125 // TODO (kingbri): Change to use WI Anchor positioning instead of separate top/bottom arrays4131 // TODO (kingbri): Change to use WI Anchor positioning instead of separate top/bottom arrays
4126 [...allActivatedEntries].sort(sortFn).forEach((entry) => {4132 [...allActivatedEntries.values()].sort(sortFn).forEach((entry) => {
4127 const regexDepth = entry.position === world_info_position.atDepth ? (entry.depth ?? DEFAULT_DEPTH) : null;4133 const regexDepth = entry.position === world_info_position.atDepth ? (entry.depth ?? DEFAULT_DEPTH) : null;
4128 const content = getRegexedString(entry.content, regex_placement.WORLD_INFO, { depth: regexDepth, isMarkdown: false, isPrompt: true });4134 const content = getRegexedString(entry.content, regex_placement.WORLD_INFO, { depth: regexDepth, isMarkdown: false, isPrompt: true });
41294135
@@ -4182,14 +4188,14 @@ export async function checkWorldInfo(chat, maxContext, isDryRun) {
4182 context.setExtensionPrompt(NOTE_MODULE_NAME, ANWithWI, chat_metadata[metadata_keys.position], chat_metadata[metadata_keys.depth], extension_settings.note.allowWIScan, chat_metadata[metadata_keys.role]);4188 context.setExtensionPrompt(NOTE_MODULE_NAME, ANWithWI, chat_metadata[metadata_keys.position], chat_metadata[metadata_keys.depth], extension_settings.note.allowWIScan, chat_metadata[metadata_keys.role]);
4183 }4189 }
41844190
4185 !isDryRun && timedEffects.setTimedEffects(Array.from(allActivatedEntries));4191 !isDryRun && timedEffects.setTimedEffects(Array.from(allActivatedEntries.values()));
4186 buffer.resetExternalEffects();4192 buffer.resetExternalEffects();
4187 timedEffects.cleanUp();4193 timedEffects.cleanUp();
41884194
4189 console.log(`[WI] Adding ${allActivatedEntries.size} entries to prompt`, Array.from(allActivatedEntries));4195 console.log(`[WI] Adding ${allActivatedEntries.size} entries to prompt`, Array.from(allActivatedEntries.values()));
4190 console.debug('[WI] --- DONE ---');4196 console.debug('[WI] --- DONE ---');
41914197
4192 return { worldInfoBefore, worldInfoAfter, EMEntries, WIDepthEntries, allActivatedEntries };4198 return { worldInfoBefore, worldInfoAfter, EMEntries, WIDepthEntries, allActivatedEntries: allActivatedEntries.values() };
4193}4199}
41944200
4195/**4201/**
@@ -4291,7 +4297,7 @@ function filterGroupsByTimedEffects(groups, timedEffects, removeEntry) {
4291/**4297/**
4292 * Filters entries by inclusion groups.4298 * Filters entries by inclusion groups.
4293 * @param {object[]} newEntries Entries activated on current recursion level4299 * @param {object[]} newEntries Entries activated on current recursion level
4294 * @param {Set<object>} allActivatedEntries Set of all activated entries4300 * @param {Map<string, object>} allActivatedEntries Map of all activated entries
4295 * @param {WorldInfoBuffer} buffer The buffer to use for scanning4301 * @param {WorldInfoBuffer} buffer The buffer to use for scanning
4296 * @param {number} scanState The current scan state4302 * @param {number} scanState The current scan state
4297 * @param {WorldInfoTimedEffects} timedEffects The timed effects currently active4303 * @param {WorldInfoTimedEffects} timedEffects The timed effects currently active
@@ -4339,7 +4345,7 @@ function filterByInclusionGroups(newEntries, allActivatedEntries, buffer, scanSt
4339 continue;4345 continue;
4340 }4346 }
43414347
4342 if (Array.from(allActivatedEntries).some(x => x.group === key)) {4348 if (Array.from(allActivatedEntries.values()).some(x => x.group === key)) {
4343 console.debug(`[WI] Skipping inclusion group check, group '${key}' was already activated`);4349 console.debug(`[WI] Skipping inclusion group check, group '${key}' was already activated`);
4344 // We need to forcefully deactivate all other entries in the group4350 // We need to forcefully deactivate all other entries in the group
4345 removeAllBut(group, null, false);4351 removeAllBut(group, null, false);