@mtcute/core 0.5.0 → 0.7.0

package/cjs/highlevel/types/media/audio.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Audio = void 0;
+const file_id_1 = require("@mtcute/file-id");
+const index_js_1 = require("../../utils/index.js");
+const memoize_js_1 = require("../../utils/memoize.js");
+const document_js_1 = require("./document.js");
+/**
+ * An audio file
+ */
+class Audio extends document_js_1.RawDocument {
+    /** Type of the file for File ID generation */
+    _fileIdType() {
+        return file_id_1.tdFileId.FileType.Audio;
+    }
+    constructor(doc, 
+    /** TL object describing the audio */
+    attr) {
+        super(doc);
+        this.attr = attr;
+        /** Type of the media (for use in a tagged union) */
+        this.type = '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;
+    }
+}
+exports.Audio = Audio;
+(0, memoize_js_1.memoizeGetters)(Audio, ['fileName', 'thumbnails', 'fileId', 'uniqueFileId']);
+(0, index_js_1.makeInspectable)(Audio, ['fileSize', 'dcId'], ['inputMedia', 'inputDocument']);
+//# sourceMappingURL=audio.js.map

package/cjs/highlevel/types/media/audio.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio.js","sourceRoot":"","sources":["../../../../../src/highlevel/types/media/audio.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAG1C,mDAAsD;AACtD,uDAAuD;AACvD,+CAA2C;AAE3C;;GAEG;AACH,MAAa,KAAM,SAAQ,yBAAW;IAIlC,8CAA8C;IACpC,WAAW;QACjB,OAAO,kBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAA;IAClC,CAAC;IAED,YACI,GAAmB;IACnB,qCAAqC;IAC5B,IAAkC;QAE3C,KAAK,CAAC,GAAG,CAAC,CAAA;QAFD,SAAI,GAAJ,IAAI,CAA8B;QAX/C,oDAAoD;QAC3C,SAAI,GAAG,OAAgB,CAAA;IAahC,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAA;IACtC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAA;IAClC,CAAC;CACJ;AAvCD,sBAuCC;AAED,IAAA,2BAAc,EAAC,KAAK,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAA;AAC3E,IAAA,0BAAe,EAAC,KAAK,EAAE,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAA","sourcesContent":["import { tdFileId } from '@mtcute/file-id'\nimport { tl } from '@mtcute/tl'\n\nimport { makeInspectable } from '../../utils/index.js'\nimport { memoizeGetters } from '../../utils/memoize.js'\nimport { RawDocument } from './document.js'\n\n/**\n * An audio file\n */\nexport class Audio extends RawDocument {\n    /** Type of the media (for use in a tagged union) */\n    readonly type = 'audio' as const\n\n    /** Type of the file for File ID generation */\n    protected _fileIdType(): tdFileId.FileType {\n        return tdFileId.FileType.Audio\n    }\n\n    constructor(\n        doc: tl.RawDocument,\n        /** TL object describing the audio */\n        readonly attr: tl.RawDocumentAttributeAudio,\n    ) {\n        super(doc)\n    }\n\n    /**\n     * Duration of the audio in seconds.\n     *\n     * May not be accurate since provided by the sender.\n     */\n    get duration(): number {\n        return this.attr.duration\n    }\n\n    /**\n     * Performer of the audio track.\n     */\n    get performer(): string | null {\n        return this.attr.performer ?? null\n    }\n\n    /**\n     * Title of the audio track.\n     */\n    get title(): string | null {\n        return this.attr.title ?? null\n    }\n}\n\nmemoizeGetters(Audio, ['fileName', 'thumbnails', 'fileId', 'uniqueFileId'])\nmakeInspectable(Audio, ['fileSize', 'dcId'], ['inputMedia', 'inputDocument'])\n"]}

package/cjs/highlevel/types/media/contact.d.ts

@@ -0,0 +1,31 @@
+import { tl } from '@mtcute/tl';
+/**
+ * A phone contact
+ */
+export declare class Contact {
+    readonly obj: tl.RawMessageMediaContact;
+    readonly type: "contact";
+    constructor(obj: tl.RawMessageMediaContact);
+    /**
+     * Contact's phone number
+     */
+    get phoneNumber(): string;
+    /**
+     * Contact's first name
+     */
+    get firstName(): string;
+    /**
+     * Contact's last name
+     */
+    get lastName(): string;
+    /**
+     * Contact's user ID in Telegram or `0` if not available
+     */
+    get userId(): number;
+    /**
+     * Input media TL object generated from this object,
+     * to be used inside {@link InputMediaLike} and
+     * {@link TelegramClient.sendMedia}
+     */
+    get inputMedia(): tl.TypeInputMedia;
+}

package/cjs/highlevel/types/media/contact.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contact = void 0;
+const index_js_1 = require("../../utils/index.js");
+/**
+ * A phone contact
+ */
+class Contact {
+    constructor(obj) {
+        this.obj = obj;
+        this.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',
+        };
+    }
+}
+exports.Contact = Contact;
+(0, index_js_1.makeInspectable)(Contact, undefined, ['inputMedia']);
+//# sourceMappingURL=contact.js.map

package/cjs/highlevel/types/media/contact.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.js","sourceRoot":"","sources":["../../../../../src/highlevel/types/media/contact.ts"],"names":[],"mappings":";;;AAEA,mDAAsD;AAEtD;;GAEG;AACH,MAAa,OAAO;IAGhB,YAAqB,GAA8B;QAA9B,QAAG,GAAH,GAAG,CAA2B;QAF1C,SAAI,GAAG,SAAkB,CAAA;IAEoB,CAAC;IAEvD;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAA;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAA;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;QACV,OAAO;YACH,GAAG,IAAI,CAAC,GAAG;YACX,CAAC,EAAE,mBAAmB;SACzB,CAAA;IACL,CAAC;CACJ;AA5CD,0BA4CC;AAED,IAAA,0BAAe,EAAC,OAAO,EAAE,SAAS,EAAE,CAAC,YAAY,CAAC,CAAC,CAAA","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { makeInspectable } from '../../utils/index.js'\n\n/**\n * A phone contact\n */\nexport class Contact {\n    readonly type = 'contact' as const\n\n    constructor(readonly obj: tl.RawMessageMediaContact) {}\n\n    /**\n     * Contact's phone number\n     */\n    get phoneNumber(): string {\n        return this.obj.phoneNumber\n    }\n\n    /**\n     * Contact's first name\n     */\n    get firstName(): string {\n        return this.obj.firstName\n    }\n\n    /**\n     * Contact's last name\n     */\n    get lastName(): string {\n        return this.obj.lastName\n    }\n\n    /**\n     * Contact's user ID in Telegram or `0` if not available\n     */\n    get userId(): number {\n        return this.obj.userId\n    }\n\n    /**\n     * Input media TL object generated from this object,\n     * to be used inside {@link InputMediaLike} and\n     * {@link TelegramClient.sendMedia}\n     */\n    get inputMedia(): tl.TypeInputMedia {\n        return {\n            ...this.obj,\n            _: 'inputMediaContact',\n        }\n    }\n}\n\nmakeInspectable(Contact, undefined, ['inputMedia'])\n"]}

package/cjs/highlevel/types/media/dice.d.ts

@@ -0,0 +1,155 @@
+import { tl } from '@mtcute/tl';
+/**
+ * A dice or another interactive random emoji.
+ */
+export declare class Dice {
+    readonly obj: tl.RawMessageMediaDice;
+    readonly type: "dice";
+    /**
+     * A simple 6-sided dice.
+     *
+     * {@link value} represents its value (1-6)
+     */
+    static readonly TYPE_DICE = "\uD83C\uDFB2";
+    /**
+     * 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 readonly TYPE_DART = "\uD83C\uDFAF";
+    /**
+     * 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 readonly TYPE_BASKETBALL = "\uD83C\uDFC0";
+    /**
+     * 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 readonly TYPE_FOOTBALL = "\u26BD\uFE0F";
+    /**
+     * 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 readonly TYPE_BOWLING = "\uD83C\uDFB3";
+    /**
+     * 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 readonly TYPE_SLOTS = "\uD83C\uDFB0";
+    constructor(obj: tl.RawMessageMediaDice);
+    /**
+     * An emoji which was originally sent.
+     *
+     * See static members of {@link Dice} for a list
+     * of possible values
+     */
+    get emoji(): string;
+    /**
+     * Emoji's interactive value.
+     *
+     * See what this value represents in the corresponding
+     * type's documentation (in {@link Dice} static fields)
+     */
+    get value(): number;
+    /**
+     * 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(): tl.TypeInputMedia;
+}

package/cjs/highlevel/types/media/dice.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dice = void 0;
+const index_js_1 = require("../../utils/index.js");
+/**
+ * A dice or another interactive random emoji.
+ */
+class Dice {
+    constructor(obj) {
+        this.obj = obj;
+        this.type = 'dice';
+    }
+    /**
+     * 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,
+        };
+    }
+}
+exports.Dice = Dice;
+/**
+ * A simple 6-sided dice.
+ *
+ * {@link value} represents its value (1-6)
+ */
+Dice.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)
+ */
+Dice.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
+ */
+Dice.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
+ */
+Dice.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
+ */
+Dice.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)
+ */
+Dice.TYPE_SLOTS = '🎰';
+(0, index_js_1.makeInspectable)(Dice, undefined, ['inputMedia']);
+//# sourceMappingURL=dice.js.map

package/cjs/highlevel/types/media/dice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dice.js","sourceRoot":"","sources":["../../../../../src/highlevel/types/media/dice.ts"],"names":[],"mappings":";;;AAEA,mDAAsD;AAEtD;;GAEG;AACH,MAAa,IAAI;IAoIb,YAAqB,GAA2B;QAA3B,QAAG,GAAH,GAAG,CAAwB;QAnIvC,SAAI,GAAG,MAAe,CAAA;IAmIoB,CAAC;IAEpD;;;;;OAKG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IACzB,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,UAAU;QACV,OAAO;YACH,CAAC,EAAE,gBAAgB;YACnB,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ;SAC9B,CAAA;IACL,CAAC;;AAvKL,oBAwKC;AArKG;;;;GAIG;AACa,cAAS,GAAG,IAAI,AAAP,CAAO;AAEhC;;;;;GAKG;AACa,cAAS,GAAG,IAAI,AAAP,CAAO;AAEhC;;;;;;;;;GASG;AACa,oBAAe,GAAG,IAAI,AAAP,CAAO;AAEtC;;;;;;;;;GASG;AACa,kBAAa,GAAG,IAAI,AAAP,CAAO;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AACa,iBAAY,GAAG,IAAI,AAAP,CAAO;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACa,eAAU,GAAG,IAAI,AAAP,CAAO;AAwCrC,IAAA,0BAAe,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,YAAY,CAAC,CAAC,CAAA","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { makeInspectable } from '../../utils/index.js'\n\n/**\n * A dice or another interactive random emoji.\n */\nexport class Dice {\n    readonly type = 'dice' as const\n\n    /**\n     * A simple 6-sided dice.\n     *\n     * {@link value} represents its value (1-6)\n     */\n    static readonly TYPE_DICE = '🎲'\n\n    /**\n     * A dart. Telegram dart has 4 rings and middle.\n     *\n     * {@link value} represents the position of the dart:\n     * ![Dart position graph](https://i.imgur.com/iPBm7HG.png)\n     */\n    static readonly TYPE_DART = '🎯'\n\n    /**\n     * A basketball thrown into a hoop.\n     *\n     * {@link value} represents the motion of the ball:\n     *  - 1: simple miss (ball hits right part, bounces to the left)\n     *  - 2: first hit the ring, then miss\n     *  - 3: ball gets stuck between the ring and the base\n     *  - 4: first hit the ring, then score\n     *  - 5: direct score\n     */\n    static readonly TYPE_BASKETBALL = '🏀'\n\n    /**\n     * A football thrown to the gate.\n     *\n     * {@link value} represents the motion of the ball:\n     *  - 1: flies above the top barbell\n     *  - 2: hits right barbell, then miss\n     *  - 3: direct score in the middle\n     *  - 4: hits left barbell, then score, then hits right barbell\n     *  - 5: score in the top-right corner\n     */\n    static readonly TYPE_FOOTBALL = '⚽️'\n\n    /**\n     * A bowling ball thrown to pins.\n     *\n     * Assuming the following identifiers for the pins:\n     * ```\n     * 4 5 6\n     *  2 3\n     *   1\n     * ```\n     *\n     * {@link value} represents the motion of the ball and pins:\n     *  - 1: the ball touched 6th pin, none are down\n     *  - 2: the ball hit 4th pin, only 4th pin is down.\n     *  - 3: the ball hit 1st pin, pins 1, 2, 5 are down, leaving pins 3, 4, 6\n     *  - 4: the ball hit 1st pin on the right side, all the pins except 2nd and 6th are down\n     *  - 5: the ball hit 3rd pin and all the pins except 2nd are down.\n     *  - 6: the ball hit 1st pin and all pins are down\n     */\n    static readonly TYPE_BOWLING = '🎳'\n\n    /**\n     * A slot machine.\n     *\n     * {@link value} represents the result of the machine.\n     * Value itself is an integer in range `[1, 64]`,\n     * and is composed out of several parts.\n     *\n     * > **Note**: The following information is based on the TDesktop\n     * > implementation. These are the relevant files:\n     * >  - [`chat_helpers/stickers_dice_pack.cpp`](https://github.com/telegramdesktop/tdesktop/blob/dev/Telegram/SourceFiles/chat_helpers/stickers_dice_pack.cpp)\n     * >  - [`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)\n     *\n     * Unlike other animated dices, this does not have\n     * all the possible combinations in the sticker set.\n     * Instead, `value` is a specially encoded integer that contains\n     * the information about the indexes.\n     *\n     * There are some base parts of the animations:\n     *  - 0th sticker is the base background of the machine\n     *  - 1st sticker is the background of the machine for the \"winning\" state (i.e. `777`)\n     *  - 2nd sticker is the frame of the machine, including the handle\n     *  - 8th sticker is the \"idle\" state for the left slot\n     *  - 14th sticker is the \"idle\" state for the middle slot\n     *  - 20th sticker is the \"idle\" state for the right slot\n     *\n     * The machine result is encoded as 3 concatenated two-bit integers,\n     * and the resulting integer is incremented by one.\n     *\n     * So, to decode the value to its parts, you can use this code:\n     * ```typescript\n     * const computePartValue = (val: number, idx: number) => ((val - 1) >> (idx * 2)) & 0x03; // 0..3\n     * const parts = [\n     *   computePartValue(msg.media.value, 0),\n     *   computePartValue(msg.media.value, 1),\n     *   computePartValue(msg.media.value, 2),\n     * ]\n     * ```\n     *\n     * Each part of the value corresponds to a particular slot (i.e. part 0 is left slot,\n     * part 1 is middle, part 2 is right). The slot values are as follows:\n     *  - 0: BAR (displayed as a *BAR* sign on a black background)\n     *  - 1: BERRIES (displayed as berries, similar to emoji 🍇)\n     *  - 2: LEMON (displayed as a lemon, similar to emoji 🍋)\n     *  - 3: SEVEN (displayed as a red digit 7)\n     *\n     * Therefore, the winning value (i.e. `777`) is represented as `(3 << 4 | 3 << 2 | 3 << 0) + 1 = 64`\n     *\n     * To determine the needed animation parts, you'll need to apply some shifts.\n     * These are the offsets for the individual symbols:\n     *  - WIN_SEVEN: 0\n     *  - SEVEN: 1\n     *  - BAR: 2\n     *  - BERRIES: 3\n     *  - LEMON: 4\n     *\n     * And these are the shifts for each slot:\n     *  - LEFT: 3\n     *  - MIDDLE: 9\n     *  - RIGHT: 15\n     *\n     * > WIN_SEVEN is the same as SEVEN, but only used if the machine result is `777` (i.e. `value = 64`),\n     * > as it contains additional \"blinking\" animation.\n     *\n     * The sticker index is computed as follows: `SHIFTS[SLOT] + OFFSETS[SYM]`.\n     * For example, berries for the middle slot would be: `SHIFTS[MIDDLE] + OFFSETS[BERRIES] = 9 + 3 = 12`\n     *\n     * Currently, this sticker set is used for the machine: [SlotMachineAnimated](https://t.me/addstickers/SlotMachineAnimated)\n     */\n    static readonly TYPE_SLOTS = '🎰'\n\n    constructor(readonly obj: tl.RawMessageMediaDice) {}\n\n    /**\n     * An emoji which was originally sent.\n     *\n     * See static members of {@link Dice} for a list\n     * of possible values\n     */\n    get emoji(): string {\n        return this.obj.emoticon\n    }\n\n    /**\n     * Emoji's interactive value.\n     *\n     * See what this value represents in the corresponding\n     * type's documentation (in {@link Dice} static fields)\n     */\n    get value(): number {\n        return this.obj.value\n    }\n\n    /**\n     * Input media TL object generated from this object,\n     * to be used inside {@link InputMediaLike} and\n     * {@link TelegramClient.sendMedia}\n     *\n     * Note that when you use this media, a new `value`\n     * will be generated!\n     */\n    get inputMedia(): tl.TypeInputMedia {\n        return {\n            _: 'inputMediaDice',\n            emoticon: this.obj.emoticon,\n        }\n    }\n}\n\nmakeInspectable(Dice, undefined, ['inputMedia'])\n"]}

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

@@ -0,0 +1,6 @@
+import { Audio } from './audio.js';
+import { Document } from './document.js';
+import { Sticker } from './sticker.js';
+import { Video } from './video.js';
+import { Voice } from './voice.js';
+export type ParsedDocument = Sticker | Voice | Audio | Video | Document;

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

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseDocument = void 0;
+const audio_js_1 = require("./audio.js");
+const document_js_1 = require("./document.js");
+const sticker_js_1 = require("./sticker.js");
+const video_js_1 = require("./video.js");
+const voice_js_1 = require("./voice.js");
+/** @internal */
+function parseDocument(doc, media) {
+    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_js_1.Sticker(doc, stickerAttr, sz);
+    }
+    for (const attr of doc.attributes) {
+        switch (attr._) {
+            case 'documentAttributeAudio':
+                if (attr.voice) {
+                    return new voice_js_1.Voice(doc, attr);
+                }
+                return new audio_js_1.Audio(doc, attr);
+            case 'documentAttributeVideo':
+                return new video_js_1.Video(doc, attr, media);
+            case 'documentAttributeImageSize':
+                // legacy gif
+                if (doc.mimeType === 'image/gif') {
+                    return new video_js_1.Video(doc, attr, media);
+                }
+        }
+    }
+    return new document_js_1.Document(doc);
+}
+exports.parseDocument = parseDocument;
+//# sourceMappingURL=document-utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-utils.js","sourceRoot":"","sources":["../../../../../src/highlevel/types/media/document-utils.ts"],"names":[],"mappings":";;;AAEA,yCAAkC;AAClC,+CAAwC;AACxC,6CAAsC;AACtC,yCAAkC;AAClC,yCAAkC;AAIlC,gBAAgB;AAChB,SAAgB,aAAa,CAAC,GAAmB,EAAE,KAAkC;IACjF,MAAM,WAAW,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,0BAA0B,IAAI,CAAC,CAAC,CAAC,KAAK,8BAA8B,CACtF,CAAA;IAED,IAAI,WAAW,EAAE;QACb,MAAM,EAAE,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAC1B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,4BAA4B,IAAI,EAAE,CAAC,CAAC,KAAK,wBAAwB,CACjB,CAAA;QAErE,OAAO,IAAI,oBAAO,CAAC,GAAG,EAAE,WAAkF,EAAE,EAAE,CAAC,CAAA;KAClH;IAED,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,UAAU,EAAE;QAC/B,QAAQ,IAAI,CAAC,CAAC,EAAE;YACZ,KAAK,wBAAwB;gBACzB,IAAI,IAAI,CAAC,KAAK,EAAE;oBACZ,OAAO,IAAI,gBAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;iBAC9B;gBAED,OAAO,IAAI,gBAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;YAE/B,KAAK,wBAAwB;gBACzB,OAAO,IAAI,gBAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;YAEtC,KAAK,4BAA4B;gBAC7B,aAAa;gBACb,IAAI,GAAG,CAAC,QAAQ,KAAK,WAAW,EAAE;oBAC9B,OAAO,IAAI,gBAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;iBACrC;SACR;KACJ;IAED,OAAO,IAAI,sBAAQ,CAAC,GAAG,CAAC,CAAA;AAC5B,CAAC;AAlCD,sCAkCC","sourcesContent":["import { tl } from '@mtcute/tl'\n\nimport { Audio } from './audio.js'\nimport { Document } from './document.js'\nimport { Sticker } from './sticker.js'\nimport { Video } from './video.js'\nimport { Voice } from './voice.js'\n\nexport type ParsedDocument = Sticker | Voice | Audio | Video | Document\n\n/** @internal */\nexport function parseDocument(doc: tl.RawDocument, media?: tl.RawMessageMediaDocument): ParsedDocument {\n    const stickerAttr = doc.attributes.find(\n        (a) => a._ === 'documentAttributeSticker' || a._ === 'documentAttributeCustomEmoji',\n    )\n\n    if (stickerAttr) {\n        const sz = doc.attributes.find(\n            (it) => it._ === 'documentAttributeImageSize' || it._ === 'documentAttributeVideo',\n        )! as tl.RawDocumentAttributeImageSize | tl.RawDocumentAttributeVideo\n\n        return new Sticker(doc, stickerAttr as tl.RawDocumentAttributeSticker | tl.RawDocumentAttributeCustomEmoji, sz)\n    }\n\n    for (const attr of doc.attributes) {\n        switch (attr._) {\n            case 'documentAttributeAudio':\n                if (attr.voice) {\n                    return new Voice(doc, attr)\n                }\n\n                return new Audio(doc, attr)\n\n            case 'documentAttributeVideo':\n                return new Video(doc, attr, media)\n\n            case 'documentAttributeImageSize':\n                // legacy gif\n                if (doc.mimeType === 'image/gif') {\n                    return new Video(doc, attr, media)\n                }\n        }\n    }\n\n    return new Document(doc)\n}\n"]}

