@mtcute/core 0.17.0 → 0.18.0-rc.5

package/highlevel/types/media/audio.cjs

@@ -0,0 +1,46 @@
+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 fileId = require("@mtcute/file-id");
+const memoize = require("../../utils/memoize.cjs");
+const document = require("./document.cjs");
+const inspectable = require("../../utils/inspectable.cjs");
+class Audio extends document.RawDocument {
+  constructor(doc, attr) {
+    super(doc);
+    this.attr = attr;
+  }
+  /** Type of the media (for use in a tagged union) */
+  type = "audio";
+  /** Type of the file for File ID generation */
+  _fileIdType() {
+    return fileId.tdFileId.FileType.Audio;
+  }
+  /**
+   * Duration of the audio in seconds.
+   *
+   * May not be accurate since provided by the sender.
+   */
+  get duration() {
+    return this.attr.duration;
+  }
+  /**
+   * Performer of the audio track.
+   */
+  get performer() {
+    return this.attr.performer ?? null;
+  }
+  /**
+   * Title of the audio track.
+   */
+  get title() {
+    return this.attr.title ?? null;
+  }
+}
+const Audio$1 = /* @__PURE__ */ memoize.memoizeGetters(Audio, ["fileName", "thumbnails", "fileId", "uniqueFileId"]);
+const Audio$2 = /* @__PURE__ */ inspectable.makeInspectable(Audio$1, ["fileSize", "dcId"], ["inputMedia", "inputDocument"]);
+exports.Audio = Audio$2;

package/highlevel/types/media/audio.d.ts

@@ -1,5 +1,5 @@
-import { tdFileId } from '@mtcute/file-id';
 import { tl } from '@mtcute/tl';
+import { tdFileId } from '@mtcute/file-id';
 import { RawDocument } from './document.js';
 /**
  * An audio file

package/highlevel/types/media/audio.js

@@ -0,0 +1,41 @@
+import { tdFileId } from "@mtcute/file-id";
+import { memoizeGetters } from "../../utils/memoize.js";
+import { RawDocument } from "./document.js";
+import { makeInspectable } from "../../utils/inspectable.js";
+class Audio extends RawDocument {
+  constructor(doc, attr) {
+    super(doc);
+    this.attr = attr;
+  }
+  /** Type of the media (for use in a tagged union) */
+  type = "audio";
+  /** Type of the file for File ID generation */
+  _fileIdType() {
+    return tdFileId.FileType.Audio;
+  }
+  /**
+   * Duration of the audio in seconds.
+   *
+   * May not be accurate since provided by the sender.
+   */
+  get duration() {
+    return this.attr.duration;
+  }
+  /**
+   * Performer of the audio track.
+   */
+  get performer() {
+    return this.attr.performer ?? null;
+  }
+  /**
+   * Title of the audio track.
+   */
+  get title() {
+    return this.attr.title ?? null;
+  }
+}
+const Audio$1 = /* @__PURE__ */ memoizeGetters(Audio, ["fileName", "thumbnails", "fileId", "uniqueFileId"]);
+const Audio$2 = /* @__PURE__ */ makeInspectable(Audio$1, ["fileSize", "dcId"], ["inputMedia", "inputDocument"]);
+export {
+  Audio$2 as Audio
+};

package/highlevel/types/media/contact.cjs

@@ -0,0 +1,51 @@
+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 inspectable = require("../../utils/inspectable.cjs");
+class Contact {
+  constructor(obj) {
+    this.obj = obj;
+  }
+  type = "contact";
+  /**
+   * Contact's phone number
+   */
+  get phoneNumber() {
+    return this.obj.phoneNumber;
+  }
+  /**
+   * Contact's first name
+   */
+  get firstName() {
+    return this.obj.firstName;
+  }
+  /**
+   * Contact's last name
+   */
+  get lastName() {
+    return this.obj.lastName;
+  }
+  /**
+   * Contact's user ID in Telegram or `0` if not available
+   */
+  get userId() {
+    return this.obj.userId;
+  }
+  /**
+   * Input media TL object generated from this object,
+   * to be used inside {@link InputMediaLike} and
+   * {@link TelegramClient.sendMedia}
+   */
+  get inputMedia() {
+    return {
+      ...this.obj,
+      _: "inputMediaContact"
+    };
+  }
+}
+const Contact$1 = /* @__PURE__ */ inspectable.makeInspectable(Contact, void 0, ["inputMedia"]);
+exports.Contact = Contact$1;

