@keyringnetwork/keyring-connect-sdk 0.0.2 → 0.0.3

package/dist/main.d.ts

@@ -1,6 +1,6 @@
-import { ExtensionStatusData, LaunchKeyringConnectData } from './types';
-export default class KeyringConnectSDK {
-    static launchKeyringConnect(data: LaunchKeyringConnectData): Promise<void>;
+import { ExtensionConfig, ExtensionState } from './types';
+export default class KeyringConnect {
+    static launchExtension(data: ExtensionConfig): Promise<void>;
     static isKeyringConnectInstalled(): Promise<boolean>;
-    static getExtensionState(): Promise<ExtensionStatusData>;
+    static getExtensionState(): Promise<ExtensionState>;
 }

package/dist/main.js

@@ -11,8 +11,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const env_1 = require("./env");
 const types_1 = require("./types");
-class KeyringConnectSDK {
-    static launchKeyringConnect(data) {
+class KeyringConnect {
+    static launchExtension(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const keyringConnectAvailable = yield this.isKeyringConnectInstalled();
             if (!keyringConnectAvailable) {
@@ -50,4 +50,4 @@ class KeyringConnectSDK {
         });
     }
 }
-exports.default = KeyringConnectSDK;
+exports.default = KeyringConnect;

package/dist/types.d.ts

@@ -3,7 +3,7 @@ export declare enum EVENT_ACTIONS {
     GET_STATUS = "GET_STATUS",
     KEYRING_CONNECT_STATUS = "KEYRING_CONNECT_STATUS"
 }
-export type LaunchKeyringConnectData = {
+export type ExtensionConfig = {
     client: {
         /**
          * The name of the client.
@@ -58,7 +58,7 @@ export type UserState = {
      */
     entity_id: string;
 };
-export interface ExtensionStatusData {
+export interface ExtensionState {
     status: ExtensionStatus;
     manifest?: any;
     error?: string;

package/package.json

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

package/readme.md

@@ -0,0 +1,139 @@
+# Keyring Connect SDK
+
+A TypeScript/JavaScript SDK for integrating with the Keyring Connect browser extension. This SDK enables seamless interaction with the Keyring Connect extension for user verification and attestation.
+
+
+## Installation
+
+```bash
+npm install @keyringnetwork/keyring-connect-sdk
+```
+
+## Features
+
+- Launch Keyring Connect with custom client configuration
+- Monitor extension status and user state
+- Full TypeScript support with comprehensive type definitions
+
+## Usage
+
+### Initialize
+
+```typescript
+import { KeyringConnect } from '@keyringnetwork/keyring-connect-sdk';
+```
+
+### Launch Keyring Connect
+
+```typescript
+const extensionConfig = {
+  client: {
+    client_name: 'My App',
+    client_app_url: 'https://myapp.com',
+    client_logo_url: 'https://myapp.com/logo.png',
+    client_policy_id: 123,
+  },
+  // Optional proof configuration
+  proof_config: {
+    datasource: {
+      id: 'github',
+      name: 'GitHub',
+      label: 'GitHub Account',
+      link: 'https://github.com',
+      login_url: 'https://github.com/login',
+      target_url: null,
+      image: 'https://github.com/logo.png',
+      proof_sources: [/ ... /],
+    },
+    entity_type: 'individual',
+  },
+};
+try {
+  await KeyringConnect.launchExtension(extensionConfig);
+} catch (error) {
+  console.error('Failed to launch Keyring Connect:', error);
+}
+```
+
+### Monitor Extension Status
+
+```typescript
+export interface ExtensionStatusData {
+  status: ExtensionStatus;
+  manifest?: any;
+  error?: string;
+  user?: UserState;
+}
+
+const status = await KeyringConnect.getExtensionState();
+```
+
+## API Reference
+
+### Key Types
+
+> Full type definitions can be found in our [types.ts](src/types.ts)
+
+
+#### ExtensionConfig
+
+```typescript
+type ExtensionConfig = {
+  client: {
+    client_name: string; // Name of your application
+    client_app_url: string; // Your application's URL
+    client_logo_url: string; // Your application's logo URL
+    client_policy_id: number; // Your Keyring policy ID
+  };
+  proof_config?: {
+    datasource: DataSource; // Configuration for the proof source
+    entity_type: string; // Type of entity to verify
+  };
+};
+```
+
+#### 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
+
+#### Status Types
+- `ExtensionStatus`: Extension states (`idle`, `mounted`, `proving`, `prove_success`, `error`)
+- `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
+- **mounted**: Extension is launched and ready
+- **proving**: Currently generating proof
+- **prove_success**: Proof generation successful
+- **error**: An error occurred
+
+## Requirements
+
+- An on-chain Keyring policy
+- 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);
+  }
+```