qaut.js 1.0.0 → 1.0.2

package/README.md

@@ -53,6 +53,12 @@ client.on(Events.MessageCreate, async message => {
 client.login();
 ```
 
+`Client` keeps the Node.js process alive after login by default. For one-shot scripts, pass:
+
+```js
+const client = new Client({ token: process.env.QAUT_TOKEN, keepAlive: false });
+```
+
 ## Builders
 
 - `EmbedBuilder`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qaut.js",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official QauT bot framework for building bots and integrations.",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.d.ts

@@ -98,9 +98,16 @@ export declare class TextChannel {
   send(payload: string | Record<string, unknown>): Promise<unknown>;
 }
 
+export declare class User {
+  id: string;
+  constructor(client: Client, data?: Record<string, unknown>);
+  send(payload: string | Record<string, unknown>): Promise<unknown>;
+}
+
 export declare class Message {
   client: Client;
   channel: TextChannel | null;
+  author: User | null;
   content?: string;
   constructor(client: Client, data?: Record<string, unknown>);
   reply(payload: string | Record<string, unknown>): Promise<unknown>;
@@ -111,11 +118,18 @@ export declare class Client extends EventEmitter {
   rest: REST;
   user: unknown;
   intents: IntentBitField;
-  constructor(options?: { token?: string; intents?: Array<number | bigint | string> | number | bigint | string; restBaseUrl?: string });
+  polling: boolean;
+  pollIntervalMs: number;
+  keepAlive: boolean;
+  constructor(options?: { token?: string; intents?: Array<number | bigint | string> | number | bigint | string; restBaseUrl?: string; keepAlive?: boolean; polling?: boolean; pollIntervalMs?: number });
   login(token?: string): Promise<string>;
+  startKeepAlive(): this;
+  startPolling(): this;
+  destroy(): this;
   setPresence(presence?: Record<string, unknown>): Promise<unknown>;
   setStatus(status: string): Promise<unknown>;
   channel(id: string): TextChannel;
+  user(id: string): User;
   emitGatewayEvent(eventName: string, payload: unknown): boolean;
 }
 

package/src/index.js

@@ -222,11 +222,23 @@ class TextChannel {
   }
 }
 
+class User {
+  constructor(client, data = {}) {
+    this.client = client;
+    Object.assign(this, data);
+  }
+
+  send(payload) {
+    return this.client.rest.post(`/bot/users/${this.id}/messages`, normalizeMessagePayload(payload));
+  }
+}
+
 class Message {
   constructor(client, data = {}) {
     this.client = client;
     Object.assign(this, data);
     this.channel = data.channel || (data.channelId ? new TextChannel(client, { id: data.channelId }) : null);
+    this.author = data.author ? new User(client, data.author) : null;
   }
 
   reply(payload) {
@@ -243,6 +255,12 @@ class Client extends EventEmitter {
     this.intents = new IntentBitField(options.intents || 0);
     this.rest = new REST({ token: this.token, baseUrl: options.restBaseUrl || DefaultRestBase });
     this.user = null;
+    this.keepAlive = options.keepAlive !== false;
+    this.keepAliveInterval = null;
+    this.polling = options.polling !== false;
+    this.pollIntervalMs = Number(options.pollIntervalMs || 1500);
+    this.pollInterval = null;
+    this.gatewayCursor = null;
   }
 
   async login(token = this.token) {
@@ -251,10 +269,48 @@ class Client extends EventEmitter {
     this.rest.setToken(token);
     const me = await this.rest.get('/bot/me');
     this.user = me;
+    if (this.keepAlive) this.startKeepAlive();
+    if (this.polling) this.startPolling();
     this.emit(Events.ClientReady, me);
     return token;
   }
 
+  startKeepAlive() {
+    if (this.keepAliveInterval) return this;
+    this.keepAliveInterval = setInterval(() => {
+      this.emit(Events.Debug, 'QauT.js keep-alive heartbeat');
+    }, 30_000);
+    return this;
+  }
+
+  destroy() {
+    if (this.keepAliveInterval) clearInterval(this.keepAliveInterval);
+    if (this.pollInterval) clearInterval(this.pollInterval);
+    this.keepAliveInterval = null;
+    this.pollInterval = null;
+    this.user = null;
+    return this;
+  }
+
+  startPolling() {
+    if (this.pollInterval) return this;
+    this.gatewayCursor = new Date().toISOString();
+    const tick = async () => {
+      try {
+        const query = this.gatewayCursor ? `?after=${encodeURIComponent(this.gatewayCursor)}` : '';
+        const data = await this.rest.get(`/bot/gateway/messages${query}`);
+        this.gatewayCursor = data.cursor || new Date().toISOString();
+        for (const payload of data.messages || []) {
+          this.emitGatewayEvent(Events.MessageCreate, payload);
+        }
+      } catch (err) {
+        this.emit(Events.Error, err);
+      }
+    };
+    this.pollInterval = setInterval(tick, this.pollIntervalMs);
+    return this;
+  }
+
   async setPresence(presence = {}) {
     return this.rest.patch('/bot/presence', presence);
   }
@@ -267,6 +323,10 @@ class Client extends EventEmitter {
     return new TextChannel(this, { id });
   }
 
+  user(id) {
+    return new User(this, { id });
+  }
+
   emitGatewayEvent(eventName, payload) {
     if (eventName === Events.MessageCreate) return this.emit(eventName, new Message(this, payload));
     return this.emit(eventName, payload);
@@ -319,4 +379,5 @@ module.exports = {
   SlashCommandBuilder,
   Status,
   TextChannel
+  , User
 };