.gitattributes

@@ -1,2 +1,3 @@
 *.ts linguist-language=TypeScript
 *.js linguist-language=TypeScript
+*.html linguist-language=TypeScript

.gitignore

@@ -54,10 +54,6 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# static files directory
-static/*
-!static/.gitkeep
-
 templates/*
 !templates/test.hbs
 

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,34 @@
+{
+  "editor.formatOnSave": false,
+
+  // Auto fix
+
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never",
+		"source.fixAll.stylelint": "explicit"
+  },
+  "eslint.run": "onType",
+  "eslint.format.enable": true,
+  "css.validate": false,
+	"less.validate": false,
+
+	"files.autoSaveDelay": 500,
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml",
+    "toml",
+    "gql",
+    "graphql"
+  ]
+}

README-en.md

@@ -0,0 +1,188 @@
+# Puppeteer Server
+
+English | [中文](README.md)
+
+<img src="https://github.com/pdsuwwz/puppeteer-server/assets/19891724/86177762-8a97-4656-8ee0-5add61c50237" height="100" align-right />
+
+
+## 📤 Migrate to Playwright
+
+To experience enhanced features and broader browser support, the entire codebase of the latest version has seamlessly migrated to Playwright.
+
+Playwright repo: [koa-playwright-server](https://github.com/pdsuwwz/koa-playwright-server)
+
+## Introduction
+
+🦩 Koa + ESM + TypeScript + Rollup + Nodemon + Puppeteer + ESLint (v9)
+
+> * Fast Generate into PDF and images from any webpage.
+>
+> * Support merge multiple webpages into one PDF file, injection of Cookies, Watermark addition and Header and Footer insertion
+
+
+## ✨ Features
+
+* ✅ Built-in ES Module + TypeScript environment
+
+* 🌈 Separation business logic and Controllers.
+
+* 🛡 Probably the best practice for Puppeteer project.
+
+* 🧩 Configured routing.
+
+* 🚧 Eslint (v9) configuration.
+
+* ⚡ Fast build with Rollup.
+
+* 🔌 Extensible PDF watermark, header and footer.
+
+* 🧲 Supports merging of multiple PDF files.
+
+* 🔥 Based on Nodemon HMR.
+
+
+## Screenshot
+
+* Merge Combine the two websites into a PDF file
+> 📦 See [Merge Test 1](__test__/axios-browser.html), [Merge Test 2](__test__/axios-node.js)
+
+
+![image](https://user-images.githubusercontent.com/19891724/159743021-e1f9f528-d6d9-4d6b-b63f-4e71c6b72bdb.png)
+
+
+
+## 🎯 Prerequisites
+
+Please make sure that [Node.js](https://nodejs.org/) (>= 20.x) is installed on your operating system.
+
+## Project structure
+
+<pre>
+├── src
+│   ├── controllers/ ---  Server controllers
+│   ├── services/    ---  Server services
+│   ├── config.ts    ---  About Environments variable
+│   ├── main.ts      ---  Entry file
+│   └── routes.ts    ---  Configs for routing controllers <a href="#Routing">👉 Routing</a>
+</pre>
+
+## ⚡ Quick Start
+
+### 1. Installation
+
+```bash
+pnpm install
+```
+
+### 2. Running Development
+
+```bash
+pnpm dev
+```
+
+### 3. Running Production
+
+The project has built-in a `pm2`, running the `pnpm start` will automatically manage the process by `pm2`.
+
+Run `pnpm build` to build, then run `pnpm start` to start the process managed by `pm2`:
+
+* Build
+
+```bash
+pnpm build
+```
+
+* Run
+
+```bash
+pnpm start # PORT is 8080
+# or
+node dist/bundle.esm.js # PORT is 5000
+```
+
+## API
+
+* `GET /image`
+
+Generate screenshot.
+
+```bash
+curl --location --request GET \
+'http://localhost:5000/image?url=https://www.baidu.com' \
+--output test-image.png
+```
+
+* `GET /simple-pdf`
+
+Generate pdf.
+
+```bash
+curl --location --request GET \
+'http://localhost:5000/simple-pdf?url=https://www.google.com/' \
+--output test-simple-pdf.pdf
+```
+
+* `POST /pdf`
+
+Generate pdf with elements such as headers and footers.
+
+```bash
+curl --location --request POST 'http://localhost:5000/pdf' \
+--header 'Content-Type: application/x-www-form-urlencoded' \
+--data-urlencode 'url=http://www.google.com' \
+--data-urlencode 'cookies[0].name=token' \
+--data-urlencode 'cookies[0].value=9s2d4c16-f072-16eg-b134-0642ap190006' \
+--data-urlencode 'cookies[0].domain=www.google.com' --output test-complex-pdf.pdf
+```
+
+👆 /pdf request parameters
+
+| Field | Description | Type | Default Value |
+| -------- | -------- | -------- | -------- |
+| url | Target site url | string | — |
+| cookies | Generally used as a website that requires login to access, you can add this field | Array<{ name, value, domain }> | [] |
+| hasMargin | If this field is set to true, it means that the generated PDF will contain margins | boolean | true |
+| isLandscape | Whether the generated PDF is horizontal | boolean | false |
+| hiddenWatermark | Whether to hide watermark | boolean | false |
+| attachment | Display the custom header and footer, provided that hasMargin is set to true | { header, footer } | — |
+
+
+* `POST /combine-pdf`
+
+Merge multiple PDF files into one file.
+
+See [Merge Test 1](__test__/axios-browser.html), [Merge Test 2](__test__/axios-node.js)
+
+👆 /combine-pdf request parameters
+
+| Field | Description | Type | Default Value |
+| -------- | -------- | -------- | -------- |
+| pdfList | A collection of target websites, the parameter type is an array, and each item in the array is a parameter required by `/pdf` | Array<{ pdfItem }> | [] |
+
+
+## Routing
+
+In order to make the routing information more readable and transparent, the form of configuration is adopted here.
+
+You can create an `array` and then write the routing meta information into the `array`, and reuse it in the [src/routes.ts](src/routes.ts)
+
+```ts
+const routes: Array<RouteConfig> = [
+  {
+    path: '/',
+    method: 'get',
+    action: homeController.hello
+  },
+  // here...
+]
+```
+
+# License
+
+:v:
+
+[MIT](./LICENSE)
+
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpdsuwwz%2Fpuppeteer-server.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpdsuwwz%2Fpuppeteer-server?ref=badge_large)
+