@tma.js/sdk 2.7.0 → 3.0.0

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@tma.js/sdk",
-  "version": "2.7.0",
+  "version": "3.0.0",
   "description": "TypeScript Source Development Kit for Telegram Mini Apps client application.",
   "author": "Vladislav Kibenko <wolfram.deus@gmail.com>",
-  "homepage": "https://github.com/Telegram-Mini-Apps/tma.js#readme",
+  "homepage": "https://github.com/Telegram-Mini-Apps/telegram-apps#readme",
   "repository": {
     "type": "git",
-    "url": "git@github.com:Telegram-Mini-Apps/tma.js.git",
-    "directory": "packages/sdk"
+    "url": "git@github.com:Telegram-Mini-Apps/telegram-apps.git",
+    "directory": "tma.js/sdk"
   },
   "bugs": {
-    "url": "https://github.com/Telegram-Mini-Apps/tma.js/issues"
+    "url": "https://github.com/Telegram-Mini-Apps/telegram-apps/issues"
   },
   "keywords": [
     "telegram-mini-apps",
@@ -34,6 +34,17 @@
       "default": "./dist/index.cjs"
     }
   },
+  "dependencies": {
+    "better-promises": "^1.0.0",
+    "error-kid": "^1.0.2",
+    "fp-ts": "^2.16.11",
+    "valibot": "^1.1.0",
+    "@tma.js/bridge": "^2.1.0",
+    "@tma.js/signals": "^1.0.0",
+    "@tma.js/toolkit": "^1.0.1",
+    "@tma.js/transformers": "^1.1.0",
+    "@tma.js/types": "^1.0.1"
+  },
   "devDependencies": {
     "test-utils": "0.0.1",
     "tsconfig": "0.0.2"
@@ -43,12 +54,11 @@
   },
   "scripts": {
     "test": "vitest --run",
-    "lint": "cd ../.. && eslint packages/sdk/src --ignore-pattern **/*.test.ts",
+    "lint": "cd ../.. && eslint tma.js/sdk/src --ignore-pattern **/*.test.ts",
     "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit -p tsconfig.build.json",
-    "build": "rimraf dist && pnpm run build:default && pnpm run build:iife && pnpm run build:iife:low-level",
+    "build": "rimraf dist && pnpm run build:default && pnpm run build:iife",
     "build:default": "vite build -c vite.config.ts",
-    "build:iife": "vite build -c vite.iife.config.ts",
-    "build:iife:low-level": "vite build -c vite.iife.low-level.config.ts"
+    "build:iife": "vite build -c vite.iife.config.ts"
   }
 }

package/dist/dts/bridge/captureSameReq.d.ts

@@ -1,10 +0,0 @@
-type CaptureSameReqFn = (payload: {
-    req_id: string;
-}) => boolean;
-/**
- * Returns a function which can be used in `request` function `capture` property to capture
- * the event with the same request identifier.
- * @param reqId - request identifier.
- */
-export declare function captureSameReq(reqId: string): CaptureSameReqFn;
-export {};

package/dist/dts/bridge/events/event-emitter/createMiniAppsEventEmitter.d.ts

@@ -1,15 +0,0 @@
-import { MiniAppsEventEmitter } from '../types.js';
-
-/**
- * Creates new event emitter, which handles events from the Telegram application.
- */
-export declare function createMiniAppsEventEmitter(): [
-    /**
-     * Created event emitter.
-     */
-    emitter: MiniAppsEventEmitter,
-    /**
-     * Function to dispose created emitter.
-     */
-    dispose: () => void
-];

package/dist/dts/bridge/events/event-emitter/singleton.d.ts

@@ -1,8 +0,0 @@
-import { MiniAppsEventEmitter } from '../types.js';
-
-declare const resetMiniAppsEventEmitter: () => void;
-/**
- * Returns Mini Apps event emitter singleton.
- */
-export declare function miniAppsEventEmitter(): MiniAppsEventEmitter;
-export { resetMiniAppsEventEmitter };

