@tma.js/sdk 2.6.1 → 3.0.0

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

@@ -1,198 +0,0 @@
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { BrowserNavigatorAnyHistoryItem, BrowserNavigatorConOptions, BrowserNavigatorEvents, BrowserNavigatorHashMode, BrowserNavigatorHistoryItem, URLLike } from './types.js';
-
-type Emitter<State> = EventEmitter<BrowserNavigatorEvents<State>>;
-export declare class BrowserNavigator<State = {}> {
-    private readonly navigator;
-    private readonly ee;
-    readonly hashMode: BrowserNavigatorHashMode | null;
-    readonly base: string;
-    constructor(
-    /**
-     * Navigation history.
-     */
-    history: readonly BrowserNavigatorAnyHistoryItem<State>[], 
-    /**
-     * Currently active history item index.
-     */
-    index: number, { postEvent, hashMode, base }?: BrowserNavigatorConOptions);
-    /**
-     * Shows whether the navigator is currently attached to the browser history.
-     */
-    private attached;
-    /**
-     * Attaches current navigator to the browser history allowing navigator to manipulate it.
-     */
-    attach(): Promise<void>;
-    /**
-     * Goes back in history by 1.
-     */
-    back(): void;
-    /**
-     * Detaches current navigator from the browser history.
-     */
-    detach(): void;
-    /**
-     * Goes forward in history.
-     */
-    forward(): void;
-    /**
-     * Current history cursor.
-     */
-    get index(): number;
-    /**
-     * Current history item identifier.
-     */
-    get id(): string;
-    /**
-     * 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;
-    /**
-     * Current history item hash.
-     * @see URL.hash
-     * @example
-     * "", "#my-hash"
-     */
-    get hash(): string;
-    /**
-     * True if navigator has items before the current item.
-     */
-    get hasPrev(): boolean;
-    /**
-     * True if navigator has items after the current item.
-     */
-    get hasNext(): boolean;
-    /**
-     * Navigation history.
-     */
-    get history(): BrowserNavigatorHistoryItem<State>[];
-    /**
-     * Handles the window "popstate" event.
-     * @param state - event state.
-     */
-    private onPopState;
-    /**
-     * Underlying navigator change event listener.
-     */
-    private onNavigatorChange;
-    /**
-     * Adds new event listener.
-     */
-    on: Emitter<State>['on'];
-    /**
-     * Removes event listener.
-     */
-    off: Emitter<State>['off'];
-    /**
-     * Path, including pathname, search and hash.
-     * @example Pathname only.
-     * "/pathname"
-     * @example Pathname + search.
-     * "/pathname?search"
-     * @example Pathname + hash.
-     * "/pathname#hash"
-     * @example Pathname + search + hash.
-     * "/pathname?search#hash"
-     */
-    get path(): string;
-    /**
-     * Current pathname. Always starts with the slash.
-     * @see URL.pathname
-     * @example
-     * "/", "/abc"
-     */
-    get pathname(): string;
-    /**
-     * Depending on the current navigation type, parses incoming path and returns it presented as
-     * an object. In other words, this method parses the passed path and returns object, describing
-     * how the navigator "sees" it.
-     *
-     * @example Hash mode is omitted.
-     * parsePath('/abc?a=1#hash');
-     * // { pathname: '/abc', search: '?a=1', hash: '#hash' }
-     * parsePath('http://example.com/abc?a=1#hash');
-     * // { pathname: '/abc', search: '?a=1', hash: '#hash' }
-     *
-     * @example Hash mode is enabled.
-     * parsePath('/abc?a=1#tma?is=cool#yeah');
-     * // { pathname: '/tma', search: '?is=cool', hash: '#yeah' }
-     * parsePath('http://example.com/abc?a=1#tma?is=cool#yeah');
-     * // { pathname: '/tma', search: '?is=cool', hash: '#yeah' }
-     */
-    parsePath(path: string | URL): URLLike;
-    /**
-     * Pushes new history item. Method replaces all entries after the current one with the one
-     * being pushed. Take a note, that passed item is always relative. In case, you want to use
-     * it as an absolute one, use the "/" prefix. Example: "/absolute", { pathname: "/absolute" }.
-     *
-     * To create a final path, navigator uses a method, used in the URL class constructor, resolving
-     * a path based on the current one.
-     * @param path - entry path.
-     * @param state - entry state.
-     *
-     * @example Pushing an absolute path.
-     * push("/absolute"); // "/absolute"
-     *
-     * @example Pushing a relative path.
-     * push("relative"); // "/home/root" -> "/home/relative"
-     *
-     * @example Pushing query parameters.
-     * push("/absolute?my-param=1"); // "/home/root" -> "/absolute?my-param=1"
-     * push("relative?my-param=1"); // "/home/root" -> "/home/relative?my-param=1"
-     * push("?my-param=1"); // "/home" -> "/home?my-param=1"
-     *
-     * @example Pushing hash.
-     * push("#my-hash"); // "/home" -> "/home#my-hash"
-     * push("relative#my-hash"); // "/home/root" -> "/home/relative#my-hash"
-     *
-     * @example Pushing state.
-     * push("", { state: 'my-state' }); "/home/root" -> "/home/root"
-     * push({ state: 'my-state' }); "/home/root" -> "/home/root"
-     */
-    push(path: string, state?: State): void;
-    push(item: BrowserNavigatorAnyHistoryItem<State>): void;
-    /**
-     * Replaces the current history item. Has the same logic as the `push` method.
-     * @param path - entry path.
-     * @param state - entry state.
-     * @see push
-     */
-    replace(path: string, state?: State): void;
-    replace(item: BrowserNavigatorAnyHistoryItem<State>): void;
-    /**
-     * Combines the navigator `base` property with the passed path data applying the navigator
-     * navigation mode.
-     * @param value - path presented as string or URLLike.
-     */
-    renderPath(value: string | URLLike): string;
-    /**
-     * Synchronizes current navigator state with browser history.
-     */
-    private syncHistory;
-    /**
-     * Current query parameters.
-     * @see URL.search
-     * @example
-     * "", "?", "?a=1"
-     */
-    get search(): string;
-    /**
-     * Current history item state.
-     */
-    get state(): State | undefined;
-}
-export {};

package/dist/dts/navigation/BrowserNavigator/basicItemToBrowser.d.ts

@@ -1,7 +0,0 @@
-import { BasicNavigatorHistoryItem } from '../BasicNavigator/types.js';
-import { BrowserNavigatorHistoryItem, BrowserNavigatorHistoryItemParams } from './types.js';
-
-/**
- * Converts basic navigator entry to browser navigator entry.
- */
-export declare function basicItemToBrowser<State>({ params, ...rest }: BasicNavigatorHistoryItem<BrowserNavigatorHistoryItemParams<State>>): BrowserNavigatorHistoryItem<State>;

package/dist/dts/navigation/BrowserNavigator/createBrowserNavigatorFromLocation.d.ts

@@ -1,4 +0,0 @@
-import { BrowserNavigator } from './BrowserNavigator.js';
-import { BrowserNavigatorConOptions } from './types.js';
-
-export declare function createBrowserNavigatorFromLocation<State>(options?: BrowserNavigatorConOptions): BrowserNavigator<State>;

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

@@ -1,25 +0,0 @@
-import { BrowserNavigatorAnyHistoryItem } from './types.js';
-
-interface PrepareItemResult<State> {
-    id?: string;
-    pathname: string;
-    params: {
-        hash: string;
-        search: string;
-        state?: State;
-    };
-}
-/**
- * Converts a path, presented as a string to a basic navigator appropriate form.
- * @param path - full path.
- * @param relativePath - relative path.
- * @param state - history item state.
- */
-export declare function prepareItem<State>(path: string, relativePath: string, state?: State): PrepareItemResult<State>;
-/**
- * Converts a path, presented as an object to a basic navigator appropriate form.
- * @param item - history item data.
- * @param relativePath - relative path.
- */
-export declare function prepareItem<State>(item: BrowserNavigatorAnyHistoryItem<State>, relativePath: string): PrepareItemResult<State>;
-export {};

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

@@ -1,64 +0,0 @@
-import { PostEvent } from '../../bridge/methods/postEvent.js';
-import { BrowserNavigator } from './BrowserNavigator.js';
-
-/**
- * Minimal set of properties we are working with in this library.
- */
-export interface URLLike extends Pick<URL, 'pathname' | 'search' | 'hash'> {
-}
-export interface BrowserNavigatorConOptions {
-    /**
-     * Base navigator URL.
-     * @default ""
-     */
-    base?: string;
-    /**
-     * Hash navigation mode. Pass null to enable MPA (Multi Page Application) navigation.
-     * @default 'classic'
-     */
-    hashMode?: BrowserNavigatorHashMode | null;
-    /**
-     * Function to call Mini Apps methods.
-     * @default Global postEvent function.
-     */
-    postEvent?: PostEvent;
-}
-export interface BrowserNavigatorHistoryItemParams<State> extends Pick<URLLike, 'search' | 'hash'> {
-    state?: State;
-}
-export interface BrowserNavigatorHistoryItem<State> extends URLLike {
-    id: string;
-    state?: State;
-}
-export type BrowserNavigatorAnyHistoryItem<State> = string | Partial<BrowserNavigatorHistoryItem<State>>;
-/**
- * Hash navigation mode.
- * @example 'classic'
- * '#pathname?search'
- * @example 'slash'
- * '#/pathname?search'
- */
-export type BrowserNavigatorHashMode = 'classic' | 'slash';
-/**
- * Events supported by `BrowserNavigator`.
- */
-export interface BrowserNavigatorEvents<State> {
-    change: {
-        /**
-         * Navigator instance.
-         */
-        navigator: BrowserNavigator<State>;
-        /**
-         * Navigator cursor delta.
-         */
-        delta: number;
-        /**
-         * Previous active history item.
-         */
-        from: BrowserNavigatorHistoryItem<State>;
-        /**
-         * Currently active history item.
-         */
-        to: BrowserNavigatorHistoryItem<State>;
-    };
-}

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

@@ -1,7 +0,0 @@
-import { URLLike } from './BrowserNavigator/types.js';
-
-/**
- * Safely creates new instance of URL with some predefined protocol and hostname.
- * @param urlOrPath - URL instance or path.
- */
-export declare function createSafeURL(urlOrPath: string | Partial<URLLike>): URL;

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

@@ -1,4 +0,0 @@
-/**
- * Drops current browser history switching browser history cursor to the first one entry.
- */
-export declare function drop(): Promise<void>;

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

@@ -1,7 +0,0 @@
-/**
- * Ensures, that specified value starts with the specified prefix. If it doesn't, function appends
- * prefix.
- * @param value - value to check.
- * @param prefix - prefix to add.
- */
-export declare function ensurePrefix(value: string, prefix: string): string;

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

@@ -1,6 +0,0 @@
-/**
- * Returns the first navigation entry from window.performance.
- * @returns First navigation entry or null, in case performance functionality is not supported
- * or navigation entry was not found.
- */
-export declare function getFirstNavigationEntry(): PerformanceNavigationTiming | undefined;

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

@@ -1,15 +0,0 @@
-/**
- * @param value - string to take hash part from.
- * @returns String after the first met "#" symbol. In case, value doesn't contain hashtag, the
- * function will return null.
- *
- * @example No hash.
- * getHash('/path'); // null
- *
- * @example Has hash.
- * getHash('/path#abc'); // 'abc'
- *
- * @example Has double hash.
- * getHash('/path#abc#another'); // 'abc#another'
- */
-export declare function getHash(value: string): string | null;

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

