@pagepocket/lib 0.8.6 → 0.9.0

package/dist/hackers/replay-dom-rewrite.js

@@ -1,377 +1,7 @@
+import { replayDomRewriteScriptPart1 } from "./replay-dom-rewrite/script-part-1.js";
+import { replayDomRewriteScriptPart2 } from "./replay-dom-rewrite/script-part-2.js";
 export const replayDomRewriter = {
     id: "replay-dom-rewriter",
     stage: "replay",
-    build: () => `
-  // NOTE: When a resource is not found in the snapshot, we keep the original URL.
-  // (User choice) We still preserve a limited placeholder behavior for some tags,
-  // but only when we have a recorded response body to convert to a data URL.
-  const transparentGif = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///ywAAAAAAQABAAACAUwAOw==";
-  const emptyScript = "data:text/javascript,/*pagepocket-missing*/";
-  const emptyStyle = "data:text/css,/*pagepocket-missing*/";
-
-  let readyResolved = false;
-  if (ready && typeof ready.then === "function") {
-    ready.then(() => {
-      readyResolved = true;
-    });
-  } else {
-    readyResolved = true;
-  }
-
-  const onReady = (callback) => {
-    if (readyResolved) {
-      callback();
-      return;
-    }
-    if (ready && typeof ready.then === "function") {
-      ready.then(callback);
-    } else {
-      callback();
-    }
-  };
-
-  const rewritten = new WeakMap();
-
-  const shouldRewriteAttr = (element, attr) => {
-    try {
-      const tag = String((element && element.tagName) || "").toLowerCase();
-      const name = String(attr || "").toLowerCase();
-
-      if (!tag || !name) {
-        return false;
-      }
-
-      // Never rewrite navigation.
-      if (tag === "a" && name === "href") {
-        return false;
-      }
-
-      if (name === "src") {
-        return (
-          tag === "img" ||
-          tag === "source" ||
-          tag === "video" ||
-          tag === "audio" ||
-          tag === "script" ||
-          tag === "iframe" ||
-          tag === "object" ||
-          tag === "embed" ||
-          tag === "track"
-        );
-      }
-
-      if (name === "href") {
-        if (tag !== "link") {
-          return false;
-        }
-
-        const rel = String((element.getAttribute && element.getAttribute("rel")) || "").toLowerCase();
-        // Stylesheets + icons are resources.
-        if (rel.includes("stylesheet") || rel.includes("icon")) {
-          return true;
-        }
-
-        // Preload/prefetch/modulepreload are also resource loads.
-        // These are common in modern bundlers (Webpack/Rspack/Vite) and can
-        // otherwise bypass replay mapping.
-        if (rel.includes("preload") || rel.includes("prefetch") || rel.includes("modulepreload")) {
-          return true;
-        }
-
-        return false;
-      }
-
-      if (name === "srcset") {
-        return tag === "img" || tag === "source";
-      }
-
-      return false;
-    } catch {
-      return false;
-    }
-  };
-
-  // Rewrite srcset values to local files only (avoid data: URLs in srcset).
-  const rewriteSrcset = (value) => {
-    if (!value) return value;
-
-    // Substack-style image/fetch URLs include commas inside the URL token
-    // (",w_40,h_40,..."). This makes the srcset invalid and browsers will
-    // parse it into garbage candidate URLs. Prefer dropping srcset and relying
-    // on the rewritten img[src].
-    try {
-      const trimmed = String(value || "").trim();
-      const hasFetchTransform = trimmed.includes("/image/fetch/");
-      const hasEncodedUrlTail = trimmed.includes("https%3A%2F%2F");
-      const hasCommaTokens =
-        trimmed.includes(",w_") ||
-        trimmed.includes(", w_") ||
-        trimmed.includes(",h_") ||
-        trimmed.includes(", h_") ||
-        trimmed.includes(",c_") ||
-        trimmed.includes(", c_");
-
-      if (hasFetchTransform && hasEncodedUrlTail && hasCommaTokens) {
-        return "";
-      }
-    } catch {}
-
-    return value.split(",").map((part) => {
-      const trimmed = part.trim();
-      if (!trimmed) return trimmed;
-      const pieces = trimmed.split(/\\s+/, 2);
-      const url = pieces[0];
-      const descriptor = pieces[1];
-      if (isLocalResource(url)) return trimmed;
-      const localPath = findLocalPath(url);
-      if (localPath) {
-        return descriptor ? localPath + " " + descriptor : localPath;
-      }
-      return trimmed;
-    }).join(",");
-  };
-
-  // Rewrite element attributes to local files or data URLs.
-  const rewriteElement = (element) => {
-    if (!element || !element.getAttribute) return;
-    if (!readyResolved) {
-      onReady(() => rewriteElement(element));
-      return;
-    }
-    const prev = rewritten.get(element);
-    const currentSrc = element.getAttribute("src");
-    const currentHref = element.getAttribute("href");
-    const currentSrcset = element.getAttribute("srcset");
-    if (
-      prev &&
-      prev.src === currentSrc &&
-      prev.href === currentHref &&
-      prev.srcset === currentSrcset
-    ) {
-      return;
-    }
-    const tag = (element.tagName || "").toLowerCase();
-    if (tag === "img" || tag === "source" || tag === "video" || tag === "audio" || tag === "script" || tag === "iframe" || tag === "object" || tag === "embed" || tag === "track") {
-      const src = currentSrc;
-      if (src && !src.startsWith("data:") && !src.startsWith("blob:")) {
-        const next = rewriteResourceUrl(src, { kind: "attr", tag, attr: "src" });
-        if (next && next !== src) {
-          element.setAttribute("src", next);
-          return;
-        }
-      }
-    }
-
-    if (tag === "link") {
-      const href = currentHref;
-      const rel = (element.getAttribute("rel") || "").toLowerCase();
-       if (href && !href.startsWith("data:") && !href.startsWith("blob:")) {
-         if (rel.includes("stylesheet") || rel.includes("icon") || rel.includes("preload") || rel.includes("prefetch") || rel.includes("modulepreload")) {
-           // For <link rel=preload as=style>, use a CSS fallback type.
-           const as = (element.getAttribute("as") || "").toLowerCase();
-           const fallbackType =
-             rel.includes("stylesheet") || (rel.includes("preload") && as === "style")
-               ? "text/css"
-               : undefined;
-           const next = rewriteResourceUrl(href, {
-             kind: "attr",
-             tag,
-             attr: "href",
-             fallbackType
-           });
-           if (next && next !== href) {
-             element.setAttribute("href", next);
-             return;
-           }
-         }
-       }
-    }
-
-    const srcset = currentSrcset;
-    if (srcset) {
-      element.setAttribute("srcset", rewriteSrcset(srcset));
-    }
-
-    rewritten.set(element, {
-      src: element.getAttribute("src"),
-      href: element.getAttribute("href"),
-      srcset: element.getAttribute("srcset")
-    });
-  };
-
-  // Intercept DOM attribute writes to keep resources local.
-  const originalSetAttribute = Element.prototype.setAttribute;
-  Element.prototype.setAttribute = function(name, value) {
-    const attr = String(name).toLowerCase();
-    if (attr === "src" || attr === "href" || attr === "srcset") {
-      if (!readyResolved) {
-        const pendingValue = String(value);
-        onReady(() => originalSetAttribute.call(this, name, pendingValue));
-        return;
-      }
-      if (attr === "srcset") {
-        const rewritten = rewriteSrcset(String(value));
-        return originalSetAttribute.call(this, name, rewritten);
-      }
-
-      if (!shouldRewriteAttr(this, attr)) {
-        return originalSetAttribute.call(this, name, value);
-      }
-
-      const tag = (this.tagName || "").toLowerCase();
-      const rel = (this.getAttribute && this.getAttribute("rel")) || "";
-      const relLower = rel.toLowerCase();
-       const as = String((this.getAttribute && this.getAttribute("as")) || "").toLowerCase();
-       const fallbackType =
-         attr === "href" && (relLower.includes("stylesheet") || (relLower.includes("preload") && as === "style"))
-           ? "text/css"
-           : undefined;
-
-      const next = rewriteResourceUrl(String(value), {
-        kind: "setAttribute",
-        tag,
-        attr,
-        fallbackType
-      });
-
-      return originalSetAttribute.call(this, name, next);
-    }
-    return originalSetAttribute.call(this, name, value);
-  };
-
-  // Patch property setters (e.g. img.src) so direct assignments are rewritten.
-  const patchProperty = (proto, prop, handler) => {
-    try {
-      const desc = Object.getOwnPropertyDescriptor(proto, prop);
-      if (!desc || !desc.set) return;
-      Object.defineProperty(proto, prop, {
-        configurable: true,
-        get: desc.get,
-        set: function(value) {
-          return handler.call(this, value, desc.set);
-        }
-      });
-    } catch {}
-  };
-
-  patchProperty(HTMLImageElement.prototype, "src", function(value, setter) {
-    const rawValue = String(value);
-    if (!readyResolved) {
-      onReady(() => {
-        const next = rewriteResourceUrl(rawValue, { kind: "setter", tag: "img", attr: "src" });
-        setter.call(this, next);
-      });
-      return;
-    }
-    const next = rewriteResourceUrl(rawValue, { kind: "setter", tag: "img", attr: "src" });
-    setter.call(this, next);
-  });
-
-  patchProperty(HTMLScriptElement.prototype, "src", function(value, setter) {
-    const rawValue = String(value);
-    if (!readyResolved) {
-      onReady(() => {
-        const next = rewriteResourceUrl(rawValue, { kind: "setter", tag: "script", attr: "src" });
-        setter.call(this, next);
-      });
-      return;
-    }
-    const next = rewriteResourceUrl(rawValue, { kind: "setter", tag: "script", attr: "src" });
-    setter.call(this, next);
-  });
-
-   patchProperty(HTMLLinkElement.prototype, "href", function(value, setter) {
-     const rawValue = String(value);
-     const rel = (this.getAttribute && this.getAttribute("rel")) || "";
-     const relLower = rel.toLowerCase();
-     const as = String((this.getAttribute && this.getAttribute("as")) || "").toLowerCase();
-     if (!readyResolved) {
-       onReady(() => {
-         if (
-           !relLower.includes("stylesheet") &&
-           !relLower.includes("icon") &&
-           !relLower.includes("preload") &&
-           !relLower.includes("prefetch") &&
-           !relLower.includes("modulepreload")
-         ) {
-           setter.call(this, rawValue);
-           return;
-         }
-         const fallbackType =
-           relLower.includes("stylesheet") || (relLower.includes("preload") && as === "style")
-             ? "text/css"
-             : undefined;
-         const next = rewriteResourceUrl(rawValue, {
-           kind: "setter",
-           tag: "link",
-           attr: "href",
-           fallbackType
-         });
-         setter.call(this, next);
-       });
-       return;
-     }
-     if (
-       !relLower.includes("stylesheet") &&
-       !relLower.includes("icon") &&
-       !relLower.includes("preload") &&
-       !relLower.includes("prefetch") &&
-       !relLower.includes("modulepreload")
-     ) {
-       setter.call(this, rawValue);
-       return;
-     }
-     const fallbackType =
-       relLower.includes("stylesheet") || (relLower.includes("preload") && as === "style")
-         ? "text/css"
-         : undefined;
-     const next = rewriteResourceUrl(rawValue, {
-       kind: "setter",
-       tag: "link",
-       attr: "href",
-       fallbackType
-     });
-     setter.call(this, next);
-   });
-
-  patchProperty(HTMLImageElement.prototype, "srcset", function(value, setter) {
-    const rawValue = String(value);
-    if (!readyResolved) {
-      onReady(() => {
-        const next = rewriteSrcset(rawValue);
-        setter.call(this, next);
-      });
-      return;
-    }
-    const next = rewriteSrcset(rawValue);
-    setter.call(this, next);
-  });
-
-  // Observe DOM mutations and rewrite any new elements or attributes.
-  const observer = new MutationObserver((mutations) => {
-    for (const mutation of mutations) {
-      if (mutation.type === "attributes" && mutation.target) {
-        rewriteElement(mutation.target);
-      }
-      if (mutation.type === "childList") {
-        mutation.addedNodes.forEach((node) => {
-          if (node && node.nodeType === 1) {
-            rewriteElement(node);
-          }
-        });
-      }
-    }
-  });
-
-  observer.observe(document.documentElement, {
-    attributes: true,
-    childList: true,
-    subtree: true,
-    // Include rel/as so we can rewrite <link> even when href is set before
-    // rel/as (common in some loaders).
-    attributeFilter: ["src", "href", "srcset", "rel", "as"]
-  });
-
-  document.querySelectorAll("img,source,video,audio,script,link,iframe").forEach((el) => rewriteElement(el));
-`
+    build: () => `${replayDomRewriteScriptPart1}${replayDomRewriteScriptPart2}`
 };

