axoncore/src/Langs/MessageManager.js

The best fully featured discord bot framework. Universal Client, Command and Event handler.

import TranslationManager from './TranslationManager';
import MessageParser from './MessageParser';
/**
 * @typedef {import('../AxonClient').default} AxonClient
 * @typedef {Object.<string, AxonLanguageResponse>} Languages
 * @typedef {{
 * ERR_BOT_PERM?: String, ERR_CALLER_PERM?: String, ERR_DESTINATION_PERM?: String,
 * ERR_COOLDOWN?: String, ERR_GENERAL?: String, [key: String]: String|undefined
 * }} AxonLanguageResponse
 * @typedef {import('../Langs/TranslationManager').default} TranslationManager
 */

/**
 * Holds all messages.
 * Used as an interface to get the message in the correct lang and parse arguments from the message.
 *
 * @author KhaaZ
 *
 * @class MessageManager
 *
 * @prop {AxonClient} _axon
 * @prop {Languages} _message - All messages (all langs)
 * @prop {TranslationManager} translation
 * @prop {MessageParser} parser
 */
class MessageManager {
    /**
     * Creates an instance of MessageManager.
     * Dynamically create one method for each message so we can use <this>.MESSAGE_CONSTANT() directly. It will actually call the get method.
     *
     * @param {AxonClient} axonClient
     * @param {Languages} messages
     * @param {String} baseLang
     *
     * @memberof MessageManager
     */
    constructor(axonClient, messages, baseLang) {
        this._axon = axonClient;

        this._messages = messages;
    
        this.translation = new TranslationManager(this, baseLang);
        this.parser = new MessageParser();

        // creating method for every message to make access easier
        for (const message in this.translation.getMessages() ) {
            this[message] = (args, lang) => this.get(message, args, lang);
        }
    }

    /**
     * Returns all messages (all langs)
     *
     * @readonly
     * @type {Languages}
     * @memberof MessageManager
     */
    get messages() {
        return this._messages;
    }

    /**
     * All message from the given lang (or default lang)
     *
     * @param {String} lang
     * @returns {AxonLanguageResponse} Object with all messages
     * @memberof MessageManager
     */
    getMessages(lang) {
        return this.translation.getMessages(lang);
    }

    /**
     * The message in the given lang (or default lang)
     *
     * @param {String} message
     * @param {String} lang
     * @returns {String} The message
     * @memberof MessageManager
     */
    getMessage(message, lang) {
        return this.translation.getMessage(message, lang);
    }

    /**
     * Get the message in the correct lang, parsed to replace {{key}} with the correct argument
     *
     * @param {String} message
     * @param {AxonLanguageResponse} args
     * @param {String} lang
     * @returns {String} The actual message
     * @memberof MessageManager
     */
    get(message, args, lang) {
        return this.parser.parse(this.translation.getMessage(message, lang), args);
    }
}

export default MessageManager;