bits-to-dead-trees 2.4.2 → 2.5.1

package/.dockerignore

@@ -0,0 +1,9 @@
+node_modules/
+.github
+.changeset
+test
+.eslintrc.json
+.prettierrc.json
+.tool-versions
+nodemon.json
+tsconfig.json

package/.github/bin/check-for-schema-changes

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -o nounset
+
+PATH_TO_SCRIPT=$(dirname $(realpath $0))
+
+cd "${PATH_TO_SCRIPT}/../.." || exit 1
+
+if [[ $(git status --porcelain | grep pdf_request-body-json) ]]; then
+  echo "🚨 Detected schema changes that haven't been committed, please run 'npm run update-schemas' and commit the changes."
+  exit 2
+else
+  echo "All good, no schema changes detected. 🏝"
+fi

package/.github/workflows/check-json-schema.yml

@@ -0,0 +1,29 @@
+name: Check JSON schema
+
+on: push
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: .tool-versions
+          cache: npm
+
+      - name: Install npm dependencies
+        run: npm ci
+
+      - name: Update schemas
+        run: npm run update-schemas
+
+      - name: Run prettier
+        run: .github/bin/check-for-schema-changes

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # bits-to-dead-trees
 
+## 2.5.1
+
+### Patch Changes
+
+- [#205](https://github.com/rmehner/bits-to-dead-trees/pull/205) [`7798151`](https://github.com/rmehner/bits-to-dead-trees/commit/7798151d59091936735942509e7241fb04464ba0) Thanks [@depfu](https://github.com/apps/depfu)! - Update to Playwright 1.35.1
+
+## 2.5.0
+
+### Minor Changes
+
+- [`3c6ef83`](https://github.com/rmehner/bits-to-dead-trees/commit/3c6ef832b1227f6bca40a87102972a54ae913da5) Thanks [@rmehner](https://github.com/rmehner)! - Upgrade to Playwright 1.35.0
+
 ## 2.4.2
 
 ### Patch Changes

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/playwright:v1.34.3
+FROM mcr.microsoft.com/playwright:v1.35.1
 
 ENV NODE_ENV=production
 ENV SERVER_PORT=8000

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bits-to-dead-trees",
   "author": "Robin Mehner <robin@coding-robin.de>",
-  "version": "2.4.2",
+  "version": "2.5.1",
   "description": "Turn HTML into PDF files",
   "repository": "github:rmehner/bits-to-dead-trees",
   "license": "Apache-2.0",
@@ -23,27 +23,26 @@
     "start:dev": "nodemon --inspect server.js",
     "dump-schemas": "typescript-json-schema --noExtraProps --required --strictNullChecks types/schemas.ts PdfRequestBody --out pdf_request_body.json",
     "update-schemas": "npm run dump-schemas && npm run format",
-    "postinstall": "npx playwright install chromium",
+    "postinstall": "npx playwright-core install chromium",
     "add-changeset": "changeset",
     "release": "changeset publish",
     "test": "vitest --reporter verbose",
     "ts-check": "npx tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^4.17.0",
-    "playwright-core": "^1.34.3"
+    "fastify": "^4.18.0",
+    "playwright-core": "^1.35.1"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.1",
     "@types/lodash": "^4.14.195",
-    "eslint": "^8.41.0",
+    "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",
     "nodemon": "^2.0.22",
     "pino-pretty": "^10.0.0",
     "prettier": "^2.8.8",
-    "tslib": "^2.5.2",
-    "typescript-json-schema": "^0.56.0",
-    "vitest": "^0.31.1"
+    "typescript-json-schema": "^0.57.0",
+    "vitest": "^0.32.0"
   }
 }

package/pdf_request_body.json

@@ -10,11 +10,11 @@
           "type": "boolean"
         },
         "baseURL": {
-          "description": "When using [page.goto(url[, options])](https://playwright.dev/docs/api/class-page#page-goto),\n[page.route(url, handler[, options])](https://playwright.dev/docs/api/class-page#page-route),\n[page.waitForURL(url[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-url),\n[page.waitForRequest(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-request),\nor\n[page.waitForResponse(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-response)\nit takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nExamples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n  `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n  `http://localhost:3000/bar.html`",
+          "description": "When using [page.goto(url[, options])](https://playwright.dev/docs/api/class-page#page-goto),\n[page.route(url, handler[, options])](https://playwright.dev/docs/api/class-page#page-route),\n[page.waitForURL(url[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-url),\n[page.waitForRequest(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-request),\nor\n[page.waitForResponse(urlOrPredicate[, options])](https://playwright.dev/docs/api/class-page#page-wait-for-response)\nit takes the base URL in consideration by using the\n[`URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor for building the corresponding URL.\nUnset by default. Examples:\n- baseURL: `http://localhost:3000` and navigating to `/bar.html` results in `http://localhost:3000/bar.html`\n- baseURL: `http://localhost:3000/foo/` and navigating to `./bar.html` results in\n  `http://localhost:3000/foo/bar.html`\n- baseURL: `http://localhost:3000/foo` (without trailing slash) and navigating to `./bar.html` results in\n  `http://localhost:3000/bar.html`",
           "type": "string"
         },
         "bypassCSP": {
-          "description": "Toggles bypassing page's Content-Security-Policy.",
+          "description": "Toggles bypassing page's Content-Security-Policy. Defaults to `false`.",
           "type": "boolean"
         },
         "colorScheme": {
@@ -37,7 +37,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "An object containing additional HTTP headers to be sent with every request.",
+          "description": "An object containing additional HTTP headers to be sent with every request. Defaults to none.",
           "type": "object"
         },
         "forcedColors": {
@@ -76,7 +76,7 @@
           "type": "boolean"
         },
         "locale": {
-          "description": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules. Learn more about emulation in\nour [emulation guide](https://playwright.dev/docs/emulation#locale--timezone).",
+          "description": "Specify user locale, for example `en-GB`, `de-DE`, etc. Locale will affect `navigator.language` value,\n`Accept-Language` request header value as well as number and date formatting rules. Defaults to the system default\nlocale. Learn more about emulation in our [emulation guide](https://playwright.dev/docs/emulation#locale--timezone).",
           "type": "string"
         },
         "logger": {
@@ -88,7 +88,7 @@
           "type": "boolean"
         },
         "permissions": {
-          "description": "A list of permissions to grant to all pages in this context. See\n[browserContext.grantPermissions(permissions[, options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions)\nfor more details.",
+          "description": "A list of permissions to grant to all pages in this context. See\n[browserContext.grantPermissions(permissions[, options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-grant-permissions)\nfor more details. Defaults to none.",
           "items": {
             "type": "string"
           },
@@ -96,7 +96,7 @@
         },
         "proxy": {
           "additionalProperties": false,
-          "description": "Network proxy settings to use with this context.\n\n**NOTE** For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If\nall contexts override the proxy, global proxy will be never used and can be any string, for example `launch({\nproxy: { server: 'http://per-context' } })`.",
+          "description": "Network proxy settings to use with this context. Defaults to none.\n\n**NOTE** For Chromium on Windows the browser needs to be launched with the global proxy for this option to work. If\nall contexts override the proxy, global proxy will be never used and can be any string, for example `launch({\nproxy: { server: 'http://per-context' } })`.",
           "properties": {
             "bypass": {
               "description": "Optional comma-separated domains to bypass proxy, for example `\".com, chromium.org, .domain.com\"`.",
@@ -149,7 +149,7 @@
                   "type": "string"
                 }
               ],
-              "description": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor."
+              "description": "A glob or regex pattern to filter requests that are stored in the HAR. When a `baseURL` via the context options was\nprovided and the passed URL is a path, it gets merged via the\n[`new URL()`](https://developer.mozilla.org/en-US/docs/Web/API/URL/URL) constructor. Defaults to none."
             }
           },
           "required": ["path"],
@@ -311,11 +311,11 @@
           "description": "Learn more about [storage state and auth](https://playwright.dev/docs/auth).\n\nPopulates context with given storage state. This option can be used to initialize context with logged-in\ninformation obtained via\n[browserContext.storageState([options])](https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state)."
         },
         "strictSelectors": {
-          "description": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). See [Locator] to learn more about the strict\nmode.",
+          "description": "If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on\nselectors that imply single target DOM element will throw when more than one element matches the selector. This\noption does not affect any Locator APIs (Locators are always strict). Defaults to `false`. See {@link Locator} to\nlearn more about the strict mode.",
           "type": "boolean"
         },
         "timezoneId": {
-          "description": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs.",
+          "description": "Changes the timezone of the context. See\n[ICU's metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1)\nfor a list of supported timezone IDs. Defaults to the system timezone.",
           "type": "string"
         },
         "userAgent": {