thelounge/server/plugins/packages/publicClient.ts

import {PackageInfo} from "./index";
import Client from "../../client";
import Chan from "../../models/chan";
import Msg from "../../models/msg";
import {MessageType, UserInMessage} from "../../../shared/types/msg";

export default class PublicClient {
	private client: Client;
	private packageInfo: PackageInfo;

	constructor(client: Client, packageInfo: PackageInfo) {
		this.client = client;
		this.packageInfo = packageInfo;
	}

	/**
	 *
	 * @param {String} command - IRC command to run, this is in the same format that a client would send to the server (eg: JOIN #test)
	 * @param {String} targetId - The id of the channel to simulate the command coming from. Replies will go to this channel if appropriate
	 */
	runAsUser(command: string, targetId: string) {
		this.client.inputLine({target: targetId, text: command});
	}

	/**
	 *
	 * @param {Object} attributes
	 */
	createChannel(attributes: Partial<Chan>) {
		return this.client.createChannel(attributes);
	}

	/**
	 * Emits an `event` to the browser client, with `data` in the body of the event.
	 *
	 * @param {String} event - Name of the event, must be something the browser will recognise
	 * @param {Object} data - Body of the event, can be anything, but will need to be properly interpreted by the client
	 */
	sendToBrowser(event: string, data) {
		this.client.emit(event, data);
	}

	/**
	 *
	 * @param {Number} chanId
	 */
	getChannel(chanId: number) {
		return this.client.find(chanId);
	}

	/**
	 * Sends a message to this client, displayed in the given channel.
	 *
	 * @param {String} text the message to send
	 * @param {Chan} chan the channel to send the message to
	 */
	sendMessage(text: string, chan: Chan) {
		chan.pushMessage(
			this.client,
			new Msg({
				type: MessageType.PLUGIN,
				text: text,
				from: {
					nick: this.packageInfo.name || this.packageInfo.packageName,
				} as UserInMessage,
			})
		);
	}
}