feat(plugins): add on_connect plugin

Add following options:
- channels
- oper

Author: jeromeludmann

client.ts

@@ -12,6 +12,7 @@ import * as Motd from "./plugins/motd.ts";
 import * as Msg from "./plugins/msg.ts";
 import * as Nick from "./plugins/nick.ts";
 import * as Notice from "./plugins/notice.ts";
+import * as OnConnect from "./plugins/on_connect.ts";
 import * as Oper from "./plugins/oper.ts";
 import * as Part from "./plugins/part.ts";
 import * as Ping from "./plugins/ping.ts";
@@ -29,6 +30,7 @@ export type Options =
   & Debug.Options
   & Invite.Options
   & Nick.Options
+  & OnConnect.Options
   & Ping.Options
   & Register.Options
   & Time.Options

plugins/on_connect.ts

@@ -0,0 +1,61 @@
+import type { ExtendedClient } from "../core/mod.ts";
+import { createPlugin } from "../core/mod.ts";
+import type { JoinPluginParams } from "./join.ts";
+import type { OperPluginParams } from "./oper.ts";
+import type { RegisterPluginParams } from "./register.ts";
+
+export interface Options {
+  /** Channels to join on connect. */
+  channels?: string[];
+
+  /** Sets as operator on connect. */
+  oper?: {
+    /** Username operator. */
+    user: string;
+    /** Password operator. */
+    pass: string;
+  };
+}
+
+export interface OnConnectPluginParams {
+  options: Options;
+}
+
+function autoJoin(
+  client: ExtendedClient<
+    OnConnectPluginParams & JoinPluginParams & RegisterPluginParams
+  >,
+) {
+  const { channels } = client.options;
+
+  if (channels === undefined || channels.length === 0) {
+    return;
+  }
+
+  client.on("register", () => {
+    client.join(...channels);
+  });
+}
+
+function autoOper(
+  client: ExtendedClient<
+    OnConnectPluginParams & OperPluginParams & RegisterPluginParams
+  >,
+) {
+  if (client.options.oper === undefined) {
+    return;
+  }
+
+  const { user, pass } = client.options.oper;
+
+  client.on("register", () => {
+    client.oper(user, pass);
+  });
+}
+
+export const plugin = createPlugin<
+  & OnConnectPluginParams
+  & JoinPluginParams
+  & OperPluginParams
+  & RegisterPluginParams
+>(autoOper, autoJoin);

plugins/on_connect_test.ts

@@ -0,0 +1,41 @@
+import { assertEquals } from "../core/test_deps.ts";
+import { arrange } from "../core/test_helpers.ts";
+import { plugin as join } from "./join.ts";
+import { plugin as nick } from "./nick.ts";
+import { plugin as onConnect } from "./on_connect.ts";
+import { plugin as oper } from "./oper.ts";
+import { plugin as register } from "./register.ts";
+
+Deno.test("on_connect channels", async () => {
+  const { server, client, sanitize } = arrange(
+    [onConnect, join, nick, register],
+    { nick: "nick", channels: ["#channel1", "#channel2"] },
+  );
+
+  server.listen();
+  client.connect(server.host, server.port);
+  await server.waitClient();
+
+  server.send(":serverhost 001 nick :Welcome to the server");
+  const raw = await server.once("JOIN");
+  assertEquals(raw, "JOIN #channel1,#channel2");
+
+  await sanitize();
+});
+
+Deno.test("on_connect oper", async () => {
+  const { server, client, sanitize } = arrange(
+    [onConnect, oper, nick, register],
+    { nick: "nick", oper: { user: "user", pass: "pass" } },
+  );
+
+  server.listen();
+  client.connect(server.host, server.port);
+  await server.waitClient();
+
+  server.send(":serverhost 001 nick :Welcome to the server");
+  const raw = await server.once("OPER");
+  assertEquals(raw, "OPER user pass");
+
+  await sanitize();
+});