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

    Class ProjectModule

    Project-level operations: settings, ZIP export, and ZIP import.

    Import is exposed as a single high-level call — the API's two-step validate → run flow is handled internally. The validate step is what surfaces user-correctable errors (e.g. malformed ZIP, naming conflicts).

    Index

    Constructors

    constructor

    Methods

    getSettings export import

    Constructors

    • Parameters

      • client: BugBugApiClient

      Returns ProjectModule

    Methods

    • Fetch project settings (e.g. retention, integrations).

      Parameters

      Returns Promise<
          {
              browserHeight: number;
              browserLanguage: string
              | null;
              browserWidth: number;
              closeWindowsOnSuccessfulTestRun: boolean;
              domSnapshot: boolean;
              incognitoMode: boolean;
              mobileBrowserHeight: number;
              mobileBrowserWidth: number;
              projectId: string;
              runLogs: "disabled" | "consoleLogs" | "fullBugBugDebugging";
              runTimeoutLocal: number;
              runTimeoutServer: number;
              selectorMethods: {
                  name: string;
                  isActive: boolean;
                  extraValue?: string | null;
                  order: number;
              }[];
              selectorsExcludedAttributes: string
              | null;
              selectorsIncludedAttributes: string | null;
              selectorsNonSemanticClassesEnabled: boolean;
              selectorsPriority: "manual" | "automatic";
              sleep: number;
              timezone:
                  | "Africa/Abidjan"
                  | "Africa/Accra"
                  | "Africa/Addis_Ababa"
                  | "Africa/Algiers"
                  | "Africa/Asmara"
                  | "Africa/Bamako"
                  | "Africa/Bangui"
                  | "Africa/Banjul"
                  | "Africa/Bissau"
                  | "Africa/Blantyre"
                  | "Africa/Brazzaville"
                  | "Africa/Bujumbura"
                  | "Africa/Cairo"
                  | "Africa/Casablanca"
                  | "Africa/Ceuta"
                  | "Africa/Conakry"
                  | "Africa/Dakar"
                  | "Africa/Dar_es_Salaam"
                  | "Africa/Djibouti"
                  | "Africa/Douala"
                  | "Africa/El_Aaiun"
                  | "Africa/Freetown"
                  | "Africa/Gaborone"
                  | "Africa/Harare"
                  | "Africa/Johannesburg"
                  | "Africa/Juba"
                  | "Africa/Kampala"
                  | "Africa/Khartoum"
                  | "Africa/Kigali"
                  | "Africa/Kinshasa"
                  | "Africa/Lagos"
                  | "Africa/Libreville"
                  | "Africa/Lome"
                  | "Africa/Luanda"
                  | "Africa/Lubumbashi"
                  | "Africa/Lusaka"
                  | "Africa/Malabo"
                  | "Africa/Maputo"
                  | "Africa/Maseru"
                  | "Africa/Mbabane"
                  | "Africa/Mogadishu"
                  | "Africa/Monrovia"
                  | "Africa/Nairobi"
                  | "Africa/Ndjamena"
                  | "Africa/Niamey"
                  | "Africa/Nouakchott"
                  | "Africa/Ouagadougou"
                  | "Africa/Porto-Novo"
                  | "Africa/Sao_Tome"
                  | "Africa/Tripoli"
                  | "Africa/Tunis"
                  | "Africa/Windhoek"
                  | "America/Adak"
                  | "America/Anchorage"
                  | "America/Anguilla"
                  | "America/Antigua"
                  | "America/Araguaina"
                  | "America/Argentina/Buenos_Aires"
                  | "America/Argentina/Catamarca"
                  | "America/Argentina/Cordoba"
                  | "America/Argentina/Jujuy"
                  | "America/Argentina/La_Rioja"
                  | "America/Argentina/Mendoza"
                  | "America/Argentina/Rio_Gallegos"
                  | "America/Argentina/Salta"
                  | "America/Argentina/San_Juan"
                  | "America/Argentina/San_Luis"
                  | "America/Argentina/Tucuman"
                  | "America/Argentina/Ushuaia"
                  | "America/Aruba"
                  | "America/Asuncion"
                  | "America/Atikokan"
                  | "America/Bahia"
                  | "America/Bahia_Banderas"
                  | "America/Barbados"
                  | "America/Belem"
                  | "America/Belize"
                  | "America/Blanc-Sablon"
                  | "America/Boa_Vista"
                  | "America/Bogota"
                  | "America/Boise"
                  | "America/Cambridge_Bay"
                  | "America/Campo_Grande"
                  | "America/Cancun"
                  | "America/Caracas"
                  | "America/Cayenne"
                  | "America/Cayman"
                  | "America/Chicago"
                  | "America/Chihuahua"
                  | "America/Ciudad_Juarez"
                  | "America/Costa_Rica"
                  | "America/Coyhaique"
                  | "America/Creston"
                  | "America/Cuiaba"
                  | "America/Curacao"
                  | "America/Danmarkshavn"
                  | "America/Dawson"
                  | "America/Dawson_Creek"
                  | "America/Denver"
                  | "America/Detroit"
                  | "America/Dominica"
                  | "America/Edmonton"
                  | "America/Eirunepe"
                  | "America/El_Salvador"
                  | "America/Fort_Nelson"
                  | "America/Fortaleza"
                  | "America/Glace_Bay"
                  | "America/Goose_Bay"
                  | "America/Grand_Turk"
                  | "America/Grenada"
                  | "America/Guadeloupe"
                  | "America/Guatemala"
                  | "America/Guayaquil"
                  | "America/Guyana"
                  | "America/Halifax"
                  | "America/Havana"
                  | "America/Hermosillo"
                  | "America/Indiana/Indianapolis"
                  | "America/Indiana/Knox"
                  | "America/Indiana/Marengo"
                  | "America/Indiana/Petersburg"
                  | "America/Indiana/Tell_City"
                  | "America/Indiana/Vevay"
                  | "America/Indiana/Vincennes"
                  | "America/Indiana/Winamac"
                  | "America/Inuvik"
                  | "America/Iqaluit"
                  | "America/Jamaica"
                  | "America/Juneau"
                  | "America/Kentucky/Louisville"
                  | "America/Kentucky/Monticello"
                  | "America/Kralendijk"
                  | "America/La_Paz"
                  | "America/Lima"
                  | "America/Los_Angeles"
                  | "America/Lower_Princes"
                  | "America/Maceio"
                  | "America/Managua"
                  | "America/Manaus"
                  | "America/Marigot"
                  | "America/Martinique"
                  | "America/Matamoros"
                  | "America/Mazatlan"
                  | "America/Menominee"
                  | "America/Merida"
                  | "America/Metlakatla"
                  | "America/Mexico_City"
                  | "America/Miquelon"
                  | "America/Moncton"
                  | "America/Monterrey"
                  | "America/Montevideo"
                  | "America/Montserrat"
                  | "America/Nassau"
                  | "America/New_York"
                  | "America/Nome"
                  | "America/Noronha"
                  | "America/North_Dakota/Beulah"
                  | "America/North_Dakota/Center"
                  | "America/North_Dakota/New_Salem"
                  | "America/Nuuk"
                  | "America/Ojinaga"
                  | "America/Panama"
                  | "America/Paramaribo"
                  | "America/Phoenix"
                  | "America/Port-au-Prince"
                  | "America/Port_of_Spain"
                  | "America/Porto_Velho"
                  | "America/Puerto_Rico"
                  | "America/Punta_Arenas"
                  | "America/Rankin_Inlet"
                  | "America/Recife"
                  | "America/Regina"
                  | "America/Resolute"
                  | "America/Rio_Branco"
                  | "America/Santarem"
                  | "America/Santiago"
                  | "America/Santo_Domingo"
                  | "America/Sao_Paulo"
                  | "America/Scoresbysund"
                  | "America/Sitka"
                  | "America/St_Barthelemy"
                  | "America/St_Johns"
                  | "America/St_Kitts"
                  | "America/St_Lucia"
                  | "America/St_Thomas"
                  | "America/St_Vincent"
                  | "America/Swift_Current"
                  | "America/Tegucigalpa"
                  | "America/Thule"
                  | "America/Tijuana"
                  | "America/Toronto"
                  | "America/Tortola"
                  | "America/Vancouver"
                  | "America/Whitehorse"
                  | "America/Winnipeg"
                  | "America/Yakutat"
                  | "Antarctica/Casey"
                  | "Antarctica/Davis"
                  | "Antarctica/DumontDUrville"
                  | "Antarctica/Macquarie"
                  | "Antarctica/Mawson"
                  | "Antarctica/McMurdo"
                  | "Antarctica/Palmer"
                  | "Antarctica/Rothera"
                  | "Antarctica/Syowa"
                  | "Antarctica/Troll"
                  | "Antarctica/Vostok"
                  | "Arctic/Longyearbyen"
                  | "Asia/Aden"
                  | "Asia/Almaty"
                  | "Asia/Amman"
                  | "Asia/Anadyr"
                  | "Asia/Aqtau"
                  | "Asia/Aqtobe"
                  | "Asia/Ashgabat"
                  | "Asia/Atyrau"
                  | "Asia/Baghdad"
                  | "Asia/Bahrain"
                  | "Asia/Baku"
                  | "Asia/Bangkok"
                  | "Asia/Barnaul"
                  | "Asia/Beirut"
                  | "Asia/Bishkek"
                  | "Asia/Brunei"
                  | "Asia/Chita"
                  | "Asia/Colombo"
                  | "Asia/Damascus"
                  | "Asia/Dhaka"
                  | "Asia/Dili"
                  | "Asia/Dubai"
                  | "Asia/Dushanbe"
                  | "Asia/Famagusta"
                  | "Asia/Gaza"
                  | "Asia/Hebron"
                  | "Asia/Ho_Chi_Minh"
                  | "Asia/Hong_Kong"
                  | "Asia/Hovd"
                  | "Asia/Irkutsk"
                  | "Asia/Jakarta"
                  | "Asia/Jayapura"
                  | "Asia/Jerusalem"
                  | "Asia/Kabul"
                  | "Asia/Kamchatka"
                  | "Asia/Karachi"
                  | "Asia/Kathmandu"
                  | "Asia/Khandyga"
                  | "Asia/Kolkata"
                  | "Asia/Krasnoyarsk"
                  | "Asia/Kuala_Lumpur"
                  | "Asia/Kuching"
                  | "Asia/Kuwait"
                  | "Asia/Macau"
                  | "Asia/Magadan"
                  | "Asia/Makassar"
                  | "Asia/Manila"
                  | "Asia/Muscat"
                  | "Asia/Nicosia"
                  | "Asia/Novokuznetsk"
                  | "Asia/Novosibirsk"
                  | "Asia/Omsk"
                  | "Asia/Oral"
                  | "Asia/Phnom_Penh"
                  | "Asia/Pontianak"
                  | "Asia/Pyongyang"
                  | "Asia/Qatar"
                  | "Asia/Qostanay"
                  | "Asia/Qyzylorda"
                  | "Asia/Riyadh"
                  | "Asia/Sakhalin"
                  | "Asia/Samarkand"
                  | "Asia/Seoul"
                  | "Asia/Shanghai"
                  | "Asia/Singapore"
                  | "Asia/Srednekolymsk"
                  | "Asia/Taipei"
                  | "Asia/Tashkent"
                  | "Asia/Tbilisi"
                  | "Asia/Tehran"
                  | "Asia/Thimphu"
                  | "Asia/Tokyo"
                  | "Asia/Tomsk"
                  | "Asia/Ulaanbaatar"
                  | "Asia/Urumqi"
                  | "Asia/Ust-Nera"
                  | "Asia/Vientiane"
                  | "Asia/Vladivostok"
                  | "Asia/Yakutsk"
                  | "Asia/Yangon"
                  | "Asia/Yekaterinburg"
                  | "Asia/Yerevan"
                  | "Atlantic/Azores"
                  | "Atlantic/Bermuda"
                  | "Atlantic/Canary"
                  | "Atlantic/Cape_Verde"
                  | "Atlantic/Faroe"
                  | "Atlantic/Madeira"
                  | "Atlantic/Reykjavik"
                  | "Atlantic/South_Georgia"
                  | "Atlantic/St_Helena"
                  | "Atlantic/Stanley"
                  | "Australia/Adelaide"
                  | "Australia/Brisbane"
                  | "Australia/Broken_Hill"
                  | "Australia/Darwin"
                  | "Australia/Eucla"
                  | "Australia/Hobart"
                  | "Australia/Lindeman"
                  | "Australia/Lord_Howe"
                  | "Australia/Melbourne"
                  | "Australia/Perth"
                  | "Australia/Sydney"
                  | "Canada/Atlantic"
                  | "Canada/Central"
                  | "Canada/Eastern"
                  | "Canada/Mountain"
                  | "Canada/Newfoundland"
                  | "Canada/Pacific"
                  | "Europe/Amsterdam"
                  | "Europe/Andorra"
                  | "Europe/Astrakhan"
                  | "Europe/Athens"
                  | "Europe/Belgrade"
                  | "Europe/Berlin"
                  | "Europe/Bratislava"
                  | "Europe/Brussels"
                  | "Europe/Bucharest"
                  | "Europe/Budapest"
                  | "Europe/Busingen"
                  | "Europe/Chisinau"
                  | "Europe/Copenhagen"
                  | "Europe/Dublin"
                  | "Europe/Gibraltar"
                  | "Europe/Guernsey"
                  | "Europe/Helsinki"
                  | "Europe/Isle_of_Man"
                  | "Europe/Istanbul"
                  | "Europe/Jersey"
                  | "Europe/Kaliningrad"
                  | "Europe/Kirov"
                  | "Europe/Kyiv"
                  | "Europe/Lisbon"
                  | "Europe/Ljubljana"
                  | "Europe/London"
                  | "Europe/Luxembourg"
                  | "Europe/Madrid"
                  | "Europe/Malta"
                  | "Europe/Mariehamn"
                  | "Europe/Minsk"
                  | "Europe/Monaco"
                  | "Europe/Moscow"
                  | "Europe/Oslo"
                  | "Europe/Paris"
                  | "Europe/Podgorica"
                  | "Europe/Prague"
                  | "Europe/Riga"
                  | "Europe/Rome"
                  | "Europe/Samara"
                  | "Europe/San_Marino"
                  | "Europe/Sarajevo"
                  | "Europe/Saratov"
                  | "Europe/Simferopol"
                  | "Europe/Skopje"
                  | "Europe/Sofia"
                  | "Europe/Stockholm"
                  | "Europe/Tallinn"
                  | "Europe/Tirane"
                  | "Europe/Ulyanovsk"
                  | "Europe/Vaduz"
                  | "Europe/Vatican"
                  | "Europe/Vienna"
                  | "Europe/Vilnius"
                  | "Europe/Volgograd"
                  | "Europe/Warsaw"
                  | "Europe/Zagreb"
                  | "Europe/Zurich"
                  | "GMT"
                  | "Indian/Antananarivo"
                  | "Indian/Chagos"
                  | "Indian/Christmas"
                  | "Indian/Cocos"
                  | "Indian/Comoro"
                  | "Indian/Kerguelen"
                  | "Indian/Mahe"
                  | "Indian/Maldives"
                  | "Indian/Mauritius"
                  | "Indian/Mayotte"
                  | "Indian/Reunion"
                  | "Pacific/Apia"
                  | "Pacific/Auckland"
                  | "Pacific/Bougainville"
                  | "Pacific/Chatham"
                  | "Pacific/Chuuk"
                  | "Pacific/Easter"
                  | "Pacific/Efate"
                  | "Pacific/Fakaofo"
                  | "Pacific/Fiji"
                  | "Pacific/Funafuti"
                  | "Pacific/Galapagos"
                  | "Pacific/Gambier"
                  | "Pacific/Guadalcanal"
                  | "Pacific/Guam"
                  | "Pacific/Honolulu"
                  | "Pacific/Kanton"
                  | "Pacific/Kiritimati"
                  | "Pacific/Kosrae"
                  | "Pacific/Kwajalein"
                  | "Pacific/Majuro"
                  | "Pacific/Marquesas"
                  | "Pacific/Midway"
                  | "Pacific/Nauru"
                  | "Pacific/Niue"
                  | "Pacific/Norfolk"
                  | "Pacific/Noumea"
                  | "Pacific/Pago_Pago"
                  | "Pacific/Palau"
                  | "Pacific/Pitcairn"
                  | "Pacific/Pohnpei"
                  | "Pacific/Port_Moresby"
                  | "Pacific/Rarotonga"
                  | "Pacific/Saipan"
                  | "Pacific/Tahiti"
                  | "Pacific/Tarawa"
                  | "Pacific/Tongatapu"
                  | "Pacific/Wake"
                  | "Pacific/Wallis"
                  | "US/Alaska"
                  | "US/Arizona"
                  | "US/Central"
                  | "US/Eastern"
                  | "US/Hawaii"
                  | "US/Mountain"
                  | "US/Pacific"
                  | "UTC";
              userAgent: string
              | null;
              waitingConditions: {
                  isActive: boolean;
                  type: string;
                  timeout?: number | null;
                  expected?: string | null;
              }[];
              browserMediaDevicesPermissions: | "disabled"
              | "always_accept"
              | "always_decline";
          },
      >

      The ProjectSettings object for the project.

    • Export the entire project as a ZIP archive (tests, suites, components, profiles, settings).

      Parameters

      Returns Promise<Uint8Array<ArrayBufferLike>>

      Raw ZIP bytes ready to be written to disk or uploaded elsewhere.

      import { writeFile } from 'node:fs/promises';
      const zipBytes = await sdk.project.export();
      await writeFile('project.zip', zipBytes);

    • Import a project from a ZIP archive.

      Performs the two-step server flow:

      1. Validate the upload — surfaces server-side errors (malformed ZIP, naming conflicts, …) as ValidationError.
      2. Run the import asynchronously using the validated upload id.

      Parameters

      • zipBytes: Uint8Array

        Raw ZIP archive bytes.

      • options: RequestOptions = {}

      Returns Promise<unknown>

      The response from the import run endpoint (typically a 202 with empty body — kept as unknown until the API stabilizes the shape).

      When validation succeeds but the server omits the uploadId needed to trigger the run step.

      When the ZIP is rejected by validate.

      import { readFile } from 'node:fs/promises';
      const bytes = await readFile('project.zip');
      await sdk.project.import(bytes);

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods