@rr0/cms 0.3.65 → 0.3.67

package/dist/CMSGenerator.d.ts

@@ -130,6 +130,12 @@ export declare class CMSGenerator implements CMSContext {
         timeElementFactory: TimeElementFactory;
         timeReplacer: TimeReplacer;
     };
+    /**
+     * The other names each people's page can be searched by — their pseudonyms and their surnames, the latter said as
+     * "<surname> <lastName>" so that a surname alone doesn't leave the reader guessing whose it is. Keyed by page URL,
+     * the people's own page only: their other pages (a CV, say) are not that person's name.
+     */
+    protected peopleNames(peopleService: PeopleService): Promise<Map<string, string[]>>;
     protected setupPeople(context: RR0ContextImpl, peopleRenderer: PeopleHtmlRenderer, copies: string[]): Promise<{
         peopleService: PeopleService;
         peopleSteps: import("./index.js").PeopleDirectoryStep[];

package/dist/CMSGenerator.js

@@ -243,7 +243,8 @@ export class CMSGenerator {
         }
         const reindex = args.reindex;
         if (reindex === null || reindex === void 0 ? void 0 : reindex.includes("search")) {
-            ssg.add(new SearchIndexStep("search/index.json", searchVisitor, outDir, (context, fileName) => timeService.setContextFromFile(context, fileName)));
+            const peopleNames = await this.peopleNames(peopleService);
+            ssg.add(new SearchIndexStep("search/index.json", searchVisitor, outDir, (context, fileName) => timeService.setContextFromFile(context, fileName), url => peopleNames.get(url) || []));
         }
         if (reindex === null || reindex === void 0 ? void 0 : reindex.includes("sources")) {
             ssg.add(new SourceIndexStep(this.options.sourceRegistryFileName, sourceFactory));
@@ -288,6 +289,25 @@ export class CMSGenerator {
         const timeReplacer = new TimeReplacer(timeElementFactory);
         return { timeFiles, timeElementFactory, timeReplacer };
     }
+    /**
+     * The other names each people's page can be searched by — their pseudonyms and their surnames, the latter said as
+     * "<surname> <lastName>" so that a surname alone doesn't leave the reader guessing whose it is. Keyed by page URL,
+     * the people's own page only: their other pages (a CV, say) are not that person's name.
+     */
+    async peopleNames(peopleService) {
+        const namesByUrl = new Map();
+        for (const people of await peopleService.getAll()) {
+            const lastName = people.lastName;
+            const names = [
+                ...people.pseudonyms,
+                ...(lastName ? people.surnames.map(surname => `${surname} ${lastName}`) : [])
+            ];
+            if (names.length > 0 && people.dirName) {
+                namesByUrl.set(`${people.dirName}/index.html`, names);
+            }
+        }
+        return namesByUrl;
+    }
     async setupPeople(context, peopleRenderer, copies) {
         const peopleFiles = await this.peopleFactory.getFiles();
         const peopleService = new PeopleService(this.dataService, this.peopleFactory, { files: peopleFiles, rootDir: "people" });

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/search/SearchComponent.mjs

@@ -9,7 +9,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _SearchComponent_instances, _SearchComponent_siteIndex, _SearchComponent_loading, _SearchComponent_maxResultCount, _SearchComponent_siteSearchChange, _SearchComponent_siteSearchLoad, _SearchComponent_setDataList;
+var _SearchComponent_instances, _SearchComponent_siteIndex, _SearchComponent_entries, _SearchComponent_loading, _SearchComponent_maxResultCount, _SearchComponent_siteSearchChange, _SearchComponent_siteSearchLoad, _SearchComponent_setDataList;
 const template = document.createElement("template");
 const html = `
 <input id="search-input" list="values" type="search" part="input">
@@ -32,6 +32,13 @@ export class SearchComponent extends HTMLElement {
          * @type SearchIndex
          */
         _SearchComponent_siteIndex.set(this, void 0);
+        /**
+         * One searchable entry per name: a page's title, plus each of the other names it is known by. A datalist filters on
+         * its options' own text, so a surname or a pseudonym is only reachable when it IS an option.
+         *
+         * @type {{label: string, url: string}[]}
+         */
+        _SearchComponent_entries.set(this, []);
         _SearchComponent_loading.set(this, false
         /**
          * @readonly
@@ -69,19 +76,17 @@ export class SearchComponent extends HTMLElement {
         this.placeholder = "Recherche";
     }
 }
-_SearchComponent_siteIndex = new WeakMap(), _SearchComponent_loading = new WeakMap(), _SearchComponent_maxResultCount = new WeakMap(), _SearchComponent_instances = new WeakSet(), _SearchComponent_siteSearchChange = function _SearchComponent_siteSearchChange(e) {
-    var _a;
+_SearchComponent_siteIndex = new WeakMap(), _SearchComponent_entries = new WeakMap(), _SearchComponent_loading = new WeakMap(), _SearchComponent_maxResultCount = new WeakMap(), _SearchComponent_instances = new WeakSet(), _SearchComponent_siteSearchChange = function _SearchComponent_siteSearchChange(e) {
     const value = e.target.value.trim();
-    const pages = ((_a = __classPrivateFieldGet(this, _SearchComponent_siteIndex, "f")) === null || _a === void 0 ? void 0 : _a.pages) || [];
+    const entries = __classPrivateFieldGet(this, _SearchComponent_entries, "f");
     if (e.inputType === "insertReplacementText" || e.inputType == null) {
-        const pageIndex = pages.findIndex(page => page.title === value);
-        if (pageIndex >= 0) {
-            const page = pages[pageIndex];
-            window.location.href = "/" + page.url;
+        const entry = entries.find(entry => entry.label === value);
+        if (entry) {
+            window.location.href = "/" + entry.url;
         }
     }
     const lowValue = value.toLowerCase();
-    const dataList = pages.filter(page => page.title.toLowerCase().indexOf(lowValue) >= 0);
+    const dataList = entries.filter(entry => entry.label.toLowerCase().indexOf(lowValue) >= 0);
     __classPrivateFieldGet(this, _SearchComponent_instances, "m", _SearchComponent_setDataList).call(this, dataList.length <= __classPrivateFieldGet(this, _SearchComponent_maxResultCount, "f") ? dataList : []);
 }, _SearchComponent_siteSearchLoad = function _SearchComponent_siteSearchLoad() {
     if (!__classPrivateFieldGet(this, _SearchComponent_siteIndex, "f") && !__classPrivateFieldGet(this, _SearchComponent_loading, "f")) {
@@ -89,22 +94,27 @@ _SearchComponent_siteIndex = new WeakMap(), _SearchComponent_loading = new WeakM
         fetch("/search/index.json").then(async (response) => {
             if (response.ok) {
                 __classPrivateFieldSet(this, _SearchComponent_siteIndex, await response.json(), "f");
+                const entries = [];
                 for (const page of __classPrivateFieldGet(this, _SearchComponent_siteIndex, "f").pages) {
                     const timeStr = page.time;
                     const title = page.title;
                     page.title += (timeStr && timeStr !== title.toLowerCase() ? ` (${timeStr})` : "");
+                    entries.push({ label: page.title, url: page.url });
+                    for (const name of page.names || []) {
+                        entries.push({ label: name, url: page.url });
+                    }
                 }
+                __classPrivateFieldSet(this, _SearchComponent_entries, entries, "f");
             }
             __classPrivateFieldSet(this, _SearchComponent_loading, false, "f");
         });
     }
-}, _SearchComponent_setDataList = function _SearchComponent_setDataList(pages) {
+}, _SearchComponent_setDataList = function _SearchComponent_setDataList(entries) {
     const datalist = this.shadow.getElementById("values");
     datalist.innerHTML = "";
-    for (let i = 0; i < pages.length; i++) {
-        const page = pages[i];
+    for (let i = 0; i < entries.length; i++) {
         const option = document.createElement("option");
-        option.value = page.title;
+        option.value = entries[i].label;
         datalist.append(option);
     }
 };

package/dist/search/SearchIndexStep.d.ts

@@ -9,12 +9,16 @@ export declare class SearchIndexStep implements SsgStep {
     protected searchCommand: SearchVisitor;
     protected contentRoot?: string;
     protected prepareContext?: (context: HtmlRR0Context, fileName: string) => void;
+    protected alternateNames?: (url: string) => string[];
     protected encoding: BufferEncoding;
     /**
      * @param fileName The index file path
      * @param searchCommand The command that collected the pages info.
+     * @param contentRoot
+     * @param prepareContext
+     * @param alternateNames Other names a page can be searched by, such as a people's surnames and pseudonyms.
      */
-    constructor(fileName: string, searchCommand: SearchVisitor, contentRoot?: string, prepareContext?: (context: HtmlRR0Context, fileName: string) => void);
+    constructor(fileName: string, searchCommand: SearchVisitor, contentRoot?: string, prepareContext?: (context: HtmlRR0Context, fileName: string) => void, alternateNames?: (url: string) => string[]);
     /**
      * Write the search index file.
      *

package/dist/search/SearchIndexStep.js

@@ -10,12 +10,16 @@ export class SearchIndexStep {
     /**
      * @param fileName The index file path
      * @param searchCommand The command that collected the pages info.
+     * @param contentRoot
+     * @param prepareContext
+     * @param alternateNames Other names a page can be searched by, such as a people's surnames and pseudonyms.
      */
-    constructor(fileName, searchCommand, contentRoot, prepareContext) {
+    constructor(fileName, searchCommand, contentRoot, prepareContext, alternateNames) {
         this.fileName = fileName;
         this.searchCommand = searchCommand;
         this.contentRoot = contentRoot;
         this.prepareContext = prepareContext;
+        this.alternateNames = alternateNames;
         this.encoding = "utf8";
     }
     /**
@@ -24,7 +28,7 @@ export class SearchIndexStep {
      * @param context
      */
     async execute(context) {
-        var _a;
+        var _a, _b;
         const newIndex = this.searchCommand.index;
         let existingIndex;
         if (this.contentRoot) {
@@ -45,7 +49,8 @@ export class SearchIndexStep {
                 const titleMatch = /<title[^>]*>([\s\S]*?)<\/title>/i.exec(html);
                 const outputTitle = titleMatch ? this.decodeTitle(titleMatch[1]) : "";
                 const title = this.readSourceTitle(sourceFile) || outputTitle;
-                const pageInfo = this.searchCommand.pageInfoFrom(title, url.split(path.sep).join("/"), pageContext);
+                const pageUrl = url.split(path.sep).join("/");
+                const pageInfo = this.searchCommand.pageInfoFrom(title, pageUrl, pageContext, (_b = this.alternateNames) === null || _b === void 0 ? void 0 : _b.call(this, pageUrl));
                 if (pageInfo) {
                     const resultTitle = SearchVisitor.resultTitle(pageInfo);
                     const titleIndexed = pagesByResultTitle.get(resultTitle);

package/dist/search/SearchVisitor.d.ts

@@ -7,6 +7,10 @@ export type PageInfo = {
     title: string;
     url: string;
     time: string;
+    /**
+     * Other names the page can be searched by, such as a people's surnames and pseudonyms.
+     */
+    names?: string[];
     html?: string;
 };
 type WordCount = {
@@ -37,7 +41,7 @@ export declare class SearchVisitor implements FileVisitor {
     contentStepEnd(): Promise<void>;
     visit(context: HtmlRR0Context): Promise<void>;
     pageInfo(context: HtmlRR0Context, contentRoot?: string): PageInfo | undefined;
-    pageInfoFrom(title: string, url: string, context: HtmlRR0Context): PageInfo | undefined;
+    pageInfoFrom(title: string, url: string, context: HtmlRR0Context, names?: string[]): PageInfo | undefined;
     protected handleAlreadyIndexed(resultTitle: string, url: string, titleIndexed: PageInfo): void;
     protected getContents(doc: Document): string;
     protected indexContent(context: HtmlRR0Context, outputFile: HtmlFileContents): void;

package/dist/search/SearchVisitor.js

@@ -59,12 +59,17 @@ export class SearchVisitor {
             : file.name.startsWith("out/") ? file.name.substring("out/".length) : file.name;
         return this.pageInfoFrom(file.title, url, context);
     }
-    pageInfoFrom(title, url, context) {
+    pageInfoFrom(title, url, context, names = []) {
         if (!title || this.config.notIndexedUrls.includes(url)) {
             return undefined;
         }
         const time = this.timeTextBuilder.build(context, { year: "numeric", month: "short", day: "numeric" }).toLowerCase();
-        return { title, url, time };
+        const pageInfo = { title, url, time };
+        const otherNames = Array.from(new Set(names.filter(name => name && name !== title)));
+        if (otherNames.length > 0) {
+            pageInfo.names = otherNames;
+        }
+        return pageInfo;
     }
     handleAlreadyIndexed(resultTitle, url, titleIndexed) {
         throw new Error(`Search result "${resultTitle}" with URL ${url} is already indexed with URL ${titleIndexed.url}`);

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