@daydreamsai/ai-sdk-provider/dist/index.d.mts

Dreams Router AI SDK provider (forked from OpenRouter)

import { LanguageModelV2, LanguageModelV2CallOptions, LanguageModelV2Content, LanguageModelV2FinishReason, LanguageModelV2Usage, LanguageModelV2CallWarning, LanguageModelV2ResponseMetadata, SharedV2Headers, LanguageModelV2StreamPart } from '@ai-sdk/provider';
export { LanguageModelV2, LanguageModelV2Prompt } from '@ai-sdk/provider';
import { Account } from 'viem';

type OpenRouterChatModelId = string;
type OpenRouterChatSettings = {
    /**
  Modify the likelihood of specified tokens appearing in the completion.
  
  Accepts a JSON object that maps tokens (specified by their token ID in
  the GPT tokenizer) to an associated bias value from -100 to 100. You
  can use this tokenizer tool to convert text to token IDs. Mathematically,
  the bias is added to the logits generated by the model prior to sampling.
  The exact effect will vary per model, but values between -1 and 1 should
  decrease or increase likelihood of selection; values like -100 or 100
  should result in a ban or exclusive selection of the relevant token.
  
  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
  token from being generated.
  */
    logitBias?: Record<number, number>;
    /**
  Return the log probabilities of the tokens. Including logprobs will increase
  the response size and can slow down response times. However, it can
  be useful to understand better how the model is behaving.
  
  Setting to true will return the log probabilities of the tokens that
  were generated.
  
  Setting to a number will return the log probabilities of the top n
  tokens that were generated.
  */
    logprobs?: boolean | number;
    /**
  Whether to enable parallel function calling during tool use. Default to true.
     */
    parallelToolCalls?: boolean;
    /**
  A unique identifier representing your end-user, which can help OpenRouter to
  monitor and detect abuse. Learn more.
  */
    user?: string;
} & OpenRouterSharedSettings;

/**
 * Dreams Router payment configuration types
 */
/**
 * Payment configuration (no private key needed - handled by signer)
 */
interface DreamsRouterPaymentConfig {
    /**
     * Payment amount in USDC (6 decimals). Defaults to 100000 ($0.10)
     */
    amount?: string;
    /**
     * Service wallet address to receive payments
     */
    serviceWallet?: string;
    /**
     * USDC contract address. Defaults to Base Sepolia USDC
     */
    usdcAddress?: string;
    /**
     * Network to use for payments. Defaults to 'base-sepolia'
     */
    network?: 'base-sepolia' | 'base' | 'avalanche-fuji' | 'avalanche' | 'iotex';
    /**
     * Payment validity duration in seconds. Defaults to 600 (10 minutes)
     */
    validityDuration?: number;
}
/**
 * Dreams Router authentication method types
 */
type DreamsRouterAuthMethod = 'api-key' | 'session-token';
interface DreamsRouterAuthConfig {
    method: DreamsRouterAuthMethod;
    apiKey?: string;
    sessionToken?: string;
}

type OpenRouterProviderOptions = {
    models?: string[];
    /**
     * https://openrouter.ai/docs/use-cases/reasoning-tokens
     * One of `max_tokens` or `effort` is required.
     * If `exclude` is true, reasoning will be removed from the response. Default is false.
     */
    reasoning?: {
        enabled?: boolean;
        exclude?: boolean;
    } & ({
        max_tokens: number;
    } | {
        effort: 'high' | 'medium' | 'low';
    });
    /**
     * A unique identifier representing your end-user, which can
     * help OpenRouter to monitor and detect abuse.
     */
    user?: string;
};
type OpenRouterSharedSettings = OpenRouterProviderOptions & {
    /**
     * @deprecated use `reasoning` instead
     */
    includeReasoning?: boolean;
    extraBody?: Record<string, unknown>;
    /**
     * Enable usage accounting to get detailed token usage information.
     * https://openrouter.ai/docs/use-cases/usage-accounting
     */
    usage?: {
        /**
         * When true, includes token usage information in the response.
         */
        include: boolean;
    };
};
/**
 * Usage accounting response
 * @see https://openrouter.ai/docs/use-cases/usage-accounting
 */
type OpenRouterUsageAccounting = {
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
    cost?: number;
};

