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

package/lib/ebook/images.js

@@ -3,19 +3,24 @@ import path from "node:path";
 
 import sharp from "sharp";
 
-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 = {};
 
+    /**
+     * @param {SiteGenerator} siteGenerator
+     * @param {string} contentDir
+     * @param {Taxa} taxa
+     */
     constructor(siteGenerator, contentDir, taxa) {
         this.#siteGenerator = siteGenerator;
         this.#contentDir = contentDir;
@@ -59,17 +64,17 @@ class Images {
                 await Files.fetch(src, srcFileName);
             }
 
-            await new sharp(srcFileName)
+            sharp(srcFileName)
                 .resize({ width: 300 })
                 .jpeg({ quality: 40 })
                 .toFile(targetFileName);
 
             imageList.push(
-                new Image(imagePrefix + "/" + filename, row["credit"])
+                new TaxonImage(imagePrefix + "/" + filename, row["credit"])
             );
         }
 
-        this.#siteGenerator.copyIllustrations(Taxa.getFlowerColors());
+        this.#siteGenerator.copyIllustrations(this.#taxa.getFlowerColors());
     }
 
     getManifestEntries() {
@@ -91,6 +96,9 @@ class Images {
         return entries.join("");
     }
 
+    /**
+     * @param {string} name
+     */
     getTaxonImages(name) {
         return this.#images[name];
     }

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/taxonpage.js

@@ -14,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/exceptions.js

@@ -2,55 +2,71 @@ import { Config } from "./config.js";
 import { Files } from "./files.js";
 
 class Exceptions {
-
+    /** @type {Object<string,Object<string,Object<string,{}>>>} */
     #exceptions = {};
 
-    constructor( dir ) {
-
-        function readConfig( fileName ) {
-            return JSON.parse( Files.read( fileName ) );
+    /**
+     * @param {string} dir
+     */
+    constructor(dir) {
+        /**
+         * @param {string} fileName
+         */
+        function readConfig(fileName) {
+            return JSON.parse(Files.read(fileName));
         }
 
         // Read default configuration.
-        this.#exceptions = readConfig( Config.getPackageDir() + "/data/exceptions.json" );
+        this.#exceptions = readConfig(
+            Config.getPackageDir() + "/data/exceptions.json"
+        );
 
         // Add/overwrite with local configuration.
-        const localExceptions = readConfig( dir + "/exceptions.json" );
-        for ( const [ k, v ] of Object.entries( localExceptions ) ) {
-            this.#exceptions[ k ] = v;
+        const localExceptions = readConfig(dir + "/exceptions.json");
+        for (const [k, v] of Object.entries(localExceptions)) {
+            this.#exceptions[k] = v;
             // Tag as a local exception so we can distinguish between global and local.
             v.local = true;
         }
-
     }
 
     getExceptions() {
-        return Object.entries( this.#exceptions );
+        return Object.entries(this.#exceptions);
     }
 
-    getValue( name, cat, subcat, defaultValue ) {
-        const taxonData = this.#exceptions[ name ];
-        if ( taxonData ) {
-            const catData = taxonData[ cat ];
-            if ( catData ) {
-                const val = catData[ subcat ];
-                return ( val === undefined ) ? defaultValue : val;
+    /**
+     * @param {string} name
+     * @param {string} cat
+     * @param {string} subcat
+     * @param {string} defaultValue
+     */
+    getValue(name, cat, subcat, defaultValue) {
+        const taxonData = this.#exceptions[name];
+        if (taxonData) {
+            const catData = taxonData[cat];
+            if (catData) {
+                const val = catData[subcat];
+                return val === undefined ? defaultValue : val;
             }
         }
         return defaultValue;
     }
 
-    hasException( name, cat, subcat ) {
-        const taxonData = this.#exceptions[ name ];
-        if ( taxonData ) {
-            const catData = taxonData[ cat ];
-            if ( catData ) {
-                return catData[ subcat ] !== undefined;
+    /**
+     * @param {string} name
+     * @param {string} cat
+     * @param {string} subcat
+     */
+    hasException(name, cat, subcat) {
+        const taxonData = this.#exceptions[name];
+        if (taxonData) {
+            const catData = taxonData[cat];
+            if (catData) {
+                return catData[subcat] !== undefined;
             }
         }
         return false;
     }
-
 }
 
-export { Exceptions };
+export { Exceptions };

package/lib/externalsites.js

@@ -1,4 +1,7 @@
 class ExternalSites {
+    /**
+     * @param {InatObsOptions} options
+     */
     static getInatObsLink(options) {
         const url = new URL(
             "https://www.inaturalist.org/observations?subview=map"
@@ -9,10 +12,14 @@ class ExternalSites {
                 case "coords": {
                     const delta = 0.1;
                     const params = url.searchParams;
-                    params.set("nelat", v[1] + delta);
-                    params.set("swlat", v[1] - delta);
-                    params.set("nelng", v[0] + delta);
-                    params.set("swlng", v[0] - delta);
+                    /** @type {number} */
+                    const lat = v[1];
+                    /** @type {number} */
+                    const lng = v[0];
+                    params.set("nelat", (lat + delta).toString());
+                    params.set("swlat", (lat - delta).toString());
+                    params.set("nelng", (lng + delta).toString());
+                    params.set("swlng", (lng - delta).toString());
                     break;
                 }
                 case "created_d1":

package/lib/families.js

@@ -1,9 +1,9 @@
 import { GenericPage } from "./genericpage.js";
 import { HTML } from "./html.js";
 import { Jepson } from "./jepson.js";
-import { Taxa } from "./taxa.js";
 import { Files } from "./files.js";
 import { Config } from "./config.js";
+import { HTMLTaxon } from "./htmltaxon.js";
 
 class Family {
     #name;
@@ -81,7 +81,7 @@ class Families {
 
     /**
      * @param {string} outputDir
-     * @param {import("./index.js").TaxaCol[]} taxaColumns
+     * @param {TaxaCol[]} taxaColumns
      */
     renderPages(outputDir, taxaColumns) {
         new PageFamilyList(outputDir, this.#families).render(taxaColumns);
@@ -109,7 +109,7 @@ class PageFamilyList extends GenericPage {
     }
 
     /**
-     * @param {import("./index.js").TaxaCol[]} taxaColumns
+     * @param {TaxaCol[]} taxaColumns
      */
     render(taxaColumns) {
         let html = this.getDefaultIntro();
@@ -176,8 +176,7 @@ class PageFamily extends GenericPage {
     }
 
     /**
-     *
-     * @param {import("./index.js").TaxaCol[]} columns
+     * @param {TaxaCol[]} columns
      */
     render(columns) {
         let html = this.getDefaultIntro();
@@ -188,7 +187,7 @@ class PageFamily extends GenericPage {
             { class: "section" }
         );
 
-        html += Taxa.getHTMLTable(this.#family.getTaxa(), columns);
+        html += HTMLTaxon.getTaxaTable(this.#family.getTaxa(), columns);
 
         this.writeFile(html);
     }
@@ -207,17 +206,20 @@ class PageSection extends GenericPage {
         this.#taxa = taxa;
     }
 
+    /**
+     * @param {TaxaCol[]} [columns]
+     */
     render(columns) {
         let html = this.getDefaultIntro();
 
-        html += Taxa.getHTMLTable(this.#taxa, columns);
+        html += HTMLTaxon.getTaxaTable(this.#taxa, columns);
 
         this.writeFile(html);
     }
 }
 
 class Sections {
-    /** @type {Object<string,Taxon[]} */
+    /** @type {Object<string,Taxon[]>} */
     static #sections = {};
 
     /**

package/lib/flowercolor.js

@@ -0,0 +1,42 @@
+import { TextUtils } from "./textutils.js";
+
+class FlowerColor {
+    #colorName;
+    #colorCode;
+    /** @type {Taxon[]} */
+    #taxa = [];
+
+    /**
+     * @param {string} colorName
+     * @param {string} [colorCode]
+     */
+    constructor(colorName, colorCode) {
+        this.#colorName = colorName;
+        this.#colorCode = colorCode ? colorCode : colorName;
+    }
+
+    /**
+     * @param {Taxon} taxon
+     */
+    addTaxon(taxon) {
+        this.#taxa.push(taxon);
+    }
+
+    getColorCode() {
+        return this.#colorCode;
+    }
+
+    getColorName(uc = false) {
+        return uc ? TextUtils.ucFirst(this.#colorName) : this.#colorName;
+    }
+
+    getFileName() {
+        return "list_fc_" + this.#colorName + ".html";
+    }
+
+    getTaxa() {
+        return this.#taxa;
+    }
+}
+
+export { FlowerColor };