package/dist/hackers/replay-svg-image.js

@@ -28,20 +28,41 @@ export const replaySvgImageRewriter = {
     };
 
     const resolveHref = (value) => {
-      if (!value) return null;
-      if (isLocalResource(value)) return value;
+      if (!value) {
+        return undefined;
+      }
+
+      if (isLocalResource(value)) {
+        return value;
+      }
+
       const localPath = findLocalPath(value);
-      if (localPath) return localPath;
+      if (localPath) {
+        return localPath;
+      }
+
       const record = findByUrl(value);
-      if (record) return toDataUrl(record);
+      if (record) {
+        return toDataUrl(record);
+      }
+
       return transparentGif;
     };
 
     const rewriteImage = (el) => {
-      if (!el || !el.getAttribute) return;
+      if (!el || !el.getAttribute) {
+        return;
+      }
+
       const href = el.getAttribute("href") || (el.getAttributeNS && el.getAttributeNS(xlinkNs, "href"));
-      if (!href) return;
-      if (href.startsWith("data:") || href.startsWith("blob:") || isLocalResource(href)) return;
+      if (!href) {
+        return;
+      }
+
+      if (href.startsWith("data:") || href.startsWith("blob:") || isLocalResource(href)) {
+        return;
+      }
+
       if (!readyResolved) {
         try { el.setAttributeNS(xlinkNs, "href", transparentGif); } catch {}
         try { el.setAttribute("href", transparentGif); } catch {}
@@ -49,7 +70,10 @@ export const replaySvgImageRewriter = {
         return;
       }
       const next = resolveHref(href);
-      if (!next) return;
+      if (!next) {
+        return;
+      }
+
       try { el.setAttributeNS(xlinkNs, "href", next); } catch {}
       try { el.setAttribute("href", next); } catch {}
     };

package/dist/hackers/replay-xhr.js

@@ -16,12 +16,12 @@ export const replayXhrResponder = {
     this.__pagepocketUrl = url;
     return originalOpen.call(this, method, url, ...rest);
   };
-  XMLHttpRequest.prototype.send = function(body) {
+   XMLHttpRequest.prototype.send = function(body) {
     const method = this.__pagepocketMethod || "GET";
     const url = this.__pagepocketUrl || "";
     const xhr = this;
-    waitForReady().then(() => {
-      let record = null;
+     waitForReady().then(() => {
+      let record;
       try {
         record = findRecord(method, url, body);
       } catch (err) {

package/dist/path-resolver.js

@@ -40,12 +40,12 @@ export const createDefaultPathResolver = () => {
                 resolvedByUrl.set(input.url, entryPath);
                 return entryPath;
             }
-            let parsed = null;
+            let parsed;
             try {
                 parsed = new URL(input.url);
             }
             catch {
-                parsed = null;
+                parsed = undefined;
             }
             const pathname = normalizePathname(parsed?.pathname || "/");
             const queryHash = `${parsed?.search || ""}${parsed?.hash || ""}`;

package/dist/replace-elements/actions.d.ts

@@ -1,5 +1,5 @@
-import type { Cheerio, CheerioAPI } from "cheerio";
+import type { AnyCheerio, AnyCheerioApi } from "../cheerio/types.js";
 import type { ReplaceAction } from "../types.js";
-export declare const isHtmlElement: ($: CheerioAPI, $el: Cheerio<any>) => boolean;
-export declare const applyReplaceAction: ($: CheerioAPI, $el: Cheerio<any>, action: ReplaceAction) => void;
+export declare const isHtmlElement: ($: AnyCheerioApi, $el: AnyCheerio) => boolean;
+export declare const applyReplaceAction: ($: AnyCheerioApi, $el: AnyCheerio, action: ReplaceAction) => void;
 export declare const tagNameMatches: (el: unknown, expected?: string) => boolean;

package/dist/replace-elements/actions.js

@@ -1,26 +1,42 @@
+const describeReplaceAction = (value) => {
+    if (!value || typeof value !== "object") {
+        return "";
+    }
+    if (!("type" in value)) {
+        return "";
+    }
+    const typeValue = value.type;
+    return typeof typeValue === "string" ? typeValue : String(typeValue ?? "");
+};
 const getNodeName = (el) => {
-    if (!el || typeof el !== "object")
-        return null;
+    if (!el || typeof el !== "object") {
+        return undefined;
+    }
     const name = el.name;
-    return typeof name === "string" ? name : null;
+    return typeof name === "string" ? name : undefined;
 };
 const getNodeType = (el) => {
-    if (!el || typeof el !== "object")
-        return null;
+    if (!el || typeof el !== "object") {
+        return undefined;
+    }
     const type = el.type;
-    return typeof type === "string" ? type : null;
+    return typeof type === "string" ? type : undefined;
 };
 export const isHtmlElement = ($, $el) => {
-    if (!$el || !$el.length)
+    if (!$el || !$el.length) {
         return false;
-    if (!$el.closest("html").length)
+    }
+    if (!$el.closest("html").length) {
         return false;
+    }
     const el = $el.get(0);
-    if (!el)
+    if (!el) {
         return false;
+    }
     const type = getNodeType(el);
-    if (type && type !== "tag")
+    if (type && type !== "tag") {
         return false;
+    }
     return true;
 };
 export const applyReplaceAction = ($, $el, action) => {
@@ -55,9 +71,11 @@ export const applyReplaceAction = ($, $el, action) => {
             const keepChildren = action.keepChildren !== false;
             const next = $(`<${to}></${to}>`);
             if (keepAttributes) {
-                const attrs = ($el.attr() ?? {});
-                for (const [key, value] of Object.entries(attrs)) {
-                    next.attr(key, value);
+                const attrs = $el.attr();
+                if (attrs) {
+                    Object.entries(attrs).forEach(([key, value]) => {
+                        next.attr(key, value);
+                    });
                 }
             }
             if (keepChildren) {
@@ -72,15 +90,17 @@ export const applyReplaceAction = ($, $el, action) => {
         }
         default: {
             const exhaustive = action;
-            throw new Error(`Unknown replace action: ${String(exhaustive?.type ?? "")}`);
+            throw new Error(`Unknown replace action: ${describeReplaceAction(exhaustive)}`);
         }
     }
 };
 export const tagNameMatches = (el, expected) => {
-    if (!expected)
+    if (!expected) {
         return true;
+    }
     const name = getNodeName(el);
-    if (!name)
+    if (!name) {
         return false;
+    }
     return name.toLowerCase() === expected.toLowerCase();
 };

package/dist/replace-elements/match.d.ts

@@ -1,5 +1,5 @@
-import type { Cheerio, CheerioAPI } from "cheerio";
+import type { AnyCheerio, AnyCheerioApi } from "../cheerio/types.js";
 import type { MatchQuery } from "../types.js";
 import { isHtmlElement } from "./actions.js";
-export declare const elementMatchesFilter: ($: CheerioAPI, $el: Cheerio<any>, filter: MatchQuery | null) => boolean;
+export declare const elementMatchesFilter: ($: AnyCheerioApi, $el: AnyCheerio, filter: MatchQuery | undefined) => boolean;
 export { isHtmlElement };

package/dist/replace-elements/match.js

@@ -1,46 +1,57 @@
 import { isHtmlElement, tagNameMatches } from "./actions.js";
 const idMatches = (_$, $el, expected) => {
-    if (!expected)
+    if (!expected) {
         return true;
+    }
     return ($el.attr("id") || "") === expected;
 };
 const attrsMatch = ($el, attrs) => {
-    if (!attrs)
+    if (!attrs) {
         return true;
+    }
     for (const [name, expected] of Object.entries(attrs)) {
         const actual = $el.attr(name);
         if (expected === true) {
-            if (actual === undefined)
+            if (actual === undefined) {
                 return false;
+            }
             continue;
         }
         if (typeof expected === "string") {
-            if (actual !== expected)
+            if (actual !== expected) {
                 return false;
+            }
             continue;
         }
         if (expected instanceof RegExp) {
-            if (actual === undefined)
+            if (actual === undefined) {
                 return false;
-            if (!expected.test(actual))
+            }
+            if (!expected.test(actual)) {
                 return false;
+            }
             continue;
         }
     }
     return true;
 };
 export const elementMatchesFilter = ($, $el, filter) => {
-    if (!filter || typeof filter === "string")
+    if (!filter || typeof filter === "string") {
         return true;
+    }
     const el = $el.get(0);
-    if (!el)
+    if (!el) {
         return false;
-    if (!tagNameMatches(el, filter.tagName))
+    }
+    if (!tagNameMatches(el, filter.tagName)) {
         return false;
-    if (!idMatches($, $el, filter.id))
+    }
+    if (!idMatches($, $el, filter.id)) {
         return false;
-    if (!attrsMatch($el, filter.attrs))
+    }
+    if (!attrsMatch($el, filter.attrs)) {
         return false;
+    }
     return true;
 };
 export { isHtmlElement };

package/dist/replace-elements/normalize.d.ts

@@ -14,7 +14,7 @@ type NormalizedItem = {
 };
 export declare const normalizeMatchToSelector: (match: MatchQuery) => {
     selector: string;
-    filter: MatchQuery | null;
+    filter: MatchQuery | undefined;
 };
 export declare const normalizeReplaceElementsConfig: (replaceElements: ReplaceElementsConfig) => NormalizedItem[];
 export type { NormalizedItem };

package/dist/replace-elements/normalize.js

@@ -3,7 +3,9 @@ const defaultApply = {
     limit: "all",
     onReplaced: "stop"
 };
-const isPlainObject = (value) => typeof value === "object" && value !== null;
+const isPlainObject = (value) => {
+    return typeof value === "object" && value !== null;
+};
 const normalizeApply = (apply) => ({
     scope: apply?.scope ?? defaultApply.scope,
     limit: apply?.limit ?? defaultApply.limit,
@@ -11,7 +13,7 @@ const normalizeApply = (apply) => ({
 });
 export const normalizeMatchToSelector = (match) => {
     if (typeof match === "string") {
-        return { selector: match, filter: null };
+        return { selector: match, filter: undefined };
     }
     return { selector: match.selector ?? "*", filter: match };
 };