@keyringnetwork/keyring-connect-sdk 0.0.1

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const EXTENSION_ID = "dadlipjhdmhncgadnfhbebmpgfkmhhhk";

package/dist/constants.js

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

package/dist/env.d.ts

@@ -0,0 +1,3 @@
+export declare const ENV: {
+    EXTENSION_ID: string;
+};

package/dist/env.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV = void 0;
+exports.ENV = {
+    EXTENSION_ID: 'dadlipjhdmhncgadnfhbebmpgfkmhhhk',
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default as KeyringConnectSDK } from './main';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyringConnectSDK = void 0;
+var main_1 = require("./main");
+Object.defineProperty(exports, "KeyringConnectSDK", { enumerable: true, get: function () { return __importDefault(main_1).default; } });
+__exportStar(require("./types"), exports);

package/dist/main.d.ts

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

package/dist/main.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const env_1 = require("./env");
+const types_1 = require("./types");
+class KeyringConnectSDK {
+    static launchKeyringConnect(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const keyringConnectAvailable = yield this.isKeyringConnectInstalled();
+            if (!keyringConnectAvailable) {
+                throw new Error('Keyring Connect is not installed');
+            }
+            console.log('launching keyring connect');
+            window.postMessage({ type: types_1.EVENT_ACTIONS.LAUNCH_KEYRING_CONNECT, data }, '*');
+        });
+    }
+    static isKeyringConnectInstalled() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = `chrome-extension://${env_1.ENV.EXTENSION_ID}/icon/16.png`;
+                const { statusText } = yield fetch(url);
+                if (statusText === 'OK') {
+                    return true;
+                }
+                return false;
+            }
+            catch (error) {
+                return false;
+            }
+        });
+    }
+    static getExtensionState() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve) => {
+                window.addEventListener('message', (event) => {
+                    if (event.data.type === types_1.EVENT_ACTIONS.KEYRING_CONNECT_STATUS) {
+                        resolve(event.data.data);
+                    }
+                });
+                window.postMessage({ type: types_1.EVENT_ACTIONS.GET_STATUS }, '*');
+            });
+        });
+    }
+}
+exports.default = KeyringConnectSDK;

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+export declare enum EVENT_ACTIONS {
+    LAUNCH_KEYRING_CONNECT = "LAUNCH_KEYRING_CONNECT",
+    GET_STATUS = "GET_STATUS",
+    KEYRING_CONNECT_STATUS = "KEYRING_CONNECT_STATUS"
+}
+export type LaunchKeyringConnectData = {
+    /**
+     * The name of the client.
+     */
+    client_name: string;
+    /**
+     * The URL of the client app which the chrome extension will communicate with.
+     */
+    client_app_url: string;
+    /**
+     * The URL of the client logo.
+     */
+    client_logo_url: string;
+    /**
+     * The policy ID of the client.
+     */
+    client_policy_id: number;
+};
+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 = {
+    /**
+     * Off-chain attestation status.
+     */
+    attestation_status: AttestationStatus;
+    /**
+     * On-chain keyring credential status.
+     */
+    credential_status: CredentialStatus;
+    /**
+     * Connected wallet address of the user.
+     */
+    wallet_address: string;
+    /**
+     * Keyring User ID.
+     */
+    user_id: string;
+    /**
+     * Keyring Entity ID.
+     */
+    entity_id: string;
+};
+export interface ExtensionStatusData {
+    status: ExtensionStatus;
+    manifest?: any;
+    error?: string;
+    user?: UserState;
+}

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVENT_ACTIONS = void 0;
+var EVENT_ACTIONS;
+(function (EVENT_ACTIONS) {
+    EVENT_ACTIONS["LAUNCH_KEYRING_CONNECT"] = "LAUNCH_KEYRING_CONNECT";
+    EVENT_ACTIONS["GET_STATUS"] = "GET_STATUS";
+    EVENT_ACTIONS["KEYRING_CONNECT_STATUS"] = "KEYRING_CONNECT_STATUS";
+})(EVENT_ACTIONS || (exports.EVENT_ACTIONS = EVENT_ACTIONS = {}));

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@keyringnetwork/keyring-connect-sdk",
+  "version": "0.0.1",
+  "description": "An SDK for interacting with Keyring Connect browser extension",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.3"
+  }
+}