@tma.js/sdk 2.7.0 → 3.0.0

package/dist/dts/errors/errors.d.ts

@@ -1,49 +0,0 @@
-/**
- * Specified Mini Apps method is unsupported.
- */
-export declare const ERR_METHOD_UNSUPPORTED = "ERR_METHOD_UNSUPPORTED";
-/**
- * Specified Mini Apps method parameter is unsupported.
- */
-export declare const ERR_METHOD_PARAMETER_UNSUPPORTED = "ERR_METHOD_PARAMETER_UNSUPPORTED";
-/**
- * Current environment is not Telegram application.
- */
-export declare const ERR_UNKNOWN_ENV = "ERR_UNKNOWN_ENV";
-/**
- * Telegram application returned and error while invoking custom method.
- */
-export declare const ERR_INVOKE_CUSTOM_METHOD_RESPONSE = "ERR_INVOKE_CUSTOM_METHOD_RESPONSE";
-/**
- * Timeout reached.
- */
-export declare const ERR_TIMED_OUT = "ERR_TIMED_OUT";
-/**
- * Value has unexpected type.
- */
-export declare const ERR_UNEXPECTED_TYPE = "ERR_UNEXPECTED_TYPE";
-/**
- * Something went wrong during value parsing.
- */
-export declare const ERR_PARSE = "ERR_PARSE";
-/**
- * Navigation entries list is empty.
- */
-export declare const ERR_NAVIGATION_HISTORY_EMPTY = "ERR_NAVIGATION_LIST_EMPTY";
-/**
- * Navigation entries cursor is invalid.
- */
-export declare const ERR_NAVIGATION_INDEX_INVALID = "ERR_NAVIGATION_CURSOR_INVALID";
-/**
- * Navigation entries item is invalid.
- */
-export declare const ERR_NAVIGATION_ITEM_INVALID = "ERR_NAVIGATION_ITEM_INVALID";
-/**
- * SSR component initialization failed.
- */
-export declare const ERR_SSR_INIT = "ERR_SSR_INIT";
-/**
- * Path starts from the invalid base.
- */
-export declare const ERR_INVALID_PATH_BASE = "ERR_INVALID_PATH_BASE";
-export type ErrorType = typeof ERR_METHOD_UNSUPPORTED | typeof ERR_METHOD_PARAMETER_UNSUPPORTED | typeof ERR_UNKNOWN_ENV | typeof ERR_INVOKE_CUSTOM_METHOD_RESPONSE | typeof ERR_TIMED_OUT | typeof ERR_PARSE | typeof ERR_UNEXPECTED_TYPE | typeof ERR_NAVIGATION_HISTORY_EMPTY | typeof ERR_NAVIGATION_INDEX_INVALID | typeof ERR_NAVIGATION_ITEM_INVALID | typeof ERR_SSR_INIT | typeof ERR_INVALID_PATH_BASE;

package/dist/dts/errors/isSDKError.d.ts

@@ -1,7 +0,0 @@
-import { SDKError } from './SDKError.js';
-
-/**
- * @returns True, if passed value is an instance of SDKError.
- * @param value - value to check.
- */
-export declare function isSDKError(value: unknown): value is SDKError;

package/dist/dts/errors/isSDKErrorOfType.d.ts

@@ -1,8 +0,0 @@
-import { ErrorType } from './errors.js';
-
-/**
- * Returns true if passed value is an SDK error of specified type.
- * @param value - value to check.
- * @param type - error type.
- */
-export declare function isSDKErrorOfType(value: unknown, type: ErrorType): boolean;

package/dist/dts/events/event-emitter/EventEmitter.d.ts

@@ -1,54 +0,0 @@
-import { RemoveEventListenerFn } from '../types.js';
-import { EmptyEventName, EventListener, EventName, EventParams, NonEmptyEventName, SubscribeListener } from './types.js';
-
-export declare class EventEmitter<Schema> {
-    private readonly listeners;
-    private listenersCount;
-    private subscribeListeners;
-    /**
-     * Removes all event listeners.
-     */
-    clear(): void;
-    /**
-     * Returns count of bound listeners.
-     */
-    get count(): number;
-    /**
-     * Emits known event which has no parameters.
-     * @param event - event name.
-     */
-    emit<E extends EmptyEventName<Schema>>(event: E): void;
-    /**
-     * Emits known event which has parameters.
-     * @param event - event name.
-     * @param args - list of event listener arguments.
-     */
-    emit<E extends NonEmptyEventName<Schema>>(event: E, ...args: EventParams<Schema[E]>): void;
-    /**
-     * Adds new event listener.
-     * @param event - event name.
-     * @param listener - event listener.
-     * @param once - should listener be called only once.
-     * @returns Function to remove bound event listener.
-     */
-    on<E extends EventName<Schema>>(event: E, listener: EventListener<Schema[E]>, once?: boolean): RemoveEventListenerFn;
-    /**
-     * Removes event listener. In case, specified listener was bound several times, it removes
-     * only a single one.
-     * @param event - event name.
-     * @param listener - event listener.
-     */
-    off<E extends EventName<Schema>>(event: E, listener: EventListener<Schema[E]>): void;
-    /**
-     * Adds a new event listener for all events.
-     * @param listener - event listener.
-     * @returns Function to remove event listener.
-     */
-    subscribe(listener: SubscribeListener<Schema>): RemoveEventListenerFn;
-    /**
-     * Removes global event listener. In case, specified listener was bound several times, it removes
-     * only a single one.
-     * @param listener - event listener.
-     */
-    unsubscribe(listener: SubscribeListener<Schema>): void;
-}

package/dist/dts/events/event-emitter/types.d.ts

@@ -1,45 +0,0 @@
-import { If, IsNever, IsUndefined, Or } from '../../types/index.js';
-
-/**
- * Function accepting the list of passed arguments and returning nothing.
- */
-type VoidFunc<Args extends any[] = []> = (...args: Args) => void;
-/**
- * Accepts type assuming, it is responsible for describing event listener
- * parameters. Covers following cases:
- * 1. If function is passed, return its arguments.
- * 2. If never or void is passed, return empty tuple.
- * 3. If array is passed return this type.
- * 4. Otherwise, return tuple with passed type.
- */
-export type EventParams<Params> = Params extends any[] ? Params : Params extends (...args: any) => any ? Parameters<Params> : If<Or<IsNever<Params>, IsUndefined<Params>>, [
-], Params extends void ? [] : [Params]>;
-/**
- * Returns function that represents event listener with specified
- * list of parameters.
- */
-export type EventListener<Params> = VoidFunc<EventParams<Params>>;
-/**
- * Returns event names.
- */
-export type EventName<Schema> = Extract<keyof Schema, string>;
-/**
- * Returns event names which do not require any arguments.
- */
-export type EmptyEventName<Schema> = {
-    [E in EventName<Schema>]: EventParams<Schema[E]> extends [] ? E : never;
-}[EventName<Schema>];
-/**
- * Returns event names which require arguments.
- */
-export type NonEmptyEventName<Schema> = Exclude<EventName<Schema>, EmptyEventName<Schema>>;
-/**
- * Represents any listener, which could be used in EventEmitter.subscribe.
- */
-export type SubscribeListener<Schema> = (payload: {
-    [E in EventName<Schema>]: {
-        event: E;
-        args: EventParams<Schema[E]>;
-    };
-}[EventName<Schema>]) => void;
-export {};

package/dist/dts/events/onWindow.d.ts

@@ -1,10 +0,0 @@
-import { RemoveEventListenerFn } from './types.js';
-
-/**
- * Adds new event listener using window.addEventListener.
- * @param type - event name.
- * @param listener - event listener.
- * @param options - listening options.
- * @returns Function to remove event listener.
- */
-export declare function onWindow<K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | AddEventListenerOptions): RemoveEventListenerFn;

package/dist/dts/events/types.d.ts

@@ -1,6 +0,0 @@
-/**
- * Function, which removes bound event listener.
- */
-export interface RemoveEventListenerFn {
-    (): void;
-}

package/dist/dts/index.low-level.d.ts

@@ -1,41 +0,0 @@
-/**
- * Bridge.
- */
-export { off } from './bridge/events/listening/off.js';
-export { on } from './bridge/events/listening/on.js';
-export { subscribe } from './bridge/events/listening/subscribe.js';
-export { unsubscribe } from './bridge/events/listening/unsubscribe.js';
-export { createPostEvent } from './bridge/methods/createPostEvent.js';
-export { postEvent } from './bridge/methods/postEvent.js';
-export { setTargetOrigin, targetOrigin } from './bridge/target-origin.js';
-export { captureSameReq } from './bridge/captureSameReq.js';
-export { invokeCustomMethod } from './bridge/invokeCustomMethod.js';
-export { request } from './bridge/request.js';
-/**
- * Debug.
- */
-export { setDebug } from './debug/debug.js';
-/**
- * Env.
- */
-export { isIframe } from './env/isIframe.js';
-export { isTMA } from './env/isTMA.js';
-/**
- * Errors.
- */
-export * from './errors/errors.js';
-export { isSDKError } from './errors/isSDKError.js';
-export { isSDKErrorOfType } from './errors/isSDKErrorOfType.js';
-export { SDKError } from './errors/SDKError.js';
-/**
- * Init.
- */
-export { initWeb } from './env/initWeb.js';
-/**
- * Launch params.
- */
-export { retrieveLaunchParams } from './launch-params/retrieveLaunchParams.js';
-/**
- * Supports.
- */
-export { supports } from './supports/supports.js';

package/dist/dts/launch-params/parseLaunchParams.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * Parses value as launch parameters.
- * @param value - value to parse.
- */
-export declare function parseLaunchParams(value: unknown): LaunchParams;

package/dist/dts/launch-params/retrieveFromLocation.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * @returns Launch parameters from the current window location hash.
- * @throws Error if function was unable to extract launch parameters from the window location hash.
- */
-export declare function retrieveFromLocation(): LaunchParams;

package/dist/dts/launch-params/retrieveFromPerformance.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * @returns Launch parameters based on the first navigation entry.
- * @throws Error if function was unable to extract launch parameters from the navigation entry.
- */
-export declare function retrieveFromPerformance(): LaunchParams;

package/dist/dts/launch-params/retrieveFromStorage.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * @returns Launch parameters stored in the session storage.
- * @throws Error if function was unable to extract launch parameters from the window location hash.
- */
-export declare function retrieveFromStorage(): LaunchParams;

package/dist/dts/launch-params/retrieveFromUrl.d.ts

@@ -1,8 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * @param urlString - URL to extract launch parameters from.
- * @returns Launch parameters from the specified URL.
- * @throws Error if function was unable to extract launch parameters from the passed URL.
- */
-export declare function retrieveFromUrl(urlString: string): LaunchParams;

package/dist/dts/launch-params/retrieveLaunchParams.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * @returns Launch parameters from any known source.
- * @throws Error if extraction was unsuccessful.
- */
-export declare function retrieveLaunchParams(): LaunchParams;

package/dist/dts/launch-params/saveToStorage.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * Saves specified launch parameters in the session storage.
- * @param value - launch params to save.
- */
-export declare function saveToStorage(value: LaunchParams): void;

package/dist/dts/launch-params/serializeLaunchParams.d.ts

@@ -1,7 +0,0 @@
-import { LaunchParams } from './types.js';
-
-/**
- * Converts launch parameters to its initial representation.
- * @param value - launch parameters.
- */
-export declare function serializeLaunchParams(value: LaunchParams): string;

package/dist/dts/launch-params/types.d.ts

