@mtcute/dispatcher 0.6.0 → 0.7.0

package/esm/state/service.js

@@ -0,0 +1,64 @@
+import { asyncResettable, LruMap } from '@mtcute/core/utils.js';
+const makeCurrentSceneKey = (key) => `$current_scene_${key}`;
+export class StateService {
+    constructor(provider) {
+        this.provider = provider;
+        this._cache = new LruMap(100);
+        this._loaded = false;
+        this._load = asyncResettable(async () => {
+            await this.provider.driver.load?.();
+            this._loaded = true;
+        });
+    }
+    async load() {
+        await this._load.run();
+        this._vacuumTimer = setInterval(() => {
+            Promise.resolve(this.provider.state.vacuum(Date.now())).catch(() => { });
+        }, 300000);
+    }
+    async destroy() {
+        await this.provider.driver.save?.();
+        await this.provider.driver.destroy?.();
+        clearInterval(this._vacuumTimer);
+        this._loaded = false;
+    }
+    async getState(key) {
+        if (!this._loaded)
+            await this.load();
+        const cached = this._cache.get(key);
+        if (cached)
+            return cached;
+        const state = await this.provider.state.getState(key, Date.now());
+        if (!state)
+            return null;
+        return JSON.parse(state);
+    }
+    async setState(key, state, ttl) {
+        if (!this._loaded)
+            await this.load();
+        this._cache.set(key, state);
+        await this.provider.state.setState(key, JSON.stringify(state), ttl);
+    }
+    async deleteState(key) {
+        if (!this._loaded)
+            await this.load();
+        this._cache.delete(key);
+        await this.provider.state.deleteState(key);
+    }
+    getCurrentScene(key) {
+        return this.getState(makeCurrentSceneKey(key));
+    }
+    setCurrentScene(key, scene, ttl) {
+        return this.setState(makeCurrentSceneKey(key), scene, ttl);
+    }
+    deleteCurrentScene(key) {
+        return this.deleteState(makeCurrentSceneKey(key));
+    }
+    getRateLimit(key, limit, window) {
+        return this.provider.state.getRateLimit(key, Date.now(), limit, window);
+    }
+    resetRateLimit(key) {
+        return this.provider.state.resetRateLimit(key);
+    }
+}
+//# sourceMappingURL=service.js.map

package/esm/state/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../src/state/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AAI/D,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,kBAAkB,GAAG,EAAE,CAAA;AAEpE,MAAM,OAAO,YAAY;IACrB,YAAqB,QAA+B;QAA/B,aAAQ,GAAR,QAAQ,CAAuB;QAE5C,WAAM,GAA4B,IAAI,MAAM,CAAC,GAAG,CAAC,CAAA;QAGjD,YAAO,GAAG,KAAK,CAAA;QACf,UAAK,GAAG,eAAe,CAAC,KAAK,IAAI,EAAE;YACvC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAA;YACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACvB,CAAC,CAAC,CAAA;IATqD,CAAC;IAUxD,KAAK,CAAC,IAAI;QACN,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE;YACjC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAC3E,CAAC,EAAE,MAAO,CAAC,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAA;QACnC,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAA;QACtC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAChC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,GAAW;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAEpC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACnC,IAAI,MAAM;YAAE,OAAO,MAAW,CAAA;QAE9B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAA;QAEvB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAA;IACjC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAI,GAAW,EAAE,KAAQ,EAAE,GAAY;QACjD,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAEpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC3B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAA;IACvE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,GAAW;QACzB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,CAAC,IAAI,EAAE,CAAA;QAEpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACvB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9C,CAAC;IAED,eAAe,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,eAAe,CAAC,GAAW,EAAE,KAAa,EAAE,GAAY;QACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;IAC9D,CAAC;IAED,kBAAkB,CAAC,GAAW;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAA;IACrD,CAAC;IAED,YAAY,CAAC,GAAW,EAAE,KAAa,EAAE,MAAc;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC3E,CAAC;IAED,cAAc,CAAC,GAAW;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IAClD,CAAC;CACJ","sourcesContent":["import { asyncResettable, LruMap } from '@mtcute/core/utils.js'\n\nimport { IStateStorageProvider } from './provider.js'\n\nconst makeCurrentSceneKey = (key: string) => `$current_scene_${key}`\n\nexport class StateService {\n    constructor(readonly provider: IStateStorageProvider) {}\n\n    private _cache: LruMap<string, unknown> = new LruMap(100)\n    private _vacuumTimer?: NodeJS.Timeout\n\n    private _loaded = false\n    private _load = asyncResettable(async () => {\n        await this.provider.driver.load?.()\n        this._loaded = true\n    })\n    async load() {\n        await this._load.run()\n        this._vacuumTimer = setInterval(() => {\n            Promise.resolve(this.provider.state.vacuum(Date.now())).catch(() => {})\n        }, 300_000)\n    }\n\n    async destroy() {\n        await this.provider.driver.save?.()\n        await this.provider.driver.destroy?.()\n        clearInterval(this._vacuumTimer)\n        this._loaded = false\n    }\n\n    async getState<T>(key: string): Promise<T | null> {\n        if (!this._loaded) await this.load()\n\n        const cached = this._cache.get(key)\n        if (cached) return cached as T\n\n        const state = await this.provider.state.getState(key, Date.now())\n        if (!state) return null\n\n        return JSON.parse(state) as T\n    }\n\n    async setState<T>(key: string, state: T, ttl?: number): Promise<void> {\n        if (!this._loaded) await this.load()\n\n        this._cache.set(key, state)\n        await this.provider.state.setState(key, JSON.stringify(state), ttl)\n    }\n\n    async deleteState(key: string): Promise<void> {\n        if (!this._loaded) await this.load()\n\n        this._cache.delete(key)\n        await this.provider.state.deleteState(key)\n    }\n\n    getCurrentScene(key: string): Promise<string | null> {\n        return this.getState(makeCurrentSceneKey(key))\n    }\n\n    setCurrentScene(key: string, scene: string, ttl?: number): Promise<void> {\n        return this.setState(makeCurrentSceneKey(key), scene, ttl)\n    }\n\n    deleteCurrentScene(key: string): Promise<void> {\n        return this.deleteState(makeCurrentSceneKey(key))\n    }\n\n    getRateLimit(key: string, limit: number, window: number) {\n        return this.provider.state.getRateLimit(key, Date.now(), limit, window)\n    }\n\n    resetRateLimit(key: string) {\n        return this.provider.state.resetRateLimit(key)\n    }\n}\n"]}

package/esm/state/update-state.d.ts

@@ -1,6 +1,6 @@
-import { MtcuteError } from '@mtcute/client';
+import { MtcuteError } from '@mtcute/core';
 import type { Dispatcher } from '../dispatcher.js';
-import { IStateStorage } from './storage.js';
+import { StateService } from './service.js';
 /**
  * Error thrown by `.rateLimit()`
  */
