@tma.js/bridge 1.4.0 → 2.0.0

package/package.json

@@ -1,64 +1,64 @@
 {
   "name": "@tma.js/bridge",
-  "version": "1.4.0",
-  "description": "Communication layer between Telegram and frontend applications.",
+  "version": "2.0.0",
+  "description": "TypeScript package to provide communication layer between Mini App and Telegram 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+https://github.com/Telegram-Mini-Apps/tma.js.git",
-    "directory": "packages/bridge"
+    "url": "git@github.com:Telegram-Mini-Apps/telegram-apps.git",
+    "directory": "tma.js/bridge"
   },
   "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",
     "typescript",
-    "bridge",
-    "webview"
+    "bridge"
   ],
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "main": "./dist/index.cjs",
-  "browser": "./dist/index.iife.js",
-  "module": "./dist/index.mjs",
+  "module": "./dist/index.js",
   "types": "./dist/dts/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/dts/index.d.ts",
-      "import": "./dist/index.mjs",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     }
   },
   "dependencies": {
-    "@tma.js/colors": "0.0.5",
-    "@tma.js/event-emitter": "0.1.0",
-    "@tma.js/logger": "0.0.5",
-    "@tma.js/parsing": "1.0.0",
-    "@tma.js/util-types": "0.0.3",
-    "@tma.js/utils": "0.5.6"
+    "better-promises": "^1.0.0",
+    "error-kid": "^1.0.2",
+    "fp-ts": "^2.16.11",
+    "mitt": "^3.0.1",
+    "valibot": "^1.1.0",
+    "@tma.js/signals": "^1.0.0",
+    "@tma.js/toolkit": "^1.0.0",
+    "@tma.js/transformers": "^1.0.0",
+    "@tma.js/types": "^1.0.0"
   },
   "devDependencies": {
-    "build-utils": "0.0.1",
-    "eslint-config-custom": "0.1.0",
+    "test-utils": "0.0.1",
     "tsconfig": "0.0.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "test": "vitest",
-    "lint": "eslint -c .eslintrc.cjs src/**/* tests/**/*",
+    "test": "vitest --run",
+    "lint": "cd ../.. && eslint tma.js/bridge/src --ignore-pattern **/*.test.ts",
+    "lint:fix": "pnpm run lint --fix",
     "typecheck": "tsc --noEmit -p tsconfig.build.json",
-    "build": "pnpm run build:default && pnpm run build:iife",
-    "build:default": "vite build --config vite.config.ts",
-    "build:iife": "vite build --config vite.iife.config.ts"
+    "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"
   }
 }

package/dist/dts/env.d.ts

@@ -1,29 +0,0 @@
-type AnyFunc = (...args: unknown[]) => unknown;
-type WithExternalNotify<T> = T & {
-    external: {
-        notify: AnyFunc;
-    };
-};
-type WithWebviewProxy<T> = T & {
-    TelegramWebviewProxy: {
-        postEvent: AnyFunc;
-    };
-};
-/**
- * Returns true in case, passed value contains path `external.notify` property and `notify` is a
- * function.
- * @param value - value to check.
- */
-export declare function hasExternalNotify<T extends {}>(value: T): value is WithExternalNotify<T>;
-/**
- * Returns true in case, passed value contains path `TelegramWebviewProxy.postEvent` property and
- * `postEvent` is a function.
- * @param value - value to check.
- */
-export declare function hasWebviewProxy<T extends {}>(value: T): value is WithWebviewProxy<T>;
-/**
- * Returns true in case, current environment is iframe.
- * @see https://stackoverflow.com/a/326076
- */
-export declare function isIframe(): boolean;
-export {};

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

@@ -1,8 +0,0 @@
-import type { Version } from '@tma.js/utils';
-import type { MethodName } from '../methods/index.js';
-/**
- * Error thrown in case, unsupported method was called.
- */
-export declare class MethodUnsupportedError extends Error {
-    constructor(method: MethodName, version: Version);
-}

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

