@ca-plant-list/ca-plant-list 0.3.6 → 0.4.0

package/lib/ebook/images.js

@@ -3,88 +3,105 @@ import path from "node:path";
 
 import sharp from "sharp";
 
-import { Config, CSV, Files } from "@ca-plant-list/ca-plant-list";
-
-import { Image } from "./image.js";
 import { EBook } from "./ebook.js";
-import { Taxa } from "../taxa.js";
+import { Config } from "../config.js";
+import { CSV } from "../csv.js";
+import { Files } from "../files.js";
+import { TaxonImage } from "./taxonimage.js";
 
 class Images {
-
     #siteGenerator;
     #contentDir;
     #taxa;
+    /** @type {Object<string,TaxonImage[]>} */
     #images = {};
 
-    constructor( siteGenerator, contentDir, taxa ) {
+    /**
+     * @param {SiteGenerator} siteGenerator
+     * @param {string} contentDir
+     * @param {Taxa} taxa
+     */
+    constructor(siteGenerator, contentDir, taxa) {
         this.#siteGenerator = siteGenerator;
         this.#contentDir = contentDir;
         this.#taxa = taxa;
     }
 
     async createImages() {
-
         const photoDirSrc = "external_data/photos";
         const imagePrefix = "i";
         const photoDirTarget = this.#contentDir + "/" + imagePrefix;
-        fs.mkdirSync( photoDirSrc, { recursive: true } );
-        fs.mkdirSync( photoDirTarget, { recursive: true } );
-
-        const rows = CSV.parseFile( Config.getPackageDir() + "/data", "photos.csv" );
-        for ( const row of rows ) {
-
-            const name = row[ "taxon_name" ];
-            const taxon = this.#taxa.getTaxon( name );
-            if ( !taxon ) {
+        fs.mkdirSync(photoDirSrc, { recursive: true });
+        fs.mkdirSync(photoDirTarget, { recursive: true });
+
+        const rows = CSV.parseFile(
+            Config.getPackageDir() + "/data",
+            "photos.csv"
+        );
+        for (const row of rows) {
+            const name = row["taxon_name"];
+            const taxon = this.#taxa.getTaxon(name);
+            if (!taxon) {
                 continue;
             }
 
-            let imageList = this.#images[ name ];
-            if ( !imageList ) {
+            let imageList = this.#images[name];
+            if (!imageList) {
                 imageList = [];
-                this.#images[ name ] = imageList;
+                this.#images[name] = imageList;
             }
 
-            const src = new URL( row[ "source" ] );
-            const parts = path.parse( src.pathname ).dir.split( "/" );
-            const prefix = src.host.includes( "calflora" ) ? "cf-" : "inat-";
-            const filename = prefix + parts.slice( -1 )[ 0 ] + ".jpg";
+            const src = new URL(row["source"]);
+            const parts = path.parse(src.pathname).dir.split("/");
+            const prefix = src.host.includes("calflora") ? "cf-" : "inat-";
+            const filename = prefix + parts.slice(-1)[0] + ".jpg";
             const srcFileName = photoDirSrc + "/" + filename;
             const targetFileName = photoDirTarget + "/" + filename;
 
-            if ( !fs.existsSync( srcFileName ) ) {
+            if (!fs.existsSync(srcFileName)) {
                 // File is not there; retrieve it.
-                console.log( "retrieving " + srcFileName );
-                await Files.fetch( src, srcFileName );
+                console.log("retrieving " + srcFileName);
+                await Files.fetch(src, srcFileName);
             }
 
-            await new sharp( srcFileName ).resize( { width: 300 } ).jpeg( { quality: 40 } ).toFile( targetFileName );
-
-            imageList.push( new Image( imagePrefix + "/" + filename, row[ "credit" ] ) );
+            sharp(srcFileName)
+                .resize({ width: 300 })
+                .jpeg({ quality: 40 })
+                .toFile(targetFileName);
 
+            imageList.push(
+                new TaxonImage(imagePrefix + "/" + filename, row["credit"])
+            );
         }
 
-        this.#siteGenerator.copyIllustrations( Taxa.getFlowerColors() );
-
+        this.#siteGenerator.copyIllustrations(this.#taxa.getFlowerColors());
     }
 
     getManifestEntries() {
-
         const entries = [];
-        const images = Files.getDirEntries( this.#contentDir + "/i" ).sort();
-
-        for ( let index = 0; index < images.length; index++ ) {
-            const fileName = images[ index ];
-            const ext = fileName.split( "." )[ 1 ];
-            entries.push( EBook.getManifestEntry( "i" + index, "i/" + fileName, EBook.getMediaTypeForExt( ext ) ) );
+        const images = Files.getDirEntries(this.#contentDir + "/i").sort();
+
+        for (let index = 0; index < images.length; index++) {
+            const fileName = images[index];
+            const ext = fileName.split(".")[1];
+            entries.push(
+                EBook.getManifestEntry(
+                    "i" + index,
+                    "i/" + fileName,
+                    EBook.getMediaTypeForExt(ext)
+                )
+            );
         }
 
-        return entries.join( "" );
+        return entries.join("");
     }
 
-    getTaxonImages( name ) {
-        return this.#images[ name ];
+    /**
+     * @param {string} name
+     */
+    getTaxonImages(name) {
+        return this.#images[name];
     }
 }
 
-export { Images };
+export { Images };

package/lib/ebook/pages/page_list_families.js

@@ -1,7 +1,5 @@
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
-// eslint-disable-next-line no-unused-vars
-import { Families } from "../../families.js";
 
 class PageListFamilies extends EBookPage {
     #families;

package/lib/ebook/pages/page_list_flower_color.js

@@ -2,25 +2,30 @@ import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 
 class PageListFlowerColor extends EBookPage {
-
     #color;
 
-    constructor( outputDir, color ) {
-        super( outputDir + "/" + color.getFileName(), color.getColorName( true ) + " Flowers" );
+    /**
+     * @param {string} outputDir
+     * @param {FlowerColor} color
+     */
+    constructor(outputDir, color) {
+        super(
+            outputDir + "/" + color.getFileName(),
+            color.getColorName(true) + " Flowers"
+        );
         this.#color = color;
     }
 
     renderPageBody() {
-
-        const html = XHTML.textElement( "h1", this.getTitle() );
+        const html = XHTML.textElement("h1", this.getTitle());
 
         const links = [];
-        for ( const taxon of this.#color.getTaxa() ) {
-            links.push( XHTML.getLink( taxon.getFileName(), taxon.getName() ) );
+        for (const taxon of this.#color.getTaxa()) {
+            links.push(XHTML.getLink(taxon.getFileName(), taxon.getName()));
         }
 
-        return html + XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return html + XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
 }
 
-export { PageListFlowerColor };
+export { PageListFlowerColor };

package/lib/ebook/pages/page_list_flowers.js

@@ -6,104 +6,122 @@ import { EBook } from "../ebook.js";
 const FN_FLOWER_TIME_INDEX = "fm.html";
 
 class PageListFlowers {
-
-    static createPages( contentDir, taxa ) {
-        new PageListFlowerTimeIndex( contentDir ).create();
-        for ( let m1 = 1; m1 < 13; m1++ ) {
-            new PageListFlowerTime( contentDir, taxa, m1 ).create();
+    /**
+     * @param {string} contentDir
+     * @param {Taxa} taxa
+     */
+    static createPages(contentDir, taxa) {
+        new PageListFlowerTimeIndex(contentDir).create();
+        for (let m1 = 1; m1 < 13; m1++) {
+            new PageListFlowerTime(contentDir, taxa, m1).create();
         }
     }
 
     static getManifestEntries() {
-
         const manifestEntries = [];
 
-        manifestEntries.push( EBook.getManifestEntry( "fm0", FN_FLOWER_TIME_INDEX ) );
-        for ( let m1 = 1; m1 < 13; m1++ ) {
-            manifestEntries.push( EBook.getManifestEntry( "fm" + m1, PageListFlowerTime.getFileNameBloomTime( m1 ) ) );
+        manifestEntries.push(
+            EBook.getManifestEntry("fm0", FN_FLOWER_TIME_INDEX)
+        );
+        for (let m1 = 1; m1 < 13; m1++) {
+            manifestEntries.push(
+                EBook.getManifestEntry(
+                    "fm" + m1,
+                    PageListFlowerTime.getFileNameBloomTime(m1)
+                )
+            );
         }
 
-        return manifestEntries.join( "" );
+        return manifestEntries.join("");
     }
 
     static getSpineEntries() {
-
         const spineEntries = [];
 
-        spineEntries.push( EBook.getSpineEntry( "fm0" ) );
-        for ( let m1 = 1; m1 < 13; m1++ ) {
-            spineEntries.push( EBook.getSpineEntry( "fm" + m1 ) );
+        spineEntries.push(EBook.getSpineEntry("fm0"));
+        for (let m1 = 1; m1 < 13; m1++) {
+            spineEntries.push(EBook.getSpineEntry("fm" + m1));
         }
 
-        return spineEntries.join( "" );
-
+        return spineEntries.join("");
     }
 
     static renderMonthLinks() {
         const links = [];
-        for ( let m1 = 1; m1 < 13; m1++ ) {
+        for (let m1 = 1; m1 < 13; m1++) {
             links.push(
                 XHTML.getLink(
-                    PageListFlowerTime.getFileNameBloomTime( m1 ),
-                    DateUtils.getMonthName( m1 ) + " - " + DateUtils.getMonthName( ( m1 ) % 12 + 1 )
+                    PageListFlowerTime.getFileNameBloomTime(m1),
+                    DateUtils.getMonthName(m1) +
+                        " - " +
+                        DateUtils.getMonthName((m1 % 12) + 1)
                 )
             );
         }
-        return XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
-
 }
 
 class PageListFlowerTimeIndex extends EBookPage {
-
-    constructor( outputDir ) {
-        super( outputDir + "/" + FN_FLOWER_TIME_INDEX, "Flowering Times" );
+    /**
+     * @param {string} outputDir
+     */
+    constructor(outputDir) {
+        super(outputDir + "/" + FN_FLOWER_TIME_INDEX, "Flowering Times");
     }
 
     renderPageBody() {
-        const html = XHTML.textElement( "h1", this.getTitle() );
+        const html = XHTML.textElement("h1", this.getTitle());
         return html + PageListFlowers.renderMonthLinks();
     }
-
 }
 
 class PageListFlowerTime extends EBookPage {
-
     #taxa;
     #m1;
     #m2;
 
-    constructor( outputDir, taxa, month ) {
+    /**
+     * @param {string} outputDir
+     * @param {Taxa} taxa
+     * @param {number} month
+     */
+    constructor(outputDir, taxa, month) {
         super(
-            outputDir + "/" + PageListFlowerTime.getFileNameBloomTime( month ),
-            "Flowering in " + DateUtils.getMonthName( month ) + " - " + DateUtils.getMonthName( month % 12 + 1 )
+            outputDir + "/" + PageListFlowerTime.getFileNameBloomTime(month),
+            "Flowering in " +
+                DateUtils.getMonthName(month) +
+                " - " +
+                DateUtils.getMonthName((month % 12) + 1)
         );
         this.#taxa = taxa;
         this.#m1 = month;
-        this.#m2 = month % 12 + 1;
+        this.#m2 = (month % 12) + 1;
     }
 
-    static getFileNameBloomTime( m1 ) {
+    /**
+     * @param {number} m1
+     */
+    static getFileNameBloomTime(m1) {
         return "list_fm_" + m1 + ".html";
     }
 
     renderPageBody() {
+        const html = XHTML.textElement("h1", this.getTitle());
 
-        const html = XHTML.textElement( "h1", this.getTitle() );
-
-        const range = [ this.#m1, this.#m2 ];
+        /** @type {[number,number]} */
+        const range = [this.#m1, this.#m2];
         const links = [];
-        for ( const taxon of this.#taxa.getTaxonList() ) {
+        for (const taxon of this.#taxa.getTaxonList()) {
             const m1 = taxon.getBloomStart();
             const m2 = taxon.getBloomEnd();
-            if ( m1 && DateUtils.monthRangesOverlap( range, [ m1, m2 ] ) ) {
-                links.push( XHTML.getLink( taxon.getFileName(), taxon.getName() ) );
+            if (m1 && m2 && DateUtils.monthRangesOverlap(range, [m1, m2])) {
+                links.push(XHTML.getLink(taxon.getFileName(), taxon.getName()));
             }
         }
 
-        return html + XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return html + XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
-
 }
 
-export { PageListFlowers, PageListFlowerTime };
+export { PageListFlowers, PageListFlowerTime };

package/lib/ebook/pages/page_list_species.js

@@ -1,26 +1,32 @@
+import { HTMLTaxon } from "../../htmltaxon.js";
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 
 class PageListSpecies extends EBookPage {
-
     #taxa;
 
-    constructor( outputDir, taxa, filename, title ) {
-        super( outputDir + "/" + filename, title );
+    /**
+     *
+     * @param {string} outputDir
+     * @param {Taxon[]} taxa
+     * @param {string} filename
+     * @param {string} title
+     */
+    constructor(outputDir, taxa, filename, title) {
+        super(outputDir + "/" + filename, title);
         this.#taxa = taxa;
     }
 
     renderPageBody() {
-
-        const html = XHTML.textElement( "h1", this.getTitle() );
+        const html = XHTML.textElement("h1", this.getTitle());
 
         const links = [];
-        for ( const taxon of this.#taxa ) {
-            links.push( XHTML.getLink( taxon.getFileName(), taxon.getName() ) );
+        for (const taxon of this.#taxa) {
+            links.push(HTMLTaxon.getLink(taxon));
         }
 
-        return html + XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return html + XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
 }
 
-export { PageListSpecies };
+export { PageListSpecies };

package/lib/ebook/pages/taxonpage.js

@@ -1,13 +1,10 @@
 import imageSize from "image-size";
-import { Config, Files } from "@ca-plant-list/ca-plant-list";
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 import { Markdown } from "../../markdown.js";
-// eslint-disable-next-line no-unused-vars
-import { Taxon } from "../../taxon.js";
-// eslint-disable-next-line no-unused-vars
-import { Image } from "../image.js";
 import { HTMLTaxon } from "../../htmltaxon.js";
+import { Config } from "../../config.js";
+import { Files } from "../../files.js";
 
 class TaxonPage extends EBookPage {
     #outputDir;
@@ -17,7 +14,7 @@ class TaxonPage extends EBookPage {
     /**
      * @param {string} outputDir
      * @param {Taxon} taxon
-     * @param {Image[]} photos
+     * @param {TaxonImage[]} photos
      */
     constructor(outputDir, taxon, photos) {
         super(outputDir + "/" + taxon.getFileName(), taxon.getName());

package/lib/ebook/pages/tocpage.js

@@ -1,26 +1,30 @@
-import { Taxa } from "../../taxa.js";
 import { EBookPage } from "../ebookpage.js";
 import { XHTML } from "../xhtml.js";
 import { PageListFlowers } from "./page_list_flowers.js";
 
 class TOCPage extends EBookPage {
-
-    constructor( outputDir ) {
-        super( outputDir + "/toc.xhtml", "Table of Contents" );
+    #taxa;
+
+    /**
+     * @param {string} outputDir
+     * @param {Taxa} taxa
+     */
+    constructor(outputDir, taxa) {
+        super(outputDir + "/toc.xhtml", "Table of Contents");
+        this.#taxa = taxa;
     }
 
     renderPageBody() {
-
-        let html = "<nav id=\"toc\" role=\"doc-toc\" epub:type=\"toc\">";
-        html += "<h1 epub:type=\"title\">Table of Contents</h1>";
+        let html = '<nav id="toc" role="doc-toc" epub:type="toc">';
+        html += '<h1 epub:type="title">Table of Contents</h1>';
 
         const mainLinks = [];
-        mainLinks.push( this.#getFlowerColorLinks() );
-        mainLinks.push( this.#getFlowerTimeLinks() );
-        mainLinks.push( XHTML.getLink( "./list_families.html", "All Families" ) );
-        mainLinks.push( XHTML.getLink( "./list_species.html", "All Species" ) );
-        mainLinks.push( XHTML.getLink( "./glossary.html", "Glossary" ) );
-        html += XHTML.wrap( "ol", XHTML.arrayToLI( mainLinks ) );
+        mainLinks.push(this.#getFlowerColorLinks());
+        mainLinks.push(this.#getFlowerTimeLinks());
+        mainLinks.push(XHTML.getLink("./list_families.html", "All Families"));
+        mainLinks.push(XHTML.getLink("./list_species.html", "All Species"));
+        mainLinks.push(XHTML.getLink("./glossary.html", "Glossary"));
+        html += XHTML.wrap("ol", XHTML.arrayToLI(mainLinks));
 
         html += "</nav>";
 
@@ -28,19 +32,21 @@ class TOCPage extends EBookPage {
     }
 
     #getFlowerColorLinks() {
-        const html = XHTML.textElement( "span", "Flower Color" );
+        const html = XHTML.textElement("span", "Flower Color");
         const links = [];
-        for ( const colorName of Taxa.getFlowerColorNames() ) {
-            links.push( XHTML.getLink( "list_fc_" + colorName + ".html", colorName ) );
+        for (const color of this.#taxa.getFlowerColors()) {
+            const colorName = color.getColorName();
+            links.push(
+                XHTML.getLink("list_fc_" + colorName + ".html", colorName)
+            );
         }
-        return html + XHTML.wrap( "ol", XHTML.arrayToLI( links ) );
+        return html + XHTML.wrap("ol", XHTML.arrayToLI(links));
     }
 
     #getFlowerTimeLinks() {
-        const html = XHTML.getLink( "fm.html", "Flowering Times" );
+        const html = XHTML.getLink("fm.html", "Flowering Times");
         return html + PageListFlowers.renderMonthLinks();
     }
-
 }
 
-export { TOCPage };
+export { TOCPage };

package/lib/ebook/plantbook.js

@@ -8,7 +8,6 @@ import { PageListFlowers } from "./pages/page_list_flowers.js";
 import { PageListSpecies } from "./pages/page_list_species.js";
 import { TaxonPage } from "./pages/taxonpage.js";
 import { TOCPage } from "./pages/tocpage.js";
-import { Taxa } from "../taxa.js";
 
 class PlantBook extends EBook {
     #taxa;
@@ -16,9 +15,8 @@ class PlantBook extends EBook {
     #images;
 
     /**
-     *
      * @param {string} outputDir
-     * @param {*} config
+     * @param {Config} config
      * @param {Taxa} taxa
      */
     constructor(outputDir, config, taxa) {
@@ -52,11 +50,8 @@ class PlantBook extends EBook {
         }
 
         // Create lists.
-        for (const colorName of Taxa.getFlowerColorNames()) {
-            new PageListFlowerColor(
-                contentDir,
-                this.#taxa.getFlowerColor(colorName)
-            ).create();
+        for (const color of this.#taxa.getFlowerColors()) {
+            new PageListFlowerColor(contentDir, color).create();
         }
 
         PageListFlowers.createPages(contentDir, this.#taxa);
@@ -84,7 +79,7 @@ class PlantBook extends EBook {
 
         this.#glossary.renderPages();
 
-        new TOCPage(contentDir).create();
+        new TOCPage(contentDir, this.#taxa).create();
     }
 
     renderManifestEntries() {
@@ -95,8 +90,7 @@ class PlantBook extends EBook {
             '<item id="lspecies" href="list_species.html" media-type="application/xhtml+xml" />';
         xml +=
             '<item id="lfamilies" href="list_families.html" media-type="application/xhtml+xml" />';
-        for (const colorName of Taxa.getFlowerColorNames()) {
-            const color = this.#taxa.getFlowerColor(colorName);
+        for (const color of this.#taxa.getFlowerColors()) {
             xml +=
                 '<item id="l' +
                 color.getColorName() +
@@ -142,8 +136,7 @@ class PlantBook extends EBook {
         let xml = "";
 
         // Add lists.
-        for (const colorName of Taxa.getFlowerColorNames()) {
-            const color = this.#taxa.getFlowerColor(colorName);
+        for (const color of this.#taxa.getFlowerColors()) {
             xml += '<itemref idref="l' + color.getColorName() + '"/>';
         }
         xml += PageListFlowers.getSpineEntries();

package/lib/ebook/{image.js → taxonimage.js}

@@ -1,4 +1,4 @@
-class Image {
+class TaxonImage {
     #src;
     #credit;
 
@@ -20,4 +20,4 @@ class Image {
     }
 }
 
-export { Image };
+export { TaxonImage };

package/lib/ebook/xhtml.js

@@ -1,7 +1,5 @@
-import { HTML } from "@ca-plant-list/ca-plant-list";
+import { HTML } from "../html.js";
 
-class XHTML extends HTML {
+class XHTML extends HTML {}
 
-}
-
-export { XHTML };
+export { XHTML };