@@ -1,7 +0,0 @@
-import { URLLike } from './BrowserNavigator/types.js';
-
-/**
- * Extracts pathname from the value.
- * @param value - source value.
- */
-export declare function getPathname(value: string | Partial<URLLike>): string;

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

@@ -1,5 +0,0 @@
-/**
- * Performs window.history.go operation waiting for it to be completed.
- * @param delta - history change delta.
- */
-export declare function go(delta: number): Promise<boolean>;

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

@@ -1,9 +0,0 @@
-import { BrowserNavigatorConOptions } from './BrowserNavigator/types.js';
-import { BrowserNavigator } from './BrowserNavigator/BrowserNavigator.js';
-
-/**
- * Initializes a standard Mini Apps navigator.
- * @param sessionStorageKey - session storage key, containing the navigator state.
- * @param options - additional BrowserNavigator options.
- */
-export declare function initNavigator<State>(sessionStorageKey: string, options?: BrowserNavigatorConOptions): BrowserNavigator<State>;

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

@@ -1,7 +0,0 @@
-import { URLLike } from './BrowserNavigator/types.js';
-
-/**
- * Extracts path part from a URL.
- * @param urlOrPath - URL instance or path.
- */
-export declare function urlToPath(urlOrPath: string | Partial<URLLike>): string;

package/dist/dts/parsing/ArrayParser/ArrayParser.d.ts

@@ -1,17 +0,0 @@
-import { ValueParser } from '../ValueParser/ValueParser.js';
-import { ArrayParserOfResult } from '../ArrayParser/types.js';
-import { AnyParser } from '../types.js';
-import { ValueParserParseResult } from '../ValueParser/types.js';
-
-export declare class ArrayParser<ItemType, IsOptional extends boolean> extends ValueParser<unknown[], IsOptional> {
-    private itemParser;
-    constructor(itemParser: AnyParser<ItemType>, isOptional: IsOptional, type?: string);
-    /**
-     * Attempts to parse passed value
-     * @param value - value to parse.
-     * @throws {SDKError} ERR_PARSE
-     * @see ERR_PARSE
-     */
-    parse(value: unknown): ValueParserParseResult<ItemType[], IsOptional>;
-    of<Item>(itemParser: AnyParser<Item>): ArrayParserOfResult<this, Item, IsOptional>;
-}

package/dist/dts/parsing/ArrayParser/types.d.ts

@@ -1,12 +0,0 @@
-import { AnyParser } from '../types.js';
-import { ValueParserOverrides } from '../ValueParser/types.js';
-
-export type ArrayParserOfResult<BaseClass, ItemType, IsOptional extends boolean> = ArrayParserType<BaseClass, ItemType, IsOptional>;
-export interface ArrayParserOverrides<BaseClass, ItemType, IsOptional extends boolean> extends ValueParserOverrides<BaseClass, ItemType[], IsOptional> {
-    /**
-     * Specifies parser for each array item.
-     * @param parser - item parser.
-     */
-    of<Item>(parser: AnyParser<Item>): ArrayParserOfResult<BaseClass, Item, IsOptional>;
-}
-export type ArrayParserType<BaseClass, ItemType, IsOptional extends boolean> = Omit<BaseClass, keyof ArrayParserOverrides<any, any, any>> & ArrayParserOverrides<BaseClass, ItemType, IsOptional>;

package/dist/dts/parsing/ValueParser/ValueParser.d.ts

