@mtcute/dispatcher 0.16.7 → 0.16.13

package/esm/state/update-state.js

@@ -1,214 +0,0 @@
-import { MtArgumentError, MtcuteError } from '@mtcute/core';
-import { sleep } from '@mtcute/core/utils.js';
-/**
- * Error thrown by `.rateLimit()`
- */
-export class RateLimitError extends MtcuteError {
-    reset;
-    constructor(reset) {
-        super('You are being rate limited.');
-        this.reset = reset;
-    }
-}
-/**
- * State of the current update.
- *
- * @template State  Type that represents the state
- * @template SceneName  Possible scene names
- */
-export class UpdateState {
-    _key;
-    _localKey;
-    _storage;
-    _scene;
-    _scoped;
-    _cached;
-    _localStorage;
-    _localKeyBase;
-    constructor(storage, key, scene, scoped, customStorage, customKey) {
-        this._storage = storage;
-        this._key = key;
-        this._scene = scene;
-        this._scoped = scoped;
-        this._localStorage = customStorage ?? storage;
-        this._localKeyBase = customKey ?? key;
-        this._updateLocalKey();
-    }
-    /** Name of the current scene */
-    get scene() {
-        return this._scene;
-    }
-    _updateLocalKey() {
-        if (!this._scoped) {
-            this._localKey = this._localKeyBase;
-        }
-        else {
-            this._localKey = this._scene ? `${this._scene}_${this._localKeyBase}` : this._localKeyBase;
-        }
-    }
-    async get(fallback, force) {
-        if (typeof fallback === 'boolean') {
-            force = fallback;
-            fallback = undefined;
-        }
-        if (!force && this._cached !== undefined) {
-            if (!this._cached && fallback) {
-                return typeof fallback === 'function' ? fallback() : fallback;
-            }
-            return this._cached;
-        }
-        let res = (await this._localStorage.getState(this._localKey));
-        if (!res && fallback) {
-            res = typeof fallback === 'function' ? fallback() : fallback;
-        }
-        this._cached = res;
-        return res;
-    }
-    /**
-     * Set new state to the storage
-     *
-     * @param state  New state
-     * @param ttl  TTL for the new state (in seconds)
-     */
-    async set(state, ttl) {
-        this._cached = state;
-        await this._localStorage.setState(this._localKey, state, ttl);
-    }
-    /**
-     * Merge the given object to the current state.
-     *
-     * > **Note**: If the storage currently has no state,
-     * > then `fallback` must be provided.
-     *
-     * Basically a shorthand to calling `.get()`,
-     * modifying and then calling `.set()`
-     *
-     * @param state  State to be merged
-     * @param fallback  Default state
-     * @param ttl  TTL for the new state (in seconds)
-     * @param forceLoad  Whether to force load the old state from storage
-     */
-    async merge(state, params = {}) {
-        const { fallback, ttl, forceLoad } = params;
-        const old = await this.get(forceLoad);
-        if (!old) {
-            if (!fallback) {
-                throw new MtArgumentError('Cannot use merge on empty state without fallback.');
-            }
-            const fallback_ = typeof fallback === 'function' ? fallback() : fallback;
-            await this.set({ ...fallback_, ...state }, ttl);
-        }
-        else {
-            await this.set({ ...old, ...state }, ttl);
-        }
-        // _cached is set by .set()
-        return this._cached;
-    }
-    /**
-     * Delete the state from the storage
-     */
-    async delete() {
-        this._cached = null;
-        await this._localStorage.deleteState(this._localKey);
-    }
-    /**
-     * Enter some scene
-     */
-    async enter(scene, params) {
-        const { with: with_, ttl, reset = true } = params ?? {};
-        if (reset && this._scoped)
-            await this.delete();
-        if (!scene['_scene']) {
-            throw new MtArgumentError('Cannot enter a non-scene Dispatcher');
-        }
-        if (!scene['_parent']) {
-            throw new MtArgumentError('This scene has not been registered');
-        }
-        this._scene = scene['_scene'];
-        this._scoped = scene['_sceneScoped'];
-        this._updateLocalKey();
-        await this._storage.setCurrentScene(this._key, this._scene, ttl);
-        if (with_) {
-            if (scene['_customStateKeyDelegate']) {
-                throw new MtArgumentError('Cannot use `with` parameter when the scene uses a custom state key delegate');
-            }
-            await scene.getState(this._key).set(with_, ttl);
-        }
-    }
-    /**
-     * Exit from current scene to the root
-     *
-     * @param reset
-     *     Whether to reset scene state (only applicable in case this is a scoped scene)
-     */
-    async exit(reset = true) {
-        if (reset && this._scoped)
-            await this.delete();
-        this._scene = null;
-        this._updateLocalKey();
-        await this._storage.deleteCurrentScene(this._key);
-    }
-    /**
-     * Rate limit some handler.
-     *
-     * When the rate limit exceeds, {@link RateLimitError} is thrown.
-     *
-     * This is a simple rate-limiting solution that uses
-     * the same key as the state. If you need something more
-     * sophisticated and/or customizable, you'll have to implement
-     * your own rate-limiter.
-     *
-     * > **Note**: `key` is used to prefix the local key
-     * > derived using the given key delegate.
-     *
-     * @param key  Key of the rate limit
-     * @param limit  Maximum number of requests in `window`
-     * @param window  Window size in seconds
-     * @returns  Tuple containing the number of remaining and
-     *   unix time in ms when the user can try again
-     */
-    async rateLimit(key, limit, window) {
-        const [remaining, reset] = await this._localStorage.getRateLimit(`${key}:${this._localKey}`, limit, window);
-        if (!remaining) {
-            throw new RateLimitError(reset);
-        }
-        return [remaining - 1, reset];
-    }
-    /**
-     * Throttle some handler.
-     *
-     * When the rate limit exceeds, this function waits for it to reset.
-     *
-     * This is a simple wrapper over {@link rateLimit}, and follows the same logic.
-     *
-     * > **Note**: `key` is used to prefix the local key
-     * > derived using the given key delegate.
-     *
-     * @param key  Key of the rate limit
-     * @param limit  Maximum number of requests in `window`
-     * @param window  Window size in seconds
-     * @returns  Tuple containing the number of remaining and
-     *   unix time in ms when the user can try again
-     */
-    async throttle(key, limit, window) {
-        try {
-            return await this.rateLimit(key, limit, window);
-        }
-        catch (e) {
-            if (e instanceof RateLimitError) {
-                await sleep(e.reset - Date.now());
-                return this.throttle(key, limit, window);
-            }
-            throw e;
-        }
-    }
-    /**
-     * Reset the rate limit
-     *
-     * @param key  Key of the rate limit
-     */
-    async resetRateLimit(key) {
-        await this._localStorage.resetRateLimit(`${key}:${this._localKey}`);
-    }
-}
-//# sourceMappingURL=update-state.js.map

