bothy-sdk
    Preparing search index...

    Module index

    TypeScript SDK of the public API (docs/spec/11-extensions.md section 11), Node.js entry.

    The types in ./generated/openapi.ts come from docs/api/openapi.yaml through the pinned openapi-typescript (make -C sdk/typescript generate, never edited by hand). On that core the hand layer of 11 11.2 adds the modules auth, retry, gateway, invocation, runs, components, commands, outbox, heartbeat and webhooks; createApiClient always registers the tolerance layer of ./tolerance.ts (gate G5). This entry handles tokens and keys and is for Node.js only; bothy-sdk/core is the browser-safe subset and bothy-sdk/testing holds the FakeServer and the shared scenarios (docs/decisions.d/M2-30.md D-M2-30-2).

    const api = createApiClient({ baseUrl: "https://example.com/api/v1", token: new Secret(token) });
    const { data } = await api.GET("/events", { params: { query: { after: 0 } } });
    for (const event of data ? knownEvents(data) : []) console.log(event.type);

    Classes

    AckWindow
    Adapter
    AgentHandler
    AgentInvocationDenied
    AlreadyStarted
    AutocompleteTooManyChoicesError
    BadRequestError
    BaseVersionConflict
    BillingModeMismatch
    CloseReason
    CommandSpec
    ConflictError
    CursorAdvance
    DpopKey
    Envelope
    FileInboxStore
    FileOutboxStore
    ForbiddenError
    Gateway
    GatewayEvent
    GatewayOpError
    GatewaySource
    GoneError
    HeartbeatSender
    InboxEntry
    InvocationTokenInvalid
    InvocationVerifier
    MemoryCommandStore
    MemoryInboxStore
    MemoryOutboxStore
    NotFoundError
    Outbox
    PatchPath
    PatchPathError
    PollingSource
    PreconditionFailedError
    ProblemError
    RateLimitedError
    RenderedContext
    RequestInProgress
    RunHandle
    RunPatcher
    RuntimeFailure
    Secret
    ServerError
    SourceReady
    TimeoutError
    ToolClassMismatch
    TransportError
    UnauthenticatedError
    Unavailable
    UseDpopNonce
    ValidationFailed
    VersionConflict
    WebhookConfigError
    WebhookKeyCache
    WebhookVerificationError

    Interfaces

    Actual
    ActualBilling
    AdapterConfig
    AdapterOptions
    AddStepOptions
    ApiClientExtras
    ApiClientOptions
    ApprovalCardOptions
    AutocompleteRequest
    BuildHeartbeatOptions
    ButtonOptions
    CallOptions
    CardMessageOptions
    Clock
    CommandSpecOptions
    CommandStore
    ComponentOptions
    Credentials
    CursorPage
    DataOf
    DpopProofOptions
    DpopSigner
    EnvelopeFields
    EphemeralEvent
    EventSource
    Expectation
    FetchResult
    FinishOptions
    FormField
    FormOptions
    GatewayOptions
    GatewaySocket
    GuardedAutocompleteOptions
    HeartbeatSenderOptions
    InboxEntryFields
    InboxStore
    Invocation
    InvocationClaims
    InvocationVerifierOptions
    KnownEvent
    LastApiRetryOptions
    Logger
    OutboxEntry
    OutboxOptions
    OutboxStore
    PlanItem
    PollingSourceOptions
    ProblemDetails
    QuestionCardOptions
    ReconcileOptions
    ReconcileResult
    RenderContextOptions
    ReplayStore
    ReportSessionOptions
    RespondOptions
    RetryOptions
    RunHandleOptions
    RunOutbox
    RunPatcherOptions
    RunUpdateGateway
    SdkSettings
    SelectOption
    SelectOptions
    SendMessageOptions
    StartOptions
    TokenCheck
    UnknownEvent
    Unwrapped
    UpdateOptions
    UpdateStepOptions
    VerifiedWebhook
    VerifyWebhookOptions
    VerifyWebhookTrust
    WebhookKeyCacheOptions

    Type Aliases

    ActualSource
    ApiClient
    ApprovalValue
    AutocompleteHandler
    AutocompleteSend
    ButtonStyle
    CommandClient
    Delivery
    DpopAlgorithm
    EntryState
    Event
    EventPage
    EventType
    FollowupState
    GatewayLike
    GatewaySocketConstructor
    HeadersLike
    HeartbeatSend
    InteractionClient
    JwksFetcher
    LogFields
    MetricField
    OutboxEntryKind
    OutboxInit
    OutboxMethod
    OutboxPath
    OutboxState
    PageFetcher
    ProblemErrorClass
    ProblemFieldError
    SuccessData
    TokenVerdict
    TriggererLoader
    WebhookHeaders
    WebhookVerificationErrorCode

    Variables

    API_PREFIX
    APPROVAL_VALUES
    BUTTON_STYLES
    CAPABILITY_KEYS
    CODE_FORM
    CONTEXT_NOTICE
    DATA_NOTICE
    defaultLogger
    DEFAULTS
    DETAILS_KEYS
    EntryState
    FORM_FIELD_TYPES
    HEARTBEAT_MEMBERS
    IDEMPOTENCY_KEY_HEADER
    IDEMPOTENT_EXEMPT_OPERATIONS
    IDENTIFY_ON
    INVOCATION_TOKEN_HEADER
    KNOWN_EVENT_TYPES
    KNOWN_PROBLEM_CODES
    METRIC_FIELDS
    NAME_FORM
    OutboxState
    PATCH_PATHS
    PERMANENT_STATUSES
    PROBLEM_STATUS
    PROTOCOL_VERSIONS
    RESPOND_STATES
    RESUME_ON
    RETRY_EXEMPT_REASONS
    SDK_VERSION
    SETTING_KEYS
    silentLogger
    STOP_ON
    systemClock
    TOKEN_EVENT_TYPES
    TokenVerdict
    toleranceMiddleware
    UPDATE_STATES
    VERSION_FORM

    Functions

    apiPath
    approvalCard
    asSecret
    autocompleteRequest
    backoffMs
    buildHeartbeat
    button
    cardMessage
    checkComponents
    compareActual
    createApiClient
    createDpopProof
    decodeEvent
    dpopThumbprint
    envelopeFrom
    errorClass
    exemptOperationOf
    expectationFor
    form
    gatewayHtu
    gatewayUrl
    guardedAutocomplete
    isKnownEvent
    isNotFound
    isRetryableRequest
    isRetryableStatus
    isRunEnded
    jwksFetcher
    knownEvents
    loadDpopKey
    normalizeHtu
    ownCommands
    pageItems
    pages
    parseDuration
    parseRetryAfter
    parseWebhookPublicKey
    parseWebhookSecret
    problemError
    questionCard
    reconcileCommands
    renderContext
    requireSafeUrl
    resolveSettings
    respond
    restAutocompleteSender
    restHeartbeatSend
    select
    settingsFromMapping
    storedClaims
    triggererLoader
    unwrap
    unwrapDetailed
    update
    userAgentHeader
    uuidv7
    verifyWebhook
    verifyWebhookRequest