@mtcute/dispatcher 0.12.3 → 0.12.4

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/esm/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/esm/callback-data-builder.js

@@ -40,18 +40,17 @@ export 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 MtArgumentError('Invalid data passed');
+            if (safe)
+                return null;
+            throw new MtArgumentError(`Invalid data passed: "${data}" (bad prefix, expected ${this.prefix}, got ${parts[0]})`);
         }
         if (parts.length !== this._fields.length + 1) {
-            throw new MtArgumentError('Invalid data passed');
+            if (safe)
+                return null;
+            throw new MtArgumentError(`Invalid data passed: "${data}" (bad parts count, expected ${this._fields.length}, got ${parts.length - 1})`);
         }
         const ret = {};
         parts.forEach((it, idx) => {
@@ -79,7 +78,9 @@ export 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/esm/callback-data-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"callback-data-builder.js","sourceRoot":"","sources":["../../src/callback-data-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2C,eAAe,EAAE,MAAM,cAAc,CAAA;AAIvF;;;;;;GAMG;AACH,MAAM,OAAO,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,eAAe,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,eAAe,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,eAAe,CAAC,qBAAqB,CAAC,CAAA;QACpD,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,eAAe,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","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,OAAO,EAA2C,eAAe,EAAE,MAAM,cAAc,CAAA;AAIvF;;;;;;GAMG;AACH,MAAM,OAAO,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,eAAe,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,eAAe,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,eAAe,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,eAAe,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","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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mtcute/dispatcher",
-  "version": "0.12.3",
+  "version": "0.12.4",
   "description": "Updates dispatcher and bot framework for @mtcute/client",
   "author": "alina sireneva <alina@tei.su>",
   "license": "MIT",