bits-to-dead-trees 0.0.8 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,11 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "github-actions"
4
+ directory: "/"
5
+ schedule:
6
+ interval: "weekly"
7
+
8
+ - package-ecosystem: "docker"
9
+ directory: "/"
10
+ schedule:
11
+ interval: "weekly"
@@ -1,9 +1,8 @@
1
1
  name: Build and Push Docker Image
2
2
 
3
3
  on:
4
- push:
5
- tags:
6
- - "v*"
4
+ release:
5
+ types: [published]
7
6
 
8
7
  concurrency: ${{ github.workflow }}-${{ github.ref }}
9
8
 
@@ -13,6 +12,8 @@ jobs:
13
12
  steps:
14
13
  - name: Checkout Repo
15
14
  uses: actions/checkout@v3
15
+ with:
16
+ ref: ${{ github.ref_name }}
16
17
 
17
18
  - name: Login to GitHub Container Registry
18
19
  uses: docker/login-action@v1
@@ -0,0 +1,29 @@
1
+ name: CI
2
+
3
+ on: push
4
+
5
+ concurrency:
6
+ group: ${{ github.ref }}
7
+ cancel-in-progress: true
8
+
9
+ jobs:
10
+ build:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - name: Checkout Repo
14
+ uses: actions/checkout@v3
15
+
16
+ - name: Set up Node
17
+ uses: actions/setup-node@v3
18
+ with:
19
+ node-version: lts/*
20
+ cache: npm
21
+
22
+ - name: Install npm dependencies
23
+ run: npm ci
24
+
25
+ - name: Run eslint
26
+ run: npm run lint
27
+
28
+ - name: Run prettier
29
+ run: npm run check-format
@@ -0,0 +1,38 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ concurrency: ${{ github.workflow }}-${{ github.ref }}
9
+
10
+ jobs:
11
+ release:
12
+ name: Release
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - name: Checkout Repo
16
+ uses: actions/checkout@v3
17
+ with:
18
+ # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
19
+ fetch-depth: 0
20
+
21
+ - name: Setup Node.js
22
+ uses: actions/setup-node@v3
23
+ with:
24
+ cache: npm
25
+ node-version: lts/*
26
+
27
+ - name: Install Dependencies
28
+ run: npm install
29
+
30
+ - name: Create Release Pull Request or Publish to npm
31
+ id: changesets
32
+ uses: changesets/action@v1
33
+ with:
34
+ publish: npm run release
35
+ title: Release new version 🚀
36
+ env:
37
+ GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
38
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # bits-to-dead-trees
2
2
 
3
+ ## 0.0.11
4
+
5
+ ### Patch Changes
6
+
7
+ - a3c12a4: Wait for network idle event before creating pdf
8
+
9
+ ## 0.0.10
10
+
11
+ ### Patch Changes
12
+
13
+ - df332b7: Go back to automatic release, but use PAT
14
+
15
+ ## 0.0.9
16
+
17
+ ### Patch Changes
18
+
19
+ - ddb70f5: Update eslint
20
+ - 5176013: Add CI setup
21
+
3
22
  ## 0.0.8
4
23
 
5
24
  ### Patch Changes
package/README.md CHANGED
@@ -5,6 +5,8 @@
5
5
  Exposes a web server with a single endpoint to take in a URL and create a PDF out
6
6
  of that. It's using [Playwright](https://playwright.dev) in the background for this.
7
7
 
8
+ [![Depfu](https://badges.depfu.com/badges/74bd86ac2a33c6c6f6817cafc6419e84/overview.svg)](https://depfu.com/github/rmehner/bits-to-dead-trees?project_id=35056)
9
+
8
10
  ## Setup
9
11
 
10
12
  ### Requirements
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bits-to-dead-trees",
3
3
  "author": "Robin Mehner <robin@coding-robin.de>",
4
- "version": "0.0.8",
4
+ "version": "0.0.11",
5
5
  "description": "Turn HTML into PDF files",
6
6
  "repository": "github:rmehner/bits-to-dead-trees",
7
7
  "license": "Apache-2.0",
@@ -15,6 +15,7 @@
15
15
  },
16
16
  "main": "dist/index.js",
17
17
  "scripts": {
18
+ "check-format": "prettier --check 'src/**/*.ts'",
18
19
  "clean": "rimraf dist",
19
20
  "lint": "eslint src/*.ts",
20
21
  "format": "prettier --write src/**/*.{ts,json}",
@@ -25,8 +26,7 @@
25
26
  "update-schemas": "npm run dump-schemas && npm run format",
26
27
  "postinstall": "npx playwright install chromium",
27
28
  "add-changeset": "changeset",
28
- "release": "changeset publish",
29
- "version": "changeset version"
29
+ "release": "changeset publish"
30
30
  },