package/dist/dts/bridge/events/event-handlers/cleanupEventHandlers.d.ts

@@ -1,4 +0,0 @@
-/**
- * Removes global event handlers, used by the package.
- */
-export declare function cleanupEventHandlers(): void;

package/dist/dts/bridge/events/event-handlers/defineEventHandlers.d.ts

@@ -1,6 +0,0 @@
-/**
- * Defines special handlers by known paths, which are recognized by
- * Telegram as ports to receive events. This function also sets special
- * function in global window object to prevent duplicate declaration.
- */
-export declare function defineEventHandlers(): void;

package/dist/dts/bridge/events/event-handlers/emitMiniAppsEvent.d.ts

@@ -1,9 +0,0 @@
-/**
- * Emits event sent from Telegram native application like it was sent in
- * default web environment between 2 iframes. It dispatches new MessageEvent
- * and expects it to be handled via `window.addEventListener('message', ...)`
- * as developer would do it to handle messages sent from the parent iframe.
- * @param eventType - event name.
- * @param eventData - event payload.
- */
-export declare function emitMiniAppsEvent(eventType: string, eventData: unknown): void;

package/dist/dts/bridge/events/listening/off.d.ts

@@ -1,8 +0,0 @@
-import { MiniAppsEventListener, MiniAppsEventName } from '../types.js';
-
-/**
- * Removes listener from specified event.
- * @param event - event to listen.
- * @param listener - event listener to remove.
- */
-export declare function off<E extends MiniAppsEventName>(event: E, listener: MiniAppsEventListener<E>): void;

package/dist/dts/bridge/events/listening/on.d.ts

@@ -1,12 +0,0 @@
-import { RemoveEventListenerFn } from '../../../events/types.js';
-import { MiniAppsEventListener, MiniAppsEventName } from '../types.js';
-
-/**
- * Adds new listener to the specified event. Returns handler
- * which allows to stop listening to event.
- * @param event - event name.
- * @param listener - event listener.
- * @param once - should listener be called only once.
- * @returns Function to remove bound event listener.
- */
-export declare function on<E extends MiniAppsEventName>(event: E, listener: MiniAppsEventListener<E>, once?: boolean): RemoveEventListenerFn;

package/dist/dts/bridge/events/listening/subscribe.d.ts

@@ -1,9 +0,0 @@
-import { RemoveEventListenerFn } from '../../../events/types.js';
-import { MiniAppsSubscribeListener } from '../types.js';
-
-/**
- * Subscribes to all events sent from the native Telegram application.
- * @param listener - event listener to bind.
- * @returns Function to remove bound event listener.
- */
-export declare function subscribe(listener: MiniAppsSubscribeListener): RemoveEventListenerFn;

package/dist/dts/bridge/events/listening/unsubscribe.d.ts

@@ -1,7 +0,0 @@
-import { MiniAppsSubscribeListener } from '../types.js';
-
-/**
- * Removes global event listener.
- * @param listener - event listener.
- */
-export declare function unsubscribe(listener: MiniAppsSubscribeListener): void;

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

