Add types for SillyTavern.getContext

2025-06-05 21:59:27 +02:00 · 2024-12-06 16:41:26 +02:00
parent 3502bfcaa0
commit 77841dbc21
7 changed files with 228 additions and 146 deletions
--- a/public/scripts/st-context.js
+++ b/public/scripts/st-context.js
@ -0,0 +1,170 @@
+import {
+    activateSendButtons,
+    addOneMessage,
+    callPopup,
+    characters,
+    chat,
+    chat_metadata,
+    create_save,
+    deactivateSendButtons,
+    event_types,
+    eventSource,
+    extension_prompts,
+    Generate,
+    generateQuietPrompt,
+    getCurrentChatId,
+    getRequestHeaders,
+    getThumbnailUrl,
+    main_api,
+    max_context,
+    menu_type,
+    messageFormatting,
+    name1,
+    name2,
+    online_status,
+    openCharacterChat,
+    reloadCurrentChat,
+    renameChat,
+    saveChatConditional,
+    saveMetadata,
+    saveReply,
+    saveSettingsDebounced,
+    selectCharacterById,
+    sendGenerationRequest,
+    sendStreamingRequest,
+    sendSystemMessage,
+    setExtensionPrompt,
+    stopGeneration,
+    streamingProcessor,
+    substituteParams,
+    substituteParamsExtended,
+    this_chid,
+    updateChatMetadata,
+} from '../script.js';
+import {
+    extension_settings,
+    ModuleWorkerWrapper,
+    renderExtensionTemplate,
+    renderExtensionTemplateAsync,
+    writeExtensionField,
+} from './extensions.js';
+import { groups, openGroupChat, selected_group } from './group-chats.js';
+import { t, translate } from './i18n.js';
+import { hideLoader, showLoader } from './loader.js';
+import { MacrosParser } from './macros.js';
+import { oai_settings } from './openai.js';
+import { callGenericPopup, Popup, POPUP_RESULT, POPUP_TYPE } from './popup.js';
+import { registerDebugFunction } from './power-user.js';
+import { isMobile, shouldSendOnEnter } from './RossAscends-mods.js';
+import { ScraperManager } from './scrapers.js';
+import { executeSlashCommands, executeSlashCommandsWithOptions, registerSlashCommand } from './slash-commands.js';
+import { SlashCommand } from './slash-commands/SlashCommand.js';
+import { ARGUMENT_TYPE, SlashCommandArgument, SlashCommandNamedArgument } from './slash-commands/SlashCommandArgument.js';
+import { SlashCommandParser } from './slash-commands/SlashCommandParser.js';
+import { tag_map, tags } from './tags.js';
+import { textgenerationwebui_settings } from './textgen-settings.js';
+import { getTokenCount, getTokenCountAsync, getTokenizerModel } from './tokenizers.js';
+import { ToolManager } from './tool-calling.js';
+import { timestampToMoment } from './utils.js';
+
+export function getContext() {
+    return {
+        chatCompletionSettings: oai_settings,
+        textCompletionSettings: textgenerationwebui_settings,
+        chat,
+        characters,
+        groups,
+        name1,
+        name2,
+        characterId: this_chid,
+        groupId: selected_group,
+        chatId: selected_group
+            ? groups.find(x => x.id == selected_group)?.chat_id
+            : (this_chid && characters[this_chid] && characters[this_chid].chat),
+        getCurrentChatId,
+        getRequestHeaders,
+        reloadCurrentChat,
+        renameChat,
+        saveSettingsDebounced,
+        onlineStatus: online_status,
+        maxContext: Number(max_context),
+        chatMetadata: chat_metadata,
+        streamingProcessor,
+        eventSource,
+        eventTypes: event_types,
+        addOneMessage,
+        generate: Generate,
+        sendStreamingRequest,
+        sendGenerationRequest,
+        stopGeneration,
+        /** @deprecated Use getTokenCountAsync instead */
+        getTokenCount,
+        getTokenCountAsync,
+        extensionPrompts: extension_prompts,
+        setExtensionPrompt: setExtensionPrompt,
+        updateChatMetadata: updateChatMetadata,
+        saveChat: saveChatConditional,
+        openCharacterChat,
+        openGroupChat,
+        saveMetadata,
+        sendSystemMessage,
+        activateSendButtons,
+        deactivateSendButtons,
+        saveReply,
+        substituteParams,
+        substituteParamsExtended,
+        SlashCommandParser,
+        SlashCommand,
+        SlashCommandArgument,
+        SlashCommandNamedArgument,
+        ARGUMENT_TYPE,
+        executeSlashCommandsWithOptions,
+        /** @deprecated Use SlashCommandParser.addCommandObject() instead */
+        registerSlashCommand,
+        /** @deprecated Use executeSlashCommandWithOptions instead */
+        executeSlashCommands,
+        timestampToMoment,
+        /** @deprecated Handlebars for extensions are no longer supported. */
+        registerHelper: () => { },
+        registerMacro: MacrosParser.registerMacro.bind(MacrosParser),
+        unregisterMacro: MacrosParser.unregisterMacro.bind(MacrosParser),
+        registerFunctionTool: ToolManager.registerFunctionTool.bind(ToolManager),
+        unregisterFunctionTool: ToolManager.unregisterFunctionTool.bind(ToolManager),
+        isToolCallingSupported: ToolManager.isToolCallingSupported.bind(ToolManager),
+        canPerformToolCalls: ToolManager.canPerformToolCalls.bind(ToolManager),
+        registerDebugFunction: registerDebugFunction,
+        /** @deprecated Use renderExtensionTemplateAsync instead. */
+        renderExtensionTemplate: renderExtensionTemplate,
+        renderExtensionTemplateAsync: renderExtensionTemplateAsync,
+        registerDataBankScraper: ScraperManager.registerDataBankScraper,
+        /** @deprecated Use callGenericPopup or Popup instead. */
+        callPopup,
+        callGenericPopup,
+        showLoader,
+        hideLoader,
+        mainApi: main_api,
+        extensionSettings: extension_settings,
+        ModuleWorkerWrapper,
+        getTokenizerModel,
+        generateQuietPrompt,
+        writeExtensionField,
+        getThumbnailUrl,
+        selectCharacterById,
+        messageFormatting,
+        shouldSendOnEnter,
+        isMobile,
+        t,
+        translate,
+        tags,
+        tagMap: tag_map,
+        menuType: menu_type,
+        createCharacterData: create_save,
+        /** @deprecated Legacy snake-case naming, compatibility with old extensions */
+        event_types: event_types,
+        Popup: Popup,
+        POPUP_TYPE,
+        POPUP_RESULT,
+    };
+}
+
+export default getContext;