package/esm/state/update-state.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"update-state.js","sourceRoot":"","sources":["../../../src/state/update-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAM7C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IACtB;IAArB,YAAqB,KAAa;QAC9B,KAAK,CAAC,6BAA6B,CAAC,CAAA;QADnB,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IACZ,IAAI,CAAQ;IACZ,SAAS,CAAS;IAElB,QAAQ,CAAc;IAEtB,MAAM,CAAe;IACrB,OAAO,CAAU;IACjB,OAAO,CAAe;IAEtB,aAAa,CAAc;IAC3B,aAAa,CAAQ;IAE7B,YACI,OAAqB,EACrB,GAAW,EACX,KAAoB,EACpB,MAAgB,EAChB,aAA4B,EAC5B,SAAkB;QAElB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;QACf,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QAErB,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,OAAO,CAAA;QAC7C,IAAI,CAAC,aAAa,GAAG,SAAS,IAAI,GAAG,CAAA;QAErC,IAAI,CAAC,eAAe,EAAE,CAAA;IAC1B,CAAC;IAED,gCAAgC;IAChC,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAA;IACtB,CAAC;IAEO,eAAe;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAA;QACvC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAA;QAC9F,CAAC;IACL,CAAC;IAyBD,KAAK,CAAC,GAAG,CAAC,QAA0C,EAAE,KAAe;QACjE,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,KAAK,GAAG,QAAQ,CAAA;YAChB,QAAQ,GAAG,SAAS,CAAA;QACxB,CAAC;QAED,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC5B,OAAO,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;YACjE,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,CAAA;QACvB,CAAC;QAED,IAAI,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAiB,CAAA;QAE7E,IAAI,CAAC,GAAG,IAAI,QAAQ,EAAE,CAAC;YACnB,GAAG,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;QAChE,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,GAAG,CAAA;QAElB,OAAO,GAAG,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CAAC,KAAY,EAAE,GAAY;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;IACjE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAK,CACP,KAAqB,EACrB,SAII,EAAE;QAEN,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAA;QAE3C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAErC,IAAI,CAAC,GAAG,EAAE,CAAC;YACP,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,MAAM,IAAI,eAAe,CAAC,mDAAmD,CAAC,CAAA;YAClF,CAAC;YAED,MAAM,SAAS,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;YAExE,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,CAAC,CAAA;QACnD,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,CAAC,CAAA;QAC7C,CAAC;QAED,2BAA2B;QAE3B,OAAO,IAAI,CAAC,OAAQ,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACR,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACxD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CACP,KAAY,EACZ,MAiBC;QAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAA;QAEvD,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QAE9C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,eAAe,CAAC,qCAAqC,CAAC,CAAA;QACpE,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,eAAe,CAAC,oCAAoC,CAAC,CAAA;QACnE,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,cAAc,CAAC,CAAA;QACpC,IAAI,CAAC,eAAe,EAAE,CAAA;QAEtB,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAEhE,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,CAAC,yBAAyB,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAI,eAAe,CAAC,6EAA6E,CAAC,CAAA;YAC5G,CAAC;YAED,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QACnD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI;QACnB,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,eAAe,EAAE,CAAA;QACtB,MAAM,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,KAAa,EAAE,MAAc;QACtD,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;QAE3G,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;QAED,OAAO,CAAC,SAAS,GAAG,CAAC,EAAE,KAAK,CAAC,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,KAAa,EAAE,MAAc;QACrD,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;QACnD,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YAClB,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;gBAC9B,MAAM,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;gBAEjC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;YAC5C,CAAC;YAED,MAAM,CAAC,CAAA;QACX,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAAC,GAAW;QAC5B,MAAM,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;IACvE,CAAC;CACJ","sourcesContent":["import { MtArgumentError, MtcuteError } from '@mtcute/core'\nimport { sleep } from '@mtcute/core/utils.js'\n\nimport type { Dispatcher } from '../dispatcher.js'\n\nimport type { StateService } from './service.js'\n\n/**\n * Error thrown by `.rateLimit()`\n */\nexport class RateLimitError extends MtcuteError {\n    constructor(readonly reset: number) {\n        super('You are being rate limited.')\n    }\n}\n\n/**\n * State of the current update.\n *\n * @template State  Type that represents the state\n * @template SceneName  Possible scene names\n */\nexport class UpdateState<State extends object> {\n    private _key: string\n    private _localKey!: string\n\n    private _storage: StateService\n\n    private _scene: string | null\n    private _scoped?: boolean\n    private _cached?: State | null\n\n    private _localStorage: StateService\n    private _localKeyBase: string\n\n    constructor(\n        storage: StateService,\n        key: string,\n        scene: string | null,\n        scoped?: boolean,\n        customStorage?: StateService,\n        customKey?: string,\n    ) {\n        this._storage = storage\n        this._key = key\n        this._scene = scene\n        this._scoped = scoped\n\n        this._localStorage = customStorage ?? storage\n        this._localKeyBase = customKey ?? key\n\n        this._updateLocalKey()\n    }\n\n    /** Name of the current scene */\n    get scene(): string | null {\n        return this._scene\n    }\n\n    private _updateLocalKey(): void {\n        if (!this._scoped) {\n            this._localKey = this._localKeyBase\n        } else {\n            this._localKey = this._scene ? `${this._scene}_${this._localKeyBase}` : this._localKeyBase\n        }\n    }\n\n    /**\n     * Retrieve the state from the storage, falling back to default\n     * if not found\n     *\n     * @param fallback  Default state value\n     * @param force  Whether to ignore cached state (def. `false`)\n     */\n    async get(fallback: State | (() => State), force?: boolean): Promise<State>\n\n    /**\n     * Retrieve the state from the storage, falling back to default\n     * if not found\n     *\n     * @param fallback  Default state value\n     * @param force  Whether to ignore cached state (def. `false`)\n     */\n    async get(fallback?: State | (() => State), force?: boolean): Promise<State | null>\n    /**\n     * Retrieve the state from the storage\n     *\n     * @param force  Whether to ignore cached state (def. `false`)\n     */\n    async get(force?: boolean): Promise<State | null>\n    async get(fallback?: State | (() => State) | boolean, force?: boolean): Promise<State | null> {\n        if (typeof fallback === 'boolean') {\n            force = fallback\n            fallback = undefined\n        }\n\n        if (!force && this._cached !== undefined) {\n            if (!this._cached && fallback) {\n                return typeof fallback === 'function' ? fallback() : fallback\n            }\n\n            return this._cached\n        }\n\n        let res = (await this._localStorage.getState(this._localKey)) as State | null\n\n        if (!res && fallback) {\n            res = typeof fallback === 'function' ? fallback() : fallback\n        }\n        this._cached = res\n\n        return res\n    }\n\n    /**\n     * Set new state to the storage\n     *\n     * @param state  New state\n     * @param ttl  TTL for the new state (in seconds)\n     */\n    async set(state: State, ttl?: number): Promise<void> {\n        this._cached = state\n        await this._localStorage.setState(this._localKey, state, ttl)\n    }\n\n    /**\n     * Merge the given object to the current state.\n     *\n     * > **Note**: If the storage currently has no state,\n     * > then `fallback` must be provided.\n     *\n     * Basically a shorthand to calling `.get()`,\n     * modifying and then calling `.set()`\n     *\n     * @param state  State to be merged\n     * @param fallback  Default state\n     * @param ttl  TTL for the new state (in seconds)\n     * @param forceLoad  Whether to force load the old state from storage\n     */\n    async merge(\n        state: Partial<State>,\n        params: {\n            fallback?: State | (() => State)\n            ttl?: number\n            forceLoad?: boolean\n        } = {},\n    ): Promise<State> {\n        const { fallback, ttl, forceLoad } = params\n\n        const old = await this.get(forceLoad)\n\n        if (!old) {\n            if (!fallback) {\n                throw new MtArgumentError('Cannot use merge on empty state without fallback.')\n            }\n\n            const fallback_ = typeof fallback === 'function' ? fallback() : fallback\n\n            await this.set({ ...fallback_, ...state }, ttl)\n        } else {\n            await this.set({ ...old, ...state }, ttl)\n        }\n\n        // _cached is set by .set()\n\n        return this._cached!\n    }\n\n    /**\n     * Delete the state from the storage\n     */\n    async delete(): Promise<void> {\n        this._cached = null\n        await this._localStorage.deleteState(this._localKey)\n    }\n\n    /**\n     * Enter some scene\n     */\n    async enter<SceneState extends object, Scene extends Dispatcher<SceneState>>(\n        scene: Scene,\n        params?: {\n            /**\n             * Initial state for the scene\n             *\n             * Note that this will only work if the scene uses the same key delegate as this state.\n             */\n            with?: SceneState\n\n            /** TTL for the scene (in seconds) */\n            ttl?: number\n\n            /**\n             * If currently in a scoped scene, whether to reset the state\n             *\n             * @default  true\n             */\n            reset?: boolean\n        },\n    ): Promise<void> {\n        const { with: with_, ttl, reset = true } = params ?? {}\n\n        if (reset && this._scoped) await this.delete()\n\n        if (!scene['_scene']) {\n            throw new MtArgumentError('Cannot enter a non-scene Dispatcher')\n        }\n\n        if (!scene['_parent']) {\n            throw new MtArgumentError('This scene has not been registered')\n        }\n\n        this._scene = scene['_scene']\n        this._scoped = scene['_sceneScoped']\n        this._updateLocalKey()\n\n        await this._storage.setCurrentScene(this._key, this._scene, ttl)\n\n        if (with_) {\n            if (scene['_customStateKeyDelegate']) {\n                throw new MtArgumentError('Cannot use `with` parameter when the scene uses a custom state key delegate')\n            }\n\n            await scene.getState(this._key).set(with_, ttl)\n        }\n    }\n\n    /**\n     * Exit from current scene to the root\n     *\n     * @param reset\n     *     Whether to reset scene state (only applicable in case this is a scoped scene)\n     */\n    async exit(reset = true): Promise<void> {\n        if (reset && this._scoped) await this.delete()\n        this._scene = null\n        this._updateLocalKey()\n        await this._storage.deleteCurrentScene(this._key)\n    }\n\n    /**\n     * Rate limit some handler.\n     *\n     * When the rate limit exceeds, {@link RateLimitError} is thrown.\n     *\n     * This is a simple rate-limiting solution that uses\n     * the same key as the state. If you need something more\n     * sophisticated and/or customizable, you'll have to implement\n     * your own rate-limiter.\n     *\n     * > **Note**: `key` is used to prefix the local key\n     * > derived using the given key delegate.\n     *\n     * @param key  Key of the rate limit\n     * @param limit  Maximum number of requests in `window`\n     * @param window  Window size in seconds\n     * @returns  Tuple containing the number of remaining and\n     *   unix time in ms when the user can try again\n     */\n    async rateLimit(key: string, limit: number, window: number): Promise<[number, number]> {\n        const [remaining, reset] = await this._localStorage.getRateLimit(`${key}:${this._localKey}`, limit, window)\n\n        if (!remaining) {\n            throw new RateLimitError(reset)\n        }\n\n        return [remaining - 1, reset]\n    }\n\n    /**\n     * Throttle some handler.\n     *\n     * When the rate limit exceeds, this function waits for it to reset.\n     *\n     * This is a simple wrapper over {@link rateLimit}, and follows the same logic.\n     *\n     * > **Note**: `key` is used to prefix the local key\n     * > derived using the given key delegate.\n     *\n     * @param key  Key of the rate limit\n     * @param limit  Maximum number of requests in `window`\n     * @param window  Window size in seconds\n     * @returns  Tuple containing the number of remaining and\n     *   unix time in ms when the user can try again\n     */\n    async throttle(key: string, limit: number, window: number): Promise<[number, number]> {\n        try {\n            return await this.rateLimit(key, limit, window)\n        } catch (e: unknown) {\n            if (e instanceof RateLimitError) {\n                await sleep(e.reset - Date.now())\n\n                return this.throttle(key, limit, window)\n            }\n\n            throw e\n        }\n    }\n\n    /**\n     * Reset the rate limit\n     *\n     * @param key  Key of the rate limit\n     */\n    async resetRateLimit(key: string): Promise<void> {\n        await this._localStorage.resetRateLimit(`${key}:${this._localKey}`)\n    }\n}\n"]}