@@ -1,302 +0,0 @@
-import { RGB } from '../../colors/types.js';
-import { EventListener } from '../../events/event-emitter/types.js';
-import { RemoveEventListenerFn } from '../../events/types.js';
-import { EventEmitter } from '../../events/event-emitter/EventEmitter.js';
-import { RequestId } from '../../request-id/types.js';
-
-export type InvoiceStatus = 'paid' | 'failed' | 'pending' | 'cancelled' | string;
-export type PhoneRequestedStatus = 'sent' | 'cancelled' | string;
-export type WriteAccessRequestedStatus = 'allowed' | string;
-export type BiometryType = 'finger' | 'face' | string;
-export type BiometryTokenUpdateStatus = 'updated' | 'removed' | string;
-export type BiometryAuthRequestStatus = 'failed' | 'authorized' | string;
-/**
- * Map where key is known event name, and value is its listener.
- * @see https://docs.telegram-mini-apps.com/platform/events
- */
-export interface MiniAppsEvents {
-    /**
-     * User clicked the BackButton.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/events#back-button-pressed
-     */
-    back_button_pressed: never;
-    /**
-     * Biometry authentication request completed.
-     * @since 7.2
-     * @see https://docs.telegram-mini-apps.com/platform/events#biometry-auth-requested
-     */
-    biometry_auth_requested: {
-        /**
-         * Authentication status.
-         */
-        status: BiometryAuthRequestStatus;
-        /**
-         * Token from the local secure storage saved previously.
-         */
-        token?: string;
-    };
-    /**
-     * Biometry settings were received.
-     * @since 7.2
-     * @see https://docs.telegram-mini-apps.com/platform/events#biometry-info-received
-     */
-    biometry_info_received: {
-        /**
-         * Shows whether biometry is available.
-         */
-        available: false;
-    } | {
-        /**
-         * Shows whether biometry is available.
-         */
-        available: true;
-        /**
-         * Shows whether permission to use biometrics has been requested.
-         */
-        access_requested: boolean;
-        /**
-         * Shows whether permission to use biometrics has been granted.
-         */
-        access_granted: boolean;
-        /**
-         * A unique device identifier that can be used to match the token to the device.
-         */
-        device_id: string;
-        /**
-         * Show whether local storage contains previously saved token.
-         */
-        token_saved: boolean;
-        /**
-         * The type of biometrics currently available on the device.
-         */
-        type: BiometryType;
-    };
-    /**
-     * Biometry token was updated.
-     * @since 7.2
-     * @see https://docs.telegram-mini-apps.com/platform/events#biometry-token-updated
-     */
-    biometry_token_updated: {
-        /**
-         * Update status.
-         */
-        status: BiometryTokenUpdateStatus;
-    };
-    /**
-     * Telegram application attempted to extract text from clipboard.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/events#clipboard-text-received
-     */
-    clipboard_text_received: {
-        /**
-         * Passed during the `web_app_read_text_from_clipboard` method invocation `req_id` value.
-         */
-        req_id: RequestId;
-        /**
-         * Data extracted from the clipboard. The returned value will have the type `string` only in
-         * the case, application has access to the clipboard.
-         */
-        data?: string | null;
-    };
-    /**
-     * Custom method invocation completed.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/events#custom-method-invoked
-     */
-    custom_method_invoked: {
-        /**
-         * Unique identifier of this invocation.
-         */
-        req_id: RequestId;
-        /**
-         * Method invocation successful result.
-         */
-        result?: unknown;
-        /**
-         * Method invocation error code.
-         */
-        error?: string;
-    };
-    /**
-     * An invoice was closed.
-     * @see https://docs.telegram-mini-apps.com/platform/events#invoice-closed
-     */
-    invoice_closed: {
-        /**
-         * Passed during the `web_app_open_invoice` method invocation `slug` value.
-         */
-        slug: string;
-        /**
-         * Invoice status.
-         */
-        status: InvoiceStatus;
-    };
-    /**
-     * User clicked the Main Button.
-     * @see https://docs.telegram-mini-apps.com/platform/events#main-button-pressed
-     */
-    main_button_pressed: never;
-    /**
-     * Application received phone access request status.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/events#phone-requested
-     */
-    phone_requested: {
-        /**
-         * Request status.
-         */
-        status: PhoneRequestedStatus;
-    };
-    /**
-     * Popup was closed.
-     * @see https://docs.telegram-mini-apps.com/platform/events#popup-closed
-     */
-    popup_closed: {
-        /**
-         * Identifier of the clicked button. In case, the popup was closed without clicking any button,
-         * this property will be omitted.
-         */
-        button_id?: string;
-    };
-    /**
-     * The QR scanner scanned some QR and extracted its content.
-     * @param payload - event payload.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/events#qr-text-received
-     */
-    qr_text_received: {
-        /**
-         * Data extracted from the QR.
-         */
-        data?: string;
-    };
-    /**
-     * Parent iframe requested current iframe reload.
-     * @see https://docs.telegram-mini-apps.com/platform/events#reload-iframe
-     */
-    reload_iframe: never;
-    /**
-     * QR scanner was closed.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/platform/events#scan-qr-popup-closed
-     */
-    scan_qr_popup_closed: never;
-    /**
-     * The event which is usually sent by the Telegram web application. Its payload represents
-     * `<style/>` tag html content, a developer could use. The stylesheet described in the payload
-     * will help the developer to stylize the app scrollbar (but he is still able to do it himself).
-     * @see https://docs.telegram-mini-apps.com/platform/events#set-custom-style
-     */
-    set_custom_style: string;
-    /**
-     * Occurs when the Settings Button was pressed.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/platform/events#settings-button-pressed
-     */
-    settings_button_pressed: never;
-    /**
-     * Occurs whenever theme settings are changed in the user's Telegram app
-     * (including switching to night mode).
-     * @see https://docs.telegram-mini-apps.com/platform/events#theme-changed
-     */
-    theme_changed: {
-        /**
-         * Map where the key is a theme stylesheet key and value is  the corresponding color in
-         * `#RRGGBB` format.
-         */
-        theme_params: {
-            /**
-             * @since v6.10
-             */
-            accent_text_color?: RGB;
-            bg_color?: RGB;
-            button_color?: RGB;
-            button_text_color?: RGB;
-            /**
-             * @since v6.10
-             */
-            destructive_text_color?: RGB;
-            /**
-             * @since v6.10
-             */
-            header_bg_color?: RGB;
-            hint_color?: RGB;
-            link_color?: RGB;
-            secondary_bg_color?: RGB;
-            /**
-             * @since v6.10
-             */
-            section_bg_color?: RGB;
-            /**
-             * @since v6.10
-             */
-            section_header_text_color?: RGB;
-            /**
-             * @since v6.10
-             */
-            subtitle_text_color?: RGB;
-            text_color?: RGB;
-            [key: string]: RGB | undefined;
-        };
-    };
-    /**
-     * Occurs whenever the viewport has been changed. For example, when the user started
-     * dragging the application or called the expansion method.
-     * @see https://docs.telegram-mini-apps.com/platform/events#viewport-changed
-     */
-    viewport_changed: {
-        /**
-         * The viewport height.
-         */
-        height: number;
-        /**
-         * The viewport width.
-         */
-        width: number;
-        /**
-         * Is the viewport currently expanded.
-         */
-        is_expanded: boolean;
-        /**
-         * Is the viewport current state stable and not going to change in the next moment.
-         */
-        is_state_stable: boolean;
-    };
-    /**
-     * Application received write access request status.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/platform/events#write-access-requested
-     */
-    write_access_requested: {
-        /**
-         * Request status.
-         */
-        status: WriteAccessRequestedStatus;
-    };
-}
-/**
- * Mini Apps event name.
- */
-export type MiniAppsEventName = keyof MiniAppsEvents;
-/**
- * Payload of the specified Mini Apps event.
- */
-export type MiniAppsEventPayload<E extends MiniAppsEventName> = MiniAppsEvents[E];
-/**
- * Returns event listener for the specified Mini Apps event.
- */
-export type MiniAppsEventListener<E extends MiniAppsEventName> = EventListener<MiniAppsEvents[E]>;
-export interface MiniAppsEventEmitter extends Pick<EventEmitter<MiniAppsEvents>, 'on' | 'off' | 'count'> {
-    subscribe(listener: MiniAppsSubscribeListener): RemoveEventListenerFn;
-    unsubscribe(listener: MiniAppsSubscribeListener): void;
-}
-/**
- * Mini Apps event listener used in `subscribe` and `unsubscribe` functions.
- */
-export type MiniAppsSubscribeListener = (payload: {
-    [E in MiniAppsEventName]: {
-        name: E;
-        payload: MiniAppsEventPayload<E>;
-    };
-}[MiniAppsEventName]) => void;

package/dist/dts/bridge/invokeCustomMethod.d.ts

@@ -1,23 +0,0 @@
-import { ExecuteWithOptions } from '../types/index.js';
-import { CustomMethodName, CustomMethodParams } from './methods/types/custom-methods.js';
-
-/**
- * Invokes known custom method. Returns method execution result.
- * @param method - method name.
- * @param params - method parameters.
- * @param requestId - request identifier.
- * @param options - additional options.
- * @throws {SDKError} ERR_INVOKE_CUSTOM_METHOD_RESPONSE
- * @see ERR_INVOKE_CUSTOM_METHOD_RESPONSE
- */
-export declare function invokeCustomMethod<M extends CustomMethodName>(method: M, params: CustomMethodParams<M>, requestId: string, options?: ExecuteWithOptions): Promise<unknown>;
-/**
- * Invokes unknown custom method. Returns method execution result.
- * @param method - method name.
- * @param params - method parameters.
- * @param requestId - request identifier.
- * @param options - additional options.
- * @throws {SDKError} ERR_INVOKE_CUSTOM_METHOD_RESPONSE
- * @see ERR_INVOKE_CUSTOM_METHOD_RESPONSE
- */
-export declare function invokeCustomMethod(method: string, params: object, requestId: string, options?: ExecuteWithOptions): Promise<unknown>;