@@ -23,7 +23,7 @@ export declare class UpdateState<State extends object> {
     private _cached?;
     private _localStorage;
     private _localKeyBase;
-    constructor(storage: IStateStorage, key: string, scene: string | null, scoped?: boolean, customStorage?: IStateStorage, customKey?: string);
+    constructor(storage: StateService, key: string, scene: string | null, scoped?: boolean, customStorage?: StateService, customKey?: string);
     /** Name of the current scene */
     get scene(): string | null;
     private _updateLocalKey;

package/esm/state/update-state.js

@@ -1,7 +1,7 @@
 /* eslint-disable dot-notation */
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { MtArgumentError, MtcuteError } from '@mtcute/client';
-import { sleep } from '@mtcute/client/utils.js';
+import { MtArgumentError, MtcuteError } from '@mtcute/core';
+import { sleep } from '@mtcute/core/utils.js';
 /**
  * Error thrown by `.rateLimit()`
  */

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

@@ -1 +1 @@
-{"version":3,"file":"update-state.js","sourceRoot":"","sources":["../../../src/state/update-state.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,uDAAuD;AACvD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAK/C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC3C,YAAqB,KAAa;QAC9B,KAAK,CAAC,6BAA6B,CAAC,CAAA;QADnB,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAapB,YACI,OAAsB,EACtB,GAAW,EACX,KAAoB,EACpB,MAAgB,EAChB,aAA6B,EAC7B,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;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAA;aACjD;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAA;SAC7F;IACL,CAAC;IAyBD,KAAK,CAAC,GAAG,CAAC,QAA0C,EAAE,KAAe;QACjE,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YAC/B,KAAK,GAAG,QAAQ,CAAA;YAChB,QAAQ,GAAG,SAAS,CAAA;SACvB;QAED,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE;gBAC3B,OAAO,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;aAChE;YAED,OAAO,IAAI,CAAC,OAAO,CAAA;SACtB;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;YAClB,GAAG,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;SAC/D;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;YACN,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAM,IAAI,eAAe,CAAC,mDAAmD,CAAC,CAAA;aACjF;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;SAClD;aAAM;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,CAAC,CAAA;SAC5C;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;YAClB,MAAM,IAAI,eAAe,CAAC,qCAAqC,CAAC,CAAA;SACnE;QAED,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACnB,MAAM,IAAI,eAAe,CAAC,oCAAoC,CAAC,CAAA;SAClE;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;YACP,IAAI,KAAK,CAAC,yBAAyB,CAAC,EAAE;gBAClC,MAAM,IAAI,eAAe,CAAC,6EAA6E,CAAC,CAAA;aAC3G;YAED,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClD;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;YACZ,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;SAClC;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;YACA,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;SAClD;QAAC,OAAO,CAAU,EAAE;YACjB,IAAI,CAAC,YAAY,cAAc,EAAE;gBAC7B,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;aAC3C;YAED,MAAM,CAAC,CAAA;SACV;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":["/* eslint-disable dot-notation */\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { MtArgumentError, MtcuteError } from '@mtcute/client'\nimport { sleep } from '@mtcute/client/utils.js'\n\nimport type { Dispatcher } from '../dispatcher.js'\nimport { IStateStorage } from './storage.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: IStateStorage\n\n    private _scene: string | null\n    private _scoped?: boolean\n    private _cached?: State | null\n\n    private _localStorage: IStateStorage\n    private _localKeyBase: string\n\n    constructor(\n        storage: IStateStorage,\n        key: string,\n        scene: string | null,\n        scoped?: boolean,\n        customStorage?: IStateStorage,\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) 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"]}
+{"version":3,"file":"update-state.js","sourceRoot":"","sources":["../../../src/state/update-state.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,uDAAuD;AACvD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAK7C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC3C,YAAqB,KAAa;QAC9B,KAAK,CAAC,6BAA6B,CAAC,CAAA;QADnB,UAAK,GAAL,KAAK,CAAQ;IAElC,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAapB,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;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAA;aACjD;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAA;SAC7F;IACL,CAAC;IAyBD,KAAK,CAAC,GAAG,CAAC,QAA0C,EAAE,KAAe;QACjE,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YAC/B,KAAK,GAAG,QAAQ,CAAA;YAChB,QAAQ,GAAG,SAAS,CAAA;SACvB;QAED,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE;gBAC3B,OAAO,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;aAChE;YAED,OAAO,IAAI,CAAC,OAAO,CAAA;SACtB;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;YAClB,GAAG,GAAG,OAAO,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAA;SAC/D;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;YACN,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAM,IAAI,eAAe,CAAC,mDAAmD,CAAC,CAAA;aACjF;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;SAClD;aAAM;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,CAAC,CAAA;SAC5C;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;YAClB,MAAM,IAAI,eAAe,CAAC,qCAAqC,CAAC,CAAA;SACnE;QAED,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACnB,MAAM,IAAI,eAAe,CAAC,oCAAoC,CAAC,CAAA;SAClE;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;YACP,IAAI,KAAK,CAAC,yBAAyB,CAAC,EAAE;gBAClC,MAAM,IAAI,eAAe,CAAC,6EAA6E,CAAC,CAAA;aAC3G;YAED,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClD;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;YACZ,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAA;SAClC;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;YACA,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;SAClD;QAAC,OAAO,CAAU,EAAE;YACjB,IAAI,CAAC,YAAY,cAAc,EAAE;gBAC7B,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;aAC3C;YAED,MAAM,CAAC,CAAA;SACV;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":["/* eslint-disable dot-notation */\n/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { MtArgumentError, MtcuteError } from '@mtcute/core'\nimport { sleep } from '@mtcute/core/utils.js'\n\nimport type { Dispatcher } from '../dispatcher.js'\nimport { 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) 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.d.ts

@@ -1,4 +1,4 @@
-import { MaybeAsync } from '@mtcute/client';
+import { MaybePromise } from '@mtcute/core';
 import { MessageContext } from './context/message.js';
 import { Dispatcher } from './dispatcher.js';
 import { filters } from './filters/index.js';
@@ -55,6 +55,6 @@ export declare class WizardScene<State extends object> extends Dispatcher<State
     /**
      * Add a step to the wizard
      */
-    addStep(handler: (msg: MessageContext, state: UpdateState<State & WizardInternalState>) => MaybeAsync<WizardSceneAction | number>): void;
+    addStep(handler: (msg: MessageContext, state: UpdateState<State & WizardInternalState>) => MaybePromise<WizardSceneAction | number>): void;
 }
 export {};

package/esm/wizard.js

@@ -17,7 +17,7 @@ export var WizardSceneAction;
     WizardSceneAction["Next"] = "next";
     WizardSceneAction["Stay"] = "stay";
     WizardSceneAction["Exit"] = "exit";
-})(WizardSceneAction = WizardSceneAction || (WizardSceneAction = {}));
+})(WizardSceneAction || (WizardSceneAction = {}));
 /**
  * Wizard is a special type of Dispatcher
  * that can be used to simplify implementing

package/esm/wizard.js.map

@@ -1 +1 @@
-{"version":3,"file":"wizard.js","sourceRoot":"","sources":["../../src/wizard.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,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,GAAjB,iBAAiB,KAAjB,iBAAiB,QAI5B;AAMD;;;;GAIG;AACH,MAAM,OAAO,WAAkC,SAAQ,UAAuC;IAA9F;;QACY,WAAM,GAAG,CAAC,CAAA;QAEV,kBAAa,GAAgC,EAAiC,CAAA;IAmF1F,CAAC;IAjFG,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;YACrB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB;aAAM;YACH,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;SACzD;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,MAAM,CAAC,SAAS,CAAC,IAAY;QACzB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAA;QAE5E,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,aAAa;QACT,OAAO,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,OAAO,CACH,OAG2C;QAE3C,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;gBAC5B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBAElC,OAAM;aACT;YAED,QAAQ,MAAM,EAAE;gBACZ,KAAK,MAAM,CAAC,CAAC;oBACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,CAAA;oBACpC,MAAK;iBACR;gBACD,KAAK,MAAM;oBACP,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;oBAClB,MAAK;aACZ;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ","sourcesContent":["import { MaybeAsync } from '@mtcute/client'\n\nimport { MessageContext } from './context/message.js'\nimport { Dispatcher } from './dispatcher.js'\nimport { filters } from './filters/index.js'\nimport { 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    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) {\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) {\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    static onNthStep(step: number) {\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    onCurrentStep() {\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        ) => MaybeAsync<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"]}
+{"version":3,"file":"wizard.js","sourceRoot":"","sources":["../../src/wizard.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,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;IAA9F;;QACY,WAAM,GAAG,CAAC,CAAA;QAEV,kBAAa,GAAgC,EAAiC,CAAA;IAmF1F,CAAC;IAjFG,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;YACrB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;SACrB;aAAM;YACH,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAA;SACzD;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,MAAM,CAAC,SAAS,CAAC,IAAY;QACzB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAA;QAE5E,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,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;gBAC5B,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;gBAElC,OAAM;aACT;YAED,QAAQ,MAAM,EAAE;gBACZ,KAAK,MAAM,CAAC,CAAC;oBACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,CAAA;oBACpC,MAAK;iBACR;gBACD,KAAK,MAAM;oBACP,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;oBAClB,MAAK;aACZ;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ","sourcesContent":["import { MaybePromise } from '@mtcute/core'\n\nimport { MessageContext } from './context/message.js'\nimport { Dispatcher } from './dispatcher.js'\nimport { filters } from './filters/index.js'\nimport { 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    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) {\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) {\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    static onNthStep(step: number) {\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    onCurrentStep() {\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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mtcute/dispatcher",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Updates dispatcher and bot framework for @mtcute/client",
   "author": "Alina Sireneva <alina@tei.su>",
   "license": "MIT",
@@ -8,10 +8,17 @@
   "type": "module",
   "scripts": {},
   "dependencies": {
-    "@mtcute/client": "^0.6.0",
-    "@mtcute/test": "^0.6.0",
+    "@mtcute/core": "^0.7.0",
     "events": "3.2.0"
   },
+  "peerDependencies": {
+    "@mtcute/sqlite": "^0.7.0"
+  },
+  "peerDependenciesMeta": {
+    "@mtcute/sqlite": {
+      "optional": true
+    }
+  },
   "module": "esm/index.js",
   "exports": {
     ".": {

package/cjs/state/storage.d.ts

@@ -1,96 +0,0 @@
-import { MaybeAsync } from '@mtcute/client';
-/**
- * Interface for FSM storage for the dispatcher.
- *
- * All of the officially supported storages already implement
- * this interface, so you can just re-use it.
- *
- * Current scene is a special case of a `string` state,
- * Most of the time you can just store it the same way
- * as normal state, prefixing with something like `$current_state_`
- * (scene name can't start with `$`).
- * Alternatively, you can store them as simple strings
- */
-export interface IStateStorage {
-    /**
-     * Load state from some external storage.
-     * Should be used either to load session content from file/network/etc
-     * to memory, or to open required connections to fetch session content later
-     *
-     * This method may be called multiple times and should handle that.
-     */
-    load?(): MaybeAsync<void>;
-    /**
-     * Save state to some external storage.
-     * Should be used to commit pending changes in the session.
-     * For example, saving session content to file/network/etc,
-     * or committing a database transaction
-     */
-    save?(): MaybeAsync<void>;
-    /**
-     * Cleanup storage and release all used resources.
-     *
-     * This method may be called multiple times and should handle that.
-     */
-    destroy?(): MaybeAsync<void>;
-    /**
-     * Retrieve state from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    getState(key: string): MaybeAsync<unknown>;
-    /**
-     * Save state to the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     * @param state  Object representing the state
-     * @param ttl  TTL for the state, in seconds
-     */
-    setState(key: string, state: unknown, ttl?: number): MaybeAsync<void>;
-    /**
-     * Delete state from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    deleteState(key: string): MaybeAsync<void>;
-    /**
-     * Retrieve the current scene UID from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    getCurrentScene(key: string): MaybeAsync<string | null>;
-    /**
-     * Change current scene's UID from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     * @param scene  New scene
-     * @param ttl  TTL for the scene, in seconds
-     */
-    setCurrentScene(key: string, scene: string, ttl?: number): MaybeAsync<void>;
-    /**
-     * Delete current scene from the storage, effectively "exiting" to root.
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    deleteCurrentScene(key: string): MaybeAsync<void>;
-    /**
-     * Get information about a rate limit.
-     *
-     * It is recommended that you use sliding window or leaky bucket
-     * to implement rate limiting ([learn more](https://konghq.com/blog/how-to-design-a-scalable-rate-limiting-algorithm/)),
-     *
-     * @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
-     */
-    getRateLimit(key: string, limit: number, window: number): MaybeAsync<[number, number]>;
-    /**
-     * Reset a rate limit.
-     *
-     * @param key  Key of the rate limit
-     */
-    resetRateLimit(key: string): MaybeAsync<void>;
-}
-export declare function isCompatibleStorage(storage: unknown): storage is IStateStorage;

