keepkey-vault-sdk 1.2.6 → 2.0.1

package/dist/src/KeepKeySdk.d.ts

@@ -1,47 +0,0 @@
-/**
- * KeepKey SDK Compatibility Layer
- *
- * Provides backward-compatible API that matches the v1 SDK interface
- */
-import { DeviceStatusChecker } from './device-status';
-import { AddressApi, AuthApi, BNBApi, CosmosApi, ETHApi, InfoApi, InitializeApi, MayachainApi, OsmosisApi, ThorchainApi, UTXOApi, XRPApi } from './generated/v2/apis';
-export interface KeepKeySdkConfig {
-    apiKey: string;
-    basePath?: string;
-    spec?: string;
-    config?: any;
-}
-/**
- * Main KeepKey SDK class that provides a v1-compatible interface
- */
-export declare class KeepKeySdk {
-    readonly address: AddressApi;
-    readonly auth: AuthApi;
-    readonly bnb: BNBApi;
-    readonly cosmos: CosmosApi;
-    readonly eth: ETHApi;
-    readonly info: InfoApi;
-    readonly initialize: InitializeApi;
-    readonly mayachain: MayachainApi;
-    readonly osmosis: OsmosisApi;
-    readonly system: {
-        info: InfoApi;
-    };
-    readonly thorchain: ThorchainApi;
-    readonly utxo: UTXOApi;
-    readonly xrp: XRPApi;
-    readonly versionInfo?: {
-        apiVersion: number;
-        version: string;
-        supportedChains: string[];
-    };
-    readonly deviceStatus: DeviceStatusChecker;
-    private constructor();
-    /**
-     * Static factory method for backward compatibility with v1 SDK
-     *
-     * @param config SDK configuration
-     * @returns Promise that resolves to KeepKeySdk instance
-     */
-    static create(config: KeepKeySdkConfig): Promise<KeepKeySdk>;
-}

package/dist/src/KeepKeySdk.js

@@ -1,126 +0,0 @@
-"use strict";
-/**
- * KeepKey SDK Compatibility Layer
- *
- * Provides backward-compatible API that matches the v1 SDK interface
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeepKeySdk = void 0;
-const device_status_1 = require("./device-status");
-const apis_1 = require("./generated/v2/apis");
-const runtime_1 = require("./generated/v2/runtime");
-const version_detector_1 = require("./version-detector");
-/**
- * Main KeepKey SDK class that provides a v1-compatible interface
- */
-class KeepKeySdk {
-    constructor(config, basePath, versionInfo) {
-        this.versionInfo = versionInfo;
-        this.deviceStatus = new device_status_1.DeviceStatusChecker(basePath);
-        // Initialize all API instances
-        this.address = new apis_1.AddressApi(config);
-        this.auth = new apis_1.AuthApi(config);
-        this.bnb = new apis_1.BNBApi(config);
-        this.cosmos = new apis_1.CosmosApi(config);
-        this.eth = new apis_1.ETHApi(config);
-        this.info = new apis_1.InfoApi(config);
-        this.initialize = new apis_1.InitializeApi(config);
-        this.mayachain = new apis_1.MayachainApi(config);
-        this.osmosis = new apis_1.OsmosisApi(config);
-        this.thorchain = new apis_1.ThorchainApi(config);
-        this.utxo = new apis_1.UTXOApi(config);
-        this.xrp = new apis_1.XRPApi(config);
-        // Create system namespace for backward compatibility
-        this.system = {
-            info: this.info,
-        };
-    }
-    /**
-     * Static factory method for backward compatibility with v1 SDK
-     *
-     * @param config SDK configuration
-     * @returns Promise that resolves to KeepKeySdk instance
-     */
-    static async create(config) {
-        const basePath = config.basePath || 'http://localhost:1646';
-        // Detect API version
-        const detector = new version_detector_1.VersionDetector(basePath);
-        const versionInfo = await detector.detectVersion();
-        console.log(`[KeepKeySdk] Initialized with API v${versionInfo.apiVersion} (version ${versionInfo.version})`);
-        // Validate API key or pair to get a new one
-        let apiKey = config.apiKey;
-        let needsPairing = !apiKey;
-        // If we have an API key, validate it first
-        if (apiKey && !needsPairing) {
-            try {
-                const validateResponse = await fetch(`${basePath}/system/info/ping`, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                        Authorization: `Bearer ${apiKey}`,
-                    },
-                });
-                if (!validateResponse.ok) {
-                    const errorText = await validateResponse.text();
-                    if (errorText.includes('invalid API key') || errorText.includes('API key required')) {
-                        console.log('[KeepKeySdk] Provided API key is invalid, will attempt to pair');
-                        needsPairing = true;
-                    }
-                }
-            }
-            catch (error) {
-                console.warn('[KeepKeySdk] API key validation error:', error);
-                needsPairing = true;
-            }
-        }
-        // Pair if needed
-        if (needsPairing) {
-            console.log('[KeepKeySdk] Attempting to pair for API key...');
-            try {
-                const pairResponse = await fetch(`${basePath}/auth/pair`, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify({
-                        name: 'KeepKey SDK',
-                        url: 'http://localhost',
-                        imageUrl: 'http://localhost/icon.png',
-                    }),
-                });
-                if (pairResponse.ok) {
-                    const pairData = await pairResponse.json();
-                    apiKey = pairData.apiKey;
-                    console.log('[KeepKeySdk] Auto-pair successful, API key obtained');
-                }
-                else {
-                    console.warn('[KeepKeySdk] Auto-pair failed:', await pairResponse.text());
-                }
-            }
-            catch (error) {
-                console.warn('[KeepKeySdk] Auto-pair error:', error);
-            }
-        }
-        // Check if device is connected (non-blocking warning)
-        const deviceChecker = new device_status_1.DeviceStatusChecker(basePath);
-        const deviceConnected = await deviceChecker.isDeviceConnected();
-        if (!deviceConnected) {
-            console.warn('[KeepKeySdk] WARNING: No KeepKey device detected. Device-dependent operations will fail.');
-            console.warn('[KeepKeySdk] Please connect your device and ensure it is unlocked.');
-        }
-        else {
-            console.log('[KeepKeySdk] KeepKey device detected and ready');
-        }
-        const configuration = new runtime_1.Configuration({
-            basePath,
-            apiKey,
-            headers: apiKey
-                ? {
-                    Authorization: `Bearer ${apiKey}`,
-                }
-                : undefined,
-        });
-        return new KeepKeySdk(configuration, basePath, versionInfo);
-    }
-}
-exports.KeepKeySdk = KeepKeySdk;

package/dist/src/device-status.d.ts

@@ -1,36 +0,0 @@
-/**
- * Device Status Checker
- *
- * Checks device connection status before making device-dependent API calls
- */
-export interface DeviceStatus {
-    connected: boolean;
-    wallets: any[];
-    currentWallet: any | null;
-}
-export declare class DeviceStatusChecker {
-    private basePath;
-    private cachedStatus;
-    private cacheExpiry;
-    private readonly CACHE_TTL_MS;
-    constructor(basePath: string);
-    /**
-     * Checks if a KeepKey device is connected
-     * Uses v1 /admin/info endpoint which doesn't require authentication
-     * Results are cached for 5 seconds to avoid excessive polling
-     */
-    isDeviceConnected(): Promise<boolean>;
-    /**
-     * Gets full device status including wallet information
-     */
-    getStatus(): Promise<DeviceStatus | null>;
-    /**
-     * Clears cached device status, forcing fresh check on next call
-     */
-    clearCache(): void;
-    /**
-     * Throws an error if no device is connected
-     * Use this before calling device-dependent endpoints
-     */
-    requireDevice(): Promise<void>;
-}

package/dist/src/device-status.js