type OpenRouterCompletionModelId = string;
type OpenRouterCompletionSettings = {
    /**
  Modify the likelihood of specified tokens appearing in the completion.
  
  Accepts a JSON object that maps tokens (specified by their token ID in
  the GPT tokenizer) to an associated bias value from -100 to 100. You
  can use this tokenizer tool to convert text to token IDs. Mathematically,
  the bias is added to the logits generated by the model prior to sampling.
  The exact effect will vary per model, but values between -1 and 1 should
  decrease or increase likelihood of selection; values like -100 or 100
  should result in a ban or exclusive selection of the relevant token.
  
  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
  token from being generated.
     */
    logitBias?: Record<number, number>;
    /**
  Return the log probabilities of the tokens. Including logprobs will increase
  the response size and can slow down response times. However, it can
  be useful to better understand how the model is behaving.
  
  Setting to true will return the log probabilities of the tokens that
  were generated.
  
  Setting to a number will return the log probabilities of the top n
  tokens that were generated.
     */
    logprobs?: boolean | number;
    /**
  The suffix that comes after a completion of inserted text.
     */
    suffix?: string;
} & OpenRouterSharedSettings;

type OpenRouterChatConfig = {
    provider: string;
    compatibility: 'strict' | 'compatible';
    headers: () => Record<string, string | undefined>;
    url: (options: {
        modelId: string;
        path: string;
    }) => string;
    fetch?: typeof fetch;
    extraBody?: Record<string, unknown>;
};
declare class OpenRouterChatLanguageModel implements LanguageModelV2 {
    readonly specificationVersion: "v2";
    readonly provider = "dreamsrouter";
    readonly defaultObjectGenerationMode: "tool";
    readonly modelId: OpenRouterChatModelId;
    readonly supportedUrls: Record<string, RegExp[]>;
    readonly settings: OpenRouterChatSettings;
    private readonly config;
    constructor(modelId: OpenRouterChatModelId, settings: OpenRouterChatSettings, config: OpenRouterChatConfig);
    private getArgs;
    doGenerate(options: LanguageModelV2CallOptions): Promise<{
        content: Array<LanguageModelV2Content>;
        finishReason: LanguageModelV2FinishReason;
        usage: LanguageModelV2Usage;
        warnings: Array<LanguageModelV2CallWarning>;
        providerMetadata?: {
            openrouter: {
                provider: string;
                usage: OpenRouterUsageAccounting;
            };
        };
        request?: {
            body?: unknown;
        };
        response?: LanguageModelV2ResponseMetadata & {
            headers?: SharedV2Headers;
            body?: unknown;
        };
    }>;
    doStream(options: LanguageModelV2CallOptions): Promise<{
        stream: ReadableStream<LanguageModelV2StreamPart>;
        warnings: Array<LanguageModelV2CallWarning>;
        request?: {
            body?: unknown;
        };
        response?: LanguageModelV2ResponseMetadata & {
            headers?: SharedV2Headers;
            body?: unknown;
        };
    }>;
}

type OpenRouterCompletionConfig = {
    provider: string;
    compatibility: 'strict' | 'compatible';
    headers: () => Record<string, string | undefined>;
    url: (options: {
        modelId: string;
        path: string;
    }) => string;
    fetch?: typeof fetch;
    extraBody?: Record<string, unknown>;
};
declare class OpenRouterCompletionLanguageModel implements LanguageModelV2 {
    readonly specificationVersion: "v2";
    readonly provider = "openrouter";
    readonly modelId: OpenRouterCompletionModelId;
    readonly supportedUrls: Record<string, RegExp[]>;
    readonly defaultObjectGenerationMode: undefined;
    readonly settings: OpenRouterCompletionSettings;
    private readonly config;
    constructor(modelId: OpenRouterCompletionModelId, settings: OpenRouterCompletionSettings, config: OpenRouterCompletionConfig);
    private getArgs;
    doGenerate(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
    doStream(options: LanguageModelV2CallOptions): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
}

interface OpenRouterProvider extends LanguageModelV2 {
    (modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
    (modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
    languageModel(modelId: OpenRouterChatModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
    languageModel(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
    /**
  Creates an OpenRouter chat model for text generation.
     */
    chat(modelId: OpenRouterChatModelId, settings?: OpenRouterChatSettings): OpenRouterChatLanguageModel;
    /**
  Creates an OpenRouter completion model for text generation.
     */
    completion(modelId: OpenRouterCompletionModelId, settings?: OpenRouterCompletionSettings): OpenRouterCompletionLanguageModel;
}
interface OpenRouterProviderSettings {
    /**
  Base URL for the OpenRouter API calls.
       */
    baseURL?: string;
    /**
  @deprecated Use `baseURL` instead.
       */
    baseUrl?: string;
    /**
    API key for authenticating requests. JWT or API key.
       */
    apiKey?: string;
    /**
  Custom headers to include in the requests.
       */
    headers?: Record<string, string>;
    /**
  OpenRouter compatibility mode. Should be set to `strict` when using the OpenRouter API,
  and `compatible` when using 3rd party providers. In `compatible` mode, newer
  information such as streamOptions are not being sent. Defaults to 'compatible'.
     */
    compatibility?: "strict" | "compatible";
    /**
  Custom fetch implementation. You can use it as a middleware to intercept requests,
  or to provide a custom fetch implementation for e.g. testing.
      */
    fetch?: typeof fetch;
    /**
  A JSON object to send as the request body to access OpenRouter features & upstream provider features.
    */
    extraBody?: Record<string, unknown>;
    /**
     * Payment configuration for x402 payments. When provided, the SDK will automatically
     * generate x402 payment signatures for each request.
     * Note: This is used internally by wallet auth utils. Use createDreamsRouterAuth() for easier setup.
     */
    payment?: DreamsRouterPaymentConfig;
    /**
     * Account for generating x402 payments. Used internally by wallet auth utils.
     */
    signer?: Account;
}
/**
Create a Dreams router provider instance.
 */
declare function createDreamsRouter(options?: OpenRouterProviderSettings): OpenRouterProvider;
/**
Default Dreams router provider instance. It uses 'strict' compatibility mode.
 */
declare const dreamsrouter: OpenRouterProvider;

/**
 * x402 Payment utilities for Dreams Router
 */

/**
 * Creates EIP-712 typed data for X402 payment (no signing)
 */
declare function createX402PaymentData(address: string, config?: DreamsRouterPaymentConfig): {
    eip712Data: {
        types: {
            TransferWithAuthorization: {
                name: string;
                type: string;
            }[];
        };
        domain: {
            name: string;
            version: string;
            chainId: number;
            verifyingContract: `0x${string}`;
        };
        primaryType: "TransferWithAuthorization";
        message: {
            from: `0x${string}`;
            to: `0x${string}`;
            value: string;
            validAfter: string;
            validBefore: string;
            nonce: string;
        };
    };
    authorization: {
        from: `0x${string}`;
        to: `0x${string}`;
        value: string;
        validAfter: string;
        validBefore: string;
        nonce: string;
    };
    network: "base-sepolia" | "base" | "avalanche-fuji" | "avalanche" | "iotex";
};
/**
 * Generates X402 payment for browser/wagmi environments
 */
declare function generateX402PaymentBrowser(address: string, signTypedDataAsync: (data: any) => Promise<string>, config?: DreamsRouterPaymentConfig): Promise<string | null>;
declare function generateX402Payment(account: Account, config: DreamsRouterPaymentConfig): Promise<string | null>;

/**
 * Dreams Router API Client
 * Provides access to Dreams Router API endpoints with authentication support
 */
interface ApiResponse<T = any> {
    success: boolean;
    data?: T;
    user?: User;
    apiKey?: string;
    sessionToken?: string;
    usageHistory?: UsageLog[];
    statistics?: UsageStats;
    summary?: UsageSummary;
    models?: ModelConfig[];
    stats?: ModelStats;
    providers?: ModelProvider[];
    categories?: ModelCategory[];
    recommendations?: ModelRecommendationResponse;
    error?: string;
    amountCredited?: number;
    newBalance?: number;
    balance?: number;
    userId?: string;
    walletAddress?: string;
    exists?: boolean;
    lastSeen?: number;
    message?: string;
    instructions?: any;
}
interface User {
    id: string;
    walletAddress?: string;
    balance: number;
    authMethod: 'api-key' | 'wallet' | 'password' | 'github';
    createdAt: number;
    updatedAt: number;
    name?: string;
    email?: string;
    emailVerified?: boolean;
    githubId?: string;
    githubUsername?: string;
    githubLinkedAt?: number | null;
    lastSeen?: number;
}
interface UsageLog {
    id: string;
    userId: string;
    model: string;
    promptTokens: number;
    completionTokens: number;
    totalTokens: number;
    costUsd: number;
    timestamp: number;
    paymentMethod?: string;
    provider?: string;
}
interface UsageStats {
    totalRequests: number;
    totalTokens: number;
    totalCost: number;
    avgTokensPerRequest: number;
    mostUsedModel: string | null;
    requestCount: number;
    timeRange: {
        start: number;
        end: number;
    };
}
interface UsageSummary {
    totalRequests: number;
    totalCost: number;
    totalTokens: number;
    modelsUsed: string[];
    paymentMethods: Record<string, {
        requests: number;
        cost: number;
    }>;
    costByModel: Record<string, number>;
    tokensByModel: Record<string, number>;
}
interface ModelConfig {
    id: string;
    name: string;
    description: string;
    context_length: number;
    pricing: {
        prompt: number;
        completion: number;
    };
    capabilities: string[];
}
interface ModelStats {
    total_models: number;
    active_models: number;
    most_popular: string;
}
interface ModelProvider {
    id: string;
    name: string;
    models: string[];
}
interface ModelCategory {
    id: string;
    name: string;
    description: string;
    models: string[];
}
interface ModelRecommendationResponse {
    recommended_models: ModelConfig[];
    reasoning: string;
}
interface DreamsRouterApiClientOptions {
    baseURL?: string;
    apiKey?: string;
    defaultHeaders?: Record<string, string>;
}
declare class DreamsRouterApiClient {
    private baseURL;
    private defaultHeaders;
    private onTokenExpired?;
    constructor(options?: DreamsRouterApiClientOptions);
    setApiKey(apiKey: string): void;
    removeApiKey(): void;
    removeSessionToken(): void;
    setTokenExpiredCallback(callback: () => Promise<string | null>): void;
    private request;
    private isJWTTokenExpired;
    getProfile(): Promise<ApiResponse<{
        user: User;
    }>>;
    walletLogin(walletAddress: string, signature: string, message: string): Promise<ApiResponse<{
        user: User;
        sessionToken: string;
    }>>;
    getWalletBalance(address: string): Promise<ApiResponse<{
        balance: number;
        userId?: string;
        walletAddress?: string;
        exists?: boolean;
        lastSeen?: number;
    }>>;
    processPayment(x402Payment: string): Promise<ApiResponse<{
        amountCredited: number;
        newBalance: number;
    }>>;
    getDetailedModels(): Promise<ApiResponse<{
        models: ModelConfig[];
    }>>;
    getModelStats(): Promise<ApiResponse<{
        stats: ModelStats;
    }>>;
    getProviders(): Promise<ApiResponse<{
        providers: ModelProvider[];
    }>>;
    getModelCategories(): Promise<ApiResponse<{
        categories: ModelCategory[];
    }>>;
    searchModels(query: string): Promise<ApiResponse>;
    getModelRecommendations(requirements: {
        budget?: number;
        needsVision?: boolean;
        needsFunctions?: boolean;
        needsStreaming?: boolean;
        minTokens?: number;
    }): Promise<ApiResponse<{
        recommendations: ModelRecommendationResponse;
    }>>;
}

interface WalletAuthManager {
    apiClient: DreamsRouterApiClient;
    currentSessionToken: string | null;
    currentUser: User | null;
    currentAccount: Account | null;
    /**
     * Sign message and get JWT session token using an account
     */
    walletLogin(account: Account): Promise<{
        sessionToken: string;
        user: User;
    }>;
    /**
     * Create Dreams Router provider with current authentication and optional payments
     */
    createDreamsRouter(options?: {
        payments?: DreamsRouterPaymentConfig;
    }): ReturnType<typeof createDreamsRouter>;
    /**
     * Get current user profile
     */
    getProfile(): Promise<User>;
    /**
     * Get wallet balance
     */
    getBalance(address: string): Promise<number>;
    /**
     * Logout and clear tokens
     */
    logout(): void;
}
interface WalletAuthManagerOptions {
    baseURL?: string;
    onTokenExpired?: () => Promise<string | null>;
}
declare function createWalletAuthManager(options?: WalletAuthManagerOptions): WalletAuthManager;
/**
 * Dreams Router authentication with automatic AI SDK integration
 */
declare function createDreamsRouterAuth(account: Account, options?: WalletAuthManagerOptions & {
    payments?: DreamsRouterPaymentConfig;
}): Promise<{
    sessionToken: string;
    user: User;
    dreamsRouter: OpenRouterProvider;
    authManager: WalletAuthManager;
}>;

export { type DreamsRouterAuthConfig, type DreamsRouterAuthMethod, type DreamsRouterPaymentConfig, type OpenRouterCompletionSettings, type OpenRouterProvider, type OpenRouterProviderOptions, type OpenRouterProviderSettings, type OpenRouterSharedSettings, type OpenRouterUsageAccounting, type WalletAuthManager, type WalletAuthManagerOptions, createDreamsRouter, createDreamsRouterAuth, createWalletAuthManager, createX402PaymentData, dreamsrouter, generateX402Payment, generateX402PaymentBrowser };