@jxsuite/import 0.40.9 → 0.40.12

package/src/to-jx.ts

@@ -1,4 +1,5 @@
 import { htmlToJx } from "@jxsuite/markup/html-to-jx";
+import { isString } from "@jxsuite/schema/guards";
 import type { JxElement } from "@jxsuite/schema/types";
 
 export interface ToJxResult {
@@ -39,27 +40,30 @@ export const STRIP_TAGS = new Set([
 ]);
 
 function countNodes(node: JxElement | string): number {
-  if (typeof node === "string") {
+  if (isString(node)) {
     return 0;
   }
   let n = 1;
   if (Array.isArray(node.children)) {
     for (const c of node.children) {
-      n += countNodes(c as JxElement | string);
+      n += countNodes(c);
     }
   }
   return n;
 }
 
-function stripTags(nodes: (JxElement | string)[]): {
+/** A converted subtree with the stripped tags removed, and the inline CSS harvested from them. */
+interface StrippedNodes {
   cleaned: (JxElement | string)[];
   styles: string[];
-} {
+}
+
+function stripTags(nodes: (JxElement | string)[]): StrippedNodes {
   const cleaned: (JxElement | string)[] = [];
   const styles: string[] = [];
 
   for (const node of nodes) {
-    if (typeof node === "string") {
+    if (isString(node)) {
       cleaned.push(node);
       continue;
     }
@@ -69,7 +73,7 @@ function stripTags(nodes: (JxElement | string)[]): {
     // Collect inline <style> content for Phase 1. Style elements hold raw text, which htmlToJx
     // Always collapses into textContent (never string children).
     if (tag === "style") {
-      if (typeof node.textContent === "string") {
+      if (isString(node.textContent)) {
         styles.push(node.textContent);
       }
       continue;
@@ -81,8 +85,8 @@ function stripTags(nodes: (JxElement | string)[]): {
 
     // Recurse into children
     if (Array.isArray(node.children)) {
-      const sub = stripTags(node.children as (JxElement | string)[]);
-      node.children = sub.cleaned as JxElement[];
+      const sub = stripTags(node.children);
+      node.children = sub.cleaned;
       styles.push(...sub.styles);
     }
 
@@ -98,7 +102,7 @@ export function convertToJx(bodyHtml: string): ToJxResult {
 
   const document: JxElement = {
     tagName: "div",
-    children: cleaned as JxElement[],
+    children: cleaned,
   };
 
   return {

package/src/toggle-algebra.ts

@@ -28,6 +28,9 @@
  * rules, which they ship correctly. When the algebra does not close, nothing is rewritten.
  */
 
+import { isString } from "@jxsuite/schema/guards";
+import type { JxAttributeValue } from "@jxsuite/schema/types";
+
 /** A JavaScript identifier, which is what every one of these shapes is built around. */
 const IDENT = String.raw`[A-Za-z_$][A-Za-z0-9_$]*`;
 
@@ -93,7 +96,7 @@ export function classifyToggleValue(
   value: string,
   knownIdents?: ReadonlySet<string>,
 ): ToggleRole | null {
-  if (typeof value !== "string" || value.length === 0) {
+  if (value.length === 0) {
     return null;
   }
 
@@ -141,12 +144,12 @@ export function classifyToggleValue(
  * declaration outranks a toggle, which outranks a predicate, because that is the order in which
  * they identify the node: a root, then a control, then a panel.
  *
- * @param {Record<string, unknown> | undefined} attributes
+ * @param {Record<string, JxAttributeValue> | undefined} attributes
  * @param {ReadonlySet<string>} [knownIdents] - Idents a DECLARE in scope has introduced
  * @returns {ToggleRole | null}
  */
 export function roleOfElement(
-  attributes: Record<string, unknown> | undefined,
+  attributes: Record<string, JxAttributeValue> | undefined,
   knownIdents?: ReadonlySet<string>,
 ): ToggleRole | null {
   if (!attributes) {
@@ -155,7 +158,7 @@ export function roleOfElement(
   const rank = { assign: 1, compare: 2, declare: 0 };
   let best: ToggleRole | null = null;
   for (const value of Object.values(attributes)) {
-    if (typeof value !== "string") {
+    if (!isString(value)) {
       continue;
     }
     const role = classifyToggleValue(value, knownIdents);

package/src/verify.ts

@@ -9,6 +9,7 @@
 
 import { extname, join } from "node:path";
 import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
+import { isFunction } from "@jxsuite/schema/guards";
 import type { Browser, Page } from "puppeteer-core";
 import { launchBrowser, closeBrowser } from "./browser-local.ts";
 import { diffScreenshots } from "./screenshot-diff.ts";
@@ -122,6 +123,11 @@ interface PageDiagnostics {
   failedRequests: string[];
 }
 
+/** The message of a thrown value, which may be any value at all rather than an Error. */
+function describeError(cause: unknown): string {
+  return cause instanceof Error ? cause.message : String(cause);
+}
+
 /**
  * Listen for the two things a fidelity percentage cannot tell you: what the page logged, and what
  * it asked for and did not get.
@@ -132,7 +138,9 @@ interface PageDiagnostics {
  */
 function watchPage(page: Page): PageDiagnostics {
   const diagnostics: PageDiagnostics = { consoleErrors: [], failedRequests: [] };
-  if (typeof (page as Partial<Page>).on !== "function") {
+  /* SAFETY: Widening to Partial<Page> only admits what the doc comment above describes: a stand-in
+     page that screenshots but has no event emitter is passed where a Page is expected. */
+  if (!isFunction((page as Partial<Page>).on)) {
     return diagnostics;
   }
   page.on("console", (msg) => {
@@ -143,7 +151,7 @@ function watchPage(page: Page): PageDiagnostics {
   // `pageerror` carries `Error | unknown`: a page can reject with anything at all, and a thrown
   // String is still a page that broke.
   page.on("pageerror", (error) => {
-    diagnostics.consoleErrors.push(error instanceof Error ? error.message : String(error));
+    diagnostics.consoleErrors.push(describeError(error));
   });
   page.on("requestfailed", (request) => {
     diagnostics.failedRequests.push(`failed ${request.url()}`);
@@ -203,39 +211,44 @@ async function buildProject(projectDir: string): Promise<{ distDir: string; erro
  * will not use a font it was handed as one, which cost the clone fidelity points that were not the
  * importer's fault at all (issue #232).
  */
-const CONTENT_TYPES: Record<string, string> = {
-  ".avif": "image/avif",
-  ".css": "text/css",
-  ".gif": "image/gif",
-  ".htm": "text/html; charset=utf-8",
-  ".html": "text/html; charset=utf-8",
-  ".ico": "image/x-icon",
-  ".jpeg": "image/jpeg",
-  ".jpg": "image/jpeg",
-  ".js": "text/javascript; charset=utf-8",
-  ".json": "application/json; charset=utf-8",
-  ".map": "application/json; charset=utf-8",
-  ".mjs": "text/javascript; charset=utf-8",
-  ".otf": "font/otf",
-  ".png": "image/png",
-  ".svg": "image/svg+xml",
-  ".ttf": "font/ttf",
-  ".txt": "text/plain; charset=utf-8",
-  ".webmanifest": "application/manifest+json",
-  ".webp": "image/webp",
-  ".woff": "font/woff",
-  ".woff2": "font/woff2",
-  ".xml": "application/xml; charset=utf-8",
-};
+const CONTENT_TYPES = new Map<string, string>(
+  Object.entries({
+    ".avif": "image/avif",
+    ".css": "text/css",
+    ".gif": "image/gif",
+    ".htm": "text/html; charset=utf-8",
+    ".html": "text/html; charset=utf-8",
+    ".ico": "image/x-icon",
+    ".jpeg": "image/jpeg",
+    ".jpg": "image/jpeg",
+    ".js": "text/javascript; charset=utf-8",
+    ".json": "application/json; charset=utf-8",
+    ".map": "application/json; charset=utf-8",
+    ".mjs": "text/javascript; charset=utf-8",
+    ".otf": "font/otf",
+    ".png": "image/png",
+    ".svg": "image/svg+xml",
+    ".ttf": "font/ttf",
+    ".txt": "text/plain; charset=utf-8",
+    ".webmanifest": "application/manifest+json",
+    ".webp": "image/webp",
+    ".woff": "font/woff",
+    ".woff2": "font/woff2",
+    ".xml": "application/xml; charset=utf-8",
+  }),
+);
+
+/** A running static server and the origin it answers on. */
+export interface ServedDirectory {
+  server: ReturnType<typeof Bun.serve>;
+  baseUrl: string;
+}
 
 /**
  * Serve a directory over HTTP using Bun's built-in server. Returns the server instance and the base
  * URL.
  */
-export function serveDirectory(dir: string): {
-  server: ReturnType<typeof Bun.serve>;
-  baseUrl: string;
-} {
+export function serveDirectory(dir: string): ServedDirectory {
   const server = Bun.serve({
     port: 0,
     async fetch(req) {
@@ -250,7 +263,7 @@ export function serveDirectory(dir: string): {
       const file = Bun.file(filePath);
       if (await file.exists()) {
         const contentType =
-          CONTENT_TYPES[extname(filePath).toLowerCase()] ?? "application/octet-stream";
+          CONTENT_TYPES.get(extname(filePath).toLowerCase()) ?? "application/octet-stream";
         return new Response(file, { headers: { "Content-Type": contentType } });
       }
       return new Response("Not Found", { status: 404 });
@@ -302,7 +315,7 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
       onProgress(`  Build completed with ${buildErrors.length} error(s)`);
     }
   } catch (error) {
-    const err = error as Error;
+    const message = describeError(error);
     return {
       pages: [...pages.entries()].map(([route, ref]) => ({
         route,
@@ -315,11 +328,11 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
         renderedScreenshotPath: "",
         consoleErrors: [],
         failedRequests: [],
-        error: `Build failed: ${err.message}`,
+        error: `Build failed: ${message}`,
       })),
       averageFidelity: 0,
       reportDir,
-      buildErrors: [`Build failed: ${err.message}`],
+      buildErrors: [`Build failed: ${message}`],
       passed: false,
     };
   }
@@ -392,8 +405,8 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
           failedRequests: diagnostics.failedRequests,
         });
       } catch (error) {
-        const err = error as Error;
-        onProgress(`    Error: ${err.message}`);
+        const message = describeError(error);
+        onProgress(`    Error: ${message}`);
         results.push({
           route,
           sourceUrl: ref.sourceUrl,
@@ -405,7 +418,7 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
           renderedScreenshotPath: "",
           consoleErrors: [],
           failedRequests: [],
-          error: err.message,
+          error: message,
         });
       }
     }
@@ -430,7 +443,7 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
      */
     const errored = results.filter((r) => r.error);
     const passed =
-      (buildErrors ?? []).length === 0 && errored.length === 0 && averageFidelity >= minFidelity;
+      buildErrors.length === 0 && errored.length === 0 && averageFidelity >= minFidelity;
 
     const report = {
       timestamp: new Date().toISOString(),
@@ -443,7 +456,7 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
       averageFidelity,
       passed,
       pages: results,
-      buildErrors: buildErrors ?? [],
+      buildErrors,
     };
     writeFileSync(join(reportDir, "report.json"), JSON.stringify(report, null, 2));
 
@@ -451,7 +464,7 @@ export async function verifyProject(opts: VerifyOptions): Promise<VerifyResult>
       pages: results,
       averageFidelity,
       reportDir,
-      buildErrors: buildErrors ?? [],
+      buildErrors,
       passed,
     };
   } finally {