{"id":21944743,"url":"https://github.com/browserstack/wdio-browserstack-service","last_synced_at":"2025-09-06T01:33:13.543Z","repository":{"id":39750381,"uuid":"465729255","full_name":"browserstack/wdio-browserstack-service","owner":"browserstack","description":"Browserstack-Webdriverio service integration plugin - A WebdriverIO service that manages local tunnel and job metadata for Browserstack users.","archived":false,"fork":false,"pushed_at":"2025-08-22T06:45:11.000Z","size":1179,"stargazers_count":0,"open_issues_count":10,"forks_count":3,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-08-22T08:44:59.322Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-03T13:25:28.000Z","updated_at":"2025-08-20T06:44:45.000Z","dependencies_parsed_at":"2025-04-22T21:06:46.029Z","dependency_job_id":"906bf3b9-1bec-4931-b9df-692dc2b6f646","html_url":"https://github.com/browserstack/wdio-browserstack-service","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/browserstack/wdio-browserstack-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fwdio-browserstack-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fwdio-browserstack-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fwdio-browserstack-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fwdio-browserstack-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/wdio-browserstack-service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fwdio-browserstack-service/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273846966,"owners_count":25178628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T04:17:00.360Z","updated_at":"2025-09-06T01:33:13.533Z","avatar_url":"https://github.com/browserstack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @browserstack/wdio-browserstack-service\n\n![npm](https://img.shields.io/npm/v/@browserstack/wdio-browserstack-service)\n![License: MIT](https://img.shields.io/badge/license-MIT-blue)\n\nCore SDK for BrowserStack integration used by the WebdriverIO BrowserStack Service.\nFor user configuration and service options, see the official service README:\n[https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-browserstack-service/README.md](https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-browserstack-service/README.md)\n\n## Table of Contents\n1. [Overview](#overview)\n2. [Code Generation](#code-generation)\n3. [Development](#development)\n4. [Contributing](#contributing)\n5. [License](#license)\n\n## Overview\nThis package provides the TypeScript-based gRPC client and Protobuf definitions\nused internally by the `@wdio/browserstack-service` plugin for WebdriverIO.\nIt includes:\n- Generated TypeScript types and clients from Protobuf definitions.\n- Message factory constructors for backward compatibility.\n\n## Installation\nThis module is included as a dependency of the `@wdio/browserstack-service` package.\nUsers should install and configure the service as documented in the linked README above.\n\n## Setup \u0026 Configuration\nAdd the service to your WebdriverIO configuration (`wdio.conf.js`):\n\u003c!-- Usage is provided by @wdio/browserstack-service. --\u003e\n```\nexport BROWSERSTACK_USERNAME=your_username\nexport BROWSERSTACK_ACCESS_KEY=your_access_key\n```\n\n## Usage\nImport and use the gRPC client and message constructors:\n```ts\nimport { SDKClient, StartBinSessionRequestConstructor } from '@browserstack/wdio-browserstack-service';\nimport path from 'path';\nimport process from 'process';\nimport { CLIUtils } from '@browserstack/cli-utils'; // example import, adjust if needed\nimport { version as packageVersion } from './package.json'; // adjust to your setup\n\n// Initialize the client (uses default insecure credentials unless overridden)\nconst client = new SDKClient('grpc.browserstack.com:443');\n\n// Collect framework details\nconst automationFrameworkDetail = CLIUtils.getAutomationFrameworkDetail();\nconst testFrameworkDetail = CLIUtils.getTestFrameworkDetail();\n\nconst frameworkVersions = {\n  ...automationFrameworkDetail.version,\n  ...testFrameworkDetail.version\n};\n\n// Build StartBinSessionRequest\nconst startReq = StartBinSessionRequestConstructor.create({\n  binSessionId: 'your-session-id', // replace with actual session id\n  sdkLanguage: CLIUtils.getSdkLanguage(),\n  sdkVersion: packageVersion,\n  pathProject: process.cwd(),\n  pathConfig: path.resolve(process.cwd(), 'browserstack.yml'),\n  cliArgs: process.argv.slice(2),\n  frameworks: [automationFrameworkDetail.name, testFrameworkDetail.name],\n  frameworkVersions,\n  language: CLIUtils.getSdkLanguage(),\n  testFramework: testFrameworkDetail.name,\n  wdioConfig: {}, // provide your WDIO config if applicable\n});\n\n// Start a session\nclient.startBinSession(startReq).then(response =\u003e {\n  console.log('Started session:', response.binSessionId);\n}).catch(err =\u003e {\n  console.error('Failed to start session:', err);\n});\n```\n\n## Code Generation\nThis project uses [Buf](https://docs.buf.build/) and `ts-proto` to\ngenerate TypeScript code from Protobuf definitions.\n\n### Prerequisites\n- [Buf CLI](https://docs.buf.build/installation)\n- Node.js ≥16\n\n### Generate \u0026 Build\n```bash\n# Clean previously generated files\nnpm run clean\n\n# Generate from .proto files\nnpm run generate\n\n# Compile to JS and declaration files\nnpm run build\n```\n\nGenerated files appear under `dist/` and should be published to npm.\n\n## Development\nClone the repository and install dependencies:\n```bash\ngit clone https://github.com/browserstack/wdio-browserstack-service.git\ncd wdio-browserstack-service\nnpm install\n```\n\nRun generation and build:\n```bash\nnpm run build\n```\n\n## Contributing\nContributions are welcome! Please open issues or pull requests in the [GitHub repository](https://github.com/browserstack/wdio-browserstack-service).\n\n## License\nMIT © BrowserStack","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fwdio-browserstack-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fwdio-browserstack-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fwdio-browserstack-service/lists"}