feat: create @amazeelabs/save-webpage

Author: Leksat

packages/npm/@amazeelabs/save-webpage/.eslintrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+  extends: ['@amazeelabs/eslint-config'],
+  root: true,
+};

packages/npm/@amazeelabs/save-webpage/.gitignore

@@ -0,0 +1,2 @@
+build
+node_modules

packages/npm/@amazeelabs/save-webpage/.npmignore

@@ -0,0 +1 @@
+!build

packages/npm/@amazeelabs/save-webpage/.prettierrc

@@ -0,0 +1 @@
+"@amazeelabs/prettier-config"

packages/npm/@amazeelabs/save-webpage/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@amazeelabs/save-webpage",
+  "version": "1.0.0",
+  "description": "Saves a webpage with all resources.",
+  "type": "module",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf build && tsc",
+    "test:static": "tsc --noEmit && eslint '**/*.{ts,tsx,js,jsx}' --ignore-path='./.gitignore'"
+  },
+  "dependencies": {
+    "website-scraper": "^5.3.1"
+  },
+  "devDependencies": {
+    "@amazeelabs/eslint-config": "1.4.43",
+    "@amazeelabs/prettier-config": "1.1.3",
+    "@types/website-scraper": "^1.2.10",
+    "typescript": "5.3.3"
+  },
+  "keywords": [],
+  "author": "AmazeeLabs <[email protected]>"
+}

packages/npm/@amazeelabs/save-webpage/src/index.ts

@@ -0,0 +1,57 @@
+import * as scrape from 'website-scraper';
+
+export async function saveWebpage(args: {
+  /**
+   * URL of the target webpage.
+   */
+  url: string;
+  /**
+   * Replaces the actual webpage content.
+   */
+  content?: string;
+  /**
+   * Path to directory where downloaded files will be saved. Must not exist.
+   */
+  directory: string;
+}): Promise<void> {
+  await scrape({
+    directory: args.directory,
+    urls: [args.url],
+    plugins: args.content ? [new ReplaceContentPlugin(args.content)] : [],
+  });
+}
+
+// Replaces the first request response with given content.
+class ReplaceContentPlugin {
+  isFirstRequest = true;
+
+  constructor(public firstRequestResponse: string) {}
+
+  apply(
+    registerAction: (
+      event: 'afterResponse',
+      handler: <T>(args: { response: T }) => Promise<
+        | T
+        | {
+            body: string;
+            encoding: 'utf8';
+            metadata: {};
+          }
+      >,
+    ) => void,
+  ): void {
+    registerAction('afterResponse', async ({ response }) => {
+      if (this.isFirstRequest) {
+        this.isFirstRequest = false;
+        return {
+          body: this.firstRequestResponse,
+          encoding: 'utf8',
+          metadata: {},
+        };
+      } else {
+        this.isFirstRequest = false;
+        return response;
+      }
+    });
+  }
+}

packages/npm/@amazeelabs/save-webpage/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "esnext",
+    "module": "esnext",
+    "strict": true,
+    "skipLibCheck": true,
+    "outDir": "build"
+  },
+  "include": ["src"],
+  "$schema": "https://json.schemastore.org/tsconfig"
+}