@rr0/cms 0.3.66 → 0.3.68

package/dist/CMSGenerator.test.js

@@ -24,6 +24,15 @@ import { PlaceReplacerFactory } from "./place/PlaceReplacerFactory.js";
 import { IndexedReplacerFactory } from "./index/IndexedReplacerFactory.js";
 import { UnitReplaceCommand } from "./value/UnitReplaceCommand.js";
 import { cmsTestUtil } from "./test/CMSTestUtil.js";
+/**
+ * Chronological order: a period's page comes before the pages of its sub-periods ("1960" before "April 1960"),
+ * which a plain sort does not do since "04/index.html" < "index.html".
+ */
+function periodFirst(a, b) {
+    const dirA = a.substring(0, a.lastIndexOf("/") + 1);
+    const dirB = b.substring(0, b.lastIndexOf("/") + 1);
+    return dirA < dirB ? -1 : dirA > dirB ? 1 : 0;
+}
 export async function getTimeFiles() {
     const minusYearFiles = await glob(cmsTestUtil.filePath("time/-?/?/?/?/index.html"));
     const year1Files = await glob(cmsTestUtil.filePath("time/?/index.html"));
@@ -32,7 +41,7 @@ export async function getTimeFiles() {
     const year4Files = await glob(cmsTestUtil.filePath("time/?/?/?/?/index.html"));
     const monthFiles = await glob(cmsTestUtil.filePath("time/?/?/?/?/??/index.html"));
     const dayFiles = await glob(cmsTestUtil.filePath("time/?/?/?/?/??/??/index.html"));
-    return year1Files.concat(year2Files).concat(year3Files).concat(year4Files).concat(minusYearFiles).concat(monthFiles).concat(dayFiles).sort();
+    return year1Files.concat(year2Files).concat(year3Files).concat(year4Files).concat(minusYearFiles).concat(monthFiles).concat(dayFiles).sort(periodFirst);
 }
 describe("Build", () => {
     console.time("ssg");

package/dist/DataContentVisitor.d.ts

@@ -14,6 +14,15 @@ export declare class DataContentVisitor implements ContentVisitor {
     visit(context: HtmlRR0Context): Promise<void>;
     protected process(context: HtmlRR0Context, data: RR0Data): Promise<void>;
     protected processEvent(context: HtmlRR0Context, event: RR0Event, data: RR0Data): Promise<void>;
+    /** Where the UFO@home player that replays a case's sightings is served from. */
+    static readonly SIGHTING_PLAYER_SCRIPT = "https://ufoathome.org/lib/rr0-sighting.mjs";
+    /**
+     * A sighting event of a case points at a witness's recording (its `url`, a UFO@home
+     * `sighting.json`): the page shows them in the UFO@home player, reading the case.json itself so
+     * that every sighting of the case is offered, not only this one. Inserted at the end of the page's
+     * contents, once, and only if the page does not already embed a player where its author put one.
+     */
+    protected processSighting(context: HtmlRR0Context, data: RR0Data): void;
     protected timeParagraph(context: HtmlRR0Context, event: RR0Event): {
         eventP: HTMLParagraphElement;
         timeEl: HTMLElement;

package/dist/DataContentVisitor.js

@@ -46,12 +46,38 @@ export class DataContentVisitor {
             case "death":
                 await this.processDeath(context, event, data);
                 break;
+            case "sighting":
+                this.processSighting(context, data);
+                break;
             default:
                 const { eventP, timeEl } = this.timeParagraph(context, event);
                 await this.eventRenderer.render(context, event, eventP);
                 context.file.document.append(eventP);
         }
     }
+    /**
+     * A sighting event of a case points at a witness's recording (its `url`, a UFO@home
+     * `sighting.json`): the page shows them in the UFO@home player, reading the case.json itself so
+     * that every sighting of the case is offered, not only this one. Inserted at the end of the page's
+     * contents, once, and only if the page does not already embed a player where its author put one.
+     */
+    processSighting(context, data) {
+        const doc = context.file.document;
+        if (data.type !== "case" || doc.querySelector("rr0-sighting")) {
+            return;
+        }
+        const parentEl = doc.querySelector(".contents") || doc.body;
+        if (!parentEl) {
+            context.warn("no .contents to insert the sighting player in", context.file.name);
+            return;
+        }
+        const scriptEl = doc.createElement("script");
+        scriptEl.type = "module";
+        scriptEl.src = DataContentVisitor.SIGHTING_PLAYER_SCRIPT;
+        const playerEl = doc.createElement("rr0-sighting");
+        playerEl.setAttribute("src", "case.json");
+        parentEl.append(scriptEl, playerEl);
+    }
     timeParagraph(context, event) {
         const container = context.file.document.createElement("p");
         const eventContext = context.clone();
@@ -155,3 +181,5 @@ export class DataContentVisitor {
         }
     }
 }
+/** Where the UFO@home player that replays a case's sightings is served from. */
+DataContentVisitor.SIGHTING_PLAYER_SCRIPT = "https://ufoathome.org/lib/rr0-sighting.mjs";

package/dist/DataContentVisitor.test.js

@@ -8,6 +8,9 @@ class TestDataContentVisitor extends DataContentVisitor {
     renderImage(context, event) {
         return this.processImage(context, event);
     }
+    renderEvent(context, event, data) {
+        return this.processEvent(context, event, data);
+    }
 }
 describe("DataContentVisitor", () => {
     const portraitEvent = {
@@ -31,4 +34,27 @@ describe("DataContentVisitor", () => {
         await visitor.renderImage(context, portraitEvent);
         expect(context.file.document.querySelectorAll(".contents img[src=\"portrait.jpg\"]").length).toBe(1);
     });
+    const sightingEvent = { type: "event", eventType: "sighting", url: "sighting.json" };
+    const aCase = { type: "case", events: [sightingEvent] };
+    test("inserts the UFO@home player on the case, for a case with a sighting and no player", async () => {
+        const context = cmsTestUtil.newHtmlContext("people/v/VertongenJeanLuc/index.html", "<div class=\"contents\"><p>Le dossier</p></div>");
+        const visitor = new TestDataContentVisitor();
+        await visitor.renderEvent(context, sightingEvent, aCase);
+        await visitor.renderEvent(context, sightingEvent, aCase);
+        const players = context.file.document.querySelectorAll(".contents > rr0-sighting");
+        expect(players.length).toBe(1);
+        expect(players[0].getAttribute("src")).toBe("case.json");
+        const script = context.file.document.querySelector(".contents > script");
+        expect(script === null || script === void 0 ? void 0 : script.getAttribute("src")).toBe(DataContentVisitor.SIGHTING_PLAYER_SCRIPT);
+        expect(script === null || script === void 0 ? void 0 : script.getAttribute("type")).toBe("module");
+        // Nothing else: no dated paragraph per sighting, which a sighting without a time used to fail the build on.
+        expect(context.file.document.querySelectorAll(".contents > p").length).toBe(1);
+    });
+    test("leaves a player the page's author placed alone", async () => {
+        const context = cmsTestUtil.newHtmlContext("people/v/VertongenJeanLuc/index.html", "<div class=\"contents\"><p>Le dossier</p><rr0-sighting src=\"case.json\" show-witness-map></rr0-sighting></div>");
+        const visitor = new TestDataContentVisitor();
+        await visitor.renderEvent(context, sightingEvent, aCase);
+        expect(context.file.document.querySelectorAll("rr0-sighting").length).toBe(1);
+        expect(context.file.document.querySelectorAll("script").length).toBe(0);
+    });
 });

package/dist/time/TimeLinkDefaultHandler.d.ts

@@ -9,9 +9,16 @@ export declare class TimeLinkDefaultHandler implements LinkHandler<HtmlRR0Contex
     protected urlBuilder: TimeUrlBuilder;
     protected timeTextBuilder: TimeTextBuilder;
     constructor(service: TimeService, urlBuilder: TimeUrlBuilder, timeTextBuilder: TimeTextBuilder);
+    /**
+     * The period containing the page (the year of a month, the month of a day...), which lists it.
+     */
     contents(context: HtmlRR0Context): Link | undefined;
     next(context: HtmlRR0Context): Link | undefined;
     prev(context: HtmlRR0Context): Link | undefined;
     start(context: HtmlRR0Context): Link | undefined;
+    /**
+     * A decade, century or millennium cannot be told from a year by its path's date, so its page's own title is used.
+     */
+    protected titleOf(context: HtmlRR0Context, fileName: string): string | undefined;
     protected isTimeFile(fileName: string): boolean;
 }

package/dist/time/TimeLinkDefaultHandler.js

@@ -1,19 +1,25 @@
 import { LinkType } from "ssg-api";
+import { existsSync, readFileSync } from "fs";
 export class TimeLinkDefaultHandler {
     constructor(service, urlBuilder, timeTextBuilder) {
         this.service = service;
         this.urlBuilder = urlBuilder;
         this.timeTextBuilder = timeTextBuilder;
     }
+    /**
+     * The period containing the page (the year of a month, the month of a day...), which lists it.
+     */
     contents(context) {
-        const prevLink = this.prev(context);
-        if (prevLink) {
-            const urlBuilder = this.urlBuilder;
-            let contentUrl = urlBuilder.matchExistingTimeFile(prevLink.url.substring(1));
-            if (contentUrl != urlBuilder.options.rootDir) {
-                const text = this.service.titleFromFile(context, contentUrl, this.timeTextBuilder);
+        const fileName = context.file.name;
+        if (this.isTimeFile(fileName)) {
+            const pageDir = fileName.substring(0, fileName.lastIndexOf("/"));
+            const parentDir = pageDir.substring(0, pageDir.lastIndexOf("/"));
+            const contentUrl = this.urlBuilder.matchExistingTimeFile(parentDir);
+            if (contentUrl) {
+                const contentFile = contentUrl + "/index.html";
+                const text = this.titleOf(context, contentFile);
                 if (text) {
-                    return { type: LinkType.prev, text, url: "/" + contentUrl };
+                    return { type: LinkType.contents, text, url: "/" + contentFile };
                 }
             }
         }
@@ -26,7 +32,7 @@ export class TimeLinkDefaultHandler {
             if (pos >= 0) {
                 const nextFile = service.files[pos + 1];
                 if (nextFile) {
-                    const text = service.titleFromFile(context, nextFile, this.timeTextBuilder);
+                    const text = this.titleOf(context, nextFile);
                     return { type: LinkType.next, text, url: "/" + nextFile };
                 }
             }
@@ -40,7 +46,7 @@ export class TimeLinkDefaultHandler {
             if (pos >= 0) {
                 const prevFile = service.files[pos - 1];
                 if (prevFile) {
-                    const text = service.titleFromFile(context, prevFile, this.timeTextBuilder);
+                    const text = this.titleOf(context, prevFile);
                     if (text) {
                         return { type: LinkType.prev, text, url: "/" + prevFile };
                     }
@@ -51,13 +57,28 @@ export class TimeLinkDefaultHandler {
     start(context) {
         if (this.isTimeFile(context.file.name)) {
             return {
-                type: LinkType.contents,
+                type: LinkType.start,
                 text: "Chronologie",
                 url: "/time/"
             };
         }
     }
+    /**
+     * A decade, century or millennium cannot be told from a year by its path's date, so its page's own title is used.
+     */
+    titleOf(context, fileName) {
+        var _a;
+        const rootDir = this.urlBuilder.options.rootDir;
+        const digits = fileName.substring(rootDir.length + 1).split("/").length - 1;
+        if (digits < 4 && existsSync(fileName)) {
+            const title = (_a = /<title>([^<]*)<\/title>/.exec(readFileSync(fileName, "utf-8"))) === null || _a === void 0 ? void 0 : _a[1].trim();
+            if (title) {
+                return title;
+            }
+        }
+        return this.service.titleFromFile(context, fileName, this.timeTextBuilder);
+    }
     isTimeFile(fileName) {
-        return fileName.startsWith("time/");
+        return fileName.startsWith(this.urlBuilder.options.rootDir + "/");
     }
 }

package/dist/time/TimeLinkDefaultHandler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/time/TimeLinkDefaultHandler.test.js

@@ -0,0 +1,43 @@
+import { describe, expect, test } from "vitest";
+import { LinkType } from "ssg-api";
+import { cmsTestUtil } from "../test/CMSTestUtil.js";
+import { TimeLinkDefaultHandler } from "./TimeLinkDefaultHandler.js";
+describe("TimeLinkDefaultHandler", () => {
+    const rootDir = cmsTestUtil.filePath("time");
+    const files = [
+        "1/9/5/4/10/index.html",
+        "1/9/7/index.html",
+        "1/9/7/0/index.html",
+        "1/9/7/0/03/index.html",
+        "1/9/7/0/11/index.html",
+        "1/9/9/0/index.html"
+    ].map(file => rootDir + "/" + file);
+    const url = (file) => "/" + rootDir + "/" + file;
+    const timeUtil = cmsTestUtil.time;
+    const service = timeUtil.getService({ rootDir, files });
+    const handler = new TimeLinkDefaultHandler(service, timeUtil.urlBuilder, timeUtil.timeTextBuilder);
+    const context = cmsTestUtil.newHtmlContext("time/1/9/7/0/11/index.html", "<html><body></body></html>");
+    test("start is the chronology", () => {
+        expect(handler.start(context)).toEqual({ type: LinkType.start, text: "Chronologie", url: "/time/" });
+    });
+    test("contents is the period containing the page, not the previous page", () => {
+        const contents = handler.contents(context);
+        expect(contents.type).toBe(LinkType.contents);
+        expect(contents.url).toBe(url("1/9/7/0/index.html"));
+        expect(contents.text).toBe("1970");
+    });
+    test("prev and next follow the files order", () => {
+        expect(handler.prev(context).url).toBe(url("1/9/7/0/03/index.html"));
+        expect(handler.next(context).url).toBe(url("1/9/9/0/index.html"));
+    });
+    test("a decade is titled by its page, not as the year its path starts with", () => {
+        const yearContext = cmsTestUtil.newHtmlContext("time/1/9/7/0/index.html", "<html><body></body></html>");
+        const contents = handler.contents(yearContext);
+        expect(contents.url).toBe(url("1/9/7/index.html"));
+        expect(contents.text).toBe("1970s");
+    });
+    test("a page below a period without page is listed by the nearest one", () => {
+        const dayContext = cmsTestUtil.newHtmlContext("time/1/9/5/4/10/01/index.html", "<html><body></body></html>");
+        expect(handler.contents(dayContext).url).toBe(url("1/9/5/4/10/index.html"));
+    });
+});

package/package.json

@@ -2,7 +2,7 @@
   "name": "@rr0/cms",
   "type": "module",
   "author": "Jérôme Beau <rr0@rr0.org> (https://rr0.org)",
-  "version": "0.3.66",
+  "version": "0.3.68",
   "description": "RR0 Content Management System (CMS)",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",