bits-to-dead-trees 0.0.9 → 1.0.0

package/.eslintrc.json

@@ -3,16 +3,10 @@
     "es2021": true,
     "node": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier"
-  ],
-  "parser": "@typescript-eslint/parser",
+  "extends": ["eslint:recommended", "prettier"],
   "parserOptions": {
     "ecmaVersion": "latest",
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint"],
   "rules": {}
 }

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/build-docker-image-of-release.yml

@@ -12,7 +12,8 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
-        ref: ${{ github.ref_name }}
+        with:
+          ref: ${{ github.ref_name }}
 
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v1

package/.github/workflows/ci.yml

@@ -19,8 +19,14 @@ jobs:
           node-version: lts/*
           cache: npm
 
+      - name: Install npm dependencies
+        run: npm ci
+
       - name: Run eslint
         run: npm run lint
 
       - name: Run prettier
         run: npm run check-format
+
+      - name: Run typecheck
+        run: npm run ts-check

package/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: lts/*
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: npm run release
+          title: Release new version 🚀
+        env:
+          GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # bits-to-dead-trees
 
+## 1.0.0
+
+### Major Changes
+
+- eccf614: Remove TypeScript, use vanilla JS with JSDoc types.
+
+  This actually improves DX by not having that extra build step, while still having
+  good support in your IDE, since we still have the types as JSDoc.
+
+  This is the v1.0. This has been very stable and it's unlikely that the API will change
+  a lot. Nothing should break for users with this release.
+
+### Patch Changes
+
+- 7ef95e5: Update playwright to 1.21.1
+- d651f7a: Update playwright to 1.21.0
+
+## 0.0.11
+
+### Patch Changes
+
+- a3c12a4: Wait for network idle event before creating pdf
+
+## 0.0.10
+
+### Patch Changes
+
+- df332b7: Go back to automatic release, but use PAT
+
 ## 0.0.9
 
 ### Patch Changes

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/playwright:v1.20.2-focal
+FROM mcr.microsoft.com/playwright:v1.21.1-focal
 
 ENV NODE_ENV=production
 ENV SERVER_PORT=8000
@@ -11,15 +11,11 @@ RUN apt-get update -yqq && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/*
 
-COPY ["package.json", "package-lock.json*", "tsconfig.json", "./"]
+COPY ["package.json", "package-lock.json*", "./"]
 
-RUN npm install --production=false --ignore-scripts
+RUN npm install --production --ignore-scripts
 
-COPY src src
-
-RUN npm run build && \
-  rm -Rf src && \
-  npm install --production --ignore-scripts
+COPY ["index.js", "schemas", "./"]
 
 ENTRYPOINT ["tini", "-v", "--"]
-CMD ["node", "dist/index.js"]
+CMD ["node", "index.js"]

package/README.md

@@ -5,6 +5,8 @@
 Exposes a web server with a single endpoint to take in a URL and create a PDF out
 of that. It's using [Playwright](https://playwright.dev) in the background for this.
 
+[![Depfu](https://badges.depfu.com/badges/74bd86ac2a33c6c6f6817cafc6419e84/overview.svg)](https://depfu.com/github/rmehner/bits-to-dead-trees?project_id=35056)
+
 ## Setup
 
 ### Requirements
@@ -17,8 +19,7 @@ of that. It's using [Playwright](https://playwright.dev) in the background for t
 1. `git checkout https://github.com/rmehner/bits-to-dead-trees`
 2. `cd bits-to-dead-trees`
 3. `npm install`
-4. `npm run build` to build the app
-5. `npm start` to start the server. It'll listen to port 8000 on localhost by default.
+4. `npm start` to start the server. It'll listen to port 8000 on localhost by default.
 
 ### Development
 

package/{src/index.ts → index.js}

@@ -1,7 +1,18 @@
-import fastify from "fastify";
-import playwright from "playwright-core";
-import PdfRequestBodySchema from "./schemas/pdf_request_body.json";
-import { PdfOptions, PdfRequestBody } from "./types/schemas";
+// @ts-check
+
+/**
+ * @typedef {Parameters<import("playwright-core").Page["pdf"]>[0]} PdfOptions
+ */
+
+/**
+ * @typedef {Object} PdfRequestBody
+ * @property {string} url
+ * @property {PdfOptions} options
+ */
+
+const { fastify } = require("fastify");
+const playwright = require("playwright-core");
+const PdfRequestBodySchema = require("./schemas/pdf_request_body.json");
 
 const SERVER_PORT = process.env["SERVER_PORT"] ?? 8000;
 const SERVER_ADDRESS = process.env["SERVER_ADDRESS"] ?? "localhost";