@@ -1,51 +0,0 @@
-import { InitDataParsed } from '../components/InitData/types.js';
-import { ThemeParamsParsed } from '../components/ThemeParams/types.js';
-import { Platform } from '../types/platform.js';
-
-/**
- * Telegram Mini Apps launch parameters.
- * @see https://docs.telegram-mini-apps.com/platform/launch-parameters
- */
-export interface LaunchParams {
-    /**
-     * True if Mini App is currently launched in inline mode.
-     */
-    botInline?: boolean;
-    /**
-     * Current launch init data. Can be missing in case, application was launched via
-     * KeyboardButton.
-     */
-    initData?: InitDataParsed;
-    /**
-     * The same as initData but in initial, raw format.
-     */
-    initDataRaw?: string;
-    /**
-     * Current Telegram application identifier.
-     */
-    platform: Platform;
-    /**
-     * True if application is required to show the Settings Button.
-     */
-    showSettings?: boolean;
-    /**
-     * Start parameter passed in the application link.
-     */
-    startParam?: string;
-    /**
-     * Mini App palette settings.
-     */
-    themeParams: ThemeParamsParsed;
-    /**
-     * Current Mini Apps version.
-     */
-    version: string;
-}
-/**
- * Known launch parameter name.
- */
-export type LaunchParamName = keyof LaunchParams;
-/**
- * Picks specified launch params.
- */
-export type PickLaunchParams<LP extends LaunchParamName> = Pick<LaunchParams, LP>;

package/dist/dts/logger/Logger.d.ts

@@ -1,29 +0,0 @@
-/**
- * Message log level.
- */
-export type LogLevel = 'log' | 'error';
-export interface LoggerOptions {
-    bgColor?: string;
-    textColor?: string;
-}
-export declare class Logger implements Pick<Console, 'log' | 'error'> {
-    private readonly scope;
-    private readonly options;
-    constructor(scope: string, options?: LoggerOptions);
-    /**
-     * Prints message into a console in case, logger is currently enabled.
-     * @param level - log level.
-     * @param args - arguments.
-     */
-    private print;
-    /**
-     * Prints error message into a console.
-     * @param args
-     */
-    error(...args: any[]): void;
-    /**
-     * Prints log message into a console.
-     * @param args
-     */
-    log(...args: any[]): void;
-}

package/dist/dts/misc/createCleanup.d.ts

@@ -1,11 +0,0 @@
-import { CleanupFn } from '../types/index.js';
-
-/**
- * Returns a tuple, containing function to add cleanup, call cleanup, and flag showing whether
- * cleanup was called. Cleanup will not be performed in case, it was done before.
- */
-export declare function createCleanup(...fns: (CleanupFn | CleanupFn[])[]): [
-    add: (fn: CleanupFn) => void,
-    cleanup: () => void,
-    cleanedUp: boolean
-];

package/dist/dts/misc/createComponentInitFn/createComponentInitFn.d.ts

@@ -1,16 +0,0 @@
-import { StorageKey, StorageValue } from '../../storage/storage.js';
-import { FactoryDynamic, FactoryStatic, InitStaticComponentFn, InitDynamicComponentFn, WithOnChange } from './types.js';
-
-/**
- * Creates a new init function based on factory, creating a component, not synchronizing its
- * state with the session storage.
- * @param factory - function creating new component instance.
- */
-export declare function createComponentInitFn<R>(factory: FactoryStatic<R>): InitStaticComponentFn<R>;
-/**
- * Creates a new init function based on factory, creating a component, synchronizing its
- * state with the session storage.
- * @param factory - function creating new component instance.
- * @param storageKey - storage key to restore component from.
- */
-export declare function createComponentInitFn<SK extends StorageKey, R extends WithOnChange<StorageValue<SK>> | Promise<WithOnChange<StorageValue<SK>>>>(storageKey: SK, factory: FactoryDynamic<R, SK>): InitDynamicComponentFn<R>;

package/dist/dts/misc/createComponentInitFn/types.d.ts

@@ -1,54 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { LaunchParams } from '../../launch-params/types.js';
-import { CreateRequestIdFn } from '../../request-id/types.js';
-import { StorageKey, StorageValue } from '../../storage/storage.js';
-import { CleanupFn, If, IsNever } from '../../types/index.js';
-import { RemoveEventListenerFn } from '../../events/types.js';
-
-/**
- * Object, which supports tracking its state changes.
- */
-export interface WithOnChange<State> {
-    on(event: 'change', listener: (state: State) => void): RemoveEventListenerFn;
-}
-/**
- * Options passed to a component factory.
- */
-export type FactoryOptions<State, SideEffects extends boolean> = LaunchParams & {
-    postEvent: PostEvent;
-    createRequestId: CreateRequestIdFn;
-} & If<IsNever<State>, {}, {
-    state?: State;
-}> & If<SideEffects, {
-    addCleanup(fn: CleanupFn): void;
-}, {}>;
-export interface Factory<Result, SideEffects extends boolean, State> {
-    /**
-     * Creates a new component instance.
-     * @param options - factory options.
-     */
-    (options: FactoryOptions<State, SideEffects>): Result;
-}
-export interface FactoryStatic<Result> extends Factory<Result, false, never> {
-}
-export interface FactoryDynamic<Result, SK extends StorageKey> extends Factory<Result, true, StorageValue<SK>> {
-}
-export interface InitComponentFn<Result, SideEffects extends boolean> {
-    /**
-     * Initializes a new static component instance.
-     */
-    (): If<SideEffects, [
-        /**
-         * Execution result.
-         */
-        result: Result,
-        /**
-         * Cleanup function.
-         */
-        cleanup: CleanupFn
-    ], Result>;
-}
-export interface InitStaticComponentFn<Result> extends InitComponentFn<Result, false> {
-}
-export interface InitDynamicComponentFn<Result> extends InitComponentFn<Result, true> {
-}

package/dist/dts/misc/createSingleton.d.ts

@@ -1,15 +0,0 @@
-/**
- * Creates resettable singleton. We mostly need it for test purposes.
- * @param create - function which creates singleton entity.
- * @param onReset - function which will be called in case, singleton was reset.
- */
-export declare function createSingleton<T>(create: (reset: () => void) => T, onReset?: (entity: T) => void): [
-    /**
-     * Returns singleton entity.
-     */
-    get: () => T,
-    /**
-     * Resets last stored entity.
-     */
-    reset: () => void
-];

package/dist/dts/misc/isRecord.d.ts

@@ -1,5 +0,0 @@
-/**
- * States that passed value is Record and not Array.
- * @param value - value to check.
- */
-export declare function isRecord(value: unknown): value is Record<string, unknown>;

package/dist/dts/misc/objectFromKeys.d.ts

@@ -1,6 +0,0 @@
-/**
- * Creates object with specified keys and value.
- * @param keys - object keys.
- * @param value - keys value.
- */
-export declare function objectFromKeys<K extends string, V>(keys: K[], value: V): Record<K, V>;

package/dist/dts/navigation/BasicNavigator/BasicNavigator.d.ts