@@ -1,8 +0,0 @@
-import type { Version } from '@tma.js/utils';
-import type { MethodName } from '../methods/index.js';
-/**
- * Error thrown in case, unsupported parameter was used.
- */
-export declare class ParameterUnsupportedError extends Error {
-    constructor(method: MethodName, param: string, version: Version);
-}

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

@@ -1,2 +0,0 @@
-export * from './MethodUnsupportedError.js';
-export * from './ParameterUnsupportedError.js';

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

@@ -1,130 +0,0 @@
-import type { EventEmitter as UtilEventEmitter, EventListener as UtilEventListener, EventParams as UtilEventParams, AnySubscribeListener } from '@tma.js/event-emitter';
-import type { IsNever, Not } from '@tma.js/util-types';
-import type { ClipboardTextReceivedPayload, CustomMethodInvokedPayload, InvoiceClosedPayload, PhoneRequestedPayload, PopupClosedPayload, QrTextReceivedPayload, ThemeChangedPayload, ViewportChangedPayload, WriteAccessRequestedPayload } from './payloads.js';
-/**
- * Map where key is known event name, and value is its listener.
- * @see https://docs.telegram-mini-apps.com/apps-communication/events
- */
-export interface Events {
-    /**
-     * User clicked back button.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#back-button-pressed
-     */
-    back_button_pressed: () => void;
-    /**
-     * Telegram application attempted to extract text from clipboard.
-     * @param payload - event payload.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#clipboard-text-received
-     */
-    clipboard_text_received: (payload: ClipboardTextReceivedPayload) => void;
-    /**
-     * Custom method invocation completed.
-     * @param payload - event payload.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#custom-method-invoked
-     */
-    custom_method_invoked: (payload: CustomMethodInvokedPayload) => void;
-    /**
-     * An invoice was closed.
-     * @param payload - invoice close information.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#invoice-closed
-     */
-    invoice_closed: (payload: InvoiceClosedPayload) => void;
-    /**
-     * User clicked the Main Button.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#main-button-pressed
-     */
-    main_button_pressed: () => void;
-    /**
-     * Application received phone access request status.
-     * @param payload - event payload.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#phone-requested
-     */
-    phone_requested: (payload: PhoneRequestedPayload) => void;
-    /**
-     * Popup was closed.
-     * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#popup-closed
-     */
-    popup_closed: (payload: PopupClosedPayload) => void;
-    /**
-     * Parent iframe requested current iframe reload.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#reload-iframe
-     */
-    reload_iframe: () => void;
-    /**
-     * The QR scanner scanned some QR and extracted its content.
-     * @param payload - event payload.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#qr-text-received
-     */
-    qr_text_received: (payload: QrTextReceivedPayload) => void;
-    /**
-     * QR scanner was closed.
-     * @since v6.4
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#scan-qr-popup-closed
-     */
-    scan_qr_popup_closed: () => void;
-    /**
-     * 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).
-     * @param html - `style` tag inner HTML.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#set-custom-style
-     */
-    set_custom_style: (html: string) => void;
-    /**
-     * Occurs when the Settings Button was pressed.
-     * @since v6.1
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#settings-button-pressed
-     */
-    settings_button_pressed: () => void;
-    /**
-     * Occurs whenever theme settings are changed in the user's Telegram app
-     * (including switching to night mode).
-     * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#theme-changed
-     */
-    theme_changed: (payload: ThemeChangedPayload) => void;
-    /**
-     * Occurs whenever the viewport has been changed. For example, when the user started
-     * dragging the application or called the expansion method.
-     * @param payload - event payload.
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#viewport-changed
-     */
-    viewport_changed: (payload: ViewportChangedPayload) => void;
-    /**
-     * Application received write access request status.
-     * @param payload - event payload.
-     * @since v6.9
-     * @see https://docs.telegram-mini-apps.com/apps-communication/events#write-access-requested
-     */
-    write_access_requested: (payload: WriteAccessRequestedPayload) => void;
-}
-/**
- * Any known event name.
- */
-export type EventName = keyof Events;
-/**
- * Parameters of specified event.
- */
-export type EventParams<E extends EventName> = UtilEventParams<Events[E]>[0];
-/**
- * Returns event listener for specified event name.
- */
-export type EventListener<E extends EventName> = UtilEventListener<Events[E]>;
-/**
- * Event emitter, based describe events map.
- */
-export type EventEmitter = UtilEventEmitter<Events>;
-/**
- * Returns true in case, event has parameters.
- */
-export type EventHasParams<E extends EventName> = Not<IsNever<EventParams<E>>>;
-/**
- * Event listener used in `subscribe` and `unsubscribe` functions.
- */
-export type GlobalEventListener = AnySubscribeListener<Events> | ((event: string, data: unknown) => void);

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

@@ -1,7 +0,0 @@
-export type * from './events.js';
-export * from './off.js';
-export * from './on.js';
-export * from './once.js';
-export type * from './payloads.js';
-export * from './subscribe.js';
-export * from './unsubscribe.js';

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

@@ -1,7 +0,0 @@
-import type { EventName, EventListener } from './events.js';
-/**
- * Removes listener from specified event.
- * @param event - event to listen.
- * @param listener - event listener.
- */
-export declare function off<E extends EventName>(event: E, listener: EventListener<E>): void;

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

@@ -1,10 +0,0 @@
-import type { EventName, EventListener } from './events.js';
-type StopListening = () => void;
-/**
- * Adds new listener to the specified event. Returns handler
- * which allows to stop listening to event.
- * @param event - event name.
- * @param listener - event listener.
- */
-export declare function on<E extends EventName>(event: E, listener: EventListener<E>): StopListening;
-export {};

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

@@ -1,7 +0,0 @@
-/**
- * Adds listener to window "message" event assuming, that this event could
- * be sent by Telegram native application. Calls passed callback with event
- * type and data.
- * @param cb - callback to call.
- */
-export declare function onTelegramEvent(cb: (eventType: string, eventData: unknown) => void): void;

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

@@ -1,9 +0,0 @@
-import type { EventName, EventListener } from './events.js';
-type StopListening = () => void;
-/**
- * Works the same as "on" method, but after catching the event, will remove event listener.
- * @param event - event name.
- * @param listener - event listener.
- */
-export declare function once<E extends EventName>(event: E, listener: EventListener<E>): StopListening;
-export {};

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

@@ -1,38 +0,0 @@
-import type { ClipboardTextReceivedPayload, CustomMethodInvokedPayload, InvoiceClosedPayload, PhoneRequestedPayload, PopupClosedPayload, QrTextReceivedPayload, ThemeChangedPayload, ViewportChangedPayload, WriteAccessRequestedPayload } from './payloads.js';
-/**
- * Parses incoming value as ThemeChangedPayload.
- */
-export declare const themeChangedPayload: import("@tma.js/parsing").ValueParser<ThemeChangedPayload, false>;
-/**
- * Parses incoming value as ViewportChangedPayload.
- * @param value - value to parse.
- */
-export declare const viewportChangedPayload: import("@tma.js/parsing").ValueParser<ViewportChangedPayload, false>;
-/**
- * Parses incoming value as PopupClosedPayload.
- */
-export declare const popupClosedPayload: import("@tma.js/parsing").ValueParser<PopupClosedPayload, false>;
-/**
- * Parses incoming value as QrTextReceivedPayload.
- */
-export declare const qrTextReceivedPayload: import("@tma.js/parsing").ValueParser<QrTextReceivedPayload, false>;
-/**
- * Parses incoming value as InvoiceClosedPayload.
- */
-export declare const invoiceClosedPayload: import("@tma.js/parsing").ValueParser<InvoiceClosedPayload, false>;
-/**
- * Parses incoming value as clipboard text received payload.
- */
-export declare const clipboardTextReceivedPayload: import("@tma.js/parsing").ValueParser<ClipboardTextReceivedPayload, false>;
-/**
- * Parses incoming value as WriteAccessRequestedPayload.
- */
-export declare const writeAccessRequestedPayload: import("@tma.js/parsing").ValueParser<WriteAccessRequestedPayload, false>;
-/**
- * Parses incoming value as PhoneRequestedPayload.
- */
-export declare const phoneRequestedPayload: import("@tma.js/parsing").ValueParser<PhoneRequestedPayload, false>;
-/**
- * Parses incoming value as CustomMethodInvokedPayload.
- */
-export declare const customMethodInvokedPayload: import("@tma.js/parsing").ValueParser<CustomMethodInvokedPayload<unknown>, false>;

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

