@tma.js/sdk 1.5.2 → 2.0.0

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

@@ -1,104 +0,0 @@
-import type { AnyEntry, NavigationEntry, NavigatorConEntry, NavigatorOptions, PerformGoOptions, PerformPushOptions, PerformReplaceOptions } from './types.js';
-import { Logger } from '../../logger/Logger.js';
-/**
- * Represents basic navigator implementation which uses only memory to store and control
- * navigation state.
- */
-export declare abstract class Navigator<T> {
-    protected entriesCursor: number;
-    protected logger: Logger;
-    protected readonly entries: NavigationEntry[];
-    constructor(entries: NavigatorConEntry[], entriesCursor: number, { debug, loggerPrefix, }: NavigatorOptions);
-    protected abstract performGo(options: PerformGoOptions): T;
-    protected abstract performPush(options: PerformPushOptions): T;
-    protected abstract performReplace(options: PerformReplaceOptions): T;
-    /**
-     * Converts entry to the navigation entry.
-     * @param entry - entry data
-     */
-    private formatEntry;
-    /**
-     * Current entry.
-     */
-    protected get entry(): NavigationEntry;
-    /**
-     * Goes back in history.
-     */
-    back(): T;
-    /**
-     * Current entries cursor.
-     */
-    get cursor(): number;
-    /**
-     * True if navigator can go back.
-     */
-    get canGoBack(): boolean;
-    /**
-     * True if navigator can go forward.
-     */
-    get canGoForward(): boolean;
-    /**
-     * Goes forward in history.
-     */
-    forward(): T;
-    /**
-     * Moves entries cursor by specified delta.
-     * @param delta - cursor delta.
-     */
-    go(delta: number): T;
-    /**
-     * Returns copy of navigator entries.
-     */
-    getEntries(): NavigationEntry[];
-    /**
-     * Current hash.
-     * @example
-     * "", "#", "#hash"
-     */
-    get hash(): string;
-    /**
-     * Pushes new entry. Method replaces all entries after the current one with the inserted.
-     * @param entry - entry data.
-     *
-     * @example Pushing absolute pathname.
-     * push("/absolute-path"); // "/absolute-path"
-     *
-     * @example Pushing relative pathname.
-     * // Pushing relative path replaces N last path parts, where N is pushed pathname parts count.
-     * // Pushing empty path is recognized as relative, but not replacing the last pathname part.
-     * push("relative"); // "/home/root" -> "/home/relative"
-     *
-     * @example Pushing query parameters.
-     * push("/absolute?my-param=1"); // "/home" -> "/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("johny#my-hash"); // "/home/root" -> "/home/johny#my-hash"
-     */
-    push(entry: AnyEntry): T;
-    /**
-     * Current full path including pathname, query parameters and hash.
-     */
-    get path(): string;
-    /**
-     * Current pathname.
-     * @example
-     * "/", "/abc"
-     */
-    get pathname(): string;
-    /**
-     * Replaces current entry. Has the same logic as `push` method.
-     * @param entry - entry data.
-     * @see push
-     * @returns True if changes were done.
-     */
-    replace(entry: AnyEntry): T;
-    /**
-     * Current query parameters.
-     * @example
-     * "", "?", "?a=1"
-     */
-    get search(): string;
-}

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

@@ -1,44 +0,0 @@
-export interface NavigationEntry {
-    pathname: string;
-    search: string;
-    hash: string;
-}
-export type NavigatorConEntry = Partial<NavigationEntry>;
-/**
- * Entry information is allowed to be used in `push` and `replace` Navigator methods.
- * Should be either path or object partially describing it.
- */
-export type AnyEntry = string | Partial<NavigationEntry>;
-export type PerformGoOptions = {
-    updated: false;
-    delta: number;
-} | {
-    updated: true;
-    delta: number;
-    before: NavigationEntry;
-    after: NavigationEntry;
-};
-export interface PerformPushOptions {
-    before: NavigationEntry;
-    after: NavigationEntry;
-}
-export type PerformReplaceOptions = {
-    updated: false;
-    entry: NavigationEntry;
-} | {
-    updated: true;
-    before: NavigationEntry;
-    after: NavigationEntry;
-};
-export interface NavigatorOptions {
-    /**
-     * Should navigator display debug messages.
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Prefix used for logger.
-     * @default 'Navigator'
-     */
-    loggerPrefix?: string;
-}

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

@@ -1,18 +0,0 @@
-import type { AnyParser } from './types.js';
-import type { ParseResult, ValueParserOverrides } from './ValueParser.js';
-import { ValueParser } from './ValueParser.js';
-export type OfResult<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>): OfResult<BaseClass, Item, IsOptional>;
-}
-export type ArrayParserType<BaseClass, ItemType, IsOptional extends boolean> = Omit<BaseClass, keyof ArrayParserOverrides<any, any, any>> & ArrayParserOverrides<BaseClass, ItemType, IsOptional>;
-export declare class ArrayValueParser<ItemType, IsOptional extends boolean> extends ValueParser<unknown[], IsOptional> {
-    private itemParser;
-    constructor(itemParser: AnyParser<ItemType>, isOptional: IsOptional, type?: string);
-    parse(value: unknown): ParseResult<ItemType[], IsOptional>;
-    of<Item>(itemParser: AnyParser<Item>): OfResult<this, Item, IsOptional>;
-}

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