package/cjs/state/storage.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCompatibleStorage = void 0;
-function isCompatibleStorage(storage) {
-    return (typeof storage === 'object' &&
-        storage !== null &&
-        'getState' in storage &&
-        'setState' in storage &&
-        'deleteState' in storage &&
-        'getCurrentScene' in storage &&
-        'setCurrentScene' in storage &&
-        'deleteCurrentScene' in storage &&
-        'getRateLimit' in storage &&
-        'resetRateLimit' in storage);
-}
-exports.isCompatibleStorage = isCompatibleStorage;
-//# sourceMappingURL=storage.js.map

package/cjs/state/storage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/state/storage.ts"],"names":[],"mappings":";;;AA4GA,SAAgB,mBAAmB,CAAC,OAAgB;IAChD,OAAO,CACH,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,UAAU,IAAI,OAAO;QACrB,UAAU,IAAI,OAAO;QACrB,aAAa,IAAI,OAAO;QACxB,iBAAiB,IAAI,OAAO;QAC5B,iBAAiB,IAAI,OAAO;QAC5B,oBAAoB,IAAI,OAAO;QAC/B,cAAc,IAAI,OAAO;QACzB,gBAAgB,IAAI,OAAO,CAC9B,CAAA;AACL,CAAC;AAbD,kDAaC","sourcesContent":["import { MaybeAsync } from '@mtcute/client'\n\n// ⚠️ Important: when modifying the below interface, also update it\n// in packages/core/src/storage/storage.test-utils.ts\n\n/**\n * Interface for FSM storage for the dispatcher.\n *\n * All of the officially supported storages already implement\n * this interface, so you can just re-use it.\n *\n * Current scene is a special case of a `string` state,\n * Most of the time you can just store it the same way\n * as normal state, prefixing with something like `$current_state_`\n * (scene name can't start with `$`).\n * Alternatively, you can store them as simple strings\n */\nexport interface IStateStorage {\n    /**\n     * Load state from some external storage.\n     * Should be used either to load session content from file/network/etc\n     * to memory, or to open required connections to fetch session content later\n     *\n     * This method may be called multiple times and should handle that.\n     */\n    load?(): MaybeAsync<void>\n    /**\n     * Save state to some external storage.\n     * Should be used to commit pending changes in the session.\n     * For example, saving session content to file/network/etc,\n     * or committing a database transaction\n     */\n    save?(): MaybeAsync<void>\n    /**\n     * Cleanup storage and release all used resources.\n     *\n     * This method may be called multiple times and should handle that.\n     */\n    destroy?(): MaybeAsync<void>\n\n    /**\n     * Retrieve state from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    getState(key: string): MaybeAsync<unknown>\n\n    /**\n     * Save state to the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     * @param state  Object representing the state\n     * @param ttl  TTL for the state, in seconds\n     */\n    setState(key: string, state: unknown, ttl?: number): MaybeAsync<void>\n\n    /**\n     * Delete state from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    deleteState(key: string): MaybeAsync<void>\n\n    /**\n     * Retrieve the current scene UID from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    getCurrentScene(key: string): MaybeAsync<string | null>\n\n    /**\n     * Change current scene's UID from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     * @param scene  New scene\n     * @param ttl  TTL for the scene, in seconds\n     */\n    setCurrentScene(key: string, scene: string, ttl?: number): MaybeAsync<void>\n\n    /**\n     * Delete current scene from the storage, effectively \"exiting\" to root.\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    deleteCurrentScene(key: string): MaybeAsync<void>\n\n    /**\n     * Get information about a rate limit.\n     *\n     * It is recommended that you use sliding window or leaky bucket\n     * to implement rate limiting ([learn more](https://konghq.com/blog/how-to-design-a-scalable-rate-limiting-algorithm/)),\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    getRateLimit(key: string, limit: number, window: number): MaybeAsync<[number, number]>\n\n    /**\n     * Reset a rate limit.\n     *\n     * @param key  Key of the rate limit\n     */\n    resetRateLimit(key: string): MaybeAsync<void>\n}\n\nexport function isCompatibleStorage(storage: unknown): storage is IStateStorage {\n    return (\n        typeof storage === 'object' &&\n        storage !== null &&\n        'getState' in storage &&\n        'setState' in storage &&\n        'deleteState' in storage &&\n        'getCurrentScene' in storage &&\n        'setCurrentScene' in storage &&\n        'deleteCurrentScene' in storage &&\n        'getRateLimit' in storage &&\n        'resetRateLimit' in storage\n    )\n}\n"]}

package/esm/state/storage.d.ts

@@ -1,96 +0,0 @@
-import { MaybeAsync } from '@mtcute/client';
-/**
- * Interface for FSM storage for the dispatcher.
- *
- * All of the officially supported storages already implement
- * this interface, so you can just re-use it.
- *
- * Current scene is a special case of a `string` state,
- * Most of the time you can just store it the same way
- * as normal state, prefixing with something like `$current_state_`
- * (scene name can't start with `$`).
- * Alternatively, you can store them as simple strings
- */
-export interface IStateStorage {
-    /**
-     * Load state from some external storage.
-     * Should be used either to load session content from file/network/etc
-     * to memory, or to open required connections to fetch session content later
-     *
-     * This method may be called multiple times and should handle that.
-     */
-    load?(): MaybeAsync<void>;
-    /**
-     * Save state to some external storage.
-     * Should be used to commit pending changes in the session.
-     * For example, saving session content to file/network/etc,
-     * or committing a database transaction
-     */
-    save?(): MaybeAsync<void>;
-    /**
-     * Cleanup storage and release all used resources.
-     *
-     * This method may be called multiple times and should handle that.
-     */
-    destroy?(): MaybeAsync<void>;
-    /**
-     * Retrieve state from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    getState(key: string): MaybeAsync<unknown>;
-    /**
-     * Save state to the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     * @param state  Object representing the state
-     * @param ttl  TTL for the state, in seconds
-     */
-    setState(key: string, state: unknown, ttl?: number): MaybeAsync<void>;
-    /**
-     * Delete state from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    deleteState(key: string): MaybeAsync<void>;
-    /**
-     * Retrieve the current scene UID from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    getCurrentScene(key: string): MaybeAsync<string | null>;
-    /**
-     * Change current scene's UID from the storage
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     * @param scene  New scene
-     * @param ttl  TTL for the scene, in seconds
-     */
-    setCurrentScene(key: string, scene: string, ttl?: number): MaybeAsync<void>;
-    /**
-     * Delete current scene from the storage, effectively "exiting" to root.
-     *
-     * @param key  Key of the state, as defined by {@link StateKeyDelegate}
-     */
-    deleteCurrentScene(key: string): MaybeAsync<void>;
-    /**
-     * Get information about a rate limit.
-     *
-     * It is recommended that you use sliding window or leaky bucket
-     * to implement rate limiting ([learn more](https://konghq.com/blog/how-to-design-a-scalable-rate-limiting-algorithm/)),
-     *
-     * @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
-     */
-    getRateLimit(key: string, limit: number, window: number): MaybeAsync<[number, number]>;
-    /**
-     * Reset a rate limit.
-     *
-     * @param key  Key of the rate limit
-     */
-    resetRateLimit(key: string): MaybeAsync<void>;
-}
-export declare function isCompatibleStorage(storage: unknown): storage is IStateStorage;

