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

package/lib/photo.js

@@ -1,44 +1,65 @@
-const CC0 = "CC0";
-const CC_BY = "CC BY";
-const CC_BY_NC = "CC BY-NC";
-const COPYRIGHT = "C";
+/**
+ * @typedef {"CC0" | "CC BY" | "CC BY-NC" | "C" | null} PhotoRights
+ */
 
-class Photo {
-    /** @type {string?} */
-    #url;
-    /** @type {string?} */
-    rightsHolder;
-    /** @type {null | typeof COPYRIGHT | typeof CC_BY | typeof CC_BY_NC | typeof CC0} */
-    rights;
+export class Photo {
+    #id;
+    #ext;
+    #rightsHolder;
+    /** @type {PhotoRights} */
+    #rights;
 
     /**
-     * @param {string?} url
-     * @param {string?} rightsHolder
-     * @param {null | typeof COPYRIGHT | typeof CC_BY | typeof CC_BY_NC | typeof CC0} rights
+     * @param {number} id
+     * @param {string} ext
+     * @param {import("./utils/inat-tools.js").InatLicenseCode} licenseCode
+     * @param {string} rightsHolder
      */
-    constructor( url, rightsHolder, rights ) {
-        this.#url = url;
-        this.rightsHolder = rightsHolder;
-        this.rights = rights;
+    constructor(id, ext, licenseCode, rightsHolder) {
+        this.#id = id;
+        this.#ext = ext;
+        this.#rightsHolder = rightsHolder;
+        if (licenseCode === "cc0") this.#rights = "CC0";
+        else if (licenseCode === "cc-by") this.#rights = "CC BY";
+        else if (licenseCode === "cc-by-nc") this.#rights = "CC BY-NC";
+        else this.#rights = "C";
     }
 
-    getUrl() {
-        return this.#url;
+    /**
+     * @returns {string}
+     */
+    getAttribution() {
+        if (this.#rights === "CC0") {
+            if (this.#rightsHolder) {
+                return `By ${this.#rightsHolder} (${this.#rights})`;
+            }
+            return this.#rights;
+        }
+        if (this.#rightsHolder) {
+            return `(c) ${this.#rightsHolder} (${this.#rights})`;
+        }
+        return `(c) (${this.#rights})`;
+    }
+
+    getExt() {
+        return this.#ext;
+    }
+
+    getId() {
+        return this.#id;
     }
 
     /**
-     * Return URL of page from whence this photo came
-     * @return {string?}
+     * @returns {string} The URL of the iNaturalist page with details about the image.
      */
     getSourceUrl() {
-        return null;
+        return `https://www.inaturalist.org/photos/${this.#id}`;
     }
-}
 
-export {
-    CC0,
-    CC_BY,
-    CC_BY_NC,
-    COPYRIGHT,
-    Photo
-};
+    /**
+     * @returns {string} The URL to retrieve the image file.
+     */
+    getUrl() {
+        return `https://inaturalist-open-data.s3.amazonaws.com/photos/${this.#id}/medium.${this.#ext}`;
+    }
+}

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

package/lib/taxa.js

@@ -7,10 +7,14 @@ import { Genera } from "./genera.js";
 import { Taxon } from "./taxon.js";
 import { Families } from "./families.js";
 import { FlowerColor } from "./flowercolor.js";
-import { InatPhoto } from "./inat_photo.js";
 import { TaxaCSV } from "./tools/taxacsv.js";
 import { ErrorLog } from "./errorlog.js";
 import { Program } from "./program.js";
+import { Photo } from "./photo.js";
+
+/**
+ * @typedef {{Current: string;Former: string;Type: string;}} SynonymData
+ */
 
 const FLOWER_COLORS = [
     { name: "white", color: "white" },
@@ -36,11 +40,11 @@ class Taxa {
     #isSubset;
 
     /**
-     * @param {Object<string,TaxonData>|true} inclusionList
+     * @param {Object<string,import("./index.js").TaxonData>|true} inclusionList
      * @param {ErrorLog} errorLog
      * @param {boolean} showFlowerErrors
-     * @param {function(TaxonData,Genera):Taxon} taxonFactory
-     * @param {TaxonData[]} [extraTaxa=[]]
+     * @param {function(import("./index.js").TaxonData,Genera):Taxon} taxonFactory
+     * @param {import("./index.js").TaxonData[]} [extraTaxa=[]]
      * @param {SynonymData[]} [extraSynonyms=[]]
      * @param {boolean} includePhotos
      */
@@ -110,9 +114,9 @@ class Taxa {
      */
     #loadPhotosFromFile(dataDir, filename) {
         if (!fs.existsSync(path.join(dataDir, filename))) return;
-        /** @type {InatCsvPhoto[]} */
+        /** @type {import("./utils/inat-tools.js").InatCsvPhoto[]} */
         const csvPhotos = CSV.parseFile(dataDir, filename).map((row) => {
-            /** @type {InatLicenseCode} */
+            /** @type {import("./utils/inat-tools.js").InatLicenseCode} */
             let licenseCode = "cc-by";
             if (row.licenseCode === "cc-by-nc-sa") licenseCode = "cc-by-nc-sa";
             else if (row.licenseCode === "cc-by-nc") licenseCode = "cc-by-nc";
@@ -138,7 +142,7 @@ class Taxa {
                 continue;
             }
             taxon.addPhoto(
-                new InatPhoto(
+                new Photo(
                     csvPhoto.id,
                     csvPhoto.ext,
                     csvPhoto.licenseCode,
@@ -220,7 +224,7 @@ class Taxa {
 
     /**
      * @param {SynonymData[]} synCSV
-     * @param {Object<string,TaxonData>|boolean} inclusionList
+     * @param {Object<string,import("./index.js").TaxonData>|boolean} inclusionList
      */
     #loadSyns(synCSV, inclusionList) {
         for (const syn of synCSV) {
@@ -241,9 +245,9 @@ class Taxa {
     }
 
     /**
-     * @param {TaxonData[]} taxaCSV
-     * @param {Object<string,TaxonData>|true} inclusionList
-     * @param {function(TaxonData,Genera):Taxon} taxonFactory
+     * @param {import("./index.js").TaxonData[]} taxaCSV
+     * @param {Object<string,import("./index.js").TaxonData>|true} inclusionList
+     * @param {function(import("./index.js").TaxonData,Genera):Taxon} taxonFactory
      * @param {Genera} genera
      * @param {boolean} showFlowerErrors
      */
@@ -251,7 +255,7 @@ class Taxa {
         for (const row of taxaCSV) {
             const name = row["taxon_name"];
 
-            /** @type {TaxonData|{status?:StatusCode}} */
+            /** @type {import("./index.js").TaxonData|{status?:import("./taxon.js").StatusCode}} */
             let taxon_overrides = {};
             if (inclusionList !== true) {
                 taxon_overrides = inclusionList[name];

package/lib/taxon.js

@@ -1,6 +1,10 @@
 import { HTML } from "./html.js";
 import { RarePlants } from "./rareplants.js";
 
+/**
+ * @typedef {"N" | "NC" | "U" | "X"} StatusCode
+ */
+
 const TAXA_COLNAMES = {
     BLOOM_START: "bloom_start",
     BLOOM_END: "bloom_end",
@@ -9,7 +13,6 @@ const TAXA_COLNAMES = {
 };
 
 class Taxon {
-    /** @type {Genera} */
     #genera;
     #name;
     #genus;
@@ -35,12 +38,12 @@ class Taxon {
     #rankGlobal;
     /** @type {string[]} */
     #synonyms = [];
-    /** @type {Photo[]} */
+    /** @type {import("./photo.js").Photo[]}*/
     #photos = [];
 
     /**
-     * @param {TaxonData} data
-     * @param {Genera} genera
+     * @param {import("./index.js").TaxonData} data
+     * @param {import("./genera.js").Genera} genera
      */
     constructor(data, genera) {
         this.#genera = genera;
@@ -98,12 +101,15 @@ class Taxon {
     }
 
     /**
-     * @param {InatPhoto} photo
+     * @param {import("./photo.js").Photo} photo
      */
     addPhoto(photo) {
         this.#photos = this.#photos.concat([photo]);
     }
 
+    /**
+     * @returns {import("./photo.js").Photo[]}
+     */
     getPhotos() {
         return this.#photos;
     }
@@ -325,7 +331,7 @@ class Taxon {
     }
 
     /**
-     * @param {Config} config
+     * @param {import("./config.js").Config} config
      * @returns {string}
      */
     getStatusDescription(config) {

package/lib/tools/calflora.js

@@ -1,6 +1,7 @@
 import * as path from "path";
 import { CSV } from "../csv.js";
 import { Files } from "../files.js";
+import { TaxaCSV } from "./taxacsv.js";
 
 const CALFLORA_URL_ALL =
     "https://www.calflora.org/app/downtext?xun=117493&table=species&format=Tab&cols=0,1,4,5,8,38,41,43&psp=lifeform::grass,Tree,Herb,Fern,Shrub,Vine!!&par=f&active=";
@@ -17,18 +18,27 @@ const CALFLORA_URL_COUNTY =
  * }} CalfloraData
  */
 
-class Calflora {
+export class Calflora {
     /** @type {Object<string,CalfloraData>} */
     static #taxa = {};
 
     /**
      *
      * @param {string} toolsDataDir
-     * @param {Taxa} taxa
+     * @param {string} dataDir
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
+     * @param {boolean} update
      */
-    static async analyze(toolsDataDir, taxa, exceptions, errorLog) {
+    static async analyze(
+        toolsDataDir,
+        dataDir,
+        taxa,
+        exceptions,
+        errorLog,
+        update,
+    ) {
         /**
          * @param {string} url
          * @param {string} targetFile
@@ -78,6 +88,8 @@ class Calflora {
             this.#taxa[row["Taxon"]] = row;
         }
 
+        const idsToUpdate = new Map();
+
         for (const taxon of taxa.getTaxonList()) {
             const name = taxon.getName();
             if (name.includes(" unknown")) {
@@ -152,16 +164,21 @@ class Calflora {
                     cfID,
                     taxon.getCalfloraID(),
                 );
+                idsToUpdate.set(name, cfID);
             }
         }
 
         this.#checkExceptions(taxa, exceptions, errorLog);
+
+        if (update) {
+            this.#updateIds(dataDir, idsToUpdate);
+        }
     }
 
     /**
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      */
     static #checkExceptions(taxa, exceptions, errorLog) {
         // Check the Calflora exceptions and make sure they still apply.
@@ -220,6 +237,22 @@ class Calflora {
             }
         }
     }
-}
 
-export { Calflora };
+    /**
+     * @param {string} dataDir
+     * @param {Map<string,string>} idsToUpdate
+     */
+    static #updateIds(dataDir, idsToUpdate) {
+        const taxa = new TaxaCSV(dataDir);
+
+        for (const taxonData of taxa.getTaxa()) {
+            const id = idsToUpdate.get(taxonData.taxon_name);
+            if (!id) {
+                continue;
+            }
+            taxonData["calrecnum"] = id;
+        }
+
+        taxa.write();
+    }
+}

package/lib/tools/calscape.js

@@ -8,9 +8,9 @@ export class Calscape {
     /**
      * @param {string} toolsDataDir
      * @param {string} dataDir
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      * @param {boolean} update
      */
     static async analyze(
@@ -58,9 +58,9 @@ export class Calscape {
 }
 
 /**
- * @param {Taxa} taxa
+ * @param {import("../taxa.js").Taxa} taxa
  * @param {import("../exceptions.js").Exceptions} exceptions
- * @param {ErrorLog} errorLog
+ * @param {import("../errorlog.js").ErrorLog} errorLog
  */
 function checkExceptions(taxa, exceptions, errorLog) {
     // Check the Calscape exceptions and make sure they still apply.

package/lib/tools/inat.js

@@ -21,9 +21,9 @@ export class INat {
     /**
      * @param {string} toolsDataDir
      * @param {string} dataDir
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      * @param {string} csvFileName
      * @param {boolean} update
      */
@@ -115,9 +115,9 @@ export class INat {
 
     /**
      *
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      */
     static #checkExceptions(taxa, exceptions, errorLog) {
         // Check the iNat exceptions and make sure they still apply.
@@ -168,9 +168,9 @@ export class INat {
 
     /**
      *
-     * @param {Taxa} taxa
+     * @param {import("../taxa.js").Taxa} taxa
      * @param {import("../exceptions.js").Exceptions} exceptions
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      * @param {string} name
      * @param {string} iNatName
      */
@@ -255,7 +255,7 @@ export class INat {
 
     /**
      * @param {{name:string,rank:string}} iNatResult
-     * @param {ErrorLog} errorLog
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      */
     static makeSynonymName(iNatResult, errorLog) {
         const synParts = iNatResult.name.split(" ");

package/lib/tools/jepsoneflora.js

@@ -1,6 +1,7 @@
 import { scrape } from "@htmltools/scrape";
 import { Files } from "../files.js";
 import { SynCSV } from "./syncsv.js";
+import { TaxaCSV } from "./taxacsv.js";
 
 /**
  * @typedef {{
@@ -53,8 +54,8 @@ export class JepsonEFlora {
 
     /**
      * @param {string} toolsDataDir
-     * @param {Taxa} taxa
-     * @param {ErrorLog} errorLog
+     * @param {import("../taxa.js").Taxa} taxa
+     * @param {import("../errorlog.js").ErrorLog} errorLog
      */
     constructor(toolsDataDir, taxa, errorLog) {
         this.#toolsDataPath = toolsDataDir + "/jepson-eflora";
@@ -63,16 +64,19 @@ export class JepsonEFlora {
     }
 
     /**
+     * @param {string} dataDir
      * @param {import("../exceptions.js").Exceptions} exceptions
      * @param {boolean} update
      */
-    async analyze(exceptions, update) {
+    async analyze(dataDir, exceptions, update) {
         // Create data directory if it's not there.
         Files.mkdir(this.#toolsDataPath);
 
         // Retrieve all Jepson indexes.
         await this.#loadIndexPages();
 
+        const idsToUpdate = new Map();
+
         for (const taxon of this.#taxa.getTaxonList()) {
             const name = taxon.getName();
             if (name.includes(" unknown")) {
@@ -95,6 +99,7 @@ export class JepsonEFlora {
                     taxon.getJepsonID(),
                     jepsInfo.id,
                 );
+                idsToUpdate.set(name, jepsInfo.id);
             }
 
             const efStatus = this.#getStatusCode(jepsInfo);
@@ -116,6 +121,7 @@ export class JepsonEFlora {
         this.#checkExceptions(exceptions);
 
         if (update) {
+            this.#updateIds(dataDir, idsToUpdate);
             this.#updateSynCSV();
         }
     }
@@ -222,7 +228,7 @@ export class JepsonEFlora {
 
     /**
      * @param {JepsonTaxon} jepsInfo
-     * @returns {StatusCode|undefined}
+     * @returns {import("../taxon.js").StatusCode|undefined}
      */
     #getStatusCode(jepsInfo) {
         switch (jepsInfo.type) {
@@ -396,6 +402,24 @@ export class JepsonEFlora {
         }
     }
 
+    /**
+     * @param {string} dataDir
+     * @param {Map<string,string>} idsToUpdate
+     */
+    #updateIds(dataDir, idsToUpdate) {
+        const taxa = new TaxaCSV(dataDir);
+
+        for (const taxonData of taxa.getTaxa()) {
+            const id = idsToUpdate.get(taxonData.taxon_name);
+            if (!id) {
+                continue;
+            }
+            taxonData["jepson id"] = id;
+        }
+
+        taxa.write();
+    }
+
     #updateSynCSV() {
         const csv = new SynCSV("./data");
         const data = csv.getData();

package/lib/tools/jepsonfamilies.js

@@ -0,0 +1,102 @@
+import path from "node:path";
+import { Files } from "../files.js";
+import { scrape } from "@htmltools/scrape";
+
+export class JepsonFamilies {
+    /**
+     * @param {string} toolsDataDir
+     * @param {string} outputdir
+     */
+    static async build(toolsDataDir, outputdir) {
+        const url = "https://ucjeps.berkeley.edu/eflora/toc.html";
+        const indexFileName = path.basename(url);
+        const toolsDataPath = toolsDataDir + "/jepsonfam";
+        const indexFilePath = toolsDataPath + "/" + indexFileName;
+
+        // Create data directory if it's not there.
+        Files.mkdir(toolsDataPath);
+
+        // Download the data file if it doesn't exist.
+        if (!Files.exists(indexFilePath)) {
+            console.log("retrieving Jepson family index");
+            await Files.fetch(url, indexFilePath);
+        }
+
+        const document = scrape.parseFile(indexFilePath);
+
+        const body = scrape.getSubtree(document, (t) => t.tagName === "body");
+        if (!body) {
+            throw new Error();
+        }
+        const contentDiv = scrape.getSubtree(
+            body,
+            (t) => scrape.getAttr(t, "id") === "content",
+        );
+        if (!contentDiv) {
+            throw new Error();
+        }
+        const rows = scrape.getSubtrees(contentDiv, (t) => t.tagName === "tr");
+
+        this.#parseRows(outputdir, rows);
+    }
+
+    /**
+     * @param {string} toolsDataPath
+     * @param {import("@htmltools/scrape").Element[]} rows
+     */
+    static #parseRows(toolsDataPath, rows) {
+        /** @type {Object<string,{section:string,id:string}>} */
+        const families = {};
+        /** @type {Object<string,{family:string,id:string}>} */
+        const genera = {};
+
+        for (const row of rows) {
+            const cols = scrape.getSubtrees(row, (t) => t.tagName === "td");
+            if (!cols || cols.length < 3) {
+                continue;
+            }
+
+            // Find the section.
+            const section = scrape.getTextContent(cols[0].children[0]);
+
+            // Find the family name and ID.
+            const familyLink = cols[1].children[0];
+            if (familyLink.type !== "element") {
+                throw new Error();
+            }
+            const familyTarget = scrape.getAttr(familyLink, "href");
+            if (!familyTarget) {
+                throw new Error();
+            }
+            const familyID = familyTarget.split("=")[1];
+            const familyName = scrape.getTextContent(familyLink.children[0]);
+            families[familyName] = { section: section, id: familyID };
+
+            // Find all the genera.
+            const genusLinks = scrape.getSubtrees(
+                cols[2],
+                (t) => t.tagName === "a",
+            );
+            for (const genusLink of genusLinks) {
+                const genusTarget = scrape.getAttr(genusLink, "href");
+                if (!genusTarget) {
+                    throw new Error();
+                }
+                const genusID = genusTarget.split("=")[1];
+                const genusName = scrape.getTextContent(genusLink.children[0]);
+                genera[genusName] = { family: familyName, id: genusID };
+            }
+        }
+
+        Files.write(
+            toolsDataPath + "/families.json",
+            JSON.stringify(families, undefined, 4),
+            true,
+        );
+        Files.write(
+            toolsDataPath + "/genera.json",
+            JSON.stringify(genera, undefined, 4),
+            true,
+        );
+    }
+}