@tonconnect/sdk 3.0.3-beta.0 → 3.0.3-beta.1

package/lib/types/index.d.ts

@@ -18,6 +18,8 @@ export declare interface Account {
     publicKey?: string;
 }
 
+export declare type AddTonConnectPrefix<T extends string> = `ton-connect-${T}` | `ton-connect-ui-${T}`;
+
 /**
  * Requested authentication type: 'ton_addr' or 'ton_proof'.
  */
@@ -34,7 +36,9 @@ export declare class BadRequestError extends TonConnectError {
 /**
  * A concrete implementation of EventDispatcher that dispatches events to the browser window.
  */
-export declare class BrowserEventDispatcher<T> implements EventDispatcher<T> {
+export declare class BrowserEventDispatcher<T extends {
+    type: string;
+}> implements EventDispatcher<T> {
     /**
      * The window object, possibly undefined in a server environment.
      * @private
@@ -46,7 +50,19 @@ export declare class BrowserEventDispatcher<T> implements EventDispatcher<T> {
      * @param eventDetails - The details of the event to dispatch.
      * @returns A promise that resolves when the event has been dispatched.
      */
-    dispatchEvent(eventName: string, eventDetails: T): Promise<void>;
+    dispatchEvent<P extends AddTonConnectPrefix<T['type']>>(eventName: P, eventDetails: T & {
+        type: RemoveTonConnectPrefix<P>;
+    }): Promise<void>;
+    /**
+     * Adds an event listener to the browser window.
+     * @param eventName - The name of the event to listen for.
+     * @param listener - The listener to add.
+     * @param options - The options for the listener.
+     * @returns A function that removes the listener.
+     */
+    addEventListener<P extends AddTonConnectPrefix<T['type']>>(eventName: P, listener: (event: CustomEvent<T & {
+        type: RemoveTonConnectPrefix<P>;
+    }>) => void, options?: AddEventListenerOptions): Promise<() => void>;
 }
 
 export declare enum CHAIN {
@@ -84,6 +100,10 @@ export declare type ConnectionCompletedEvent = {
      * Event type.
      */
     type: 'connection-completed';
+    /**
+     * Connection success flag.
+     */
+    is_success: true;
 } & ConnectionInfo;
 
 /**
@@ -94,6 +114,10 @@ export declare type ConnectionErrorEvent = {
      * Event type.
      */
     type: 'connection-error';
+    /**
+     * Connection success flag.
+     */
+    is_success: false;
     /**
      * Reason for the error.
      */
@@ -102,6 +126,10 @@ export declare type ConnectionErrorEvent = {
      * Error code.
      */
     error_code: CONNECT_EVENT_ERROR_CODES | null;
+    /**
+     * Custom data for the connection.
+     */
+    custom_data: Version;
 };
 
 /**
@@ -141,7 +169,7 @@ export declare type ConnectionInfo = {
          * Wallet provider.
          */
         provider: 'http' | 'injected' | null;
-    };
+    } & Version;
 };
 
 /**
@@ -152,6 +180,10 @@ export declare type ConnectionRestoringCompletedEvent = {
      * Event type.
      */
     type: 'connection-restoring-completed';
+    /**
+     * Connection success flag.
+     */
+    is_success: true;
 } & ConnectionInfo;
 
 /**
@@ -162,10 +194,18 @@ export declare type ConnectionRestoringErrorEvent = {
      * Event type.
      */
     type: 'connection-restoring-error';
+    /**
+     * Connection success flag.
+     */
+    is_success: false;
     /**
      * Reason for the error.
      */
     error_message: string;
+    /**
+     * Custom data for the connection.
+     */
+    custom_data: Version;
 };
 
 /**
@@ -181,6 +221,10 @@ export declare type ConnectionRestoringStartedEvent = {
      * Event type.
      */
     type: 'connection-restoring-started';
+    /**
+     * Custom data for the connection.
+     */
+    custom_data: Version;
 };
 
 /**
@@ -191,6 +235,10 @@ export declare type ConnectionStartedEvent = {
      * Event type.
      */
     type: 'connection-started';
+    /**
+     * Custom data for the connection.
+     */
+    custom_data: Version;
 };
 
 export declare type ConnectItem = TonAddressItem | TonProofItem;
