@pagepocket/lib 0.4.0 → 0.4.2

package/README.md

@@ -0,0 +1,45 @@
+# @pagepocket/lib
+
+Library for rewriting captured HTML into an offline-ready snapshot. It downloads
+assets, rewrites HTML/CSS/JS references to local URLs, and injects replay/preload
+scripts.
+
+## Install
+
+```bash
+pnpm add @pagepocket/lib
+```
+
+## Quick Start
+
+```ts
+import { PagePocket } from "@pagepocket/lib";
+
+const pagepocket = new PagePocket(htmlString, requestsJSON, {
+  assetsDirName: "example_files",
+  baseUrl: "https://example.com",
+  requestsPath: "example.requests.json"
+});
+
+const html = await pagepocket.put();
+```
+
+## API
+
+```ts
+type PagePocketOptions = {
+  assetsDirName?: string;
+  baseUrl?: string;
+  requestsPath?: string;
+};
+```
+
+- `assetsDirName`: folder name for downloaded assets.
+- `baseUrl`: used to resolve relative URLs.
+- `requestsPath`: path to the `*.requests.json` file referenced by replay.
+
+`put()` returns the rewritten HTML string.
+
+## Notes
+
+- Uses `@pagepocket/uni-fs` for file IO so it works in Node and OPFS contexts.

package/dist/css-rewrite.js