@@ -1,22 +0,0 @@
-interface Options {
-    /**
-     * Type name.
-     */
-    type?: string;
-    /**
-     * Original occurred error.
-     */
-    cause?: unknown;
-}
-/**
- * Error thrown in case, there was an error during parsing.
- */
-export declare class ParseError extends Error {
-    readonly value: unknown;
-    /**
-     * Parser name.
-     */
-    readonly type?: string;
-    constructor(value: unknown, { cause, type }?: Options);
-}
-export {};

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

@@ -1,17 +0,0 @@
-interface Options {
-    /**
-     * Type name.
-     */
-    type?: string;
-    /**
-     * Original occurred error.
-     */
-    cause?: unknown;
-}
-/**
- * Error thrown in case, there was an error during parse.
- */
-export declare class ParseSchemaFieldError extends Error {
-    constructor(field: string, { cause, type }?: Options);
-}
-export {};

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

@@ -1,4 +0,0 @@
-/**
- * Creates instance of TypeError stating, that value has unexpected type.
- */
-export declare function unexpectedTypeError(): TypeError;

package/dist/dts/state/State.d.ts

@@ -1,28 +0,0 @@
-import type { StateEvents } from './types.js';
-import type { EventEmitter } from '../event-emitter/EventEmitter.js';
-import type { StringKeys } from '../types/utils.js';
-/**
- * Represents state which is observable via passed EventEmitter.
- */
-export declare class State<S extends object> {
-    private readonly state;
-    private readonly ee;
-    constructor(state: S, ee: Pick<EventEmitter<StateEvents<S>>, 'on' | 'off' | 'emit'>);
-    private internalSet;
-    /**
-     * Returns copy of current state.
-     */
-    clone(): S;
-    /**
-     * Sets value by key.
-     * @param key - state key.
-     * @param value - value to set.
-     */
-    set<K extends StringKeys<S>>(key: K, value: S[K]): void;
-    set(state: Partial<S>): void;
-    /**
-     * Returns value by specified key.
-     * @param key - state key.
-     */
-    get<K extends StringKeys<S>>(key: K): S[K];
-}

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

@@ -1,27 +0,0 @@
-import type { StringKeys } from '../types/utils.js';
-/**
- * Computes state property changed event.
- */
-export type PropChangedEvent<K extends string> = `change:${K}`;
-/**
- * Extracts state property type by its computed change event name.
- */
-export type PropertyType<State extends object, Event extends string> = {
-    [Key in StringKeys<State>]: Event extends PropChangedEvent<Key> ? State[Key] : never;
-}[StringKeys<State>];
-/**
- * Creates map, where key is event name which is used, when state property was changed.
- * Value is according listener.
- */
-export type PropChangedEventsMap<State extends object> = {
-    [Event in PropChangedEvent<StringKeys<State>>]: (value: PropertyType<State, Event>) => void;
-};
-/**
- * Creates map with all events emitted by state.
- */
-export type StateEvents<State extends object> = PropChangedEventsMap<State> & {
-    /**
-     * Being called whenever any property was updated.
-     */
-    change: () => void;
-};

package/dist/dts/storage.d.ts

@@ -1,50 +0,0 @@
-import type { HeaderColorKey } from './bridge/methods/methods.js';
-import type { RGB } from './colors/types.js';
-/**
- * Describes storage keys and according values.
- */
-interface StorageParams {
-    'back-button': {
-        isVisible: boolean;
-    };
-    'closing-behavior': {
-        isConfirmationNeeded: boolean;
-    };
-    'main-button': {
-        backgroundColor: RGB;
-        isEnabled: boolean;
-        isLoaderVisible: boolean;
-        isVisible: boolean;
-        text: string;
-        textColor: RGB;
-    };
-    'settings-button': {
-        isVisible: boolean;
-    };
-    viewport: {
-        height: number;
-        isExpanded: boolean;
-        stableHeight: number;
-        width: number;
-    };
-    'mini-app': {
-        backgroundColor: RGB;
-        headerColor: HeaderColorKey | RGB;
-    };
-}
-/**
- * Key which could be used to store data in storage.
- */
-type StorageKey = keyof StorageParams;
-/**
- * Saves value in sessionStorage.
- * @param key - storage key.
- * @param value - storage value.
- */
-export declare function saveStorageValue<K extends StorageKey>(key: K, value: StorageParams[K]): void;
-/**
- * Extracts value from the sessionStorage.
- * @param key - storage key.
- */
-export declare function getStorageValue<K extends StorageKey>(key: K): StorageParams[K] | null;
-export {};

package/dist/dts/supports/createSupportsFunc.d.ts

@@ -1,10 +0,0 @@
-import type { SupportsFunc } from './types.js';
-import type { MiniAppsMethodName } from '../bridge/methods/methods.js';
-import type { Version } from '../version/types.js';
-/**
- * Returns function, which accepts predefined method name and checks if it is supported
- * via passed schema and version.
- * @param schema - object which contains methods names and TWA method as a dependency.
- * @param version - platform version.
- */
-export declare function createSupportsFunc<M extends string>(version: Version, schema: Record<M, MiniAppsMethodName>): SupportsFunc<M>;

package/dist/dts/timeout/TimeoutError.d.ts

@@ -1,3 +0,0 @@
-export declare class TimeoutError extends Error {
-    constructor(timeout: number);
-}

package/dist/dts/timeout/isTimeoutError.d.ts

@@ -1,6 +0,0 @@
-import { TimeoutError } from './TimeoutError.js';
-/**
- * Returns true in case, passed value is TimeoutError.
- * @param value - checked value.
- */
-export declare function isTimeoutError(value: unknown): value is TimeoutError;