🎨 优化扩展模块，完成ai接入和对话功能
This commit is contained in:
199
data/st-core-scripts/scripts/macros/engine/MacroEnvBuilder.js
Normal file
199
data/st-core-scripts/scripts/macros/engine/MacroEnvBuilder.js
Normal file
@@ -0,0 +1,199 @@
|
||||
import { name1, name2, characters, getCharacterCardFieldsLazy, getGeneratingModel } from '../../../script.js';
|
||||
import { groups, selected_group } from '../../../scripts/group-chats.js';
|
||||
import { logMacroGeneralError } from './MacroDiagnostics.js';
|
||||
import { getStringHash } from '/scripts/utils.js';
|
||||
/**
|
||||
* MacroEnvBuilder is responsible for constructing the MacroEnv object
|
||||
* that is passed to macro handlers.
|
||||
*
|
||||
* It does **not** depend on the legacy regex macro system. Instead, it
|
||||
* works from the same raw inputs that substituteParams receives plus a
|
||||
* small bundle of global helpers, so it can eventually replace the
|
||||
* environment-building block in substituteParams.
|
||||
*/
|
||||
|
||||
/** @typedef {import('./MacroEnv.types.js').MacroEnv} MacroEnv */
|
||||
|
||||
/**
|
||||
* @typedef {Object} MacroEnvRawContext
|
||||
* @property {string} content
|
||||
* @property {string|null} [name1Override]
|
||||
* @property {string|null} [name2Override]
|
||||
* @property {string|null} [original]
|
||||
* @property {string|null} [groupOverride]
|
||||
* @property {boolean} [replaceCharacterCard]
|
||||
* @property {Record<string, any>|null} [dynamicMacros]
|
||||
* @property {(value: string) => string} [postProcessFn]
|
||||
*/
|
||||
|
||||
/**
|
||||
* @typedef {(env: MacroEnv, ctx: MacroEnvRawContext) => void} MacroEnvProvider
|
||||
*/
|
||||
|
||||
/**
|
||||
* @enum {number} Exposed ordering buckets for providers. Callers can use envBuilder.providerOrder.* when registering providers.
|
||||
*/
|
||||
export const env_provider_order = {
|
||||
EARLIEST: 0,
|
||||
EARLY: 10,
|
||||
NORMAL: 50,
|
||||
LATE: 90,
|
||||
LATEST: 100,
|
||||
};
|
||||
|
||||
/** @type {MacroEnvBuilder} */
|
||||
let instance;
|
||||
export { instance as MacroEnvBuilder };
|
||||
|
||||
class MacroEnvBuilder {
|
||||
/** @type {MacroEnvBuilder} */ static #instance;
|
||||
/** @type {MacroEnvBuilder} */ static get instance() { return MacroEnvBuilder.#instance ?? (MacroEnvBuilder.#instance = new MacroEnvBuilder()); }
|
||||
|
||||
/** @type {{ fn: MacroEnvProvider, order: env_provider_order }[]} */
|
||||
#providers;
|
||||
|
||||
constructor() {
|
||||
this.#providers = [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a provider that can augment the MacroEnv with additional
|
||||
* data (for extensions, extra context, etc.).
|
||||
*
|
||||
* Should be called once during initialization.
|
||||
*
|
||||
* @param {MacroEnvProvider} provider
|
||||
* @param {env_provider_order} [order=env_provider_order.NORMAL]
|
||||
* @returns {void}
|
||||
*/
|
||||
registerProvider(provider, order = env_provider_order.NORMAL) {
|
||||
if (typeof provider !== 'function') throw new Error('Provider must be a function');
|
||||
this.#providers.push({ fn: provider, order });
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a MacroEnv from the raw arguments that are conceptually the
|
||||
* same as substituteParams receives, plus a bundle of global helpers.
|
||||
*
|
||||
* @param {MacroEnvRawContext} ctx
|
||||
* @returns {MacroEnv}
|
||||
*/
|
||||
buildFromRawEnv(ctx) {
|
||||
// Create the env first, we will populate it step by step.
|
||||
// Some fields are marked as required, so we have to fill them with dummy fields here
|
||||
/** @type {MacroEnv} */
|
||||
const env = {
|
||||
content: ctx.content,
|
||||
contentHash: getStringHash(ctx.content),
|
||||
names: { user: '', char: '', group: '', groupNotMuted: '', notChar: '' },
|
||||
character: {},
|
||||
system: { model: '' },
|
||||
functions: { postProcess: (x) => x },
|
||||
dynamicMacros: {},
|
||||
extra: {},
|
||||
};
|
||||
|
||||
if (ctx.replaceCharacterCard) {
|
||||
// Use lazy fields - each property is only resolved when accessed
|
||||
const fields = getCharacterCardFieldsLazy();
|
||||
if (fields) {
|
||||
// Define lazy getters on env.character that delegate to fields
|
||||
const fieldMappings = /** @type {const} */ ([
|
||||
['charPrompt', 'system'],
|
||||
['charInstruction', 'jailbreak'],
|
||||
['description', 'description'],
|
||||
['personality', 'personality'],
|
||||
['scenario', 'scenario'],
|
||||
['persona', 'persona'],
|
||||
['mesExamplesRaw', 'mesExamples'],
|
||||
['version', 'version'],
|
||||
['charDepthPrompt', 'charDepthPrompt'],
|
||||
['creatorNotes', 'creatorNotes'],
|
||||
]);
|
||||
for (const [envKey, fieldKey] of fieldMappings) {
|
||||
Object.defineProperty(env.character, envKey, {
|
||||
get() { return fields[fieldKey] || ''; },
|
||||
enumerable: true,
|
||||
configurable: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Names
|
||||
env.names.user = ctx.name1Override ?? name1 ?? '';
|
||||
env.names.char = ctx.name2Override ?? name2 ?? '';
|
||||
env.names.group = getGroupValue(ctx, { currentChar: env.names.char, includeMuted: true });
|
||||
env.names.groupNotMuted = getGroupValue(ctx, { currentChar: env.names.char, includeMuted: false });
|
||||
env.names.notChar = getGroupValue(ctx, { currentChar: env.names.char, filterOutChar: true, includeUser: env.names.user });
|
||||
|
||||
// System
|
||||
env.system.model = getGeneratingModel();
|
||||
|
||||
// Functions
|
||||
// original (one-shot) and arbitrary additional values
|
||||
if (typeof ctx.original === 'string') {
|
||||
let originalSubstituted = false;
|
||||
env.functions.original = () => {
|
||||
if (originalSubstituted) return '';
|
||||
originalSubstituted = true;
|
||||
return ctx.original;
|
||||
};
|
||||
}
|
||||
env.functions.postProcess = typeof ctx.postProcessFn === 'function' ? ctx.postProcessFn : (x) => x;
|
||||
|
||||
// Dynamic, per-call macros that should be visible only for this evaluation run.
|
||||
if (ctx.dynamicMacros && typeof ctx.dynamicMacros === 'object') {
|
||||
env.dynamicMacros = { ...ctx.dynamicMacros };
|
||||
}
|
||||
|
||||
// Let providers augment the env, if any are registered. Apply them in order,
|
||||
// so callers can influence when their provider runs relative to others.
|
||||
const orderedProviders = this.#providers.slice().sort((a, b) => a.order - b.order);
|
||||
for (const { fn } of orderedProviders) {
|
||||
try {
|
||||
fn(env, ctx);
|
||||
} catch (e) {
|
||||
// Provider errors should not break macro evaluation
|
||||
logMacroGeneralError({ message: 'MacroEnvBuilder: Provider error', error: e });
|
||||
}
|
||||
}
|
||||
|
||||
return env;
|
||||
}
|
||||
}
|
||||
|
||||
instance = MacroEnvBuilder.instance;
|
||||
|
||||
/**
|
||||
* @param {MacroEnvRawContext} ctx
|
||||
* @param {Object} options
|
||||
* @param {string} [options.currentChar=null]
|
||||
* @param {boolean} [options.includeMuted=false]
|
||||
* @param {boolean} [options.filterOutChar=false]
|
||||
* @param {string|null} [options.includeUser=null]
|
||||
* @returns {string}
|
||||
*/
|
||||
function getGroupValue(ctx, { currentChar = null, includeMuted = false, filterOutChar = false, includeUser = null }) {
|
||||
if (typeof ctx.groupOverride === 'string') {
|
||||
return ctx.groupOverride;
|
||||
}
|
||||
|
||||
if (!selected_group) return filterOutChar ? (includeUser || '') : (currentChar ?? '');
|
||||
|
||||
const groupEntry = Array.isArray(groups) ? groups.find(x => x && x.id === selected_group) : null;
|
||||
const members = /** @type {string[]} */ (groupEntry?.members ?? []);
|
||||
const disabledMembers = /** @type {string[]} */ (groupEntry?.disabled_members ?? []);
|
||||
|
||||
const names = Array.isArray(members)
|
||||
? members
|
||||
.filter(((id) => includeMuted ? true : !disabledMembers.includes(id)))
|
||||
.map(m => Array.isArray(characters) ? characters.find(c => c && c.avatar === m) : null)
|
||||
.filter(c => !!c && typeof c.name === 'string')
|
||||
.filter(c => !filterOutChar || c.name !== currentChar)
|
||||
.map(c => c.name)
|
||||
.join(', ')
|
||||
: '';
|
||||
|
||||
return names;
|
||||
}
|
||||
Reference in New Issue
Block a user