@pagepocket/build-snapshot-unit 0.8.0

package/dist/build-snapshot-plugin.d.ts

@@ -0,0 +1,7 @@
+import { type PagePocketContext, type PagePocketPlugin } from "@pagepocket/lib";
+export type BuildSnapshotPluginOptions = {};
+export declare class BuildSnapshotPlugin implements PagePocketPlugin {
+    readonly name = "plugin:build-snapshot";
+    constructor(options?: BuildSnapshotPluginOptions);
+    apply(ctx: PagePocketContext): void;
+}

package/dist/build-snapshot-plugin.js

@@ -0,0 +1,62 @@
+import { buildSnapshot, createDefaultPathResolver, createDefaultResourceFilter, debugLog } from "@pagepocket/lib";
+export class BuildSnapshotPlugin {
+    constructor(options) {
+        this.name = "plugin:build-snapshot";
+        void options;
+    }
+    apply(ctx) {
+        const baseFilter = ctx.options.filter ?? createDefaultResourceFilter();
+        const blacklist = ctx.options.blacklist ?? [];
+        const isBlacklisted = (url) => typeof url === "string" && blacklist.some((pattern) => pattern.test(url));
+        const filter = blacklist.length === 0
+            ? baseFilter
+            : {
+                shouldSave(req, res) {
+                    if (isBlacklisted(req.url)) {
+                        debugLog("[pagepocket] blacklist match (skip save)", req.url);
+                        return false;
+                    }
+                    return baseFilter.shouldSave(req, res);
+                }
+            };
+        const pathResolver = ctx.options.pathResolver ?? createDefaultPathResolver();
+        const rewriteEntry = ctx.options.rewriteEntry ?? true;
+        const rewriteCSS = ctx.options.rewriteCSS ?? true;
+        const limits = ctx.options.limits;
+        ctx.onFinalize(async () => {
+            const existingFiles = ctx.files;
+            if (existingFiles) {
+                return;
+            }
+            const capture = ctx.capture;
+            if (!capture) {
+                throw new Error("BuildSnapshotPlugin requires ctx.capture");
+            }
+            const entryUrl = ctx.entry.kind === "url"
+                ? ctx.entry.url
+                : ctx.entry.kind === "html-string"
+                    ? (ctx.entry.url ?? ctx.entry.baseUrl)
+                    : "";
+            const internal = ctx;
+            const replaceElements = internal._replaceElements && internal._replaceElements.length > 0
+                ? internal._replaceElements
+                : undefined;
+            const replaceElementsMerged = replaceElements
+                ? replaceElements.flat()
+                : undefined;
+            const files = await buildSnapshot({
+                entryUrl,
+                createdAt: Date.now(),
+                capture,
+                filter,
+                pathResolver,
+                rewriteEntry,
+                rewriteCSS,
+                replaceElements: replaceElementsMerged,
+                limits,
+                warnings: []
+            });
+            ctx.files = files;
+        });
+    }
+}

package/dist/build-snapshot-unit.d.ts

@@ -0,0 +1,10 @@
+import { Unit, type FileTree, type UnitPatch } from "@pagepocket/lib";
+export declare class BuildSnapshotUnit extends Unit {
+    readonly id = "buildSnapshot";
+    readonly kind = "build.snapshot";
+    merge(returnValue: UnitPatch, pluginContributedValue?: UnitPatch): UnitPatch;
+    run(ctx: import("@pagepocket/lib").UnitContext, rt: import("@pagepocket/lib").UnitRuntime): Promise<{
+        files: FileTree;
+        html: {};
+    } | undefined>;
+}

package/dist/build-snapshot-unit.js

@@ -0,0 +1,82 @@
+import { buildSnapshot, createDefaultPathResolver, createDefaultResourceFilter, debugLog, mergeFileTrees, Unit } from "@pagepocket/lib";
+export class BuildSnapshotUnit extends Unit {
+    constructor() {
+        super(...arguments);
+        this.id = "buildSnapshot";
+        this.kind = "build.snapshot";
+    }
+    merge(returnValue, pluginContributedValue = {}) {
+        const mergedValue = { ...returnValue, ...pluginContributedValue };
+        const returnFiles = returnValue.files;
+        const pluginFiles = pluginContributedValue.files;
+        if (!isFileTree(returnFiles) || !isFileTree(pluginFiles)) {
+            return mergedValue;
+        }
+        return { ...mergedValue, files: mergeFileTrees(returnFiles, pluginFiles) };
+    }
+    async run(ctx, rt) {
+        if (ctx.value.files) {
+            return;
+        }
+        const baseFilter = rt.options.filter ?? createDefaultResourceFilter();
+        const blacklist = rt.options.blacklist ?? [];
+        const isBlacklisted = (url) => typeof url === "string" && blacklist.some((pattern) => pattern.test(url));
+        const filter = blacklist.length === 0
+            ? baseFilter
+            : {
+                shouldSave(req, res) {
+                    if (isBlacklisted(req.url)) {
+                        debugLog("[pagepocket] blacklist match (skip save)", req.url);
+                        return false;
+                    }
+                    return baseFilter.shouldSave(req, res);
+                }
+            };
+        const pathResolver = rt.options.pathResolver ?? createDefaultPathResolver();
+        const rewriteEntry = rt.options.rewriteEntry ?? true;
+        const rewriteCSS = rt.options.rewriteCSS ?? true;
+        const limits = rt.options.limits;
+        const capture = ctx.value.capture;
+        if (!capture) {
+            throw new Error("BuildSnapshotUnit requires ctx.value.capture");
+        }
+        const entryUrl = rt.entry.kind === "url"
+            ? rt.entry.url
+            : rt.entry.kind === "html-string"
+                ? (rt.entry.url ?? rt.entry.baseUrl)
+                : "";
+        const replaceElements = await rt.elements.compile();
+        const replaceElementsFinal = replaceElements.length > 0 ? replaceElements : undefined;
+        const files = await buildSnapshot({
+            entryUrl,
+            createdAt: Date.now(),
+            capture,
+            filter,
+            pathResolver,
+            rewriteEntry,
+            rewriteCSS,
+            replaceElements: replaceElementsFinal,
+            limits,
+            warnings: []
+        });
+        const html = ctx.value.html;
+        if (!html) {
+            throw new Error("BuildSnapshotUnit requires ctx.value.html");
+        }
+        return { files, html };
+    }
+}
+const isFileTree = (v) => {
+    if (!v || typeof v !== "object") {
+        return false;
+    }
+    if (!("root" in v)) {
+        return false;
+    }
+    const root = v.root;
+    if (!root || typeof root !== "object") {
+        return false;
+    }
+    const r = root;
+    return r.kind === "directory" && typeof r.path === "string" && Array.isArray(r.entries);
+};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { BuildSnapshotUnit } from "./build-snapshot-unit.js";

package/dist/index.js

@@ -0,0 +1 @@
+export { BuildSnapshotUnit } from "./build-snapshot-unit.js";

package/dist/plugin.d.ts

@@ -0,0 +1,10 @@
+import type { PagePocketContext, PagePocketPlugin } from "@pagepocket/lib";
+export type BuildSnapshotPluginOptions = {
+    enabled?: boolean;
+};
+export declare class BuildSnapshotPlugin implements PagePocketPlugin {
+    readonly name = "plugin:build-snapshot";
+    enabled?: boolean;
+    constructor(options?: BuildSnapshotPluginOptions);
+    apply(ctx: PagePocketContext): void;
+}

package/dist/plugin.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuildSnapshotPlugin = void 0;
+const lib_1 = require("@pagepocket/lib");
+class BuildSnapshotPlugin {
+    constructor(options) {
+        this.name = "plugin:build-snapshot";
+        this.enabled = options?.enabled;
+    }
+    apply(ctx) {
+        const contentStore = ctx.options.contentStore ?? new lib_1.HybridContentStore();
+        const baseFilter = ctx.options.filter ?? (0, lib_1.createDefaultResourceFilter)();
+        const blacklist = ctx.options.blacklist ?? [];
+        const isBlacklisted = (url) => typeof url === "string" && blacklist.some((pattern) => pattern.test(url));
+        const filter = blacklist.length === 0
+            ? baseFilter
+            : {
+                shouldSave(req, res) {
+                    if (isBlacklisted(req.url)) {
+                        (0, lib_1.debugLog)("[pagepocket] blacklist match (skip save)", req.url);
+                        return false;
+                    }
+                    return baseFilter.shouldSave(req, res);
+                }
+            };
+        const pathResolver = ctx.options.pathResolver ?? (0, lib_1.createDefaultPathResolver)();
+        const rewriteEntry = ctx.options.rewriteEntry ?? true;
+        const rewriteCSS = ctx.options.rewriteCSS ?? true;
+        const limits = ctx.options.limits;
+        const store = new lib_1.NetworkStore({
+            contentStore,
+            filter,
+            limits
+        });
+        const inflightTracker = new lib_1.InflightTracker({
+            shouldIgnore: (event) => {
+                if (!isBlacklisted(event.url)) {
+                    return false;
+                }
+                (0, lib_1.debugLog)("[pagepocket] blacklist match (ignore inflight)", event.url);
+                return true;
+            }
+        });
+        ctx.onNetworkEvent(async (event) => {
+            inflightTracker.handleEvent(event);
+            await store.handleEvent(event);
+        });
+        ctx.onFinalize(async () => {
+            const existingFiles = ctx.files;
+            if (existingFiles) {
+                return;
+            }
+            const entryUrl = ctx.entry.kind === "url"
+                ? ctx.entry.url
+                : ctx.entry.kind === "html-string"
+                    ? (ctx.entry.url ?? ctx.entry.baseUrl)
+                    : "";
+            const internal = ctx;
+            const replaceElements = internal._replaceElements && internal._replaceElements.length > 0
+                ? internal._replaceElements
+                : undefined;
+            const replaceElementsMerged = replaceElements
+                ? replaceElements.flat()
+                : undefined;
+            const snapshot = await (0, lib_1.buildSnapshot)({
+                entryUrl,
+                createdAt: Date.now(),
+                resources: store.getResources(),
+                apiEntries: store.getApiEntries(),
+                contentStore,
+                pathResolver,
+                rewriteEntry,
+                rewriteCSS,
+                replaceElements: replaceElementsMerged,
+                warnings: []
+            });
+            const files = {
+                root: {
+                    kind: "directory",
+                    path: "",
+                    entries: snapshot.files.map((file) => ({
+                        kind: "file",
+                        path: file.path,
+                        source: { kind: "content-ref", ref: file.source }
+                    }))
+                },
+                content: snapshot.content
+            };
+            ctx.files = files;
+        });
+    }
+}
+exports.BuildSnapshotPlugin = BuildSnapshotPlugin;

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@pagepocket/build-snapshot-unit",
+  "version": "0.8.0",
+  "description": "PagePocket plugin: build snapshot",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "license": "ISC",
+  "dependencies": {
+    "@pagepocket/contracts": "0.8.0",
+    "@pagepocket/lib": "0.8.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "node -e \"process.exit(0)\""
+  }
+}