@tma.js/sdk 2.6.1 → 3.0.0

package/dist/dts/classes/WithSupportsAndStateUtils.d.ts

@@ -1,24 +0,0 @@
-import { WithStateUtils } from './WithStateUtils.js';
-import { MiniAppsMethodName } from '../bridge/methods/types/methods.js';
-import { SupportsFn } from '../supports/types.js';
-import { Version } from '../version/types.js';
-
-export declare class WithSupportsAndStateUtils<StateShape extends object, SupportsMethod extends string> extends WithStateUtils<StateShape> {
-    constructor(
-    /**
-     * Initial state.
-     */
-    stateShape: StateShape, 
-    /**
-     * Mini Apps version.
-     */
-    version: Version, 
-    /**
-     * Supports method schema.
-     */
-    supportsSchema: Record<SupportsMethod, MiniAppsMethodName>);
-    /**
-     * @returns True, if specified method is supported by the current component.
-     */
-    supports: SupportsFn<SupportsMethod>;
-}

package/dist/dts/classes/WithSupportsAndTrackableState.d.ts

@@ -1,16 +0,0 @@
-import { WithSupportsAndStateUtils } from './WithSupportsAndStateUtils.js';
-import { StateEvents } from './State/types.js';
-import { EventEmitter } from '../events/event-emitter/EventEmitter.js';
-
-type Emitter<StateShape extends object> = EventEmitter<StateEvents<StateShape>>;
-export declare class WithSupportsAndTrackableState<StateShape extends object, SupportsMethod extends string> extends WithSupportsAndStateUtils<StateShape, SupportsMethod> {
-    /**
-     * Adds a new event listener.
-     */
-    on: Emitter<StateShape>['on'];
-    /**
-     * Removes the event listener.
-     */
-    off: Emitter<StateShape>['off'];
-}
-export {};

package/dist/dts/classes/WithTrackableState.d.ts

@@ -1,16 +0,0 @@
-import { WithStateUtils } from './WithStateUtils.js';
-import { StateEvents } from './State/types.js';
-import { EventEmitter } from '../events/event-emitter/EventEmitter.js';
-
-type Emitter<StateShape extends object> = EventEmitter<StateEvents<StateShape>>;
-export declare class WithTrackableState<StateShape extends object> extends WithStateUtils<StateShape> {
-    /**
-     * Adds a new event listener.
-     */
-    on: Emitter<StateShape>['on'];
-    /**
-     * Removes the event listener.
-     */
-    off: Emitter<StateShape>['off'];
-}
-export {};

package/dist/dts/classnames/classNames.d.ts

@@ -1,12 +0,0 @@
-/**
- * Function which joins passed values with space following these rules:
- * 1. If value is non-empty string, it will be added to output.
- * 2. If value is object, only those keys will be added, which values are truthy.
- * 3. If value is array, classNames will be called with this value spread.
- * 4. All other values are ignored.
- *
- * You can find this function to similar one from the package {@link https://www.npmjs.com/package/classnames|classnames}.
- * @param values - values array.
- * @returns Final class name.
- */
-export declare function classNames(...values: any[]): string;

package/dist/dts/classnames/mergeClassNames.d.ts

@@ -1,14 +0,0 @@
-import { UnionOptionalKeys, UnionRequiredKeys } from '../types/unions.js';
-
-export type MergeClassNames<Tuple extends any[]> = Exclude<Tuple[number], number | string | null | undefined | any[] | boolean> extends infer Union ? {
-    [K in UnionRequiredKeys<Union>]: string;
-} & {
-    [K in UnionOptionalKeys<Union>]?: string;
-} : never;
-/**
- * Merges 2 sets of parameters. Function expects passing an array of objects with values, which
- * could be passed to `classNames` function. As the result, it returns an object with keys
- * from all objects with merged values.
- * @see classNames
- */
-export declare function mergeClassNames<T extends any[]>(...partials: T): MergeClassNames<T>;

