Class ConfigModule

Config module — BugBug-side configuration and connectivity probes.

Used by integrators to check API reachability, get IP ranges for firewall allowlists, and surface a one-shot system summary.

Index

Constructors

Methods

getIpAddresses getStatus testConnectivity getSystemInfo

Constructors

constructor

new ConfigModule(client: BugBugApiClient): ConfigModule
Parameters
- client: BugBugApiClient
Returns ConfigModule
- Defined in sdk/src/modules/config/config.ts:17

Methods

getIpAddresses

getIpAddresses(options?: RequestOptions): Promise<{ ips: string[] }>
Fetch the BugBug infrastructure IP ranges that should be allowlisted for outbound runner traffic.
Parameters
- options: RequestOptions = {}
Returns Promise<{ ips: string[] }>
- Defined in sdk/src/modules/config/config.ts:25

getStatus

getStatus(options?: RequestOptions): Promise<ApiStatus>
Liveness probe + token check.

GET /config/status/ is unauthenticated. If the SDK's apiToken is sent, the server validates it and reports the result via authenticated; an invalid token still returns 200, so this method only throws on transport-level failures.
Parameters
- options: RequestOptions = {}
Returns Promise<ApiStatus>
- Defined in sdk/src/modules/config/config.ts:36

testConnectivity

testConnectivity(options?: RequestOptions): Promise<ConnectivityStatus>
Probe API connectivity and authentication by making one lightweight call.

Never throws — transport failures are returned as connected: false with the error message. When the call succeeds, authenticated reflects whether the configured API token is currently valid.
Parameters
- options: RequestOptions = {}
Returns Promise<ConnectivityStatus>
A ConnectivityStatus snapshot with response time and message.
- Defined in sdk/src/modules/config/config.ts:48

getSystemInfo

getSystemInfo(options?: RequestOptions): Promise<SdkSystemInfo>
Single-shot system summary: IP ranges + connectivity probe.

Internally issues one IP-fetch and reuses it as the connectivity probe to avoid duplicate requests.
Parameters
- options: RequestOptions = {}
Returns Promise<SdkSystemInfo>
A SdkSystemInfo snapshot with { ipAddresses, connectivity, timestamp }.
- Defined in sdk/src/modules/config/config.ts:80