@ca-plant-list/ca-plant-list 0.4.8 → 0.4.9

package/lib/web/pagetaxon.js

@@ -8,197 +8,206 @@ import { Markdown } from "../markdown.js";
 import { Config } from "../config.js";
 
 class PageTaxon extends GenericPage {
-  #config;
-  #taxon;
-
-  /**
-   * @param {string} outputDir
-   * @param {Config} config
-   * @param {Taxon} taxon
-   */
-  constructor(outputDir, config, taxon) {
-    super(outputDir, taxon.getName(), taxon.getBaseFileName());
-    this.#config = config;
-    this.#taxon = taxon;
-  }
-
-  #getInfoLinks() {
-    const links = [];
-    const jepsonID = this.#taxon.getJepsonID();
-    if (jepsonID) {
-      links.push(Jepson.getEFloraLink(jepsonID));
+    #config;
+    #taxon;
+
+    /**
+     * @param {string} outputDir
+     * @param {Config} config
+     * @param {Taxon} taxon
+     */
+    constructor(outputDir, config, taxon) {
+        super(outputDir, taxon.getName(), taxon.getBaseFileName());
+        this.#config = config;
+        this.#taxon = taxon;
     }
-    const cfLink = this.#taxon.getCalfloraTaxonLink();
-    if (cfLink) {
-      links.push(cfLink);
-    }
-    const iNatLink = this.#taxon.getINatTaxonLink();
-    if (iNatLink) {
-      links.push(iNatLink);
-    }
-    const rpiLink = this.#taxon.getRPITaxonLink();
-    if (rpiLink) {
-      links.push(rpiLink);
-    }
-    return links;
-  }
-
-  #getObsLinks() {
-    const links = [];
-    links.push(
-      HTML.getLink(
-        "https://www.calflora.org/entry/observ.html?track=m#srch=t&grezc=5&cols=b&lpcli=t&cc=" +
-          this.#config.getCountyCodes().join("!") +
-          "&incobs=f&taxon=" +
-          this.#taxon.getCalfloraName().replaceAll(" ", "+"),
-        "Calflora",
-        {},
-        true
-      )
-    );
-    const iNatID = this.#taxon.getINatID();
-    if (iNatID) {
-      const projectId = links.push(
-        HTML.getLink(
-          ExternalSites.getInatObsLink({
-            project_id: this.#config.getConfigValue("inat", "project_id"),
-            subview: "map",
-            taxon_id: iNatID,
-          }),
-          "iNaturalist",
-          {},
-          true
-        )
-      );
+
+    #getInfoLinks() {
+        const links = [];
+        const jepsonID = this.#taxon.getJepsonID();
+        if (jepsonID) {
+            links.push(Jepson.getEFloraLink(jepsonID));
+        }
+        const cfLink = this.#taxon.getCalfloraTaxonLink();
+        if (cfLink) {
+            links.push(cfLink);
+        }
+        const iNatLink = this.#taxon.getINatTaxonLink();
+        if (iNatLink) {
+            links.push(iNatLink);
+        }
+        const rpiLink = this.#taxon.getRPITaxonLink();
+        if (rpiLink) {
+            links.push(rpiLink);
+        }
+        return links;
     }
 
-    return links;
-  }
-
-  /**
-   * @param {string[]} list
-   * @param {string} header
-   * @param {string} className
-   */
-  #getListSectionHTML(list, header, className) {
-    let html = "";
-    if (list.length > 0) {
-      html += '<div class="section nobullet ' + className + '">';
-      html += HTML.textElement("h2", header);
-      html += "<ul>";
-      html += HTML.arrayToLI(list);
-      html += "</ul>";
-      html += "</div>";
+    #getObsLinks() {
+        const links = [];
+        links.push(
+            HTML.getLink(
+                "https://www.calflora.org/entry/observ.html?track=m#srch=t&grezc=5&cols=b&lpcli=t&cc=" +
+                    this.#config.getCountyCodes().join("!") +
+                    "&incobs=f&taxon=" +
+                    this.#taxon.getCalfloraName().replaceAll(" ", "+"),
+                "Calflora",
+                {},
+                true,
+            ),
+        );
+        const iNatID = this.#taxon.getINatID();
+        if (iNatID) {
+            links.push(
+                HTML.getLink(
+                    ExternalSites.getInatObsLink({
+                        project_id: this.#config.getConfigValue(
+                            "inat",
+                            "project_id",
+                        ),
+                        subview: "map",
+                        taxon_id: iNatID,
+                    }),
+                    "iNaturalist",
+                    {},
+                    true,
+                ),
+            );
+        }
+
+        return links;
     }
