@sockethub/irc2as 4.0.0-alpha.9 → 4.0.0-beta.1

package/README.md

@@ -11,8 +11,15 @@ of them, and as time goes on hopefully become more compliant (PRs & feedback wel
 ## Usage
 
 ```javascript
-    var IRC2AS = require('irc2as');
-    var irc2as = new IRC2AS({server: 'irc.freenode.net'});
+    import { IrcToActivityStreams } from '@sockethub/irc2as';
+    const irc2as = new IrcToActivityStreams({
+      server: 'irc.freenode.net',
+      contexts: [
+        'https://www.w3.org/ns/activitystreams',
+        'https://sockethub.org/ns/context/v1.jsonld',
+        'https://sockethub.org/ns/context/platform/irc/v1.jsonld'
+      ]
+    });
 
     irc2as.events.on('incoming', function (asObject) {
       console.log('activity stream: ', asObject);
@@ -22,6 +29,12 @@ of them, and as time goes on hopefully become more compliant (PRs & feedback wel
       console.log('error response to something we sent: ', asObject);
     });
 
+    irc2as.events.on('ctcp', function (ctcp) {
+      // non-ACTION CTCP traffic: { kind: 'request' | 'reply', command, args, from, target }
+      // ACTION (/me) is delivered on 'incoming' as a "me" object instead
+      console.log('ctcp request or reply: ', ctcp);
+    });
+
     irc2as.events.on('unprocessed', function (line) {
       console.log(`irc line we don't know what to do with (yet), PRs welcome`, line);
     });

package/dist/as-emitter.d.ts

@@ -0,0 +1,43 @@
+export class ASEmitter {
+    constructor(events: any, server: any, contexts: any);
+    server: any;
+    events: any;
+    contexts: any[];
+    emitEvent(code: any, asObject: any): void;
+    __generalError(nick: any, content: any): {
+        "@context": any[];
+        type: string;
+        actor: {
+            type: string;
+            id: string;
+            name: any;
+        };
+        target: {
+            type: string;
+            id: any;
+        };
+        error: any;
+    };
+    presence(nick: any, role: any, channel: any): void;
+    attendance(channel: any, nick: any, members: any, roles: any): void;
+    channelError(channel: any, nick: any, content: any): void;
+    nickError(nick: any, content: any): void;
+    notice(nick: any, content: any, from: any): void;
+    serviceError(nick: any, content: any): void;
+    joinError(nick: any): void;
+    topicChange(channel: any, nick: any, content: any): void;
+    joinRoom(channel: any, nick: any): void;
+    userQuit(nick: any): void;
+    userPart(channel: any, nick: any): void;
+    privMsg(nick: any, target: any, content: any): void;
+    /**
+     * Emits a non-ACTION CTCP frame on the `ctcp` event. `kind` is "request"
+     * for a PRIVMSG and "reply" for a NOTICE.
+     */
+    ctcp(kind: any, from: any, target: any, { command, args }: {
+        command: any;
+        args: any;
+    }): void;
+    role(type: any, nick: any, target: any, role: any, channel: any): void;
+    nickChange(nick: any, content: any): void;
+}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/** Cap LIST rows buffered and delivered in one channels response. */
+export const LIST_MAX_ITEMS: 5000;
+export class IrcToActivityStreams {
+    constructor(cfg: any);
+    server: any;
+    contexts: any[];
+    events: events<[never]>;
+    chantypes: string;
+    __buffer: {};
+    __listTruncated: boolean;
+    input(payload: any): boolean;
+    __processIRCCodes(code: any, server: any, channel: any, pos1: any, pos2: any, pos3: any, content: any, msg: any, incoming: any): void;
+}
+import events from "node:events";