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

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";
@@ -15,7 +15,7 @@ class Genera {
     }
 
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      */
     addTaxon(taxon) {
         const genusName = taxon.getGenusName();
@@ -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/htmltaxon.js

@@ -6,7 +6,15 @@ import { RarePlants } from "./rareplants.js";
 import { TextUtils } from "./textutils.js";
 
 /**
- * @type {Record<string,{title:string,data:function (Taxon):string}>}
+ * @typedef {{
+    class?: string;
+    data: (taxon: import("./taxon.js").Taxon) => string;
+    title: string;
+     }} TaxaColDef
+ */
+
+/**
+ * @type {Record<string,TaxaColDef>}
  */
 const TAXA_LIST_COLS = {
     CESA: {
@@ -39,6 +47,7 @@ const TAXA_LIST_COLS = {
     },
 };
 
+/** @type {TaxaColDef[]} */
 const DEFAULT_TAXA_COLUMNS = [
     TAXA_LIST_COLS.SPECIES,
     TAXA_LIST_COLS.COMMON_NAME,
@@ -46,7 +55,7 @@ const DEFAULT_TAXA_COLUMNS = [
 
 class HTMLTaxon {
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      * @returns {string|undefined}
      */
     static getCalscapeLink(taxon) {
@@ -88,7 +97,7 @@ class HTMLTaxon {
     }
 
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      * @param {string} classNames
      * @param {boolean} [includeColorLink=true]
      */
@@ -129,7 +138,7 @@ class HTMLTaxon {
     }
 
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      * @returns {string}
      */
     static getFooterHTML(taxon) {
@@ -142,7 +151,7 @@ class HTMLTaxon {
     }
 
     /**
-     * @param {Taxon} taxon
+     * @param {import("./taxon.js").Taxon} taxon
      */
     static getLink(taxon) {
         return (
@@ -182,8 +191,8 @@ class HTMLTaxon {
     }
 
     /**
-     * @param {Taxon[]} taxa
-     * @param {TaxaCol[]} [columns]
+     * @param {import("./taxon.js").Taxon[]} taxa
+     * @param {TaxaColDef[]} [columns]
      */
     static getTaxaTable(taxa, columns = DEFAULT_TAXA_COLUMNS) {
         let html = "<table><thead>";

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(
@@ -79,11 +103,27 @@ export class Jekyll {
     static include(fileName: string): string;
 }
 
+type PhotoRights = "CC0" | "CC BY" | "CC BY-NC" | "C" | null;
+
+export class Photo {
+    getAttribution(): string;
+    getExt(): string;
+    getId(): number;
+    getSourceUrl(): string;
+    getUrl(): string;
+}
+
 export class Program {
     static getIncludeList(dataDir: string): string[];
     static getProgram(): Command;
 }
 
+export class Family {}
+
+export class Genera {}
+
+export class Genus {}
+
 export class Taxa {
     constructor(
         inclusionList: Record<string, TaxonData> | true,
@@ -91,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[];
@@ -101,14 +141,19 @@ export class Taxon {
     getBaseFileName(): string;
     getCalfloraID(): string;
     getCalfloraTaxonLink(): string;
+    getCESA(): string | undefined;
+    getCNDDBRank(): string | undefined;
     getCommonNames(): string[];
     getFamily(): Family;
+    getFESA(): string | undefined;
     getGenus(): Genus;
     getGenusName(): string;
+    getGlobalRank(): string | undefined;
     getINatID(): string;
     getINatTaxonLink(): string;
     getJepsonID(): string;
     getName(): string;
+    getPhotos(): Photo[];
     getRPIRankAndThreat(): string;
     getRPITaxonLink(): string;
     getSynonyms(): string[];

package/lib/pagerenderer.js

@@ -7,259 +7,262 @@ import { HTML } from "./html.js";
 import { HTMLTaxon, TAXA_LIST_COLS } from "./htmltaxon.js";
 
 const ENDANGERED_COLS = [
-  TAXA_LIST_COLS.SPECIES,
-  TAXA_LIST_COLS.COMMON_NAME,
-  TAXA_LIST_COLS.CESA,
-  TAXA_LIST_COLS.FESA,
+    TAXA_LIST_COLS.SPECIES,
+    TAXA_LIST_COLS.COMMON_NAME,
+    TAXA_LIST_COLS.CESA,
+    TAXA_LIST_COLS.FESA,
 ];
 const RPI_COLUMNS = [
-  TAXA_LIST_COLS.SPECIES_BARE,
-  TAXA_LIST_COLS.COMMON_NAME,
-  TAXA_LIST_COLS.CNPS_RANK,
+    TAXA_LIST_COLS.SPECIES_BARE,
+    TAXA_LIST_COLS.COMMON_NAME,
+    TAXA_LIST_COLS.CNPS_RANK,
 ];
 
 class PageRenderer extends BasePageRenderer {
-  /**
-   * @param {string} outputDir
-   * @param {import('./config.js').Config} config
-   * @param {Taxa} taxa
-   */
-  static render(outputDir, config, taxa) {
-    super.renderBasePages(outputDir, taxa);
+    /**
+     * @param {string} outputDir
+     * @param {import('./config.js').Config} config
+     * @param {import("./taxa.js").Taxa} taxa
+     */
+    static render(outputDir, config, taxa) {
+        super.renderBasePages(outputDir, taxa);
 
-    this.renderLists(outputDir, config, taxa);
+        this.renderLists(outputDir, config, taxa);
 
-    const taxonList = taxa.getTaxonList();
-    for (const taxon of taxonList) {
-      new PageTaxon(outputDir, config, taxon).render();
+        const taxonList = taxa.getTaxonList();
+        for (const taxon of taxonList) {
+            new PageTaxon(outputDir, config, taxon).render();
+        }
     }
-  }
 
-  /**
-   * @param {string} outputDir
-   * @param {Config} config
-   * @param {Taxa} taxa
-   */
-  static renderLists(outputDir, config, taxa) {
     /**
-     * @param {ListInfo[]} listInfo
-     * @param {Object<string,string>} attributes
-     * @param {TaxaCol[]} [columns]
-     * @returns {string}
+     * @param {string} outputDir
+     * @param {import('./config.js').Config} config
+     * @param {import("./taxa.js").Taxa} taxa
      */
-    function getListArray(listInfo, attributes = {}, columns) {
-      const listArray = [];
-      for (const list of listInfo) {
-        const listTaxa = [];
-        const calfloraTaxa = [];
-        const iNatTaxa = [];
-        for (const taxon of taxa.getTaxonList()) {
-          if (list.include(taxon)) {
-            listTaxa.push(taxon);
-            calfloraTaxa.push(taxon.getCalfloraName());
-            iNatTaxa.push(taxon.getINatName());
-          }
-        }
+    static renderLists(outputDir, config, taxa) {
+        /**
+         * @param {ListInfo[]} listInfo
+         * @param {Object<string,string>} attributes
+         * @param {import("./htmltaxon.js").TaxaColDef[]} [columns]
+         * @returns {string}
+         */
+        function getListArray(listInfo, attributes = {}, columns) {
+            const listArray = [];
+            for (const list of listInfo) {
+                const listTaxa = [];
+                const calfloraTaxa = [];
+                const iNatTaxa = [];
+                for (const taxon of taxa.getTaxonList()) {
+                    if (list.include(taxon)) {
+                        listTaxa.push(taxon);
+                        calfloraTaxa.push(taxon.getCalfloraName());
+                        iNatTaxa.push(taxon.getINatName());
+                    }
+                }
 
-        if (listTaxa.length === 0) {
-          continue;
-        }
+                if (listTaxa.length === 0) {
+                    continue;
+                }
 
-        Files.write(
-          outputDir + "/calflora_" + list.filename + ".txt",
-          calfloraTaxa.join("\n")
-        );
-        Files.write(
-          outputDir + "/inat_" + list.filename + ".txt",
-          iNatTaxa.join("\n")
-        );
+                Files.write(
+                    outputDir + "/calflora_" + list.filename + ".txt",
+                    calfloraTaxa.join("\n"),
+                );
+                Files.write(
+                    outputDir + "/inat_" + list.filename + ".txt",
+                    iNatTaxa.join("\n"),
+                );
 
-        const cols = columns ? columns : list.columns;
-        new PageTaxonList(outputDir, list.name, list.filename).render(
-          listTaxa,
-          cols
-        );
+                const cols = columns ? columns : list.columns;
+                new PageTaxonList(outputDir, list.name, list.filename).render(
+                    listTaxa,
+                    cols,
+                );
 
-        // Check for sublists.
-        const subListHTML = list.listInfo
-          ? getListArray(list.listInfo, { class: "indent" }, cols)
-          : "";
+                // Check for sublists.
+                const subListHTML = list.listInfo
+                    ? getListArray(list.listInfo, { class: "indent" }, cols)
+                    : "";
 
-        listArray.push(
-          HTML.getLink("./" + list.filename + ".html", list.name) +
-            " (" +
-            listTaxa.length +
-            ")" +
-            subListHTML
-        );
-      }
+                listArray.push(
+                    HTML.getLink("./" + list.filename + ".html", list.name) +
+                        " (" +
+                        listTaxa.length +
+                        ")" +
+                        subListHTML,
+                );
+            }
 
-      return renderList(listArray, attributes);
-    }
+            return renderList(listArray, attributes);
+        }
 
-    /**
-     * @param {string[]} listsHTML
-     * @param {Object<string,string>} attributes
-     */
-    function renderList(listsHTML, attributes = {}) {
-      return HTML.wrap("ul", HTML.arrayToLI(listsHTML), attributes);
-    }
+        /**
+         * @param {string[]} listsHTML
+         * @param {Object<string,string>} attributes
+         */
+        function renderList(listsHTML, attributes = {}) {
+            return HTML.wrap("ul", HTML.arrayToLI(listsHTML), attributes);
+        }
 
-    /**
-     * @param {string} title
-     * @param {string} listsHTML
-     */
-    function renderSection(title, listsHTML) {
-      let html = '<div class="section nobullet">';
-      html += HTML.textElement("h2", title);
-      html += listsHTML;
-      html += "</div>";
-      return html;
-    }
+        /**
+         * @param {string} title
+         * @param {string} listsHTML
+         */
+        function renderSection(title, listsHTML) {
+            let html = '<div class="section nobullet">';
+            html += HTML.textElement("h2", title);
+            html += listsHTML;
+            html += "</div>";
+            return html;
+        }
 
-    /** @typedef {{name:string,filename:string,include:function(Taxon):boolean,columns?:TaxaCol[],listInfo?:ListInfo[]}} ListInfo */
-    /** @type {{title:string,listInfo:ListInfo[]}[]} */
-    const sections = [
-      {
-        title: "All Species",
-        listInfo: [
-          {
-            name: config.getLabel("native", "Native"),
-            filename: "list_native",
-            include: (t) => t.isNative(),
-          },
-          {
-            name: config.getLabel("introduced", "Introduced"),
-            filename: "list_introduced",
-            include: (t) => !t.isNative(),
-          },
-          {
-            name: "All Plants",
-            filename: "list_all",
-            include: () => true,
-          },
-        ],
-      },
-      {
-        title: "Rare Plants",
-        listInfo: [
-          {
-            name: "CNPS Ranked Plants",
-            filename: "list_rpi",
-            include: (t) => t.getRPIRank() !== undefined,
-            columns: RPI_COLUMNS,
-            listInfo: [
-              {
-                name: RarePlants.getRPIRankDescription("1A"),
-                filename: "list_rpi_1a",
-                include: (t) => t.getRPIRank() === "1A",
-              },
-              {
-                name: RarePlants.getRPIRankDescription("1B"),
-                filename: "list_rpi_1b",
-                include: (t) => t.getRPIRank() === "1B",
-              },
-              {
-                name: RarePlants.getRPIRankDescription("2A"),
-                filename: "list_rpi_2a",
-                include: (t) => t.getRPIRank() === "2A",
-              },
-              {
-                name: RarePlants.getRPIRankDescription("2B"),
-                filename: "list_rpi_2b",
-                include: (t) => t.getRPIRank() === "2B",
-              },
-              {
-                name: RarePlants.getRPIRankDescription("3"),
-                filename: "list_rpi_3",
-                include: (t) => t.getRPIRank() === "3",
-              },
-              {
-                name: RarePlants.getRPIRankDescription("4"),
-                filename: "list_rpi_4",
-                include: (t) => t.getRPIRank() === "4",
-              },
-            ],
-          },
-          {
-            name: "Endangered Species",
-            filename: "list_endangered",
-            include: (t) =>
-              t.getCESA() !== undefined || t.getFESA() !== undefined,
-            columns: ENDANGERED_COLS,
-          },
-        ],
-      },
-    ];
+        /** @typedef {{name:string,filename:string,include:function(import("./taxon.js").Taxon):boolean,columns?:import("./htmltaxon.js").TaxaColDef[],listInfo?:ListInfo[]}} ListInfo */
+        /** @type {{title:string,listInfo:ListInfo[]}[]} */
+        const sections = [
+            {
+                title: "All Species",
+                listInfo: [
+                    {
+                        name: config.getLabel("native", "Native"),
+                        filename: "list_native",
+                        include: (t) => t.isNative(),
+                    },
+                    {
+                        name: config.getLabel("introduced", "Introduced"),
+                        filename: "list_introduced",
+                        include: (t) => !t.isNative(),
+                    },
+                    {
+                        name: "All Plants",
+                        filename: "list_all",
+                        include: () => true,
+                    },
+                ],
+            },
+            {
+                title: "Rare Plants",
+                listInfo: [
+                    {
+                        name: "CNPS Ranked Plants",
+                        filename: "list_rpi",
+                        include: (t) => t.getRPIRank() !== undefined,
+                        columns: RPI_COLUMNS,
+                        listInfo: [
+                            {
+                                name: RarePlants.getRPIRankDescription("1A"),
+                                filename: "list_rpi_1a",
+                                include: (t) => t.getRPIRank() === "1A",
+                            },
+                            {
+                                name: RarePlants.getRPIRankDescription("1B"),
+                                filename: "list_rpi_1b",
+                                include: (t) => t.getRPIRank() === "1B",
+                            },
+                            {
+                                name: RarePlants.getRPIRankDescription("2A"),
+                                filename: "list_rpi_2a",
+                                include: (t) => t.getRPIRank() === "2A",
+                            },
+                            {
+                                name: RarePlants.getRPIRankDescription("2B"),
+                                filename: "list_rpi_2b",
+                                include: (t) => t.getRPIRank() === "2B",
+                            },
+                            {
+                                name: RarePlants.getRPIRankDescription("3"),
+                                filename: "list_rpi_3",
+                                include: (t) => t.getRPIRank() === "3",
+                            },
+                            {
+                                name: RarePlants.getRPIRankDescription("4"),
+                                filename: "list_rpi_4",
+                                include: (t) => t.getRPIRank() === "4",
+                            },
+                        ],
+                    },
+                    {
+                        name: "Endangered Species",
+                        filename: "list_endangered",
+                        include: (t) =>
+                            t.getCESA() !== undefined ||
+                            t.getFESA() !== undefined,
+                        columns: ENDANGERED_COLS,
+                    },
+                ],
+            },
+        ];
 
-    let html = '<div class="wrapper">';
-    for (const section of sections) {
-      const listHTML = getListArray(section.listInfo);
+        let html = '<div class="wrapper">';
+        for (const section of sections) {
+            const listHTML = getListArray(section.listInfo);
 
-      if (listHTML.length > 0) {
-        html += renderSection(section.title, listHTML);
-      }
-    }
-    html += renderSection(
-      "Taxonomy",
-      renderList([HTML.getLink("./list_families.html", "Plant Families")])
-    );
+            if (listHTML.length > 0) {
+                html += renderSection(section.title, listHTML);
+            }
+        }
+        html += renderSection(
+            "Taxonomy",
+            renderList([
+                HTML.getLink("./list_families.html", "Plant Families"),
+            ]),
+        );
 
-    html += "</div>";
+        html += "</div>";
 
-    // Write lists to includes directory so it can be inserted into pages.
-    Files.write(outputDir + "/_includes/plantlists.html", html);
-  }
+        // Write lists to includes directory so it can be inserted into pages.
+        Files.write(outputDir + "/_includes/plantlists.html", html);
+    }
 }
 
 class PageTaxonList extends GenericPage {
-  /**
-   * @param {string} outputDir
-   * @param {string} title
-   * @param {string} baseName
-   */
-  constructor(outputDir, title, baseName) {
-    super(outputDir, title, baseName);
-  }
+    /**
+     * @param {string} outputDir
+     * @param {string} title
+     * @param {string} baseName
+     */
+    constructor(outputDir, title, baseName) {
+        super(outputDir, title, baseName);
+    }
 
-  /**
-   *
-   * @param {Taxon[]} taxa
-   * @param {TaxaCol[]|undefined} columns
-   */
-  render(taxa, columns) {
-    let html = this.getDefaultIntro();
+    /**
+     *
+     * @param {import("./taxon.js").Taxon[]} taxa
+     * @param {import("./htmltaxon.js").TaxaColDef[]|undefined} columns
+     */
+    render(taxa, columns) {
+        let html = this.getDefaultIntro();
 
-    html += '<div class="wrapper">';
+        html += '<div class="wrapper">';
 
-    html += '<div class="section">';
-    html += HTMLTaxon.getTaxaTable(taxa, columns);
-    html += "</div>";
+        html += '<div class="section">';
+        html += HTMLTaxon.getTaxaTable(taxa, columns);
+        html += "</div>";
 
-    html += '<div class="section nobullet">';
-    html += HTML.textElement("h2", "Download");
-    html += "<ul>";
-    html +=
-      "<li>" +
-      HTML.getLink(
-        "./calflora_" + this.getBaseFileName() + ".txt",
-        "Calflora List"
-      ) +
-      "</li>";
-    html +=
-      "<li>" +
-      HTML.getLink(
-        "./inat_" + this.getBaseFileName() + ".txt",
-        "iNaturalist List"
-      ) +
-      "</li>";
-    html += "</ul>";
-    html += "</div>";
+        html += '<div class="section nobullet">';
+        html += HTML.textElement("h2", "Download");
+        html += "<ul>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./calflora_" + this.getBaseFileName() + ".txt",
+                "Calflora List",
+            ) +
+            "</li>";
+        html +=
+            "<li>" +
+            HTML.getLink(
+                "./inat_" + this.getBaseFileName() + ".txt",
+                "iNaturalist List",
+            ) +
+            "</li>";
+        html += "</ul>";
+        html += "</div>";
 
-    html += "</div>";
+        html += "</div>";
 
-    this.writeFile(html);
-  }
+        this.writeFile(html);
+    }
 }
 
 export { PageRenderer };