slack.ts 0.0.3 → 0.0.5

package/dist/client.js

@@ -1,16 +1,18 @@
-import { sleep } from "./utils/index.js";
-import { ChannelRef } from "./resources/channel.js";
-import { SlackWebAPIError, SlackWebAPIPlatformError } from "./error.js";
+import EventEmitter from "events";
 import { POST_METHODS, } from "./api/index.js";
-import { SocketEventsReceiver } from "./events/receivers/socket.js";
+import { SlackWebAPIError, SlackWebAPIPlatformError } from "./error.js";
 import { DummyReceiver } from "./events/receivers/dummy.js";
+import { SocketEventsReceiver } from "./events/receivers/socket.js";
+import { Action } from "./resources/action.js";
+import { ChannelRef } from "./resources/channel.js";
 import { Message } from "./resources/message.js";
-export class App {
+import { sleep } from "./utils/index.js";
+export class App extends EventEmitter {
     #token;
     #receiver;
-    messageCallbacks = [];
-    eventCallbacks = {};
     constructor({ token, receiver = { type: "dummy" } } = {}) {
+        super({ captureRejections: true });
+        this.on("error", this.#onCallbackError.bind(this));
         this.#token = token;
         switch (receiver.type) {
             case "socket":
@@ -20,44 +22,75 @@ export class App {
                 this.#receiver = new DummyReceiver();
         }
         this.#receiver.on("event", this.#onEvent.bind(this));
+        this.#receiver.on("block_actions", this.#onBlockActions.bind(this));
+        this.#receiver.on("view_submission", this.#onViewSubmission.bind(this));
+        this.on("event:message", this.#onMessage.bind(this));
     }
-    async #onEvent(event) {
-        const data = {
-            client: this,
-            event,
-        };
-        for (const callback of this.eventCallbacks[event.event.type] ?? []) {
-            callback(data);
-        }
-        if (event.event.type === "message") {
-            const data = {
-                message: new Message(this, event.event.channel, event.event.ts, event.event),
-                client: this,
-                event: event,
-            };
-            for (const callback of this.messageCallbacks) {
-                callback(data);
-            }
+    #onEvent(event) {
+        this.emit("event", event);
+        this.emit(`event:${event.event.type}`, { payload: event.event, event: event });
+    }
+    #onBlockActions(event) {
+        this.emit("actions", event);
+        for (const action of event.actions) {
+            const obj = new Action(this, action, event);
+            this.emit(`action:${action.type}`, obj);
+            this.emit(`action.${action.action_id}`, obj);
+            this.emit(`action:${action.type}.${action.action_id}`, obj);
         }
     }
+    #onViewSubmission(event) {
+        this.emit("submit", event);
+        this.emit(`submit.${event.view.callback_id}`, event);
+    }
+    async #onCallbackError(error) {
+        console.error("Error occurred executing callback");
+        console.error(error);
+    }
+    #onMessage({ payload }) {
+        const message = new Message(this, payload.channel, payload.ts, payload);
+        this.emit("message", message);
+        this.emit(`message#${payload.channel}`, message);
+    }
     /**
      * Registers a callback for `message` events.
      *
+     * @deprecated Use `app.on('message', callback)` or `app.on('event:message', callback)`
      * @param callback Function to execute when a new message is received
      */
     message(callback) {
-        this.messageCallbacks.push(callback);
+        this.on("event:message", async ({ event, payload }) => {
+            await callback({
+                event,
+                message: new Message(this, payload.channel, payload.ts, payload),
+                client: this,
+            });
+        });
     }
     /**
      * Registers a callback for a given type of event.
      *
+     * @deprecated Use `app.on('event:type', callback)` instead
      * @param type Type of event to register
      * @param callback Function to execute when the event is received
      */
     event(type, callback) {
-        if (!this.eventCallbacks[type])
-            this.eventCallbacks[type] = [];
-        this.eventCallbacks[type].push(callback);
+        this.on(`event:${type}`, async ({ event }) => {
+            await callback({ event: event, client: this });
+        });
+    }
+    /**
+     * Registers a callback for a given type of block actions.
+     *
+     * @deprecated Use `app.on('action:type', ...)`, `app.on('action.action_id', ...)`, or
+     *   `app.on('action:type.action_id', ...)` instead
+     * @param type Type of event to register
+     * @param callback Function to execute when the event is received
+     */
+    action(type, callback) {
+        this.on(`action:${type}`, async (action) => {
+            await callback(action);
+        });
     }
     /**
      * Starts the event receiver. If you don't use the events, interactions, and slash command APIs,
@@ -79,15 +112,15 @@ export class App {
     /**
      * Makes a Slack Web API request.
      *
-     * @param endpoint The Slack Web API method to call
+     * @param method The Slack Web API method to call
      * @param params The parameters for the method
-     * @param [method='GET'] The HTTP method for the request. Default is `'GET'`
      * @returns The response from the API call
      */
-    async request(endpoint, params, method = POST_METHODS.includes(endpoint) ? "POST" : "GET") {
-        const body = method !== "GET" ? JSON.stringify(params) : undefined;
-        const url = new URL(`https://slack.com/api/${endpoint}`);
-        if (method === "GET" && params) {
+    async request(method, params) {
+        const httpMethod = POST_METHODS.includes(method) ? "POST" : "GET";
+        const body = httpMethod !== "GET" ? JSON.stringify(params) : undefined;
+        const url = new URL(`https://slack.com/api/${method}`);
+        if (httpMethod === "GET" && params) {
             for (const [key, value] of Object.entries(params)) {
                 if (value instanceof Array) {
                     for (const item of value) {
@@ -106,7 +139,11 @@ export class App {
         if (params.token || this.#token) {
             headers.set("Authorization", `Bearer ${params.token || this.#token}`);
         }
-        const res = await request(url.toString(), { method, body, headers });
+        const res = await request(url.toString(), {
+            method: httpMethod,
+            body,
+            headers,
+        });
         if (!res.ok) {
             throw new SlackWebAPIPlatformError(url.toString(), res, res.error);
         }

package/dist/error.d.ts

@@ -1,5 +1,7 @@
 export declare class SlackError extends Error {
 }
+export declare class SlackTimeoutError extends Error {
+}
 export declare class SlackWebAPIError extends SlackError {
     url: string;
     data?: unknown | undefined;

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC,qBAAa,gBAAiB,SAAQ,UAAU;IAEvC,GAAG,EAAE,MAAM;IACX,IAAI,CAAC,EAAE,OAAO;gBADd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,OAAO,YAAA;CAItB;AAED,qBAAa,wBAAyB,SAAQ,gBAAgB;IAIrD,KAAK,EAAE,MAAM;gBAFpB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACN,KAAK,EAAE,MAAM;CAIrB"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA,qBAAa,UAAW,SAAQ,KAAK;CAAG;AAExC,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C,qBAAa,gBAAiB,SAAQ,UAAU;IAEvC,GAAG,EAAE,MAAM;IACX,IAAI,CAAC,EAAE,OAAO;gBADd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,OAAO,YAAA;CAItB;AAED,qBAAa,wBAAyB,SAAQ,gBAAgB;IAIrD,KAAK,EAAE,MAAM;gBAFpB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACN,KAAK,EAAE,MAAM;CAIrB"}

package/dist/error.js

@@ -1,5 +1,7 @@
 export class SlackError extends Error {
 }
+export class SlackTimeoutError extends Error {
+}
 export class SlackWebAPIError extends SlackError {
     url;
     data;

package/dist/events/receivers/socket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/events/receivers/socket.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AAEjC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,cAAc,EAAgB,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAE9E,MAAM,WAAW,2BAA2B;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,GAAG,CAAA;CACX;AAED,qBAAa,oBAAqB,SAAQ,YAAY,CAAC,gBAAgB,CAAE,YAAW,cAAc;;IAE1F,MAAM,EAAE,GAAG,CAAA;gBAGN,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,2BAA2B;IAMvD,KAAK;YAIG,QAAQ;CAuCtB"}
+{"version":3,"file":"socket.d.ts","sourceRoot":"","sources":["../../../src/events/receivers/socket.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AAEjC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AACvC,OAAO,KAAK,EAAE,cAAc,EAAgB,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAG9E,MAAM,WAAW,2BAA2B;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,GAAG,CAAA;CACX;AAED,qBAAa,oBAAqB,SAAQ,YAAY,CAAC,gBAAgB,CAAE,YAAW,cAAc;;IAE1F,MAAM,EAAE,GAAG,CAAA;gBAGN,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,2BAA2B;IAYvD,KAAK;YAIG,QAAQ;CA0CtB"}

package/dist/events/receivers/socket.js

@@ -5,16 +5,21 @@ export class SocketEventsReceiver extends EventEmitter {
     client;
     #ws;
     constructor({ appToken, client }) {
-        super();
+        super({ captureRejections: true });
+        this.on('error', this.#onEventError.bind(this));
         this.#appToken = appToken;
         this.client = client;
     }
+    #onEventError(error) {
+        console.error('[socket-mode] error occurred handling event');
+        console.error(error);
+    }
     async start() {
         await this._connect();
     }
     async _connect() {
         const { url } = await this.client.request('apps.connections.open', { token: this.#appToken });
-        this.#ws = new WebSocket(url + '&debug_reconnects=true');
+        this.#ws = new WebSocket(url);
         this.#ws.addEventListener('open', this.#onOpen.bind(this));
         this.#ws.addEventListener('message', this.#onMessage.bind(this));
         this.#ws.addEventListener('close', this.#onClose.bind(this));
@@ -31,6 +36,10 @@ export class SocketEventsReceiver extends EventEmitter {
                 this.#ws?.send(JSON.stringify({ envelope_id: data.envelope_id }));
                 this.emit('event', data.payload);
             }
+            else if (data.type === 'interactive') {
+                this.#ws?.send(JSON.stringify({ envelope_id: data.envelope_id }));
+                this.emit(data.payload.type, data.payload);
+            }
             else if (data.type === 'hello') {
                 console.debug('[socket-mode] received server hello, app id', data.connection_info.app_id);
             }

package/dist/events/types/index.d.ts

@@ -1,5 +1,7 @@
 import type EventEmitter from "events";
 import type { AppMentionEvent, MessageEvent } from "./events.js";
+import type { BlockActions } from "../../api/interactive/block_actions.js";
+import type { ViewSubmission } from "../../api/interactive/view_submission.js";
 export interface EventsReceiver extends EventEmitter<ReceiverEventMap> {
     start(): unknown;
 }
@@ -27,6 +29,12 @@ export type ReceiverEventMap = {
     event: [
         EventWrapper<AllEvents>
     ];
+    block_actions: [
+        BlockActions
+    ];
+    view_submission: [
+        ViewSubmission
+    ];
 };
 export type AllEvents = AppMentionEvent | MessageEvent;
 //# sourceMappingURL=index.d.ts.map

package/dist/events/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAE7D,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACrE,KAAK,IAAI,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC5D,IAAI,EAAE,gBAAgB,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,CAAC,CAAA;IACR,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,OAAO,EAAE,CAAA;IACzB,qBAAqB,EAAE,OAAO,CAAA;IAC9B,eAAe,EAAE,MAAM,CAAA;IACvB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;AAE7C,MAAM,MAAM,aAAa,GAAG;KAC1B,CAAC,IAAI,aAAa,GAAG,SAAS,GAAG;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE;CAC7C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,KAAK,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,QAAQ,CAAA;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAA;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AAE3E,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACrE,KAAK,IAAI,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC5D,IAAI,EAAE,gBAAgB,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,CAAC,CAAA;IACR,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,OAAO,EAAE,CAAA;IACzB,qBAAqB,EAAE,OAAO,CAAA;IAC9B,eAAe,EAAE,MAAM,CAAA;IACvB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;AAE7C,MAAM,MAAM,aAAa,GAAG;KAC1B,CAAC,IAAI,aAAa,GAAG,SAAS,GAAG;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE;CAC7C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,KAAK,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAA;IAChC,aAAa,EAAE,CAAC,YAAY,CAAC,CAAA;IAC7B,eAAe,EAAE,CAAC,cAAc,CAAC,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,YAAY,CAAA"}

package/dist/resources/action.d.ts

@@ -0,0 +1,13 @@
+import type { BlockAction, BlockActions } from "../api/interactive/block_actions.js";
+import type { App } from "../client.js";
+import { type Responder } from "../utils/respond.js";
+export declare class Action<Type extends BlockAction = BlockAction> {
+    #private;
+    protected client: App;
+    constructor(client: App, action: Type, event: BlockActions);
+    get event(): BlockActions;
+    get raw(): Type;
+    get respond(): Responder<true>;
+}
+export type ActionInstance<Type extends BlockAction = BlockAction> = Action<Type> & Type;
+//# sourceMappingURL=action.d.ts.map

package/dist/resources/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/resources/action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACjF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,EAAiB,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAEhE,qBAAa,MAAM,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW;;IAKxD,SAAS,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG,EACrB,MAAM,EAAE,IAAI,EACZ,KAAK,EAAE,YAAY;IAOpB,IAAI,KAAK,iBAER;IAED,IAAI,GAAG,SAEN;IAED,IAAI,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAE7B;CACD;AAED,MAAM,MAAM,cAAc,CAAC,IAAI,SAAS,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA"}

package/dist/resources/action.js

@@ -0,0 +1,22 @@
+import { makeProxy } from "../utils/index.js";
+import { ResponderImpl } from "../utils/respond.js";
+export class Action {
+    client;
+    #data;
+    #event;
+    constructor(client, action, event) {
+        this.client = client;
+        this.#data = action;
+        this.#event = event;
+        return makeProxy(this, () => this.#data);
+    }
+    get event() {
+        return this.#event;
+    }
+    get raw() {
+        return this.#data;
+    }
+    get respond() {
+        return new ResponderImpl(this.client, this.#event.response_url, this.#event.trigger_id);
+    }
+}

package/dist/resources/channel.d.ts

@@ -1,9 +1,24 @@
+import type { TimestampPaginationParams } from "../api/types/api.js";
 import type { Conversation } from "../api/types/conversation.js";
 import type { NormalMessage } from "../api/types/message.js";
 import type { App } from "../client.js";
 import { type SendMessageWithFiles, type SendMessageWithoutFiles } from "../utils/messaging.js";
 import type { DistributiveOmit } from "../utils/typing.js";
 import { MessageRef, type MessageInstance } from "./message.js";
+import { UserRef } from "./user.js";
+interface FetchMessagesParams extends Omit<TimestampPaginationParams, "limit"> {
+    /**
+     * How many messages to fetch in each API call. This will not affect the number of returned
+     * messages.
+     */
+    batch?: number;
+    /**
+     * How many messages to return in total.
+     *
+     * @default Infinity
+     */
+    limit?: number;
+}
 declare class ChannelMixin {
     #private;
     protected client: App;
@@ -32,6 +47,15 @@ declare class ChannelMixin {
      * @returns A message reference object
      */
     message(ts: string): MessageRef<import("../api/types/message.js").AnyMessage>;
+    /**
+     * Fetches messages in the channel. Note that this method only fetches root messages (i.e.,
+     * messages not in a thread); to fetch thread replies, use the `replies` method on messages
+     * instead.
+     *
+     * @param params Options for fetching messages
+     * @returns An async iterator of messages, from newest to oldest
+     */
+    messages(params?: FetchMessagesParams): AsyncGenerator<MessageInstance, void, unknown>;
 }
 export declare class ChannelRef extends ChannelMixin implements PromiseLike<ChannelInstance> {
     #private;
@@ -40,7 +64,9 @@ export declare class ChannelRef extends ChannelMixin implements PromiseLike<Chan
 export declare class Channel extends ChannelMixin {
     #private;
     constructor(client: App, id: string, data: Conversation);
+    /** A reference to the creator of this channel. Only available for non-DM channels. */
+    get creator(): UserRef | undefined;
 }
-export type ChannelInstance = Channel & Conversation;
+export type ChannelInstance = Channel & DistributiveOmit<Conversation, "creator">;
 export {};
 //# sourceMappingURL=channel.d.ts.map

package/dist/resources/channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/resources/channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,EAGN,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAW,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAErE,cAAM,YAAY;;IAIhB,SAAS,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG,EACrB,EAAE,EAAE,MAAM;IAKX,wBAAwB;IACxB,IAAI,EAAE,WAEL;IAED;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAE1F;;;;;OAKG;IACG,IAAI,CACT,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,EAAE,SAAS,CAAC,GAAG,MAAM,GACpE,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAiB1C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;CAGlB;AAED,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW,CAAC,eAAe,CAAC;;IACnF,IAAI,CAAC,QAAQ,GAAG,eAAe,EAAE,QAAQ,GAAG,KAAK,EAChD,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,eAAe,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EAC/F,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GACjF,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;CAQnC;AAED,qBAAa,OAAQ,SAAQ,YAAY;;gBAG5B,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;CAKvD;AAED,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,YAAY,CAAA"}
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/resources/channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,EAGN,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAW,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEhC,UAAU,mBAAoB,SAAQ,IAAI,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAC7E;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACd;AAED,cAAM,YAAY;;IAIhB,SAAS,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG,EACrB,EAAE,EAAE,MAAM;IAKX,wBAAwB;IACxB,IAAI,EAAE,WAEL;IAED;;;;;OAKG;IACG,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAE1F;;;;;OAKG;IACG,IAAI,CACT,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,EAAE,SAAS,CAAC,GAAG,MAAM,GACpE,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAiB1C;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;IAIlB;;;;;;;OAOG;IACI,QAAQ,CAAC,MAAM,GAAE,mBAAwB;CAOhD;AAED,qBAAa,UAAW,SAAQ,YAAa,YAAW,WAAW,CAAC,eAAe,CAAC;;IACnF,IAAI,CAAC,QAAQ,GAAG,eAAe,EAAE,QAAQ,GAAG,KAAK,EAChD,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,eAAe,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EAC/F,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GACjF,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;CAQnC;AAED,qBAAa,OAAQ,SAAQ,YAAY;;gBAG5B,MAAM,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAMvD,sFAAsF;IACtF,IAAI,OAAO,wBAEV;CACD;AAED,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,gBAAgB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA"}

package/dist/resources/channel.js

@@ -1,6 +1,8 @@
 import { makeProxy } from "../utils/index.js";
 import { sendMessage, } from "../utils/messaging.js";
+import { paginate } from "../utils/paginate.js";
 import { Message, MessageRef } from "./message.js";
+import { UserRef } from "./user.js";
 class ChannelMixin {
     client;
     #id;
@@ -31,6 +33,19 @@ class ChannelMixin {
     message(ts) {
         return new MessageRef(this.client, this.#id, ts);
     }
+    /**
+     * Fetches messages in the channel. Note that this method only fetches root messages (i.e.,
+     * messages not in a thread); to fetch thread replies, use the `replies` method on messages
+     * instead.
+     *
+     * @param params Options for fetching messages
+     * @returns An async iterator of messages, from newest to oldest
+     */
+    async *messages(params = {}) {
+        yield* paginate(this.client, "conversations.history", { channel: this.#id, ...params }, (r) => r.messages
+            .values()
+            .map((m) => new Message(this.client, this.#id, m.ts, m)));
+    }
 }
 export class ChannelRef extends ChannelMixin {
     then(onfulfilled, onrejected) {
@@ -48,4 +63,8 @@ export class Channel extends ChannelMixin {
         this.#data = data;
         return makeProxy(this, () => this.#data);
     }
+    /** A reference to the creator of this channel. Only available for non-DM channels. */
+    get creator() {
+        return this.#data.creator ? new UserRef(this.client, this.#data.creator) : undefined;
+    }
 }

package/dist/resources/message.d.ts

@@ -1,8 +1,31 @@
+import type { BlockAction, BlockActionTypes } from "../api/interactive/block_actions.js";
+import type { TimestampPaginationParams } from "../api/types/api.js";
 import type { AnyMessage, NormalMessage } from "../api/types/message.js";
 import type { App } from "../client.js";
 import { type SendMessageWithFiles, type SendMessageWithoutFiles } from "../utils/messaging.js";
 import type { DistributiveOmit } from "../utils/typing.js";
+import type { ActionInstance } from "./action.js";
 import { ChannelRef } from "./channel.js";
+import { UserRef } from "./user.js";
+interface FetchRepliesParams extends Omit<TimestampPaginationParams, "limit"> {
+    /**
+     * How many replies to fetch in each API call. This will not affect the number of returned
+     * messages.
+     */
+    batch?: number;
+    /**
+     * How many replies to return in total.
+     *
+     * @default Infinity
+     */
+    limit?: number;
+    /**
+     * Whether to include the root message in the results.
+     *
+     * @default true
+     */
+    root?: boolean;
+}
 declare class MessageMixin {
     #private;
     protected client: App;
@@ -13,6 +36,11 @@ declare class MessageMixin {
     /** Timestamp of the message */
     get ts(): string;
     protected get _threadTs(): string | undefined;
+    /**
+     * Waits for an event about this message to occur before continuing. To configure the wait object,
+     * see its methods (for example, `message.wait.timeout(60000)`).
+     */
+    get wait(): MessageWait;
     /**
      * Sends a message as a reply to this messsage with files.
      *
@@ -27,6 +55,14 @@ declare class MessageMixin {
      * @returns The sent message
      */
     reply(message: DistributiveOmit<SendMessageWithoutFiles, "channel" | "thread_ts"> | string): Promise<MessageInstance<NormalMessage>>;
+    /**
+     * Fetches replies in the thread of this message. Note that this method may return the root
+     * message by default; set `params.root` to `false` to skip it.
+     *
+     * @param params Options for fetching replies
+     * @returns An async iterator of messages, from oldest to newest
+     */
+    replies(params?: FetchRepliesParams): AsyncGenerator<MessageInstance, void, unknown>;
 }
 export declare class MessageRef<Subtype extends AnyMessage = AnyMessage> extends MessageMixin implements PromiseLike<Message<Subtype>> {
     #private;
@@ -39,8 +75,67 @@ export declare class Message<Subtype extends AnyMessage = AnyMessage> extends Me
     isNormal(): this is MessageInstance<NormalMessage>;
     /** The raw data of this message */
     get raw(): Subtype;
+    /**
+     * A reference to the user that created the message. Note that for system messages (such as
+     * channel join messages), this may not be the user you expect. Read the Slack documentation to
+     * find out.
+     */
+    get author(): UserRef;
     protected get _threadTs(): string | undefined;
 }
 export type MessageInstance<Subtype extends AnyMessage = AnyMessage> = Message<Subtype> & Subtype;
+declare class MessageWait {
+    private message;
+    private client;
+    private _timeout;
+    constructor(message: MessageMixin, client: App);
+    /**
+     * Sets the timeout of the wait. A `SlackTimeoutError` will be thrown if no matching event occurs
+     * after the timeout. Set this to `0` to disable timeouts; i.e., methods will wait forever. (This
+     * is dangerous because it creates potential memory leaks!)
+     *
+     * By default, timeout is set to 10 minutes.
+     *
+     * @param timeout Timeout in milliseconds
+     * @returns `this` for chaining
+     */
+    timeout(timeout: number): this;
+    /**
+     * Waits for a block action on this message happened (e.g., a button is pressed).
+     *
+     * The parameters can be any of any of the following:
+     *
+     * - An action ID; for example, `'place_order'`.
+     * - An event type and an action ID joined with a dot (`.`); for example, `'button.place_order'`.
+     *   The benefit of using this instead of a plain action ID is, if all string parameters have an
+     *   event type prefix, the return type of this function will be automatically narrowed to only
+     *   the possible action types.
+     * - A function (`async` or not) that takes in an action and returns `false` if this action should
+     *   be ignored (useful for permission checks).
+     *
+     * An action is matched if its container is this message, its `action_id` is one of the parameters
+     * passed in, and it passes all the function checks.
+     *
+     * NOTE: You must specify at least one non-function parameter, since the `action_id` of the action
+     * must match one of the arguments.
+     *
+     * @param specifiers An array of specifiers (see above for their format)
+     * @returns The action that occurred that matches the specifiers.
+     * @throws `SlackTimeoutError` if timed out before a matched event occurred
+     */
+    action<ActionIDs extends (string | ActionPredicate)[]>(...specifiers: ActionIDs): Promise<ExtractActionWaitReturnValue<ExtractString<ActionIDs[number]>>>;
+}
+type ActionPredicate = (action: ActionInstance) => boolean | Promise<boolean>;
+type ExtractActionWaitReturnValue<ActionID extends string> = ActionInstance<ExtractWaitActionType<ActionID>>;
+type ExtractWaitActionType<Specifier extends string> = {
+    [K in Specifier]: BlockAction & ExtractTypeAndActionID<Specifier>;
+}[Specifier];
+type ExtractTypeAndActionID<T extends string> = T extends `${infer Type extends BlockActionTypes}.${infer ActionID}` ? {
+    type: Type;
+    action_id: ActionID;
+} : {
+    action_id: T;
+};
+type ExtractString<T> = T extends string ? T : never;
 export {};
 //# sourceMappingURL=message.d.ts.map

package/dist/resources/message.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/resources/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAGpC,OAAO,EAGN,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,cAAM,YAAY;;IAKhB,SAAS,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG,EACrB,OAAO,EAAE,MAAM,EACf,EAAE,EAAE,MAAM;IAMX,8CAA8C;IAC9C,IAAI,OAAO,eAEV;IAED,SAAS,KAAK,UAAU,WAEvB;IAED,+BAA+B;IAC/B,IAAI,EAAE,WAEL;IAED,SAAS,KAAK,SAAS,IAAI,MAAM,GAAG,SAAS,CAE5C;IAED;;;;;OAKG;IACG,KAAK,CACV,OAAO,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,SAAS,GAAG,WAAW,CAAC,GACtE,OAAO,CAAC,SAAS,CAAC;IAErB;;;;;OAKG;IACG,KAAK,CACV,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,EAAE,SAAS,GAAG,WAAW,CAAC,GAAG,MAAM,GAClF,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;CAoB1C;AAED,qBAAa,UAAU,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,CAC9D,SAAQ,YACR,YAAW,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;;IAExC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,KAAK,EACjD,WAAW,CAAC,EACT,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAC/D,IAAI,GACJ,SAAS,EACZ,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GACjF,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;CAsBnC;AAED,qBAAa,OAAO,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,YAAY;;gBAGrE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;IAMnE,+EAA+E;IAC/E,QAAQ,IAAI,IAAI,IAAI,eAAe,CAAC,aAAa,CAAC;IAIlD,mCAAmC;IACnC,IAAI,GAAG,YAEN;IAED,cAAuB,SAAS,IAAI,MAAM,GAAG,SAAS,CAErD;CACD;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA"}
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../src/resources/message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AAGpC,OAAO,EAGN,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEhC,UAAU,kBAAmB,SAAQ,IAAI,CAAC,yBAAyB,EAAE,OAAO,CAAC;IAC5E;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACd;AAED,cAAM,YAAY;;IAKhB,SAAS,CAAC,MAAM,EAAE,GAAG;gBAAX,MAAM,EAAE,GAAG,EACrB,OAAO,EAAE,MAAM,EACf,EAAE,EAAE,MAAM;IAMX,8CAA8C;IAC9C,IAAI,OAAO,eAEV;IAED,SAAS,KAAK,UAAU,WAEvB;IAED,+BAA+B;IAC/B,IAAI,EAAE,WAEL;IAED,SAAS,KAAK,SAAS,IAAI,MAAM,GAAG,SAAS,CAE5C;IAED;;;OAGG;IACH,IAAI,IAAI,gBAEP;IAED;;;;;OAKG;IACG,KAAK,CACV,OAAO,EAAE,gBAAgB,CAAC,oBAAoB,EAAE,SAAS,GAAG,WAAW,CAAC,GACtE,OAAO,CAAC,SAAS,CAAC;IAErB;;;;;OAKG;IACG,KAAK,CACV,OAAO,EAAE,gBAAgB,CAAC,uBAAuB,EAAE,SAAS,GAAG,WAAW,CAAC,GAAG,MAAM,GAClF,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAqB1C;;;;;;OAMG;IACI,OAAO,CAAC,MAAM,GAAE,kBAAuB,GAAG,cAAc,CAAC,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC;CAY/F;AAED,qBAAa,UAAU,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,CAC9D,SAAQ,YACR,YAAW,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;;IAExC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,KAAK,EACjD,WAAW,CAAC,EACT,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAC/D,IAAI,GACJ,SAAS,EACZ,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,GACjF,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;CAsBnC;AAED,qBAAa,OAAO,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,CAAE,SAAQ,YAAY;;gBAGrE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;IAMnE,+EAA+E;IAC/E,QAAQ,IAAI,IAAI,IAAI,eAAe,CAAC,aAAa,CAAC;IAIlD,mCAAmC;IACnC,IAAI,GAAG,YAEN;IAED;;;;OAIG;IACH,IAAI,MAAM,YAET;IAED,cAAuB,SAAS,IAAI,MAAM,GAAG,SAAS,CAErD;CACD;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;AAEjG,cAAM,WAAW;IAIf,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,MAAM;IAJf,OAAO,CAAC,QAAQ,CAAW;gBAGlB,OAAO,EAAE,YAAY,EACrB,MAAM,EAAE,GAAG;IAGpB;;;;;;;;;OASG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM;IAKvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,SAAS,SAAS,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,EAC1D,GAAG,UAAU,EAAE,SAAS,GACtB,OAAO,CAAC,4BAA4B,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAwD1E;AAED,KAAK,eAAe,GAAG,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAE7E,KAAK,4BAA4B,CAAC,QAAQ,SAAS,MAAM,IAAI,cAAc,CAC1E,qBAAqB,CAAC,QAAQ,CAAC,CAC/B,CAAA;AAED,KAAK,qBAAqB,CAAC,SAAS,SAAS,MAAM,IAAI;KACrD,CAAC,IAAI,SAAS,GAAG,WAAW,GAAG,sBAAsB,CAAC,SAAS,CAAC;CACjE,CAAC,SAAS,CAAC,CAAA;AAEZ,KAAK,sBAAsB,CAAC,CAAC,SAAS,MAAM,IAC3C,CAAC,SAAS,GAAG,MAAM,IAAI,SAAS,gBAAgB,IAAI,MAAM,QAAQ,EAAE,GACjE;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,SAAS,EAAE,QAAQ,CAAA;CAAE,GACnC;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,CAAA;AAEpB,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,CAAA"}