package/dist/dts/bridge/methods/createPostEvent.d.ts

@@ -1,14 +0,0 @@
-import { Version } from '../../version/types.js';
-import { PostEvent } from './postEvent.js';
-
-/**
- * Creates a function which checks if specified method and parameters are supported.
- *
- * If method or parameters are unsupported, an error will be thrown.
- * @param version - Telegram Mini Apps version.
- * @throws {SDKError} ERR_METHOD_UNSUPPORTED
- * @throws {SDKError} ERR_METHOD_PARAMETER_UNSUPPORTED
- * @see ERR_METHOD_UNSUPPORTED
- * @see ERR_METHOD_PARAMETER_UNSUPPORTED
- */
-export declare function createPostEvent(version: Version): PostEvent;

package/dist/dts/bridge/methods/postEvent.d.ts

@@ -1,40 +0,0 @@
-import { MiniAppsMethodParams, MiniAppsMethodWithOptionalParams, MiniAppsMethodWithoutParams, MiniAppsMethodWithRequiredParams } from './types/methods.js';
-
-interface PostEventOptions {
-    /**
-     * Origin used while posting a message.
-     *
-     * This option is only used if the current environment is browser (Web version of Telegram)
-     * and could be used for test purposes.
-     * @default 'https://web.telegram.org'
-     */
-    targetOrigin?: string;
-}
-export type PostEvent = typeof postEvent;
-/**
- * Calls Mini Apps method with optional parameters.
- * @param method - method name.
- * @param params - method parameters.
- * @param options - posting options.
- * @throws {SDKError} ERR_UNKNOWN_ENV
- * @see ERR_UNKNOWN_ENV
- */
-export declare function postEvent<Method extends MiniAppsMethodWithOptionalParams>(method: Method, params?: MiniAppsMethodParams<Method>, options?: PostEventOptions): void;
-/**
- * Calls Mini Apps method without parameters.
- * @param method - method name.
- * @param options - posting options.
- * @throws {SDKError} ERR_UNKNOWN_ENV
- * @see ERR_UNKNOWN_ENV
- */
-export declare function postEvent(method: MiniAppsMethodWithoutParams | MiniAppsMethodWithOptionalParams, options?: PostEventOptions): void;
-/**
- * Calls Mini Apps method with parameters.
- * @param method - method name.
- * @param params - method parameters.
- * @param options - posting options.
- * @throws {SDKError} ERR_UNKNOWN_ENV
- * @see ERR_UNKNOWN_ENV
- */
-export declare function postEvent<Method extends MiniAppsMethodWithRequiredParams>(method: Method, params: MiniAppsMethodParams<Method>, options?: PostEventOptions): void;
-export {};

