@rr0/cms 0.3.54 → 0.3.55

package/dist/CMSGenerator.d.ts

@@ -1,5 +1,5 @@
 import { HttpSource, RR0CaseMapping, TimeElementFactory, TimeRenderer, TimeReplacer, TimeService, TimeTextBuilder, TimeUrlBuilder } from "./time/index.js";
-import { CaseFactory } from "./science/crypto/ufo/enquete/dossier/index.js";
+import { CaseDirectoryStep, CaseFactory, CaseService } from "./science/crypto/ufo/enquete/dossier/index.js";
 import { CityService, DepartmentService, OrganizationService } from "./org/index.js";
 import { HtmlRR0Context, RR0ContextImpl } from "./RR0Context.js";
 import { FileWriteConfig, ReplaceCommand } from "ssg-api";
@@ -96,5 +96,8 @@ export declare class CMSGenerator implements CMSContext {
         copies: string[];
     }>;
     private setupNotes;
-    private setupCases;
+    protected setupCases(timeElementFactory: TimeElementFactory): Promise<{
+        caseService: CaseService;
+        ufoCasesStep: CaseDirectoryStep;
+    }>;
 }

package/dist/CMSGenerator.js

@@ -25,6 +25,7 @@ import { GooglePlaceService } from "@rr0/place";
 import { PeopleHtmlRenderer } from "./people/PeopleHtmlRenderer.js";
 import { CountryService } from "./org/country/CountryService.js";
 import { TimeContext } from "./time/TimeContext.mjs";
