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

package/data/genera.json

@@ -607,6 +607,10 @@
         "family": "Asteraceae",
         "id": "302"
     },
+    "Aldama": {
+        "family": "Asteraceae",
+        "id": "95525"
+    },
     "Almutaster": {
         "family": "Asteraceae",
         "id": "67986"
@@ -1107,6 +1111,10 @@
         "family": "Asteraceae",
         "id": "497"
     },
+    "Laphamia": {
+        "family": "Asteraceae",
+        "id": "68724"
+    },
     "Lapsana": {
         "family": "Asteraceae",
         "id": "498"
@@ -1199,6 +1207,10 @@
         "family": "Asteraceae",
         "id": "68898"
     },
+    "Mycelis": {
+        "family": "Asteraceae",
+        "id": "532"
+    },
     "Nestotus": {
         "family": "Asteraceae",
         "id": "82475"
@@ -1515,10 +1527,6 @@
         "family": "Asteraceae",
         "id": "653"
     },
-    "Viguiera": {
-        "family": "Asteraceae",
-        "id": "655"
-    },
     "Volutaria": {
         "family": "Asteraceae",
         "id": "82515"
@@ -1983,10 +1991,6 @@
         "family": "Cactaceae",
         "id": "9216"
     },
-    "Coryphantha": {
-        "family": "Cactaceae",
-        "id": "9218"
-    },
     "Cylindropuntia": {
         "family": "Cactaceae",
         "id": "68351"
@@ -1999,6 +2003,10 @@
         "family": "Cactaceae",
         "id": "9220"
     },
+    "Escobaria": {
+        "family": "Cactaceae",
+        "id": "10632"
+    },
     "Ferocactus": {
         "family": "Cactaceae",
         "id": "10633"
@@ -2115,6 +2123,10 @@
         "family": "Caryophyllaceae",
         "id": "10431"
     },
+    "Engellaria": {
+        "family": "Caryophyllaceae",
+        "id": "85147"
+    },
     "Eremogone": {
         "family": "Caryophyllaceae",
         "id": "68468"
@@ -2175,10 +2187,6 @@
         "family": "Caryophyllaceae",
         "id": "10855"
     },
-    "Schizotechium": {
-        "family": "Caryophyllaceae",
-        "id": "85148"
-    },
     "Scleranthus": {
         "family": "Caryophyllaceae",
         "id": "10857"
@@ -2203,6 +2211,10 @@
         "family": "Caryophyllaceae",
         "id": "10852"
     },
+    "Torreyostellaria": {
+        "family": "Caryophyllaceae",
+        "id": "8632"
+    },
     "Euonymus": {
         "family": "Celastraceae",
         "id": "9802"
@@ -2315,30 +2327,14 @@
         "family": "Cistaceae",
         "id": "10869"
     },
-    "Carsonia": {
-        "family": "Cleomaceae",
-        "id": "91883"
-    },
     "Cleomella": {
         "family": "Cleomaceae",
         "id": "10309"
     },
-    "Oxystylis": {
-        "family": "Cleomaceae",
-        "id": "10312"
-    },
-    "Peritoma": {
-        "family": "Cleomaceae",
-        "id": "91884"
-    },
     "Polanisia": {
         "family": "Cleomaceae",
         "id": "10313"
     },
-    "Wislizenia": {
-        "family": "Cleomaceae",
-        "id": "10314"
-    },
     "Comandra": {
         "family": "Comandraceae",
         "id": "10714"
@@ -2735,6 +2731,10 @@
         "family": "Fabaceae",
         "id": "9376"
     },
+    "Neltuma": {
+        "family": "Fabaceae",
+        "id": "68919"
+    },
     "Olneya": {
         "family": "Fabaceae",
         "id": "9384"
@@ -2751,6 +2751,10 @@
         "family": "Fabaceae",
         "id": "9391"
     },
+    "Paraserianthes": {
+        "family": "Fabaceae",
+        "id": "9393"
+    },
     "Parkinsonia": {
         "family": "Fabaceae",
         "id": "9394"
@@ -2775,10 +2779,6 @@
         "family": "Fabaceae",
         "id": "9404"
     },
-    "Prosopis": {
-        "family": "Fabaceae",
-        "id": "9406"
-    },
     "Psorothamnus": {
         "family": "Fabaceae",
         "id": "9408"
@@ -2811,6 +2811,10 @@
         "family": "Fabaceae",
         "id": "9420"
     },
