@sockethub/platform-irc 4.0.0-alpha.24 → 4.0.0-alpha.25

package/README.md

@@ -18,8 +18,8 @@ messages.
 
 ## Usage
 
-IRC room targets use `channel@server` in `target.id` (for example
-`general@irc.libera.chat`). When you include `target.name`, use the channel
+IRC room targets use `#channel@server` in `target.id` (for example
+`#general@irc.libera.chat`). When you include `target.name`, use the channel
 name as it appears on IRC (for example `#general`).
 
 ### Send Message Example
@@ -37,7 +37,7 @@ name as it appears on IRC (for example `#general`).
     "type": "person"
   },
   "target": {
-    "id": "general@irc.libera.chat",
+    "id": "#general@irc.libera.chat",
     "type": "room",
     "name": "#general"
   },
@@ -63,7 +63,7 @@ name as it appears on IRC (for example `#general`).
     "type": "person"
   },
   "target": {
-    "id": "general@irc.libera.chat",
+    "id": "#general@irc.libera.chat",
     "type": "room",
     "name": "#general"
   }
@@ -110,7 +110,7 @@ name as it appears on IRC (for example `#general`).
     "type": "person"
   },
   "target": {
-    "id": "general@irc.libera.chat",
+    "id": "#general@irc.libera.chat",
     "type": "room",
     "name": "#general"
   },
@@ -160,7 +160,7 @@ name as it appears on IRC (for example `#general`).
     "type": "person"
   },
   "target": {
-    "id": "general@irc.libera.chat",
+    "id": "#general@irc.libera.chat",
     "type": "room",
     "name": "#general"
   },
@@ -181,7 +181,7 @@ name as it appears on IRC (for example `#general`).
     "https://sockethub.org/ns/context/platform/irc/v1.jsonld"
   ],
   "actor": {
-    "id": "general@irc.libera.chat",
+    "id": "#general@irc.libera.chat",
     "type": "room",
     "name": "#general"
   },

package/dist/index.d.ts

@@ -118,13 +118,19 @@ export declare class IRC implements PersistentPlatformInterface {
     disconnect(job: ActivityStream, done: PlatformCallback): void;
     cleanup(done: PlatformCallback): any;
     /**
-     * Resolve an IRC channel name from a job target. Prefers `target.name`,
-     * falling back to the channel segment of `target.id` (`<server>/<channel>`).
-     * Returns undefined when no valid `#channel` can be determined, so callers
-     * never emit a bare `NAMES` command (which floods the client with the
-     * server's entire channel list).
+     * Resolve an activity target to its IRC recipient (channel or nick).
+     *
+     * Targets are server-qualified for consistency with what the platform emits
+     * (see irc2as): rooms are addressed as `#channel@server` and users
+     * (private messages) as
+     * `nick@server` — the same `@server` suffix for both. Returns `null` for a
+     * `room` target that isn't server-qualified (a bare channel), which callers
+     * reject — bare channel names are no longer accepted.
+     *
+     * @param target activity stream target (`job.target`)
+     * @returns the IRC channel (`#channel`) or nick, or `null` for a bare room
      */
-    private resolveChannelName;
+    private resolveIrcTarget;
     private isJoined;
     private hasJoined;
     private hasLeft;