bits-to-dead-trees 0.0.10 → 1.0.1

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

@@ -16,14 +16,14 @@ jobs:
           ref: ${{ github.ref_name }}
 
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build and push builder image
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v3
         with:
           file: Dockerfile
           push: true

package/.github/workflows/ci.yml

@@ -27,3 +27,6 @@ jobs:
 
       - name: Run prettier
         run: npm run check-format
+
+      - name: Run typecheck
+        run: npm run ts-check

package/.tool-versions

@@ -1 +1 @@
-nodejs 16.14.2
+nodejs 16.15.1

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # bits-to-dead-trees
 
+## 1.0.1
+
+### Patch Changes
+
+- cd71c2f: Update playwright to 1.23.2 (new browser versions)
+
+## 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

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/playwright:v1.20.2-focal
+FROM mcr.microsoft.com/playwright:v1.23.2-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
 
@@ -40,3 +41,17 @@ The server exposes the `/pdf` endpoint that listens to a POST request and expect
 `options` are the options Playwright knows about PDF: https://playwright.dev/docs/api/class-page#page-pdf. We pass them to Playwright directly, so please refer to their docs.
 
 The response is the PDF file.
+
+## Docker
+
+Versions are automatically build as Docker images and are available on [GitHub's package registry](https://github.com/rmehner/bits-to-dead-trees/pkgs/container/bits-to-dead-trees)
+
+If you want to use it internally with docker-compose, this should give you a good idea to start:
+
+```yml
+services:
+  pdf:
+    image: ghcr.io/rmehner/bits-to-dead-trees:v1.0.0
+    ports:
+      - 8000:8000
+```

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);
@@ -59,7 +82,7 @@ server.get("/health", async (_, response) => response.code(200).send());
 
 const startServer = async () => {
   try {
-    await server.listen(+SERVER_PORT, SERVER_ADDRESS);
+    await server.listen({ port: +SERVER_PORT, host: SERVER_ADDRESS });
   } catch (error) {
     console.error(error);
     process.exit(1);

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.10",
+  "version": "1.0.1",
   "description": "Turn HTML into PDF files",
   "repository": "github:rmehner/bits-to-dead-trees",
   "license": "Apache-2.0",
@@ -13,38 +13,32 @@
   "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"
+    "release": "changeset publish",
+    "ts-check": "npx tsc --noEmit"
   },
   "dependencies": {
-    "fastify": "^3.28.0",
-    "playwright-core": "^1.20.2"
+    "fastify": "^4.2.0",
+    "playwright-core": "^1.23.2"
   },
   "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",
+    "@changesets/cli": "^2.23.1",
+    "eslint": "^8.19.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"
+    "nodemon": "^2.0.19",
+    "pino-pretty": "^8.1.0",
+    "prettier": "^2.7.1",
+    "tslib": "^2.4.0",
+    "typescript-json-schema": "^0.54.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
+  }
 }