@@ -205,70 +253,95 @@ export declare type ConnectItemReplyError<T> = {
 
 /**
  * Create a connection completed event.
+ * @param version
  * @param wallet
  */
-export declare function createConnectionCompletedEvent(wallet: Wallet | null): ConnectionCompletedEvent;
+export declare function createConnectionCompletedEvent(version: Version, wallet: Wallet | null): ConnectionCompletedEvent;
 
 /**
  * Create a connection error event.
+ * @param version
  * @param error_message
  * @param errorCode
  */
-export declare function createConnectionErrorEvent(error_message: string, errorCode: CONNECT_EVENT_ERROR_CODES | void): ConnectionErrorEvent;
+export declare function createConnectionErrorEvent(version: Version, error_message: string, errorCode: CONNECT_EVENT_ERROR_CODES | void): ConnectionErrorEvent;
 
 /**
  * Create a connection restoring completed event.
+ * @param version
  * @param wallet
  */
-export declare function createConnectionRestoringCompletedEvent(wallet: Wallet | null): ConnectionRestoringCompletedEvent;
+export declare function createConnectionRestoringCompletedEvent(version: Version, wallet: Wallet | null): ConnectionRestoringCompletedEvent;
 
 /**
  * Create a connection restoring error event.
+ * @param version
  * @param errorMessage
  */
-export declare function createConnectionRestoringErrorEvent(errorMessage: string): ConnectionRestoringErrorEvent;
+export declare function createConnectionRestoringErrorEvent(version: Version, errorMessage: string): ConnectionRestoringErrorEvent;
 
 /**
  * Create a connection restoring started event.
  */
-export declare function createConnectionRestoringStartedEvent(): ConnectionRestoringStartedEvent;
+export declare function createConnectionRestoringStartedEvent(version: Version): ConnectionRestoringStartedEvent;
 
 /**
  * Create a connection init event.
  */
-export declare function createConnectionStartedEvent(): ConnectionStartedEvent;
+export declare function createConnectionStartedEvent(version: Version): ConnectionStartedEvent;
 
 /**
  * Create a disconnect event.
+ * @param version
  * @param wallet
  * @param scope
  * @returns
  */
-export declare function createDisconnectionEvent(wallet: Wallet | null, scope: 'dapp' | 'wallet'): DisconnectionEvent;
+export declare function createDisconnectionEvent(version: Version, wallet: Wallet | null, scope: 'dapp' | 'wallet'): DisconnectionEvent;
+
+/**
+ * Create a request version event.
+ */
+export declare function createRequestVersionEvent(): RequestVersionEvent;
+
+/**
+ * Create a response version event.
+ * @param version
+ */
+export declare function createResponseVersionEvent(version: string): ResponseVersionEvent;
 
 /**
  * Create a transaction init event.
+ * @param version
  * @param wallet
  * @param transaction
  */
-export declare function createTransactionSentForSignatureEvent(wallet: Wallet | null, transaction: SendTransactionRequest): TransactionSentForSignatureEvent;
+export declare function createTransactionSentForSignatureEvent(version: Version, wallet: Wallet | null, transaction: SendTransactionRequest): TransactionSentForSignatureEvent;
 
 /**
  * Create a transaction signed event.
+ * @param version
  * @param wallet
  * @param transaction
  * @param signedTransaction
  */
-export declare function createTransactionSignedEvent(wallet: Wallet | null, transaction: SendTransactionRequest, signedTransaction: SendTransactionResponse): TransactionSignedEvent;
+export declare function createTransactionSignedEvent(version: Version, wallet: Wallet | null, transaction: SendTransactionRequest, signedTransaction: SendTransactionResponse): TransactionSignedEvent;
 
 /**
  * Create a transaction error event.
+ * @param version
  * @param wallet
  * @param transaction
  * @param errorMessage
  * @param errorCode
  */
-export declare function createTransactionSigningFailedEvent(wallet: Wallet | null, transaction: SendTransactionRequest, errorMessage: string, errorCode: SEND_TRANSACTION_ERROR_CODES | void): TransactionSigningFailedEvent;
+export declare function createTransactionSigningFailedEvent(version: Version, wallet: Wallet | null, transaction: SendTransactionRequest, errorMessage: string, errorCode: SEND_TRANSACTION_ERROR_CODES | void): TransactionSigningFailedEvent;
+
+/**
+ * Create a version info.
+ * @param version
+ */
+export declare function createVersionInfo(version: Version): Version;
 
 export declare interface DappMetadata {
     /**
@@ -316,13 +389,27 @@ export declare function encodeTelegramUrlParameters(parameters: string): string;
 /**
  * Interface for an event dispatcher that sends events.
  */
-export declare interface EventDispatcher<T> {
+export declare interface EventDispatcher<T extends {
+    type: string;
+}> {
     /**
      * Dispatches an event with the given name and details.
      * @param eventName - The name of the event to dispatch.
      * @param eventDetails - The details of the event to dispatch.
      */
-    dispatchEvent(eventName: string, eventDetails: T): Promise<void>;
+    dispatchEvent<P extends AddTonConnectPrefix<T['type']>>(eventName: P, eventDetails: T & {
+        type: RemoveTonConnectPrefix<P>;
+    }): Promise<void>;
+    /**
+     * Adds an event listener.
+     * @param eventName - The name of the event to listen for.
+     * @param listener - The listener to add.
+     * @param options - The options for the listener.
+     * @returns A function that removes the listener.
+     */
+    addEventListener<P extends AddTonConnectPrefix<T['type']>>(eventName: P, listener: (event: CustomEvent<T & {
+        type: RemoveTonConnectPrefix<P>;
+    }>) => void, options?: AddEventListenerOptions): Promise<() => void>;
 }
 
 export declare type Feature = SendTransactionFeatureDeprecated | SendTransactionFeature | SignDataFeature;
@@ -473,10 +560,39 @@ export declare class ParseHexError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }
 
+/**
+ * Removes the `ton-connect-` and `ton-connect-ui-` prefixes from the given string.
+ */
+export declare type RemoveTonConnectPrefix<T> = T extends `ton-connect-ui-${infer Rest}` ? Rest : T extends `ton-connect-${infer Rest}` ? Rest : T;
+
+/**
+ * Request TON Connect UI version.
+ */
+export declare type RequestVersionEvent = {
+    /**
+     * Event type.
+     */
+    type: 'request-version';
+};
+
+/**
+ * Response TON Connect UI version.
+ */
+export declare type ResponseVersionEvent = {
+    /**
+     * Event type.
+     */
+    type: 'response-version';
+    /**
+     * TON Connect UI version.
+     */
+    version: string;
+};
+
 /**
  * User action events.
  */
-export declare type SdkActionEvent = ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent;
+export declare type SdkActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent;
 
 export declare enum SEND_TRANSACTION_ERROR_CODES {
     UNKNOWN_ERROR = 0,
@@ -786,6 +902,10 @@ export declare type TransactionSignedEvent = {
      * Event type.
      */
     type: 'transaction-signed';
+    /**
+     * Connection success flag.
+     */
+    is_success: true;
     /**
      * Signed transaction.
      */
@@ -805,6 +925,10 @@ export declare type TransactionSigningFailedEvent = {
      * Event type.
      */
     type: 'transaction-signing-failed';
+    /**
+     * Connection success flag.
+     */
+    is_success: false;
     /**
      * Reason for the error.
      */
@@ -838,6 +962,25 @@ export declare class UserRejectsError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }
 
+/**
+ * Version of the TON Connect SDK and TON Connect UI.
+ */
+export declare type Version = {
+    /**
+     * TON Connect SDK version.
+     */
+    ton_connect_sdk_lib: string | null;
+    /**
+     * TON Connect UI version.
+     */
+    ton_connect_ui_lib: string | null;
+};
+
+/**
+ * Version events.
+ */
+export declare type VersionEvent = RequestVersionEvent | ResponseVersionEvent;
+
 export declare interface Wallet {
     /**
      * Information about user's wallet's device.
@@ -1012,6 +1155,11 @@ export declare class WalletsListManager {
     private isCorrectWalletConfigDTO;
 }
 
+/**
+ * Parameters without version field.
+ */
+export declare type WithoutVersion<T> = T extends [Version, ...infer Rest] ? [...Rest] : never;
+
 /**
  * Thrown when passed address is in incorrect format.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "3.0.3-beta.0",
+  "version": "3.0.3-beta.1",
   "scripts": {
     "build": "npx rimraf types-dist && npx rimraf lib && npx rollup -c rollup.config.mjs && ttsc --project tsconfig.declarations.json && api-extractor run && npx rimraf types-dist && npx rimraf dist && npx webpack --config webpack.config.js",
     "test": "vitest run"
@@ -56,6 +56,7 @@
     "webpack-cli": "^5.0.0",
     "rollup": "^3.18.0",
     "@rollup/plugin-typescript": "^11.0.0",
+    "@rollup/plugin-replace": "5.0.5",
     "vite": "^4.2.1",
     "vite-tsconfig-paths": "^4.0.5",
     "vitest": "^0.29.2",