package/highlevel/types/media/contact.js

@@ -0,0 +1,46 @@
+import { makeInspectable } from "../../utils/inspectable.js";
+class Contact {
+  constructor(obj) {
+    this.obj = obj;
+  }
+  type = "contact";
+  /**
+   * Contact's phone number
+   */
+  get phoneNumber() {
+    return this.obj.phoneNumber;
+  }
+  /**
+   * Contact's first name
+   */
+  get firstName() {
+    return this.obj.firstName;
+  }
+  /**
+   * Contact's last name
+   */
+  get lastName() {
+    return this.obj.lastName;
+  }
+  /**
+   * Contact's user ID in Telegram or `0` if not available
+   */
+  get userId() {
+    return this.obj.userId;
+  }
+  /**
+   * Input media TL object generated from this object,
+   * to be used inside {@link InputMediaLike} and
+   * {@link TelegramClient.sendMedia}
+   */
+  get inputMedia() {
+    return {
+      ...this.obj,
+      _: "inputMediaContact"
+    };
+  }
+}
+const Contact$1 = /* @__PURE__ */ makeInspectable(Contact, void 0, ["inputMedia"]);
+export {
+  Contact$1 as Contact
+};

package/highlevel/types/media/dice.cjs

@@ -0,0 +1,171 @@
+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 inspectable = require("../../utils/inspectable.cjs");
+class Dice {
+  constructor(obj) {
+    this.obj = obj;
+  }
+  type = "dice";
+  /**
+   * A simple 6-sided dice.
+   *
+   * {@link value} represents its value (1-6)
+   */
+  static TYPE_DICE = "🎲";
+  /**
+   * A dart. Telegram dart has 4 rings and middle.
+   *
+   * {@link value} represents the position of the dart:
+   * ![Dart position graph](https://i.imgur.com/iPBm7HG.png)
+   */
+  static TYPE_DART = "🎯";
+  /**
+   * A basketball thrown into a hoop.
+   *
+   * {@link value} represents the motion of the ball:
+   *  - 1: simple miss (ball hits right part, bounces to the left)
+   *  - 2: first hit the ring, then miss
+   *  - 3: ball gets stuck between the ring and the base
+   *  - 4: first hit the ring, then score
+   *  - 5: direct score
+   */
+  static TYPE_BASKETBALL = "🏀";
+  /**
+   * A football thrown to the gate.
+   *
+   * {@link value} represents the motion of the ball:
+   *  - 1: flies above the top barbell
+   *  - 2: hits right barbell, then miss
+   *  - 3: direct score in the middle
+   *  - 4: hits left barbell, then score, then hits right barbell
+   *  - 5: score in the top-right corner
+   */
+  static TYPE_FOOTBALL = "⚽️";
+  /**
+   * A bowling ball thrown to pins.
+   *
+   * Assuming the following identifiers for the pins:
+   * ```
+   * 4 5 6
+   *  2 3
+   *   1
+   * ```
+   *
+   * {@link value} represents the motion of the ball and pins:
+   *  - 1: the ball touched 6th pin, none are down
+   *  - 2: the ball hit 4th pin, only 4th pin is down.
+   *  - 3: the ball hit 1st pin, pins 1, 2, 5 are down, leaving pins 3, 4, 6
+   *  - 4: the ball hit 1st pin on the right side, all the pins except 2nd and 6th are down
+   *  - 5: the ball hit 3rd pin and all the pins except 2nd are down.
+   *  - 6: the ball hit 1st pin and all pins are down
+   */
+  static TYPE_BOWLING = "🎳";
+  /**
+   * A slot machine.
+   *
+   * {@link value} represents the result of the machine.
+   * Value itself is an integer in range `[1, 64]`,
+   * and is composed out of several parts.
+   *
+   * > **Note**: The following information is based on the TDesktop
+   * > implementation. These are the relevant files:
+   * >  - [`chat_helpers/stickers_dice_pack.cpp`](https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/chat_helpers/stickers_dice_pack.cpp)
+   * >  - [`history/view/media/history_view_slot_machine.cpp`](https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/history/view/media/history_view_slot_machine.cpp)
+   *
+   * Unlike other animated dices, this does not have
+   * all the possible combinations in the sticker set.
+   * Instead, `value` is a specially encoded integer that contains
+   * the information about the indexes.
+   *
+   * There are some base parts of the animations:
+   *  - 0th sticker is the base background of the machine
+   *  - 1st sticker is the background of the machine for the "winning" state (i.e. `777`)
+   *  - 2nd sticker is the frame of the machine, including the handle
+   *  - 8th sticker is the "idle" state for the left slot
+   *  - 14th sticker is the "idle" state for the middle slot
+   *  - 20th sticker is the "idle" state for the right slot
+   *
+   * The machine result is encoded as 3 concatenated two-bit integers,
+   * and the resulting integer is incremented by one.
+   *
+   * So, to decode the value to its parts, you can use this code:
+   * ```typescript
+   * const computePartValue = (val: number, idx: number) => ((val - 1) >> (idx * 2)) & 0x03; // 0..3
+   * const parts = [
+   *   computePartValue(msg.media.value, 0),
+   *   computePartValue(msg.media.value, 1),
+   *   computePartValue(msg.media.value, 2),
+   * ]
+   * ```
+   *
+   * Each part of the value corresponds to a particular slot (i.e. part 0 is left slot,
+   * part 1 is middle, part 2 is right). The slot values are as follows:
+   *  - 0: BAR (displayed as a *BAR* sign on a black background)
+   *  - 1: BERRIES (displayed as berries, similar to emoji 🍇)
+   *  - 2: LEMON (displayed as a lemon, similar to emoji 🍋)
+   *  - 3: SEVEN (displayed as a red digit 7)
+   *
+   * Therefore, the winning value (i.e. `777`) is represented as `(3 << 4 | 3 << 2 | 3 << 0) + 1 = 64`
+   *
+   * To determine the needed animation parts, you'll need to apply some shifts.
+   * These are the offsets for the individual symbols:
+   *  - WIN_SEVEN: 0
+   *  - SEVEN: 1
+   *  - BAR: 2
+   *  - BERRIES: 3
+   *  - LEMON: 4
+   *
+   * And these are the shifts for each slot:
+   *  - LEFT: 3
+   *  - MIDDLE: 9
+   *  - RIGHT: 15
+   *
+   * > WIN_SEVEN is the same as SEVEN, but only used if the machine result is `777` (i.e. `value = 64`),
+   * > as it contains additional "blinking" animation.
+   *
+   * The sticker index is computed as follows: `SHIFTS[SLOT] + OFFSETS[SYM]`.
+   * For example, berries for the middle slot would be: `SHIFTS[MIDDLE] + OFFSETS[BERRIES] = 9 + 3 = 12`
+   *
+   * Currently, this sticker set is used for the machine: [SlotMachineAnimated](https://t.me/addstickers/SlotMachineAnimated)
+   */
+  static TYPE_SLOTS = "🎰";
+  /**
+   * An emoji which was originally sent.
+   *
+   * See static members of {@link Dice} for a list
+   * of possible values
+   */
+  get emoji() {
+    return this.obj.emoticon;
+  }
+  /**
+   * Emoji's interactive value.
+   *
+   * See what this value represents in the corresponding
+   * type's documentation (in {@link Dice} static fields)
+   */
+  get value() {
+    return this.obj.value;
+  }
+  /**
+   * Input media TL object generated from this object,
+   * to be used inside {@link InputMediaLike} and
+   * {@link TelegramClient.sendMedia}
+   *
+   * Note that when you use this media, a new `value`
+   * will be generated!
+   */
+  get inputMedia() {
+    return {
+      _: "inputMediaDice",
+      emoticon: this.obj.emoticon
+    };
+  }
+}
+const Dice$1 = /* @__PURE__ */ inspectable.makeInspectable(Dice, void 0, ["inputMedia"]);
+exports.Dice = Dice$1;

package/highlevel/types/media/dice.js

@@ -0,0 +1,166 @@
+import { makeInspectable } from "../../utils/inspectable.js";
+class Dice {
+  constructor(obj) {
+    this.obj = obj;
+  }
+  type = "dice";
+  /**
+   * A simple 6-sided dice.
+   *
+   * {@link value} represents its value (1-6)
+   */
+  static TYPE_DICE = "🎲";
+  /**
+   * A dart. Telegram dart has 4 rings and middle.
+   *
+   * {@link value} represents the position of the dart:
+   * ![Dart position graph](https://i.imgur.com/iPBm7HG.png)
+   */
+  static TYPE_DART = "🎯";
+  /**
+   * A basketball thrown into a hoop.
+   *
+   * {@link value} represents the motion of the ball:
+   *  - 1: simple miss (ball hits right part, bounces to the left)
+   *  - 2: first hit the ring, then miss
+   *  - 3: ball gets stuck between the ring and the base
+   *  - 4: first hit the ring, then score
+   *  - 5: direct score
+   */
+  static TYPE_BASKETBALL = "🏀";
+  /**
+   * A football thrown to the gate.
+   *
+   * {@link value} represents the motion of the ball:
+   *  - 1: flies above the top barbell
+   *  - 2: hits right barbell, then miss
+   *  - 3: direct score in the middle
+   *  - 4: hits left barbell, then score, then hits right barbell
+   *  - 5: score in the top-right corner
+   */
+  static TYPE_FOOTBALL = "⚽️";
+  /**
+   * A bowling ball thrown to pins.
+   *
+   * Assuming the following identifiers for the pins:
+   * ```
+   * 4 5 6
+   *  2 3
+   *   1
+   * ```
+   *
+   * {@link value} represents the motion of the ball and pins:
+   *  - 1: the ball touched 6th pin, none are down
+   *  - 2: the ball hit 4th pin, only 4th pin is down.
+   *  - 3: the ball hit 1st pin, pins 1, 2, 5 are down, leaving pins 3, 4, 6
+   *  - 4: the ball hit 1st pin on the right side, all the pins except 2nd and 6th are down
+   *  - 5: the ball hit 3rd pin and all the pins except 2nd are down.
+   *  - 6: the ball hit 1st pin and all pins are down
+   */
+  static TYPE_BOWLING = "🎳";
+  /**
+   * A slot machine.
+   *
+   * {@link value} represents the result of the machine.
+   * Value itself is an integer in range `[1, 64]`,
+   * and is composed out of several parts.
+   *
+   * > **Note**: The following information is based on the TDesktop
+   * > implementation. These are the relevant files:
+   * >  - [`chat_helpers/stickers_dice_pack.cpp`](https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/chat_helpers/stickers_dice_pack.cpp)
+   * >  - [`history/view/media/history_view_slot_machine.cpp`](https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/history/view/media/history_view_slot_machine.cpp)
+   *
+   * Unlike other animated dices, this does not have
+   * all the possible combinations in the sticker set.
+   * Instead, `value` is a specially encoded integer that contains
+   * the information about the indexes.
+   *
+   * There are some base parts of the animations:
+   *  - 0th sticker is the base background of the machine
+   *  - 1st sticker is the background of the machine for the "winning" state (i.e. `777`)
+   *  - 2nd sticker is the frame of the machine, including the handle
+   *  - 8th sticker is the "idle" state for the left slot
+   *  - 14th sticker is the "idle" state for the middle slot
+   *  - 20th sticker is the "idle" state for the right slot
+   *
+   * The machine result is encoded as 3 concatenated two-bit integers,
+   * and the resulting integer is incremented by one.
+   *
+   * So, to decode the value to its parts, you can use this code:
+   * ```typescript
+   * const computePartValue = (val: number, idx: number) => ((val - 1) >> (idx * 2)) & 0x03; // 0..3
+   * const parts = [
+   *   computePartValue(msg.media.value, 0),
+   *   computePartValue(msg.media.value, 1),
+   *   computePartValue(msg.media.value, 2),
+   * ]
+   * ```
+   *
+   * Each part of the value corresponds to a particular slot (i.e. part 0 is left slot,
+   * part 1 is middle, part 2 is right). The slot values are as follows:
+   *  - 0: BAR (displayed as a *BAR* sign on a black background)
+   *  - 1: BERRIES (displayed as berries, similar to emoji 🍇)
+   *  - 2: LEMON (displayed as a lemon, similar to emoji 🍋)
+   *  - 3: SEVEN (displayed as a red digit 7)
+   *
+   * Therefore, the winning value (i.e. `777`) is represented as `(3 << 4 | 3 << 2 | 3 << 0) + 1 = 64`
+   *
+   * To determine the needed animation parts, you'll need to apply some shifts.
+   * These are the offsets for the individual symbols:
+   *  - WIN_SEVEN: 0
+   *  - SEVEN: 1
+   *  - BAR: 2
+   *  - BERRIES: 3
+   *  - LEMON: 4
+   *
+   * And these are the shifts for each slot:
+   *  - LEFT: 3
+   *  - MIDDLE: 9
+   *  - RIGHT: 15
+   *
+   * > WIN_SEVEN is the same as SEVEN, but only used if the machine result is `777` (i.e. `value = 64`),
+   * > as it contains additional "blinking" animation.
+   *
+   * The sticker index is computed as follows: `SHIFTS[SLOT] + OFFSETS[SYM]`.
+   * For example, berries for the middle slot would be: `SHIFTS[MIDDLE] + OFFSETS[BERRIES] = 9 + 3 = 12`
+   *
+   * Currently, this sticker set is used for the machine: [SlotMachineAnimated](https://t.me/addstickers/SlotMachineAnimated)
+   */
+  static TYPE_SLOTS = "🎰";
+  /**
+   * An emoji which was originally sent.
+   *
+   * See static members of {@link Dice} for a list
+   * of possible values
+   */
+  get emoji() {
+    return this.obj.emoticon;
+  }
+  /**
+   * Emoji's interactive value.
+   *
+   * See what this value represents in the corresponding
+   * type's documentation (in {@link Dice} static fields)
+   */
+  get value() {
+    return this.obj.value;
+  }
+  /**
+   * Input media TL object generated from this object,
+   * to be used inside {@link InputMediaLike} and
+   * {@link TelegramClient.sendMedia}
+   *
+   * Note that when you use this media, a new `value`
+   * will be generated!
+   */
+  get inputMedia() {
+    return {
+      _: "inputMediaDice",
+      emoticon: this.obj.emoticon
+    };
+  }
+}
+const Dice$1 = /* @__PURE__ */ makeInspectable(Dice, void 0, ["inputMedia"]);
+export {
+  Dice$1 as Dice
+};

