keepkey-vault-sdk 1.0.0

package/dist/src/generated/runtime.js

@@ -0,0 +1,309 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextApiResponse = exports.BlobApiResponse = exports.VoidApiResponse = exports.JSONApiResponse = exports.canConsumeForm = exports.mapValues = exports.querystring = exports.exists = exports.COLLECTION_FORMATS = exports.RequiredError = exports.FetchError = exports.ResponseError = exports.BaseAPI = exports.DefaultConfig = exports.Configuration = exports.BASE_PATH = void 0;
+exports.BASE_PATH = "http://localhost:1646".replace(/\/+$/, "");
+class Configuration {
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : exports.BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+exports.Configuration = Configuration;
+exports.DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+class BaseAPI {
+    constructor(configuration = exports.DefaultConfig) {
+        this.configuration = configuration;
+        this.fetchApi = async (url, init) => {
+            let fetchParams = { url, init };
+            for (const middleware of this.middleware) {
+                if (middleware.pre) {
+                    fetchParams = await middleware.pre({
+                        fetch: this.fetchApi,
+                        ...fetchParams,
+                    }) || fetchParams;
+                }
+            }
+            let response = undefined;
+            try {
+                response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+            }
+            catch (e) {
+                for (const middleware of this.middleware) {
+                    if (middleware.onError) {
+                        response = await middleware.onError({
+                            fetch: this.fetchApi,
+                            url: fetchParams.url,
+                            init: fetchParams.init,
+                            error: e,
+                            response: response ? response.clone() : undefined,
+                        }) || response;
+                    }
+                }
+                if (response === undefined) {
+                    if (e instanceof Error) {
+                        throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+            }
+            for (const middleware of this.middleware) {
+                if (middleware.post) {
+                    response = await middleware.post({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        response: response.clone(),
+                    }) || response;
+                }
+            }
+            return response;
+        };
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === "function"
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+        const overridedInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+        const init = {
+            ...overridedInit,
+            body: isFormData(overridedInit.body) ||
+                overridedInit.body instanceof URLSearchParams ||
+                isBlob(overridedInit.body)
+                ? overridedInit.body
+                : JSON.stringify(overridedInit.body),
+        };
+        return { url, init };
+    }
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+exports.BaseAPI = BaseAPI;
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+class ResponseError extends Error {
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        this.name = "ResponseError";
+    }
+}
+exports.ResponseError = ResponseError;
+class FetchError extends Error {
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        this.name = "FetchError";
+    }
+}
+exports.FetchError = FetchError;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+exports.exists = exists;
+function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+exports.querystring = querystring;
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+function mapValues(data, fn) {
+    return Object.keys(data).reduce((acc, key) => ({ ...acc, [key]: fn(data[key]) }), {});
+}
+exports.mapValues = mapValues;
+function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.canConsumeForm = canConsumeForm;
+class JSONApiResponse {
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+exports.JSONApiResponse = JSONApiResponse;
+class VoidApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+exports.VoidApiResponse = VoidApiResponse;
+class BlobApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+    ;
+}
+exports.BlobApiResponse = BlobApiResponse;
+class TextApiResponse {
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+    ;
+}
+exports.TextApiResponse = TextApiResponse;

package/dist/src/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * KeepKey SDK v2 with Automatic Version Detection
+ *
+ * This SDK automatically detects whether it's connecting to a v1 or v2 API
+ * and routes requests accordingly.
+ *
+ * Usage:
+ *
+ * ```typescript
+ * import { createSDKConfig } from '@keepkey/keepkey-sdk';
+ *
+ * // Automatic version detection (recommended)
+ * const config = createSDKConfig({
+ *   basePath: 'http://localhost:1646'
+ * });
+ *
+ * // Get version info
+ * const versionInfo = await config.getVersionInfo();
+ * console.log(`API version: ${versionInfo.apiVersion}`);
+ * console.log(`Supported chains: ${versionInfo.supportedChains.length}`);
+ *
+ * // Manual version override (skip detection)
+ * const config = createSDKConfigWithVersion(2, {
+ *   basePath: 'http://localhost:1646'
+ * });
+ * ```
+ */
+export * from './generated';
+export { VersionRouter } from './middleware/version-router';
+export type { OpenAPISpec } from './spec-loader';
+export { SpecLoader } from './spec-loader';
+export type { ApiVersionInfo } from './version-detector';
+export { VersionDetector } from './version-detector';
+export type { SDKConfigurationParameters } from './sdk-config';
+export { createSDKConfig, createSDKConfigWithVersion, SDKConfiguration } from './sdk-config';
+export type { Configuration, ConfigurationParameters } from './generated/runtime';

package/dist/src/index.js

@@ -0,0 +1,57 @@
+"use strict";
+/**
+ * KeepKey SDK v2 with Automatic Version Detection
+ *
+ * This SDK automatically detects whether it's connecting to a v1 or v2 API
+ * and routes requests accordingly.
+ *
+ * Usage:
+ *
+ * ```typescript
+ * import { createSDKConfig } from '@keepkey/keepkey-sdk';
+ *
+ * // Automatic version detection (recommended)
+ * const config = createSDKConfig({
+ *   basePath: 'http://localhost:1646'
+ * });
+ *
+ * // Get version info
+ * const versionInfo = await config.getVersionInfo();
+ * console.log(`API version: ${versionInfo.apiVersion}`);
+ * console.log(`Supported chains: ${versionInfo.supportedChains.length}`);
+ *
+ * // Manual version override (skip detection)
+ * const config = createSDKConfigWithVersion(2, {
+ *   basePath: 'http://localhost:1646'
+ * });
+ * ```
+ */
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKConfiguration = exports.createSDKConfigWithVersion = exports.createSDKConfig = exports.VersionDetector = exports.SpecLoader = exports.VersionRouter = void 0;
+// Export generated API
+__exportStar(require("./generated"), exports);
+// Export version detection
+var version_router_1 = require("./middleware/version-router");
+Object.defineProperty(exports, "VersionRouter", { enumerable: true, get: function () { return version_router_1.VersionRouter; } });
+var spec_loader_1 = require("./spec-loader");
+Object.defineProperty(exports, "SpecLoader", { enumerable: true, get: function () { return spec_loader_1.SpecLoader; } });
+var version_detector_1 = require("./version-detector");
+Object.defineProperty(exports, "VersionDetector", { enumerable: true, get: function () { return version_detector_1.VersionDetector; } });
+var sdk_config_1 = require("./sdk-config");
+Object.defineProperty(exports, "createSDKConfig", { enumerable: true, get: function () { return sdk_config_1.createSDKConfig; } });
+Object.defineProperty(exports, "createSDKConfigWithVersion", { enumerable: true, get: function () { return sdk_config_1.createSDKConfigWithVersion; } });
+Object.defineProperty(exports, "SDKConfiguration", { enumerable: true, get: function () { return sdk_config_1.SDKConfiguration; } });

package/dist/src/middleware/version-router.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Version-Aware Request Router
+ *
+ * Routes endpoints based on detected API version with intelligent fallback.
+ */
+import type { ApiVersionInfo } from '../version-detector';
+export declare class VersionRouter {
+    private apiVersionInfo;
+    constructor(apiVersionInfo: ApiVersionInfo);
+    /**
+     * Routes endpoint based on API version.
+     * Falls back to v1 endpoint if v2 unavailable.
+     *
+     * @param v1Endpoint - The v1 API endpoint path
+     * @param v2Endpoint - Optional v2 API endpoint path
+     * @returns The appropriate endpoint to use
+     */
+    routeEndpoint(v1Endpoint: string, v2Endpoint?: string): string;
+    /**
+     * Checks if a feature/chain is supported by current API version.
+     *
+     * @param feature - Feature or chain identifier to check
+     * @returns true if supported, false otherwise
+     */
+    isFeatureSupported(feature: string): boolean;
+    /**
+     * Checks if a string is a chain identifier
+     */
+    private isChainIdentifier;
+    /**
+     * Matches a CAIP-2 network ID with a chain symbol
+     */
+    private matchesChain;
+    /**
+     * Gets current API version
+     */
+    getApiVersion(): number;
+    /**
+     * Gets version info
+     */
+    getVersionInfo(): ApiVersionInfo;
+    /**
+     * Updates version info (e.g., after re-detection)
+     */
+    updateVersionInfo(apiVersionInfo: ApiVersionInfo): void;
+}

package/dist/src/middleware/version-router.js

@@ -0,0 +1,150 @@
+"use strict";
+/**
+ * Version-Aware Request Router
+ *
+ * Routes endpoints based on detected API version with intelligent fallback.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionRouter = void 0;
+class VersionRouter {
+    constructor(apiVersionInfo) {
+        this.apiVersionInfo = apiVersionInfo;
+    }
+    /**
+     * Routes endpoint based on API version.
+     * Falls back to v1 endpoint if v2 unavailable.
+     *
+     * @param v1Endpoint - The v1 API endpoint path
+     * @param v2Endpoint - Optional v2 API endpoint path
+     * @returns The appropriate endpoint to use
+     */
+    routeEndpoint(v1Endpoint, v2Endpoint) {
+        const apiVersion = this.apiVersionInfo.apiVersion;
+        // If v2 API detected and v2 endpoint provided, use v2
+        if (apiVersion === 2 && v2Endpoint) {
+            console.log(`[VersionRouter] Routing to v2: ${v2Endpoint}`);
+            return v2Endpoint;
+        }
+        // Otherwise use v1 endpoint
+        if (apiVersion === 2 && !v2Endpoint) {
+            console.log(`[VersionRouter] No v2 endpoint available, using v1: ${v1Endpoint}`);
+        }
+        return v1Endpoint;
+    }
+    /**
+     * Checks if a feature/chain is supported by current API version.
+     *
+     * @param feature - Feature or chain identifier to check
+     * @returns true if supported, false otherwise
+     */
+    isFeatureSupported(feature) {
+        const supportedChains = this.apiVersionInfo.supportedChains || [];
+        // Check if it's a known chain identifier (CAIP-2 format or known symbol)
+        if (this.isChainIdentifier(feature)) {
+            // Check both CAIP-2 network ID and symbol formats
+            const isSupported = supportedChains.some(chain => chain === feature || this.matchesChain(chain, feature));
+            if (!isSupported) {
+                console.warn(`[VersionRouter] Chain ${feature} not in supported chains list`);
+            }
+            return isSupported;
+        }
+        // For unknown strings, do a final case-insensitive check against supported chains
+        // This handles any chain symbols we may have missed in our chainSymbols list
+        const normalizedFeature = feature.toUpperCase();
+        const isSupported = supportedChains.some(chain => {
+            // Check exact match (case-insensitive)
+            if (chain.toUpperCase() === normalizedFeature) {
+                return true;
+            }
+            // Check if it matches any known chain symbol via mapping
+            return this.matchesChain(chain, feature);
+        });
+        if (!isSupported) {
+            console.warn(`[VersionRouter] Feature/chain ${feature} not supported`);
+        }
+        return isSupported;
+    }
+    /**
+     * Checks if a string is a chain identifier
+     */
+    isChainIdentifier(value) {
+        // CAIP-2 format: namespace:reference
+        if (value.includes(':')) {
+            return true;
+        }
+        // Common chain symbols
+        const chainSymbols = [
+            'SOL',
+            'TRX',
+            'TON',
+            'ZEC',
+            'BTC',
+            'ETH',
+            'GAIA',
+            'OSMO',
+            'XRP',
+            'LTC',
+            'DOGE',
+            'BCH',
+            'DASH',
+            'DGB',
+            'MATIC',
+            'BASE',
+            'BSC',
+            'MON',
+            'HYPE',
+            'MAYA',
+            'THOR',
+        ];
+        return chainSymbols.includes(value.toUpperCase());
+    }
+    /**
+     * Matches a CAIP-2 network ID with a chain symbol
+     */
+    matchesChain(caipId, symbol) {
+        // Simple mapping of CAIP-2 IDs to common symbols
+        const chainMap = {
+            'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp': 'SOL',
+            'tron:27Lqcw': 'TRX',
+            'ton:-239': 'TON',
+            'bip122:00040fe8ec8471911baa1db1266ea15d': 'ZEC',
+            'bip122:000000000019d6689c085ae165831e93': 'BTC',
+            'eip155:1': 'ETH',
+            'cosmos:cosmoshub-4': 'GAIA',
+            'cosmos:osmosis-1': 'OSMO',
+            'ripple:4109c6f2045fc7eff4cde8f9905d19c2': 'XRP',
+            'bip122:12a765e31ffd4059bada1e25190f6e98': 'LTC',
+            'bip122:00000000001a91e3dace36e2be3bf030': 'DOGE',
+            'bip122:000000000000000000651ef99cb9fcbe': 'BCH',
+            'bip122:000007d91d1254d60e2dd1ae58038307': 'DASH',
+            'bip122:4da631f2ac1bed857bd968c67c913978': 'DGB',
+            'eip155:137': 'MATIC',
+            'eip155:8453': 'BASE',
+            'eip155:56': 'BSC',
+            'eip155:41454': 'MON',
+            'eip155:2868': 'HYPE',
+            'cosmos:mayachain-mainnet-v1': 'MAYA',
+            'cosmos:thorchain-mainnet-v1': 'THOR',
+        };
+        return chainMap[caipId]?.toUpperCase() === symbol.toUpperCase();
+    }
+    /**
+     * Gets current API version
+     */
+    getApiVersion() {
+        return this.apiVersionInfo.apiVersion;
+    }
+    /**
+     * Gets version info
+     */
+    getVersionInfo() {
+        return this.apiVersionInfo;
+    }
+    /**
+     * Updates version info (e.g., after re-detection)
+     */
+    updateVersionInfo(apiVersionInfo) {
+        this.apiVersionInfo = apiVersionInfo;
+    }
+}
+exports.VersionRouter = VersionRouter;

package/dist/src/sdk-config.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Enhanced SDK Configuration with Version Detection
+ *
+ * Extends the generated Configuration with automatic API version detection
+ * and intelligent routing between v1 and v2 APIs.
+ */
+import type { ConfigurationParameters } from './generated/runtime';
+import { Configuration } from './generated/runtime';
+import { VersionRouter } from './middleware/version-router';
+import type { ApiVersionInfo } from './version-detector';
+import { VersionDetector } from './version-detector';
+export interface SDKConfigurationParameters extends ConfigurationParameters {
+    /**
+     * Enable automatic version detection via /api/health endpoint
+     * @default true
+     */
+    autoDetectVersion?: boolean;
+    /**
+     * Manually specify API version (bypasses auto-detection)
+     * @default undefined (auto-detect)
+     */
+    apiVersion?: number;
+    /**
+     * Custom version detector instance
+     * @default undefined (creates new instance)
+     */
+    versionDetector?: VersionDetector;
+}
+export declare class SDKConfiguration extends Configuration {
+    private versionDetector;
+    private versionRouter?;
+    private apiVersionInfo?;
+    private autoDetectVersion;
+    private manualApiVersion?;
+    private versionDetectionPromise?;
+    constructor(params?: SDKConfigurationParameters);
+    /**
+     * Initialize version detection.
+     * This is called automatically when needed, but can be called explicitly for early detection.
+     */
+    initVersionDetection(): Promise<ApiVersionInfo>;
+    private performVersionDetection;
+    /**
+     * Get current API version (may trigger detection if not yet initialized)
+     */
+    getApiVersion(): Promise<number>;
+    /**
+     * Get full version information (may trigger detection if not yet initialized)
+     */
+    getVersionInfo(): Promise<ApiVersionInfo>;
+    /**
+     * Get version router (may trigger detection if not yet initialized)
+     */
+    getVersionRouter(): Promise<VersionRouter>;
+    /**
+     * Check if a feature/chain is supported
+     */
+    isFeatureSupported(feature: string): Promise<boolean>;
+    /**
+     * Clear cached version information and force re-detection
+     */
+    clearVersionCache(): void;
+    /**
+     * Get synchronous API version (returns undefined if not yet detected)
+     */
+    getApiVersionSync(): number | undefined;
+    /**
+     * Check if version detection has completed
+     */
+    isVersionDetected(): boolean;
+}
+/**
+ * Create an SDK configuration with automatic version detection
+ */
+export declare function createSDKConfig(params?: SDKConfigurationParameters): SDKConfiguration;
+/**
+ * Create an SDK configuration with manual version override
+ */
+export declare function createSDKConfigWithVersion(apiVersion: number, params?: ConfigurationParameters): SDKConfiguration;