@keyringnetwork/keyring-connect-sdk 1.0.1 → 1.0.2

package/dist/types.d.ts

@@ -21,14 +21,16 @@ export type ExtensionSDKConfig = {
      */
     policy_id: number;
     /**
-     * The proof configuration for the extension. This can break the extension! Please proceed carefully
+     * 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;
     };
     /**
-     * The KRN configuration for the extension. This can break the extension! Please proceed carefully
+     * Keyring Network configuration for the extension.
+     * @note this is meant to be used for internal testing and development purposes.
      */
     krn_config?: {
         onboarding_api_url?: string;
@@ -55,26 +57,12 @@ export type ExtensionLaunchConfig = {
         datastore_api_url?: string;
         analytics_api_url?: string;
     };
-    auth_user?: UserProfile;
+    auth_user?: any;
 };
-export interface UserProfile {
-    sub: string;
-    given_name?: string;
-    family_name?: string;
-    nickname: string;
-    name?: string;
-    picture?: string;
-    updated_at: string;
-    email?: string;
-    email_verified?: boolean;
-    'keyring-access/roles': string[];
-    uid: string;
-    id_token: string;
-}
 export type ExtensionStatus = 'idle' | 'mounted' | 'proving' | 'prove_success' | 'error';
 export type AttestationStatus = 'onboarding_required' | 'onboarding_pending' | 'attestation_ready' | 'non_compliant';
 export type CredentialStatus = 'expired' | 'valid' | 'none';
-export type UserState = {
+export type User = {
     /**
      * Off-chain attestation status.
      */
@@ -100,7 +88,7 @@ export interface ExtensionState {
     status: ExtensionStatus;
     manifest?: any;
     error?: string;
-    user?: UserState;
+    user?: User;
 }
 export interface DataSource {
     id: string;

package/package.json

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

package/readme.md

@@ -31,8 +31,15 @@ const extensionConfig = {
   logo_url: 'https://myapp.com/logo.png',
   policy_id: 123,
 };
+
 try {
-  await KeyringConnect.launchExtension(extensionConfig);
+  const isInstalled = await KeyringConnect.isKeyringConnectInstalled();
+
+  if (isInstalled) {
+    await KeyringConnect.launchExtension(extensionConfig);
+  } else {
+    // show UI to install extension
+  }
 } catch (error) {
   console.error('Failed to launch Keyring Connect:', error);
 }
@@ -41,14 +48,14 @@ try {
 ### Monitor Extension Status
 
 ```typescript
-export interface ExtensionStatusData {
-  status: ExtensionStatus;
+export interface ExtensionState {
+  status: 'idle' | 'mounted' | 'proving' | 'prove_success' | 'error';
   manifest?: any;
-  error?: string;
-  user?: UserState;
+  error?: string; // error message, only if status is 'error'
+  user?: User;
 }
 
-const status = await KeyringConnect.getExtensionState();
+const extensionState = await KeyringConnect.getExtensionState();
 ```
 
 ## API Reference
@@ -57,36 +64,11 @@ const status = await KeyringConnect.getExtensionState();
 
 > Full type definitions can be found in our [types.ts](https://github.com/Keyring-Network/keyring-connect/blob/master/keyring-connect-sdk/src/types.ts)
 
-#### ExtensionConfig
-
-```typescript
-type ExtensionSDKConfig = {
-  name: string; // Name of your application
-  client_app_url: string; // Your application's URL
-  logo_url: string; // Your application's logo URL
-  policy_id: number; // Your Keyring policy ID
-
-  // Proof configuration. This can break the extension!
-  proof_config?: {
-    datasource: DataSource;
-    entity_type: string;
-  };
-  
-  // KRN configuration. This can break the extension!
-  krn_config?: {
-    entity_id?: string;
-    onboarding_api_url?: string;
-    datastore_api_url?: string;
-    analytics_api_url?: string;
-  };
-};
-```
-
 #### Core Types Overview
 
 - `ExtensionConfig`: Configuration for initializing the Keyring Connect extension
 - `ExtensionState`: Current state and status information of the extension
-- `UserState`: User's verification and credential status information
+- `User`: User's verification and credential status information
 
 #### Status Types
 
@@ -94,14 +76,6 @@ type ExtensionSDKConfig = {
 - `AttestationStatus`: Off-chain verification status (`onboarding_required`, `onboarding_pending`, `attestation_ready`, `non_compliant`)
 - `CredentialStatus`: On-chain credential status (`expired`, `valid`, `none`)
 
-#### Proof Configuration Types
-
-- `DataSource`: The website that owns the data the Prover is trying to prove, defined by a name and login URL, containing a list of Proof Sources
-- `ProofSource`: Defines how to generate a single Proof on a given Data Source, containing an Endpoint and a list of Claims
-- `Endpoint`: A URL on the Data Source's server that provides access to the data that will need to be disclosed in the Proof
-- `DisclosableField`: A field in the Endpoint's response that the Prover must disclose to the Verifier, defined by a JSON path
-- `Claim`: Links Proofs to Keyring rules, containing a label and rule ID for evaluation of its status
-
 ## Extension States
 
 - **idle**: Extension is installed but not active
@@ -116,18 +90,3 @@ type ExtensionSDKConfig = {
 - Chrome browser (version 88 or higher recommended)
 - Keyring Connect browser extension installed
 - Active internet connection
-
-## Error Handling
-
-The SDK throws errors in the following cases:
-
-- Network errors
-- Proof generation failures
-- On-chain credential update failures
-
-```typescript
-const state = await KeyringConnect.getExtensionState();
-if (state.status === 'error') {
-  console.error('An error occurred:', state.error);
-}
-```