package/highlevel/types/media/document-utils.cjs

@@ -0,0 +1,45 @@
+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 audio = require("./audio.cjs");
+const document = require("./document.cjs");
+const sticker = require("./sticker.cjs");
+const video = require("./video.cjs");
+const voice = require("./voice.cjs");
+function parseSticker(doc) {
+  const stickerAttr = doc.attributes.find(
+    (a) => a._ === "documentAttributeSticker" || a._ === "documentAttributeCustomEmoji"
+  );
+  if (stickerAttr) {
+    const sz = doc.attributes.find(
+      (it) => it._ === "documentAttributeImageSize" || it._ === "documentAttributeVideo"
+    );
+    return new sticker.Sticker(doc, stickerAttr, sz);
+  }
+}
+function parseDocument(doc, media) {
+  const sticker2 = parseSticker(doc);
+  if (sticker2) return sticker2;
+  for (const attr of doc.attributes) {
+    switch (attr._) {
+      case "documentAttributeAudio":
+        if (attr.voice) {
+          return new voice.Voice(doc, attr);
+        }
+        return new audio.Audio(doc, attr);
+      case "documentAttributeVideo":
+        return new video.Video(doc, attr, media);
+      case "documentAttributeImageSize":
+        if (doc.mimeType === "image/gif") {
+          return new video.Video(doc, attr, media);
+        }
+    }
+  }
+  return new document.Document(doc);
+}
+exports.parseDocument = parseDocument;
+exports.parseSticker = parseSticker;

package/highlevel/types/media/document-utils.js

@@ -0,0 +1,40 @@
+import { Audio as Audio$2 } from "./audio.js";
+import { Document as Document$2 } from "./document.js";
+import { Sticker as Sticker$2 } from "./sticker.js";
+import { Video as Video$2 } from "./video.js";
+import { Voice as Voice$2 } from "./voice.js";
+function parseSticker(doc) {
+  const stickerAttr = doc.attributes.find(
+    (a) => a._ === "documentAttributeSticker" || a._ === "documentAttributeCustomEmoji"
+  );
+  if (stickerAttr) {
+    const sz = doc.attributes.find(
+      (it) => it._ === "documentAttributeImageSize" || it._ === "documentAttributeVideo"
+    );
+    return new Sticker$2(doc, stickerAttr, sz);
+  }
+}
+function parseDocument(doc, media) {
+  const sticker = parseSticker(doc);
+  if (sticker) return sticker;
+  for (const attr of doc.attributes) {
+    switch (attr._) {
+      case "documentAttributeAudio":
+        if (attr.voice) {
+          return new Voice$2(doc, attr);
+        }
+        return new Audio$2(doc, attr);
+      case "documentAttributeVideo":
+        return new Video$2(doc, attr, media);
+      case "documentAttributeImageSize":
+        if (doc.mimeType === "image/gif") {
+          return new Video$2(doc, attr, media);
+        }
+    }
+  }
+  return new Document$2(doc);
+}
+export {
+  parseDocument,
+  parseSticker
+};