@@ -1,77 +0,0 @@
-"use strict";
-/**
- * Device Status Checker
- *
- * Checks device connection status before making device-dependent API calls
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeviceStatusChecker = void 0;
-class DeviceStatusChecker {
-    constructor(basePath) {
-        this.cachedStatus = null;
-        this.cacheExpiry = 0;
-        this.CACHE_TTL_MS = 5000; // 5 seconds
-        this.basePath = basePath.replace(/\/+$/, '');
-    }
-    /**
-     * Checks if a KeepKey device is connected
-     * Uses v1 /admin/info endpoint which doesn't require authentication
-     * Results are cached for 5 seconds to avoid excessive polling
-     */
-    async isDeviceConnected() {
-        const now = Date.now();
-        // Return cached status if still valid
-        if (this.cachedStatus && now < this.cacheExpiry) {
-            return this.cachedStatus.connected;
-        }
-        try {
-            const response = await fetch(`${this.basePath}/admin/info`, {
-                method: 'GET',
-                headers: {
-                    Accept: 'application/json',
-                },
-            });
-            if (!response.ok) {
-                console.warn(`[DeviceStatusChecker] /admin/info returned ${response.status}`);
-                return false;
-            }
-            const data = await response.json();
-            this.cachedStatus = {
-                connected: data?.usb?.state?.connected || false,
-                wallets: data?.wallets || [],
-                currentWallet: data?.currentWallet || null,
-            };
-            this.cacheExpiry = now + this.CACHE_TTL_MS;
-            return this.cachedStatus.connected;
-        }
-        catch (error) {
-            console.warn('[DeviceStatusChecker] Failed to check device status:', error);
-            return false;
-        }
-    }
-    /**
-     * Gets full device status including wallet information
-     */
-    async getStatus() {
-        await this.isDeviceConnected();
-        return this.cachedStatus;
-    }
-    /**
-     * Clears cached device status, forcing fresh check on next call
-     */
-    clearCache() {
-        this.cachedStatus = null;
-        this.cacheExpiry = 0;
-    }
-    /**
-     * Throws an error if no device is connected
-     * Use this before calling device-dependent endpoints
-     */
-    async requireDevice() {
-        const connected = await this.isDeviceConnected();
-        if (!connected) {
-            throw new Error('No KeepKey device connected. Please connect your device and unlock it if necessary.');
-        }
-    }
-}
-exports.DeviceStatusChecker = DeviceStatusChecker;

package/dist/src/fetch.d.ts

@@ -1,52 +0,0 @@
-/**
- * Universal Fetch Transport Layer
- *
- * Runtime-agnostic fetch implementation that works in:
- * - Browser/WebView (Tauri)
- * - Node 18+ (native fetch)
- * - Node <18 (with injected fetch)
- * - React Native (with injected fetch)
- */
-export type FetchLike = typeof fetch;
-/**
- * HTTP Error with status code and response body
- */
-export declare class HttpError extends Error {
-    status: number;
-    bodyText?: string | undefined;
-    response?: Response | undefined;
-    constructor(message: string, status: number, bodyText?: string | undefined, response?: Response | undefined);
-}
-/**
- * Resolve fetch implementation from environment or injection
- */
-export declare function resolveFetch(fetchImpl?: FetchLike): FetchLike;
-/**
- * Create a fetch wrapper with error handling
- */
-export declare function createFetchWrapper(fetchImpl?: FetchLike): (url: URL | RequestInfo, init?: RequestInit) => Promise<Response>;
-/**
- * Environment detection utilities
- */
-export declare const environment: {
-    /**
-     * Check if running in browser environment
-     */
-    isBrowser: boolean;
-    /**
-     * Check if running in Node.js environment
-     */
-    isNode: boolean;
-    /**
-     * Check if native fetch is available
-     */
-    hasNativeFetch: boolean;
-    /**
-     * Get environment name for debugging
-     */
-    readonly name: string;
-};
-/**
- * Get appropriate fetch for current environment
- */
-export declare function getEnvironmentFetch(): FetchLike;

package/dist/src/fetch.js

@@ -1,98 +0,0 @@
-"use strict";
-/**
- * Universal Fetch Transport Layer
- *
- * Runtime-agnostic fetch implementation that works in:
- * - Browser/WebView (Tauri)
- * - Node 18+ (native fetch)
- * - Node <18 (with injected fetch)
- * - React Native (with injected fetch)
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnvironmentFetch = exports.environment = exports.createFetchWrapper = exports.resolveFetch = exports.HttpError = void 0;
-/**
- * HTTP Error with status code and response body
- */
-class HttpError extends Error {
-    constructor(message, status, bodyText, response) {
-        super(message);
-        this.status = status;
-        this.bodyText = bodyText;
-        this.response = response;
-        this.name = 'HttpError';
-    }
-}
-exports.HttpError = HttpError;
-/**
- * Resolve fetch implementation from environment or injection
- */
-function resolveFetch(fetchImpl) {
-    const resolved = fetchImpl ?? globalThis.fetch;
-    if (!resolved || typeof resolved !== 'function') {
-        throw new Error('No fetch implementation found. ' +
-            'Provide `fetch` in SDK options (e.g. undici for Node<18, polyfill for older browsers).');
-    }
-    return resolved.bind(globalThis);
-}
-exports.resolveFetch = resolveFetch;
-/**
- * Create a fetch wrapper with error handling
- */
-function createFetchWrapper(fetchImpl) {
-    const fetchFn = resolveFetch(fetchImpl);
-    return async (url, init) => {
-        try {
-            const response = await fetchFn(url, init);
-            // Don't throw on HTTP errors here - let the caller decide
-            // This matches the native fetch behavior
-            return response;
-        }
-        catch (error) {
-            // Network/connection errors
-            if (error instanceof Error) {
-                throw new HttpError(`Network error: ${error.message}`, 0, undefined);
-            }
-            throw error;
-        }
-    };
-}
-exports.createFetchWrapper = createFetchWrapper;
-/**
- * Environment detection utilities
- */
-exports.environment = {
-    /**
-     * Check if running in browser environment
-     */
-    isBrowser: typeof window !== 'undefined' && typeof window.fetch === 'function',
-    /**
-     * Check if running in Node.js environment
-     */
-    isNode: typeof process !== 'undefined' && process.versions?.node !== undefined,
-    /**
-     * Check if native fetch is available
-     */
-    hasNativeFetch: typeof globalThis !== 'undefined' && typeof globalThis.fetch === 'function',
-    /**
-     * Get environment name for debugging
-     */
-    get name() {
-        if (this.isBrowser)
-            return 'browser';
-        if (this.isNode)
-            return 'node';
-        return 'unknown';
-    },
-};
-/**
- * Get appropriate fetch for current environment
- */
-function getEnvironmentFetch() {
-    if (exports.environment.hasNativeFetch) {
-        return globalThis.fetch.bind(globalThis);
-    }
-    // This should rarely happen in modern environments
-    throw new Error(`No native fetch found in ${exports.environment.name} environment. ` +
-        'Please provide a fetch implementation in SDK options.');
-}
-exports.getEnvironmentFetch = getEnvironmentFetch;

package/dist/src/generated/v1/apis/AddressApi.d.ts

