refactor(plugins): move sendCapabilities to client.utils

Author: jeromeludmann

plugins/cap.ts

@@ -18,6 +18,12 @@ interface CapFeatures {
   state: {
     capabilities: string[];
   };
+  utils: {
+    /** Sends CAP sequence with existing capabilities.
+     *
+     * Optionaly, takes additional capabilities in argument. */
+    sendCapabilities: (...capabilities: string[]) => void;
+  };
 }
 
 export default createPlugin("cap")<CapFeatures>((client) => {
@@ -28,4 +34,21 @@ export default createPlugin("cap")<CapFeatures>((client) => {
   client.cap = (command, ...params) => {
     client.send("CAP", command, ...params);
   };
+
+  // Provides util to send capabilities
+  // (currently triggered by plugins/registration)
+
+  client.utils.sendCapabilities = (...capabilities: string[]): void => {
+    const caps = [...client.state.capabilities, ...capabilities];
+
+    if (caps.length === 0) {
+      return;
+    }
+
+    for (const cap of caps) {
+      client.cap("REQ", cap);
+    }
+
+    client.cap("END");
+  };
 });

plugins/cap_test.ts

@@ -17,4 +17,26 @@ describe("plugins/cap", (test) => {
 
     assertEquals(raw, ["CAP REQ capability"]);
   });
+
+  test("send capabilities", async () => {
+    const { client, server } = await mock();
+
+    client.state.capabilities.push("cap1");
+    client.utils.sendCapabilities();
+
+    assertEquals(server.receive(), [
+      "CAP REQ multi-prefix", // already provided by plugins/names
+      "CAP REQ cap1", // provided by previous capabilities.push()
+      "CAP END",
+    ]);
+
+    client.utils.sendCapabilities("cap2");
+
+    assertEquals(server.receive(), [
+      "CAP REQ multi-prefix",
+      "CAP REQ cap1",
+      "CAP REQ cap2", // provided by sendCapabilities()
+      "CAP END",
+    ]);
+  });
 });

plugins/registration.ts

@@ -35,20 +35,6 @@ export default createPlugin(
   const { nick, username = nick, realname = nick, password } = options;
   client.state.user = { nick, username, realname };
 
-  const sendCapabilities = () => {
-    const { capabilities } = client.state;
-
-    if (capabilities.length === 0) {
-      return;
-    }
-
-    for (const capability of capabilities) {
-      client.cap("REQ", capability);
-    }
-
-    client.cap("END");
-  };
-
   const sendRegistration = () => {
     if (password !== undefined) {
       client.pass(password);
@@ -60,7 +46,7 @@ export default createPlugin(
   // Sends capabilities and registers once connected.
 
   client.on("connected", () => {
-    sendCapabilities();
+    client.utils.sendCapabilities();
     sendRegistration();
   });