@@ -1,17 +0,0 @@
-import { Parser } from '../types.js';
-import { ValueParserOptionalResult, ValueParserParseResult } from './types.js';
-
-export declare class ValueParser<ResultType, IsOptional extends boolean> {
-    protected parser: Parser<ResultType>;
-    protected isOptional: IsOptional;
-    protected type?: string | undefined;
-    constructor(parser: Parser<ResultType>, isOptional: IsOptional, type?: string | undefined);
-    /**
-     * Attempts to parse passed value
-     * @param value - value to parse.
-     * @throws {SDKError} ERR_PARSE
-     * @see ERR_PARSE
-     */
-    parse(value: unknown): ValueParserParseResult<ResultType, IsOptional>;
-    optional(): ValueParserOptionalResult<this, ResultType>;
-}

package/dist/dts/parsing/ValueParser/types.d.ts

@@ -1,28 +0,0 @@
-import { If } from '../../types/logical.js';
-
-/**
- * Result of "parse" function.
- */
-export type ValueParserParseResult<ResultType, IsOptional extends boolean> = ResultType | If<IsOptional, undefined, never>;
-/**
- * Result of "optional" function in ValueParser.
- */
-export type ValueParserOptionalResult<BaseClass, ResultType> = ValueParserType<BaseClass, ResultType, true>;
-export interface ValueParserOverrides<BaseClass, ResultType, IsOptional extends boolean> {
-    /**
-     * Parses incoming value applying parsing function passed via constructor.
-     * @param value - value to parse.
-     */
-    parse(value: unknown): ValueParserParseResult<ResultType, IsOptional>;
-    /**
-     * Marks this parser result as optional. This makes the parser to check if passed value
-     * is empty. If so, parser will return undefined value instead of passing it to the actual
-     * parser.
-     */
-    optional(): ValueParserOptionalResult<BaseClass, ResultType>;
-}
-/**
- * Describes generated ValueParser interface. Shortly saying, this type overrides BaseClass
- * properties defined in ValueParser.
- */
-export type ValueParserType<BaseClass, ResultType, IsOptional extends boolean> = Omit<BaseClass, keyof ValueParserOverrides<any, any, any>> & ValueParserOverrides<BaseClass, ResultType, IsOptional>;

package/dist/dts/parsing/createTypeError.d.ts

@@ -1,6 +0,0 @@
-import { SDKError } from '../errors/SDKError.js';
-
-/**
- * Creates instance of TypeError stating, that value has unexpected type.
- */
-export declare function createTypeError(): SDKError;

package/dist/dts/parsing/createValueParserGenerator.d.ts

@@ -1,10 +0,0 @@
-import { ValueParser } from './ValueParser/ValueParser.js';
-import { Parser } from './types.js';
-
-export type ValueParserGenerator<T> = () => ValueParser<T, false>;
-/**
- * Creates function which generates new scalar value parser based on the specified one.
- * @param parser - parser to use as basic.
- * @param type - type name.
- */
-export declare function createValueParserGenerator<T>(parser: Parser<T>, type?: string): ValueParserGenerator<T>;

package/dist/dts/parsing/parseBySchema.d.ts

@@ -1,9 +0,0 @@
-import { Schema } from './types.js';
-
-/**
- * Parses external value by specified schema. Functions iterates over each schema field
- * and uses getField function to get its value from the external source.
- * @param schema - object schema.
- * @param getField - function which gets external value by its field name.
- */
-export declare function parseBySchema<T>(schema: Schema<T>, getField: (field: string) => unknown): T;

package/dist/dts/parsing/parsers/array.d.ts

@@ -1,7 +0,0 @@
-import { ArrayParser } from '../ArrayParser/ArrayParser.js';
-
-/**
- * Parses incoming value as an array.
- * @param parserTypeName - parser type name.
- */
-export declare function array(parserTypeName?: string): ArrayParser<unknown, false>;

package/dist/dts/parsing/parsers/boolean.d.ts

@@ -1,6 +0,0 @@
-import { ValueParserGenerator } from '../createValueParserGenerator.js';
-
-/**
- * Returns parser to parse value as boolean.
- */
-export declare const boolean: ValueParserGenerator<boolean>;

package/dist/dts/parsing/parsers/date.d.ts

@@ -1,6 +0,0 @@
-import { ValueParserGenerator } from '../createValueParserGenerator.js';
-
-/**
- * Returns parser to parse value as Date.
- */
-export declare const date: ValueParserGenerator<Date>;

package/dist/dts/parsing/parsers/json.d.ts

@@ -1,9 +0,0 @@
-import { ValueParser } from '../ValueParser/ValueParser.js';
-import { Schema } from '../types.js';
-
-/**
- * Creates new Json parser according to passed schema.
- * @param schema - object schema.
- * @param type - parser type name.
- */
-export declare function json<T>(schema: Schema<T>, type?: string): ValueParser<T, false>;

package/dist/dts/parsing/parsers/number.d.ts

@@ -1,6 +0,0 @@
-import { ValueParserGenerator } from '../createValueParserGenerator.js';
-
-/**
- * Returns parser to parse value as number.
- */
-export declare const number: ValueParserGenerator<number>;

package/dist/dts/parsing/parsers/rgb.d.ts

@@ -1,7 +0,0 @@
-import { RGB } from '../../colors/types.js';
-import { ValueParserGenerator } from '../createValueParserGenerator.js';
-
-/**
- * Returns parser to parse value as RGB color.
- */
-export declare const rgb: ValueParserGenerator<RGB>;

package/dist/dts/parsing/parsers/searchParams.d.ts

@@ -1,9 +0,0 @@
-import { ValueParser } from '../ValueParser/ValueParser.js';
-import { Schema } from '../types.js';
-
-/**
- * Creates new search params parser according to passed schema.
- * @param schema - object schema.
- * @param type - parser type name.
- */
-export declare function searchParams<T>(schema: Schema<T>, type?: string): ValueParser<T, false>;

package/dist/dts/parsing/parsers/string.d.ts

@@ -1,6 +0,0 @@
-import { ValueParserGenerator } from '../createValueParserGenerator.js';
-
-/**
- * Returns parser to parse value as string.
- */
-export declare const string: ValueParserGenerator<string>;

package/dist/dts/parsing/toRecord.d.ts

@@ -1,7 +0,0 @@
-/**
- * Converts value to record.
- * @param value - value to convert.
- * @throws {Error} Value passed as a string does not represent JSON object.
- * @throws {Error} Value is not convertable.
- */
-export declare function toRecord(value: unknown): Record<string, unknown>;

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

@@ -1,30 +0,0 @@
-/**
- * Represents any known parser.
- */
-export type AnyParser<T> = Parser<T> | {
-    parse: Parser<T>;
-};
-/**
- * Detailed schema field options.
- */
-export interface SchemaFieldDetailed<T> {
-    /**
-     * Source property name.
-     * @default Original property name in schema.
-     */
-    from?: string;
-    /**
-     * Function which should parse incoming value and return expected type.
-     */
-    type: AnyParser<T>;
-}
-/**
- * Function which parses incoming value.
- */
-export type Parser<T> = (value: unknown) => T;
-/**
- * Object schema definition.
- */
-export type Schema<T> = {
-    [K in keyof T]: AnyParser<T[K]> | SchemaFieldDetailed<T[K]>;
-};

package/dist/dts/request-id/createRequestIdGenerator.d.ts

@@ -1,6 +0,0 @@
-import { CreateRequestIdFn } from './types.js';
-
-/**
- * Creates function which generated request identifiers.
- */
-export declare function createRequestIdGenerator(): CreateRequestIdFn;

package/dist/dts/request-id/types.d.ts

@@ -1,9 +0,0 @@
-/**
- * Request identifier which should be generated locally. Native Telegram application
- * uses it to generate a response to called method.
- */
-export type RequestId = string;
-/**
- * Function which generates unique request identifiers.
- */
-export type CreateRequestIdFn = () => RequestId;