@keyringnetwork/keyring-connect-sdk 2.1.0 → 2.1.1

package/dist/constants/index.d.ts

@@ -0,0 +1 @@
+export declare const EXTENSION_TIMEOUT = 2000;

package/dist/constants/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXTENSION_TIMEOUT = void 0;
+exports.EXTENSION_TIMEOUT = 2000;

package/dist/main.d.ts

@@ -5,18 +5,21 @@ import { ExtensionSDKConfig, ExtensionState } from "./types";
 export declare class KeyringConnect {
     private static keyringConnectUrl;
     /**
-     * Launch the Keyring Connect Extension with the provided configuration
-     * @note This will redirect to the Keyring Connect page if it is not installed
+     * Tries to launch the Keyring Connect Extension with the provided configuration.
+     * If the extension is not installed, it will redirect to the Keyring Connect page.
+     * @param data - The configuration for the extension
      */
     static launchExtension(data: ExtensionSDKConfig): Promise<void>;
     /**
      * Check if Keyring Connect Extension is installed and ready to use
+     * @returns Promise that resolves with true if extension is installed and ready to use, false otherwise
      */
     static isKeyringConnectInstalled(): Promise<boolean>;
     /**
-     * Get the current state of the Keyring Connect Extension to allow for UI updates
+     * Get the current state of the Keyring Connect Extension
+     * @returns Promise that resolves with extension state or null if unavailable
      */
-    static getExtensionState(): Promise<ExtensionState>;
+    static getExtensionState(): Promise<ExtensionState | null>;
     private static validateClientConfig;
     private static validateCredentialConfig;
     private static validateProofConfig;

package/dist/main.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringConnect = void 0;
 const contracts_abi_1 = require("@keyringnetwork/contracts-abi");
+const constants_1 = require("./constants");
 const datasources_json_1 = __importDefault(require("./constants/datasources.json"));
 const types_1 = require("./types");
 /**
@@ -21,8 +22,9 @@ const types_1 = require("./types");
  */
 class KeyringConnect {
     /**
-     * Launch the Keyring Connect Extension with the provided configuration
-     * @note This will redirect to the Keyring Connect page if it is not installed
+     * Tries to launch the Keyring Connect Extension with the provided configuration.
+     * If the extension is not installed, it will redirect to the Keyring Connect page.
+     * @param data - The configuration for the extension
      */
     static launchExtension(data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -46,15 +48,12 @@ class KeyringConnect {
     }
     /**
      * Check if Keyring Connect Extension is installed and ready to use
+     * @returns Promise that resolves with true if extension is installed and ready to use, false otherwise
      */
     static isKeyringConnectInstalled() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const timeout = new Promise((resolve) => {
-                    setTimeout(() => resolve(false), 2000);
-                });
-                const checkExtension = this.getExtensionState().then((state) => Boolean(state.manifest));
-                return Promise.race([timeout, checkExtension]);
+                return this.getExtensionState().then((state) => state ? Boolean(state.manifest) : false);
             }
             catch (error) {
                 return false;
@@ -62,11 +61,15 @@ class KeyringConnect {
         });
     }
     /**
-     * Get the current state of the Keyring Connect Extension to allow for UI updates
+     * Get the current state of the Keyring Connect Extension
+     * @returns Promise that resolves with extension state or null if unavailable
      */
     static getExtensionState() {
         return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve) => {
+            const timeout = new Promise((resolve) => {
+                setTimeout(() => resolve(null), constants_1.EXTENSION_TIMEOUT);
+            });
+            const extensionResponse = new Promise((resolve) => {
                 window.addEventListener("message", (event) => {
                     if (event.data.type === types_1.EVENT_ACTIONS.KEYRING_CONNECT_STATUS) {
                         resolve(event.data.data);
@@ -74,6 +77,7 @@ class KeyringConnect {
                 });
                 window.postMessage({ type: types_1.EVENT_ACTIONS.GET_STATUS }, "*");
             });
+            return Promise.race([timeout, extensionResponse]);
         });
     }
     static validateClientConfig(config) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyringnetwork/keyring-connect-sdk",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "An SDK for interacting with Keyring Connect browser extension",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",