one-api-workers/type.d.ts

type Variables = {
    lang: string | undefined | null
}

type AnalyticsEngineDataPoint = {
    blobs?: string[];
    doubles?: number[];
    indexes?: string[];
}

interface AnalyticsEngineDataset {
    writeDataPoint: (point: AnalyticsEngineDataPoint) => void;
    writeDataPoints?: (points: AnalyticsEngineDataPoint[]) => void;
}

type CloudflareBindings = {
    DB: D1Database;
    ASSETS: Fetcher;
    ADMIN_TOKEN: string;
    CF_API_TOKEN?: string;
    CF_ACCOUNT_ID?: string;
    FRONTEND_DEV_SERVER_URL?: string;
    USAGE_ANALYTICS?: AnalyticsEngineDataset;
    USAGE_ANALYTICS_DATASET?: string;
    DISABLE_ANALYTICS_QUERIES?: string;
}

type HonoCustomType = {
    "Bindings": CloudflareBindings;
    "Variables": Variables;
}

// 数据库表行的基础结构
type BaseDbRow = {
    created_at: string;
    updated_at: string;
}

// channel_config 表的行结构
type ChannelConfigRow = BaseDbRow & {
    key: string;
    value: string; // JSON 字符串，解析后为 ChannelConfig 类型
}

// api_token 表的行结构
type ApiTokenRow = BaseDbRow & {
    key: string;
    value: string; // JSON 字符串，解析后为 ApiTokenData 类型
    usage: number; // 原始计费单位整数
}

type ChannelType =
    | "azure-openai"
    | "openai"
    | "gemini"
    | "azure-openai-audio"
    | "openai-audio"
    | "claude"
    | "claude-to-openai"
    | "openai-responses"
    | "azure-openai-responses"
    | undefined
    | null;

type ChannelModelMapping = {
    id: string;
    name: string;
    enabled?: boolean;
    default_params?: Record<string, unknown>;
}

type ChannelConfig = {
    name: string;
    type: ChannelType;
    endpoint: string;
    enabled?: boolean;
    weight?: number;
    api_key?: string;
    api_keys?: string[];
    auto_retry?: boolean;
    auto_rotate?: boolean;
    models?: ChannelModelMapping[];
    supported_models?: string[];
    deployment_mapper?: Record<string, string>;
    model_pricing?: Record<string, ModelPricing>;
}

type ChannelConfigMap = {
    [key: string]: ChannelConfig;
}

type OpenAIResponse = {
    usage?: Usage
}

type Usage = {
    prompt_tokens?: number,
    completion_tokens?: number,
    total_tokens?: number,
    cached_tokens?: number,
}

type oawKeyPayload = {
    channel_key: string;
    multipler: number | undefined | null;
}

type CommonResponse = {
    success?: boolean;
    message?: string;
    data?: any;
}

type PricingBillingMode = "volume" | "request";

type ModelPricing = {
    billingMode?: PricingBillingMode;
    input?: number;
    output?: number;
    cache?: number;
    // 兼容旧版独立按次收费配置
    request?: number;
}

type BillingConfig = {
    displayDecimals: number;
}

type AdminSecurityConfig = {
    enabled: boolean;
    telegramBotToken: string;
    telegramChatId: string;
    verifiedFingerprint: string;
    verifiedAt: string | null;
}

type ApiDocsConfig = {
    enabled: boolean;
}

type SystemConfig = BillingConfig & {
    adminSecurity: AdminSecurityConfig;
    apiDocs: ApiDocsConfig;
}

type ApiTokenData = {
    name: string;
    channel_keys: string[];
    total_quota: number; // 原始计费单位整数，-1 表示无限额度
}

type RequestTrackingState = {
    retryCount: number;
    upstreamStatus?: number;
    errorSummary?: string;
}

type AdminLoginChallengeRow = BaseDbRow & {
    id: string;
    code_hash: string;
    expires_at: string;
    attempts: number;
    max_attempts: number;
    request_ip: string;
    request_country: string;
    request_region: string;
    request_city: string;
    request_colo: string;
    request_timezone: string;
}

type AdminSessionRow = BaseDbRow & {
    token_hash: string;
    expires_at: string;
    last_used_at: string;
}