@routstr/sdk 0.3.7 → 0.3.9

package/dist/interfaces-C-DYd9Jy.d.ts

@@ -0,0 +1,176 @@
+import { k as ProviderInfo, e as Model, M as Message, n as TransactionHistory } from './types-_21yYFZG.js';
+
+/**
+ * Interfaces for the Routstr SDK wallet abstraction layer
+ * These interfaces allow the SDK to be framework-agnostic
+ */
+
+/**
+ * WalletAdapter - Abstracts wallet operations (NIP-60 or legacy)
+ * The React app implements this using its hooks
+ */
+interface WalletAdapter {
+    /** Get balances for all mints (mintUrl -> balance in sats) */
+    getBalances(): Promise<Record<string, number>>;
+    /** Get unit type for each mint (mintUrl -> 'sat' | 'msat') */
+    getMintUnits(): Record<string, "sat" | "msat">;
+    /** Get the currently active mint URL */
+    getActiveMintUrl(): string | null;
+    /**
+     * Create and send a cashu token from a mint
+     * @param mintUrl The mint URL to send from
+     * @param amount Amount in sats
+     * @param p2pkPubkey Optional P2PK public key
+     * @returns Encoded cashu token string
+     */
+    sendToken(mintUrl: string, amount: number, p2pkPubkey?: string): Promise<string>;
+    /**
+     * Receive/store a cashu token
+     * Handles both NIP-60 and legacy storage internally
+     * @param token Encoded cashu token string
+     * @returns Result with success flag and amount received
+     */
+    receiveToken(token: string): Promise<{
+        success: boolean;
+        amount: number;
+        unit: "sat" | "msat";
+        message?: string;
+    }>;
+}
+/**
+ * StorageAdapter - Abstracts local storage operations
+ * Separates token storage from wallet operations
+ */
+interface ApiKeyEntry {
+    baseUrl: string;
+    key: string;
+    balance: number;
+    lastUsed: number | null;
+}
+interface ChildKeyEntry {
+    parentBaseUrl: string;
+    childKey: string;
+    balance: number;
+    balanceLimit?: number;
+    validityDate?: number;
+    createdAt: number;
+}
+interface XCashuTokenEntry {
+    baseUrl: string;
+    token: string;
+    createdAt: number;
+    tryCount: number;
+}
+interface StorageAdapter {
+    /** Save provider info to cache */
+    saveProviderInfo(baseUrl: string, info: ProviderInfo): void;
+    /** Get cached provider info */
+    getProviderInfo(baseUrl: string): ProviderInfo | null;
+    /** Get stored API key entry for a provider */
+    getApiKey(baseUrl: string): ApiKeyEntry | null;
+    /** Store API key for a provider */
+    setApiKey(baseUrl: string, key: string): void;
+    /** Update balance for an existing stored API key (based on provider response) */
+    updateApiKeyBalance(baseUrl: string, balance: number): void;
+    /** Remove API key for a provider */
+    removeApiKey(baseUrl: string): void;
+    /** Get all stored API keys */
+    getAllApiKeys(): ApiKeyEntry[];
+    /** Get all stored API keys as distribution (baseUrl -> amount in sats) */
+    getApiKeyDistribution(): Array<{
+        baseUrl: string;
+        amount: number;
+    }>;
+    /** Get stored child key for a parent provider */
+    getChildKey(parentBaseUrl: string): ChildKeyEntry | null;
+    /** Store a child key for a parent provider */
+    setChildKey(parentBaseUrl: string, childKey: string, balance?: number, validityDate?: number, balanceLimit?: number): void;
+    /** Update balance for an existing child key */
+    updateChildKeyBalance(parentBaseUrl: string, balance: number): void;
+    /** Remove child key for a parent provider */
+    removeChildKey(parentBaseUrl: string): void;
+    /** Get all stored child keys */
+    getAllChildKeys(): ChildKeyEntry[];
+    /** Get cached receive tokens (tokens that failed to receive due to mint errors) */
+    getCachedReceiveTokens(): Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt: number;
+    }>;
+    /** Set cached receive tokens */
+    setCachedReceiveTokens(tokens: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt?: number;
+    }>): void;
+    /** Get all stored xcashu tokens */
+    getXcashuTokens(): Record<string, XCashuTokenEntry[]>;
+    /** Get xcashu tokens for a specific baseUrl */
+    getXcashuTokensForBaseUrl(baseUrl: string): XCashuTokenEntry[];
+    /** Add an xcashu token for a baseUrl */
+    addXcashuToken(baseUrl: string, token: string): void;
+    /** Remove an xcashu token */
+    removeXcashuToken(baseUrl: string, token: string): void;
+    /** Clear all xcashu tokens for a baseUrl */
+    clearXcashuTokensForBaseUrl(baseUrl: string): void;
+    /** Update try count for a specific token */
+    updateXcashuTokenTryCount(token: string, tryCount: number): void;
+}
+/**
+ * ProviderRegistry - Provides access to provider/model data
+ * Used by ProviderManager for failover logic
+ */
+interface ProviderRegistry {
+    /** Get all models available from a provider */
+    getModelsForProvider(baseUrl: string): Model[];
+    /** Get list of disabled provider URLs */
+    getDisabledProviders(): string[];
+    /** Get mints accepted by a provider */
+    getProviderMints(baseUrl: string): string[];
+    /**
+     * Get provider info (version, etc.)
+     * Should fetch from network if not cached, or return cached version
+     */
+    getProviderInfo(baseUrl: string): Promise<ProviderInfo | null>;
+    /** Get all providers with their models */
+    getAllProvidersModels(): Record<string, Model[]>;
+}
+/**
+ * StreamingCallbacks - Callbacks for real-time updates during API calls
+ * Used by RoutstrClient to communicate with the UI
+ */
+interface StreamingCallbacks {
+    /** Called when new content arrives from the stream */
+    onStreamingUpdate: (content: string) => void;
+    /** Called when thinking/reasoning content arrives */
+    onThinkingUpdate: (content: string) => void;
+    /** Called when a complete message should be appended */
+    onMessageAppend: (message: Message) => void;
+    /** Called when balance changes */
+    onBalanceUpdate: (balance: number) => void;
+    /** Called when a transaction is recorded */
+    onTransactionUpdate: (transaction: TransactionHistory) => void;
+    /** Called when a new token is created (amount in sats) */
+    onTokenCreated?: (amount: number) => void;
+    /** Called when payment processing starts/stops */
+    onPaymentProcessing?: (isProcessing: boolean) => void;
+    /** Called when sats spent on the last message is known */
+    onLastMessageSatsUpdate?: (satsSpent: number, estimatedCosts: number) => void;
+}
+/**
+ * Options for creating a RoutstrClient
+ */
+interface RoutstrClientOptions {
+    /** Wallet adapter for cashu operations */
+    walletAdapter: WalletAdapter;
+    /** Storage adapter for token management */
+    storageAdapter: StorageAdapter;
+    /** Provider registry for failover logic */
+    providerRegistry: ProviderRegistry;
+    /** Nostr relay URLs (for future nostr-based features) */
+    relayUrls?: string[];
+}
+
+export type { ApiKeyEntry as A, ChildKeyEntry as C, ProviderRegistry as P, RoutstrClientOptions as R, StorageAdapter as S, WalletAdapter as W, XCashuTokenEntry as X, StreamingCallbacks as a };

