providerplaneai
    Preparing search index...

    Class BaseProviderAbstract

    Abstract base class for all AI providers.

    Provides shared helpers and state management for provider implementations.

    Responsibilities:

    • Store and manage provider configuration
    • Register and check supported capabilities
    • Merge provider defaults, model configs, and runtime options
    • Offer type-safe capability checks

    Does not implement Provider directly, but is intended for extension by concrete provider classes.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    capabilities config executors? providerType

    Methods

    ensureInitialized getCapabilities getCapability getMergedOptions getProviderType hasCapability init isInitialized mergeOptions registerCapability setClientExecutors sanitizeConstructorParams

    Constructors

    Properties

    capabilities: Partial<CapabilityMap> = {}

    Support provider capabilities

    config: ProviderConnectionConfig | null = null

    Current connection config

    executors?: Map<CapabilityKeyType, CapabilityExecutor<any, any, any>>
    providerType: AIProviderType

    Type of this provider (OpenAI, Anthropic, Gemini, etc.)

    Methods

    • Resolve and merge configuration for a capability.

      Merge precedence (low → high):

      1. providerDefaults (global provider-level defaults)
      2. model capability defaults (models[modelName][capability])
      3. runtimeOptions (request-level overrides)

      Model resolution fallback: runtimeOptions.model → config.defaultModels[capability] → config.defaultModel

      Parameters

      • capability: string

        Name of the capability.

      • runtimeOptions: any = {}

        Request-level override options.

      Returns { generalParams: any; model: any; modelParams: any; providerParams: any }

      Merged configuration with keys such as model, modelParams, providerParams, and generalParams.

      When a model cannot be resolved for the requested capability.

    • Type-safe runtime check for a capability. Allows safe casting after confirming the capability is registered.

      Type Parameters

      Parameters

      • capability: C

        Capability symbol.

      Returns boolean

      true when the capability is registered.

    • Deep-merge multiple objects. Arrays override completely, objects are recursively merged, primitives override. Used for merging provider defaults, model configurations, and runtime options.

      Parameters

      • ...sources: any[]

        Objects to merge.

      Returns any

      Deep-merged object.

    • Strips keys from providerParams that must never be forwarded to an SDK constructor because they can redirect API traffic or override credentials.

      Blocked keys across all supported SDKs:

      • baseURL / baseUrl — redirects all provider traffic to an arbitrary host, causing the API key to be sent to an attacker-controlled server.
      • apiKey / authToken — would silently override the key already set from config.
      • httpAgent — custom HTTP agent can route traffic through an arbitrary proxy.
      • fetch / globalFetch — custom fetch implementations can intercept all requests.
      • httpOptions — Gemini SDK wrapper for baseUrl and custom fetch.

      Parameters

      • params: Record<string, unknown>

        Raw providerParams from caller config.

      Returns Record<string, unknown>

      Params with dangerous constructor keys removed.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods