@bugbug-io/sdk
    Preparing search index...

    Class BugBugSDK

    Main BugBug SDK class providing modular access to BugBug API functionality.

    Organizes functionality into dedicated modules:

    • tests - Test management and execution
    • suites - Suite management and execution
    • profiles - Profile management
    • config - System configuration and connectivity
    • groups - Groups/components management
    • components - Reusable test components listing
    • steps - Individual test steps management
    • project - Project settings, ZIP export, and ZIP import
    • projectArtifacts - Project artifact uploads for upload-file steps
    • visualRegression - Visual regression reference screenshots
    • auth - OAuth authorization and token identity helpers
    import { createBugBug } from '@bugbug-io/sdk';

    const sdk = createBugBug({
      apiToken: 'your-api-token',
      verbose: true
    });

    // Run a test and watch progress
    const result = await sdk.tests.startRun('my-test', {
      watchProgress: true,
      onProgress: (run) => console.log(`Status: ${run.status}`)
    });
    Index

    Constructors

    constructor

    Properties

    tests suites profiles config groups components steps stepRuns project projectArtifacts projects variables visualRegression auth

    Methods

    getConfig updateConfig setProject testConnection

    Constructors

    Properties

    tests: TestsModule
    suites: SuitesModule
    profiles: ProfilesModule
    config: ConfigModule
    groups: GroupsModule
    components: ComponentsModule
    steps: StepsModule
    stepRuns: StepRunsModule
    project: ProjectModule
    projectArtifacts: ProjectArtifactsModule
    projects: ProjectsModule
    variables: VariablesModule
    visualRegression: VisualRegressionModule
    auth: AuthModule

    Methods

    • Get the current SDK configuration.

      Returns Readonly<Required<BugBugConfig>>

      Readonly configuration object with all resolved defaults

      const config = sdk.getConfig();
      console.log(`API URL: ${config.apiUrl}`);
      console.log(`Verbose: ${config.verbose}`);

    • Update SDK configuration at runtime.

      Parameters

      • updates: Partial<BugBugConfig>

        Partial configuration updates to apply

      Returns void

      sdk.updateConfig({
        verbose: true,
        timeout: 60000
      });

    • Set the active project for subsequent project-scoped requests. Shorthand for updateConfig({ projectId }).

      Parameters

      • projectId: string

        The project id to scope requests to.

      Returns void

      sdk.setProject('00000000-0000-0000-0000-000000000001');

    • Test API connectivity and authentication.

      Parameters

      • options: RequestOptions = {}

        Request options including timeout and signal

      Returns Promise<ConnectivityStatus>

      Connectivity test result with timing and status

      const result = await sdk.testConnection();
      if (result.connected) {
        console.log(`Connected in ${result.responseTime}ms`);
      } else {
        console.error(`Connection failed: ${result.error}`);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods