@pagepocket/single-file-unit 0.8.6 → 0.9.0

package/dist/single-file/embed-resources.d.ts

@@ -7,5 +7,5 @@ export declare const embedResourcesPathData: (options: {
     inlinePathUrl: (raw: string, context: {
         kind: "attr" | "css";
         selector: string;
-    }) => string | null;
+    }) => string | undefined;
 }) => Promise<void>;

package/dist/single-file/embed-resources.js

@@ -1,6 +1,6 @@
 import { rewriteCssText } from "@pagepocket/lib";
 import { bytesToBase64 } from "@pagepocket/shared";
-import { decodeUtf8OrNull } from "../utils/decode-utf8-or-null.js";
+import { decodeUtf8OrUndefined } from "../utils/decode-utf8-or-undefined.js";
 import { shouldSkipCssValue } from "../utils/should-skip-css-value.js";
 export const embedResourcesPathData = async (options) => {
     const { resourcesPath, bytesByPath, maxInlineBytes, oversizeBehavior, inlinePathUrl } = options;
@@ -16,17 +16,17 @@ export const embedResourcesPathData = async (options) => {
         // If the embedded resource is CSS, inline its url()/@import dependencies so file://
         // replay doesn't attempt to load /... from disk.
         if (item.mimeType === "text/css") {
-            const cssText = decodeUtf8OrNull(bytes);
-            if (cssText !== null) {
+            const cssText = decodeUtf8OrUndefined(bytes);
+            if (cssText) {
                 const rewritten = await rewriteCssText({
                     cssText,
                     cssUrl: item.path,
                     resolveUrl: async (absolute) => {
                         if (shouldSkipCssValue(absolute)) {
-                            return null;
+                            return undefined;
                         }
                         if (!absolute.startsWith("/")) {
-                            return null;
+                            return undefined;
                         }
                         return inlinePathUrl(absolute, {
                             kind: "css",

package/dist/single-file/inline-path-url.d.ts

@@ -6,4 +6,4 @@ export declare const createInlinePathUrl: (options: {
     bytesByPath: Map<string, Uint8Array>;
     maxInlineBytes: number;
     oversizeBehavior: (mimeType?: string) => "error" | "placeholder";
-}) => (raw: string, context: InlinePathUrlContext) => string | null;
+}) => (raw: string, context: InlinePathUrlContext) => string | undefined;

package/dist/single-file/inline-path-url.js

@@ -6,11 +6,11 @@ export const createInlinePathUrl = (options) => {
     return (raw, context) => {
         const value = String(raw || "").trim();
         if (!value.startsWith("/")) {
-            return null;
+            return undefined;
         }
         const bytes = bytesByPath.get(value);
         if (!bytes) {
-            return null;
+            return undefined;
         }
         const inferredMime = lookupMimeTypeFromPath(value);
         if (bytes.byteLength > maxInlineBytes) {
@@ -24,7 +24,7 @@ export const createInlinePathUrl = (options) => {
             if (inferredMime.startsWith("video/") || inferredMime.startsWith("audio/")) {
                 return placeholderSvgDataUrl(`media omitted: ${value}`);
             }
-            return null;
+            return undefined;
         }
         return toDataUrlBase64(inferredMime, bytes);
     };

package/dist/single-file/oversize-behavior.js

@@ -2,14 +2,18 @@ import { parseResourceTypeFromMime } from "../utils/oversize.js";
 export const createOversizeBehavior = (oversize) => {
     return (mimeType) => {
         const type = parseResourceTypeFromMime(mimeType);
-        if (type === "script")
+        if (type === "script") {
             return oversize.script;
-        if (type === "stylesheet")
+        }
+        if (type === "stylesheet") {
             return oversize.stylesheet;
-        if (type === "image")
+        }
+        if (type === "image") {
             return oversize.image;
-        if (type === "media")
+        }
+        if (type === "media") {
             return oversize.media;
+        }
         return "placeholder";
     };
 };

package/dist/single-file/read-snapshot.d.ts

@@ -19,6 +19,6 @@ export type ApiSnapshot = {
     records: unknown[];
 };
 export declare const readIndexHtml: (bytesByPath: Map<string, Uint8Array>) => string;
-export declare const readOptionalApiSnapshot: (bytesByPath: Map<string, Uint8Array>) => ApiSnapshot | null;
+export declare const readOptionalApiSnapshot: (bytesByPath: Map<string, Uint8Array>) => ApiSnapshot | undefined;
 export declare const readResourcesPathSnapshot: (bytesByPath: Map<string, Uint8Array>) => ResourcesPathSnapshot;
 export {};

package/dist/single-file/read-snapshot.js

@@ -1,12 +1,12 @@
-import { decodeUtf8OrNull } from "../utils/decode-utf8-or-null.js";
+import { decodeUtf8OrUndefined } from "../utils/decode-utf8-or-undefined.js";
 export const readIndexHtml = (bytesByPath) => {
     const indexPath = "/index.html";
     const indexBytes = bytesByPath.get(indexPath);
     if (!indexBytes) {
         throw new Error(`SingleFilePlugin requires ${indexPath}`);
     }
-    const indexHtml = decodeUtf8OrNull(indexBytes);
-    if (indexHtml === null) {
+    const indexHtml = decodeUtf8OrUndefined(indexBytes);
+    if (!indexHtml) {
         throw new Error("SingleFilePlugin failed to decode index.html as utf-8");
     }
     return indexHtml;
@@ -14,15 +14,15 @@ export const readIndexHtml = (bytesByPath) => {
 export const readOptionalApiSnapshot = (bytesByPath) => {
     const apiPath = "/api.json";
     const apiBytes = bytesByPath.get(apiPath);
-    const apiJsonText = apiBytes ? decodeUtf8OrNull(apiBytes) : null;
+    const apiJsonText = apiBytes ? decodeUtf8OrUndefined(apiBytes) : undefined;
     if (!apiJsonText) {
-        return null;
+        return undefined;
     }
     try {
         return JSON.parse(apiJsonText);
     }
     catch {
-        return null;
+        return undefined;
     }
 };
 export const readResourcesPathSnapshot = (bytesByPath) => {
@@ -31,16 +31,16 @@ export const readResourcesPathSnapshot = (bytesByPath) => {
     if (!bytes) {
         throw new Error(`SingleFilePlugin requires ${resourcesPathPath}`);
     }
-    const text = decodeUtf8OrNull(bytes);
-    if (text === null) {
+    const text = decodeUtf8OrUndefined(bytes);
+    if (!text) {
         throw new Error("SingleFilePlugin failed to decode resources_path.json as utf-8");
     }
-    let parsed = null;
+    let parsed;
     try {
         parsed = JSON.parse(text);
     }
     catch {
-        parsed = null;
+        parsed = undefined;
     }
     if (!parsed || parsed.version !== "1.0" || !Array.isArray(parsed.items)) {
         throw new Error("SingleFilePlugin got invalid resources_path.json");

package/dist/single-file/rewrite-index-html.d.ts

@@ -3,11 +3,11 @@ export declare const rewriteIndexHtmlToSingleFile: (options: {
     indexHtml: string;
     bytesByPath: Map<string, Uint8Array>;
     resourcesPath: ResourcesPathSnapshot;
-    apiSnapshot: ApiSnapshot | null;
+    apiSnapshot: ApiSnapshot | undefined;
     maxInlineBytes: number;
     oversizeBehavior: (mimeType?: string) => "error" | "placeholder";
     inlinePathUrl: (raw: string, context: {
         kind: "attr" | "css";
         selector: string;
-    }) => string | null;
+    }) => string | undefined;
 }) => Promise<string>;

package/dist/single-file/rewrite-index-html.js

@@ -1,7 +1,7 @@
 import { rewriteCssText } from "@pagepocket/lib";
 import { lookupMimeTypeFromPath } from "@pagepocket/shared";
 import * as cheerio from "cheerio";
-import { decodeUtf8OrNull } from "../utils/decode-utf8-or-null.js";
+import { decodeUtf8OrUndefined } from "../utils/decode-utf8-or-undefined.js";
 import { placeholderSvgDataUrl } from "../utils/placeholder-svg.js";
 import { shouldSkipCssValue } from "../utils/should-skip-css-value.js";
 import { toDataUrlBase64 } from "../utils/to-data-url.js";
@@ -19,7 +19,7 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
     const toSnapshotLocalPath = (absoluteOrPath) => {
         const raw = String(absoluteOrPath || "").trim();
         if (!raw) {
-            return null;
+            return undefined;
         }
         if (raw.startsWith("/")) {
             return raw;
@@ -27,13 +27,13 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
         try {
             const parsed = new URL(raw);
             if (parsed.origin !== CSS_BASE_URL) {
-                return null;
+                return undefined;
             }
             const withSearch = `${parsed.pathname}${parsed.search || ""}`;
-            return withSearch || parsed.pathname || null;
+            return withSearch || parsed.pathname || undefined;
         }
         catch {
-            return null;
+            return undefined;
         }
     };
     const rewriteCssFileToDataUrl = async (cssPath, cssBytes) => {
@@ -44,8 +44,8 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
             }
             return placeholderSvgDataUrl(`stylesheet omitted: ${cssPath}`);
         }
-        const cssText = decodeUtf8OrNull(cssBytes);
-        if (cssText === null) {
+        const cssText = decodeUtf8OrUndefined(cssBytes);
+        if (!cssText) {
             return toDataUrlBase64("text/css", cssBytes);
         }
         const rewritten = await rewriteCssText({
@@ -53,18 +53,18 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
             cssUrl: `${CSS_BASE_URL}${cssPath}`,
             resolveUrl: async (absolute) => {
                 if (shouldSkipCssValue(absolute)) {
-                    return null;
+                    return undefined;
                 }
                 const snapshotPath = toSnapshotLocalPath(absolute);
                 if (!snapshotPath) {
-                    return null;
+                    return undefined;
                 }
                 const mime = lookupMimeTypeFromPath(snapshotPath);
                 const behavior = oversizeBehavior(mime);
                 const bytes = bytesByPath.get(snapshotPath) ??
                     bytesByPath.get(snapshotPath.split("?")[0] || snapshotPath);
                 if (!bytes) {
-                    return null;
+                    return undefined;
                 }
                 if (bytes.byteLength > maxInlineBytes) {
                     if (behavior === "error") {
@@ -76,7 +76,7 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
                     if (mime.startsWith("video/") || mime.startsWith("audio/")) {
                         return placeholderSvgDataUrl(`media omitted: ${snapshotPath}`);
                     }
-                    return null;
+                    return undefined;
                 }
                 return toDataUrlBase64(mime, bytes);
             }
@@ -137,8 +137,9 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
             .split(",")
             .map((part) => {
             const trimmed = part.trim();
-            if (!trimmed)
+            if (!trimmed) {
                 return trimmed;
+            }
             const pieces = trimmed.split(/\s+/, 2);
             const url = pieces[0] || "";
             const descriptor = pieces[1];
@@ -152,14 +153,16 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
     };
     $("img[srcset], source[srcset]").each((_index, element) => {
         const value = $(element).attr("srcset");
-        if (!value)
+        if (!value) {
             return;
+        }
         $(element).attr("srcset", rewriteSrcsetInline(value));
     });
     $("link[imagesrcset]").each((_index, element) => {
         const value = $(element).attr("imagesrcset");
-        if (!value)
+        if (!value) {
             return;
+        }
         $(element).attr("imagesrcset", rewriteSrcsetInline(value));
     });
     const inlineStyleText = async (cssText) => {
@@ -171,11 +174,11 @@ export const rewriteIndexHtmlToSingleFile = async (options) => {
             cssUrl: `${CSS_BASE_URL}/`,
             resolveUrl: async (absolute) => {
                 if (shouldSkipCssValue(absolute)) {
-                    return null;
+                    return undefined;
                 }
                 const snapshotPath = toSnapshotLocalPath(absolute);
                 if (!snapshotPath) {
-                    return null;
+                    return undefined;
                 }
                 return inlinePathUrl(snapshotPath, { kind: "css", selector: "css" });
             }

package/dist/single-file-unit.js

@@ -1,4 +1,5 @@
 import { Unit } from "@pagepocket/lib";
+import { buildSingleFileFiles } from "./single-file/build-single-file-files.js";
 export class SingleFileUnit extends Unit {
     constructor(options) {
         super();
@@ -11,9 +12,6 @@ export class SingleFileUnit extends Unit {
         if (!files) {
             throw new Error("SingleFileUnit requires ctx.value.files");
         }
-        // Single-file transformation is pure with respect to artifacts.
-        // We keep implementation local to this package; it consumes and produces files@1.
-        const { buildSingleFileFiles } = await import("./single-file/build-single-file-files.js");
         const nextFiles = await buildSingleFileFiles({ files, options: this.options });
         return { files: nextFiles };
     }

package/dist/utils/decode-utf8-or-null.d.ts

@@ -1 +1 @@
-export declare const decodeUtf8OrNull: (bytes: Uint8Array) => string | null;
+export declare const decodeUtf8OrNull: (bytes: Uint8Array) => string | undefined;

package/dist/utils/decode-utf8-or-null.js

@@ -1,5 +1,5 @@
 import { decodeUtf8Lenient } from "@pagepocket/shared";
 export const decodeUtf8OrNull = (bytes) => {
     const decoded = decodeUtf8Lenient(bytes);
-    return decoded ? decoded : null;
+    return decoded ? decoded : undefined;
 };

package/dist/utils/decode-utf8-or-undefined.d.ts

@@ -0,0 +1 @@
+export declare const decodeUtf8OrUndefined: (bytes: Uint8Array) => string | undefined;

package/dist/utils/decode-utf8-or-undefined.js

@@ -0,0 +1,5 @@
+import { decodeUtf8Lenient } from "@pagepocket/shared";
+export const decodeUtf8OrUndefined = (bytes) => {
+    const decoded = decodeUtf8Lenient(bytes);
+    return decoded ? decoded : undefined;
+};

package/dist/utils/oversize.d.ts

@@ -6,7 +6,7 @@ declare const defaultOversize: {
 };
 export type OversizeResourceType = keyof typeof defaultOversize;
 export type OversizeBehavior = (typeof defaultOversize)[OversizeResourceType];
-export declare const parseResourceTypeFromMime: (mimeType?: string) => OversizeResourceType | null;
+export declare const parseResourceTypeFromMime: (mimeType?: string) => OversizeResourceType | undefined;
 export declare const defaultOversizeBehavior: {
     readonly script: "error";
     readonly stylesheet: "error";

package/dist/utils/oversize.js

@@ -20,6 +20,6 @@ export const parseResourceTypeFromMime = (mimeType) => {
     if (mime.startsWith("video/") || mime.startsWith("audio/")) {
         return "media";
     }
-    return null;
+    return undefined;
 };
 export const defaultOversizeBehavior = defaultOversize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagepocket/single-file-unit",
-  "version": "0.8.6",
+  "version": "0.9.0",
   "description": "PagePocket plugin: emit strong-offline single-file index.html",
   "type": "module",
   "main": "dist/index.js",
@@ -17,15 +17,16 @@
   "license": "ISC",
   "dependencies": {
     "cheerio": "^1.1.2",
-    "@pagepocket/lib": "0.8.6",
-    "@pagepocket/contracts": "0.8.6",
-    "@pagepocket/shared": "0.8.6"
+    "@pagepocket/lib": "0.9.0",
+    "@pagepocket/contracts": "0.9.0",
+    "@pagepocket/shared": "0.9.0"
   },
   "devDependencies": {
+    "tsx": "^4.21.0",
     "typescript": "^5.4.5"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "test": "node -e \"process.exit(0)\""
+    "test": "tsx --test specs/*.spec.ts"
   }
 }