@mtcute/dispatcher 0.1.0

package/cjs/filters/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../../src/filters/message.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,mCAAmC;AACnC,2CAcuB;AAKvB;;;;GAIG;AACI,MAAM,QAAQ,GAAiD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAA;AAAjF,QAAA,QAAQ,YAAyE;AAE9F;;;;GAIG;AACI,MAAM,QAAQ,GAAgD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAA;AAA/E,QAAA,QAAQ,YAAuE;AAE5F;;GAEG;AACI,MAAM,KAAK,GAAgE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,cAAc,KAAK,IAAI,CAAA;AAAzG,QAAA,KAAK,SAAoG;AAEtH;;GAEG;AACI,MAAM,KAAK,GAAsE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAA;AAAtG,QAAA,KAAK,SAAiG;AAEnH;;GAEG;AACI,MAAM,OAAO,GAChB,CAA6B,IAAO,EAA4E,EAAE,CAC9G,CAAC,GAAG,EAAE,EAAE,CACJ,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,IAAI,CAAA;AAHvB,QAAA,OAAO,WAGgB;AAEpC,yCAAyC;AAC5B,QAAA,KAAK,GAAG,IAAA,eAAO,EAAC,OAAO,CAAC,CAAA;AACrC,wCAAwC;AAC3B,QAAA,IAAI,GAAG,IAAA,eAAO,EAAC,MAAM,CAAC,CAAA;AACnC,2CAA2C;AAC9B,QAAA,OAAO,GAAG,IAAA,eAAO,EAAC,SAAS,CAAC,CAAA;AACzC,+CAA+C;AAClC,QAAA,KAAK,GAAG,IAAA,eAAO,EAAC,OAAO,CAAC,CAAA;AACrC,8DAA8D;AACjD,QAAA,KAAK,GAAG,IAAA,eAAO,EAAC,OAAO,CAAC,CAAA;AACrC,2CAA2C;AAC9B,QAAA,OAAO,GAAG,IAAA,eAAO,EAAC,SAAS,CAAC,CAAA;AACzC,qDAAqD;AACxC,QAAA,QAAQ,GAAG,IAAA,eAAO,EAAC,UAAU,CAAC,CAAA;AAC3C,mFAAmF;AACtE,QAAA,QAAQ,GAAG,IAAA,eAAO,EAAC,OAAO,CAAC,CAAA;AACxC,mDAAmD;AACtC,QAAA,QAAQ,GAAG,IAAA,eAAO,EAAC,UAAU,CAAC,CAAA;AAC3C,iDAAiD;AACpC,QAAA,YAAY,GAAG,IAAA,eAAO,EAAC,eAAe,CAAC,CAAA;AACpD,wCAAwC;AAC3B,QAAA,IAAI,GAAG,IAAA,eAAO,EAAC,MAAM,CAAC,CAAA;AACnC,4CAA4C;AAC/B,QAAA,OAAO,GAAG,IAAA,eAAO,EAAC,UAAU,CAAC,CAAA;AAC1C,yCAAyC;AAC5B,QAAA,KAAK,GAAG,IAAA,eAAO,EAAC,OAAO,CAAC,CAAA;AACrC,wCAAwC;AAC3B,QAAA,IAAI,GAAG,IAAA,eAAO,EAAC,MAAM,CAAC,CAAA;AACnC,4CAA4C;AAC/B,QAAA,OAAO,GAAG,IAAA,eAAO,EAAC,SAAS,CAAC,CAAA;AAEzC;;GAEG;AACI,MAAM,WAAW,GAA+C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,YAAY,oBAAW,CAAA;AAAnG,QAAA,WAAW,eAAwF;AAEhH;;;;;GAKG;AACI,MAAM,WAAW,GAAkD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,YAAY,oBAAW,CAAA;AAAtG,QAAA,WAAW,eAA2F;AAEnH;;;;GAIG;AACI,MAAM,KAAK,GAWd,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAA;AAX3E,QAAA,KAAK,SAWsE;AAExF;;;;;GAKG;AACI,MAAM,SAAS,GAWlB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAA;AAX1E,QAAA,SAAS,aAWiE;AAEvF;;GAEG;AACI,MAAM,YAAY,GAWrB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAA;AAX1E,QAAA,YAAY,gBAW8D;AAEvF;;GAEG;AACI,MAAM,aAAa,GACtB,CAAC,IAAiB,EAA6C,EAAE,CAC7D,CAAC,GAAG,EAAE,EAAE,CACJ,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,CAAA;AAH9D,QAAA,aAAa,iBAGiD;AAE3E;;GAEG;AACI,MAAM,mBAAmB,GAC5B,CAAC,IAAuB,EAA6C,EAAE,CACnE,CAAC,GAAG,EAAE,EAAE,CACJ,GAAG,CAAC,KAAK,EAAE,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,IAAI,CAAA;AAH7D,QAAA,mBAAmB,uBAG0C;AAE1E;;GAEG;AACI,MAAM,IAAI,GAMb,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAA;AANpC,QAAA,IAAI,QAMgC;AAEjD;;GAEG;AACI,MAAM,OAAO,GAA+C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAA;AAA5E,QAAA,OAAO,WAAqE;AAEzF;;GAEG;AACI,MAAM,MAAM,GAAG,CAClB,IAAmB,EASrB,EAAE;IACA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACrB,MAAM,KAAK,GAA6B,EAAE,CAAA;QAC1C,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAExC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAE,GAAG,CAAC,MAAM,EAAE,IAAY,IAAI,KAAK,CAAA;KACrD;IAED,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,KAAK,IAAI,CAAA;AAC7C,CAAC,CAAA;AAnBY,QAAA,MAAM,UAmBlB;AAEM,MAAM,MAAM,GACf,CACI,IAAO,EACmE,EAAE,CAC5E,CAAC,GAAG,EAAE,EAAE,CACJ,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAA;AALvB,QAAA,MAAM,UAKiB;AAEpC;;;;GAIG;AACI,MAAM,OAAO,GAChB,CACI,MAA0C,EACuC,EAAE,CACnF,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;IACjB,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE;QAAE,OAAO,KAAK,CAAA;IAEzC,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,UAAU,EAAE,CAAA;IACpC,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAExB,GAAG,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE7C,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAA;IAExB,OAAO,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AAC/B,CAAC,CAAA;AAfI,QAAA,OAAO,WAeX","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n// ^^ will be looked into in MTQ-29\nimport {\n    Chat,\n    MaybeArray,\n    Message,\n    MessageAction,\n    MessageMediaType,\n    MessageReplyInfo,\n    RawDocument,\n    RawLocation,\n    Sticker,\n    StickerSourceType,\n    StickerType,\n    User,\n    Video,\n} from '@mtcute/client'\n\nimport { MessageContext } from '../index.js'\nimport { Modify, UpdateFilter } from './types.js'\n\n/**\n * Filter incoming messages.\n *\n * Messages sent to yourself (i.e. Saved Messages) are also \"incoming\"\n */\nexport const incoming: UpdateFilter<Message, { isOutgoing: false }> = (msg) => !msg.isOutgoing\n\n/**\n * Filter outgoing messages.\n *\n * Messages sent to yourself (i.e. Saved Messages) are **not** \"outgoing\"\n */\nexport const outgoing: UpdateFilter<Message, { isOutgoing: true }> = (msg) => msg.isOutgoing\n\n/**\n * Filter messages that are replies to some other message\n */\nexport const reply: UpdateFilter<Message, { replyToMessage: MessageReplyInfo }> = (msg) => msg.replyToMessage !== null\n\n/**\n * Filter messages containing some media\n */\nexport const media: UpdateFilter<Message, { media: Exclude<Message['media'], null> }> = (msg) => msg.media !== null\n\n/**\n * Filter messages containing media of given type\n */\nexport const mediaOf =\n    <T extends MessageMediaType>(type: T): UpdateFilter<Message, { media: Extract<Message['media'], { type: T }> }> =>\n        (msg) =>\n            msg.media?.type === type\n\n/** Filter messages containing a photo */\nexport const photo = mediaOf('photo')\n/** Filter messages containing a dice */\nexport const dice = mediaOf('dice')\n/** Filter messages containing a contact */\nexport const contact = mediaOf('contact')\n/** Filter messages containing an audio file */\nexport const audio = mediaOf('audio')\n/** Filter messages containing a voice message (audio-only) */\nexport const voice = mediaOf('voice')\n/** Filter messages containing a sticker */\nexport const sticker = mediaOf('sticker')\n/** Filter messages containing a document (a file) */\nexport const document = mediaOf('document')\n/** Filter messages containing any video (videos, round messages and animations) */\nexport const anyVideo = mediaOf('video')\n/** Filter messages containing a static location */\nexport const location = mediaOf('location')\n/** Filter messages containing a live location */\nexport const liveLocation = mediaOf('live_location')\n/** Filter messages containing a game */\nexport const game = mediaOf('game')\n/** Filter messages containing a web page */\nexport const webpage = mediaOf('web_page')\n/** Filter messages containing a venue */\nexport const venue = mediaOf('venue')\n/** Filter messages containing a poll */\nexport const poll = mediaOf('poll')\n/** Filter messages containing an invoice */\nexport const invoice = mediaOf('invoice')\n\n/**\n * Filter messages containing any location (live or static).\n */\nexport const anyLocation: UpdateFilter<Message, { media: Location }> = (msg) => msg.media instanceof RawLocation\n\n/**\n * Filter messages containing a document\n *\n * This will also match media like audio, video, voice\n * that also use Documents\n */\nexport const anyDocument: UpdateFilter<Message, { media: RawDocument }> = (msg) => msg.media instanceof RawDocument\n\n/**\n * Filter messages containing a simple video.\n *\n * This does not include round messages and animations\n */\nexport const video: UpdateFilter<\n    Message,\n    {\n        media: Modify<\n            Video,\n            {\n                isRound: false\n                isAnimation: false\n            }\n        >\n    }\n> = (msg) => msg.media?.type === 'video' && !msg.media.isAnimation && !msg.media.isRound\n\n/**\n * Filter messages containing an animation.\n *\n * > **Note**: Legacy GIFs (i.e. documents with `image/gif` MIME)\n * > are also considered animations.\n */\nexport const animation: UpdateFilter<\n    Message,\n    {\n        media: Modify<\n            Video,\n            {\n                isRound: false\n                isAnimation: true\n            }\n        >\n    }\n> = (msg) => msg.media?.type === 'video' && msg.media.isAnimation && !msg.media.isRound\n\n/**\n * Filter messages containing a round message (aka video note).\n */\nexport const roundMessage: UpdateFilter<\n    Message,\n    {\n        media: Modify<\n            Video,\n            {\n                isRound: true\n                isAnimation: false\n            }\n        >\n    }\n> = (msg) => msg.media?.type === 'video' && !msg.media.isAnimation && msg.media.isRound\n\n/**\n * Filter messages containing a sticker by its type\n */\nexport const stickerByType =\n    (type: StickerType): UpdateFilter<Message, { media: Sticker }> =>\n        (msg) =>\n            msg.media?.type === 'sticker' && msg.media.stickerType === type\n\n/**\n * Filter messages containing a sticker by its source file type\n */\nexport const stickerBySourceType =\n    (type: StickerSourceType): UpdateFilter<Message, { media: Sticker }> =>\n        (msg) =>\n            msg.media?.type === 'sticker' && msg.media.sourceType === type\n\n/**\n * Filter text-only messages non-service messages\n */\nexport const text: UpdateFilter<\n    Message,\n    {\n        media: null\n        isService: false\n    }\n> = (msg) => msg.media === null && !msg.isService\n\n/**\n * Filter service messages\n */\nexport const service: UpdateFilter<Message, { isService: true }> = (msg) => msg.isService\n\n/**\n * Filter service messages by action type\n */\nexport const action = <T extends Exclude<MessageAction, null>['type']>(\n    type: MaybeArray<T>,\n): UpdateFilter<\n    Message,\n    {\n        action: Extract<MessageAction, { type: T }>\n        sender: T extends 'user_joined_link' | 'user_removed' | 'history_cleared' | 'contact_joined' | 'bot_allowed'\n            ? User\n            : User | Chat\n    }\n> => {\n    if (Array.isArray(type)) {\n        const index: Partial<Record<T, true>> = {}\n        type.forEach((it) => (index[it] = true))\n\n        return (msg) => (msg.action?.type as any) in index\n    }\n\n    return (msg) => msg.action?.type === type\n}\n\nexport const sender =\n    <T extends Message['sender']['type']>(\n        type: T,\n    ): UpdateFilter<Message, { sender: Extract<Message['sender'], { type: T }> }> =>\n        (msg) =>\n            msg.sender.type === type\n\n/**\n * Filter that matches messages that are replies to some other message.\n *\n * Optionally, you can pass a filter that will be applied to the replied message.\n */\nexport const replyTo =\n    <Mod, State extends object>(\n        filter?: UpdateFilter<Message, Mod, State>,\n    ): UpdateFilter<MessageContext, { getReplyTo: () => Promise<Message & Mod> }, State> =>\n        async (msg, state) => {\n            if (!msg.replyToMessage?.id) return false\n\n            const reply = await msg.getReplyTo()\n            if (!reply) return false\n\n            msg.getReplyTo = () => Promise.resolve(reply)\n\n            if (!filter) return true\n\n            return filter(reply, state)\n        }\n"]}

package/cjs/filters/state.d.ts

@@ -0,0 +1,15 @@
+import { MaybeAsync } from '@mtcute/client';
+import { UpdateFilter } from './types.js';
+/**
+ * Create a filter for the cases when the state is empty
+ */
+export declare const stateEmpty: UpdateFilter<any>;
+/**
+ * Create a filter based on state predicate
+ *
+ * If state exists and matches `predicate`, update passes
+ * this filter, otherwise it doesn't
+ *
+ * @param predicate  State predicate
+ */
+export declare const state: <T extends object>(predicate: (state: T) => MaybeAsync<boolean>) => UpdateFilter<any, {}, T>;

package/cjs/filters/state.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.state = exports.stateEmpty = void 0;
+/**
+ * Create a filter for the cases when the state is empty
+ */
+const stateEmpty = async (upd, state) => {
+    if (!state)
+        return false;
+    return !(await state.get());
+};
+exports.stateEmpty = stateEmpty;
+/**
+ * Create a filter based on state predicate
+ *
+ * If state exists and matches `predicate`, update passes
+ * this filter, otherwise it doesn't
+ *
+ * @param predicate  State predicate
+ */
+const state = (predicate) => {
+    return async (upd, state) => {
+        if (!state)
+            return false;
+        const data = await state.get();
+        if (!data)
+            return false;
+        return predicate(data);
+    };
+};
+exports.state = state;
+//# sourceMappingURL=state.js.map

package/cjs/filters/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../src/filters/state.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACI,MAAM,UAAU,GAAsB,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;IAC9D,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAA;IAExB,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC,CAAA;AAC/B,CAAC,CAAA;AAJY,QAAA,UAAU,cAItB;AAED;;;;;;;GAOG;AACI,MAAM,KAAK,GAAG,CACjB,SAA4C,EAEpB,EAAE;IAC1B,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QACxB,IAAI,CAAC,KAAK;YAAE,OAAO,KAAK,CAAA;QACxB,MAAM,IAAI,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAA;QAC9B,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAA;QAEvB,OAAO,SAAS,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC,CAAA;AACL,CAAC,CAAA;AAXY,QAAA,KAAK,SAWjB","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { MaybeAsync } from '@mtcute/client'\n\nimport { UpdateFilter } from './types.js'\n\n/**\n * Create a filter for the cases when the state is empty\n */\nexport const stateEmpty: UpdateFilter<any> = async (upd, state) => {\n    if (!state) return false\n\n    return !(await state.get())\n}\n\n/**\n * Create a filter based on state predicate\n *\n * If state exists and matches `predicate`, update passes\n * this filter, otherwise it doesn't\n *\n * @param predicate  State predicate\n */\nexport const state = <T extends object>(\n    predicate: (state: T) => MaybeAsync<boolean>,\n    // eslint-disable-next-line @typescript-eslint/ban-types\n): UpdateFilter<any, {}, T> => {\n    return async (upd, state) => {\n        if (!state) return false\n        const data = await state.get()\n        if (!data) return false\n\n        return predicate(data)\n    }\n}\n"]}

package/cjs/filters/text.d.ts

@@ -0,0 +1,64 @@
+import { CallbackQuery, ChosenInlineResult, InlineQuery, Message } from '@mtcute/client';
+import { UpdateContextDistributed } from '../context/base.js';
+import { UpdateFilter } from './types.js';
+type UpdatesWithText = UpdateContextDistributed<Message | InlineQuery | ChosenInlineResult | CallbackQuery>;
+/**
+ * Filter objects that match a given regular expression
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult#id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * When a regex matches, the match array is stored in a
+ * type-safe extension field `.match` of the object
+ *
+ * @param regex  Regex to be matched
+ */
+export declare const regex: (regex: RegExp) => UpdateFilter<UpdatesWithText, {
+    match: RegExpMatchArray;
+}>;
+/**
+ * Filter objects which contain the exact text given
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  String to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+export declare const equals: (str: string, ignoreCase?: boolean) => UpdateFilter<UpdatesWithText>;
+/**
+ * Filter objects which contain the text given (as a substring)
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+export declare const contains: (str: string, ignoreCase?: boolean) => UpdateFilter<UpdatesWithText>;
+/**
+ * Filter objects which contain the text starting with a given string
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+export declare const startsWith: (str: string, ignoreCase?: boolean) => UpdateFilter<UpdatesWithText>;
+/**
+ * Filter objects which contain the text ending with a given string
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+export declare const endsWith: (str: string, ignoreCase?: boolean) => UpdateFilter<UpdatesWithText>;
+export {};

package/cjs/filters/text.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.endsWith = exports.startsWith = exports.contains = exports.equals = exports.regex = void 0;
+function extractText(obj) {
+    switch (obj._name) {
+        case 'new_message':
+            return obj.text;
+        case 'inline_query':
+            return obj.query;
+        case 'chosen_inline_result':
+            return obj.id;
+        case 'callback_query':
+            if (obj.raw.data)
+                return obj.dataStr;
+    }
+    return null;
+}
+/**
+ * Filter objects that match a given regular expression
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult#id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * When a regex matches, the match array is stored in a
+ * type-safe extension field `.match` of the object
+ *
+ * @param regex  Regex to be matched
+ */
+const regex = (regex) => (obj) => {
+    const txt = extractText(obj);
+    if (!txt)
+        return false;
+    const m = txt.match(regex);
+    if (m) {
+        obj.match = m;
+        return true;
+    }
+    return false;
+};
+exports.regex = regex;
+/**
+ * Filter objects which contain the exact text given
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  String to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+const equals = (str, ignoreCase = false) => {
+    if (ignoreCase) {
+        str = str.toLowerCase();
+        return (obj) => extractText(obj)?.toLowerCase() === str;
+    }
+    return (obj) => extractText(obj) === str;
+};
+exports.equals = equals;
+/**
+ * Filter objects which contain the text given (as a substring)
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+const contains = (str, ignoreCase = false) => {
+    if (ignoreCase) {
+        str = str.toLowerCase();
+        return (obj) => {
+            const txt = extractText(obj);
+            return txt != null && txt.toLowerCase().includes(str);
+        };
+    }
+    return (obj) => {
+        const txt = extractText(obj);
+        return txt != null && txt.includes(str);
+    };
+};
+exports.contains = contains;
+/**
+ * Filter objects which contain the text starting with a given string
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+const startsWith = (str, ignoreCase = false) => {
+    if (ignoreCase) {
+        str = str.toLowerCase();
+        return (obj) => {
+            const txt = extractText(obj);
+            return txt != null && txt.toLowerCase().substring(0, str.length) === str;
+        };
+    }
+    return (obj) => {
+        const txt = extractText(obj);
+        return txt != null && txt.substring(0, str.length) === str;
+    };
+};
+exports.startsWith = startsWith;
+/**
+ * Filter objects which contain the text ending with a given string
+ *  - for `Message`, `Message.text` is used
+ *  - for `InlineQuery`, `InlineQuery.query` is used
+ *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used
+ *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used
+ *
+ * @param str  Substring to be matched
+ * @param ignoreCase  Whether string case should be ignored
+ */
+const endsWith = (str, ignoreCase = false) => {
+    if (ignoreCase) {
+        str = str.toLowerCase();
+        return (obj) => {
+            const txt = extractText(obj);
+            return txt != null && txt.toLowerCase().substring(0, str.length) === str;
+        };
+    }
+    return (obj) => {
+        const txt = extractText(obj);
+        return txt != null && txt.substring(0, str.length) === str;
+    };
+};
+exports.endsWith = endsWith;
+//# sourceMappingURL=text.js.map

package/cjs/filters/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../src/filters/text.ts"],"names":[],"mappings":";;;AAOA,SAAS,WAAW,CAAC,GAAoB;IACrC,QAAQ,GAAG,CAAC,KAAK,EAAE;QACf,KAAK,aAAa;YACd,OAAO,GAAG,CAAC,IAAI,CAAA;QACnB,KAAK,cAAc;YACf,OAAO,GAAG,CAAC,KAAK,CAAA;QACpB,KAAK,sBAAsB;YACvB,OAAO,GAAG,CAAC,EAAE,CAAA;QACjB,KAAK,gBAAgB;YACjB,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAA;KAC3C;IAED,OAAO,IAAI,CAAA;AACf,CAAC;AAED;;;;;;;;;;;GAWG;AACI,MAAM,KAAK,GACd,CAAC,KAAa,EAA8D,EAAE,CAC1E,CAAC,GAAG,EAAE,EAAE;IACJ,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC5B,IAAI,CAAC,GAAG;QAAE,OAAO,KAAK,CAAA;IAEtB,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAE1B,IAAI,CAAC,EAAE;QACF,GAAgD,CAAC,KAAK,GAAG,CAAC,CAAA;QAE3D,OAAO,IAAI,CAAA;KACd;IAED,OAAO,KAAK,CAAA;AAChB,CAAC,CAAA;AAfI,QAAA,KAAK,SAeT;AAET;;;;;;;;;GASG;AACI,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK,EAAiC,EAAE;IACrF,IAAI,UAAU,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QAEvB,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,GAAG,CAAA;KAC1D;IAED,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;AAC5C,CAAC,CAAA;AARY,QAAA,MAAM,UAQlB;AAED;;;;;;;;;GASG;AACI,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK,EAAiC,EAAE;IACvF,IAAI,UAAU,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QAEvB,OAAO,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;YAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACzD,CAAC,CAAA;KACJ;IAED,OAAO,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;QAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC,CAAA;AACL,CAAC,CAAA;AAhBY,QAAA,QAAQ,YAgBpB;AAED;;;;;;;;;GASG;AACI,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK,EAAiC,EAAE;IACzF,IAAI,UAAU,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QAEvB,OAAO,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;YAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAA;QAC5E,CAAC,CAAA;KACJ;IAED,OAAO,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;QAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAA;IAC9D,CAAC,CAAA;AACL,CAAC,CAAA;AAhBY,QAAA,UAAU,cAgBtB;AAED;;;;;;;;;GASG;AACI,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK,EAAiC,EAAE;IACvF,IAAI,UAAU,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAA;QAEvB,OAAO,CAAC,GAAG,EAAE,EAAE;YACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;YAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAA;QAC5E,CAAC,CAAA;KACJ;IAED,OAAO,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;QAE5B,OAAO,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,CAAA;IAC9D,CAAC,CAAA;AACL,CAAC,CAAA;AAhBY,QAAA,QAAQ,YAgBpB","sourcesContent":["import { CallbackQuery, ChosenInlineResult, InlineQuery, Message } from '@mtcute/client'\n\nimport { UpdateContextDistributed } from '../context/base.js'\nimport { UpdateFilter } from './types.js'\n\ntype UpdatesWithText = UpdateContextDistributed<Message | InlineQuery | ChosenInlineResult | CallbackQuery>\n\nfunction extractText(obj: UpdatesWithText): string | null {\n    switch (obj._name) {\n        case 'new_message':\n            return obj.text\n        case 'inline_query':\n            return obj.query\n        case 'chosen_inline_result':\n            return obj.id\n        case 'callback_query':\n            if (obj.raw.data) return obj.dataStr\n    }\n\n    return null\n}\n\n/**\n * Filter objects that match a given regular expression\n *  - for `Message`, `Message.text` is used\n *  - for `InlineQuery`, `InlineQuery.query` is used\n *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult#id} is used\n *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used\n *\n * When a regex matches, the match array is stored in a\n * type-safe extension field `.match` of the object\n *\n * @param regex  Regex to be matched\n */\nexport const regex =\n    (regex: RegExp): UpdateFilter<UpdatesWithText, { match: RegExpMatchArray }> =>\n        (obj) => {\n            const txt = extractText(obj)\n            if (!txt) return false\n\n            const m = txt.match(regex)\n\n            if (m) {\n                (obj as typeof obj & { match: RegExpMatchArray }).match = m\n\n                return true\n            }\n\n            return false\n        }\n\n/**\n * Filter objects which contain the exact text given\n *  - for `Message`, `Message.text` is used\n *  - for `InlineQuery`, `InlineQuery.query` is used\n *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used\n *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used\n *\n * @param str  String to be matched\n * @param ignoreCase  Whether string case should be ignored\n */\nexport const equals = (str: string, ignoreCase = false): UpdateFilter<UpdatesWithText> => {\n    if (ignoreCase) {\n        str = str.toLowerCase()\n\n        return (obj) => extractText(obj)?.toLowerCase() === str\n    }\n\n    return (obj) => extractText(obj) === str\n}\n\n/**\n * Filter objects which contain the text given (as a substring)\n *  - for `Message`, `Message.text` is used\n *  - for `InlineQuery`, `InlineQuery.query` is used\n *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used\n *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used\n *\n * @param str  Substring to be matched\n * @param ignoreCase  Whether string case should be ignored\n */\nexport const contains = (str: string, ignoreCase = false): UpdateFilter<UpdatesWithText> => {\n    if (ignoreCase) {\n        str = str.toLowerCase()\n\n        return (obj) => {\n            const txt = extractText(obj)\n\n            return txt != null && txt.toLowerCase().includes(str)\n        }\n    }\n\n    return (obj) => {\n        const txt = extractText(obj)\n\n        return txt != null && txt.includes(str)\n    }\n}\n\n/**\n * Filter objects which contain the text starting with a given string\n *  - for `Message`, `Message.text` is used\n *  - for `InlineQuery`, `InlineQuery.query` is used\n *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used\n *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used\n *\n * @param str  Substring to be matched\n * @param ignoreCase  Whether string case should be ignored\n */\nexport const startsWith = (str: string, ignoreCase = false): UpdateFilter<UpdatesWithText> => {\n    if (ignoreCase) {\n        str = str.toLowerCase()\n\n        return (obj) => {\n            const txt = extractText(obj)\n\n            return txt != null && txt.toLowerCase().substring(0, str.length) === str\n        }\n    }\n\n    return (obj) => {\n        const txt = extractText(obj)\n\n        return txt != null && txt.substring(0, str.length) === str\n    }\n}\n\n/**\n * Filter objects which contain the text ending with a given string\n *  - for `Message`, `Message.text` is used\n *  - for `InlineQuery`, `InlineQuery.query` is used\n *  - for {@link ChosenInlineResult}, {@link ChosenInlineResult.id} is used\n *  - for `CallbackQuery`, `CallbackQuery.dataStr` is used\n *\n * @param str  Substring to be matched\n * @param ignoreCase  Whether string case should be ignored\n */\nexport const endsWith = (str: string, ignoreCase = false): UpdateFilter<UpdatesWithText> => {\n    if (ignoreCase) {\n        str = str.toLowerCase()\n\n        return (obj) => {\n            const txt = extractText(obj)\n\n            return txt != null && txt.toLowerCase().substring(0, str.length) === str\n        }\n    }\n\n    return (obj) => {\n        const txt = extractText(obj)\n\n        return txt != null && txt.substring(0, str.length) === str\n    }\n}\n"]}

package/cjs/filters/types.d.ts

@@ -0,0 +1,91 @@
+import { MaybeAsync } from '@mtcute/client';
+import { UpdateState } from '../state/update-state.js';
+/**
+ * Type describing a primitive filter, which is a function taking some `Base`
+ * and a {@link TelegramClient}, checking it against some condition
+ * and returning a boolean.
+ *
+ * If `true` is returned, the filter is considered
+ * to be matched, and the appropriate update handler function is called,
+ * otherwise next registered handler is checked.
+ *
+ * Additionally, filter might contain a type modification
+ * to `Base` for better code insights. If it is present,
+ * it is used to overwrite types (!) of some of the `Base` fields
+ * to given (note that this is entirely compile-time! object is not modified)
+ *
+ * For parametrized filters (like {@link filters.regex}),
+ * type modification can also be used to add additional fields
+ * (in case of `regex`, its match array is added to `.match`)
+ *
+ * Example without type mod:
+ * ```typescript
+ *
+ * const hasPhoto: UpdateFilter<Message> = msg => msg.media?.type === 'photo'
+ *
+ * // ..later..
+ * tg.onNewMessage(hasPhoto, async (msg) => {
+ *     // `hasPhoto` filter matched, so we can safely assume
+ *     // that `msg.media` is a Photo.
+ *     //
+ *     // but it is very redundant, verbose and error-rome,
+ *     // wonder if we could make typescript do this automagically and safely...
+ *     await (msg.media as Photo).downloadToFile(`${msg.id}.jpg`)
+ * })
+ * ```
+ *
+ * Example with type mod:
+ * ```typescript
+ *
+ * const hasPhoto: UpdateFilter<Message, { media: Photo }> = msg => msg.media?.type === 'photo'
+ *
+ * // ..later..
+ * tg.onNewMessage(hasPhoto, async (msg) => {
+ *     // since `hasPhoto` filter matched,
+ *     // we have applied the modification to `msg`,
+ *     // and `msg.media` now has type `Photo`
+ *     //
+ *     // no more redundancy and type casts!
+ *     await msg.media.downloadToFile(`${msg.id}.jpg`)
+ * })
+ * ```
+ *
+ * > **Note**: Type modification can contain anything, even totally unrelated types
+ * > and it is *your* task to keep track that everything is correct.
+ * >
+ * > Bad example:
+ * > ```typescript
+ * > // we check for `Photo`, but type contains `Audio`. this will be a problem!
+ * > const hasPhoto: UpdateFilter<Message, { media: Audio }> = msg => msg.media?.type === 'photo'
+ * >
+ * > // ..later..
+ * > tg.onNewMessage(hasPhoto, async (msg) => {
+ * >     // oops! `msg.media` is `Audio` and does not have `.width`!
+ * >     console.log(msg.media.width)
+ * > })
+ * > ```
+ *
+ * > **Warning!** Do not use the generics provided in functions
+ * > like `and`, `or`, etc. Those are meant to be inferred by the compiler!
+ */
+export type UpdateFilter<Base, Mod = {}, State extends object = never> = (update: Base, state?: UpdateState<State>) => MaybeAsync<boolean>;
+export type Modify<Base, Mod> = Omit<Base, keyof Mod> & Mod;
+export type Invert<Base, Mod> = {
+    [P in keyof Mod & keyof Base]: Exclude<Base[P], Mod[P]>;
+};
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export type ExtractBase<Filter> = Filter extends UpdateFilter<infer I, any> ? I : never;
+export type ExtractMod<Filter> = Filter extends UpdateFilter<any, infer I> ? I : never;
+export type ExtractState<Filter> = Filter extends UpdateFilter<any, any, infer I> ? I : never;
+export type TupleKeys<T extends any[]> = Exclude<keyof T, keyof []>;
+export type WrapBase<T extends any[]> = {
+    [K in TupleKeys<T>]: {
+        base: ExtractBase<T[K]>;
+    };
+};
+export type Values<T> = T[keyof T];
+export type UnwrapBase<T> = T extends {
+    base: any;
+} ? T['base'] : never;
+export type ExtractBaseMany<Filters extends any[]> = UnwrapBase<UnionToIntersection<Values<WrapBase<Filters>>>>;
+export type EmptyObject = Record<never, never>;

package/cjs/filters/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/* eslint-disable @typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// ^^ will be looked into in MTQ-29
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/cjs/filters/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/filters/types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,uDAAuD;AACvD,mCAAmC","sourcesContent":["/* eslint-disable @typescript-eslint/ban-types */\n/* eslint-disable @typescript-eslint/no-explicit-any */\n// ^^ will be looked into in MTQ-29\n\nimport { MaybeAsync } from '@mtcute/client'\n\nimport { UpdateState } from '../state/update-state.js'\n/**\n * Type describing a primitive filter, which is a function taking some `Base`\n * and a {@link TelegramClient}, checking it against some condition\n * and returning a boolean.\n *\n * If `true` is returned, the filter is considered\n * to be matched, and the appropriate update handler function is called,\n * otherwise next registered handler is checked.\n *\n * Additionally, filter might contain a type modification\n * to `Base` for better code insights. If it is present,\n * it is used to overwrite types (!) of some of the `Base` fields\n * to given (note that this is entirely compile-time! object is not modified)\n *\n * For parametrized filters (like {@link filters.regex}),\n * type modification can also be used to add additional fields\n * (in case of `regex`, its match array is added to `.match`)\n *\n * Example without type mod:\n * ```typescript\n *\n * const hasPhoto: UpdateFilter<Message> = msg => msg.media?.type === 'photo'\n *\n * // ..later..\n * tg.onNewMessage(hasPhoto, async (msg) => {\n *     // `hasPhoto` filter matched, so we can safely assume\n *     // that `msg.media` is a Photo.\n *     //\n *     // but it is very redundant, verbose and error-rome,\n *     // wonder if we could make typescript do this automagically and safely...\n *     await (msg.media as Photo).downloadToFile(`${msg.id}.jpg`)\n * })\n * ```\n *\n * Example with type mod:\n * ```typescript\n *\n * const hasPhoto: UpdateFilter<Message, { media: Photo }> = msg => msg.media?.type === 'photo'\n *\n * // ..later..\n * tg.onNewMessage(hasPhoto, async (msg) => {\n *     // since `hasPhoto` filter matched,\n *     // we have applied the modification to `msg`,\n *     // and `msg.media` now has type `Photo`\n *     //\n *     // no more redundancy and type casts!\n *     await msg.media.downloadToFile(`${msg.id}.jpg`)\n * })\n * ```\n *\n * > **Note**: Type modification can contain anything, even totally unrelated types\n * > and it is *your* task to keep track that everything is correct.\n * >\n * > Bad example:\n * > ```typescript\n * > // we check for `Photo`, but type contains `Audio`. this will be a problem!\n * > const hasPhoto: UpdateFilter<Message, { media: Audio }> = msg => msg.media?.type === 'photo'\n * >\n * > // ..later..\n * > tg.onNewMessage(hasPhoto, async (msg) => {\n * >     // oops! `msg.media` is `Audio` and does not have `.width`!\n * >     console.log(msg.media.width)\n * > })\n * > ```\n *\n * > **Warning!** Do not use the generics provided in functions\n * > like `and`, `or`, etc. Those are meant to be inferred by the compiler!\n */\n// we need the second parameter because it carries meta information\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nexport type UpdateFilter<Base, Mod = {}, State extends object = never> = (\n    update: Base,\n    state?: UpdateState<State>,\n) => MaybeAsync<boolean>\n\nexport type Modify<Base, Mod> = Omit<Base, keyof Mod> & Mod\nexport type Invert<Base, Mod> = {\n    [P in keyof Mod & keyof Base]: Exclude<Base[P], Mod[P]>\n}\n\nexport type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never\n\nexport type ExtractBase<Filter> = Filter extends UpdateFilter<infer I, any> ? I : never\n\nexport type ExtractMod<Filter> = Filter extends UpdateFilter<any, infer I> ? I : never\n\nexport type ExtractState<Filter> = Filter extends UpdateFilter<any, any, infer I> ? I : never\n\nexport type TupleKeys<T extends any[]> = Exclude<keyof T, keyof []>\nexport type WrapBase<T extends any[]> = {\n    [K in TupleKeys<T>]: { base: ExtractBase<T[K]> }\n}\nexport type Values<T> = T[keyof T]\nexport type UnwrapBase<T> = T extends { base: any } ? T['base'] : never\nexport type ExtractBaseMany<Filters extends any[]> = UnwrapBase<UnionToIntersection<Values<WrapBase<Filters>>>>\n\nexport type EmptyObject = Record<never, never>\n"]}

package/cjs/filters/updates.d.ts

@@ -0,0 +1,46 @@
+import { CallbackQuery, ChatMemberUpdate, ChatMemberUpdateType, UserStatus, UserStatusUpdate } from '@mtcute/client';
+import { UpdateFilter } from './types.js';
+/**
+ * Create a filter for {@link ChatMemberUpdate} by update type
+ *
+ * @param types  Update type(s)
+ * @link ChatMemberUpdate.Type
+ */
+export declare const chatMember: {
+    <T extends ChatMemberUpdateType>(type: T): UpdateFilter<ChatMemberUpdate, {
+        type: T;
+    }>;
+    <T extends ChatMemberUpdateType[]>(types: T): UpdateFilter<ChatMemberUpdate, {
+        type: T[number];
+    }>;
+};
+/**
+ * Create a filter for {@link UserStatusUpdate} by new user status
+ *
+ * @param statuses  Update type(s)
+ * @link User.Status
+ */
+export declare const userStatus: {
+    <T extends UserStatus>(status: T): UpdateFilter<UserStatusUpdate, {
+        type: T;
+        lastOnline: T extends 'offline' ? Date : null;
+        nextOffline: T extends 'online' ? Date : null;
+    }>;
+    <T extends UserStatus[]>(statuses: T): UpdateFilter<UserStatusUpdate, {
+        type: T[number];
+    }>;
+};
+/**
+ * Create a filter for {@link ChatMemberUpdate} for updates
+ * regarding current user
+ */
+export declare const chatMemberSelf: UpdateFilter<ChatMemberUpdate, {
+    isSelf: true;
+}>;
+/**
+ * Create a filter for callback queries that
+ * originated from an inline message
+ */
+export declare const callbackInline: UpdateFilter<CallbackQuery, {
+    isInline: true;
+}>;

package/cjs/filters/updates.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callbackInline = exports.chatMemberSelf = exports.userStatus = exports.chatMember = void 0;
+/**
+ * Create a filter for {@link ChatMemberUpdate} by update type
+ *
+ * @param types  Update type(s)
+ * @link ChatMemberUpdate.Type
+ */
+const chatMember = (types) => {
+    if (Array.isArray(types)) {
+        const index = {};
+        types.forEach((typ) => (index[typ] = true));
+        return (upd) => upd.type in index;
+    }
+    return (upd) => upd.type === types;
+};
+exports.chatMember = chatMember;
+/**
+ * Create a filter for {@link UserStatusUpdate} by new user status
+ *
+ * @param statuses  Update type(s)
+ * @link User.Status
+ */
+const userStatus = (statuses) => {
+    if (Array.isArray(statuses)) {
+        const index = {};
+        statuses.forEach((typ) => (index[typ] = true));
+        return (upd) => upd.status in index;
+    }
+    return (upd) => upd.status === statuses;
+};
+exports.userStatus = userStatus;
+/**
+ * Create a filter for {@link ChatMemberUpdate} for updates
+ * regarding current user
+ */
+const chatMemberSelf = (upd) => upd.isSelf;
+exports.chatMemberSelf = chatMemberSelf;
+/**
+ * Create a filter for callback queries that
+ * originated from an inline message
+ */
+const callbackInline = (q) => q.isInline;
+exports.callbackInline = callbackInline;
+//# sourceMappingURL=updates.js.map

package/cjs/filters/updates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updates.js","sourceRoot":"","sources":["../../../src/filters/updates.ts"],"names":[],"mappings":";;;AAIA;;;;;GAKG;AACI,MAAM,UAAU,GAGnB,CAAC,KAAuC,EAAkC,EAAE;IAC5E,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACtB,MAAM,KAAK,GAAgD,EAAE,CAAA;QAC7D,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAE3C,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,CAAA;KACpC;IAED,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,CAAA;AACtC,CAAC,CAAA;AAZY,QAAA,UAAU,cAYtB;AAED;;;;;GAKG;AACI,MAAM,UAAU,GAYnB,CAAC,QAAgC,EAAkC,EAAE;IACrE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACzB,MAAM,KAAK,GAAsC,EAAE,CAAA;QACnD,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;QAE9C,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,IAAI,KAAK,CAAA;KACtC;IAED,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAA;AAC3C,CAAC,CAAA;AArBY,QAAA,UAAU,cAqBtB;AAED;;;GAGG;AACI,MAAM,cAAc,GAAqD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAA;AAAtF,QAAA,cAAc,kBAAwE;AAEnG;;;GAGG;AACI,MAAM,cAAc,GAAoD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;AAAnF,QAAA,cAAc,kBAAqE","sourcesContent":["import { CallbackQuery, ChatMemberUpdate, ChatMemberUpdateType, MaybeArray, UserStatus, UserStatusUpdate } from '@mtcute/client'\n\nimport { UpdateFilter } from './types.js'\n\n/**\n * Create a filter for {@link ChatMemberUpdate} by update type\n *\n * @param types  Update type(s)\n * @link ChatMemberUpdate.Type\n */\nexport const chatMember: {\n    <T extends ChatMemberUpdateType>(type: T): UpdateFilter<ChatMemberUpdate, { type: T }>\n    <T extends ChatMemberUpdateType[]>(types: T): UpdateFilter<ChatMemberUpdate, { type: T[number] }>\n} = (types: MaybeArray<ChatMemberUpdateType>): UpdateFilter<ChatMemberUpdate> => {\n    if (Array.isArray(types)) {\n        const index: Partial<Record<ChatMemberUpdateType, true>> = {}\n        types.forEach((typ) => (index[typ] = true))\n\n        return (upd) => upd.type in index\n    }\n\n    return (upd) => upd.type === types\n}\n\n/**\n * Create a filter for {@link UserStatusUpdate} by new user status\n *\n * @param statuses  Update type(s)\n * @link User.Status\n */\nexport const userStatus: {\n    <T extends UserStatus>(\n        status: T,\n    ): UpdateFilter<\n        UserStatusUpdate,\n        {\n            type: T\n            lastOnline: T extends 'offline' ? Date : null\n            nextOffline: T extends 'online' ? Date : null\n        }\n    >\n    <T extends UserStatus[]>(statuses: T): UpdateFilter<UserStatusUpdate, { type: T[number] }>\n} = (statuses: MaybeArray<UserStatus>): UpdateFilter<UserStatusUpdate> => {\n    if (Array.isArray(statuses)) {\n        const index: Partial<Record<UserStatus, true>> = {}\n        statuses.forEach((typ) => (index[typ] = true))\n\n        return (upd) => upd.status in index\n    }\n\n    return (upd) => upd.status === statuses\n}\n\n/**\n * Create a filter for {@link ChatMemberUpdate} for updates\n * regarding current user\n */\nexport const chatMemberSelf: UpdateFilter<ChatMemberUpdate, { isSelf: true }> = (upd) => upd.isSelf\n\n/**\n * Create a filter for callback queries that\n * originated from an inline message\n */\nexport const callbackInline: UpdateFilter<CallbackQuery, { isInline: true }> = (q) => q.isInline\n"]}

package/cjs/filters/user.d.ts

@@ -0,0 +1,24 @@
+import { BotChatJoinRequestUpdate, CallbackQuery, ChatMemberUpdate, ChosenInlineResult, DeleteStoryUpdate, HistoryReadUpdate, InlineQuery, MaybeArray, Message, PollVoteUpdate, StoryUpdate, User, UserStatusUpdate, UserTypingUpdate } from '@mtcute/client';
+import { UpdateContextDistributed } from '../context/base.js';
+import { UpdateFilter } from './types.js';
+/**
+ * Filter messages generated by yourself (including Saved Messages)
+ */
+export declare const me: UpdateFilter<Message, {
+    sender: User;
+}>;
+/**
+ * Filter messages sent by bots
+ */
+export declare const bot: UpdateFilter<Message, {
+    sender: User;
+}>;
+/**
+ * Filter updates by user ID(s) or username(s)
+ *
+ * Note that only some updates support filtering by username.
+ */
+export declare const userId: {
+    (id: MaybeArray<number>): UpdateFilter<UpdateContextDistributed<Message | StoryUpdate | DeleteStoryUpdate | InlineQuery | ChatMemberUpdate | ChosenInlineResult | CallbackQuery | PollVoteUpdate | BotChatJoinRequestUpdate>>;
+    (id: MaybeArray<number | string>): UpdateFilter<UpdateContextDistributed<Message | UserStatusUpdate | UserTypingUpdate | StoryUpdate | HistoryReadUpdate | DeleteStoryUpdate | InlineQuery | ChatMemberUpdate | ChosenInlineResult | CallbackQuery | PollVoteUpdate | BotChatJoinRequestUpdate>>;
+};

package/cjs/filters/user.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userId = exports.bot = exports.me = void 0;
+const client_1 = require("@mtcute/client");
+/**
+ * Filter messages generated by yourself (including Saved Messages)
+ */
+const me = (msg) => (msg.sender.type === 'user' && msg.sender.isSelf) || msg.isOutgoing;
+exports.me = me;
+/**
+ * Filter messages sent by bots
+ */
+const bot = (msg) => msg.sender.constructor === client_1.User && msg.sender.isBot;
+exports.bot = bot;
+// prettier-ignore
+/**
+ * Filter updates by user ID(s) or username(s)
+ *
+ * Note that only some updates support filtering by username.
+ */
+const userId = (id) => {
+    const indexId = new Set();
+    const indexUsername = new Set();
+    let matchSelf = false;
+    if (!Array.isArray(id))
+        id = [id];
+    id.forEach((id) => {
+        if (id === 'me' || id === 'self') {
+            matchSelf = true;
+        }
+        else if (typeof id === 'string') {
+            indexUsername.add(id);
+        }
+        else {
+            indexId.add(id);
+        }
+    });
+    return (upd) => {
+        switch (upd._name) {
+            case 'new_message':
+            case 'edit_message': {
+                const sender = upd.sender;
+                return (matchSelf && sender.isSelf) ||
+                    indexId.has(sender.id) ||
+                    indexUsername.has(sender.username);
+            }
+            case 'user_status':
+            case 'user_typing': {
+                const id = upd.userId;
+                return (matchSelf && id === upd.client.getAuthState().userId) ||
+                    indexId.has(id);
+            }
+            case 'poll_vote':
+            case 'story':
+            case 'delete_story': {
+                const peer = upd.peer;
+                if (peer.type !== 'user')
+                    return false;
+                return (matchSelf && peer.isSelf) ||
+                    indexId.has(peer.id) ||
+                    Boolean(peer.usernames?.some((u) => indexUsername.has(u.username)));
+            }
+            case 'history_read': {
+                const id = upd.chatId;
+                return (matchSelf && id === upd.client.getAuthState().userId) ||
+                    indexId.has(id);
+            }
+        }
+        const user = upd.user;
+        return ((matchSelf && user.isSelf) ||
+            indexId.has(user.id) ||
+            Boolean(user.usernames?.some((u) => indexUsername.has(u.username))));
+    };
+};
+exports.userId = userId;
+//# sourceMappingURL=user.js.map

package/cjs/filters/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/filters/user.ts"],"names":[],"mappings":";;;AAAA,2CAeuB;AAKvB;;GAEG;AACI,MAAM,EAAE,GAA4C,CAAC,GAAG,EAAE,EAAE,CAC/D,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,CAAA;AAD1D,QAAA,EAAE,MACwD;AAEvE;;GAEG;AACI,MAAM,GAAG,GAA4C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,aAAI,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,CAAA;AAA3G,QAAA,GAAG,OAAwG;AAExH,kBAAkB;AAClB;;;;GAIG;AACI,MAAM,MAAM,GA0Bf,CAAC,EAAE,EAAE,EAAE;IACP,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IACjC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;IACvC,IAAI,SAAS,GAAG,KAAK,CAAA;IAErB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;IACjC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;QACd,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,MAAM,EAAE;YAC9B,SAAS,GAAG,IAAI,CAAA;SACnB;aAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC/B,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACxB;aAAM;YACH,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SAClB;IACL,CAAC,CAAC,CAAA;IAEF,OAAO,CAAC,GAAG,EAAE,EAAE;QACX,QAAQ,GAAG,CAAC,KAAK,EAAE;YACf,KAAK,aAAa,CAAC;YACnB,KAAK,cAAc,CAAC,CAAC;gBACjB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;gBAEzB,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC;oBAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtB,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,QAAS,CAAC,CAAA;aAC1C;YACD,KAAK,aAAa,CAAC;YACnB,KAAK,aAAa,CAAC,CAAC;gBAChB,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;gBAErB,OAAO,CAAC,SAAS,IAAI,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC;oBACzD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;aACtB;YACD,KAAK,WAAW,CAAC;YACjB,KAAK,OAAO,CAAC;YACb,KAAK,cAAc,CAAC,CAAC;gBACjB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;gBACrB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;oBAAE,OAAO,KAAK,CAAA;gBAEtC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;oBAC7B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpB,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;aAC1E;YACD,KAAK,cAAc,CAAC,CAAC;gBACjB,MAAM,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;gBAErB,OAAO,CAAC,SAAS,IAAI,EAAE,KAAK,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC;oBACzD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;aACtB;SACJ;QAED,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;QAErB,OAAO,CACH,CAAC,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CACtE,CAAA;IACL,CAAC,CAAA;AACL,CAAC,CAAA;AArFY,QAAA,MAAM,UAqFlB","sourcesContent":["import {\n    BotChatJoinRequestUpdate,\n    CallbackQuery,\n    ChatMemberUpdate,\n    ChosenInlineResult,\n    DeleteStoryUpdate,\n    HistoryReadUpdate,\n    InlineQuery,\n    MaybeArray,\n    Message,\n    PollVoteUpdate,\n    StoryUpdate,\n    User,\n    UserStatusUpdate,\n    UserTypingUpdate,\n} from '@mtcute/client'\n\nimport { UpdateContextDistributed } from '../context/base.js'\nimport { UpdateFilter } from './types.js'\n\n/**\n * Filter messages generated by yourself (including Saved Messages)\n */\nexport const me: UpdateFilter<Message, { sender: User }> = (msg) =>\n    (msg.sender.type === 'user' && msg.sender.isSelf) || msg.isOutgoing\n\n/**\n * Filter messages sent by bots\n */\nexport const bot: UpdateFilter<Message, { sender: User }> = (msg) => msg.sender.constructor === User && msg.sender.isBot\n\n// prettier-ignore\n/**\n * Filter updates by user ID(s) or username(s)\n *\n * Note that only some updates support filtering by username.\n */\nexport const userId: {\n    (id: MaybeArray<number>): UpdateFilter<UpdateContextDistributed<\n        | Message\n        | StoryUpdate\n        | DeleteStoryUpdate\n        | InlineQuery\n        | ChatMemberUpdate\n        | ChosenInlineResult\n        | CallbackQuery\n        | PollVoteUpdate\n        | BotChatJoinRequestUpdate\n    >>\n    (id: MaybeArray<number | string>): UpdateFilter<UpdateContextDistributed<\n        | Message\n        | UserStatusUpdate\n        | UserTypingUpdate\n        | StoryUpdate\n        | HistoryReadUpdate\n        | DeleteStoryUpdate\n        | InlineQuery\n        | ChatMemberUpdate\n        | ChosenInlineResult\n        | CallbackQuery\n        | PollVoteUpdate\n        | BotChatJoinRequestUpdate\n    >>\n} = (id) => {\n    const indexId = new Set<number>()\n    const indexUsername = new Set<string>()\n    let matchSelf = false\n\n    if (!Array.isArray(id)) id = [id]\n    id.forEach((id) => {\n        if (id === 'me' || id === 'self') {\n            matchSelf = true\n        } else if (typeof id === 'string') {\n            indexUsername.add(id)\n        } else {\n            indexId.add(id)\n        }\n    })\n\n    return (upd) => {\n        switch (upd._name) {\n            case 'new_message':\n            case 'edit_message': {\n                const sender = upd.sender\n\n                return (matchSelf && sender.isSelf) ||\n                    indexId.has(sender.id) ||\n                    indexUsername.has(sender.username!)\n            }\n            case 'user_status':\n            case 'user_typing': {\n                const id = upd.userId\n\n                return (matchSelf && id === upd.client.getAuthState().userId) ||\n                    indexId.has(id)\n            }\n            case 'poll_vote':\n            case 'story':\n            case 'delete_story': {\n                const peer = upd.peer\n                if (peer.type !== 'user') return false\n\n                return (matchSelf && peer.isSelf) ||\n                    indexId.has(peer.id) ||\n                    Boolean(peer.usernames?.some((u) => indexUsername.has(u.username)))\n            }\n            case 'history_read': {\n                const id = upd.chatId\n\n                return (matchSelf && id === upd.client.getAuthState().userId) ||\n                    indexId.has(id)\n            }\n        }\n\n        const user = upd.user\n\n        return (\n            (matchSelf && user.isSelf) ||\n            indexId.has(user.id) ||\n            Boolean(user.usernames?.some((u) => indexUsername.has(u.username)))\n        )\n    }\n}\n"]}