package/dist/dts/bridge/methods/types/custom-methods.d.ts

@@ -1,57 +0,0 @@
-import { RequestId } from '../../../request-id/types.js';
-
-interface CreateInvokeCustomMethodParams<M extends string, Params extends object> {
-    /**
-     * Unique request identifier.
-     */
-    req_id: RequestId;
-    /**
-     * Method name.
-     */
-    method: M;
-    /**
-     * Method specific parameters.
-     */
-    params: Params;
-}
-export interface CustomMethodsParams {
-    /**
-     * Deletes storage values by their keys.
-     */
-    deleteStorageValues: {
-        keys: string | string[];
-    };
-    /**
-     * Gets current user contact in case, Mini has access to it.
-     */
-    getRequestedContact: {};
-    /**
-     * Gets all registered storage keys.
-     */
-    getStorageKeys: {};
-    /**
-     * Gets storage values by their keys.
-     */
-    getStorageValues: {
-        keys: string | string[];
-    };
-    /**
-     * Saves value by specified key in the storage.
-     */
-    saveStorageValue: {
-        key: string;
-        value: string;
-    };
-}
-/**
- * Known custom method name.
- */
-export type CustomMethodName = keyof CustomMethodsParams;
-/**
- * Custom method parameters.
- */
-export type CustomMethodParams<M extends CustomMethodName> = CustomMethodsParams[M];
-export type AnyInvokeCustomMethodParams = CreateInvokeCustomMethodParams<string, any> | {
-    [M in CustomMethodName]: CreateInvokeCustomMethodParams<M, CustomMethodParams<M>>;
-}[CustomMethodName];
-export {};

package/dist/dts/bridge/methods/types/haptic.d.ts

@@ -1,40 +0,0 @@
-/**
- * Generic type which creates new types of haptic feedback.
- */
-type CreateHapticFeedbackParams<T extends string, P> = {
-    type: T;
-} & P;
-/**
- * Style of impact occurred haptic event.
- * - `light`, indicates a collision between small or lightweight UI objects,
- * - `medium`, indicates a collision between medium-sized or medium-weight UI objects,
- * - `heavy`, indicates a collision between large or heavyweight UI objects,
- * - `rigid`, indicates a collision between hard or inflexible UI objects,
- * - `soft`, indicates a collision between soft or flexible UI objects.
- */
-export type ImpactHapticFeedbackStyle = 'light' | 'medium' | 'heavy' | 'rigid' | 'soft';
-/**
- * Type of notification occurred type event.
- * - `error`, indicates that a task or action has failed,
- * - `success`, indicates that a task or action has completed successfully,
- * - `warning`, indicates that a task or action produced a warning.
- */
-export type NotificationHapticFeedbackType = 'error' | 'success' | 'warning';
-/**
- * `impactOccurred` haptic feedback.
- */
-export type ImpactHapticFeedbackParams = CreateHapticFeedbackParams<'impact', {
-    impact_style: ImpactHapticFeedbackStyle;
-}>;
-/**
- * `notificationOccurred` haptic feedback.
- */
-export type NotificationHapticFeedbackParams = CreateHapticFeedbackParams<'notification', {
-    notification_type: NotificationHapticFeedbackType;
-}>;
-/**
- * `selectionChanged` haptic feedback.
- */
-export type SelectionHapticFeedbackParams = CreateHapticFeedbackParams<'selection_change', {}>;
-export type AnyHapticFeedbackParams = ImpactHapticFeedbackParams | NotificationHapticFeedbackParams | SelectionHapticFeedbackParams;
-export {};

package/dist/dts/bridge/methods/types/index.d.ts

@@ -1,4 +0,0 @@
-export * from './custom-methods.js';
-export * from './haptic.js';
-export * from './methods.js';
-export * from './popup.js';