@mtcute/dispatcher 0.17.2 → 0.18.0

package/callback-data-builder.cjs

@@ -0,0 +1,126 @@
+if (typeof globalThis !== "undefined" && !globalThis._MTCUTE_CJS_DEPRECATION_WARNED) {
+  globalThis._MTCUTE_CJS_DEPRECATION_WARNED = true;
+  console.warn("[mtcute-workspace] CommonJS support is deprecated and will be removed in 0.20.0. Please consider switching to ESM, it's " + (/* @__PURE__ */ new Date()).getFullYear() + " already.");
+  console.warn("[mtcute-workspace] Learn more about switching to ESM: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c");
+}
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const core = require("@mtcute/core");
+class CallbackDataBuilder {
+  /**
+   * @param prefix  Prefix for the data. Use something unique across your bot.
+   * @param fields  Field names in the order they will be serialized.
+   */
+  constructor(prefix, ...fields) {
+    this.prefix = prefix;
+    this._fields = fields;
+  }
+  _fields;
+  sep = ":";
+  /**
+   * Build a callback data string
+   *
+   * @param obj  Object containing the data
+   */
+  build(obj) {
+    const ret = this.prefix + this.sep + this._fields.map((f) => {
+      const val = obj[f];
+      if (val.includes(this.sep)) {
+        throw new core.MtArgumentError(
+          `Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`
+        );
+      }
+      return val;
+    }).join(this.sep);
+    if (ret.length > 64) {
+      throw new core.MtArgumentError("Resulting callback data is too long.");
+    }
+    return ret;
+  }
+  parse(data, safe = false) {
+    const parts = data.split(this.sep);
+    if (parts[0] !== this.prefix) {
+      if (safe) return null;
+      throw new core.MtArgumentError(
+        `Invalid data passed: "${data}" (bad prefix, expected ${this.prefix}, got ${parts[0]})`
+      );
+    }
+    if (parts.length !== this._fields.length + 1) {
+      if (safe) return null;
+      throw new core.MtArgumentError(
+        `Invalid data passed: "${data}" (bad parts count, expected ${this._fields.length}, got ${parts.length - 1})`
+      );
+    }
+    const ret = {};
+    parts.forEach((it, idx) => {
+      if (idx === 0) return;
+      ret[this._fields[idx - 1]] = it;
+    });
+    return ret;
+  }
+  /**
+   * Create a filter for this callback data.
+   *
+   * You can either pass an object with field names as keys and values as strings or regexes,
+   * which will be compiled to a RegExp, or a function that will be called with the parsed data.
+   * Note that the strings will be passed to `RegExp` **directly**, so you may want to escape them.
+   *
+   * When using a function, you can either return a boolean, or an object with field names as keys
+   * and values as strings or regexes. In the latter case, the resulting object will be matched
+   * against the parsed data the same way as if you passed it directly.
+   *
+   * @param params
+   */
+  filter(params = {}) {
+    if (typeof params === "function") {
+      return async (query) => {
+        if (!query.dataStr) return false;
+        const data = this.parse(query.dataStr, true);
+        if (!data) return false;
+        const fnResult = await params(query, data);
+        if (typeof fnResult === "boolean") {
+          query.match = data;
+          return fnResult;
+        }
+        for (const key in fnResult) {
+          const value = data[key];
+          if (value === void 0) return false;
+          let matchers = fnResult[key];
+          if (!Array.isArray(matchers)) matchers = [matchers];
+          for (const matcher of matchers) {
+            if (typeof matcher === "string") {
+              if (value !== matcher) return false;
+            } else if (!matcher.test(value)) {
+              return false;
+            }
+          }
+        }
+        query.match = data;
+        return true;
+      };
+    }
+    const parts = [];
+    this._fields.forEach((field) => {
+      if (!(field in params)) {
+        parts.push(`[^${this.sep}]*?`);
+        return;
+      }
+      const value = params[field];
+      if (Array.isArray(value)) {
+        parts.push(`(${value.map((i) => typeof i === "string" ? i : i.source).join("|")})`);
+      } else {
+        parts.push(typeof value === "string" ? value : value.source);
+      }
+    });
+    const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`);
+    return (query) => {
+      const m = query.dataStr?.match(regex);
+      if (!m) {
+        return false;
+      }
+      query.match = this.parse(m[0]);
+      return true;
+    };
+  }
+}
+exports.CallbackDataBuilder = CallbackDataBuilder;

package/callback-data-builder.d.cts

@@ -0,0 +1,49 @@
+import { BusinessCallbackQuery, CallbackQuery, InlineCallbackQuery, MaybeArray, MaybePromise } from '@mtcute/core';
+import { UpdateFilter } from './filters/types.js';
+/**
+ * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).
+ *
+ * This can be used to simplify management of different callbacks.
+ *
+ * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)
+ */
+export declare class CallbackDataBuilder<T extends string> {
+    prefix: string;
+    private readonly _fields;
+    sep: string;
+    /**
+     * @param prefix  Prefix for the data. Use something unique across your bot.
+     * @param fields  Field names in the order they will be serialized.
+     */
+    constructor(prefix: string, ...fields: T[]);
+    /**
+     * Build a callback data string
+     *
+     * @param obj  Object containing the data
+     */
+    build(obj: Record<T, string>): string;
+    /**
+     * Parse callback data to object
+     *
+     * @param data  Callback data as string
+     * @param safe  If `true`, will return `null` instead of throwing on invalid data
+     */
+    parse(data: string, safe?: false): Record<T, string>;
+    parse(data: string, safe: true): Record<T, string> | null;
+    /**
+     * Create a filter for this callback data.
+     *
+     * You can either pass an object with field names as keys and values as strings or regexes,
+     * which will be compiled to a RegExp, or a function that will be called with the parsed data.
+     * Note that the strings will be passed to `RegExp` **directly**, so you may want to escape them.
+     *
+     * When using a function, you can either return a boolean, or an object with field names as keys
+     * and values as strings or regexes. In the latter case, the resulting object will be matched
+     * against the parsed data the same way as if you passed it directly.
+     *
+     * @param params
+     */
+    filter<Update extends CallbackQuery | InlineCallbackQuery | BusinessCallbackQuery>(params?: ((upd: Update, parsed: Record<T, string>) => MaybePromise<Partial<Record<T, MaybeArray<string | RegExp>>> | boolean>) | Partial<Record<T, MaybeArray<string | RegExp>>>): UpdateFilter<Update, {
+        match: Record<T, string>;
+    }>;
+}

package/callback-data-builder.js

@@ -0,0 +1,121 @@
+import { MtArgumentError } from "@mtcute/core";
+class CallbackDataBuilder {
+  /**
+   * @param prefix  Prefix for the data. Use something unique across your bot.
+   * @param fields  Field names in the order they will be serialized.
+   */
+  constructor(prefix, ...fields) {
+    this.prefix = prefix;
+    this._fields = fields;
+  }
+  _fields;
+  sep = ":";
+  /**
+   * Build a callback data string
+   *
+   * @param obj  Object containing the data
+   */
+  build(obj) {
+    const ret = this.prefix + this.sep + this._fields.map((f) => {
+      const val = obj[f];
+      if (val.includes(this.sep)) {
+        throw new MtArgumentError(
+          `Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`
+        );
+      }
+      return val;
+    }).join(this.sep);
+    if (ret.length > 64) {
+      throw new MtArgumentError("Resulting callback data is too long.");
+    }
+    return ret;
+  }
+  parse(data, safe = false) {
+    const parts = data.split(this.sep);
+    if (parts[0] !== this.prefix) {
+      if (safe) return null;
+      throw new MtArgumentError(
+        `Invalid data passed: "${data}" (bad prefix, expected ${this.prefix}, got ${parts[0]})`
+      );
+    }
+    if (parts.length !== this._fields.length + 1) {
+      if (safe) return null;
+      throw new MtArgumentError(
+        `Invalid data passed: "${data}" (bad parts count, expected ${this._fields.length}, got ${parts.length - 1})`
+      );
+    }
+    const ret = {};
+    parts.forEach((it, idx) => {
+      if (idx === 0) return;
+      ret[this._fields[idx - 1]] = it;
+    });
+    return ret;
+  }
+  /**
+   * Create a filter for this callback data.
+   *
+   * You can either pass an object with field names as keys and values as strings or regexes,
+   * which will be compiled to a RegExp, or a function that will be called with the parsed data.
+   * Note that the strings will be passed to `RegExp` **directly**, so you may want to escape them.
+   *
+   * When using a function, you can either return a boolean, or an object with field names as keys
+   * and values as strings or regexes. In the latter case, the resulting object will be matched
+   * against the parsed data the same way as if you passed it directly.
+   *
+   * @param params
+   */
+  filter(params = {}) {
+    if (typeof params === "function") {
+      return async (query) => {
+        if (!query.dataStr) return false;
+        const data = this.parse(query.dataStr, true);
+        if (!data) return false;
+        const fnResult = await params(query, data);
+        if (typeof fnResult === "boolean") {
+          query.match = data;
+          return fnResult;
+        }
+        for (const key in fnResult) {
+          const value = data[key];
+          if (value === void 0) return false;
+          let matchers = fnResult[key];
+          if (!Array.isArray(matchers)) matchers = [matchers];
+          for (const matcher of matchers) {
+            if (typeof matcher === "string") {
+              if (value !== matcher) return false;
+            } else if (!matcher.test(value)) {
+              return false;
+            }
+          }
+        }
+        query.match = data;
+        return true;
+      };
+    }
+    const parts = [];
+    this._fields.forEach((field) => {
+      if (!(field in params)) {
+        parts.push(`[^${this.sep}]*?`);
+        return;
+      }
+      const value = params[field];
+      if (Array.isArray(value)) {
+        parts.push(`(${value.map((i) => typeof i === "string" ? i : i.source).join("|")})`);
+      } else {
+        parts.push(typeof value === "string" ? value : value.source);
+      }
+    });
+    const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`);
+    return (query) => {
+      const m = query.dataStr?.match(regex);
+      if (!m) {
+        return false;
+      }
+      query.match = this.parse(m[0]);
+      return true;
+    };
+  }
+}
+export {
+  CallbackDataBuilder
+};