package/dist/dts/colors/isColorDark.d.ts

@@ -1,6 +0,0 @@
-/**
- * Returns true in case, the color is recognized as dark.
- * @param color - color in any format acceptable by toRGB function.
- * @see toRGB
- */
-export declare function isColorDark(color: string): boolean;

package/dist/dts/colors/isRGB.d.ts

@@ -1,7 +0,0 @@
-import { RGB } from './types.js';
-
-/**
- * Returns true in case, passed value has #RRGGBB format.
- * @param value - value to check.
- */
-export declare function isRGB(value: string): value is RGB;

package/dist/dts/colors/isRGBShort.d.ts

@@ -1,7 +0,0 @@
-import { RGBShort } from './types.js';
-
-/**
- * Returns true in case, passed value has #RGB format.
- * @param value - value to check.
- */
-export declare function isRGBShort(value: string): value is RGBShort;

package/dist/dts/colors/toRGB.d.ts

@@ -1,12 +0,0 @@
-import { RGB } from './types.js';
-
-/**
- * Converts passed value to #RRGGBB format. Accepts following color formats:
- * - `#RGB`
- * - `#RRGGBB`
- * - `rgb(1,2,3)`
- * - `rgba(1,2,3,4)`
- * @param value - value to convert.
- * @throws {Error} Passed value does not satisfy any of known RGB formats.
- */
-export declare function toRGB(value: string): RGB;

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

@@ -1,8 +0,0 @@
-/**
- * Color in format #RGB.
- */
-export type RGBShort = `#${string}`;
-/**
- * Color in format #RRGGBB.
- */
-export type RGB = `#${string}`;

package/dist/dts/components/BackButton/BackButton.d.ts

@@ -1,41 +0,0 @@
-import { WithSupportsAndStateUtils } from '../../classes/WithSupportsAndStateUtils.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { BackButtonEvents, BackButtonState } from './types.js';
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { Version } from '../../version/types.js';
-
-type Emitter = EventEmitter<BackButtonEvents>;
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/back-button
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/back-button
- */
-export declare class BackButton extends WithSupportsAndStateUtils<BackButtonState, 'show' | 'hide'> {
-    private readonly postEvent;
-    constructor(isVisible: boolean, version: Version, postEvent: PostEvent);
-    private set isVisible(value);
-    /**
-     * True if BackButton is currently visible.
-     */
-    get isVisible(): boolean;
-    /**
-     * Hides the BackButton.
-     */
-    hide(): void;
-    /**
-     * Adds a new event listener.
-     * @param event - event to listen.
-     * @param listener - listener to add.
-     */
-    on: Emitter['on'];
-    /**
-     * Removes the event listener.
-     * @param event - event to listen.
-     * @param listener - listener to remove.
-     */
-    off: Emitter['off'];
-    /**
-     * Shows the BackButton.
-     */
-    show(): void;
-}
-export {};

package/dist/dts/components/BackButton/initBackButton.d.ts

@@ -1,7 +0,0 @@
-import { BackButton } from './BackButton.js';
-
-/**
- * @returns A new initialized instance of the `BackButton` class.
- * @see BackButton
- */
-export declare const initBackButton: import('../../index.js').InitDynamicComponentFn<BackButton>;

package/dist/dts/components/BackButton/types.d.ts

@@ -1,25 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-
-/**
- * BackButton internal state.
- */
-export interface BackButtonState {
-    isVisible: boolean;
-}
-/**
- * BackButton trackable events.
- */
-export interface BackButtonEvents extends StateEvents<BackButtonState> {
-    /**
-     * The BackButton was clicked.
-     */
-    click: () => void;
-}
-/**
- * BackButton event name.
- */
-export type BackButtonEventName = keyof BackButtonEvents;
-/**
- * BackButton event listener.
- */
-export type BackButtonEventListener<E extends BackButtonEventName> = BackButtonEvents[E];

package/dist/dts/components/BiometryManager/BiometryManager.d.ts

@@ -1,61 +0,0 @@
-import { WithSupportsAndTrackableState } from '../../classes/WithSupportsAndTrackableState.js';
-import { BiometryType } from '../../bridge/events/types.js';
-import { BiometryManagerAuthenticateOptions, BiometryManagerProps, BiometryManagerRequestAccessOptions, BiometryManagerState, BiometryManagerUpdateTokenOptions } from './types.js';
-
-export declare class BiometryManager extends WithSupportsAndTrackableState<BiometryManagerState, 'auth' | 'openSettings' | 'requestAccess' | 'updateToken'> {
-    private readonly postEvent;
-    private authPromise?;
-    private accessPromise?;
-    constructor({ postEvent, version, ...rest }: BiometryManagerProps);
-    /**
-     * Shows whether biometry is available.
-     */
-    get available(): boolean;
-    /**
-     * Shows whether permission to use biometrics has been granted.
-     */
-    get accessGranted(): boolean;
-    /**
-     * Shows whether if permission to use biometrics has been requested.
-     */
-    get accessRequested(): boolean;
-    /**
-     * Authenticates the user using biometrics.
-     * @param options - method options.
-     * @since 7.2
-     * @returns Token from the local secure storage, if authentication was successful.
-     */
-    authenticate({ reason, ...rest }: BiometryManagerAuthenticateOptions): Promise<string | undefined>;
-    /**
-     * A unique device identifier that can be used to match the token to the device.
-     */
-    get deviceId(): string;
-    /**
-     * Opens the biometric access settings for bots. Useful when you need to request biometrics
-     * access to users who haven't granted it yet.
-     *
-     * _Note that this method can be called only in response to user interaction with the Mini App
-     * interface (e.g. a click inside the Mini App or on the main button)_.
-     * @since 7.2
-     */
-    openSettings(): void;
-    /**
-     * Requests permission to use biometrics.
-     * @since 7.2
-     * @returns Promise with true, if access was granted.
-     */
-    requestAccess({ reason, ...rest }?: BiometryManagerRequestAccessOptions): Promise<boolean>;
-    /**
-     * The type of biometrics currently available on the device.
-     */
-    get biometryType(): BiometryType | undefined;
-    /**
-     * Shows whether token was saved previously in the local secure storage.
-     */
-    get tokenSaved(): boolean;
-    /**
-     * Updates the biometric token in a secure storage on the device.
-     * @returns Promise with `true`, if token was updated.
-     */
-    updateToken({ token, ...rest }?: BiometryManagerUpdateTokenOptions): Promise<boolean>;
-}

package/dist/dts/components/BiometryManager/formatEvent.d.ts

@@ -1,34 +0,0 @@
-import { BiometryType, MiniAppsEventPayload } from '../../bridge/events/types.js';
-
-export interface FormatBiometryInfoResult {
-    /**
-     * Shows whether biometry is available.
-     */
-    available: boolean;
-    /**
-     * Shows whether permission to use biometrics has been requested.
-     */
-    accessRequested: boolean;
-    /**
-     * Shows whether permission to use biometrics has been granted.
-     */
-    accessGranted: boolean;
-    /**
-     * A unique device identifier that can be used to match the token to the device.
-     */
-    deviceId: string;
-    /**
-     * Show whether local storage contains previously saved token.
-     */
-    tokenSaved: boolean;
-    /**
-     * The type of biometrics currently available on the device.
-     */
-    type: BiometryType;
-}
-/**
- * Converts `biometry_info_received` to some common shape.
- * @param event - event payload.
- * @see biometry_info_received
- */
-export declare function formatEvent(event: MiniAppsEventPayload<'biometry_info_received'>): FormatBiometryInfoResult;

package/dist/dts/components/BiometryManager/initBiometryManager.d.ts