@@ -1,93 +0,0 @@
-import type { RGB } from '@tma.js/colors';
-import type { RequestId } from '../shared.js';
-export interface ClipboardTextReceivedPayload {
-    /**
-     * 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;
-}
-export interface CustomMethodInvokedPayload<R = unknown> {
-    /**
-     * Unique identifier of this invocation.
-     */
-    req_id: RequestId;
-    /**
-     * Method invocation successful result.
-     */
-    result?: R;
-    /**
-     * Method invocation error code.
-     */
-    error?: string;
-}
-export type InvoiceStatus = 'paid' | 'failed' | 'pending' | 'cancelled' | string;
-export interface InvoiceClosedPayload {
-    /**
-     * Passed during the `web_app_open_invoice` method invocation `slug` value.
-     */
-    slug: string;
-    /**
-     * Invoice status
-     */
-    status: InvoiceStatus;
-}
-export interface QrTextReceivedPayload {
-    /**
-     * Data extracted from the QR.
-     */
-    data?: string;
-}
-export type ThemeParamsKey = 'accent_text_color' | 'bg_color' | 'button_color' | 'button_text_color' | 'destructive_text_color' | 'header_bg_color' | 'hint_color' | 'link_color' | 'secondary_bg_color' | 'section_header_text_color' | 'section_bg_color' | 'subtitle_text_color' | 'text_color';
-export interface ThemeChangedPayload {
-    /**
-     * Map where the key is a theme stylesheet key and value is  the corresponding color in
-     * `#RRGGBB` format.
-     */
-    theme_params: {
-        [Key in ThemeParamsKey]?: RGB;
-    };
-}
-export interface ViewportChangedPayload {
-    /**
-     * 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;
-}
-export interface PopupClosedPayload {
-    /**
-     * Identifier of the clicked button. In case, the popup was closed without clicking any button,
-     * this property will be omitted.
-     */
-    button_id?: string;
-}
-export type PhoneRequestedStatus = 'sent' | string;
-export interface PhoneRequestedPayload {
-    /**
-     * Request status.
-     */
-    status: PhoneRequestedStatus;
-}
-export type WriteAccessRequestedStatus = 'allowed' | string;
-export interface WriteAccessRequestedPayload {
-    /**
-     * Request status.
-     */
-    status: WriteAccessRequestedStatus;
-}

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

@@ -1,9 +0,0 @@
-import type { GlobalEventListener } from './events.js';
-type StopListening = () => void;
-/**
- * Subscribes to all events sent from the native Telegram application.
- * Returns function used to remove added event listener.
- * @param listener - event listener.
- */
-export declare function subscribe(listener: GlobalEventListener): StopListening;
-export {};

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

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

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

@@ -1,6 +0,0 @@
-export * from './createPostEvent.js';
-export * from './haptic.js';
-export * from './invoke-custom-method.js';
-export * from './methods.js';
-export * from './popup.js';
-export * from './postEvent.js';

package/dist/dts/methods/invoke-custom-method.d.ts

@@ -1,24 +0,0 @@
-import type { RequestId } from '../shared.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 type AnyInvokeCustomMethodParams = CreateInvokeCustomMethodParams<'deleteStorageValues', {
-    keys: string | string[];
-}> | CreateInvokeCustomMethodParams<'getStorageValues', {
-    keys: string | string[];
-}> | CreateInvokeCustomMethodParams<'getStorageKeys', {}> | CreateInvokeCustomMethodParams<'saveStorageValue', {
-    key: string;
-    value: string;
-}> | CreateInvokeCustomMethodParams<string, any>;
-export {};