-    return html;
-  }
 
-  #getRarityInfo() {
-    const cnpsRank = this.#taxon.getRPIRankAndThreat();
-    if (!cnpsRank) {
-      return "";
+    /**
+     * @param {string[]} list
+     * @param {string} header
+     * @param {string} className
+     */
+    #getListSectionHTML(list, header, className) {
+        let html = "";
+        if (list.length > 0) {
+            html += '<div class="section nobullet ' + className + '">';
+            html += HTML.textElement("h2", header);
+            html += "<ul>";
+            html += HTML.arrayToLI(list);
+            html += "</ul>";
+            html += "</div>";
+        }
+        return html;
     }
-    const ranks = [];
-
-    ranks.push(
-      HTML.textElement("span", "CNPS Rare Plant Rank:", {
-        class: "label",
-      }) + HTML.getToolTip(cnpsRank, this.#taxon.getRPIRankAndThreatTooltip())
-    );
-    if (this.#taxon.getCESA()) {
-      ranks.push(
-        HTML.textElement("span", "CESA:", { class: "label" }) +
-          RarePlants.getCESADescription(this.#taxon.getCESA())
-      );
+
+    #getRarityInfo() {
+        const cnpsRank = this.#taxon.getRPIRankAndThreat();
+        if (!cnpsRank) {
+            return "";
+        }
+        const ranks = [];
+
+        ranks.push(
+            HTML.textElement("span", "CNPS Rare Plant Rank:", {
+                class: "label",
+            }) +
+                HTML.getToolTip(
+                    cnpsRank,
+                    this.#taxon.getRPIRankAndThreatTooltip(),
+                ),
+        );
+        if (this.#taxon.getCESA()) {
+            ranks.push(
+                HTML.textElement("span", "CESA:", { class: "label" }) +
+                    RarePlants.getCESADescription(this.#taxon.getCESA()),
+            );
+        }
+
+        return HTML.wrap("div", "<ul>" + HTML.arrayToLI(ranks) + "</ul>", {
+            class: "section",
+        });
     }
 
-    return HTML.wrap("div", "<ul>" + HTML.arrayToLI(ranks) + "</ul>", {
-      class: "section",
-    });
-  }
-
-  #getRelatedTaxaLinks() {
-    const links = [];
-    const genus = this.#taxon.getGenus();
-    if (genus) {
-      const taxa = genus.getTaxa();
-      if (taxa.length > 1) {
-        for (const taxon of taxa) {
-          links.push(
-            taxon.getHTMLLink(taxon.getName() !== this.#taxon.getName())
-          );
+    #getRelatedTaxaLinks() {
+        const links = [];
+        const genus = this.#taxon.getGenus();
+        if (genus) {
+            const taxa = genus.getTaxa();
+            if (taxa.length > 1) {
+                for (const taxon of taxa) {
+                    links.push(
+                        taxon.getHTMLLink(
+                            taxon.getName() !== this.#taxon.getName(),
+                        ),
+                    );
+                }
+            }
         }
-      }
+        return links;
     }
-    return links;
-  }
 
-  #getSynonyms() {
-    return this.#taxon.getSynonyms();
-  }
+    #getSynonyms() {
+        return this.#taxon.getSynonyms();
+    }
 
-  render() {
-    let html = this.getFrontMatter();
+    render() {
+        let html = this.getFrontMatter();
 
-    html += '<div class="wrapper">';
+        html += '<div class="wrapper">';
 
-    const cn = this.#taxon.getCommonNames();
-    if (cn.length > 0) {
-      html += HTML.textElement("div", cn.join(", "), {
-        class: "section common-names",
-      });
-    }
+        const cn = this.#taxon.getCommonNames();
+        if (cn.length > 0) {
+            html += HTML.textElement("div", cn.join(", "), {
+                class: "section common-names",
+            });
+        }
 
-    html += HTML.textElement(
-      "div",
-      this.#taxon.getStatusDescription(this.#config),
-      { class: "section native-status" }
-    );
-
-    const family = this.#taxon.getFamily();
-    html += HTML.wrap(
-      "div",
-      HTML.textElement("span", "Family:", { class: "label" }) +
-        HTML.getLink("./" + family.getFileName(), family.getName()),
-      { class: "section" }
-    );
-
-    html += this.#getRarityInfo();
-
-    html += "</div>";
-
-    html += HTMLTaxon.getFlowerInfo(this.#taxon, undefined, false);
-
-    html += this.getMarkdown();
-
-    html += '<div class="grid borders">';
-    html += this.#getListSectionHTML(
-      this.#getInfoLinks(),
-      "References",
-      "info"
-    );
-    html += this.#getListSectionHTML(
-      this.#getObsLinks(),
-      "Observations",
-      "obs"
-    );
-    html += this.#getListSectionHTML(
-      this.#getRelatedTaxaLinks(),
-      "Related Species",
-      "rel-taxa"
-    );
-    html += this.#getListSectionHTML(
-      this.#getSynonyms(),
-      "Synonyms",
-      "synonyms"
-    );
-    html += "</div>";
-
-    const photos = this.#taxon.getPhotos( );
-    if ( photos.length > 0 ) {
-      let photosHtml = "";
-      for ( const photo of photos ) {
-        photosHtml += `
+        html += HTML.textElement(
+            "div",
+            this.#taxon.getStatusDescription(this.#config),
+            { class: "section native-status" },
+        );
+
+        const family = this.#taxon.getFamily();
+        html += HTML.wrap(
+            "div",
+            HTML.textElement("span", "Family:", { class: "label" }) +
+                HTML.getLink("./" + family.getFileName(), family.getName()),
+            { class: "section" },
+        );
+
+        html += this.#getRarityInfo();
+
+        html += "</div>";
+
+        html += HTMLTaxon.getFlowerInfo(this.#taxon, undefined, false);
+
+        html += this.getMarkdown();
+
+        html += '<div class="grid borders">';
+        html += this.#getListSectionHTML(
+            this.#getInfoLinks(),
+            "References",
+            "info",
+        );
+        html += this.#getListSectionHTML(
+            this.#getObsLinks(),
+            "Observations",
+            "obs",
+        );
+        html += this.#getListSectionHTML(
+            this.#getRelatedTaxaLinks(),
+            "Related Species",
+            "rel-taxa",
+        );
+        html += this.#getListSectionHTML(
+            this.#getSynonyms(),
+            "Synonyms",
+            "synonyms",
+        );
+        html += "</div>";
+
+        const photos = this.#taxon.getPhotos();
+        if (photos.length > 0) {
+            let photosHtml = "";
+            for (const photo of photos) {
+                photosHtml += `
           <figure class="col">
             <a href="${photo.getSourceUrl()}">
               <img
@@ -213,27 +222,27 @@ class PageTaxon extends GenericPage {
             </figcaption>
           </figure>
         `;
-      }
-      html += `
+            }
+            html += `
         <h2>Photos</h2>
         <div class="row">
           ${photosHtml}
         </div>
       `;
-    }
+        }
 
