@mtcute/dispatcher 0.12.3 → 0.13.0

package/cjs/callback-data-builder.d.ts

@@ -26,8 +26,10 @@ export declare class CallbackDataBuilder<T extends string> {
      * Parse callback data to object
      *
      * @param data  Callback data as string
+     * @param safe  If `true`, will return `null` instead of throwing on invalid data
      */
-    parse(data: string): Record<T, string>;
+    parse(data: string, safe?: false): Record<T, string>;
+    parse(data: string, safe: true): Record<T, string> | null;
     /**
      * Create a filter for this callback data.
      *

package/cjs/callback-data-builder.js

@@ -43,18 +43,17 @@ class CallbackDataBuilder {
         }
         return ret;
     }
-    /**
-     * Parse callback data to object
-     *
-     * @param data  Callback data as string
-     */
-    parse(data) {
+    parse(data, safe = false) {
         const parts = data.split(this.sep);
         if (parts[0] !== this.prefix) {
-            throw new core_1.MtArgumentError('Invalid data passed');
+            if (safe)
+                return null;
+            throw new core_1.MtArgumentError(`Invalid data passed: "${data}" (bad prefix, expected ${this.prefix}, got ${parts[0]})`);
         }
         if (parts.length !== this._fields.length + 1) {
-            throw new core_1.MtArgumentError('Invalid data passed');
+            if (safe)
+                return null;
+            throw new core_1.MtArgumentError(`Invalid data passed: "${data}" (bad parts count, expected ${this._fields.length}, got ${parts.length - 1})`);
         }
         const ret = {};
         parts.forEach((it, idx) => {
@@ -82,7 +81,9 @@ class CallbackDataBuilder {
             return async (query) => {
                 if (!query.dataStr)
                     return false;
-                const data = this.parse(query.dataStr);
+                const data = this.parse(query.dataStr, true);
+                if (!data)
+                    return false;
                 const fnResult = await params(query, data);
                 if (typeof fnResult === 'boolean') {
                     query.match = data;

package/cjs/callback-data-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"callback-data-builder.js","sourceRoot":"","sources":["../../src/callback-data-builder.ts"],"names":[],"mappings":";;;AAAA,uCAAuF;AAIvF;;;;;;GAMG;AACH,MAAa,mBAAmB;IAUjB;IATM,OAAO,CAAK;IAE7B,GAAG,GAAG,GAAG,CAAA;IAET;;;OAGG;IACH,YACW,MAAc,EACrB,GAAG,MAAW;QADP,WAAM,GAAN,MAAM,CAAQ;QAGrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAsB;QACxB,MAAM,GAAG,GACL,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,OAAO;iBACP,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACP,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;gBAElB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,IAAI,sBAAe,CACrB,aAAa,CAAC,IAAI,GAAG,uBAAuB,IAAI,CAAC,GAAG,sBAAsB,CAC7E,CAAA;gBACL,CAAC;gBAED,OAAO,GAAG,CAAA;YACd,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvB,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,sBAAe,CAAC,sCAAsC,CAAC,CAAA;QACrE,CAAC;QAED,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAY;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAElC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,sBAAe,CAAC,qBAAqB,CAAC,CAAA;QACpD,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,sBAAe,CAAC,qBAAqB,CAAC,CAAA;QACpD,CAAC;QAED,MAAM,GAAG,GAAG,EAAuB,CAAA;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;YACtB,IAAI,GAAG,KAAK,CAAC;gBAAE,OAAM,CAAC,cAAc;YAEpC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACF,SAKwD,EAAE;QAO1D,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;gBACnB,IAAI,CAAC,KAAK,CAAC,OAAO;oBAAE,OAAO,KAAK,CAAA;gBAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBACtC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;gBAE1C,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAE5B,KAGH,CAAC,KAAK,GAAG,IAAI,CAAA;oBAEd,OAAO,QAAQ,CAAA;gBACnB,CAAC;gBAED,kBAAkB;gBAClB,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;oBACzB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;oBACvB,IAAI,KAAK,KAAK,SAAS;wBAAE,OAAO,KAAK,CAAA;oBAErC,IAAI,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAgC,CAAA;oBAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;wBAAE,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAA;oBAEnD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC7B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;4BAC9B,IAAI,KAAK,KAAK,OAAO;gCAAE,OAAO,KAAK,CAAA;wBACvC,CAAC;6BAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;4BAAE,OAAO,KAAK,CAAA;oBACjD,CAAC;gBACL,CAAC;gBAGG,KAGH,CAAC,KAAK,GAAG,IAAI,CAAA;gBAEd,OAAO,IAAI,CAAA;YACf,CAAC,CAAA;QACL,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;gBAE9B,OAAM;YACV,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YAE3B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACzF,CAAC;iBAAM,CAAC;gBACJ,qCAAqC;gBACrC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,KAAgB,CAAC,MAAM,CAAC,CAAA;YAC5E,CAAC;QACL,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE9E,OAAO,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;YACrC,IAAI,CAAC,CAAC;gBAAE,OAAO,KAAK,CACnB;YACG,KAGH,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAE1B,OAAO,IAAI,CAAA;QACf,CAAC,CAAA;IACL,CAAC;CACJ;AA7KD,kDA6KC","sourcesContent":["import { CallbackQuery, MaybeArray, MaybePromise, MtArgumentError } from '@mtcute/core'\n\nimport { UpdateFilter } from './filters/types.js'\n\n/**\n * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).\n *\n * This can be used to simplify management of different callbacks.\n *\n * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)\n */\nexport class CallbackDataBuilder<T extends string> {\n    private readonly _fields: T[]\n\n    sep = ':'\n\n    /**\n     * @param prefix  Prefix for the data. Use something unique across your bot.\n     * @param fields  Field names in the order they will be serialized.\n     */\n    constructor(\n        public prefix: string,\n        ...fields: T[]\n    ) {\n        this._fields = fields\n    }\n\n    /**\n     * Build a callback data string\n     *\n     * @param obj  Object containing the data\n     */\n    build(obj: Record<T, string>): string {\n        const ret =\n            this.prefix +\n            this.sep +\n            this._fields\n                .map((f) => {\n                    const val = obj[f]\n\n                    if (val.includes(this.sep)) {\n                        throw new MtArgumentError(\n                            `Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`,\n                        )\n                    }\n\n                    return val\n                })\n                .join(this.sep)\n\n        if (ret.length > 64) {\n            throw new MtArgumentError('Resulting callback data is too long.')\n        }\n\n        return ret\n    }\n\n    /**\n     * Parse callback data to object\n     *\n     * @param data  Callback data as string\n     */\n    parse(data: string): Record<T, string> {\n        const parts = data.split(this.sep)\n\n        if (parts[0] !== this.prefix) {\n            throw new MtArgumentError('Invalid data passed')\n        }\n\n        if (parts.length !== this._fields.length + 1) {\n            throw new MtArgumentError('Invalid data passed')\n        }\n\n        const ret = {} as Record<T, string>\n        parts.forEach((it, idx) => {\n            if (idx === 0) return // skip prefix\n\n            ret[this._fields[idx - 1]] = it\n        })\n\n        return ret\n    }\n\n    /**\n     * Create a filter for this callback data.\n     *\n     * You can either pass an object with field names as keys and values as strings or regexes,\n     * which will be compiled to a RegExp, or a function that will be called with the parsed data.\n     * Note that the strings will be passed to `RegExp` **directly**, so you may want to escape them.\n     *\n     * When using a function, you can either return a boolean, or an object with field names as keys\n     * and values as strings or regexes. In the latter case, the resulting object will be matched\n     * against the parsed data the same way as if you passed it directly.\n     *\n     * @param params\n     */\n    filter(\n        params:\n            | ((\n                  upd: CallbackQuery,\n                  parsed: Record<T, string>,\n              ) => MaybePromise<Partial<Record<T, MaybeArray<string | RegExp>>> | boolean>)\n            | Partial<Record<T, MaybeArray<string | RegExp>>> = {},\n    ): UpdateFilter<\n        CallbackQuery,\n        {\n            match: Record<T, string>\n        }\n    > {\n        if (typeof params === 'function') {\n            return async (query) => {\n                if (!query.dataStr) return false\n\n                const data = this.parse(query.dataStr)\n                const fnResult = await params(query, data)\n\n                if (typeof fnResult === 'boolean') {\n                    (\n                        query as CallbackQuery & {\n                            match: Record<T, string>\n                        }\n                    ).match = data\n\n                    return fnResult\n                }\n\n                // validate result\n                for (const key in fnResult) {\n                    const value = data[key]\n                    if (value === undefined) return false\n\n                    let matchers = fnResult[key] as MaybeArray<string | RegExp>\n                    if (!Array.isArray(matchers)) matchers = [matchers]\n\n                    for (const matcher of matchers) {\n                        if (typeof matcher === 'string') {\n                            if (value !== matcher) return false\n                        } else if (!matcher.test(value)) return false\n                    }\n                }\n\n                (\n                    query as CallbackQuery & {\n                        match: Record<T, string>\n                    }\n                ).match = data\n\n                return true\n            }\n        }\n\n        const parts: string[] = []\n\n        this._fields.forEach((field) => {\n            if (!(field in params)) {\n                parts.push(`[^${this.sep}]*?`)\n\n                return\n            }\n\n            const value = params[field]\n\n            if (Array.isArray(value)) {\n                parts.push(`(${value.map((i) => (typeof i === 'string' ? i : i.source)).join('|')})`)\n            } else {\n                // noinspection SuspiciousTypeOfGuard\n                parts.push(typeof value === 'string' ? value : (value as RegExp).source)\n            }\n        })\n\n        const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`)\n\n        return (query) => {\n            const m = query.dataStr?.match(regex)\n            if (!m) return false\n            ;(\n                query as CallbackQuery & {\n                    match: Record<T, string>\n                }\n            ).match = this.parse(m[0])\n\n            return true\n        }\n    }\n}\n"]}
+{"version":3,"file":"callback-data-builder.js","sourceRoot":"","sources":["../../src/callback-data-builder.ts"],"names":[],"mappings":";;;AAAA,uCAAuF;AAIvF;;;;;;GAMG;AACH,MAAa,mBAAmB;IAUjB;IATM,OAAO,CAAK;IAE7B,GAAG,GAAG,GAAG,CAAA;IAET;;;OAGG;IACH,YACW,MAAc,EACrB,GAAG,MAAW;QADP,WAAM,GAAN,MAAM,CAAQ;QAGrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAsB;QACxB,MAAM,GAAG,GACL,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,GAAG;YACR,IAAI,CAAC,OAAO;iBACP,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACP,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;gBAElB,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,MAAM,IAAI,sBAAe,CACrB,aAAa,CAAC,IAAI,GAAG,uBAAuB,IAAI,CAAC,GAAG,sBAAsB,CAC7E,CAAA;gBACL,CAAC;gBAED,OAAO,GAAG,CAAA;YACd,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvB,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAClB,MAAM,IAAI,sBAAe,CAAC,sCAAsC,CAAC,CAAA;QACrE,CAAC;QAED,OAAO,GAAG,CAAA;IACd,CAAC;IAUD,KAAK,CAAC,IAAY,EAAE,IAAI,GAAG,KAAK;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAElC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YACrB,MAAM,IAAI,sBAAe,CACrB,yBAAyB,IAAI,2BAA2B,IAAI,CAAC,MAAM,SAAS,KAAK,CAAC,CAAC,CAAC,GAAG,CAC1F,CAAA;QACL,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YACrB,MAAM,IAAI,sBAAe,CACrB,yBAAyB,IAAI,gCAAgC,IAAI,CAAC,OAAO,CAAC,MAAM,SAC5E,KAAK,CAAC,MAAM,GAAG,CACnB,GAAG,CACN,CAAA;QACL,CAAC;QAED,MAAM,GAAG,GAAG,EAAuB,CAAA;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE;YACtB,IAAI,GAAG,KAAK,CAAC;gBAAE,OAAM,CAAC,cAAc;YAEpC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QACnC,CAAC,CAAC,CAAA;QAEF,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACF,SAKwD,EAAE;QAO1D,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;gBACnB,IAAI,CAAC,KAAK,CAAC,OAAO;oBAAE,OAAO,KAAK,CAAA;gBAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5C,IAAI,CAAC,IAAI;oBAAE,OAAO,KAAK,CAAA;gBAEvB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;gBAE1C,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAE5B,KAGH,CAAC,KAAK,GAAG,IAAI,CAAA;oBAEd,OAAO,QAAQ,CAAA;gBACnB,CAAC;gBAED,kBAAkB;gBAClB,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;oBACzB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;oBACvB,IAAI,KAAK,KAAK,SAAS;wBAAE,OAAO,KAAK,CAAA;oBAErC,IAAI,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAgC,CAAA;oBAC3D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;wBAAE,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAA;oBAEnD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC7B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;4BAC9B,IAAI,KAAK,KAAK,OAAO;gCAAE,OAAO,KAAK,CAAA;wBACvC,CAAC;6BAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;4BAAE,OAAO,KAAK,CAAA;oBACjD,CAAC;gBACL,CAAC;gBAGG,KAGH,CAAC,KAAK,GAAG,IAAI,CAAA;gBAEd,OAAO,IAAI,CAAA;YACf,CAAC,CAAA;QACL,CAAC;QAED,MAAM,KAAK,GAAa,EAAE,CAAA;QAE1B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;gBAE9B,OAAM;YACV,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YAE3B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACzF,CAAC;iBAAM,CAAC;gBACJ,qCAAqC;gBACrC,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,KAAgB,CAAC,MAAM,CAAC,CAAA;YAC5E,CAAC;QACL,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE9E,OAAO,CAAC,KAAK,EAAE,EAAE;YACb,MAAM,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;YACrC,IAAI,CAAC,CAAC;gBAAE,OAAO,KAAK,CACnB;YACG,KAGH,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAE1B,OAAO,IAAI,CAAA;QACf,CAAC,CAAA;IACL,CAAC;CACJ;AA1LD,kDA0LC","sourcesContent":["import { CallbackQuery, MaybeArray, MaybePromise, MtArgumentError } from '@mtcute/core'\n\nimport { UpdateFilter } from './filters/types.js'\n\n/**\n * Callback data builder, inspired by [aiogram](https://github.com/aiogram/aiogram).\n *\n * This can be used to simplify management of different callbacks.\n *\n * [Learn more in the docs](/guide/topics/keyboards.html#callback-data-builders)\n */\nexport class CallbackDataBuilder<T extends string> {\n    private readonly _fields: T[]\n\n    sep = ':'\n\n    /**\n     * @param prefix  Prefix for the data. Use something unique across your bot.\n     * @param fields  Field names in the order they will be serialized.\n     */\n    constructor(\n        public prefix: string,\n        ...fields: T[]\n    ) {\n        this._fields = fields\n    }\n\n    /**\n     * Build a callback data string\n     *\n     * @param obj  Object containing the data\n     */\n    build(obj: Record<T, string>): string {\n        const ret =\n            this.prefix +\n            this.sep +\n            this._fields\n                .map((f) => {\n                    const val = obj[f]\n\n                    if (val.includes(this.sep)) {\n                        throw new MtArgumentError(\n                            `Value for ${f} ${val} contains separator ${this.sep} and cannot be used.`,\n                        )\n                    }\n\n                    return val\n                })\n                .join(this.sep)\n\n        if (ret.length > 64) {\n            throw new MtArgumentError('Resulting callback data is too long.')\n        }\n\n        return ret\n    }\n\n    /**\n     * Parse callback data to object\n     *\n     * @param data  Callback data as string\n     * @param safe  If `true`, will return `null` instead of throwing on invalid data\n     */\n    parse(data: string, safe?: false): Record<T, string>\n    parse(data: string, safe: true): Record<T, string> | null\n    parse(data: string, safe = false): Record<T, string> | null {\n        const parts = data.split(this.sep)\n\n        if (parts[0] !== this.prefix) {\n            if (safe) return null\n            throw new MtArgumentError(\n                `Invalid data passed: \"${data}\" (bad prefix, expected ${this.prefix}, got ${parts[0]})`,\n            )\n        }\n\n        if (parts.length !== this._fields.length + 1) {\n            if (safe) return null\n            throw new MtArgumentError(\n                `Invalid data passed: \"${data}\" (bad parts count, expected ${this._fields.length}, got ${\n                    parts.length - 1\n                })`,\n            )\n        }\n\n        const ret = {} as Record<T, string>\n        parts.forEach((it, idx) => {\n            if (idx === 0) return // skip prefix\n\n            ret[this._fields[idx - 1]] = it\n        })\n\n        return ret\n    }\n\n    /**\n     * Create a filter for this callback data.\n     *\n     * You can either pass an object with field names as keys and values as strings or regexes,\n     * which will be compiled to a RegExp, or a function that will be called with the parsed data.\n     * Note that the strings will be passed to `RegExp` **directly**, so you may want to escape them.\n     *\n     * When using a function, you can either return a boolean, or an object with field names as keys\n     * and values as strings or regexes. In the latter case, the resulting object will be matched\n     * against the parsed data the same way as if you passed it directly.\n     *\n     * @param params\n     */\n    filter(\n        params:\n            | ((\n                  upd: CallbackQuery,\n                  parsed: Record<T, string>,\n              ) => MaybePromise<Partial<Record<T, MaybeArray<string | RegExp>>> | boolean>)\n            | Partial<Record<T, MaybeArray<string | RegExp>>> = {},\n    ): UpdateFilter<\n        CallbackQuery,\n        {\n            match: Record<T, string>\n        }\n    > {\n        if (typeof params === 'function') {\n            return async (query) => {\n                if (!query.dataStr) return false\n\n                const data = this.parse(query.dataStr, true)\n                if (!data) return false\n\n                const fnResult = await params(query, data)\n\n                if (typeof fnResult === 'boolean') {\n                    (\n                        query as CallbackQuery & {\n                            match: Record<T, string>\n                        }\n                    ).match = data\n\n                    return fnResult\n                }\n\n                // validate result\n                for (const key in fnResult) {\n                    const value = data[key]\n                    if (value === undefined) return false\n\n                    let matchers = fnResult[key] as MaybeArray<string | RegExp>\n                    if (!Array.isArray(matchers)) matchers = [matchers]\n\n                    for (const matcher of matchers) {\n                        if (typeof matcher === 'string') {\n                            if (value !== matcher) return false\n                        } else if (!matcher.test(value)) return false\n                    }\n                }\n\n                (\n                    query as CallbackQuery & {\n                        match: Record<T, string>\n                    }\n                ).match = data\n\n                return true\n            }\n        }\n\n        const parts: string[] = []\n\n        this._fields.forEach((field) => {\n            if (!(field in params)) {\n                parts.push(`[^${this.sep}]*?`)\n\n                return\n            }\n\n            const value = params[field]\n\n            if (Array.isArray(value)) {\n                parts.push(`(${value.map((i) => (typeof i === 'string' ? i : i.source)).join('|')})`)\n            } else {\n                // noinspection SuspiciousTypeOfGuard\n                parts.push(typeof value === 'string' ? value : (value as RegExp).source)\n            }\n        })\n\n        const regex = new RegExp(`^${this.prefix}${this.sep}${parts.join(this.sep)}$`)\n\n        return (query) => {\n            const m = query.dataStr?.match(regex)\n            if (!m) return false\n            ;(\n                query as CallbackQuery & {\n                    match: Record<T, string>\n                }\n            ).match = this.parse(m[0])\n\n            return true\n        }\n    }\n}\n"]}

package/cjs/context/scene-transition.d.ts

@@ -0,0 +1,24 @@
+import { BusinessMessageContext } from './business-message.js';
+import { CallbackQueryContext, InlineCallbackQueryContext } from './callback-query.js';
+import { MessageContext } from './message.js';
+import { UpdateContextType } from './parse.js';
+/** Update which is dispatched whenever scene is entered or exited */
+export declare class SceneTransitionContext {
+    /** Name of the previous scene, if any */
+    readonly previousScene: string | null;
+    /** Update, handler for which triggered the transition */
+    readonly update: UpdateContextType;
+    constructor(
+    /** Name of the previous scene, if any */
+    previousScene: string | null, 
+    /** Update, handler for which triggered the transition */
+    update: UpdateContextType);
+    /** Get {@link update}, asserting it is a message-related update */
+    get message(): MessageContext;
+    /** Get {@link update}, asserting it is a business message-related update */
+    get businessMessage(): BusinessMessageContext;
+    /** Get {@link update}, asserting it is a callback query update */
+    get callbackQuery(): CallbackQueryContext;
+    /** Get {@link update}, asserting it is an inline callback query update */
+    get inlineCallbackQuery(): InlineCallbackQueryContext;
+}

package/cjs/context/scene-transition.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneTransitionContext = void 0;
+const core_1 = require("@mtcute/core");
+const utils_js_1 = require("@mtcute/core/utils.js");
+const business_message_js_1 = require("./business-message.js");
+const callback_query_js_1 = require("./callback-query.js");
+const message_js_1 = require("./message.js");
+/** Update which is dispatched whenever scene is entered or exited */
+class SceneTransitionContext {
+    previousScene;
+    update;
+    constructor(
+    /** Name of the previous scene, if any */
+    previousScene, 
+    /** Update, handler for which triggered the transition */
+    update) {
+        this.previousScene = previousScene;
+        this.update = update;
+    }
+    /** Get {@link update}, asserting it is a message-related update */
+    get message() {
+        if (this.update instanceof message_js_1.MessageContext) {
+            return this.update;
+        }
+        throw new core_1.MtTypeAssertionError('SceneTransitionContext.message', 'message', this.update._name);
+    }
+    /** Get {@link update}, asserting it is a business message-related update */
+    get businessMessage() {
+        if (this.update instanceof business_message_js_1.BusinessMessageContext) {
+            return this.update;
+        }
+        throw new core_1.MtTypeAssertionError('SceneTransitionContext.businessMessage', 'business message', this.update._name);
+    }
+    /** Get {@link update}, asserting it is a callback query update */
+    get callbackQuery() {
+        if (this.update instanceof callback_query_js_1.CallbackQueryContext) {
+            return this.update;
+        }
+        throw new core_1.MtTypeAssertionError('SceneTransitionContext.callbackQuery', 'callback query', this.update._name);
+    }
+    /** Get {@link update}, asserting it is an inline callback query update */
+    get inlineCallbackQuery() {
+        if (this.update instanceof callback_query_js_1.InlineCallbackQueryContext) {
+            return this.update;
+        }
+        throw new core_1.MtTypeAssertionError('SceneTransitionContext.inlineCallbackQuery', 'inline callback query', this.update._name);
+    }
+}
+exports.SceneTransitionContext = SceneTransitionContext;
+(0, utils_js_1.makeInspectable)(SceneTransitionContext);
+//# sourceMappingURL=scene-transition.js.map

package/cjs/context/scene-transition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scene-transition.js","sourceRoot":"","sources":["../../../src/context/scene-transition.ts"],"names":[],"mappings":";;;AAAA,uCAAmD;AACnD,oDAAuD;AAEvD,+DAA8D;AAC9D,2DAAsF;AACtF,6CAA6C;AAG7C,qEAAqE;AACrE,MAAa,sBAAsB;IAGlB;IAEA;IAJb;IACI,yCAAyC;IAChC,aAA4B;IACrC,yDAAyD;IAChD,MAAyB;QAFzB,kBAAa,GAAb,aAAa,CAAe;QAE5B,WAAM,GAAN,MAAM,CAAmB;IACnC,CAAC;IAEJ,mEAAmE;IACnE,IAAI,OAAO;QACP,IAAI,IAAI,CAAC,MAAM,YAAY,2BAAc,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,MAAM,CAAA;QACtB,CAAC;QAED,MAAM,IAAI,2BAAoB,CAAC,gCAAgC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAClG,CAAC;IAED,4EAA4E;IAC5E,IAAI,eAAe;QACf,IAAI,IAAI,CAAC,MAAM,YAAY,4CAAsB,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC,MAAM,CAAA;QACtB,CAAC;QAED,MAAM,IAAI,2BAAoB,CAAC,wCAAwC,EAAE,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnH,CAAC;IAED,kEAAkE;IAClE,IAAI,aAAa;QACb,IAAI,IAAI,CAAC,MAAM,YAAY,wCAAoB,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAA;QACtB,CAAC;QAED,MAAM,IAAI,2BAAoB,CAAC,sCAAsC,EAAE,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/G,CAAC;IAED,0EAA0E;IAC1E,IAAI,mBAAmB;QACnB,IAAI,IAAI,CAAC,MAAM,YAAY,8CAA0B,EAAE,CAAC;YACpD,OAAO,IAAI,CAAC,MAAM,CAAA;QACtB,CAAC;QAED,MAAM,IAAI,2BAAoB,CAC1B,4CAA4C,EAC5C,uBAAuB,EACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CACpB,CAAA;IACL,CAAC;CACJ;AA/CD,wDA+CC;AAED,IAAA,0BAAe,EAAC,sBAAsB,CAAC,CAAA","sourcesContent":["import { MtTypeAssertionError } from '@mtcute/core'\nimport { makeInspectable } from '@mtcute/core/utils.js'\n\nimport { BusinessMessageContext } from './business-message.js'\nimport { CallbackQueryContext, InlineCallbackQueryContext } from './callback-query.js'\nimport { MessageContext } from './message.js'\nimport { UpdateContextType } from './parse.js'\n\n/** Update which is dispatched whenever scene is entered or exited */\nexport class SceneTransitionContext {\n    constructor(\n        /** Name of the previous scene, if any */\n        readonly previousScene: string | null,\n        /** Update, handler for which triggered the transition */\n        readonly update: UpdateContextType,\n    ) {}\n\n    /** Get {@link update}, asserting it is a message-related update */\n    get message(): MessageContext {\n        if (this.update instanceof MessageContext) {\n            return this.update\n        }\n\n        throw new MtTypeAssertionError('SceneTransitionContext.message', 'message', this.update._name)\n    }\n\n    /** Get {@link update}, asserting it is a business message-related update */\n    get businessMessage(): BusinessMessageContext {\n        if (this.update instanceof BusinessMessageContext) {\n            return this.update\n        }\n\n        throw new MtTypeAssertionError('SceneTransitionContext.businessMessage', 'business message', this.update._name)\n    }\n\n    /** Get {@link update}, asserting it is a callback query update */\n    get callbackQuery(): CallbackQueryContext {\n        if (this.update instanceof CallbackQueryContext) {\n            return this.update\n        }\n\n        throw new MtTypeAssertionError('SceneTransitionContext.callbackQuery', 'callback query', this.update._name)\n    }\n\n    /** Get {@link update}, asserting it is an inline callback query update */\n    get inlineCallbackQuery(): InlineCallbackQueryContext {\n        if (this.update instanceof InlineCallbackQueryContext) {\n            return this.update\n        }\n\n        throw new MtTypeAssertionError(\n            'SceneTransitionContext.inlineCallbackQuery',\n            'inline callback query',\n            this.update._name,\n        )\n    }\n}\n\nmakeInspectable(SceneTransitionContext)\n"]}

package/cjs/dispatcher.d.ts

@@ -3,6 +3,7 @@ import { TelegramClient } from '@mtcute/core/client.js';
 import { UpdateContext } from './context/base.js';
 import { BusinessMessageContext } from './context/business-message.js';
 import { CallbackQueryContext, ChatJoinRequestUpdateContext, ChosenInlineResultContext, InlineCallbackQueryContext, InlineQueryContext, MessageContext, PreCheckoutQueryContext } from './context/index.js';
+import { SceneTransitionContext } from './context/scene-transition.js';
 import { filters, UpdateFilter } from './filters/index.js';
 import { BotChatJoinRequestHandler, BotReactionCountUpdateHandler, BotReactionUpdateHandler, BotStoppedHandler, BusinessConnectionUpdateHandler, BusinessMessageGroupHandler, CallbackQueryHandler, ChatJoinRequestHandler, ChatMemberUpdateHandler, ChosenInlineResultHandler, DeleteBusinessMessageHandler, DeleteMessageHandler, DeleteStoryHandler, EditBusinessMessageHandler, EditMessageHandler, HistoryReadHandler, InlineCallbackQueryHandler, InlineQueryHandler, MessageGroupHandler, NewBusinessMessageHandler, NewMessageHandler, PollUpdateHandler, PollVoteHandler, PreCheckoutQueryHandler, RawUpdateHandler, StoryUpdateHandler, UpdateHandler, UserStatusUpdateHandler, UserTypingHandler } from './handler.js';
 import { PropagationAction } from './propagation.js';
@@ -47,11 +48,14 @@ export declare class Dispatcher<State extends object = never> {
     private _errorHandler?;
     private _preUpdateHandler?;
     private _postUpdateHandler?;
+    private _sceneTransitionHandler?;
     protected constructor(client?: TelegramClient, params?: DispatcherParams);
     /**
      * Create a new dispatcher and bind it to the client.
      */
-    static for<State extends object = never>(client: TelegramClient, params?: DispatcherParams): Dispatcher<State>;
+    static for<State extends object = never>(client: TelegramClient, ...args: [State] extends [never] ? [params?: DispatcherParams] : [params: DispatcherParams & {
+        storage: IStateStorageProvider;
+    }]): Dispatcher<State>;
     /**
      * Create a new child dispatcher.
      */
@@ -340,6 +344,24 @@ export declare class Dispatcher<State extends object = never> {
      * @param group  Handler group index
      */
     onRawUpdate(filter: RawUpdateHandler['check'], handler: RawUpdateHandler['callback'], group?: number): void;
+    /**
+     * Register a scene transition handler
+     *
+     * This handler is called whenever a scene transition occurs
+     * in the context of the scene that is being entered,
+     * and before any of the its own handlers are called,
+     * and can be used to customize the transition behavior:
+     *   - `Stop` to prevent dispatching the update any further **even if ToScene/ToRoot was used**
+     *   - `Continue` same as Stop, but still dispatch the update to children
+     *   - `ToScene` to prevent the transition and dispatch the update to the scene entered in the transition handler
+     *
+     * > **Note**: if multiple `state.enter()` calls were made within the same update,
+     * > this handler will only be called for the last one.
+     *
+     * @param handler  Raw update handler
+     * @param group  Handler group index
+     */
+    onSceneTransition(handler: ((ctx: SceneTransitionContext, state: UpdateState<State>) => MaybePromise<PropagationAction | void>) | null): void;
     /**
      * Register a new message handler without any filters
      *

package/cjs/dispatcher.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dispatcher = void 0;
 const core_1 = require("@mtcute/core");
 const parse_js_1 = require("./context/parse.js");
+const scene_transition_js_1 = require("./context/scene-transition.js");
 const index_js_1 = require("./state/index.js");
 const service_js_1 = require("./state/service.js");
 /**
@@ -29,6 +30,7 @@ class Dispatcher {
     _errorHandler;
     _preUpdateHandler;
     _postUpdateHandler;
+    _sceneTransitionHandler;
     constructor(client, params) {
         this.dispatchRawUpdate = this.dispatchRawUpdate.bind(this);
         this.dispatchUpdate = this.dispatchUpdate.bind(this);
@@ -57,9 +59,6 @@ class Dispatcher {
             }
         }
     }
-    /**
-     * Create a new dispatcher and bind it to the client.
-     */
     static for(client, params) {
         return new Dispatcher(client, params);
     }
@@ -245,7 +244,10 @@ class Dispatcher {
                 (update.name === 'new_message' ||
                     update.name === 'edit_message' ||
                     update.name === 'callback_query' ||
-                    update.name === 'message_group')) {
+                    update.name === 'message_group' ||
+                    update.name === 'new_business_message' ||
+                    update.name === 'edit_business_message' ||
+                    update.name === 'business_message_group')) {
                 // no need to fetch scene if there are no registered scenes
                 if (!parsedContext)
                     parsedContext = (0, parse_js_1._parsedUpdateToContext)(this._client, update);
@@ -281,7 +283,10 @@ class Dispatcher {
                 (update.name === 'new_message' ||
                     update.name === 'edit_message' ||
                     update.name === 'callback_query' ||
-                    update.name === 'message_group')) {
+                    update.name === 'message_group' ||
+                    update.name === 'new_business_message' ||
+                    update.name === 'edit_business_message' ||
+                    update.name === 'business_message_group')) {
                 if (!parsedContext)
                     parsedContext = (0, parse_js_1._parsedUpdateToContext)(this._client, update);
                 const key = await this._stateKeyDelegate(parsedContext);
@@ -327,6 +332,31 @@ class Dispatcher {
                             }
                             else
                                 continue;
+                            if (parsedState && this._scenes) {
+                                // check if scene transition was made
+                                const newScene = parsedState.scene;
+                                if (parsedScene !== newScene) {
+                                    const nextDp = newScene ? this._scenes.get(newScene) : this._parent;
+                                    if (!nextDp) {
+                                        throw new core_1.MtArgumentError(`Scene ${newScene} not found`);
+                                    }
+                                    if (nextDp._sceneTransitionHandler) {
+                                        const transition = new scene_transition_js_1.SceneTransitionContext(parsedScene, parsedContext);
+                                        const transitionResult = await nextDp._sceneTransitionHandler?.(transition, parsedState);
+                                        switch (transitionResult) {
+                                            case 'stop':
+                                                return true;
+                                            case 'continue':
+                                                continue;
+                                            case 'scene': {
+                                                const scene = parsedState.scene;
+                                                const dp = scene ? nextDp._scenes.get(scene) : nextDp._parent;
+                                                return dp._dispatchUpdateNowImpl(update, undefined, scene, true);
+                                            }
+                                        }
+                                    }
+                                }
+                            }
                             switch (result) {
                                 case 'continue':
                                     continue;
@@ -339,11 +369,9 @@ class Dispatcher {
                                     if (!parsedState) {
                                         throw new core_1.MtArgumentError('Cannot use ToScene without state');
                                     }
-                                    const scene = parsedState['_scene'];
-                                    if (!scene) {
-                                        throw new core_1.MtArgumentError('Cannot use ToScene without entering a scene');
-                                    }
-                                    return this._scenes.get(scene)._dispatchUpdateNowImpl(update, undefined, scene, true);
+                                    const scene = parsedState.scene;
+                                    const dp = scene ? this._scenes.get(scene) : this._parent;
+                                    return dp._dispatchUpdateNowImpl(update, undefined, scene, true);
                                 }
                             }
                             break;
@@ -513,6 +541,7 @@ class Dispatcher {
         child._client = this._client;
         child._storage = this._storage;
         child._deps = this._deps;
+        child._scenes = this._scenes;
         child._stateKeyDelegate = this._stateKeyDelegate;
         child._customStorage ??= this._customStorage;
         child._customStateKeyDelegate ??= this._customStateKeyDelegate;
@@ -730,6 +759,29 @@ class Dispatcher {
     onRawUpdate(filter, handler, group) {
         this._addKnownHandler('raw', filter, handler, group);
     }
+    /**
+     * Register a scene transition handler
+     *
+     * This handler is called whenever a scene transition occurs
+     * in the context of the scene that is being entered,
+     * and before any of the its own handlers are called,
+     * and can be used to customize the transition behavior:
+     *   - `Stop` to prevent dispatching the update any further **even if ToScene/ToRoot was used**
+     *   - `Continue` same as Stop, but still dispatch the update to children
+     *   - `ToScene` to prevent the transition and dispatch the update to the scene entered in the transition handler
+     *
+     * > **Note**: if multiple `state.enter()` calls were made within the same update,
+     * > this handler will only be called for the last one.
+     *
+     * @param handler  Raw update handler
+     * @param group  Handler group index
+     */
+    onSceneTransition(handler) {
+        if (handler)
+            this._sceneTransitionHandler = handler;
+        else
+            this._sceneTransitionHandler = undefined;
+    }
     /** @internal */
     onNewMessage(filter, handler, group) {
         this._addKnownHandler('new_message', filter, handler, group);