package/dist/interfaces-Csn8Uq04.d.mts

@@ -0,0 +1,176 @@
+import { k as ProviderInfo, e as Model, M as Message, n as TransactionHistory } from './types-_21yYFZG.mjs';
+
+/**
+ * Interfaces for the Routstr SDK wallet abstraction layer
+ * These interfaces allow the SDK to be framework-agnostic
+ */
+
+/**
+ * WalletAdapter - Abstracts wallet operations (NIP-60 or legacy)
+ * The React app implements this using its hooks
+ */
+interface WalletAdapter {
+    /** Get balances for all mints (mintUrl -> balance in sats) */
+    getBalances(): Promise<Record<string, number>>;
+    /** Get unit type for each mint (mintUrl -> 'sat' | 'msat') */
+    getMintUnits(): Record<string, "sat" | "msat">;
+    /** Get the currently active mint URL */
+    getActiveMintUrl(): string | null;
+    /**
+     * Create and send a cashu token from a mint
+     * @param mintUrl The mint URL to send from
+     * @param amount Amount in sats
+     * @param p2pkPubkey Optional P2PK public key
+     * @returns Encoded cashu token string
+     */
+    sendToken(mintUrl: string, amount: number, p2pkPubkey?: string): Promise<string>;
+    /**
+     * Receive/store a cashu token
+     * Handles both NIP-60 and legacy storage internally
+     * @param token Encoded cashu token string
+     * @returns Result with success flag and amount received
+     */
+    receiveToken(token: string): Promise<{
+        success: boolean;
+        amount: number;
+        unit: "sat" | "msat";
+        message?: string;
+    }>;
+}
+/**
+ * StorageAdapter - Abstracts local storage operations
+ * Separates token storage from wallet operations
+ */
+interface ApiKeyEntry {
+    baseUrl: string;
+    key: string;
+    balance: number;
+    lastUsed: number | null;
+}
+interface ChildKeyEntry {
+    parentBaseUrl: string;
+    childKey: string;
+    balance: number;
+    balanceLimit?: number;
+    validityDate?: number;
+    createdAt: number;
+}
+interface XCashuTokenEntry {
+    baseUrl: string;
+    token: string;
+    createdAt: number;
+    tryCount: number;
+}
+interface StorageAdapter {
+    /** Save provider info to cache */
+    saveProviderInfo(baseUrl: string, info: ProviderInfo): void;
+    /** Get cached provider info */
+    getProviderInfo(baseUrl: string): ProviderInfo | null;
+    /** Get stored API key entry for a provider */
+    getApiKey(baseUrl: string): ApiKeyEntry | null;
+    /** Store API key for a provider */
+    setApiKey(baseUrl: string, key: string): void;
+    /** Update balance for an existing stored API key (based on provider response) */
+    updateApiKeyBalance(baseUrl: string, balance: number): void;
+    /** Remove API key for a provider */
+    removeApiKey(baseUrl: string): void;
+    /** Get all stored API keys */
+    getAllApiKeys(): ApiKeyEntry[];
+    /** Get all stored API keys as distribution (baseUrl -> amount in sats) */
+    getApiKeyDistribution(): Array<{
+        baseUrl: string;
+        amount: number;
+    }>;
+    /** Get stored child key for a parent provider */
+    getChildKey(parentBaseUrl: string): ChildKeyEntry | null;
+    /** Store a child key for a parent provider */
+    setChildKey(parentBaseUrl: string, childKey: string, balance?: number, validityDate?: number, balanceLimit?: number): void;
+    /** Update balance for an existing child key */
+    updateChildKeyBalance(parentBaseUrl: string, balance: number): void;
+    /** Remove child key for a parent provider */
+    removeChildKey(parentBaseUrl: string): void;
+    /** Get all stored child keys */
+    getAllChildKeys(): ChildKeyEntry[];
+    /** Get cached receive tokens (tokens that failed to receive due to mint errors) */
+    getCachedReceiveTokens(): Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt: number;
+    }>;
+    /** Set cached receive tokens */
+    setCachedReceiveTokens(tokens: Array<{
+        token: string;
+        amount: number;
+        unit: "sat" | "msat";
+        createdAt?: number;
+    }>): void;
+    /** Get all stored xcashu tokens */
+    getXcashuTokens(): Record<string, XCashuTokenEntry[]>;
+    /** Get xcashu tokens for a specific baseUrl */
+    getXcashuTokensForBaseUrl(baseUrl: string): XCashuTokenEntry[];
+    /** Add an xcashu token for a baseUrl */
+    addXcashuToken(baseUrl: string, token: string): void;
+    /** Remove an xcashu token */
+    removeXcashuToken(baseUrl: string, token: string): void;
+    /** Clear all xcashu tokens for a baseUrl */
+    clearXcashuTokensForBaseUrl(baseUrl: string): void;
+    /** Update try count for a specific token */
+    updateXcashuTokenTryCount(token: string, tryCount: number): void;
+}
+/**
+ * ProviderRegistry - Provides access to provider/model data
+ * Used by ProviderManager for failover logic
+ */
+interface ProviderRegistry {
+    /** Get all models available from a provider */
+    getModelsForProvider(baseUrl: string): Model[];
+    /** Get list of disabled provider URLs */
+    getDisabledProviders(): string[];
+    /** Get mints accepted by a provider */
+    getProviderMints(baseUrl: string): string[];
+    /**
+     * Get provider info (version, etc.)
+     * Should fetch from network if not cached, or return cached version
+     */
+    getProviderInfo(baseUrl: string): Promise<ProviderInfo | null>;
+    /** Get all providers with their models */
+    getAllProvidersModels(): Record<string, Model[]>;
+}
+/**
+ * StreamingCallbacks - Callbacks for real-time updates during API calls
+ * Used by RoutstrClient to communicate with the UI
+ */
+interface StreamingCallbacks {
+    /** Called when new content arrives from the stream */
+    onStreamingUpdate: (content: string) => void;
+    /** Called when thinking/reasoning content arrives */
+    onThinkingUpdate: (content: string) => void;
+    /** Called when a complete message should be appended */
+    onMessageAppend: (message: Message) => void;
+    /** Called when balance changes */
+    onBalanceUpdate: (balance: number) => void;
+    /** Called when a transaction is recorded */
+    onTransactionUpdate: (transaction: TransactionHistory) => void;
+    /** Called when a new token is created (amount in sats) */
+    onTokenCreated?: (amount: number) => void;
+    /** Called when payment processing starts/stops */
+    onPaymentProcessing?: (isProcessing: boolean) => void;
+    /** Called when sats spent on the last message is known */
+    onLastMessageSatsUpdate?: (satsSpent: number, estimatedCosts: number) => void;
+}
+/**
+ * Options for creating a RoutstrClient
+ */
+interface RoutstrClientOptions {
+    /** Wallet adapter for cashu operations */
+    walletAdapter: WalletAdapter;
+    /** Storage adapter for token management */
+    storageAdapter: StorageAdapter;
+    /** Provider registry for failover logic */
+    providerRegistry: ProviderRegistry;
+    /** Nostr relay URLs (for future nostr-based features) */
+    relayUrls?: string[];
+}
+
+export type { ApiKeyEntry as A, ChildKeyEntry as C, ProviderRegistry as P, RoutstrClientOptions as R, StorageAdapter as S, WalletAdapter as W, XCashuTokenEntry as X, StreamingCallbacks as a };

package/dist/interfaces-Cv1k2EUK.d.mts

@@ -0,0 +1,118 @@
+import { e as Model, k as ProviderInfo } from './types-_21yYFZG.mjs';
+
+/**
+ * Interfaces for the model and provider discovery system
+ * These abstractions allow the discovery logic to be independent of storage implementation
+ */
+
+/**
+ * Discovery adapter for managing cached provider and model data
+ * Abstracts localStorage operations so discovery logic is testable and reusable
+ */
+interface DiscoveryAdapter {
+    /**
+     * Get cached models from all providers
+     * @returns Record mapping baseUrl -> array of models
+     */
+    getCachedModels(): Record<string, Model[]>;
+    /**
+     * Save models cache
+     * @param models Record mapping baseUrl -> array of models
+     */
+    setCachedModels(models: Record<string, Model[]>): void;
+    /**
+     * Get cached mints from all providers
+     * @returns Record mapping baseUrl -> array of mint URLs
+     */
+    getCachedMints(): Record<string, string[]>;
+    /**
+     * Save mints cache
+     * @param mints Record mapping baseUrl -> array of mint URLs
+     */
+    setCachedMints(mints: Record<string, string[]>): void;
+    /**
+     * Get cached provider info from all providers
+     * @returns Record mapping baseUrl -> provider info object
+     */
+    getCachedProviderInfo(): Record<string, ProviderInfo>;
+    /**
+     * Save provider info cache
+     * @param info Record mapping baseUrl -> provider info object
+     */
+    setCachedProviderInfo(info: Record<string, ProviderInfo>): void;
+    /**
+     * Get provider last update timestamp
+     * @param baseUrl Provider base URL
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getProviderLastUpdate(baseUrl: string): number | null;
+    /**
+     * Set provider last update timestamp
+     * @param baseUrl Provider base URL
+     * @param timestamp Timestamp in milliseconds
+     */
+    setProviderLastUpdate(baseUrl: string, timestamp: number): void;
+    /**
+     * Get last used model ID
+     * @returns Model ID or null if none
+     */
+    getLastUsedModel(): string | null;
+    /**
+     * Save last used model ID
+     * @param modelId Model ID to save
+     */
+    setLastUsedModel(modelId: string): void;
+    /**
+     * Get list of disabled provider base URLs
+     * @returns Array of disabled provider URLs
+     */
+    getDisabledProviders(): string[];
+    /**
+     * Save list of disabled provider base URLs
+     * Optional because some read-only adapters can only expose current disabled state.
+     * @param urls Array of disabled provider URLs
+     */
+    setDisabledProviders?(urls: string[]): void;
+    /**
+     * Get list of configured provider base URLs
+     * @returns Array of provider base URLs
+     */
+    getBaseUrlsList(): string[];
+    /**
+     * Get base URLs list last update timestamp
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getBaseUrlsLastUpdate(): number | null;
+    /**
+     * Save list of provider base URLs
+     * @param urls Array of provider base URLs
+     */
+    setBaseUrlsList(urls: string[]): void;
+    /**
+     * Set base URLs list last update timestamp
+     * @param timestamp Timestamp in milliseconds
+     */
+    setBaseUrlsLastUpdate(timestamp: number): void;
+    /**
+     * Get list of routstr21 models
+     * @returns Array of model IDs
+     */
+    getRoutstr21Models(): string[];
+    /**
+     * Save routstr21 models list
+     * @param models Array of model IDs
+     */
+    setRoutstr21Models(models: string[]): void;
+    /**
+     * Get routstr21 models last update timestamp
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getRoutstr21ModelsLastUpdate(): number | null;
+    /**
+     * Set routstr21 models last update timestamp
+     * @param timestamp Timestamp in milliseconds
+     */
+    setRoutstr21ModelsLastUpdate(timestamp: number): void;
+}
+
+export type { DiscoveryAdapter as D };