-    const footerTextPath =
-      Config.getPackageDir() +
-      "/data/text/" +
-      this.getBaseFileName() +
-      ".footer.md";
-    const footerMarkdown = Markdown.fileToHTML(footerTextPath);
-    if (footerMarkdown) {
-      html += HTML.wrap("div", footerMarkdown, "section");
-    }
+        const footerTextPath =
+            Config.getPackageDir() +
+            "/data/text/" +
+            this.getBaseFileName() +
+            ".footer.md";
+        const footerMarkdown = Markdown.fileToHTML(footerTextPath);
+        if (footerMarkdown) {
+            html += HTML.wrap("div", footerMarkdown, "section");
+        }
 
-    this.writeFile(html);
-  }
+        this.writeFile(html);
+    }
 }
 
 export { PageTaxon };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.4.8",
+    "version": "0.4.9",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -15,7 +15,8 @@
     "types": "./lib/index.d.ts",
     "bin": {
         "ca-plant-list": "scripts/build-site.js",
-        "ca-plant-book": "scripts/build-ebook.js"
+        "ca-plant-book": "scripts/build-ebook.js",
+        "photo-tools": "scripts/photos.js"
     },
     "dependencies": {
         "archiver": "^5.3.1",
@@ -25,7 +26,7 @@
         "csv-stringify": "^6.5.1",
         "image-size": "^1.1.1",
         "markdown-it": "^14.1.0",
-        "sharp": "^0.32.1",
+        "sharp": "^0.33.5",
         "svgo-ll": "^5.6.0",
         "unzipper": "^0.10.11"
     },