package/esm/wizard.js

@@ -1,101 +0,0 @@
-import { Dispatcher } from './dispatcher.js';
-import { filters } from './filters/index.js';
-/**
- * Action for the wizard scene.
- *
- * `Next`: Continue to the next registered step
- * (or exit, if this is the last step)
- *
- * `Stay`: Stay on the same step
- *
- * `Exit`: Exit from the wizard scene
- *
- * You can also return a `number` to jump to that step
- */
-export var WizardSceneAction;
-(function (WizardSceneAction) {
-    WizardSceneAction["Next"] = "next";
-    WizardSceneAction["Stay"] = "stay";
-    WizardSceneAction["Exit"] = "exit";
-})(WizardSceneAction || (WizardSceneAction = {}));
-/**
- * Wizard is a special type of Dispatcher
- * that can be used to simplify implementing
- * step-by-step scenes.
- */
-export class WizardScene extends Dispatcher {
-    _steps = 0;
-    _defaultState = {};
-    constructor(name, params) {
-        super(undefined, { sceneName: name, ...params });
-    }
-    setDefaultState(defaultState) {
-        this._defaultState = defaultState;
-    }
-    /**
-     * Get the total number of registered steps
-     */
-    get totalSteps() {
-        return this._steps;
-    }
-    /**
-     * Go to the Nth step
-     */
-    async goToStep(state, step) {
-        if (step >= this._steps) {
-            await state.exit();
-        }
-        else {
-            await state.merge({ $step: step }, this._defaultState);
-        }
-    }
-    /**
-     * Skip N steps
-     */
-    async skip(state, count = 1) {
-        const { $step } = (await state.get()) || {};
-        if ($step === undefined)
-            throw new Error('Wizard state is not initialized');
-        return this.goToStep(state, $step + count);
-    }
-    /**
-     * Filter that will only pass if the current step is `step`
-     */
-    // eslint-disable-next-line ts/no-empty-object-type
-    static onNthStep(step) {
-        const filter = filters.state(it => it.$step === step);
-        if (step === 0)
-            return filters.or(filters.stateEmpty, filter);
-        return filter;
-    }
-    /**
-     * Filter that will only pass if the current step is the one after last one added
-     */
-    // eslint-disable-next-line ts/no-empty-object-type
-    onCurrentStep() {
-        return WizardScene.onNthStep(this._steps);
-    }
-    /**
-     * Add a step to the wizard
-     */
-    addStep(handler) {
-        const step = this._steps++;
-        this.onNewMessage(WizardScene.onNthStep(step), async (msg, state) => {
-            const result = await handler(msg, state);
-            if (typeof result === 'number') {
-                await this.goToStep(state, result);
-                return;
-            }
-            switch (result) {
-                case 'next': {
-                    await this.goToStep(state, step + 1);
-                    break;
-                }
-                case 'exit':
-                    await state.exit();
-                    break;
-            }
-        });
-    }
-}
-//# sourceMappingURL=wizard.js.map

