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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.4.19",
+    "version": "0.4.20",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -14,8 +14,7 @@
         "ebook",
         "jekyll",
         "lib",
-        "scripts",
-        "types"
+        "scripts"
     ],
     "exports": {
         ".": "./lib/index.js"
@@ -36,7 +35,7 @@
         "inatobsphotos": "scripts/inatobsphotos.js"
     },
     "dependencies": {
-        "@htmltools/scrape": "^0.1.0",
+        "@htmltools/scrape": "^0.1.1",
         "archiver": "^5.3.1",
         "cli-progress": "^3.12.0",
         "commander": "^12.1.0",
@@ -54,11 +53,11 @@
         "@types/cli-progress": "^3.11.6",
         "@types/jest": "^29.5.14",
         "@types/markdown-it": "^14.1.2",
-        "@types/node": "^22.10.3",
+        "@types/node": "^22.10.7",
         "@types/unzipper": "^0.10.9",
-        "eslint": "^9.17.0",
+        "eslint": "^9.18.0",
         "jest": "^29.7.0",
         "prettier": "^3.4.2",
-        "typescript": "^5.7.2"
+        "typescript": "^5.7.3"
     }
 }

package/scripts/cpl-photos.js

@@ -129,7 +129,7 @@ async function getTaxa(options) {
 }
 
 /**
- * @returns {Map<string,InatPhotoInfo[]>}
+ * @returns {Map<string,import("../lib/utils/inat-tools.js").InatPhotoInfo[]>}
  */
 function readPhotos() {
     const photosFileName = `./data/${PHOTO_FILE_NAME}`;
@@ -140,7 +140,7 @@ function readPhotos() {
     /** @type {Map<string,{id:string,ext:string,licenseCode:string,attrName:string}[]>} */
     const taxonPhotos = new Map();
 
-    /** @type {InatCsvPhoto[]} */
+    /** @type {import("../lib/utils/inat-tools.js").InatCsvPhoto[]} */
     // @ts-ignore
     const csvPhotos = CSV.readFile(photosFileName);
     for (const csvPhoto of csvPhotos) {

package/scripts/cpl-tools.js

@@ -11,6 +11,8 @@ import { JepsonEFlora } from "../lib/tools/jepsoneflora.js";
 import { RPI } from "../lib/tools/rpi.js";
 import { Config } from "../lib/config.js";
 import { Taxa } from "../lib/taxa.js";
+import { SupplementalText } from "../lib/tools/supplementaltext.js";
+import { JepsonFamilies } from "../lib/tools/jepsonfamilies.js";
 
 const TOOLS = {
     CALFLORA: "calflora",
@@ -58,9 +60,11 @@ async function build(program, options) {
             case TOOLS.CALFLORA:
                 await Calflora.analyze(
                     TOOLS_DATA_DIR,
+                    options.datadir,
                     taxa,
                     exceptions,
                     errorLog,
+                    !!options.update,
                 );
                 break;
             case TOOLS.CALSCAPE:
@@ -86,11 +90,15 @@ async function build(program, options) {
                 break;
             case TOOLS.JEPSON_EFLORA: {
                 const eflora = new JepsonEFlora(TOOLS_DATA_DIR, taxa, errorLog);
-                await eflora.analyze(exceptions, !!options.update);
+                await eflora.analyze(
+                    options.datadir,
+                    exceptions,
+                    !!options.update,
+                );
                 break;
             }
             case TOOLS.JEPSON_FAM:
-                // await JepsonFamilies.build(TOOLS_DATA_DIR, options.outputdir);
+                await JepsonFamilies.build(TOOLS_DATA_DIR, "./data");
                 break;
             case TOOLS.RPI:
                 await RPI.analyze(
@@ -102,7 +110,7 @@ async function build(program, options) {
                 );
                 break;
             case TOOLS.TEXT:
-                // SupplementalText.analyze(taxa, errorLog);
+                SupplementalText.analyze(taxa, errorLog);
                 break;
             default:
                 console.log("unrecognized tool: " + tool);

package/scripts/inatobsphotos.js

@@ -9,6 +9,15 @@ import { Program } from "../lib/program.js";
 import { Taxa } from "../lib/taxa.js";
 import { sleep } from "../lib/util.js";
 
+/**
+ * @typedef {{
+    observation_photos: {
+        photo: import("../lib/utils/inat-tools.js").InatApiPhoto;
+    }[];
+}} InatApiObservation
+ @typedef {import("../lib/program.js").CommandLineOptions &{filename?:string,inatObsQuery?:string}} InatObsPhotosCommandLineOptions
+ */
+
 // While I'm guessing the products of this data will be non-commercial, it's
 // not clear how they'll be licensed so the ShareAlike clause is out, and
 // they'll probably be derivative works so the "No Derivatives" clause should
@@ -18,7 +27,7 @@ const ALLOWED_LICENSE_CODES = ["cc0", "cc-by", "cc-by-nc"];
 const DEFAULT_FILENAME = "inatobsphotos.csv";
 
 /**
- * @param {Taxon} taxon
+ * @param {import("../lib/taxon.js").Taxon} taxon
  * @param {InatObsPhotosCommandLineOptions} options
  * @return {Promise<InatApiObservation[]>}
  */

package/scripts/inattaxonphotos.js

@@ -10,24 +10,26 @@ import { Program } from "../lib/program.js";
 import { Taxa } from "../lib/taxa.js";
 import { chunk, sleep } from "../lib/util.js";
 
+/**
+ * @typedef {import("../lib/program.js").CommandLineOptions & {filename?:string}} InatTaxonPhotosCommandLineOptions
+ */
+
 // While I'm guessing the products of this data will be non-commercial, it's
 // not clear how they'll be licensed so the ShareAlike clause is out, and
 // they'll probably be derivative works so the "No Derivatives" clause should
 // be respected.
-const ALLOWED_LICENSE_CODES = [
-    "cc0", "cc-by", "cc-by-nc"
-];
+const ALLOWED_LICENSE_CODES = ["cc0", "cc-by", "cc-by-nc"];
 
 const DEFAULT_FILENAME = "inattaxonphotos.csv";
 
 /**
- * @param {Taxon[]} taxa
- * @return {Promise<InatApiTaxon[]>}
+ * @param {import("../lib/taxon.js").Taxon[]} taxa
+ * @return {Promise<import("../lib/utils/inat-tools.js").InatApiTaxon[]>}
  */
-async function fetchInatTaxa( taxa ) {
-    const inatTaxonIDs = taxa.map( taxon => taxon.getINatID( ) ).filter( Boolean );
-    const url = `https://api.inaturalist.org/v2/taxa/${inatTaxonIDs.join( "," )}?fields=(taxon_photos:(photo:(medium_url:!t,attribution:!t,license_code:!t)))`;
-    const resp = await fetch( url );
+async function fetchInatTaxa(taxa) {
+    const inatTaxonIDs = taxa.map((taxon) => taxon.getINatID()).filter(Boolean);
+    const url = `https://api.inaturalist.org/v2/taxa/${inatTaxonIDs.join(",")}?fields=(taxon_photos:(photo:(medium_url:!t,attribution:!t,license_code:!t)))`;
+    const resp = await fetch(url);
     if (!resp.ok) {
         const error = await resp.text();
         throw new Error(`Failed to fetch taxa from iNat: ${error}`);
@@ -39,74 +41,74 @@ async function fetchInatTaxa( taxa ) {
 /**
  * @param {InatTaxonPhotosCommandLineOptions} options
  */
-async function getTaxonPhotos( options ) {
+async function getTaxonPhotos(options) {
     const errorLog = new ErrorLog(options.outputdir + "/errors.tsv");
     const taxa = new Taxa(
         Program.getIncludeList(options.datadir),
         errorLog,
-        false
+        false,
     );
-    const targetTaxa = taxa.getTaxonList( );
+    const targetTaxa = taxa.getTaxonList();
 
     const filename = path.join("data", options.filename || DEFAULT_FILENAME);
-    const writableStream = fs.createWriteStream( filename );
-    const columns = [
-        "name",
-        "id",
-        "ext",
-        "licenseCode",
-        "attrName",
-    ];
-    const stringifier = stringify( { header: true, columns: columns } );
+    const writableStream = fs.createWriteStream(filename);
+    const columns = ["name", "id", "ext", "licenseCode", "attrName"];
+    const stringifier = stringify({ header: true, columns: columns });
     stringifier.pipe(writableStream);
     const prog = new cliProgress.SingleBar({
         format: "Downloading [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}",
-        etaBuffer: targetTaxa.length
+        etaBuffer: targetTaxa.length,
     });
-    prog.setMaxListeners( 100 );
-    prog.start( targetTaxa.length, 0 );
+    prog.setMaxListeners(100);
+    prog.start(targetTaxa.length, 0);
 
     // Fetch endpoint can load multiple taxa, but it will created some long URLs so best to keep this smallish
-    for ( const batch of chunk( targetTaxa, 30 ) ) {
-        const inatTaxa = await fetchInatTaxa( batch );
-        for ( const taxon of batch ) {
-            prog.increment( );
-            const iNatTaxon = inatTaxa.find( it => it.id === Number( taxon.getINatID() ) );
-            if ( !iNatTaxon ) continue;
-            // Just get the CC-licensed ones, 5 per taxon should be fine (max is 20 on iNat). Whether or not 
+    for (const batch of chunk(targetTaxa, 30)) {
+        const inatTaxa = await fetchInatTaxa(batch);
+        for (const taxon of batch) {
+            prog.increment();
+            const iNatTaxon = inatTaxa.find(
+                (it) => it.id === Number(taxon.getINatID()),
+            );
+            if (!iNatTaxon) continue;
+            // Just get the CC-licensed ones, 5 per taxon should be fine (max is 20 on iNat). Whether or not
             const taxonPhotos = iNatTaxon.taxon_photos
-                .filter( tp => ALLOWED_LICENSE_CODES.includes( tp.photo.license_code ) )
-                .slice( 0, 5 );
+                .filter((tp) =>
+                    ALLOWED_LICENSE_CODES.includes(tp.photo.license_code),
+                )
+                .slice(0, 5);
 
-            for ( const taxonPhoto of taxonPhotos ) {
+            for (const taxonPhoto of taxonPhotos) {
                 const row = [
                     taxon.getName(),
                     taxonPhoto.photo.id,
-                    String( taxonPhoto.photo.medium_url ).split( "." ).at( -1 ),
+                    String(taxonPhoto.photo.medium_url).split(".").at(-1),
                     // Need the license code to do attribution properly
                     taxonPhoto.photo.license_code,
                     // Photographers retain copyright for most CC licenses,
                     // except CC0, so attribution is a bit different
-                    (
-                        taxonPhoto.photo.attribution.match( /\(c\) (.*?),/ )?.[1]
-                        || taxonPhoto.photo.attribution.match( /uploaded by (.*)/ )?.[1]
-                    )
+                    taxonPhoto.photo.attribution.match(/\(c\) (.*?),/)?.[1] ||
+                        taxonPhoto.photo.attribution.match(
+                            /uploaded by (.*)/,
+                        )?.[1],
                 ];
-                stringifier.write( row );
+                stringifier.write(row);
             }
         }
         // iNat will throttle you if you make more than 1 request a second.
         // See https://www.inaturalist.org/pages/api+recommended+practices
-        await sleep( 1_100 );
+        await sleep(1_100);
     }
     prog.stop();
 }
 
 const program = Program.getProgram();
-program.action(getTaxonPhotos).description( "Write a CSV to datadir with iNaturalist taxon photos" )
+program
+    .action(getTaxonPhotos)
+    .description("Write a CSV to datadir with iNaturalist taxon photos")
     .option(
         "-fn, --filename <filename>",
-        "Name of file to write to the data dir"
+        "Name of file to write to the data dir",
     );
 
 await program.parseAsync();

package/types/classes.d.ts

@@ -1,205 +0,0 @@
-declare class CommandLineOptions {
-    datadir: string;
-    outputdir: string;
-    "show-flower-errors": boolean;
-}
-
-declare class Config {
-    getConfigValue(
-        prefix: string,
-        name: string,
-        subcategory?: string,
-        defaultValue?: string,
-    ): string | undefined;
-    getCountyCodes(): string[];
-    getLabel(name: string, dflt: string): string;
-}
-
-declare class ErrorLog {
-    log(...args: any[]): void;
-    write(): void;
-}
-
-declare class Families {
-    getFamilies(): Family[];
-    getFamily(name: string): Family;
-}
-
-declare class Family {
-    getFileName(): string;
-    getName(): string;
-    getSectionName(): string;
-    getTaxa(): Taxon[];
-}
-
-declare class FlowerColor {
-    getColorCode(): string;
-    getColorName(upperCase?: boolean): string;
-    getFileName(): string;
-    getTaxa(): Taxon[];
-}
-
-declare class Genera {
-    getGenus(name: string): Genus;
-}
-
-declare class Genus {
-    getFamily(): Family;
-    getTaxa(): Taxon[];
-}
-
-declare class GlossaryEntry {
-    getMarkdown(): string;
-    getTermName(): string;
-}
-
-declare class InatObsOptions {
-    coords?: [number, number];
-    project_id?: string;
-    subview?: "grid" | "list" | "map";
-    taxon_id?: string;
-}
-
-declare class SiteGenerator {
-    copyIllustrations(flowerColors: FlowerColor[]): void;
-    mkdir(path: string): void;
-    writeTemplate(
-        content: string,
-        attributes: Record<string, string>,
-        filename: string,
-    ): void;
-}
-
-declare class SynonymData {
-    Current: string;
-    Former: string;
-    Type: string;
-}
-
-declare class Taxa {
-    getFamilies(): Families;
-    getFlowerColors(): FlowerColor[];
-    getTaxon(name: string): Taxon;
-    getTaxonList(): Taxon[];
-    hasSynonym(name: string): boolean;
-    isSubset(): boolean;
-}
-
-type StatusCode = "N" | "NC" | "U" | "X";
-declare class Taxon {
-    getBaseFileName(): string;
-    getBloomEnd(): number | undefined;
-    getBloomStart(): number | undefined;
-    getCalfloraID(): string;
-    getCalfloraName(): string;
-    getCalfloraTaxonLink(): string | undefined;
-    getCalscapeCommonName(): string | undefined;
-    getCalscapeName(): string;
-    getCommonNames(): string[];
-    getFamily(): Family;
-    getFESA(): string | undefined;
-    getFileName(): string;
-    getFlowerColors(): string[] | undefined;
-    getGenus(): Genus;
-    getGenusName(): string;
-    getGlobalRank(): string | undefined;
-    getHTMLLink(
-        href: boolean | string | undefined,
-        includeRPI?: boolean,
-    ): string;
-    getINatID(): string;
-    getINatName(): string;
-    getINatSyn(): string | undefined;
-    getINatTaxonLink(): string;
-    getJepsonID(): string;
-    getLifeCycle(): string;
-    getName(): string;
-    getRPIID(): string | undefined;
-    getRPIRank(): string;
-    getRPIRankAndThreat(): string;
-    getRPIRankAndThreatTooltip(): string;
-    getRPITaxonLink(): string;
-    getStatus(): StatusCode;
-    getStatusDescription(config: Config): string;
-    getSynonyms(): string[];
-    isCANative(): boolean;
-    isNative(): boolean;
-}
-
-declare class 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: StatusCode;
-    taxon_name: string;
-}
-
-type PhotoRights = "CC0" | "CC BY" | "CC BY-NC" | "C" | null;
-
-type InatPhotoInfo = {
-    id: string;
-    ext: string;
-    licenseCode: string;
-    attrName: string | undefined;
-};
-
-type InatLicenseCode =
-    | "cc-by-nc-sa"
-    | "cc-by-nc"
-    | "cc-by-nc-nd"
-    | "cc-by"
-    | "cc-by-sa"
-    | "cc-by-nd"
-    | "pd"
-    | "gdfl"
-    | "cc0";
-
-declare class InatCsvPhoto {
-    name: string;
-    id: number;
-    ext: string;
-    licenseCode: InatLicenseCode;
-    attrName: string;
-}
-
-declare class InatApiPhoto {
-    id: number;
-    attribution: string;
-    license_code: InatLicenseCode;
-    medium_url?: string;
-    url?: string;
-}
-
-declare class InatApiTaxon {
-    id: number;
-    taxon_photos: {
-        photo: InatApiPhoto;
-    }[];
-}
-
-declare class InatApiObservation {
-    observation_photos: {
-        photo: InatApiPhoto;
-    }[];
-}
-
-declare class InatObsPhotosCommandLineOptions extends CommandLineOptions {
-    filename?: string;
-    inatObsQuery?: string;
-}
-
-declare class InatTaxonPhotosCommandLineOptions extends CommandLineOptions {
-    filename?: string;
-}