+import { IndexDirectoryStep } from "./IndexDirectoryStep.js";
 const outputFunc = async (context, outFile) => {
     try {
         if (context.file instanceof HtmlFileContents) {
@@ -146,9 +147,8 @@ export class CMSGenerator {
             outputFunc, fileVisitors: [], contentVisitors: [], force, name: "content includes", toProcess
         };
         const includeStep = new RR0ContentStep(contentStepOptions, timeService);
-        ssg.add(includeStep);
-        ssg.add(ufoCasesStep);
-        ssg.add(...peopleSteps);
+        const defaultDirectoryStep = new IndexDirectoryStep(contentRoots, [], `<ul></ul>`, outputFunc, config);
+        ssg.add(includeStep, ufoCasesStep, ...peopleSteps, defaultDirectoryStep);
         if (contentRoots) {
             const dataContentVisitor = new DataContentVisitor(dataService, caseRenderer, timeElementFactory);
             const contentVisitors = [dataContentVisitor, searchVisitor];

package/dist/IndexDirectoryStep.d.ts

@@ -0,0 +1,39 @@
+import { DirectoryStep, FileWriteConfig, OutputFunc } from "ssg-api";
+import { HtmlRR0Context, RR0Context } from "./RR0Context.js";
+/**
+ * Builds a directory index.
+ */
+export declare class IndexDirectoryStep extends DirectoryStep {
+    protected outputFunc: OutputFunc;
+    /**
+     *
+     * @param rootDirs The directories where UFO cases info can be found.
+     * @param excludedDirs The directories to exclude from the UFO case directory search.
+     * @param templateFileName The template of the directory page to build.
+     * @param outputFunc
+     * @param config
+     */
+    constructor(rootDirs: string[], excludedDirs: string[], templateFileName: string, outputFunc: OutputFunc, config: FileWriteConfig);
+    /**
+     * Convert an array of Case[] to an <ul> HTML unordered list.
+     *
+     * @param context
+     * @param cases
+     */
+    protected toList(context: HtmlRR0Context, cases: any[]): HTMLUListElement;
+    /**
+     * Convert a Case object to an HTML list item.
+     *
+     * @param context
+     * @param dirCase
+     */
+    protected toListItem(context: HtmlRR0Context, dirCase: any): HTMLLIElement;
+    protected processDirs(context: HtmlRR0Context, dirNames: string[]): Promise<void>;
+    /**
+     * Read case JSON files contents and instantiate them as Case objects.
+     *
+     * @param context
+     * @param dirNames The directories to look for case.json files.
+     */
+    protected scan(context: RR0Context, dirNames: string[]): Promise<any[]>;
+}

package/dist/IndexDirectoryStep.js

@@ -0,0 +1,81 @@
+import { DirectoryStep } from "ssg-api";
+import { StringUtil } from "./util/index.js";
+/**
+ * Builds a directory index.
+ */
+export class IndexDirectoryStep extends DirectoryStep {
+    /**
+     *
+     * @param rootDirs The directories where UFO cases info can be found.
+     * @param excludedDirs The directories to exclude from the UFO case directory search.
+     * @param templateFileName The template of the directory page to build.
+     * @param outputFunc
+     * @param config
+     */
+    constructor(rootDirs, excludedDirs, templateFileName, outputFunc, config) {
+        super({ rootDirs, excludedDirs, templateFileName, getOutputPath: config.getOutputPath }, "directory index");
+        this.outputFunc = outputFunc;
+    }
+    /**
+     * Convert an array of Case[] to an <ul> HTML unordered list.
+     *
+     * @param context
+     * @param cases
+     */
+    toList(context, cases) {
+        const listItems = cases.map(dirCase => {
+            if (!dirCase.title) {
+                const lastSlash = dirCase.dirName.lastIndexOf("/");
+                const lastDir = dirCase.dirName.substring(lastSlash + 1);
+                dirCase.title = StringUtil.camelToText(lastDir);
+            }
+            return this.toListItem(context, dirCase);
+        });
+        const ul = context.file.document.createElement("ul");
+        ul.append(...listItems);
+        ul.className = "links";
+        return ul;
+    }
+    /**
+     * Convert a Case object to an HTML list item.
+     *
+     * @param context
+     * @param dirCase
+     */
+    toListItem(context, dirCase) {
+        const item = context.file.document.createElement("li");
+        const ref = document.createElement("a");
+        ref.href = dirCase.dirName + "/";
+        item.appendChild(ref);
+        return item;
+    }
+    async processDirs(context, dirNames) {
+        const cases = await this.scan(context, dirNames);
+        const ul = this.toList(context, cases);
+        const config = this.config;
+        const outputPath = config.getOutputPath(context);
+        const output = context.newOutput(outputPath);
+        output.contents = context.file.contents.replace(`<!--#echo var="directories" -->`, ul.outerHTML);
+        await this.outputFunc(context, output);
+    }
+    /**
+     * Read case JSON files contents and instantiate them as Case objects.
+     *
+     * @param context
+     * @param dirNames The directories to look for case.json files.
+     */
+    async scan(context, dirNames) {
+        const cases = [];
+        for (const dirName of dirNames) {
+            try {
+                const dirCases = dirName;
+                cases.push(...dirCases);
+            }
+            catch (e) {
+                context.warn(`${dirName} has no case.json description`);
+                // No json, just guess title.
+            }
+        }
+        return cases;
+    }
+}

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.54",
+  "version": "0.3.55",
   "description": "RR0 Content Management System (CMS)",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,7 +25,7 @@
     "circular-deps": "dpdm src",
     "prepublishOnly": "npm run build && npm run test-ci",
     "test": "testscript",
-    "test-one": "rm -Rf out && tsx src/people/PeopleReplacer.test.ts",
+    "test-one": "rm -Rf out && tsx src/CMSGenerator.test.ts",
     "test-ci": "rm -Rf out && testscript"
   },
   "dependencies": {
@@ -34,13 +34,13 @@
     "@rr0/data": "^0.3.39",
     "@rr0/lang": "^0.1.12",
     "@rr0/place": "^0.5.3",
-    "@rr0/time": "^0.11.1",
-    "canvas": "^3.2.0",
+    "@rr0/time": "^0.11.2",
+    "canvas": "^3.2.1",
     "csv-parser": "^3.2.0",
     "glob": "^11.0.3",
     "image-size": "^2.0.2",
-    "jsdom": "^27.0.0",
-    "selenium-webdriver": "^4.35.0",
+    "jsdom": "^27.4.0",
+    "selenium-webdriver": "^4.39.0",
     "ssg-api": "^1.17.4"
   },
   "devDependencies": {