@ca-plant-list/ca-plant-list 0.4.3 → 0.4.6

package/lib/index.d.ts

@@ -13,26 +13,29 @@ export class Config {
 }
 
 export class CSV {
-    static parseFile(dir: string, fileName: string);
+    static parseFile(dir: string, fileName: string): void;
 }
 
 export class ErrorLog {
     constructor(fileName: string, echo?: boolean);
-    log(...msg: string[]);
+    log(...msg: string[]): void;
     write(): void;
 }
 
 export class Exceptions {
     constructor(dataDir: string);
-    hasException(name: string, cat: string, subcat: string);
+    hasException(name: string, cat: string, subcat: string): boolean;
 }
 
 export class Files {
     static exists(fileName: string): boolean;
-    static async fetch(url: string | URL, targetFileName: string | undefined);
-    static mkdir(dir: string);
-    static rmDir(dir: string);
-    static write(fileName: string, data: string, overwrite: boolean);
+    static fetch(
+        url: string | URL,
+        targetFileName: string | undefined
+    ): Promise<Headers>;
+    static mkdir(dir: string): void;
+    static rmDir(dir: string): void;
+    static write(fileName: string, data: string, overwrite: boolean): void;
 }
 
 export class Program {
@@ -42,13 +45,13 @@ export class Program {
 
 export class Taxa {
     constructor(
-        inclusionList: Object<string, TaxonData> | true,
+        inclusionList: Record<string, TaxonData> | true,
         errorLog: ErrorLog,
         showFlowerErrors: boolean,
         taxonFactory?: (td: TaxonData, g: Genera) => Taxon,
         extraTaxa?: TaxonData[],
         extraSynonyms?: SynonymData[]
     );
-    getTaxon(string): Taxon;
+    getTaxon(name: string): Taxon;
     getTaxonList(): Taxon[];
 }

package/lib/markdown.js

@@ -6,8 +6,12 @@ class Markdown {
 
     /**
      * @param {string} filePath
+     * @returns {string|undefined}
      */
     static fileToHTML(filePath) {
+        if (!Files.exists(filePath)) {
+            return;
+        }
         return this.strToHTML(Files.read(filePath));
     }
 

package/lib/pagerenderer.js

@@ -7,260 +7,259 @@ 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 {Config} config
-     * @param {Taxa} taxa
-     */
-    static render(outputDir, config, taxa) {
-        super.renderBasePages(outputDir, taxa);
+  /**
+   * @param {string} outputDir
+   * @param {import('./config.js').Config} config
+   * @param {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 {string} outputDir
-     * @param {Config} config
-     * @param {Taxa} taxa
+     * @param {ListInfo[]} listInfo
+     * @param {Object<string,string>} attributes
+     * @param {TaxaCol[]} [columns]
+     * @returns {string}
      */
-    static renderLists(outputDir, config, taxa) {
-        /**
-         * @param {ListInfo[]} listInfo
-         * @param {Object<string,string>} attributes
-         * @param {TaxaCol[]} [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;
-                }
-
-                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
-                );
-
-                // 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
-                );
-            }
-
-            return renderList(listArray, attributes);
+    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());
+          }
         }
 
-        /**
-         * @param {string[]} listsHTML
-         * @param {Object<string,string>} attributes
-         */
-        function renderList(listsHTML, attributes = {}) {
-            return HTML.wrap("ul", HTML.arrayToLI(listsHTML), attributes);
+        if (listTaxa.length === 0) {
+          continue;
         }
 
-        /**
-         * @param {string} title
-         * @param {string} listsHTML
-         */
-        function renderSection(title, listsHTML) {
-            let html = '<div class="section">';
-            html += HTML.textElement("h2", title);
-            html += listsHTML;
-            html += "</div>";
-            return html;
-        }
+        Files.write(
+          outputDir + "/calflora_" + list.filename + ".txt",
+          calfloraTaxa.join("\n")
+        );
+        Files.write(
+          outputDir + "/inat_" + list.filename + ".txt",
+          iNatTaxa.join("\n")
+        );
 
-        /** @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,
-                    },
-                ],
-            },
-        ];
+        const cols = columns ? columns : list.columns;
+        new PageTaxonList(outputDir, list.name, list.filename).render(
+          listTaxa,
+          cols
+        );
 
-        let html = '<div class="wrapper">';
-        for (const section of sections) {
-            const listHTML = getListArray(section.listInfo);
+        // Check for sublists.
+        const subListHTML = list.listInfo
+          ? getListArray(list.listInfo, { class: "indent" }, cols)
+          : "";
 
-            if (listHTML.length > 0) {
-                html += renderSection(section.title, listHTML);
-            }
-        }
-        html += renderSection(
-            "Taxonomy",
-            renderList([HTML.getLink("./list_families.html", "Plant Families")])
+        listArray.push(
+          HTML.getLink("./" + list.filename + ".html", list.name) +
+            " (" +
+            listTaxa.length +
+            ")" +
+            subListHTML
         );
+      }
 
-        html += "</div>";
-
-        // Write lists to includes directory so it can be inserted into pages.
-        Files.write(outputDir + "/_includes/plantlists.html", html);
+      return renderList(listArray, attributes);
     }
-}
 
-class PageTaxonList extends GenericPage {
     /**
-     * @param {string} outputDir
-     * @param {string} title
-     * @param {string} baseName
+     * @param {string[]} listsHTML
+     * @param {Object<string,string>} attributes
      */
-    constructor(outputDir, title, baseName) {
-        super(outputDir, title, baseName);
+    function renderList(listsHTML, attributes = {}) {
+      return HTML.wrap("ul", HTML.arrayToLI(listsHTML), attributes);
     }
 
     /**
-     *
-     * @param {Taxon[]} taxa
-     * @param {TaxaCol[]|undefined} columns
+     * @param {string} title
+     * @param {string} listsHTML
      */
-    render(taxa, columns) {
-        let html = this.getDefaultIntro();
+    function renderSection(title, listsHTML) {
+      let html = '<div class="section nobullet">';
+      html += HTML.textElement("h2", title);
+      html += listsHTML;
+      html += "</div>";
+      return html;
+    }
 
-        html += '<div class="wrapper">';
+    /** @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,
+          },
+        ],
+      },
+    ];
 
-        html += '<div class="section">';
-        html += HTMLTaxon.getTaxaTable(taxa, columns);
-        html += "</div>";
+    let html = '<div class="wrapper">';
+    for (const section of sections) {
+      const listHTML = getListArray(section.listInfo);
 
-        html += '<div class="section">';
-        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>";
+      if (listHTML.length > 0) {
+        html += renderSection(section.title, listHTML);
+      }
+    }
+    html += renderSection(
+      "Taxonomy",
+      renderList([HTML.getLink("./list_families.html", "Plant Families")])
+    );
 
-        html += "</div>";
+    html += "</div>";
 
-        this.writeFile(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 {Taxon[]} taxa
+   * @param {TaxaCol[]|undefined} columns
+   */
+  render(taxa, columns) {
+    let html = this.getDefaultIntro();
+
+    html += '<div class="wrapper">';
+
+    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>";
+
+    this.writeFile(html);
+  }
 }
 
 export { PageRenderer };

package/lib/photo.js

@@ -0,0 +1,44 @@
+const CC0 = "CC0";
+const CC_BY = "CC BY";
+const CC_BY_NC = "CC BY-NC";
+const COPYRIGHT = "C";
+
+class Photo {
+    /** @type {string?} */
+    #url;
+    /** @type {string?} */
+    rightsHolder;
+    /** @type {null | typeof COPYRIGHT | typeof CC_BY | typeof CC_BY_NC | typeof CC0} */
+    rights;
+
+    /**
+     * @param {string?} url
+     * @param {string?} rightsHolder
+     * @param {null | typeof COPYRIGHT | typeof CC_BY | typeof CC_BY_NC | typeof CC0} rights
+     */
+    constructor( url, rightsHolder, rights ) {
+        this.#url = url;
+        this.rightsHolder = rightsHolder;
+        this.rights = rights;
+    }
+
+    getUrl() {
+        return this.#url;
+    }
+
+    /**
+     * Return URL of page from whence this photo came
+     * @return {string?}
+     */
+    getSourceUrl() {
+        return null;
+    }
+}
+
+export {
+    CC0,
+    CC_BY,
+    CC_BY_NC,
+    COPYRIGHT,
+    Photo
+};

package/lib/taxa.js

@@ -1,9 +1,13 @@
+import * as fs from "node:fs";
+import path from "node:path";
+
 import { Config } from "./config.js";
 import { CSV } from "./csv.js";
 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";
 
 const FLOWER_COLORS = [
     { name: "white", color: "white" },
@@ -35,6 +39,7 @@ class Taxa {
      * @param {function(TaxonData,Genera):Taxon} taxonFactory
      * @param {TaxonData[]} [extraTaxa=[]]
      * @param {SynonymData[]} [extraSynonyms=[]]
+     * @param {boolean} includePhotos
      */
     constructor(
         inclusionList,
@@ -42,7 +47,8 @@ class Taxa {
         showFlowerErrors,
         taxonFactory = (td, g) => new Taxon(td, g),
         extraTaxa = [],
-        extraSynonyms = []
+        extraSynonyms = [],
+        includePhotos = true
     ) {
         this.#isSubset = inclusionList !== true;
 
@@ -76,11 +82,39 @@ class Taxa {
             a.getName().localeCompare(b.getName())
         );
 
+
+        if ( includePhotos ) {
+            this.#loadInatPhotos( dataDir );
+        }
+
         const synCSV = CSV.parseFile(dataDir, "synonyms.csv");
         this.#loadSyns(synCSV, inclusionList);
         this.#loadSyns(extraSynonyms, inclusionList);
     }
 
+    /**
+     * @param {string} dataDir
+     */
+    #loadInatPhotos( dataDir ) {
+        const photosFileName = "inattaxonphotos.csv";
+        if ( fs.existsSync( path.join( dataDir, photosFileName ) ) ) {
+            /** @type {InatCsvPhoto[]} */
+            const csvPhotos = CSV.parseFile( dataDir, photosFileName );
+            for ( const csvPhoto of csvPhotos ) {
+                const taxon = this.getTaxon(csvPhoto.name);
+                if(!taxon) {
+                    continue;
+                }
+                taxon.addPhoto(new InatPhoto(
+                    csvPhoto.id,
+                    csvPhoto.ext,
+                    csvPhoto.licenseCode,
+                    csvPhoto.attrName
+                ) );
+            }
+        }
+    }
+
     getFamilies() {
         return this.#families;
     }
@@ -175,9 +209,9 @@ class Taxa {
                     const color = this.#flower_colors[colorName];
                     if (!color) {
                         throw new Error(
-                            'flower color "' +
+                            "flower color \"" +
                                 colorName +
-                                '" not found for ' +
+                                "\" not found for " +
                                 name
                         );
                     }