31
31
  "dependencies": {
32
32
  "fastify": "^3.28.0",
@@ -38,7 +38,7 @@
38
38
  "@typescript-eslint/eslint-plugin": "^5.18.0",
39
39
  "@typescript-eslint/parser": "^5.18.0",
40
40
  "concurrently": "^7.1.0",
41
- "eslint": "^8.12.0",
41
+ "eslint": "^8.13.0",
42
42
  "eslint-config-prettier": "^8.5.0",
43
43
  "nodemon": "^2.0.15",
44
44
  "pino-pretty": "^7.6.1",
package/src/index.ts CHANGED
@@ -22,7 +22,8 @@ const createPDF = async (url: string, options?: PdfOptions) => {
22
22
  const browser = await playwright.chromium.launch();
23
23
  const context = await browser.newContext({ ignoreHTTPSErrors: true });
24
24
  const page = await context.newPage();
25
- await page.goto(url);
25
+ await page.goto(url, { timeout: 60000 });
26
+ await page.waitForLoadState("networkidle");
26
27
 
27
28
  const pdf = await page.pdf(options);
28
29
  await browser.close();
@@ -1,30 +0,0 @@
1
- {
2
- "[javascriptreact]": {
3
- "editor.formatOnSave": true,
4
- "editor.formatOnPaste": true
5
- },
6
- "[html]": {
7
- "editor.formatOnType": true,
8
- "editor.formatOnSave": true
9
- },
10
- "[javascript]": {
11
- "editor.formatOnSave": true,
12
- "editor.formatOnPaste": true
13
- },
14
- "[json]": {
15
- "editor.formatOnSave": true,
16
- "editor.formatOnPaste": true
17
- },
18
- "[typescript]": {
19
- "editor.formatOnSave": true,
20
- "editor.formatOnPaste": true
21
- },
22
- "[css]": {
23
- "editor.formatOnSave": true,
24
- "editor.formatOnPaste": true
25
- },
26
- "[scss]": {
27
- "editor.formatOnSave": true,
28
- "editor.formatOnPaste": true
29
- }
30
- }
package/dist/index.js DELETED
@@ -1,57 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const fastify_1 = __importDefault(require("fastify"));
7
- const playwright_core_1 = __importDefault(require("playwright-core"));
8
- const pdf_request_body_json_1 = __importDefault(require("./schemas/pdf_request_body.json"));
9
- const SERVER_PORT = process.env["SERVER_PORT"] ?? 8000;
10
- const server = (0, fastify_1.default)({
11
- logger: {
12
- prettyPrint: process.env["NODE_ENV"] !== "production"
13
- ? {
14
- translateTime: "HH:MM:ss Z",
15
- ignore: "pid,hostname",
16
- }
17
- : false,
18
- },
19
- });
20
- const createPDF = async (url, options) => {
21
- const browser = await playwright_core_1.default.chromium.launch();
22
- const context = await browser.newContext({ ignoreHTTPSErrors: true });
23
- const page = await context.newPage();
24
- await page.goto(url);
25
- const pdf = await page.pdf(options);
26
- await browser.close();
27
- return pdf;
28
- };
29
- server.post("/pdf", { schema: { body: pdf_request_body_json_1.default }, attachValidation: true }, async (request, response) => {
30
- if (request.validationError) {
31
- response.code(400);
32
- return {
33
- error: true,
34
- message: request.validationError.message,
35
- };
36
- }
37
- try {
38
- return createPDF(request.body.url, request.body.options);
39
- }
40
- catch (error) {
41
- response.code(500);
42
- return {
43
- error,
44
- };
45
- }
46
- });
47
- server.get("/health", async (_, response) => response.code(200).send());
48
- const startServer = async () => {
49
- try {
50
- await server.listen(+SERVER_PORT, "0.0.0.0");
51
- }
52
- catch (error) {
53
- console.error(error);
54
- process.exit(1);
55
- }
56
- };
57
- startServer();
@@ -1,84 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "properties": {
4
- "options": {
5
- "properties": {
6
- "displayHeaderFooter": {
7
- "description": "Display header and footer. Defaults to `false`.",
8
- "type": "boolean"
9
- },
10
- "footerTemplate": {
11
- "description": "HTML template for the print footer. Should use the same format as the `headerTemplate`.",
12
- "type": "string"
13
- },
14
- "format": {
15
- "description": "Paper format. If set, takes priority over `width` or `height` options. Defaults to 'Letter'.",
16
- "type": "string"
17
- },
18
- "headerTemplate": {
19
- "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",
20
- "type": "string"
21
- },
22
- "height": {
23
- "description": "Paper height, accepts values labeled with units.",
24
- "type": ["string", "number"]
25
- },
26
- "landscape": {
27
- "description": "Paper orientation. Defaults to `false`.",
28
- "type": "boolean"
29
- },
30
- "margin": {
31
- "description": "Paper margins, defaults to none.",
32
- "properties": {
33
- "bottom": {
34
- "description": "Bottom margin, accepts values labeled with units. Defaults to `0`.",
35
- "type": ["string", "number"]
36
- },
37
- "left": {
38
- "description": "Left margin, accepts values labeled with units. Defaults to `0`.",
39
- "type": ["string", "number"]
40
- },
41
- "right": {
42
- "description": "Right margin, accepts values labeled with units. Defaults to `0`.",
43
- "type": ["string", "number"]
44
- },
45
- "top": {
46
- "description": "Top margin, accepts values labeled with units. Defaults to `0`.",
47
- "type": ["string", "number"]
48
- }
49
- },
50
- "type": "object"
51
- },
52
- "pageRanges": {
53
- "description": "Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.",
54
- "type": "string"
55
- },
56
- "path": {
57
- "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.",
58
- "type": "string"
59
- },
60
- "preferCSSPageSize": {
61
- "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.",
62
- "type": "boolean"
63
- },
64
- "printBackground": {
65
- "description": "Print background graphics. Defaults to `false`.",
66
- "type": "boolean"
67
- },
68
- "scale": {
69
- "description": "Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.",
70
- "type": "number"
71
- },
72
- "width": {
73
- "description": "Paper width, accepts values labeled with units.",
74
- "type": ["string", "number"]
75
- }
76
- },
77
- "type": "object"
78
- },
79
- "url": {
80
- "type": "string"
81
- }
82
- },
83
- "type": "object"
84
- }
@@ -1,2 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });