nnw-theme 2.3.0 → 2.4.0

package/dist/render.js

@@ -3,6 +3,7 @@ import { mkdirSync, readFileSync, realpathSync, rmSync, statSync, writeFileSync,
 import { extname, isAbsolute, join, relative } from "node:path";
 import { decodeHTML } from "entities";
 import { Parser } from "htmlparser2";
+import { DELIVERIES, DELIVERY_NAMES, deliver } from "./delivery.js";
 import { enclosuresHTML, fixtureAttachments, fixtureImageURL, placeEnclosures, } from "./enclosures.js";
 import { renderingInputs } from "./netnewswire.js";
 import { fixturePath, readFixture, repositoryFixtures, ThemeError, themeStem, } from "./project.js";
@@ -156,7 +157,9 @@ export class RenderTarget {
     olderNetNewsWire;
     /** A 2x capture of the card viewport alone, for the marketplace card. */
     card;
-    constructor(fixture, platform, appearance, { largeText = false, themeScripts = true, olderNetNewsWire = false, card = false } = {}) {
+    /** The sync service the article arrives through, rewritten as it delivers it. */
+    delivery;
+    constructor(fixture, platform, appearance, { largeText = false, themeScripts = true, olderNetNewsWire = false, card = false, delivery = undefined, } = {}) {
         this.fixture = fixture;
         this.platform = platform;
         this.appearance = appearance;
@@ -165,6 +168,7 @@ export class RenderTarget {
         this.themeScripts = themeScripts;
         this.olderNetNewsWire = olderNetNewsWire;
         this.card = card;
+        this.delivery = delivery;
     }
     get ios() {
         return this.platform === "iphone" || this.platform === "ipad";
@@ -181,6 +185,8 @@ export class RenderTarget {
             parts.push("Article JavaScript off");
         if (this.olderNetNewsWire)
             parts.push("older NetNewsWire");
+        if (this.delivery)
+            parts.push(`via ${DELIVERY_NAMES[this.delivery]}`);
         if (this.card)
             parts.push("card");
         return parts.join(" · ");
@@ -192,6 +198,8 @@ export class RenderTarget {
             return "article-javascript-off";
         if (this.olderNetNewsWire)
             return "older-netnewswire";
+        if (this.delivery)
+            return `${this.fixture} via ${DELIVERY_NAMES[this.delivery]}`;
         return this.fixture;
     }
     get slug() {
@@ -202,6 +210,8 @@ export class RenderTarget {
             parts.push("no-article-js");
         if (this.olderNetNewsWire)
             parts.push("older-netnewswire");
+        if (this.delivery)
+            parts.push(this.delivery);
         if (this.card)
             parts.push("card");
         return parts.join("-");
@@ -216,32 +226,67 @@ export function extraFixtures(root) {
     }
     return extras;
 }
-export function normalTargets(extras = []) {
+/** A fixture's deliveries = [...] key, validated: the services to also render it through. */
+export function fixtureDeliveries(fixture, name) {
+    const value = fixture.deliveries;
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value) ||
+        !value.every((item) => DELIVERIES.includes(item)) ||
+        new Set(value).size !== value.length) {
+        throw new ThemeError(`${name}: deliveries must list distinct services from ${DELIVERIES.join(", ")}`);
+    }
+    return value;
+}
+/**
+ * Each fixture's deliveries = [...], for those that list any. fixtures are the names
+ * to read: the template's own and the extras.
+ */
+export function readDeliveries(root, fixtures) {
+    const result = {};
+    for (const name of fixtures) {
+        const deliveries = fixtureDeliveries(readFixture(fixturePath(root, name)), `fixtures/${name}.toml`);
+        if (deliveries.length)
+            result[name] = deliveries;
+    }
+    return result;
+}
+/** The fixtures a repository renders: the template's own, then its extras. */
+export function allFixtures(extras) {
+    return [...Object.keys(FIXTURE_NAMES), ...extras];
+}
+/**
+ * Every fixture's matrix. A fixture that lists deliveries is also rendered through
+ * each service, on Mac in light and iPhone in dark, right after its own cases.
+ */
+export function normalTargets(extras = [], deliveries = {}) {
     const targets = [];
-    for (const fixture of Object.keys(FIXTURE_NAMES)) {
-        for (const platform of PLATFORMS) {
+    for (const fixture of allFixtures(extras)) {
+        const platforms = fixture in FIXTURE_NAMES ? PLATFORMS : EXTRA_PLATFORMS;
+        for (const platform of platforms) {
             for (const appearance of APPEARANCES) {
                 targets.push(new RenderTarget(fixture, platform, appearance));
             }
         }
-    }
-    for (const fixture of extras) {
-        for (const platform of EXTRA_PLATFORMS) {
-            for (const appearance of APPEARANCES) {
-                targets.push(new RenderTarget(fixture, platform, appearance));
-            }
+        for (const delivery of deliveries[fixture] ?? []) {
+            targets.push(new RenderTarget(fixture, "mac", "light", { delivery }), new RenderTarget(fixture, "iphone", "dark", { delivery }));
         }
     }
     return targets;
 }
+/** A repository's normal matrix, including each fixture's deliveries. */
+export function repositoryTargets(root) {
+    const extras = extraFixtures(root);
+    return normalTargets(extras, readDeliveries(root, allFixtures(extras)));
+}
 /**
  * Everything check renders. A template that places [[enclosures]] itself also gets
  * the older-NetNewsWire cases, since releases before enclosure support leave that
  * macro as text in every article.
  */
-export function checkTargets(extras = [], { enclosuresMacro = false } = {}) {
+export function checkTargets(extras = [], { enclosuresMacro = false, deliveries = {} } = {}) {
     const targets = [
-        ...normalTargets(extras),
+        ...normalTargets(extras, deliveries),
         new RenderTarget("kitchen-sink", "mac", "light", { largeText: true }),
         new RenderTarget("kitchen-sink", "iphone", "light", { largeText: true }),
         new RenderTarget("article", "mac", "light", { themeScripts: false }),
@@ -411,7 +456,9 @@ function fixtureMapping(fixture, target, template, media) {
     if (!mapping.dateline_style) {
         mapping.dateline_style = mapping.title ? "articleDateline" : "articleDatelineTitle";
     }
-    const body = mapping.body ?? "";
+    let body = mapping.body ?? "";
+    if (target.delivery)
+        body = deliver(body, target.delivery, mapping.preferred_link ?? "");
     mapping.body = offlineMedia(body, media);
     // NetNewsWire before enclosure support ignores attachments and leaves the macro.
     if (!target.olderNetNewsWire) {
@@ -486,6 +533,42 @@ function isFile(path) {
         return false;
     }
 }
+/**
+ * Article.baseURL, made absolute as NetNewsWire does: no fragment, and nothing unless
+ * http or https.
+ */
+export function articleBaseURL(value) {
+    let url;
+    try {
+        url = new URL(value);
+    }
+    catch {
+        return "";
+    }
+    if (url.protocol !== "http:" && url.protocol !== "https:")
+        return "";
+    url.hash = "";
+    return url.href;
+}
+/**
+ * The page's base URL: the fixture's base_url when it gives one, else its link. An
+ * article synced through the Reader API (FreshRSS, Miniflux, Inoreader) has only an
+ * external link, so NetNewsWire falls back to the feed's home page: a delivered case
+ * uses feed_link, unless base_url gives the home page the service reports instead.
+ */
+function pageBaseURL(fixture, target) {
+    const name = `fixtures/${target.fixture}.toml`;
+    const baseURL = fixture.base_url;
+    if (baseURL !== undefined && typeof baseURL !== "string") {
+        throw new ThemeError(`${name}: base_url must be a string`);
+    }
+    if (baseURL !== undefined)
+        return articleBaseURL(baseURL);
+    if (target.delivery && typeof fixture.feed_link === "string" && fixture.feed_link) {
+        return articleBaseURL(fixture.feed_link);
+    }
+    return pyStr(fixture.preferred_link || fixture.feed_link || "");
+}
 export function renderPage(theme, fixture, target, snapshot = renderingInputs().path, media) {
     const pagePath = join(snapshot, target.ios ? "iOS" : "Mac", "page.html");
     const required = [
@@ -513,7 +596,7 @@ export function renderPage(theme, fixture, target, snapshot = renderingInputs().
         title: fixture.title ?? "Theme preview",
         style,
         body,
-        baseURL: fixture.preferred_link || fixture.feed_link || "",
+        baseURL: pageBaseURL(fixture, target),
         windowScrollY: "0",
     });
     page = injectScripts(page, snapshot, target.platform);
@@ -603,7 +686,18 @@ export function writeGallery(site, themeName, targets, results = null) {
     const known = new Set(RESERVED_FIXTURE_NAMES);
     const scenarios = new Map(SCENARIOS.map(([scenario, heading, text]) => [scenario, [heading, text]]));
     for (const target of targets) {
-        if (!known.has(target.scenario) && !scenarios.has(target.scenario)) {
+        if (known.has(target.scenario) || scenarios.has(target.scenario))
+            continue;
+        if (target.delivery) {
+            const service = DELIVERY_NAMES[target.delivery];
+            scenarios.set(target.scenario, [
+                target.scenario,
+                `fixtures/${target.fixture}.toml as ${service} delivers it through the Reader ` +
+                    `API: its body rewritten by ${service}'s sanitizer, and the feed's home page ` +
+                    "as the page's base URL.",
+            ]);
+        }
+        else {
             scenarios.set(target.scenario, [target.fixture, `Your fixtures/${target.fixture}.toml.`]);
         }
     }

package/lldb/nnwdump.py

@@ -8,7 +8,9 @@ NetNewsWire with enclosure support renders an article's enclosures into that
 dictionary: as `enclosures`, or appended to a wrapped `body` when the template has no
 [[enclosures]] macro. nnwdump keeps neither. It records the article's attachments
 and image instead, as [[attachments]] tables and image_url/thumbnail_url, so nnw-theme
-renders them for whichever template previews the fixture.
+renders them for whichever template previews the fixture. When the page's base URL
+differs from the article's link, as for an article synced through the Reader API, it
+also records base_url.
 
 Values cross the debugger boundary base64-encoded, so nothing is truncated or
 mis-escaped. HTML values are written as '''literal''' strings, so fixtures stay
@@ -103,6 +105,12 @@ def attachments_from_json(text: str) -> list[dict]:
     return tables
 
 
+def base_url_pairs(pairs: list[tuple[str, str]], base_url: str) -> list[tuple[str, str]]:
+    """base_url, when the rendered page's base differs from preferred_link."""
+    preferred = dict(pairs).get("preferred_link", "")
+    return [] if base_url == preferred else [("base_url", base_url)]
+
+
 def _toml_value_line(key: str, value) -> str:
     if isinstance(value, bool) or not isinstance(value, int):
         return toml_line(key, str(value))
@@ -194,6 +202,10 @@ def nnwdump(debugger, command, result, internal_dict):
         value, _ = _evaluate(interpreter, f'{options.article}.{link} ?? ""')
         if value:
             pairs.append((key, value))
+    # The renderer's own base: the article's link, else the feed's home page.
+    base_url, _ = _evaluate(interpreter, 'self.baseURL?.absoluteString ?? ""')
+    if base_url is not None:
+        pairs.extend(base_url_pairs(pairs, base_url))
 
     note = ""
     if attachments:

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nnw-theme",
-	"version": "2.3.0",
+	"version": "2.4.0",
 	"description": "Create, preview, check, and publish a NetNewsWire theme.",
 	"license": "Apache-2.0",
 	"author": "Dave Marquard",