@@ -18,11 +29,18 @@ const server = fastify({
   },
 });
 
-const createPDF = async (url: string, options?: PdfOptions) => {
+/**
+ *
+ * @param {string} url
+ * @param {PdfOptions} options
+ * @returns Buffer
+ */
+const createPDF = async (url, options = {}) => {
   const browser = await playwright.chromium.launch();
   const context = await browser.newContext({ ignoreHTTPSErrors: true });
   const page = await context.newPage();
-  await page.goto(url);
+  await page.goto(url, { timeout: 60000 });
+  await page.waitForLoadState("networkidle");
 
   const pdf = await page.pdf(options);
   await browser.close();
@@ -30,9 +48,14 @@ const createPDF = async (url: string, options?: PdfOptions) => {
   return pdf;
 };
 
-server.post<{ Body: PdfRequestBody }>(
+server.post(
   "/pdf",
   { schema: { body: PdfRequestBodySchema }, attachValidation: true },
+  /**
+   *
+   * @param {import('fastify').FastifyRequest<{Body: PdfRequestBody}>} request
+   * @param {import('fastify').FastifyReply} response
+   */
   async (request, response) => {
     if (request.validationError) {
       response.code(400);

package/nodemon.json

@@ -1,5 +1,4 @@
 {
-  "delay": 2000,
-  "watch": ["src/", "package-lock.json", "package.json"],
-  "ext": "ts,json"
+  "watch": ["index.js", "schemas/pdf_request_body.json", "package-lock.json"],
+  "ext": "js,json"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bits-to-dead-trees",
   "author": "Robin Mehner <robin@coding-robin.de>",
-  "version": "0.0.9",
+  "version": "1.0.0",
   "description": "Turn HTML into PDF files",
   "repository": "github:rmehner/bits-to-dead-trees",
   "license": "Apache-2.0",
@@ -13,39 +13,31 @@
   "engines": {
     "node": ">= 16"
   },
-  "main": "dist/index.js",
+  "main": "index.js",
   "scripts": {
-    "check-format": "prettier --check 'src/**/*.ts'",
-    "clean": "rimraf dist",
-    "lint": "eslint src/*.ts",
-    "format": "prettier --write src/**/*.{ts,json}",
-    "build": "npm run clean && tsc",
-    "start": "node dist/index.js",
-    "start:dev": "concurrently --kill-others \"npm run build -- --watch\" \"nodemon --inspect dist/index.js\" ",
-    "dump-schemas": "typescript-json-schema src/types/schemas.ts PdfRequestBody --out src/schemas/pdf_request_body.json",
+    "check-format": "prettier --check **/*.{js,ts,json,md}",
+    "lint": "eslint *.js",
+    "format": "prettier --write **/*.{js,ts,json,md}",
+    "start": "node index.js",
+    "start:dev": "nodemon --inspect index.js",
+    "dump-schemas": "typescript-json-schema types/schemas.ts PdfRequestBody --out schemas/pdf_request_body.json",
     "update-schemas": "npm run dump-schemas && npm run format",
     "postinstall": "npx playwright install chromium",
     "add-changeset": "changeset",
     "release": "changeset publish",
-    "version": "changeset version"
+    "ts-check": "npx tsc --noEmit"
   },
   "dependencies": {
     "fastify": "^3.28.0",
-    "playwright-core": "^1.20.2"
+    "playwright-core": "^1.21.1"
   },
   "devDependencies": {
     "@changesets/cli": "^2.22.0",
-    "@types/node": "^16",
-    "@typescript-eslint/eslint-plugin": "^5.18.0",
-    "@typescript-eslint/parser": "^5.18.0",
-    "concurrently": "^7.1.0",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
     "nodemon": "^2.0.15",
     "pino-pretty": "^7.6.1",
     "prettier": "^2.6.2",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.6.3",
     "typescript-json-schema": "^0.53.0"
   }
 }

package/tsconfig.json

@@ -1,16 +1,13 @@
 {
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-    "target": "ES2021",
-    "lib": ["ES2021", "DOM"],
-    "module": "CommonJS",
-    "rootDir": "./src",
+    "lib": ["es2021"],
+
+    "strict": true,
     "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
+    "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
-    "strict": true
-  },
-  "files": ["./src/index.ts"]
+    "resolveJsonModule": true,
+
+    "checkJs": true
+  }
 }

package/.vscode/settings.json

@@ -1,30 +0,0 @@
-{
-  "[javascriptreact]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  },
-  "[html]": {
-    "editor.formatOnType": true,
-    "editor.formatOnSave": true
-  },
-  "[javascript]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  },
-  "[json]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  },
-  "[typescript]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  },
-  "[css]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  },
-  "[scss]": {
-    "editor.formatOnSave": true,
-    "editor.formatOnPaste": true
-  }
-}

package/dist/index.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fastify_1 = __importDefault(require("fastify"));
-const playwright_core_1 = __importDefault(require("playwright-core"));
-const pdf_request_body_json_1 = __importDefault(require("./schemas/pdf_request_body.json"));
-const SERVER_PORT = process.env["SERVER_PORT"] ?? 8000;
-const server = (0, fastify_1.default)({
-    logger: {
-        prettyPrint: process.env["NODE_ENV"] !== "production"
-            ? {
-                translateTime: "HH:MM:ss Z",
-                ignore: "pid,hostname",
-            }
-            : false,
-    },
-});
-const createPDF = async (url, options) => {
-    const browser = await playwright_core_1.default.chromium.launch();
-    const context = await browser.newContext({ ignoreHTTPSErrors: true });
-    const page = await context.newPage();
-    await page.goto(url);
-    const pdf = await page.pdf(options);
-    await browser.close();
-    return pdf;
-};
-server.post("/pdf", { schema: { body: pdf_request_body_json_1.default }, attachValidation: true }, async (request, response) => {
-    if (request.validationError) {
-        response.code(400);
-        return {
-            error: true,
-            message: request.validationError.message,
-        };
-    }
-    try {
-        return createPDF(request.body.url, request.body.options);
-    }
-    catch (error) {
-        response.code(500);
-        return {
-            error,
-        };
-    }
-});
-server.get("/health", async (_, response) => response.code(200).send());
-const startServer = async () => {
-    try {
-        await server.listen(+SERVER_PORT, "0.0.0.0");
-    }
-    catch (error) {
-        console.error(error);
-        process.exit(1);
-    }
-};
-startServer();

package/dist/schemas/pdf_request_body.json

@@ -1,84 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "properties": {
-        "options": {
-            "properties": {
-                "displayHeaderFooter": {
-                    "description": "Display header and footer. Defaults to `false`.",
-                    "type": "boolean"
-                },
-                "footerTemplate": {
-                    "description": "HTML template for the print footer. Should use the same format as the `headerTemplate`.",
-                    "type": "string"
-                },
-                "format": {
-                    "description": "Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.",
-                    "type": "string"
-                },
-                "headerTemplate": {
-                    "description": "HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values\ninto them:\n- `'date'` formatted print date\n- `'title'` document title\n- `'url'` document location\n- `'pageNumber'` current page number\n- `'totalPages'` total pages in the document",
-                    "type": "string"
-                },
-                "height": {
-                    "description": "Paper height, accepts values labeled with units.",
-                    "type": ["string", "number"]
-                },
-                "landscape": {
-                    "description": "Paper orientation. Defaults to `false`.",
-                    "type": "boolean"
-                },
-                "margin": {
-                    "description": "Paper margins, defaults to none.",
-                    "properties": {
-                        "bottom": {
-                            "description": "Bottom margin, accepts values labeled with units. Defaults to `0`.",
-                            "type": ["string", "number"]
-                        },
-                        "left": {
-                            "description": "Left margin, accepts values labeled with units. Defaults to `0`.",
-                            "type": ["string", "number"]
-                        },
-                        "right": {
-                            "description": "Right margin, accepts values labeled with units. Defaults to `0`.",
-                            "type": ["string", "number"]
-                        },
-                        "top": {
-                            "description": "Top margin, accepts values labeled with units. Defaults to `0`.",
-                            "type": ["string", "number"]
-                        }
-                    },
-                    "type": "object"
-                },
-                "pageRanges": {
-                    "description": "Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.",
-                    "type": "string"
-                },
-                "path": {
-                    "description": "The file path to save the PDF to. If `path` is a relative path, then it is resolved relative to the current working\ndirectory. If no path is provided, the PDF won't be saved to the disk.",
-                    "type": "string"
-                },
-                "preferCSSPageSize": {
-                    "description": "Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format`\noptions. Defaults to `false`, which will scale the content to fit the paper size.",
-                    "type": "boolean"
-                },
-                "printBackground": {
-                    "description": "Print background graphics. Defaults to `false`.",
-                    "type": "boolean"
-                },
-                "scale": {
-                    "description": "Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.",
-                    "type": "number"
-                },
-                "width": {
-                    "description": "Paper width, accepts values labeled with units.",
-                    "type": ["string", "number"]
-                }
-            },
-            "type": "object"
-        },
-        "url": {
-            "type": "string"
-        }
-    },
-    "type": "object"
-}

package/dist/types/schemas.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });