@keyringnetwork/keyring-connect-sdk 2.1.0 → 2.2.0

package/dist/constants/datasources.json

@@ -164,10 +164,7 @@
                 ],
                 "endpoint": {
                     "body": null,
-                    "data_bounds": {
-                        "max_recv_data": 2500,
-                        "max_sent_data": 800
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "user kyc",
@@ -229,10 +226,7 @@
                 ],
                 "endpoint": {
                     "body": null,
-                    "data_bounds": {
-                        "max_recv_data": 2500,
-                        "max_sent_data": 800
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "user kyc",
@@ -310,10 +304,7 @@
                 ],
                 "endpoint": {
                     "body": null,
-                    "data_bounds": {
-                        "max_recv_data": 10000,
-                        "max_sent_data": 1000
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "country of primary address",
@@ -369,10 +360,7 @@
                 ],
                 "endpoint": {
                     "body": null,
-                    "data_bounds": {
-                        "max_recv_data": 10000,
-                        "max_sent_data": 1000
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "country of primary address",
@@ -432,10 +420,7 @@
                 ],
                 "endpoint": {
                     "body": "{\"dpIdCache\":null}",
-                    "data_bounds": {
-                        "max_recv_data": 10000,
-                        "max_sent_data": 5000
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "mailing address",
@@ -536,7 +521,7 @@
         "image": "https://main.cdn.krnprod.net/logos/revolut.svg",
         "label": "Revolut",
         "link": "https://www.revolut.com",
-        "login_url": "https://sso.revolut.com/signin",
+        "login_url": "https://app.revolut.com/start",
         "name": "Revolut",
         "proof_sources": [
             {
@@ -568,10 +553,7 @@
                 ],
                 "endpoint": {
                     "body": null,
-                    "data_bounds": {
-                        "max_recv_data": 10000,
-                        "max_sent_data": 5000
-                    },
+                    "data_bounds": null,
                     "disclosable_fields": [
                         {
                             "label": "country of primary address",

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,30 @@ 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>;
+    /**
+     * Subscribe to extension state changes
+     * @param callback Function called with extension state updates
+     *        The state parameter will be null if the extension is not installed
+     *        or if an error occurs during state retrieval which indicates that
+     *        the extension is not available (e.g. was disabled)
+     * @returns Unsubscribe function to stop polling
+     */
+    static subscribeToExtensionState(callback: (state: ExtensionState | null) => void): () => void;
     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,8 +77,55 @@ class KeyringConnect {
                 });
                 window.postMessage({ type: types_1.EVENT_ACTIONS.GET_STATUS }, "*");
             });
+            return Promise.race([timeout, extensionResponse]);
         });
     }
+    /**
+     * Subscribe to extension state changes
+     * @param callback Function called with extension state updates
+     *        The state parameter will be null if the extension is not installed
+     *        or if an error occurs during state retrieval which indicates that
+     *        the extension is not available (e.g. was disabled)
+     * @returns Unsubscribe function to stop polling
+     */
+    static subscribeToExtensionState(callback) {
+        const interval = 3000;
+        const initialDelay = 0;
+        let isActive = true;
+        let timerId = null;
+        let lastStateString = "";
+        const processState = (state) => {
+            // Deduplicate state updates
+            const stateString = JSON.stringify(state);
+            if (stateString === lastStateString)
+                return;
+            lastStateString = stateString;
+            callback(state);
+        };
+        const messageHandler = (event) => {
+            if (event.data.type === types_1.EVENT_ACTIONS.KEYRING_CONNECT_STATUS &&
+                isActive) {
+                processState(event.data.data);
+            }
+        };
+        const pollStatus = () => {
+            if (!isActive)
+                return;
+            this.getExtensionState()
+                .then((state) => processState(state))
+                .catch(() => processState(null));
+            timerId = setTimeout(pollStatus, interval);
+        };
+        window.addEventListener("message", messageHandler);
+        // Start polling after initial delay
+        timerId = setTimeout(pollStatus, initialDelay);
+        return () => {
+            isActive = false;
+            if (timerId)
+                clearTimeout(timerId);
+            window.removeEventListener("message", messageHandler);
+        };
+    }
     static validateClientConfig(config) {
         if (!config.name) {
             throw new Error("Name is required");

package/package.json

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