package/dist/interfaces-iL7CWeG5.d.ts

@@ -0,0 +1,118 @@
+import { e as Model, k as ProviderInfo } from './types-_21yYFZG.js';
+
+/**
+ * Interfaces for the model and provider discovery system
+ * These abstractions allow the discovery logic to be independent of storage implementation
+ */
+
+/**
+ * Discovery adapter for managing cached provider and model data
+ * Abstracts localStorage operations so discovery logic is testable and reusable
+ */
+interface DiscoveryAdapter {
+    /**
+     * Get cached models from all providers
+     * @returns Record mapping baseUrl -> array of models
+     */
+    getCachedModels(): Record<string, Model[]>;
+    /**
+     * Save models cache
+     * @param models Record mapping baseUrl -> array of models
+     */
+    setCachedModels(models: Record<string, Model[]>): void;
+    /**
+     * Get cached mints from all providers
+     * @returns Record mapping baseUrl -> array of mint URLs
+     */
+    getCachedMints(): Record<string, string[]>;
+    /**
+     * Save mints cache
+     * @param mints Record mapping baseUrl -> array of mint URLs
+     */
+    setCachedMints(mints: Record<string, string[]>): void;
+    /**
+     * Get cached provider info from all providers
+     * @returns Record mapping baseUrl -> provider info object
+     */
+    getCachedProviderInfo(): Record<string, ProviderInfo>;
+    /**
+     * Save provider info cache
+     * @param info Record mapping baseUrl -> provider info object
+     */
+    setCachedProviderInfo(info: Record<string, ProviderInfo>): void;
+    /**
+     * Get provider last update timestamp
+     * @param baseUrl Provider base URL
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getProviderLastUpdate(baseUrl: string): number | null;
+    /**
+     * Set provider last update timestamp
+     * @param baseUrl Provider base URL
+     * @param timestamp Timestamp in milliseconds
+     */
+    setProviderLastUpdate(baseUrl: string, timestamp: number): void;
+    /**
+     * Get last used model ID
+     * @returns Model ID or null if none
+     */
+    getLastUsedModel(): string | null;
+    /**
+     * Save last used model ID
+     * @param modelId Model ID to save
+     */
+    setLastUsedModel(modelId: string): void;
+    /**
+     * Get list of disabled provider base URLs
+     * @returns Array of disabled provider URLs
+     */
+    getDisabledProviders(): string[];
+    /**
+     * Save list of disabled provider base URLs
+     * Optional because some read-only adapters can only expose current disabled state.
+     * @param urls Array of disabled provider URLs
+     */
+    setDisabledProviders?(urls: string[]): void;
+    /**
+     * Get list of configured provider base URLs
+     * @returns Array of provider base URLs
+     */
+    getBaseUrlsList(): string[];
+    /**
+     * Get base URLs list last update timestamp
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getBaseUrlsLastUpdate(): number | null;
+    /**
+     * Save list of provider base URLs
+     * @param urls Array of provider base URLs
+     */
+    setBaseUrlsList(urls: string[]): void;
+    /**
+     * Set base URLs list last update timestamp
+     * @param timestamp Timestamp in milliseconds
+     */
+    setBaseUrlsLastUpdate(timestamp: number): void;
+    /**
+     * Get list of routstr21 models
+     * @returns Array of model IDs
+     */
+    getRoutstr21Models(): string[];
+    /**
+     * Save routstr21 models list
+     * @param models Array of model IDs
+     */
+    setRoutstr21Models(models: string[]): void;
+    /**
+     * Get routstr21 models last update timestamp
+     * @returns Timestamp in milliseconds or null if never updated
+     */
+    getRoutstr21ModelsLastUpdate(): number | null;
+    /**
+     * Set routstr21 models last update timestamp
+     * @param timestamp Timestamp in milliseconds
+     */
+    setRoutstr21ModelsLastUpdate(timestamp: number): void;
+}
+
+export type { DiscoveryAdapter as D };