package/callback-data-builder.test.d.cts

@@ -0,0 +1 @@
+export {};

package/context/base.d.cts

@@ -0,0 +1,9 @@
+import { ParsedUpdate } from '@mtcute/core';
+import { TelegramClient } from '@mtcute/core/client.js';
+export type UpdateContext<T> = T & {
+    client: TelegramClient;
+    _name: Extract<ParsedUpdate, {
+        data: T;
+    }>['name'];
+};
+export type UpdateContextDistributed<T> = T extends never ? never : UpdateContext<T>;

package/context/business-message.cjs

@@ -0,0 +1,143 @@
+if (typeof globalThis !== "undefined" && !globalThis._MTCUTE_CJS_DEPRECATION_WARNED) {
+  globalThis._MTCUTE_CJS_DEPRECATION_WARNED = true;
+  console.warn("[mtcute-workspace] CommonJS support is deprecated and will be removed in 0.20.0. Please consider switching to ESM, it's " + (/* @__PURE__ */ new Date()).getFullYear() + " already.");
+  console.warn("[mtcute-workspace] Learn more about switching to ESM: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c");
+}
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const core = require("@mtcute/core");
+class BusinessMessageContext extends core.BusinessMessage {
+  constructor(client, message) {
+    const msg = Array.isArray(message) ? message[message.length - 1] : message;
+    super(msg.update, msg._peers);
+    this.client = client;
+    this.messages = Array.isArray(message) ? message.map((it) => new BusinessMessageContext(client, it)) : [this];
+    this.isMessageGroup = Array.isArray(message);
+  }
+  // this is primarily for proper types in filters, so don't bother much with actual value
+  _name = "new_business_message";
+  /**
+   * List of messages in the message group.
+   *
+   * For other updates, this is a list with a single element (`this`).
+   */
+  messages;
+  /** Whether this update is about a message group */
+  isMessageGroup;
+  /** Get all custom emojis contained in this message (message group), if any */
+  getCustomEmojis() {
+    return this.client.getCustomEmojisFromMessages(this.messages);
+  }
+  /** Send a text message to the same chat (and topic, if applicable) as a given message */
+  answerText(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerText(this, send, params_);
+  }
+  /** Send a media to the same chat (and topic, if applicable) as a given message */
+  answerMedia(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerMedia(this, send, params_);
+  }
+  /** Send a media group to the same chat (and topic, if applicable) as a given message */
+  answerMediaGroup(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerMediaGroup(this, send, params_);
+  }
+  /** Send a text message in reply to this message */
+  replyText(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyText(this, send, params_);
+  }
+  /** Send a media in reply to this message */
+  replyMedia(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyMedia(this, send, params_);
+  }
+  /** Send a media group in reply to this message */
+  replyMediaGroup(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyMediaGroup(this, send, params_);
+  }
+  /** Send a text message in reply to this message */
+  quoteWithText(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithText(this, params);
+  }
+  /** Send a media in reply to this message */
+  quoteWithMedia(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithMedia(this, params);
+  }
+  /** Send a media group in reply to this message */
+  quoteWithMediaGroup(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithMediaGroup(this, params);
+  }
+  /** Delete this message (message group) */
+  delete(params) {
+    return this.client.deleteMessagesById(
+      this.chat.inputPeer,
+      this.messages.map((it) => it.id),
+      params
+    );
+  }
+  /** Pin this message */
+  pin(params) {
+    return this.client.pinMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+  /** Unpin this message */
+  unpin() {
+    return this.client.unpinMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id
+    });
+  }
+  /** Edit this message */
+  edit(params) {
+    return this.client.editMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+  /** Forward this message (message group) */
+  forwardTo(params) {
+    return this.client.forwardMessagesById({
+      fromChatId: this.chat.inputPeer,
+      messages: this.messages.map((it) => it.id),
+      ...params
+    });
+  }
+  /** Send a copy of this message (message group) */
+  copy(params) {
+    if (this.isMessageGroup) {
+      return this.client.sendCopyGroup({
+        messages: this.messages,
+        ...params
+      });
+    }
+    return this.client.sendCopy({
+      message: this,
+      ...params
+    });
+  }
+  /** React to this message */
+  react(params) {
+    return this.client.sendReaction({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+}
+exports.BusinessMessageContext = BusinessMessageContext;

package/context/business-message.d.cts

@@ -0,0 +1,60 @@
+import { Message, OmitInputMessageId, ParametersSkip1, Sticker, BusinessMessage } from '@mtcute/core';
+import { TelegramClient } from '@mtcute/core/client.js';
+import { DeleteMessagesParams, ForwardMessageOptions, SendCopyGroupParams, SendCopyParams } from '@mtcute/core/methods.js';
+import { UpdateContext } from './base.js';
+/**
+ * Context of a business message related update.
+ *
+ * This is a subclass of {@link BusinessMessage}, so all fields
+ * of the message are available.
+ *
+ * For message groups, own fields are related to the last message
+ * in the group. To access all messages, use {@link BusinessMessageContext#messages}.
+ */
+export declare class BusinessMessageContext extends BusinessMessage implements UpdateContext<BusinessMessage> {
+    readonly client: TelegramClient;
+    readonly _name: "new_business_message";
+    /**
+     * List of messages in the message group.
+     *
+     * For other updates, this is a list with a single element (`this`).
+     */
+    readonly messages: BusinessMessageContext[];
+    /** Whether this update is about a message group */
+    readonly isMessageGroup: boolean;
+    constructor(client: TelegramClient, message: BusinessMessage | BusinessMessage[]);
+    /** Get all custom emojis contained in this message (message group), if any */
+    getCustomEmojis(): Promise<Sticker[]>;
+    /** Send a text message to the same chat (and topic, if applicable) as a given message */
+    answerText(...params: ParametersSkip1<TelegramClient['answerText']>): Promise<Message>;
+    /** Send a media to the same chat (and topic, if applicable) as a given message */
+    answerMedia(...params: ParametersSkip1<TelegramClient['answerMedia']>): Promise<Message>;
+    /** Send a media group to the same chat (and topic, if applicable) as a given message */
+    answerMediaGroup(...params: ParametersSkip1<TelegramClient['answerMediaGroup']>): Promise<Message[]>;
+    /** Send a text message in reply to this message */
+    replyText(...params: ParametersSkip1<TelegramClient['replyText']>): Promise<Message>;
+    /** Send a media in reply to this message */
+    replyMedia(...params: ParametersSkip1<TelegramClient['replyMedia']>): Promise<Message>;
+    /** Send a media group in reply to this message */
+    replyMediaGroup(...params: ParametersSkip1<TelegramClient['replyMediaGroup']>): Promise<Message[]>;
+    /** Send a text message in reply to this message */
+    quoteWithText(params: Parameters<TelegramClient['quoteWithText']>[1]): Promise<Message>;
+    /** Send a media in reply to this message */
+    quoteWithMedia(params: Parameters<TelegramClient['quoteWithMedia']>[1]): Promise<Message>;
+    /** Send a media group in reply to this message */
+    quoteWithMediaGroup(params: Parameters<TelegramClient['quoteWithMediaGroup']>[1]): Promise<Message[]>;
+    /** Delete this message (message group) */
+    delete(params?: DeleteMessagesParams): Promise<void>;
+    /** Pin this message */
+    pin(params?: OmitInputMessageId<Parameters<TelegramClient['pinMessage']>[0]>): Promise<Message | null>;
+    /** Unpin this message */
+    unpin(): Promise<void>;
+    /** Edit this message */
+    edit(params: OmitInputMessageId<Parameters<TelegramClient['editMessage']>[0]>): Promise<Message>;
+    /** Forward this message (message group) */
+    forwardTo(params: ForwardMessageOptions): Promise<Message[]>;
+    /** Send a copy of this message (message group) */
+    copy(params: SendCopyParams & SendCopyGroupParams): Promise<Message | Message[]>;
+    /** React to this message */
+    react(params: OmitInputMessageId<Parameters<TelegramClient['sendReaction']>[0]>): Promise<Message | null>;
+}

package/context/business-message.js

@@ -0,0 +1,138 @@
+import { BusinessMessage } from "@mtcute/core";
+class BusinessMessageContext extends BusinessMessage {
+  constructor(client, message) {
+    const msg = Array.isArray(message) ? message[message.length - 1] : message;
+    super(msg.update, msg._peers);
+    this.client = client;
+    this.messages = Array.isArray(message) ? message.map((it) => new BusinessMessageContext(client, it)) : [this];
+    this.isMessageGroup = Array.isArray(message);
+  }
+  // this is primarily for proper types in filters, so don't bother much with actual value
+  _name = "new_business_message";
+  /**
+   * List of messages in the message group.
+   *
+   * For other updates, this is a list with a single element (`this`).
+   */
+  messages;
+  /** Whether this update is about a message group */
+  isMessageGroup;
+  /** Get all custom emojis contained in this message (message group), if any */
+  getCustomEmojis() {
+    return this.client.getCustomEmojisFromMessages(this.messages);
+  }
+  /** Send a text message to the same chat (and topic, if applicable) as a given message */
+  answerText(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerText(this, send, params_);
+  }
+  /** Send a media to the same chat (and topic, if applicable) as a given message */
+  answerMedia(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerMedia(this, send, params_);
+  }
+  /** Send a media group to the same chat (and topic, if applicable) as a given message */
+  answerMediaGroup(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.answerMediaGroup(this, send, params_);
+  }
+  /** Send a text message in reply to this message */
+  replyText(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyText(this, send, params_);
+  }
+  /** Send a media in reply to this message */
+  replyMedia(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyMedia(this, send, params_);
+  }
+  /** Send a media group in reply to this message */
+  replyMediaGroup(...params) {
+    const [send, params_ = {}] = params;
+    params_.businessConnectionId = this.update.connectionId;
+    return this.client.replyMediaGroup(this, send, params_);
+  }
+  /** Send a text message in reply to this message */
+  quoteWithText(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithText(this, params);
+  }
+  /** Send a media in reply to this message */
+  quoteWithMedia(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithMedia(this, params);
+  }
+  /** Send a media group in reply to this message */
+  quoteWithMediaGroup(params) {
+    params.businessConnectionId = this.update.connectionId;
+    return this.client.quoteWithMediaGroup(this, params);
+  }
+  /** Delete this message (message group) */
+  delete(params) {
+    return this.client.deleteMessagesById(
+      this.chat.inputPeer,
+      this.messages.map((it) => it.id),
+      params
+    );
+  }
+  /** Pin this message */
+  pin(params) {
+    return this.client.pinMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+  /** Unpin this message */
+  unpin() {
+    return this.client.unpinMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id
+    });
+  }
+  /** Edit this message */
+  edit(params) {
+    return this.client.editMessage({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+  /** Forward this message (message group) */
+  forwardTo(params) {
+    return this.client.forwardMessagesById({
+      fromChatId: this.chat.inputPeer,
+      messages: this.messages.map((it) => it.id),
+      ...params
+    });
+  }
+  /** Send a copy of this message (message group) */
+  copy(params) {
+    if (this.isMessageGroup) {
+      return this.client.sendCopyGroup({
+        messages: this.messages,
+        ...params
+      });
+    }
+    return this.client.sendCopy({
+      message: this,
+      ...params
+    });
+  }
+  /** React to this message */
+  react(params) {
+    return this.client.sendReaction({
+      chatId: this.chat.inputPeer,
+      message: this.id,
+      ...params
+    });
+  }
+}
+export {
+  BusinessMessageContext
+};