@@ -1,118 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { BasicNavigatorAnyHistoryItem, BasicNavigatorEvents, BasicNavigatorHistoryItem } from './types.js';
-
-type Emitter<Params> = EventEmitter<BasicNavigatorEvents<Params>>;
-export declare class BasicNavigator<Params = {}> {
-    /**
-     * Currently active history item.
-     */
-    private _index;
-    /**
-     * Function to call Mini Apps methods.
-     * @default Global `postEvent` function.
-     */
-    private readonly postEvent;
-    /**
-     * Navigation history.
-     */
-    readonly history: Readonly<BasicNavigatorHistoryItem<Params>>[];
-    private readonly ee;
-    constructor(
-    /**
-     * Navigation history.
-     */
-    history: readonly BasicNavigatorAnyHistoryItem<Params>[], 
-    /**
-     * Currently active history item.
-     */
-    _index: number, 
-    /**
-     * Function to call Mini Apps methods.
-     * @default Global `postEvent` function.
-     */
-    postEvent?: PostEvent);
-    /**
-     * True, if current navigator is currently attached.
-     */
-    private attached;
-    /**
-     * Allows this navigator to control the `BackButton` visibility state. It also tracks the
-     * `BackButton` clicks and calls the `back` method.
-     */
-    attach(): void;
-    /**
-     * Goes to the previous history item.
-     */
-    back: () => void;
-    /**
-     * Currently active history item.
-     */
-    get current(): Readonly<BasicNavigatorHistoryItem<Params>>;
-    /**
-     * Prevents current navigator from controlling the BackButton visibility state.
-     */
-    detach(): void;
-    /**
-     * Goes to the next history item.
-     */
-    forward(): void;
-    /**
-     * Changes currently active history item index by the specified delta. This method doesn't
-     * change index in case, the updated index points to the non-existing history item. This behavior
-     * is preserved until the `fit` argument is specified.
-     * @param delta - index delta.
-     * @param fit - cuts the delta argument to fit the bounds `[0, history.length - 1]`.
-     */
-    go(delta: number, fit?: boolean): void;
-    /**
-     * Goes to the specified index. Method does nothing in case, passed index is out of bounds.
-     *
-     * If "fit" option was specified and index is out of bounds, it will be cut to the nearest
-     * bound.
-     * @param index - target index.
-     * @param fit - cuts the index argument to fit the bounds `[0, history.length - 1]`.
-     */
-    goTo(index: number, fit?: boolean): void;
-    /**
-     * True if navigator has items before the current item.
-     */
-    get hasPrev(): boolean;
-    /**
-     * True if navigator has items after the current item.
-     */
-    get hasNext(): boolean;
-    /**
-     * Currently active history item index.
-     */
-    get index(): number;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter<Params>['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter<Params>['off'];
-    /**
-     * Adds a new history item removing all after the current one.
-     * @param item - item to add.
-     */
-    push(item: BasicNavigatorAnyHistoryItem<Params>): void;
-    /**
-     * Replaces the current history item.
-     * @param item - item to replace the current item with.
-     */
-    replace(item: BasicNavigatorAnyHistoryItem<Params>): void;
-    /**
-     * Sets history item by the specified index.
-     * @param index - history item index to replace.
-     * @param historyItem - history item to set.
-     */
-    private replaceAndMove;
-    /**
-     * Actualizes the `BackButton` visibility state.
-     */
-    private sync;
-}
-export {};

package/dist/dts/navigation/BasicNavigator/prepareItem.d.ts

@@ -1,8 +0,0 @@
-import { BasicNavigatorAnyHistoryItem, BasicNavigatorHistoryItem } from './types.js';
-
-/**
- * Converts any known history item type to the local one.
- * @param item - history item presented as a string or an object.
- * @param relativePathname - relative pathname.
- */
-export declare function prepareItem<Params>(item: BasicNavigatorAnyHistoryItem<Params>, relativePathname: string): Readonly<BasicNavigatorHistoryItem<Params>>;

package/dist/dts/navigation/BasicNavigator/types.d.ts

@@ -1,37 +0,0 @@
-import { BasicNavigator } from './BasicNavigator.js';
-
-/**
- * History item used by the `BasicNavigator`.
- */
-export interface BasicNavigatorHistoryItem<Params> {
-    id: string;
-    pathname: string;
-    params?: Params;
-}
-/**
- * History item used by the `BasicNavigator` methods.
- */
-export type BasicNavigatorAnyHistoryItem<Params> = string | Partial<BasicNavigatorHistoryItem<Params>>;
-/**
- * Events supported by `BasicNavigator`.
- */
-export interface BasicNavigatorEvents<Params> {
-    change: {
-        /**
-         * Navigator instance.
-         */
-        navigator: BasicNavigator<Params>;
-        /**
-         * Navigator cursor delta.
-         */
-        delta: number;
-        /**
-         * Previous active history item.
-         */
-        from: BasicNavigatorHistoryItem<Params>;
-        /**
-         * Currently active history item.
-         */
-        to: BasicNavigatorHistoryItem<Params>;
-    };
-}