@@ -36,7 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.rewriteCssUrls = void 0;
 const URL_PATTERN = /url\(\s*(['"]?)([^'")]+)\1\s*\)/g;
 const rewriteCssUrls = async (input) => {
-    const { readText, write } = await Promise.resolve().then(() => __importStar(require("uni-fs")));
+    const { readText, write } = await Promise.resolve().then(() => __importStar(require("@pagepocket/uni-fs")));
     const original = await readText(input.filename, input.extension);
     let updated = "";
     let lastIndex = 0;

package/dist/download-resources.js

@@ -98,16 +98,13 @@ const collectSrcsetUrls = (items, baseUrl) => {
     return urls;
 };
 const downloadResources = async (input) => {
-    const { write, exists } = await Promise.resolve().then(() => __importStar(require("uni-fs")));
+    const { write, exists } = await Promise.resolve().then(() => __importStar(require("@pagepocket/uni-fs")));
     const resourceMap = new Map();
     const resourceMeta = [];
     let downloadedCount = 0;
     let failedCount = 0;
     const srcsetUrls = collectSrcsetUrls(input.srcsetItems, input.baseUrl);
-    const candidateUrls = [
-        ...input.resourceUrls.map((resource) => resource.url),
-        ...srcsetUrls
-    ];
+    const candidateUrls = [...input.resourceUrls.map((resource) => resource.url), ...srcsetUrls];
     for (const candidate of candidateUrls) {
         if (shouldSkipUrl(candidate)) {
             continue;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { PagePocket } from "./pagepocket";
 export type { PagePocketOptions } from "./pagepocket";
-export type { FetchRecord, NetworkRecord, LighterceptorNetworkRecord, SnapshotData } from "./types";
+export type { FetchRecord, NetworkRecord, CapturedNetworkRecord, SnapshotData, NetworkInterceptorAdapter } from "./types";
 export { buildReplayScript } from "./replay-script";
 export { buildPreloadScript } from "./preload";
-export { findFaviconDataUrl, mapLighterceptorRecords, toDataUrlFromRecord } from "./network-records";
+export { findFaviconDataUrl, mapCapturedNetworkRecords, toDataUrlFromRecord } from "./network-records";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toDataUrlFromRecord = exports.mapLighterceptorRecords = exports.findFaviconDataUrl = exports.buildPreloadScript = exports.buildReplayScript = exports.PagePocket = void 0;
+exports.toDataUrlFromRecord = exports.mapCapturedNetworkRecords = exports.findFaviconDataUrl = exports.buildPreloadScript = exports.buildReplayScript = exports.PagePocket = void 0;
 var pagepocket_1 = require("./pagepocket");
 Object.defineProperty(exports, "PagePocket", { enumerable: true, get: function () { return pagepocket_1.PagePocket; } });
 var replay_script_1 = require("./replay-script");
@@ -9,5 +9,5 @@ var preload_1 = require("./preload");
 Object.defineProperty(exports, "buildPreloadScript", { enumerable: true, get: function () { return preload_1.buildPreloadScript; } });
 var network_records_1 = require("./network-records");
 Object.defineProperty(exports, "findFaviconDataUrl", { enumerable: true, get: function () { return network_records_1.findFaviconDataUrl; } });
-Object.defineProperty(exports, "mapLighterceptorRecords", { enumerable: true, get: function () { return network_records_1.mapLighterceptorRecords; } });
+Object.defineProperty(exports, "mapCapturedNetworkRecords", { enumerable: true, get: function () { return network_records_1.mapCapturedNetworkRecords; } });
 Object.defineProperty(exports, "toDataUrlFromRecord", { enumerable: true, get: function () { return network_records_1.toDataUrlFromRecord; } });

package/dist/network-records.d.ts

@@ -1,4 +1,4 @@
-import type { LighterceptorNetworkRecord, NetworkRecord } from "./types";
+import type { CapturedNetworkRecord, NetworkRecord } from "./types";
 export declare const toDataUrlFromRecord: (record: NetworkRecord) => string | null;
 export declare const findFaviconDataUrl: (records: NetworkRecord[]) => string | null;
-export declare const mapLighterceptorRecords: (records: LighterceptorNetworkRecord[] | undefined) => NetworkRecord[];
+export declare const mapCapturedNetworkRecords: (records: CapturedNetworkRecord[] | undefined) => NetworkRecord[];

package/dist/network-records.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapLighterceptorRecords = exports.findFaviconDataUrl = exports.toDataUrlFromRecord = void 0;
+exports.mapCapturedNetworkRecords = exports.findFaviconDataUrl = exports.toDataUrlFromRecord = void 0;
 const getHeaderValue = (headers, name) => {
     for (const key in headers) {
         if (key.toLowerCase() === name.toLowerCase()) {
@@ -61,7 +61,7 @@ const findFaviconDataUrl = (records) => {
     return null;
 };
 exports.findFaviconDataUrl = findFaviconDataUrl;
-const mapLighterceptorRecords = (records) => {
+const mapCapturedNetworkRecords = (records) => {
     if (!records)
         return [];
     return records.map((record) => {
@@ -80,4 +80,4 @@ const mapLighterceptorRecords = (records) => {
         };
     });
 };
-exports.mapLighterceptorRecords = mapLighterceptorRecords;
+exports.mapCapturedNetworkRecords = mapCapturedNetworkRecords;

package/dist/pagepocket.d.ts

@@ -1,9 +1,13 @@
-import type { SnapshotData } from "./types";
+import type { NetworkInterceptorAdapter, SnapshotData } from "./types";
 export type PagePocketOptions = {
     assetsDirName?: string;
     baseUrl?: string;
     requestsPath?: string;
 };
+interface PageContent extends PagePocketOptions {
+    content: string;
+    title: string;
+}
 type RequestsInput = SnapshotData | string;
 export declare class PagePocket {
     private htmlString;
@@ -13,6 +17,7 @@ export declare class PagePocket {
     downloadedCount: number;
     failedCount: number;
     constructor(htmlString: string, requestsJSON: RequestsInput, options?: PagePocketOptions);
-    put(): Promise<string>;
+    static fromNetworkIntercetor(htmlString: string, url: string, interceptorAdapter: NetworkInterceptorAdapter, options?: PagePocketOptions): Promise<PagePocket>;
+    put(): Promise<PageContent>;
 }
 export {};

package/dist/pagepocket.js

@@ -19,7 +19,7 @@ const safeFilename = (input) => {
 const parseRequestsJson = (requestsJSON) => {
     const snapshot = typeof requestsJSON === "string" ? JSON.parse(requestsJSON) : requestsJSON;
     const rawNetworkRecords = (snapshot.networkRecords || []);
-    const mappedNetworkRecords = (0, network_records_1.mapLighterceptorRecords)(rawNetworkRecords);
+    const mappedNetworkRecords = (0, network_records_1.mapCapturedNetworkRecords)(rawNetworkRecords);
     return {
         snapshot,
         networkRecords: mappedNetworkRecords
@@ -34,6 +34,9 @@ class PagePocket {
         this.requestsJSON = requestsJSON;
         this.options = options ?? {};
     }
+    static async fromNetworkIntercetor(htmlString, url, interceptorAdapter, options) {
+        return new PagePocket(htmlString, await interceptorAdapter.run(url), options);
+    }
     async put() {
         const { snapshot, networkRecords } = parseRequestsJson(this.requestsJSON);
         const safeTitle = safeFilename(snapshot.title || "snapshot");
@@ -67,7 +70,13 @@ class PagePocket {
             requestsPath,
             faviconDataUrl
         });
-        return $.html();
+        return {
+            content: $.html(),
+            title: safeTitle,
+            assetsDirName,
+            requestsPath,
+            baseUrl
+        };
     }
 }
 exports.PagePocket = PagePocket;

package/dist/rewrite-links.d.ts

@@ -1,7 +1,7 @@
 import type { CheerioAPI } from "cheerio";
+import type { DownloadedResource } from "./download-resources";
 import { type ResourceReference, type SrcsetReference } from "./resources";
 import type { NetworkRecord } from "./types";
-import type { DownloadedResource } from "./download-resources";
 type RewriteLinksInput = {
     $: CheerioAPI;
     resourceUrls: ResourceReference[];

package/dist/rewrite-links.js

@@ -105,7 +105,7 @@ const buildNetworkLookup = (records) => {
     return networkRecordByUrl;
 };
 const rewriteLinks = async (input) => {
-    const { readAsURL } = await Promise.resolve().then(() => __importStar(require("uni-fs")));
+    const { readAsURL } = await Promise.resolve().then(() => __importStar(require("@pagepocket/uni-fs")));
     const networkRecordByUrl = buildNetworkLookup(input.networkRecords);
     const { baseOrigin, baseDir } = buildLinkBase(input.baseUrl);
     const localUrlCache = new Map();

package/dist/types.d.ts

@@ -24,19 +24,19 @@ export type NetworkRecord = {
     error?: string;
     timestamp: number;
 };
-export type LighterceptorResponseRecord = {
+export type CapturedResponseRecord = {
     status: number;
     statusText: string;
     headers: Record<string, string>;
     body: string;
     bodyEncoding: "text" | "base64";
 };
-export type LighterceptorNetworkRecord = {
+export type CapturedNetworkRecord = {
     url: string;
     source?: string;
     method: string;
     timestamp: number;
-    response?: LighterceptorResponseRecord;
+    response?: CapturedResponseRecord;
     error?: string;
 };
 export type SnapshotData = {
@@ -44,7 +44,7 @@ export type SnapshotData = {
     title: string;
     capturedAt: string;
     fetchXhrRecords: FetchRecord[];
-    networkRecords: LighterceptorNetworkRecord[];
+    networkRecords: CapturedNetworkRecord[];
     resources: Array<{
         url: string;
         localPath: string;
@@ -52,3 +52,6 @@ export type SnapshotData = {
         size?: number;
     }>;
 };
+export interface NetworkInterceptorAdapter {
+    run(url: string): Promise<SnapshotData>;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pagepocket/lib",
-  "version": "0.4.0",
-  "description": "",
+  "version": "0.4.2",
+  "description": "Library for rewriting HTML snapshots and inlining local resources.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -12,7 +12,7 @@
   "license": "ISC",
   "dependencies": {
     "cheerio": "^1.0.0-rc.12",
-    "uni-fs": "npm:@pagepocket/uni-fs@0.4.0"
+    "@pagepocket/uni-fs": "0.4.2"
   },
   "devDependencies": {
     "@types/node": "^20.11.30",