@rr0/cms 0.3.66 → 0.3.67

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/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.67",
   "description": "RR0 Content Management System (CMS)",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",