@ca-plant-list/ca-plant-list 0.3.2 → 0.3.4

package/lib/taxon.js

@@ -1,6 +1,7 @@
-import { Genera } from "./genera.js";
-import { HTML } from "./html.js";
+import { HTML } from "./index.js";
 import { RarePlants } from "./rareplants.js";
+// eslint-disable-next-line no-unused-vars
+import { Genera } from "./genera.js";
 
 const TAXA_COLNAMES = {
     BLOOM_START: "bloom_start",
@@ -10,15 +11,18 @@ const TAXA_COLNAMES = {
 };
 
 class Taxon {
-
+    /** @type {Genera} */
+    #genera;
     #name;
     #genus;
     #commonNames;
     #status;
     #jepsonID;
     #calRecNum;
+    /**@type {string|undefined} */
     #cfSyn;
     #iNatID;
+    /**@type {string|undefined} */
     #iNatSyn;
     #flowerColors;
     #bloomStart;
@@ -29,38 +33,54 @@ class Taxon {
     #fesa;
     #rankCNDDB;
     #rankGlobal;
+    /** @type {string[]} */
     #synonyms = [];
 
-    constructor( data ) {
-        const name = data[ "taxon_name" ];
-        const commonNames = data[ TAXA_COLNAMES.COMMON_NAME ];
-        const cesa = data[ "CESA" ];
-        const fesa = data[ "FESA" ];
-        const rankGlobal = data[ "GRank" ];
-        const rankCNDDB = data[ "SRank" ];
+    /**
+     * @param {import("./index.js").TaxonData} data
+     * @param {Genera} genera
+     */
+    constructor(data, genera) {
+        this.#genera = genera;
+        const name = data["taxon_name"];
+        const commonNames = data["common name"];
+        const cesa = data["CESA"];
+        const fesa = data["FESA"];
+        const rankGlobal = data["GRank"];
+        const rankCNDDB = data["SRank"];
         this.#name = name;
-        this.#genus = name.split( " " )[ 0 ];
-        this.#commonNames = commonNames ? commonNames.split( "," ).map( t => t.trim() ) : [];
-        this.#status = data[ "status" ];
-        this.#jepsonID = data[ "jepson id" ];
-        this.#calRecNum = data[ "calrecnum" ];
-        this.#iNatID = data[ "inat id" ];
-        const colors = data[ TAXA_COLNAMES.FLOWER_COLOR ];
-        this.#flowerColors = colors ? colors.split( "," ) : undefined;
-        this.#bloomStart = data[ TAXA_COLNAMES.BLOOM_START ];
-        this.#bloomEnd = data[ TAXA_COLNAMES.BLOOM_END ];
-        this.#rpiID = data[ "RPI ID" ];
-        this.#rankRPI = data[ "CRPR" ];
+        this.#genus = name.split(" ")[0];
+        this.#commonNames = commonNames
+            ? commonNames.split(",").map((t) => t.trim())
+            : [];
+        this.#status = data["status"];
+        this.#jepsonID = data["jepson id"];
+        this.#calRecNum = data["calrecnum"];
+        this.#iNatID = data["inat id"];
+        const colors = data["flower_color"];
+        this.#flowerColors = colors ? colors.split(",") : undefined;
+        if (data["bloom_start"]) {
+            this.#bloomStart = parseInt(data["bloom_start"]);
+        }
+        if (data["bloom_end"]) {
+            this.#bloomEnd = parseInt(data["bloom_end"]);
+        }
+        this.#rpiID = data["RPI ID"];
+        this.#rankRPI = data["CRPR"];
         this.#cesa = cesa ? cesa : undefined;
         this.#fesa = fesa ? fesa : undefined;
         this.#rankCNDDB = rankCNDDB ? rankCNDDB : undefined;
         this.#rankGlobal = rankGlobal ? rankGlobal : undefined;
-        Genera.addTaxon( this );
+        genera.addTaxon(this);
     }
 
-    addSynonym( syn, type ) {
-        this.#synonyms.push( syn );
-        switch ( type ) {
+    /**
+     * @param {string} syn
+     * @param {string} type
+     */
+    addSynonym(syn, type) {
+        this.#synonyms.push(syn);
+        switch (type) {
             case "CF":
                 // Synonym is in Calflora format.
                 this.#cfSyn = syn;
@@ -74,22 +94,28 @@ class Taxon {
 
     getBaseFileName() {
         // Convert spaces to "-" and remove ".".
-        return this.#name.replaceAll( " ", "-" ).replaceAll( ".", "" );
+        return this.#name.replaceAll(" ", "-").replaceAll(".", "");
     }
 
+    /**
+     * @returns {number|undefined}
+     */
     getBloomEnd() {
         return this.#bloomEnd;
     }
 
+    /**
+     * @returns {number|undefined}
+     */
     getBloomStart() {
         return this.#bloomStart;
     }
 
     getCalfloraName() {
-        if ( this.#cfSyn ) {
+        if (this.#cfSyn) {
             return this.#cfSyn;
         }
-        return this.getName().replace( " subsp.", " ssp." ).replace( "×", "X" );
+        return this.getName().replace(" subsp.", " ssp.").replace("×", "X");
     }
 
     getCalfloraID() {
@@ -98,11 +124,16 @@ class Taxon {
 
     getCalfloraTaxonLink() {
         const calfloraID = this.getCalfloraID();
-        if ( !calfloraID ) {
+        if (!calfloraID) {
             return;
         }
-        const link = HTML.getLink( "https://www.calflora.org/app/taxon?crn=" + calfloraID, "Calflora", {}, true );
-        return this.#cfSyn ? ( link + " (" + this.#cfSyn + ")" ) : link;
+        const link = HTML.getLink(
+            "https://www.calflora.org/app/taxon?crn=" + calfloraID,
+            "Calflora",
+            {},
+            true
+        );
+        return this.#cfSyn ? link + " (" + this.#cfSyn + ")" : link;
     }
 
     getCESA() {
@@ -118,14 +149,14 @@ class Taxon {
     }
 
     getFamily() {
-        return Genera.getFamily( this.#genus );
+        return this.#genera.getFamily(this.#genus);
     }
 
     getFESA() {
         return this.#fesa;
     }
 
-    getFileName( ext = "html" ) {
+    getFileName(ext = "html") {
         return this.getBaseFileName() + "." + ext;
     }
 
@@ -134,7 +165,7 @@ class Taxon {
     }
 
     getGenus() {
-        return Genera.getGenus( this.#genus );
+        return this.#genera.getGenus(this.#genus);
     }
 
     getGenusName() {
@@ -145,18 +176,29 @@ class Taxon {
         return this.#rankGlobal;
     }
 
-    getHTMLLink( href = true, includeRPI = true ) {
-        href = href ? ( "./" + this.getFileName() ) : undefined;
+    /**
+     *
+     * @param {boolean|string|undefined} href
+     * @param {boolean} includeRPI
+     */
+    getHTMLLink(href = true, includeRPI = true) {
+        href = href ? "./" + this.getFileName() : undefined;
         let className = this.isNative() ? "native" : "non-native";
         let isRare = false;
-        if ( includeRPI && this.isRare() ) {
+        if (includeRPI && this.isRare()) {
             isRare = true;
             className += " rare";
         }
         const attributes = { class: className };
-        const link = HTML.wrap( "span", HTML.getLink( href, this.getName() ), attributes );
-        if ( isRare ) {
-            return HTML.getToolTip( link, this.getRPIRankAndThreatTooltip(), { icon: false } );
+        const link = HTML.wrap(
+            "span",
+            HTML.getLink(href, this.getName()),
+            attributes
+        );
+        if (isRare) {
+            return HTML.getToolTip(link, this.getRPIRankAndThreatTooltip(), {
+                icon: false,
+            });
         }
         return link;
     }
@@ -167,7 +209,7 @@ class Taxon {
 
     getINatName() {
         const name = this.#iNatSyn ? this.#iNatSyn : this.getName();
-        return name.replace( / (subsp|var)\./, "" ).replace( "×", "× " );
+        return name.replace(/ (subsp|var)\./, "").replace("×", "× ");
     }
 
     getINatSyn() {
@@ -176,11 +218,16 @@ class Taxon {
 
     getINatTaxonLink() {
         const iNatID = this.getINatID();
-        if ( !iNatID ) {
+        if (!iNatID) {
             return "";
         }
-        const link = HTML.getLink( "https://www.inaturalist.org/taxa/" + iNatID, "iNaturalist", {}, true );
-        return this.#iNatSyn ? ( link + " (" + this.#iNatSyn + ")" ) : link;
+        const link = HTML.getLink(
+            "https://www.inaturalist.org/taxa/" + iNatID,
+            "iNaturalist",
+            {},
+            true
+        );
+        return this.#iNatSyn ? link + " (" + this.#iNatSyn + ")" : link;
     }
 
     getJepsonID() {
@@ -196,10 +243,10 @@ class Taxon {
     }
 
     getRPIRank() {
-        if ( !this.#rankRPI ) {
+        if (!this.#rankRPI) {
             return this.#rankRPI;
         }
-        return this.#rankRPI.split( "." )[ 0 ];
+        return this.#rankRPI.split(".")[0];
     }
 
     getRPIRankAndThreat() {
@@ -207,15 +254,22 @@ class Taxon {
     }
 
     getRPIRankAndThreatTooltip() {
-        return RarePlants.getRPIRankAndThreatDescriptions( this.getRPIRankAndThreat() ).join( "<br>" );
+        return RarePlants.getRPIRankAndThreatDescriptions(
+            this.getRPIRankAndThreat()
+        ).join("<br>");
     }
 
     getRPITaxonLink() {
         const rpiID = this.getRPIID();
-        if ( !rpiID ) {
+        if (!rpiID) {
             return "";
         }
-        const link = HTML.getLink( "https://rareplants.cnps.org/Plants/Details/" + rpiID, "CNPS Rare Plant Inventory", {}, true );
+        const link = HTML.getLink(
+            "https://rareplants.cnps.org/Plants/Details/" + rpiID,
+            "CNPS Rare Plant Inventory",
+            {},
+            true
+        );
         return link;
     }
 
@@ -223,16 +277,20 @@ class Taxon {
         return this.#status;
     }
 
-    getStatusDescription( config ) {
-        switch ( this.#status ) {
+    /**
+     * @param {*} config
+     * @returns
+     */
+    getStatusDescription(config) {
+        switch (this.#status) {
             case "N":
                 return "Native";
             case "NC":
-                return config.getLabel( "status-NC", "Introduced" );
+                return config.getLabel("status-NC", "Introduced");
             case "X":
                 return "Introduced";
         }
-        throw new Error( this.#status );
+        throw new Error(this.#status);
     }
 
     getSynonyms() {
@@ -257,7 +315,7 @@ class Taxon {
 
     shouldHaveFlowers() {
         const sectionName = this.getFamily().getSectionName();
-        switch ( sectionName ) {
+        switch (sectionName) {
             case "Ceratophyllales":
             case "Eudicots":
             case "Magnoliids":
@@ -269,9 +327,9 @@ class Taxon {
             case "Lycophytes":
                 return false;
             default:
-                throw new Error( sectionName );
+                throw new Error(sectionName);
         }
     }
 }
 
-export { TAXA_COLNAMES, Taxon };
+export { TAXA_COLNAMES, Taxon };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.3.2",
+    "version": "0.3.4",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -10,11 +10,7 @@
     "homepage": "https://github.com/ca-plants/ca-plant-list",
     "type": "module",
     "exports": {
-        ".": "./lib/index.js",
-        "./Families": "./lib/families.js",
-        "./Files": "./lib/files.js",
-        "./HTML": "./lib/html.js",
-        "./Jekyll": "./lib/jekyll.js"
+        ".": "./lib/index.js"
     },
     "types": "./lib/index.d.ts",
     "bin": {
@@ -35,6 +31,8 @@
     },
     "devDependencies": {
         "@types/node": "^18.11.9",
+        "@types/unzipper": "^0.10.9",
+        "dts-bundle-generator": "^9.3.1",
         "eslint": "^8.26.0",
         "typescript": "^5.3.3"
     }

package/scripts/build-ebook.js

@@ -6,64 +6,72 @@ import { Files } from "../lib/files.js";
 import { TaxaProcessor } from "../lib/taxaprocessor.js";
 import { CommandProcessor } from "../lib/commandprocessor.js";
 
-const OPTION_DEFS = [
-    { name: "locationsdir", type: String },
-];
+const OPTION_DEFS = [{ name: "locationsdir", type: String }];
 
 const OPTION_HELP = [
     {
         name: "locationsdir",
         type: String,
         typeLabel: "{underline path}",
-        description: "If this option is specified, multiple ebooks will be generated. {bold locationsdir} must be a subdirectory"
-            + " of the current directory, and each subdirectory of {bold locationsdir} is processed in turn to generate an ebook."
-            + " Each ebook is placed in a subdirectory of {bold outputdir}."
+        description:
+            "If this option is specified, multiple ebooks will be generated. {bold locationsdir} must be a subdirectory" +
+            " of the current directory, and each subdirectory of {bold locationsdir} is processed in turn to generate an ebook." +
+            " Each ebook is placed in a subdirectory of {bold outputdir}.",
     },
 ];
 
 class BookCommand extends CommandProcessor {
-
     constructor() {
-        super( "ca-plant-book", "A tool to generate an ebook with local plant data.", OPTION_DEFS, OPTION_HELP );
+        super(
+            "ca-plant-book",
+            "A tool to generate an ebook with local plant data.",
+            OPTION_DEFS,
+            OPTION_HELP
+        );
     }
-
 }
 
-async function commandRunner( tp ) {
+/**
+ * @param {TaxaProcessor} tp
+ */
+async function commandRunner(tp) {
     const options = tp.getOptions();
-    const ebook = new PlantBook( options.outputdir, new Config( options.datadir ), tp.getTaxa() );
+    const ebook = new PlantBook(
+        options.outputdir,
+        new Config(options.datadir),
+        tp.getTaxa()
+    );
     await ebook.create();
 }
 
-async function generateEBooks( options ) {
+async function generateEBooks(options) {
     const locationsDir = options.locationsdir;
 
     // If there is a "locations" directory, generate a book for all subdirectories.
-    if ( locationsDir ) {
+    if (locationsDir) {
         // Generate ebook for each location.
         const outputBase = options.outputdir;
-        const subdirs = Files.getDirEntries( locationsDir );
-        for ( const subdir of subdirs ) {
-            console.log( "Generating " + subdir );
+        const subdirs = Files.getDirEntries(locationsDir);
+        for (const subdir of subdirs) {
+            console.log("Generating " + subdir);
             const suffix = "/" + subdir;
             const path = locationsDir + suffix;
-            if ( Files.isDir( path ) ) {
+            if (Files.isDir(path)) {
                 options.datadir = path;
                 options.outputdir = outputBase + suffix;
-                const gen = new TaxaProcessor( options );
-                await gen.process( commandRunner );
+                const gen = new TaxaProcessor(options);
+                await gen.process(commandRunner);
             }
         }
     } else {
         // Otherwise use the default directory.
-        const gen = new TaxaProcessor( options );
-        await gen.process( commandRunner );
+        const gen = new TaxaProcessor(options);
+        await gen.process(commandRunner);
     }
-
 }
 
 const cmd = new BookCommand();
 const options = cmd.getOptions();
-if ( !options.help ) {
-    generateEBooks( options );
-}
+if (!options.help) {
+    await generateEBooks(options);
+}