SillyTavern/public/scripts/extensions/quick-reply/api/QuickReplyApi.js

import { QuickReply } from '../src/QuickReply.js';
import { QuickReplyContextLink } from '../src/QuickReplyContextLink.js';
import { QuickReplySet } from '../src/QuickReplySet.js';
import { QuickReplySettings } from '../src/QuickReplySettings.js';




export class QuickReplyApi {
    /**@type {QuickReplySettings}*/ settings;




    constructor(/**@type {QuickReplySettings}*/settings) {
        this.settings = settings;
    }




    /**
     * Finds and returns an existing Quick Reply Set by its name.
     *
     * @param {String} name name of the quick reply set
     * @returns the quick reply set, or undefined if not found
     */
    getSetByName(name) {
        return QuickReplySet.get(name);
    }

    /**
     * Finds and returns an existing Quick Reply by its set's name and its label.
     *
     * @param {String} setName name of the quick reply set
     * @param {String} label label of the quick reply
     * @returns the quick reply, or undefined if not found
     */
    getQrByLabel(setName, label) {
        const set = this.getSetByName(setName);
        if (!set) return;
        return set.qrList.find(it=>it.label == label);
    }




    /**
     * Executes a quick reply by its index and returns the result.
     *
     * @param {Number} idx the index (zero-based) of the quick reply to execute
     * @returns the return value of the quick reply, or undefined if not found
     */
    async executeQuickReplyByIndex(idx) {
        const qr = [...this.settings.config.setList, ...(this.settings.chatConfig?.setList ?? [])]
            .map(it=>it.set.qrList)
            .flat()[idx]
        ;
        if (qr) {
            return await qr.onExecute();
        } else {
            throw new Error(`No quick reply at index "${idx}"`);
        }
    }


    /**
     * Adds or removes a quick reply set to the list of globally active quick reply sets.
     *
     * @param {String} name the name of the set
     * @param {Boolean} isVisible whether to show the set's buttons or not
     */
    toggleGlobalSet(name, isVisible = true) {
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        if (this.settings.config.hasSet(set)) {
            this.settings.config.removeSet(set);
        } else {
            this.settings.config.addSet(set, isVisible);
        }
    }

    /**
     * Adds a quick reply set to the list of globally active quick reply sets.
     *
     * @param {String} name the name of the set
     * @param {Boolean} isVisible whether to show the set's buttons or not
     */
    addGlobalSet(name, isVisible = true) {
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        this.settings.config.addSet(set, isVisible);
    }

    /**
     * Removes a quick reply set from the list of globally active quick reply sets.
     *
     * @param {String} name the name of the set
     */
    removeGlobalSet(name) {
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        this.settings.config.removeSet(set);
    }


    /**
     * Adds or removes a quick reply set to the list of the current chat's active quick reply sets.
     *
     * @param {String} name the name of the set
     * @param {Boolean} isVisible whether to show the set's buttons or not
     */
    toggleChatSet(name, isVisible = true) {
        if (!this.settings.chatConfig) return;
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        if (this.settings.chatConfig.hasSet(set)) {
            this.settings.chatConfig.removeSet(set);
        } else {
            this.settings.chatConfig.addSet(set, isVisible);
        }
    }

    /**
     * Adds a quick reply set to the list of the current chat's active quick reply sets.
     *
     * @param {String} name the name of the set
     * @param {Boolean} isVisible whether to show the set's buttons or not
     */
    addChatSet(name, isVisible = true) {
        if (!this.settings.chatConfig) return;
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        this.settings.chatConfig.addSet(set, isVisible);
    }

    /**
     * Removes a quick reply set from the list of the current chat's active quick reply sets.
     *
     * @param {String} name the name of the set
     */
    removeChatSet(name) {
        if (!this.settings.chatConfig) return;
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        this.settings.chatConfig.removeSet(set);
    }