package/esm/state/storage.js

@@ -1,13 +0,0 @@
-export function isCompatibleStorage(storage) {
-    return (typeof storage === 'object' &&
-        storage !== null &&
-        'getState' in storage &&
-        'setState' in storage &&
-        'deleteState' in storage &&
-        'getCurrentScene' in storage &&
-        'setCurrentScene' in storage &&
-        'deleteCurrentScene' in storage &&
-        'getRateLimit' in storage &&
-        'resetRateLimit' in storage);
-}
-//# sourceMappingURL=storage.js.map

package/esm/state/storage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/state/storage.ts"],"names":[],"mappings":"AA4GA,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAChD,OAAO,CACH,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,UAAU,IAAI,OAAO;QACrB,UAAU,IAAI,OAAO;QACrB,aAAa,IAAI,OAAO;QACxB,iBAAiB,IAAI,OAAO;QAC5B,iBAAiB,IAAI,OAAO;QAC5B,oBAAoB,IAAI,OAAO;QAC/B,cAAc,IAAI,OAAO;QACzB,gBAAgB,IAAI,OAAO,CAC9B,CAAA;AACL,CAAC","sourcesContent":["import { MaybeAsync } from '@mtcute/client'\n\n// ⚠️ Important: when modifying the below interface, also update it\n// in packages/core/src/storage/storage.test-utils.ts\n\n/**\n * Interface for FSM storage for the dispatcher.\n *\n * All of the officially supported storages already implement\n * this interface, so you can just re-use it.\n *\n * Current scene is a special case of a `string` state,\n * Most of the time you can just store it the same way\n * as normal state, prefixing with something like `$current_state_`\n * (scene name can't start with `$`).\n * Alternatively, you can store them as simple strings\n */\nexport interface IStateStorage {\n    /**\n     * Load state from some external storage.\n     * Should be used either to load session content from file/network/etc\n     * to memory, or to open required connections to fetch session content later\n     *\n     * This method may be called multiple times and should handle that.\n     */\n    load?(): MaybeAsync<void>\n    /**\n     * Save state to some external storage.\n     * Should be used to commit pending changes in the session.\n     * For example, saving session content to file/network/etc,\n     * or committing a database transaction\n     */\n    save?(): MaybeAsync<void>\n    /**\n     * Cleanup storage and release all used resources.\n     *\n     * This method may be called multiple times and should handle that.\n     */\n    destroy?(): MaybeAsync<void>\n\n    /**\n     * Retrieve state from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    getState(key: string): MaybeAsync<unknown>\n\n    /**\n     * Save state to the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     * @param state  Object representing the state\n     * @param ttl  TTL for the state, in seconds\n     */\n    setState(key: string, state: unknown, ttl?: number): MaybeAsync<void>\n\n    /**\n     * Delete state from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    deleteState(key: string): MaybeAsync<void>\n\n    /**\n     * Retrieve the current scene UID from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    getCurrentScene(key: string): MaybeAsync<string | null>\n\n    /**\n     * Change current scene's UID from the storage\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     * @param scene  New scene\n     * @param ttl  TTL for the scene, in seconds\n     */\n    setCurrentScene(key: string, scene: string, ttl?: number): MaybeAsync<void>\n\n    /**\n     * Delete current scene from the storage, effectively \"exiting\" to root.\n     *\n     * @param key  Key of the state, as defined by {@link StateKeyDelegate}\n     */\n    deleteCurrentScene(key: string): MaybeAsync<void>\n\n    /**\n     * Get information about a rate limit.\n     *\n     * It is recommended that you use sliding window or leaky bucket\n     * to implement rate limiting ([learn more](https://konghq.com/blog/how-to-design-a-scalable-rate-limiting-algorithm/)),\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    getRateLimit(key: string, limit: number, window: number): MaybeAsync<[number, number]>\n\n    /**\n     * Reset a rate limit.\n     *\n     * @param key  Key of the rate limit\n     */\n    resetRateLimit(key: string): MaybeAsync<void>\n}\n\nexport function isCompatibleStorage(storage: unknown): storage is IStateStorage {\n    return (\n        typeof storage === 'object' &&\n        storage !== null &&\n        'getState' in storage &&\n        'setState' in storage &&\n        'deleteState' in storage &&\n        'getCurrentScene' in storage &&\n        'setCurrentScene' in storage &&\n        'deleteCurrentScene' in storage &&\n        'getRateLimit' in storage &&\n        'resetRateLimit' in storage\n    )\n}\n"]}