package/cjs/highlevel/types/media/document.d.ts

@@ -0,0 +1,75 @@
+import { tdFileId as td } from '@mtcute/file-id';
+import { tl } from '@mtcute/tl';
+import { FileLocation } from '../files/index.js';
+import { Thumbnail } from './thumbnail.js';
+/**
+ * A file that is represented as a document in MTProto.
+ *
+ * This also includes audios, videos, voices etc.
+ */
+export declare abstract class RawDocument extends FileLocation {
+    readonly raw: tl.RawDocument;
+    /** Type of the media (for use in a tagged union) */
+    abstract type: string;
+    constructor(raw: tl.RawDocument);
+    /**
+     * Original file name, extracted from the document
+     * attributes.
+     */
+    get fileName(): string | null;
+    /**
+     * File MIME type, as defined by the sender.
+     */
+    get mimeType(): string;
+    /**
+     * Date the document was sent
+     */
+    get date(): Date;
+    /**
+     * Available thumbnails, if any.
+     *
+     * If there are no thumbnails, the array will be empty.
+     */
+    get thumbnails(): ReadonlyArray<Thumbnail>;
+    /**
+     * Get a thumbnail by its type.
+     *
+     * Thumbnail types are described in the
+     * [Telegram docs](https://core.telegram.org/api/files#image-thumbnail-types),
+     * and are also available as static members of {@link Thumbnail} for convenience.
+     *
+     * @param type  Thumbnail type
+     */
+    getThumbnail(type: string): Thumbnail | null;
+    /**
+     * Input document TL object generated from this object,
+     * to be used with methods that use it
+     */
+    get inputDocument(): tl.TypeInputDocument;
+    /**
+     * Input media TL object generated from this object,
+     * to be used inside {@link InputMediaLike} and
+     * {@link TelegramClient.sendMedia}
+     */
+    get inputMedia(): tl.TypeInputMedia;
+    protected _fileIdType(): td.FileType;
+    /**
+     * Get TDLib and Bot API compatible File ID
+     * representing this document.
+     */
+    get fileId(): string;
+    /**
+     * Get a unique File ID representing this document.
+     */
+    get uniqueFileId(): string;
+}
+/**
+ * A generic file.
+ *
+ * This does not include audios, videos, voices etc.
+ * and only used for documents without any special
+ * attributes.
+ */
+export declare class Document extends RawDocument {
+    readonly type: "document";
+}