@@ -1,7 +0,0 @@
-import { BiometryManager } from './BiometryManager.js';
-
-/**
- * @returns A promise with a new initialized instance of the `BiometryManager` class.
- * @see BiometryManager
- */
-export declare const initBiometryManager: import('../../index.js').InitDynamicComponentFn<Promise<BiometryManager>>;

package/dist/dts/components/BiometryManager/requestBiometryInfo.d.ts

@@ -1,8 +0,0 @@
-import { ExecuteWithOptions } from '../../types/index.js';
-import { FormatBiometryInfoResult } from './formatEvent.js';
-
-/**
- * Requests biometry information.
- * @param options - additional execution options.
- */
-export declare function requestBiometryInfo(options?: ExecuteWithOptions): Promise<FormatBiometryInfoResult>;

package/dist/dts/components/BiometryManager/types.d.ts

@@ -1,40 +0,0 @@
-import { BiometryType } from '../../bridge/events/types.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { ExecuteWithTimeout, Maybe } from '../../types/index.js';
-import { Version } from '../../version/types.js';
-
-export interface BiometryManagerState {
-    accessGranted: boolean;
-    accessRequested: boolean;
-    available: boolean;
-    deviceId: string;
-    tokenSaved: boolean;
-    token?: string;
-    biometryType?: BiometryType;
-}
-export interface BiometryManagerProps extends BiometryManagerState {
-    postEvent: PostEvent;
-    version: Version;
-}
-export interface BiometryManagerAuthenticateOptions extends ExecuteWithTimeout {
-    /**
-     * The text to be displayed to a user in the popup describing why you are
-     * asking them to authenticate and what action you will be taking based on that
-     * authentication, 0-128 characters.
-     */
-    reason?: Maybe<string>;
-}
-export interface BiometryManagerUpdateTokenOptions extends ExecuteWithTimeout {
-    /**
-     * Token to save in the local device secure storage. Passing `null`, `undefined` or empty string
-     * removes it from the storage.
-     */
-    token?: Maybe<string>;
-}
-export interface BiometryManagerRequestAccessOptions extends ExecuteWithTimeout {
-    /**
-     * The text to be displayed to a user in the popup describing why the bot needs access to
-     * biometrics, 0-128 characters.
-     */
-    reason?: Maybe<string>;
-}

package/dist/dts/components/ClosingBehavior/ClosingBehavior.d.ts

@@ -1,26 +0,0 @@
-import { WithTrackableState } from '../../classes/WithTrackableState.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { ClosingBehaviorState } from './types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/closing-behavior
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/closing-behavior
- */
-export declare class ClosingBehavior extends WithTrackableState<ClosingBehaviorState> {
-    private readonly postEvent;
-    constructor(isConfirmationNeeded: boolean, postEvent: PostEvent);
-    private set isConfirmationNeeded(value);
-    /**
-     * True, if the confirmation dialog should be shown while the user is trying to close
-     * the Mini App.
-     */
-    get isConfirmationNeeded(): boolean;
-    /**
-     * Disables the confirmation dialog when closing the Mini App.
-     */
-    disableConfirmation(): void;
-    /**
-     * Enables the confirmation dialog when closing the Mini App.
-     */
-    enableConfirmation(): void;
-}

package/dist/dts/components/ClosingBehavior/initClosingBehavior.d.ts

@@ -1,7 +0,0 @@
-import { ClosingBehavior } from './ClosingBehavior.js';
-
-/**
- * @returns A new initialized instance of the `ClosingBehavior` class.
- * @see ClosingBehavior
- */
-export declare const initClosingBehavior: import('../../index.js').InitDynamicComponentFn<ClosingBehavior>;

package/dist/dts/components/ClosingBehavior/types.d.ts

@@ -1,20 +0,0 @@
-import { StateEvents } from '../../classes/State/types.js';
-
-/**
- * ClosingBehavior internal state.
- */
-export interface ClosingBehaviorState {
-    isConfirmationNeeded: boolean;
-}
-/**
- * ClosingBehavior trackable events.
- */
-export type ClosingBehaviorEvents = StateEvents<ClosingBehaviorState>;
-/**
- * ClosingBehavior event name.
- */
-export type ClosingBehaviorEventName = keyof ClosingBehaviorEvents;
-/**
- * ClosingBehavior event listener.
- */
-export type ClosingBehaviorEventListener<E extends ClosingBehaviorEventName> = ClosingBehaviorEvents[E];

package/dist/dts/components/CloudStorage/CloudStorage.d.ts

@@ -1,47 +0,0 @@
-import { WithSupports } from '../../classes/WithSupports.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { CreateRequestIdFn } from '../../request-id/types.js';
-import { ExecuteWithTimeout } from '../../types/methods.js';
-import { Version } from '../../version/types.js';
-
-/**
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/cloud-storage
- */
-export declare class CloudStorage extends WithSupports<'delete' | 'get' | 'getKeys' | 'set'> {
-    private readonly createRequestId;
-    private readonly postEvent;
-    constructor(version: Version, createRequestId: CreateRequestIdFn, postEvent: PostEvent);
-    /**
-     * Deletes specified key or keys from the cloud storage.
-     * @param keyOrKeys - key or keys to delete.
-     * @param options - request execution options.
-     */
-    delete(keyOrKeys: string | string[], options?: ExecuteWithTimeout): Promise<void>;
-    /**
-     * Returns list of all keys presented in the cloud storage.
-     * @param options - request execution options.
-     */
-    getKeys(options?: ExecuteWithTimeout): Promise<string[]>;
-    /**
-     * Returns map, where key is one of the specified in keys argument, and value is according
-     * storage value.
-     * @param keys - keys list.
-     * @param options - request execution options.
-     */
-    get<K extends string>(keys: K[], options?: ExecuteWithTimeout): Promise<Record<K, string>>;
-    /**
-     * Returns value of the specified key.
-     * @param key - cloud storage key.
-     * @param options - request execution options.
-     * @return Value of the specified key. In case, key was not created previously, function
-     * will return empty string.
-     */
-    get(key: string, options?: ExecuteWithTimeout): Promise<string>;
-    /**
-     * Saves specified value by key.
-     * @param key - storage key.
-     * @param value - storage value.
-     * @param options - request execution options.
-     */
-    set(key: string, value: string, options?: ExecuteWithTimeout): Promise<void>;
-}

package/dist/dts/components/CloudStorage/initCloudStorage.d.ts

@@ -1,7 +0,0 @@
-import { CloudStorage } from './CloudStorage.js';
-
-/**
- * @returns A new initialized instance of the `CloudStorage` class.
- * @see CloudStorage
- */
-export declare const initCloudStorage: import('../../index.js').InitStaticComponentFn<CloudStorage>;

package/dist/dts/components/HapticFeedback/HapticFeedback.d.ts

@@ -1,34 +0,0 @@
-import { WithSupports } from '../../classes/WithSupports.js';
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { ImpactHapticFeedbackStyle, NotificationHapticFeedbackType } from '../../bridge/methods/types/haptic.js';
-import { Version } from '../../version/types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/haptic-feedback
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/components/haptic-feedback
- */
-export declare class HapticFeedback extends WithSupports<'impactOccurred' | 'notificationOccurred' | 'selectionChanged'> {
-    private readonly postEvent;
-    constructor(version: Version, postEvent: PostEvent);
-    /**
-     * A method tells that an impact occurred. The Telegram app may play the
-     * appropriate haptics based on style value passed.
-     * @param style - impact style.
-     */
-    impactOccurred(style: ImpactHapticFeedbackStyle): void;
-    /**
-     * A method tells that a task or action has succeeded, failed, or produced
-     * a warning. The Telegram app may play the appropriate haptics based on
-     * type value passed.
-     * @param type - notification type.
-     */
-    notificationOccurred(type: NotificationHapticFeedbackType): void;
-    /**
-     * A method tells that the user has changed a selection. The Telegram app
-     * may play the appropriate haptics.
-     *
-     * Do not use this feedback when the user makes or confirms a selection;
-     * use it only when the selection changes.
-     */
-    selectionChanged(): void;
-}

