@keyringnetwork/keyring-connect-sdk 3.1.0 → 3.2.0

package/dist/main.d.ts

@@ -9,6 +9,9 @@ export declare class KeyringConnect {
     /**
      * 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.
+     * @throws If the extension is not installed and running in a non-browser environment,
+     * if required configuration fields are missing, if Chrome runtime is not available,
+     * if extension communication times out, or if the extension returns an error.
      * @param data - The configuration for the extension
      */
     static launchExtension(data: ExtensionSDKConfig): Promise<void>;
@@ -33,11 +36,8 @@ export declare class KeyringConnect {
     static subscribeToExtensionState(callback: (state: ExtensionState | null) => void): () => void;
     private static validateClientConfig;
     private static validateCredentialConfig;
-    private static validateProofConfig;
     private static validateConfigData;
     private static convertToLaunchConfig;
     private static isChromeRuntimeAvailable;
     private static sendChromeMessage;
-    private static launchExtensionViaChromeAPI;
-    private static getExtensionStateViaChromeAPI;
 }

package/dist/main.js

@@ -18,6 +18,9 @@ class KeyringConnect {
     /**
      * 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.
+     * @throws If the extension is not installed and running in a non-browser environment,
+     * if required configuration fields are missing, if Chrome runtime is not available,
+     * if extension communication times out, or if the extension returns an error.
      * @param data - The configuration for the extension
      */
     static launchExtension(data) {
@@ -36,7 +39,10 @@ class KeyringConnect {
             }
             const validatedConfig = this.validateConfigData(data);
             const launchConfig = this.convertToLaunchConfig(validatedConfig);
-            yield this.launchExtensionViaChromeAPI(launchConfig);
+            yield this.sendChromeMessage({
+                type: types_1.EVENT_ACTIONS.LAUNCH_KEYRING_CONNECT,
+                data: launchConfig,
+            });
         });
     }
     /**
@@ -59,9 +65,21 @@ class KeyringConnect {
             const timeout = new Promise((resolve) => {
                 setTimeout(() => resolve(null), this.EXTENSION_TIMEOUT);
             });
+            // Check if Chrome is available first
+            if (!this.isChromeRuntimeAvailable()) {
+                return null;
+            }
             let extensionResponse;
-            extensionResponse = this.getExtensionStateViaChromeAPI();
-            return Promise.race([timeout, extensionResponse]);
+            extensionResponse = this.sendChromeMessage({
+                type: types_1.EVENT_ACTIONS.GET_STATUS,
+            });
+            try {
+                return yield Promise.race([timeout, extensionResponse]);
+            }
+            catch (error) {
+                // If there's an error (like Chrome runtime not available), return null
+                return null;
+            }
         });
     }
     /**
@@ -129,20 +147,8 @@ class KeyringConnect {
         }
         return config;
     }
-    static validateProofConfig(config) {
-        var _a;
-        if ((_a = config.proof_config) === null || _a === void 0 ? void 0 : _a.datasource) {
-            if (config.proof_config.datasource.proof_sources.length === 0) {
-                throw new Error("At least one proof source is required");
-            }
-            if (!config.proof_config.datasource.proof_sources.some((source) => source.claims.length > 0)) {
-                throw new Error("At least one claim is required per proof source");
-            }
-        }
-    }
     static validateConfigData(config) {
         this.validateClientConfig(config);
-        this.validateProofConfig(config);
         this.validateCredentialConfig(config);
         return config;
     }
@@ -166,7 +172,6 @@ class KeyringConnect {
                     websocketProxyUrl: config.krn_config.websocketProxyUrl,
                 }
                 : undefined,
-            proof_config: config.proof_config,
         };
         return launchConfig;
     }
@@ -212,21 +217,6 @@ class KeyringConnect {
             });
         });
     }
-    static launchExtensionViaChromeAPI(launchConfig) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.sendChromeMessage({
-                type: types_1.EVENT_ACTIONS.LAUNCH_KEYRING_CONNECT,
-                data: launchConfig,
-            });
-        });
-    }
-    static getExtensionStateViaChromeAPI() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.sendChromeMessage({
-                type: types_1.EVENT_ACTIONS.GET_STATUS,
-            });
-        });
-    }
 }
 exports.KeyringConnect = KeyringConnect;
 KeyringConnect.EXTENSION_TIMEOUT = 2000;

package/dist/types.d.ts

@@ -27,14 +27,6 @@ export type ExtensionSDKConfig = {
         chain_id: number;
         wallet_address: string;
     };
-    /**
-     * Additional configuration to customize the extension's verification process.
-     * @note should be used with caution as strict validation is applied to the proof config.
-     */
-    proof_config?: {
-        datasource?: DataSource;
-        entity_type?: string;
-    };
     /**
      * Keyring Network configuration for the extension.
      * @note this is meant to be used for internal testing and development purposes.
@@ -61,10 +53,6 @@ export type ExtensionLaunchConfig = {
             wallet_address: string;
         };
     };
-    proof_config?: {
-        datasource?: DataSource;
-        entity_type?: string;
-    };
     krn_config?: {
         keyring_api_url?: string;
         keyring_user_app_url?: string;
@@ -106,47 +94,6 @@ export interface ExtensionState {
     tlsn_proof?: string;
     credentialData?: CredentialData;
 }
-export interface DataSource {
-    id: string;
-    name: string;
-    label: string;
-    user_actions: string[];
-    link: string;
-    login_url: string;
-    target_url: string | null;
-    image: string;
-    proof_sources: ProofSource[];
-}
-export interface ProofSource {
-    id: string;
-    endpoint: TlsnEndpoint;
-    claims: Claim[];
-    label?: string;
-}
-export interface TlsnEndpoint {
-    url: string;
-    method: string;
-    headers: string[];
-    disclosable_fields: DisclosableField[];
-    required_cookies: string[] | null;
-    data_bounds: DataBounds | null;
-    body: string | null;
-}
-export interface Claim {
-    id: string;
-    label: string;
-    rule_id: string;
-    entity_type: string;
-}
-export interface DataBounds {
-    max_sent_data: number;
-    max_recv_data: number;
-}
-export interface DisclosableField {
-    label: string;
-    path: string;
-    key: string;
-}
 export interface CredentialData {
     trader: `0x${string}`;
     policyId: number;

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@keyringnetwork/keyring-connect-sdk",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "An SDK for interacting with Keyring Connect browser extension",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "rm -rf dist && tsc",
     "dev": "tsc --watch",
-    "build_and_publish": "pnpm build && npm publish"
+    "build_and_publish": "pnpm build && npm publish",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --ci --coverage --watchAll=false"
   },
   "files": [
     "dist"
@@ -17,10 +21,14 @@
   "license": "ISC",
   "devDependencies": {
     "@types/chrome": "^0.0.268",
+    "@types/jest": "^29.5.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@keyringnetwork/contracts-abi": "2.5.0"
+    "@keyringnetwork/contracts-abi": "2.6.0"
   }
-}
+}

package/readme.md

@@ -42,7 +42,7 @@ const extensionConfig = {
   policy_id: 123,
   credential_config: {
     chain_id: 1,
-    wallet_address: '0x123abcd'
+    wallet_address: '0x123abc'
   }
 };