    /**
     * Creates a new quick reply in an existing quick reply set.
     *
     * @param {String} setName name of the quick reply set to insert the new quick reply into
     * @param {String} label label for the new quick reply (text on the button)
     * @param {Object} [props]
     * @param {String} [props.message] the message to be sent or slash command to be executed by the new quick reply
     * @param {String} [props.title] the title / tooltip to be shown on the quick reply button
     * @param {Boolean} [props.isHidden] whether to hide or show the button
     * @param {Boolean} [props.executeOnStartup] whether to execute the quick reply when SillyTavern starts
     * @param {Boolean} [props.executeOnUser] whether to execute the quick reply after a user has sent a message
     * @param {Boolean} [props.executeOnAi] whether to execute the quick reply after the AI has sent a message
     * @param {Boolean} [props.executeOnChatChange] whether to execute the quick reply when a new chat is loaded
     * @returns {QuickReply} the new quick reply
     */
    createQuickReply(setName, label, {
        message,
        title,
        isHidden,
        executeOnStartup,
        executeOnUser,
        executeOnAi,
        executeOnChatChange,
    } = {}) {
        const set = this.getSetByName(setName);
        if (!set) {
            throw new Error(`No quick reply set with named "${setName}" found.`);
        }
        const qr = set.addQuickReply();
        qr.label = label ?? '';
        qr.message = message ?? '';
        qr.title = title ?? '';
        qr.isHidden = isHidden ?? false;
        qr.executeOnStartup = executeOnStartup ?? false;
        qr.executeOnUser = executeOnUser ?? false;
        qr.executeOnAi = executeOnAi ?? false;
        qr.executeOnChatChange = executeOnChatChange ?? false;
        qr.onUpdate();
        return qr;
    }

    /**
     * Updates an existing quick reply.
     *
     * @param {String} setName name of the existing quick reply set
     * @param {String} label label of the existing quick reply (text on the button)
     * @param {Object} [props]
     * @param {String} [props.newLabel] new label for quick reply (text on the button)
     * @param {String} [props.message] the message to be sent or slash command to be executed by the quick reply
     * @param {String} [props.title] the title / tooltip to be shown on the quick reply button
     * @param {Boolean} [props.isHidden] whether to hide or show the button
     * @param {Boolean} [props.executeOnStartup] whether to execute the quick reply when SillyTavern starts
     * @param {Boolean} [props.executeOnUser] whether to execute the quick reply after a user has sent a message
     * @param {Boolean} [props.executeOnAi] whether to execute the quick reply after the AI has sent a message
     * @param {Boolean} [props.executeOnChatChange] whether to execute the quick reply when a new chat is loaded
     * @returns {QuickReply} the altered quick reply
     */
    updateQuickReply(setName, label, {
        newLabel,
        message,
        title,
        isHidden,
        executeOnStartup,
        executeOnUser,
        executeOnAi,
        executeOnChatChange,
    } = {}) {
        const qr = this.getQrByLabel(setName, label);
        if (!qr) {
            throw new Error(`No quick reply with label "${label}" in set "${setName}" found.`);
        }
        qr.label = newLabel ?? qr.label;
        qr.message = message ?? qr.message;
        qr.title = title ?? qr.title;
        qr.isHidden = isHidden ?? qr.isHidden;
        qr.executeOnStartup = executeOnStartup ?? qr.executeOnStartup;
        qr.executeOnUser = executeOnUser ?? qr.executeOnUser;
        qr.executeOnAi = executeOnAi ?? qr.executeOnAi;
        qr.executeOnChatChange = executeOnChatChange ?? qr.executeOnChatChange;
        qr.onUpdate();
        return qr;
    }

    /**
     * Deletes an existing quick reply.
     *
     * @param {String} setName name of the existing quick reply set
     * @param {String} label label of the existing quick reply (text on the button)
     */
    deleteQuickReply(setName, label) {
        const qr = this.getQrByLabel(setName, label);
        if (!qr) {
            throw new Error(`No quick reply with label "${label}" in set "${setName}" found.`);
        }
        qr.delete();
    }


    /**
     * Adds an existing quick reply set as a context menu to an existing quick reply.
     *
     * @param {String} setName name of the existing quick reply set containing the quick reply
     * @param {String} label label of the existing quick reply
     * @param {String} contextSetName name of the existing quick reply set to be used as a context menu
     * @param {Boolean} isChained whether or not to chain the context menu quick replies
     */
    createContextItem(setName, label, contextSetName, isChained = false) {
        const qr = this.getQrByLabel(setName, label);
        const set = this.getSetByName(contextSetName);
        if (!qr) {
            throw new Error(`No quick reply with label "${label}" in set "${setName}" found.`);
        }
        if (!set) {
            throw new Error(`No quick reply set with name "${contextSetName}" found.`);
        }
        const cl = new QuickReplyContextLink();
        cl.set = set;
        cl.isChained = isChained;
        qr.addContextLink(cl);
    }

    /**
     * Removes a quick reply set from a quick reply's context menu.
     *
     * @param {String} setName name of the existing quick reply set containing the quick reply
     * @param {String} label label of the existing quick reply
     * @param {String} contextSetName name of the existing quick reply set to be used as a context menu
     */
    deleteContextItem(setName, label, contextSetName) {
        const qr = this.getQrByLabel(setName, label);
        const set = this.getSetByName(contextSetName);
        if (!qr) {
            throw new Error(`No quick reply with label "${label}" in set "${setName}" found.`);
        }
        if (!set) {
            throw new Error(`No quick reply set with name "${contextSetName}" found.`);
        }
        qr.removeContextLink(set.name);
    }

    /**
     * Removes all entries from a quick reply's context menu.
     *
     * @param {String} setName name of the existing quick reply set containing the quick reply
     * @param {String} label label of the existing quick reply
     */
    clearContextMenu(setName, label) {
        const qr = this.getQrByLabel(setName, label);
        if (!qr) {
            throw new Error(`No quick reply with label "${label}" in set "${setName}" found.`);
        }
        qr.clearContextLinks();
    }


    /**
     * Create a new quick reply set.
     *
     * @param {String} name name of the new quick reply set
     * @param {Object} [props]
     * @param {Boolean} [props.disableSend] whether or not to send the quick replies or put the message or slash command into the char input box
     * @param {Boolean} [props.placeBeforeInput] whether or not to place the quick reply contents before the existing user input
     * @param {Boolean} [props.injectInput] whether or not to automatically inject the user input at the end of the quick reply
     * @returns {QuickReplySet} the new quick reply set
     */
    createSet(name, {
        disableSend,
        placeBeforeInput,
        injectInput,
    } = {}) {
        const set = new QuickReplySet();
        set.name = name;
        set.disableSend = disableSend ?? false;
        set.placeBeforeInput = placeBeforeInput ?? false;
        set.injectInput = injectInput ?? false;
        QuickReplySet.list.push(set);
        set.save();
        //TODO settings UI must be updated
        return set;
    }

    /**
     * Update an existing quick reply set.
     *
     * @param {String} name name of the existing quick reply set
     * @param {Object} [props]
     * @param {Boolean} [props.disableSend] whether or not to send the quick replies or put the message or slash command into the char input box
     * @param {Boolean} [props.placeBeforeInput] whether or not to place the quick reply contents before the existing user input
     * @param {Boolean} [props.injectInput] whether or not to automatically inject the user input at the end of the quick reply
     * @returns {QuickReplySet} the altered quick reply set
     */
    updateSet(name, {
        disableSend,
        placeBeforeInput,
        injectInput,
    } = {}) {
        const set = this.getSetByName(name);
        if (!set) {
            throw new Error(`No quick reply set with name "${name}" found.`);
        }
        set.disableSend = disableSend ?? false;
        set.placeBeforeInput = placeBeforeInput ?? false;
        set.injectInput = injectInput ?? false;
        set.save();
        //TODO settings UI must be updated
        return set;
    }
}