@ca-plant-list/ca-plant-list 0.4.19 → 0.4.21

package/data/text/Rumex-conglomeratus.md

@@ -0,0 +1 @@
+[Perianth](./g/perianth.html) without teeth.

package/data/text/Rumex-obtusifolius.md

@@ -0,0 +1 @@
+[Perianth](./g/perianth.html) with teeth.

package/data/text/Rumex-pulcher.md

@@ -0,0 +1 @@
+[Perianth](./g/perianth.html) with teeth.

package/data/text/Rumex-salicifolius.md

@@ -0,0 +1 @@
+Leaves only on stem (no basal leaves).

package/lib/config.js

@@ -2,9 +2,15 @@ import * as path from "node:path";
 import * as url from "node:url";
 import { Files } from "./files.js";
 
+/** @type {Object<string,string>} */
+const COUNTY_NAMES = {
+    ALA: "Alameda",
+    CCA: "Contra Costa",
+};
+
 class Config {
     static #packageDir = path.dirname(
-        path.dirname(url.fileURLToPath(import.meta.url))
+        path.dirname(url.fileURLToPath(import.meta.url)),
     );
 
     /** @type {Object<string,Object<string,Object<string,{}>>>} */
@@ -55,6 +61,14 @@ class Config {
         return [];
     }
 
+    /**
+     * @returns {string[]}
+     */
+    getCountyNames() {
+        const counties = this.getCountyCodes();
+        return counties.map((c) => COUNTY_NAMES[c]);
+    }
+
     /**
      * @param {string} name
      * @param {string} dflt

package/lib/csv.js

@@ -13,7 +13,7 @@ class CSV {
      */
     static #getOptions(fileName, columns, delimiter) {
         /** @type {import("csv-parse").Options} */