package/dist/dts/components/HapticFeedback/initHapticFeedback.d.ts

@@ -1,7 +0,0 @@
-import { HapticFeedback } from './HapticFeedback.js';
-
-/**
- * @returns A new initialized instance of the `HapticFeedback` class.
- * @see HapticFeedback
- */
-export declare const initHapticFeedback: import('../../index.js').InitStaticComponentFn<HapticFeedback>;

package/dist/dts/components/InitData/InitData.d.ts

@@ -1,55 +0,0 @@
-import { Chat, ChatType, InitDataParsed, User } from './types.js';
-
-/**
- * @see Usage: https://docs.telegram-mini-apps.com/platform/init-data
- * @see API: https://docs.telegram-mini-apps.com/packages/tma-js-sdk/init-data
- */
-export declare class InitData {
-    private readonly initData;
-    constructor(initData: InitDataParsed);
-    /**
-     * @see InitDataParsed.authDate
-     */
-    get authDate(): Date;
-    /**
-     * @see InitDataParsed.canSendAfter
-     */
-    get canSendAfter(): number | undefined;
-    /**
-     * Date after which it is allowed to call
-     * the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method.
-     */
-    get canSendAfterDate(): Date | undefined;
-    /**
-     * @see InitDataParsed.chat
-     */
-    get chat(): Chat | undefined;
-    /**
-     * @see InitDataParsed.chatType
-     */
-    get chatType(): ChatType | undefined;
-    /**
-     * @see InitDataParsed.chatInstance
-     */
-    get chatInstance(): string | undefined;
-    /**
-     * @see InitDataParsed.hash
-     */
-    get hash(): string;
-    /**
-     * @see InitDataParsed.queryId
-     */
-    get queryId(): string | undefined;
-    /**
-     * @see InitDataParsed.receiver
-     */
-    get receiver(): User | undefined;
-    /**
-     * @see InitDataParsed.startParam
-     */
-    get startParam(): string | undefined;
-    /**
-     * @see InitDataParsed.user
-     */
-    get user(): User | undefined;
-}

package/dist/dts/components/InitData/initInitData.d.ts

@@ -1,7 +0,0 @@
-import { InitData } from './InitData.js';
-
-/**
- * @returns A new initialized instance of the `InitData` class or undefined.
- * @see InitData
- */
-export declare const initInitData: import('../../index.js').InitStaticComponentFn<InitData | undefined>;

package/dist/dts/components/InitData/parseInitData.d.ts

@@ -1,7 +0,0 @@
-import { InitDataParsed } from './types.js';
-
-/**
- * Parses incoming value as init data.
- * @param value - value to parse.
- */
-export declare function parseInitData(value: unknown): InitDataParsed;

package/dist/dts/components/InitData/parsers/chat.d.ts

@@ -1,3 +0,0 @@
-import { Chat } from '../types.js';
-
-export declare const chat: import('../../../parsing/ValueParser/types.js').ValueParserOptionalResult<import('../../../parsing/ValueParser/ValueParser.js').ValueParser<Chat, false>, Chat>;

package/dist/dts/components/InitData/parsers/initData.d.ts

@@ -1,7 +0,0 @@
-import { ValueParser } from '../../../parsing/ValueParser/ValueParser.js';
-import { InitDataParsed } from '../types.js';
-
-/**
- * Returns parser used to parse init data, presented as search params.
- */
-export declare function initData(): ValueParser<InitDataParsed, false>;

package/dist/dts/components/InitData/parsers/user.d.ts

@@ -1,3 +0,0 @@
-import { User } from '../types.js';
-
-export declare const user: import('../../../parsing/ValueParser/types.js').ValueParserOptionalResult<import('../../../parsing/ValueParser/ValueParser.js').ValueParser<User, false>, User>;