webdriver-bidi-protocol 0.0.1 → 0.0.4

package/.github/dependabot.yml

@@ -0,0 +1,39 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly
+      day: 'sunday'
+      time: '02:00'
+      timezone: Europe/Berlin
+    groups:
+      dependencies:
+        dependency-type: production
+        patterns:
+          - '*'
+      dev-dependencies:
+        dependency-type: development
+        patterns:
+          - '*'
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+      day: 'sunday'
+      time: '04:00'
+      timezone: Europe/Berlin
+    groups:
+      all:
+        patterns:
+          - '*'
+  - package-ecosystem: gitsubmodule
+    directory: /
+    commit-message:
+      # Prefix with 'fix' to generate patch releases.
+      prefix: fix
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 1
+    labels:
+      - commit-updates

package/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+# Declare default permissions as read only.
+permissions: read-all
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
+
+concurrency:
+  group: ci-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    name: '[Required] Run tests'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          fetch-depth: 2
+      - name: Install cddlconv
+        run: cargo install cddlconv@0.1.5
+      - name: Install dependencies
+        run: npm ci
+      - name: Build and test
+        run: npm test
+      - id: check_changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+              echo "changes=true" >> "$GITHUB_OUTPUT"; 
+          fi
+      - name: Commit and push changes
+        if: contains(github.event.pull_request.labels.*.name, 'commit-updates') && steps.check_changes.outputs.changes == 'true'
+        run: |
+          git config --global user.name 'browser-automation-bot'
+          git config --global user.email '133232582+browser-automation-bot@users.noreply.github.com'
+          git add . --all
+          git commit -m 'chore: commit updated files' --no-verify
+          git push

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+permissions: read-all
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "*v*"
+
+jobs:
+  npm-publish:
+    name: Publish npm packages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          fetch-depth: 2
+      - name: Set npm registry
+        run: npm config set registry 'https://wombat-dressing-room.appspot.com/'
+      - name: Publish packages
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN_RELEASE}}
+        run: |
+          npm config set '//wombat-dressing-room.appspot.com/:_authToken' $NODE_AUTH_TOKEN
+          npm publish

package/.github/workflows/release-please.yml

@@ -0,0 +1,21 @@
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          token: ${{ secrets.BROWSER_AUTOMATION_BOT_TOKEN }}
+          target-branch: main
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json

package/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "specs/webdriver-bidi"]
+	path = specs/webdriver-bidi
+	url = https://github.com/w3c/webdriver-bidi.git
+[submodule "specs/permissions"]
+	path = specs/permissions
+	url = https://github.com/w3c/permissions.git

package/.prettierrc.cjs

@@ -0,0 +1,4 @@
+/**
+ * @type {import('prettier').Config}
+ */
+module.exports = require("gts/.prettierrc.json");

package/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.0.4"
+}

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## [0.0.4](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/compare/webdriver-bidi-protocol-v0.0.3...webdriver-bidi-protocol-v0.0.4) (2024-06-28)
+
+
+### Bug Fixes
+
+* update repository ([28cf911](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/commit/28cf911e59ad5b177df47d04fc012d8c9cfe7fde))
+
+## [0.0.3](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/compare/webdriver-bidi-protocol-v0.0.2...webdriver-bidi-protocol-v0.0.3) (2024-06-28)
+
+
+### Bug Fixes
+
+* add repository ([#19](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/issues/19)) ([91def9d](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/commit/91def9dd0baeab3476e7154676e40d5a709da2c3))
+
+## [0.0.2](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/compare/webdriver-bidi-protocol-v0.0.1...webdriver-bidi-protocol-v0.0.2) (2024-06-28)
+
+
+### Bug Fixes
+
+* bump specs/webdriver-bidi from `05a283e` to `62b8dfe` ([#16](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/issues/16)) ([51dac71](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/commit/51dac71ca4ea2e4e85eee7ba82a6a8ac7ff584a4))
+* document usage ([#7](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/issues/7)) ([d98a6ee](https://github.com/GoogleChromeLabs/webdriver-bidi-protocol/commit/d98a6ee23cbaa943440e2b40831a0c56aa0d6c18))

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Google Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,4 +1,34 @@
 # webdriver-bidi-protocol
 
-This repository contains TypeScript types conforming to the WebDriver Bidi
-Protocol specification.
+This repository contains TypeScript types conforming to the [WebDriver
+BiDi](https://w3c.github.io/webdriver-bidi/) specification.
+
+## Installation
+
+```
+npm install webdriver-bidi-protocol
+```
+
+## Usage
+
+In your TypeScript client implementation, you can now import WebDriver
+BiDi types:
+
+```ts
+import {Commands} from 'webdriver-bidi-protocol';
+
+async function sendCommand<T extends keyof Commands>(
+  method: T,
+  params: Commands[T]['params']
+): {result: Commands[T]['returnType']} {
+  // Implementation for sending the data using WebSockets.
+}
+
+// Now TypeScript validates that the params match the spec for 'browsingContext.print'.
+await sendCommand('browsingContext.print', {context: 'xxx'});
+```
+
+## Versioning
+
+This package patch version will be incremented whenever there are
+specification updates.