+    "Strombocarpa": {
+        "family": "Fabaceae",
+        "id": "8678"
+    },
     "Thermopsis": {
         "family": "Fabaceae",
         "id": "10382"

package/data/synonyms.csv

@@ -597,10 +597,12 @@ Dodecatheon jeffreyi subsp. jeffreyi,Primula jeffreyi
 Dodecatheon jeffreyi subsp. pygmaeum,Primula jeffreyi
 Dodecatheon jeffreyi var. alpinum,Primula tetrandra
 Dodecatheon tetrandrum,Primula tetrandra
+Downingia concolor var. tricolor,Downingia concolor var. concolor
 Downingia immaculata,Downingia cuspidata
 Downingia mirabilis,Downingia ornatissima var. mirabilis
 Downingia mirabilis var. eximia,Downingia ornatissima var. mirabilis
 Downingia ornatissima var. eximia,Downingia ornatissima var. mirabilis
+Downingia tricolor,Downingia concolor var. concolor
 Draba cuneifolia var. cuneifolia,Draba cuneifolia
 Draba cuneifolia var. integrifolia,Draba cuneifolia
 Draba cuneifolia var. sonorae,Draba cuneifolia

package/data/taxa.csv

@@ -592,11 +592,12 @@ Dipterostemon capitatus,blue dicks,N,108599,13632,1196784,Blue Dicks
 Dirca occidentalis,western leatherwood,N,23143,2739,50315,Western Leatherwood,,,,,567,1B.2,,,S2,G2
 Distichlis spicata,saltgrass,N,23161,2743,58372,Saltgrass
 Dittrichia graveolens,stinkwort,X,2454,8482,58822
-Downingia bella,,N,23273,2766,60160,Hoover's Downingia
-Downingia cuspidata,,N,101864,2773,60163,Toothed Calicoflower
-Downingia insignis,,N,23278,2776,60164,Harlequin Calicoflower
-Downingia ornatissima var. mirabilis,,N,84766,14563
-Downingia pulchella,,N,23282,2782,60167,Flatface Calicoflower
+Downingia bella,,N,23273,2766,60160,Hoover's Downingia,annual,blue,3,5
+Downingia concolor var. concolor,maroonspot calicoflower,N,57811,2772,80674,Maroonspot Calicoflower,annual,blue,4,7
+Downingia cuspidata,,N,101864,2773,60163,Toothed Calicoflower,annual,blue,3,6
+Downingia insignis,,N,23278,2776,60164,Harlequin Calicoflower,annual,blue,3,5
+Downingia ornatissima var. mirabilis,,N,84766,14563,,,annual,blue,4,5
+Downingia pulchella,,N,23282,2782,60167,Flatface Calicoflower,annual,blue,4,6
 Draba cuneifolia,,N,23332,2798,1138678,Wedgeleaf Draba
 Draba verna,spring whitlow-grass,X,23442,2816,55823,,,white,2,5
 Drymocallis glandulosa var. glandulosa,sticky cinquefoil,N,82059,11609,80678,Sticky Cinquefoil,perennial,"yellow,white",5,7

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/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,32 @@
+/** @typedef {{
+    coords?: [number, number];
+    project_id?: string;
+    subview?: "grid" | "list" | "map";
+    taxon_id?: string;
+}} InatObsOptions */
+
 class ExternalSites {
     /**
      * @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 +34,7 @@ class ExternalSites {
                 case "subview":
                 case "taxon_id":
                 case "taxon_name":
-                    if (v) {
+                    if (typeof v === "string") {
                         url.searchParams.set(k, v);
                     }
                     break;

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/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;

package/lib/index.d.ts

@@ -1,5 +1,29 @@
 import { Command } from "commander";
 
+// Types
+
+export type TaxonData = {
+    bloom_end: string;
+    bloom_start: string;
+    calrecnum: string;
+    calscape_cn?: 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: "N" | "NC" | "U" | "X";
+    taxon_name: string;
+};
+
+// Classes
+
 export class Config {
     constructor(dataDir: string);
     getConfigValue(
@@ -94,6 +118,12 @@ export class Program {
     static getProgram(): Command;
 }
 
+export class Family {}
+
+export class Genera {}
+
+export class Genus {}
+
 export class Taxa {
     constructor(
         inclusionList: Record<string, TaxonData> | true,
@@ -101,7 +131,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[];

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 };