@@ -1,135 +0,0 @@
-/**
- * keepkey-sdk-server
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * The version of the OpenAPI document: 0.1.1
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import * as runtime from '../runtime';
-import type { BinanceGetAddress200Response, BinanceGetAddressRequest, CosmosGetAddress200Response, EthereumGetAddress200Response, UtxoGetAddress200Response, UtxoGetAddressRequest } from '../models';
-export interface BinanceGetAddressOperationRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface CosmosGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface EthereumGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface MayachainGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface OsmosisGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface TendermintGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface ThorchainGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-export interface UtxoGetAddressOperationRequest {
-    UtxoGetAddressRequest: UtxoGetAddressRequest;
-}
-export interface XrpGetAddressRequest {
-    BinanceGetAddressRequest: BinanceGetAddressRequest;
-}
-/**
- *
- */
-export declare class AddressApi extends runtime.BaseAPI {
-    /**
-     * Get a Binance Chain address, loading it into the current session and optionally displaying it on-device.
-     * Get Binance Address
-     */
-    binanceGetAddressRaw(requestParameters: BinanceGetAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BinanceGetAddress200Response>>;
-    /**
-     * Get a Binance Chain address, loading it into the current session and optionally displaying it on-device.
-     * Get Binance Address
-     */
-    binanceGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BinanceGetAddress200Response>;
-    /**
-     * Get a Cosmos address, loading it into the current session and optionally displaying it on-device.
-     * Get Cosmos Address
-     */
-    cosmosGetAddressRaw(requestParameters: CosmosGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CosmosGetAddress200Response>>;
-    /**
-     * Get a Cosmos address, loading it into the current session and optionally displaying it on-device.
-     * Get Cosmos Address
-     */
-    cosmosGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CosmosGetAddress200Response>;
-    /**
-     * Get an Ethereum address, loading it into the current session and optionally displaying it on-device.
-     * Get Ethereum Address
-     */
-    ethereumGetAddressRaw(requestParameters: EthereumGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EthereumGetAddress200Response>>;
-    /**
-     * Get an Ethereum address, loading it into the current session and optionally displaying it on-device.
-     * Get Ethereum Address
-     */
-    ethereumGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EthereumGetAddress200Response>;
-    /**
-     * Get a mayachain address, loading it into the current session and optionally displaying it on-device.
-     * Get Thorchain Address
-     */
-    mayachainGetAddressRaw(requestParameters: MayachainGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CosmosGetAddress200Response>>;
-    /**
-     * Get a mayachain address, loading it into the current session and optionally displaying it on-device.
-     * Get Thorchain Address
-     */
-    mayachainGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CosmosGetAddress200Response>;
-    /**
-     * Get a Cosmos address, loading it into the current session and optionally displaying it on-device.
-     * Get Cosmos Address
-     */
-    osmosisGetAddressRaw(requestParameters: OsmosisGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CosmosGetAddress200Response>>;
-    /**
-     * Get a Cosmos address, loading it into the current session and optionally displaying it on-device.
-     * Get Cosmos Address
-     */
-    osmosisGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CosmosGetAddress200Response>;
-    /**
-     * Get a Tendermint address, loading it into the current session and optionally displaying it on-device.
-     * Get Tendermint Address
-     */
-    tendermintGetAddressRaw(requestParameters: TendermintGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EthereumGetAddress200Response>>;
-    /**
-     * Get a Tendermint address, loading it into the current session and optionally displaying it on-device.
-     * Get Tendermint Address
-     */
-    tendermintGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EthereumGetAddress200Response>;
-    /**
-     * Get a Thorchain address, loading it into the current session and optionally displaying it on-device.
-     * Get Thorchain Address
-     */
-    thorchainGetAddressRaw(requestParameters: ThorchainGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CosmosGetAddress200Response>>;
-    /**
-     * Get a Thorchain address, loading it into the current session and optionally displaying it on-device.
-     * Get Thorchain Address
-     */
-    thorchainGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CosmosGetAddress200Response>;
-    /**
-     * Get a Bitcoin/Dogecoin/Dash.... cont. (see coin-support) Chain address, loading it into the current session and optionally displaying it on-device.
-     * Get Binance Address
-     */
-    utxoGetAddressRaw(requestParameters: UtxoGetAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UtxoGetAddress200Response>>;
-    /**
-     * Get a Bitcoin/Dogecoin/Dash.... cont. (see coin-support) Chain address, loading it into the current session and optionally displaying it on-device.
-     * Get Binance Address
-     */
-    utxoGetAddress(UtxoGetAddressRequest: UtxoGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UtxoGetAddress200Response>;
-    /**
-     * Get an XRP address, loading it into the current session and optionally displaying it on-device.
-     * Get XRP Address
-     */
-    xrpGetAddressRaw(requestParameters: XrpGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CosmosGetAddress200Response>>;
-    /**
-     * Get an XRP address, loading it into the current session and optionally displaying it on-device.
-     * Get XRP Address
-     */
-    xrpGetAddress(BinanceGetAddressRequest: BinanceGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CosmosGetAddress200Response>;
-}