-        const options = { relax_column_count_less: true };
+        const options = { relax_column_count_less: true, bom: true };
         options.columns = columns;
         if (path.extname(fileName) === ".tsv") {
             options.delimiter = "\t";
@@ -44,6 +44,7 @@ class CSV {
      * @param {boolean|import("csv-parse").ColumnOption[]} columns
      * @param {string|undefined} delimiter
      * @param {function (any):void} callback
+     * @deprecated Use parseFileStream
      */
     static async parseStream(
         dir,
@@ -72,6 +73,27 @@ class CSV {
         await processFile();
     }
 
+    /**
+     * @template T
+     * @param {string} fileName
+     * @param {function (T):void} callback
+     */
+    static async parseFileStream(fileName, callback) {
+        const options = this.#getOptions(fileName, true, undefined);
+        const processFile = async () => {
+            const parser = fs.createReadStream(fileName).pipe(parse(options));
+            parser.on("readable", function () {
+                let record;
+                while ((record = parser.read()) !== null) {
+                    callback(record);
+                }
+            });
+            await finished(parser);
+        };
+        // Parse the CSV content
+        await processFile();
+    }
+
     /**
      * @param {string} fileName
      * @param {boolean|import("csv-parse").ColumnOption[]|function (string[]):string[]} [columns]

package/lib/ebook/glossarypages.js

@@ -3,7 +3,7 @@ import { EBook } from "./ebook.js";
 
 class GlossaryPages extends BaseGlossaryPages {
     /**
-     * @param {SiteGenerator} siteGenerator
+     * @param {import("../sitegenerator.js").SiteGenerator} siteGenerator
      */
     constructor(siteGenerator) {
         super(siteGenerator);
@@ -19,8 +19,8 @@ class GlossaryPages extends BaseGlossaryPages {
             manifestEntries.push(
                 EBook.getManifestEntry(
                     "g" + index,
-                    "g/" + entry.getHTMLFileName()
-                )
+                    "g/" + entry.getHTMLFileName(),
+                ),
             );
         }
 

package/lib/ebook/images.js

@@ -12,9 +12,9 @@ class Images {
     #taxa;
 
     /**
-     * @param {SiteGenerator} siteGenerator
+     * @param {import("../sitegenerator.js").SiteGenerator} siteGenerator
      * @param {string} contentDir
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      */
     constructor(siteGenerator, contentDir, taxa) {
         this.#siteGenerator = siteGenerator;

package/lib/ebook/pages/page_list_families.js

@@ -6,7 +6,7 @@ class PageListFamilies extends EBookPage {
 
     /**
      * @param {string} outputDir
-     * @param {Families} families
+     * @param {import("../../families.js").Families} families
      */
     constructor(outputDir, families) {
         super(outputDir + "/list_families.html", "All Families");

package/lib/ebook/pages/page_list_flower_color.js

@@ -6,12 +6,12 @@ class PageListFlowerColor extends EBookPage {
 
     /**
      * @param {string} outputDir
-     * @param {FlowerColor} color
+     * @param {import("../../flowercolor.js").FlowerColor} color
      */
     constructor(outputDir, color) {
         super(
             outputDir + "/" + color.getFileName(),
-            color.getColorName(true) + " Flowers"
+            color.getColorName(true) + " Flowers",
         );
         this.#color = color;
     }

package/lib/ebook/pages/page_list_flowers.js

@@ -8,7 +8,7 @@ const FN_FLOWER_TIME_INDEX = "fm.html";
 class PageListFlowers {
     /**
      * @param {string} contentDir
-     * @param {Taxa} taxa
+     * @param {import("../../taxa.js").Taxa} taxa
      */
     static createPages(contentDir, taxa) {
         new PageListFlowerTimeIndex(contentDir).create();
@@ -21,14 +21,14 @@ class PageListFlowers {
         const manifestEntries = [];
 
         manifestEntries.push(
-            EBook.getManifestEntry("fm0", FN_FLOWER_TIME_INDEX)
+            EBook.getManifestEntry("fm0", FN_FLOWER_TIME_INDEX),
         );
         for (let m1 = 1; m1 < 13; m1++) {
             manifestEntries.push(
                 EBook.getManifestEntry(
                     "fm" + m1,
-                    PageListFlowerTime.getFileNameBloomTime(m1)
-                )
+                    PageListFlowerTime.getFileNameBloomTime(m1),
+                ),
             );
         }
 
@@ -54,8 +54,8 @@ class PageListFlowers {
                     PageListFlowerTime.getFileNameBloomTime(m1),
                     DateUtils.getMonthName(m1) +
                         " - " +
-                        DateUtils.getMonthName((m1 % 12) + 1)
-                )
+                        DateUtils.getMonthName((m1 % 12) + 1),
+                ),
             );
         }
         return XHTML.wrap("ol", XHTML.arrayToLI(links));
@@ -83,7 +83,7 @@ class PageListFlowerTime extends EBookPage {
 
     /**
      * @param {string} outputDir
-     * @param {Taxa} taxa
+     * @param {import("../../taxa.js").Taxa} taxa
      * @param {number} month
      */
     constructor(outputDir, taxa, month) {
@@ -92,7 +92,7 @@ class PageListFlowerTime extends EBookPage {
             "Flowering in " +
                 DateUtils.getMonthName(month) +
                 " - " +
-                DateUtils.getMonthName((month % 12) + 1)
+                DateUtils.getMonthName((month % 12) + 1),
         );
         this.#taxa = taxa;
         this.#m1 = month;

package/lib/ebook/pages/tocpage.js

@@ -7,7 +7,7 @@ class TOCPage extends EBookPage {
 
     /**
      * @param {string} outputDir
-     * @param {Taxa} taxa
+     * @param {import("../../taxa.js").Taxa} taxa
      */
     constructor(outputDir, taxa) {
         super(outputDir + "/toc.xhtml", "Table of Contents");
@@ -37,7 +37,7 @@ class TOCPage extends EBookPage {
         for (const color of this.#taxa.getFlowerColors()) {
             const colorName = color.getColorName();
             links.push(
-                XHTML.getLink("list_fc_" + colorName + ".html", colorName)
+                XHTML.getLink("list_fc_" + colorName + ".html", colorName),
             );
         }
         return html + XHTML.wrap("ol", XHTML.arrayToLI(links));

package/lib/ebook/plantbook.js

@@ -17,7 +17,7 @@ class PlantBook extends EBook {
 
     /**
      * @param {string} outputDir
-     * @param {Config} config
+     * @param {import("../config.js").Config} config
      * @param {import("../taxa.js").Taxa} taxa
      */
     constructor(outputDir, config, taxa) {
@@ -168,7 +168,7 @@ class PlantBook extends EBook {
 }
 
 /**
- * @param {Config} config
+ * @param {import("../config.js").Config} config
  * @param {string} name
  * @returns {string}
  */

package/lib/externalsites.js

@@ -1,27 +1,60 @@
-class ExternalSites {
+/** @typedef {{
+    coords?: [number, number];
+    project_id?: string;
+    subview?: "grid" | "list" | "map";
+    taxon_id?: string;
+}} InatObsOptions */
+
+export class ExternalSites {
+    /**
+     * @param {import("./taxon.js").Taxon} taxon
+     * @param {import("./config.js").Config} config
+     * @returns {URL|undefined}
+     */
+    static getCCH2ObsLink(taxon, config) {
+        const url = new URL(
+            "https://www.cch2.org/portal/collections/listtabledisplay.php?usethes=1&taxontype=2&sortfield1=o.eventDate&sortorder=desc",
+        );
+        url.searchParams.set("county", config.getCountyNames().join(";"));
+        url.searchParams.set("taxa", taxon.getName());
+        return url;
+    }
+
+    /**
+     * @param {import("./taxon.js").Taxon} taxon
+     * @returns {URL|undefined}
+     */
+    static getCCH2RefLink(taxon) {
+        const id = taxon.getCCH2ID();
+        if (!id) {
+            return;
+        }
+        const url = new URL("https://www.cch2.org/portal/taxa/index.php");
+        url.searchParams.set("taxon", id);
+        return url;
+    }
+
     /**
      * @param {InatObsOptions} options
      */
     static getInatObsLink(options) {
         const url = new URL(
-            "https://www.inaturalist.org/observations?subview=map"
+            "https://www.inaturalist.org/observations?subview=map",
         );
 
+        if (options.coords) {
+            const delta = 0.1;
+            const params = url.searchParams;
+            const lat = options.coords[1];
+            const lng = options.coords[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());
+        }
+
         for (const [k, v] of Object.entries(options)) {
             switch (k) {
-                case "coords": {
-                    const delta = 0.1;
-                    const params = url.searchParams;
-                    /** @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":
                 case "list_id":
                 case "place_id":
@@ -29,7 +62,7 @@ class ExternalSites {
                 case "subview":
                 case "taxon_id":
                 case "taxon_name":
-                    if (v) {
+                    if (typeof v === "string") {
                         url.searchParams.set(k, v);
                     }
                     break;
@@ -39,5 +72,3 @@ class ExternalSites {
         return url.toString();
     }
 }
-
-export { ExternalSites };

package/lib/families.js

@@ -5,7 +5,7 @@ import { Files } from "./files.js";
 import { Config } from "./config.js";
 import { HTMLTaxon } from "./htmltaxon.js";
 
-class Family {
+export class Family {
     #name;
     #data;
 

package/lib/files.js

@@ -140,7 +140,7 @@ class Files {
             if (entry.path === fileNameToUnzip) {
                 await this.#createFileFromStream(
                     targetFilePath,
-                    entry.stream()
+                    entry.stream(),
                 );
                 break;
             }

package/lib/flowercolor.js

@@ -3,7 +3,7 @@ import { TextUtils } from "./textutils.js";
 class FlowerColor {
     #colorName;
     #colorCode;
-    /** @type {Taxon[]} */
+    /** @type {import("./taxon.js").Taxon[]} */
     #taxa = [];
 
     /**
@@ -16,7 +16,7 @@ class FlowerColor {
     }
 
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      */
     addTaxon(taxon) {
         this.#taxa.push(taxon);

package/lib/genera.js

@@ -6,7 +6,7 @@ class Genera {
     #genera;
 
     /**
-     * @param {Families} families
+     * @param {import("./families.js").Families} families
      */
     constructor(families) {
         const dataDir = Config.getPackageDir() + "/data";
@@ -46,7 +46,7 @@ class Genus {
     #data;
 
     /**
-     * @param {{family:string,familyObj:Family,taxa:Taxon[]}} data
+     * @param {{family:string,familyObj:import("./families.js").Family,taxa:import("./taxon.js").Taxon[]}} data
      */
     constructor(data) {
         this.#data = data;
@@ -56,6 +56,9 @@ class Genus {
         return this.#data.familyObj;
     }
 
+    /**
+     * @returns {import("./taxon.js").Taxon[]}
+     */
     getTaxa() {
         return this.#data.taxa.sort((a, b) =>
             a.getName().localeCompare(b.getName()),

package/lib/htmltaxon.js

@@ -54,6 +54,19 @@ const DEFAULT_TAXA_COLUMNS = [
 ];
 
 class HTMLTaxon {
+    /**
+     * @param {string[]} links
+     * @param {URL|string|undefined} href
+     * @param {string} label
+     */
+    static addLink(links, href, label) {
+        if (href === undefined) {
+            return;
+        }
+        const link = HTML.getLink(href.toString(), label, {}, true);
+        links.push(link);
+    }
+
     /**
      * @param {import("./taxon.js").Taxon} taxon
      * @returns {string|undefined}

package/lib/index.d.ts

@@ -1,5 +1,32 @@
 import { Command } from "commander";
 
+// Types
+
+export type NativeStatusCode = "N" | "NC" | "U" | "X";
+
+export type TaxonData = {
+    bloom_end: string;
+    bloom_start: string;
+    calrecnum: string;
+    calscape_cn?: string;
+    cch2_id: string;
+    CESA: string;
+    "common name": string;
+    CRPR: string;
+    FESA: string;
+    flower_color: string;
+    GRank: string;
+    "inat id": string;
+    "jepson id": string;
+    life_cycle: string;
+    "RPI ID": string;
+    SRank: string;
+    status: NativeStatusCode;
+    taxon_name: string;
+};
+
+// Classes
+
 export class Config {
     constructor(dataDir: string);
     getConfigValue(
@@ -34,6 +61,15 @@ export class Exceptions {
     hasException(name: string, cat: string, subcat: string): boolean;
 }
 
+export class ExternalSites {
+    static getCCH2ObsLink(taxon: Taxon, config: Config): URL | undefined;
+    static getCCH2RefLink(taxon: Taxon): URL | undefined;
+}
+
+export class Family {
+    getName(): string;
+}
+
 export class Files {
     static exists(fileName: string): boolean;
     static fetch(
@@ -45,6 +81,12 @@ export class Files {
     static write(fileName: string, data: string, overwrite: boolean): void;
 }
 
+export class Genera {}
+
+export class Genus {
+    getTaxa(): Taxon[];
+}
+
 export class HTML {
     static arrayToLI(items: string[]): string;
     static getLink(
@@ -66,6 +108,11 @@ export class HTML {
 }
 
 export class HTMLTaxon {
+    static addLink(
+        links: string[],
+        href: URL | string | undefined,
+        label: string,
+    ): void;
     static getFooterHTML(taxon: Taxon): string;
     static getListSectionHTML(
         list: string[],
@@ -101,7 +148,7 @@ export class Taxa {
         showFlowerErrors: boolean,
         taxonFactory?: (td: TaxonData, g: Genera) => Taxon,
         extraTaxa?: TaxonData[],
-        extraSynonyms?: SynonymData[],
+        extraSynonyms?: Record<string, string>[],
     );
     getTaxon(name: string): Taxon;
     getTaxonList(): Taxon[];
@@ -115,6 +162,7 @@ export class Taxon {
     getCNDDBRank(): string | undefined;
     getCommonNames(): string[];
     getFamily(): Family;
+    getFileName(): string;
     getFESA(): string | undefined;
     getGenus(): Genus;
     getGenusName(): string;

package/lib/index.js

@@ -3,6 +3,7 @@ import { Config } from "./config.js";
 import { CSV } from "./csv.js";
 import { ErrorLog } from "./errorlog.js";
 import { Exceptions } from "./exceptions.js";
+import { ExternalSites } from "./externalsites.js";
 import { Families } from "./families.js";
 import { Files } from "./files.js";
 import { HTML } from "./html.js";
@@ -11,7 +12,7 @@ import { Jekyll } from "./jekyll.js";
 import { PlantBook } from "./ebook/plantbook.js";
 import { Program } from "./program.js";
 import { Taxa } from "./taxa.js";
-import { Taxon, TAXA_COLNAMES } from "./taxon.js";
+import { Taxon } from "./taxon.js";
 
 export {
     BasePageRenderer,
@@ -19,6 +20,7 @@ export {
     CSV,
     ErrorLog,
     Exceptions,
+    ExternalSites,
     Families,
     Files,
     HTML,
@@ -27,6 +29,5 @@ export {
     PlantBook,
     Program,
     Taxa,
-    TAXA_COLNAMES,
     Taxon,
 };

package/lib/photo.js

@@ -1,14 +1,5 @@
 /**
  * @typedef {"CC0" | "CC BY" | "CC BY-NC" | "C" | null} PhotoRights
- * @typedef { "cc-by-nc-sa"
-    | "cc-by-nc"
-    | "cc-by-nc-nd"
-    | "cc-by"
-    | "cc-by-sa"
-    | "cc-by-nd"
-    | "pd"
-    | "gdfl"
-    | "cc0"} InatLicenseCode
  */
 
 export class Photo {
@@ -21,7 +12,7 @@ export class Photo {
     /**
      * @param {number} id
      * @param {string} ext
-     * @param {InatLicenseCode} licenseCode
+     * @param {import("./utils/inat-tools.js").InatLicenseCode} licenseCode
      * @param {string} rightsHolder
      */
     constructor(id, ext, licenseCode, rightsHolder) {

package/lib/plants/glossary.js

@@ -1,7 +1,7 @@
 import { Config } from "../config.js";
 import { Files } from "../files.js";
 
-class Glossary {
+export class Glossary {
     #srcPath;
     /** @type {GlossaryEntry[]} */
     #srcEntries = [];
@@ -21,7 +21,7 @@ class Glossary {
     }
 }
 
-class GlossaryEntry {
+export class GlossaryEntry {
     #srcPath;
     #fileName;
     #term;
@@ -48,5 +48,3 @@ class GlossaryEntry {
         return this.#term;
     }
 }
-
-export { Glossary };

package/lib/program.js

@@ -3,6 +3,14 @@ import { Files } from "./files.js";
 import { CSV } from "./csv.js";
 import path from "node:path";
 
+/**
+ * @typedef {{
+    datadir: string;
+    outputdir: string;
+    "show-flower-errors": boolean;
+}} CommandLineOptions
+ */
+
 class Program {
     /**
      * @param {string} dataDir
@@ -16,10 +24,10 @@ class Program {
             return true;
         }
 
-        /** @type {TaxonData[]} */
+        /** @type {import("./index.js").TaxonData[]} */
         // @ts-ignore
         const includeCSV = CSV.readFile(path.join(dataDir, includeFileName));
-        /** @type {Object<string,TaxonData>} */
+        /** @type {Object<string,import("./index.js").TaxonData>} */
         const include = {};
         for (const row of includeCSV) {
             include[row["taxon_name"]] = row;

package/lib/sitegenerator.js

@@ -14,12 +14,12 @@ class SiteGenerator {
     }
 
     /**
-     * @param {FlowerColor[]} flowerColors
+     * @param {import("./flowercolor.js").FlowerColor[]} flowerColors
      */
     copyIllustrations(flowerColors) {
         /**
          * @param {string} outputDir
-         * @param {FlowerColor[]} flowerColors
+         * @param {import("./flowercolor.js").FlowerColor[]} flowerColors
          */
         function createFlowerColorIcons(outputDir, flowerColors) {
             // Read generic input.
@@ -28,7 +28,7 @@ class SiteGenerator {
             for (const color of flowerColors) {
                 Files.write(
                     Files.join(outputDir, "f-" + color.getColorName() + ".svg"),
-                    srcSVG.replace("#ff0", color.getColorCode())
+                    srcSVG.replace("#ff0", color.getColorCode()),
                 );
             }
             // Delete input file.
@@ -69,6 +69,16 @@ class SiteGenerator {
     mkdir(path) {
         Files.mkdir(Files.join(this.#baseDir, path));
     }
+
+    /**
+     * @param {string} content
+     * @param {{title:string}} attributes
+     * @param {string} filename
+     */
+    // eslint-disable-next-line no-unused-vars
+    writeTemplate(content, attributes, filename) {
+        throw new Error("must be implemented by subclass");
+    }
 }
 
 export { SiteGenerator };