Merge pull request #26 from browserstack/replace-with-proto

Proto Files

Author: yashdsaraf

.gitignore

@@ -1,2 +1,3 @@
-node_modules/
-build/
+node_modules
+dist
+generated

.nvmrc

@@ -0,0 +1 @@
+v20.11.0

CODEOWNERS

@@ -1 +1 @@
-* @browserstack/default_owner
+* @browserstack/sdk-dev

README.md

@@ -1,188 +1 @@
-# Deprecation Note
-
-> The changes done as a part of this fork have now been merged into [@wdio/browserstack-service](https://www.npmjs.com/package/@wdio/browserstack-service), so we will be deprecating this package. Please install the service using:
-
-```sh
-npm install @wdio/browserstack-service --save-dev
-```
-
----
-
-<s># WebdriverIO Browserstack Service
-
-> The official BrowserStack WebdriverIO service that integrates your WebdriverIO test suite with BrowserStack.
-
-## Installation
-
-You can simply do it by:
-
-```sh
-npm install @browserstack/wdio-browserstack-service --save-dev
-```
-
-Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted)
-
-## Configuration
-
-WebdriverIO has Browserstack support out of the box. You should simply set `user` and `key` in your `wdio.conf.js` file. This service plugin provides supports for [Browserstack Tunnel](https://www.browserstack.com/automate/node#setting-local-tunnel). Set `browserstackLocal: true` also to activate this feature.
-Reporting of session status on BrowserStack will respect `strict` setting of Cucumber options.
-
-```js
-// wdio.conf.js
-export.config = {
-    // ...
-    user: process.env.BROWSERSTACK_USERNAME,
-    key: process.env.BROWSERSTACK_ACCESS_KEY,
-    services: [
-        ['@browserstack/wdio-browserstack-service', {
-            browserstackLocal: true
-        }]
-    ],
-    // ...
-};
-```
-
-## Options
-
-In order to authorize to the BrowserStack service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
-
-### browserstackLocal
-
-Set this to true to enable routing connections from Browserstack cloud through your computer.
-
-Type: `Boolean`<br />
-Default: `false`
-
-### preferScenarioName
-
-Cucumber only. Set this to true to enable updating the session name to the Scenario name if only a single Scenario was ran. Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
-
-Type: `Boolean`<br />
-Default: `false`
-
-### opts
-
-Specified optional will be passed down to BrowserstackLocal.
-
-Type: `Object`<br />
-Default: `{}`
-
-List of available local testing modifiers to be passed as opts:
-
-#### Local Identifier
-
-If doing simultaneous multiple local testing connections, set this uniquely for different processes -
-
-```js
-opts = { localIdentifier: 'randomstring' };
-```
-
-#### Verbose Logging
-
-To enable verbose logging -
-
-```js
-opts = { verbose: 'true' };
-```
-
-Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
-
-#### Force Local
-
-To route all traffic via local(your) machine -
-
-```js
-opts = { forceLocal: 'true' };
-```
-
-#### Folder Testing
-
-To test local folder rather internal server, provide path to folder as value of this option -
-
-```js
-opts = { f: '/my/awesome/folder' };
-```
-
-#### Force Start
-
-To kill other running Browserstack Local instances -
-
-```js
-opts = { force: 'true' };
-```
-
-#### Only Automate
-
-To disable local testing for Live and Screenshots, and enable only Automate -
-
-```js
-opts = { onlyAutomate: 'true' };
-```
-
-#### Proxy
-
-To use a proxy for local testing -
-
-- proxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
-- proxyPort: Port for the proxy, defaults to 3128 when -proxyHost is used
-- proxyUser: Username for connecting to proxy (Basic Auth Only)
-- proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
-
-```js
-opts = {
-  proxyHost: '127.0.0.1',
-  proxyPort: '8000',
-  proxyUser: 'user',
-  proxyPass: 'password',
-};
-```
-
-#### Local Proxy
-
-To use local proxy in local testing -
-
-- localProxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
-- localProxyPort: Port for the proxy, defaults to 8081 when -localProxyHost is used
-- localProxyUser: Username for connecting to proxy (Basic Auth Only)
-- localProxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
-
-```js
-opts = {
-  localProxyHost: '127.0.0.1',
-  localProxyPort: '8000',
-  localProxyUser: 'user',
-  localProxyPass: 'password',
-};
-```
-
-#### PAC (Proxy Auto-Configuration)
-
-To use PAC (Proxy Auto-Configuration) in local testing -
-
-- pac-file: PAC (Proxy Auto-Configuration) file’s absolute path
-
-```js
-opts = { 'pac-file': '<pac_file_abs_path>' };
-```
-
-#### Binary Path
-
-By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
-Path to specify local Binary path -
-
-```js
-opts = { binarypath: '/path/to/binary' };
-```
-
-#### Logfile
-
-To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
-To specify the path to file where the logs will be saved -
-
-```js
-opts = { verbose: 'true', logFile: './local.log' };
-```
-
----
-
-For more information on WebdriverIO see the [homepage](https://webdriver.io). </s>
+Source code for the @browserstack/wdio-browserstack-service npm module

browserstack-service.d.ts

@@ -0,0 +1,10 @@
+version: v2
+plugins:
+  - local: protoc-gen-ts_proto
+    out: src/generated
+    opt:
+      - importSuffix=.js
+      - outputServices=grpc-js
+      - esModuleInterop=true
+      - outputPartialMethods=false
+      - useExactTypes=false

buf.gen.yaml

@@ -0,0 +1,9 @@
+version: v2
+modules:
+  - path: src/proto/browserstack/sdk/v1
+breaking:
+  use:
+    - FILE
+lint:
+  use:
+    - DEFAULT