package/scripts/photos.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+
+import path from "path";
+import { ErrorLog } from "../lib/errorlog.js";
+import { Program } from "../lib/program.js";
+import { Taxa } from "../lib/taxa.js";
+
+const OPT_LOADER = "loader";
+
+const MAX_PHOTOS = 5;
+
+/**
+ * @param {import("commander").Command} program
+ * @param {import("commander").OptionValues} options
+ */
+async function photos(program, options) {
+    const taxa = await getTaxa(options);
+    const errorLog = new ErrorLog(options.outputdir + "/log.tsv", true);
+
+    auditTaxaWithoutMaxPhotos(errorLog, taxa);
+
+    errorLog.write();
+}
+
+/**
+ * @param {ErrorLog} errorLog
+ * @param {Taxa} taxa
+ */
+function auditTaxaWithoutMaxPhotos(errorLog, taxa) {
+    for (const taxon of taxa.getTaxonList()) {
+        const photos = taxon.getPhotos();
+        if (photos.length !== MAX_PHOTOS) {
+            errorLog.log(taxon.getName(), photos.length.toString());
+        }
+    }
+}
+
+/**
+ * @param {import("commander").OptionValues} options
+ * @return {Promise<Taxa>}
+ */
+async function getTaxa(options) {
+    const errorLog = new ErrorLog(options.outputdir + "/errors.tsv", true);
+
+    const loader = options[OPT_LOADER];
+    let taxa;
+    if (loader) {
+        const taxaLoaderClass = await import("file:" + path.resolve(loader));
+        taxa = await taxaLoaderClass.TaxaLoader.loadTaxa(options, errorLog);
+    } else {
+        taxa = new Taxa(
+            Program.getIncludeList(options.datadir),
+            errorLog,
+            options.showFlowerErrors,
+        );
+    }
+
+    errorLog.write();
+    return taxa;
+}
+
+const program = Program.getProgram();
+program.option(
+    "--loader <path>",
+    "The path (relative to the current directory) of the JavaScript file containing the TaxaLoader class. If not provided, the default TaxaLoader will be used.",
+);
+program.action((options) => photos(program, options));
+await program.parseAsync();

package/types/classes.d.ts

@@ -9,7 +9,7 @@ declare class Config {
         prefix: string,
         name: string,
         subcategory?: string,
-        defaultValue?: string
+        defaultValue?: string,
     ): string | undefined;
     getCountyCodes(): string[];
     getLabel(name: string, dflt: string): string;
@@ -55,10 +55,6 @@ declare class GlossaryEntry {
     getTermName(): string;
 }
 
-declare class Images {
-    getTaxonImages(name: string): TaxonImage[];
-}
-
 declare class InatObsOptions {
     coords?: [number, number];
     project_id?: string;
@@ -72,7 +68,7 @@ declare class SiteGenerator {
     writeTemplate(
         content: string,
         attributes: Record<string, string>,
-        filename: string
+        filename: string,
     ): void;
 }
 
@@ -91,7 +87,7 @@ declare class Taxa {
 
 declare class TaxaCol {
     class?: string;
-    data:  (taxon:Taxon)=>string
+    data: (taxon: Taxon) => string;
     title: string;
 }
 
@@ -112,7 +108,7 @@ declare class Taxon {
     getGenusName(): string;
     getHTMLLink(
         href: boolean | string | undefined,
-        includeRPI?: boolean
+        includeRPI?: boolean,
     ): string;
     getINatID(): string;
     getINatName(): string;
@@ -149,19 +145,16 @@ declare class TaxonData {
     taxon_name: string;
 }
 
-declare class TaxonImage {
-    getCaption(): string | undefined;
-    getSrc(): string;
-}
-
-type PhotoRights = "CC0"| "CC BY"| "CC BY-NC"| "C"|null;
+type PhotoRights = "CC0" | "CC BY" | "CC BY-NC" | "C" | null;
 
 declare class Photo {
     url?: string;
     rightsHolder: null | string;
     rights?: PhotoRights;
-    getUrl: ( ) => string;
-    getSourceUrl: ( ) => string;
+    getExt(): string;
+    getId(): number;
+    getUrl(): string;
+    getSourceUrl(): string;
 }
 
 declare class InatPhoto extends Photo {
@@ -169,7 +162,8 @@ declare class InatPhoto extends Photo {
     ext: string;
 }
 
-type InatLicenseCode = "cc-by-nc-sa"
+type InatLicenseCode =
+    | "cc-by-nc-sa"
     | "cc-by-nc"
     | "cc-by-nc-nd"
     | "cc-by"
@@ -193,8 +187,8 @@ declare class InatApiTaxon {
         photo: {
             id: number;
             attribution: string;
-            license_code: InatLicenseCode
+            license_code: InatLicenseCode;
             medium_url: string;
-        }
-    }[]
+        };
+    }[];
 }

package/data/photos.csv

@@ -1,9 +0,0 @@
-taxon_name,source,credit
-Calochortus argillosus,https://inaturalist-open-data.s3.amazonaws.com/photos/210002711/original.jpg,"(c) skfork, some rights reserved (CC BY-NC)"
-Calochortus luteus,https://inaturalist-open-data.s3.amazonaws.com/photos/257812293/original.jpg,"(c) eeneill, some rights reserved (CC BY-NC)"
-Calochortus venustus,https://inaturalist-open-data.s3.amazonaws.com/photos/268338027/original.jpg,"(c) Gena Bentall, some rights reserved (CC BY-NC)"
-Ceanothus cuneatus,https://inaturalist-open-data.s3.amazonaws.com/photos/266280254/original.jpg,"(c) Ixchel Gonzalez-Ramirez, some rights reserved (CC BY-NC)"
-Claytonia gypsophiloides,https://inaturalist-open-data.s3.amazonaws.com/photos/268277390/original.jpeg,"(c) Christian Naventi, some rights reserved (CC BY-NC)"
-Lithophragma heterophyllum,https://inaturalist-open-data.s3.amazonaws.com/photos/104408/medium.jpg,"(c) dloarie, some rights reserved (CC BY)"
-Pseudotsuga menziesii var. menziesii,https://inaturalist-open-data.s3.amazonaws.com/photos/214823452/original.jpeg
-Pseudotsuga menziesii var. menziesii,https://inaturalist-open-data.s3.amazonaws.com/photos/243900174/original.jpg,"(c) Alan Siegel, some rights reserved (CC BY-NC)"

package/lib/ebook/taxonimage.js

@@ -1,23 +0,0 @@
-class TaxonImage {
-    #src;
-    #credit;
-
-    /**
-     * @param {string} src
-     * @param {string} credit
-     */
-    constructor(src, credit) {
-        this.#src = src;
-        this.#credit = credit;
-    }
-
-    getCaption() {
-        return this.#credit ? this.#credit : undefined;
-    }
-
-    getSrc() {
-        return this.#src;
-    }
-}
-
-export { TaxonImage };