package/esm/wizard.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"wizard.js","sourceRoot":"","sources":["../../src/wizard.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAG5C;;;;;;;;;;;GAWG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,kCAAa,CAAA;IACb,kCAAa,CAAA;IACb,kCAAa,CAAA;AACjB,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAMD;;;;GAIG;AACH,MAAM,OAAO,WAAkC,SAAQ,UAAuC;IAClF,MAAM,GAAG,CAAC,CAAA;IAEV,aAAa,GAAgC,EAAiC,CAAA;IAEtF,YAAY,IAAY,EAAE,MAA4C;QAClE,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;IACpD,CAAC;IAOD,eAAe,CAAC,YAAmB;QAC/B,IAAI,CAAC,aAAa,GAAG,YAA2C,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,MAAM,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAuC,EAAE,IAAY;QAChE,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;QACtB,CAAC;aAAM,CAAC;YACJ,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;QAC1D,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,KAAuC,EAAE,KAAK,GAAG,CAAC;QACzD,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAA;QAC3C,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QAE3E,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED;;OAEG;IACH,mDAAmD;IACnD,MAAM,CAAC,SAAS,CAAC,IAAY;QACzB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAA;QAE1E,IAAI,IAAI,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QAE7D,OAAO,MAAM,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,mDAAmD;IACnD,aAAa;QACT,OAAO,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,OAAO,CACH,OAG6C;QAE7C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QAE1B,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YAChE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAExC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBAElC,OAAM;YACV,CAAC;YAED,QAAQ,MAAM,EAAE,CAAC;gBACb,KAAK,MAAM,CAAC,CAAC,CAAC;oBACV,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,CAAA;oBACpC,MAAK;gBACT,CAAC;gBACD,KAAK,MAAM;oBACP,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;oBAClB,MAAK;YACb,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ","sourcesContent":["import type { MaybePromise } from '@mtcute/core'\n\nimport type { MessageContext } from './context/message.js'\nimport type { DispatcherParams } from './dispatcher.js'\nimport { Dispatcher } from './dispatcher.js'\nimport type { UpdateFilter } from './filters/index.js'\nimport { filters } from './filters/index.js'\nimport type { UpdateState } from './state/update-state.js'\n\n/**\n * Action for the wizard scene.\n *\n * `Next`: Continue to the next registered step\n * (or exit, if this is the last step)\n *\n * `Stay`: Stay on the same step\n *\n * `Exit`: Exit from the wizard scene\n *\n * You can also return a `number` to jump to that step\n */\nexport enum WizardSceneAction {\n    Next = 'next',\n    Stay = 'stay',\n    Exit = 'exit',\n}\n\ninterface WizardInternalState {\n    $step?: number\n}\n\n/**\n * Wizard is a special type of Dispatcher\n * that can be used to simplify implementing\n * step-by-step scenes.\n */\nexport class WizardScene<State extends object> extends Dispatcher<State & WizardInternalState> {\n    private _steps = 0\n\n    private _defaultState: State & WizardInternalState = {} as State & WizardInternalState\n\n    constructor(name: string, params?: Omit<DispatcherParams, 'sceneName'>) {\n        super(undefined, { sceneName: name, ...params })\n    }\n\n    // remove inherited statics from Dispatcher\n    declare static for: never\n    declare static child: never\n    declare static scene: never\n\n    setDefaultState(defaultState: State): void {\n        this._defaultState = defaultState as State & WizardInternalState\n    }\n\n    /**\n     * Get the total number of registered steps\n     */\n    get totalSteps(): number {\n        return this._steps\n    }\n\n    /**\n     * Go to the Nth step\n     */\n    async goToStep(state: UpdateState<WizardInternalState>, step: number): Promise<void> {\n        if (step >= this._steps) {\n            await state.exit()\n        } else {\n            await state.merge({ $step: step }, this._defaultState)\n        }\n    }\n\n    /**\n     * Skip N steps\n     */\n    async skip(state: UpdateState<WizardInternalState>, count = 1): Promise<void> {\n        const { $step } = (await state.get()) || {}\n        if ($step === undefined) throw new Error('Wizard state is not initialized')\n\n        return this.goToStep(state, $step + count)\n    }\n\n    /**\n     * Filter that will only pass if the current step is `step`\n     */\n    // eslint-disable-next-line ts/no-empty-object-type\n    static onNthStep(step: number): UpdateFilter<any, {}, WizardInternalState> {\n        const filter = filters.state<WizardInternalState>(it => it.$step === step)\n\n        if (step === 0) return filters.or(filters.stateEmpty, filter)\n\n        return filter\n    }\n\n    /**\n     * Filter that will only pass if the current step is the one after last one added\n     */\n    // eslint-disable-next-line ts/no-empty-object-type\n    onCurrentStep(): UpdateFilter<any, {}, WizardInternalState> {\n        return WizardScene.onNthStep(this._steps)\n    }\n\n    /**\n     * Add a step to the wizard\n     */\n    addStep(\n        handler: (\n            msg: MessageContext,\n            state: UpdateState<State & WizardInternalState>,\n        ) => MaybePromise<WizardSceneAction | number>,\n    ): void {\n        const step = this._steps++\n\n        this.onNewMessage(WizardScene.onNthStep(step), async (msg, state) => {\n            const result = await handler(msg, state)\n\n            if (typeof result === 'number') {\n                await this.goToStep(state, result)\n\n                return\n            }\n\n            switch (result) {\n                case 'next': {\n                    await this.goToStep(state, step + 1)\n                    break\n                }\n                case 'exit':\n                    await state.exit()\n                    break\n            }\n        })\n    }\n}\n"]}