@ca-plant-list/ca-plant-list 0.2.0 → 0.2.2

package/lib/ebook/plantbook.js

@@ -0,0 +1,179 @@
+import * as fs from "node:fs";
+import path from "node:path";
+import sharp from "sharp";
+import { CSV, Families, Files, Taxa } from "@ca-plant-list/ca-plant-list";
+import { EBook } from "./ebook.js";
+import { Image } from "./image.js";
+import { PageListFamilies } from "./pages/page_list_families.js";
+import { PageListFlowerColor } from "./pages/page_list_flower_color.js";
+import { PageListSpecies } from "./pages/page_list_species.js";
+import { TaxonPage } from "./pages/taxonpage.js";
+import { TOCPage } from "./pages/tocpage.js";
+import { Config } from "../config.js";
+import { FLOWER_COLOR_NAMES } from "../taxa.js";
+
+class PlantBook extends EBook {
+
+    #images = {};
+
+    constructor() {
+
+        super(
+            "output",
+            Config.getConfigValue( "ebook", "filename" ),
+            Config.getConfigValue( "ebook", "pub_id" ),
+            Config.getConfigValue( "ebook", "title" )
+        );
+
+    }
+
+    async createPages() {
+
+        console.log( "checking images" );
+        await this.#importImages();
+
+        const contentDir = this.getContentDir();
+
+        console.log( "creating taxon pages" );
+        const taxa = Taxa.getTaxa();
+        for ( const taxon of taxa ) {
+            const name = taxon.getName();
+            new TaxonPage( contentDir, taxon, this.#images[ name ] ).create();
+        }
+
+        // Create lists.
+        for ( const colorName of FLOWER_COLOR_NAMES ) {
+            new PageListFlowerColor( contentDir, Taxa.getFlowerColor( colorName ) ).create();
+        }
+        new PageListFamilies( contentDir ).create();
+        for ( const family of Families.getFamilies() ) {
+            const taxa = family.getTaxa();
+            if ( !taxa ) {
+                continue;
+            }
+            const name = family.getName();
+            new PageListSpecies( contentDir, taxa, name + ".html", name ).create();
+        }
+        new PageListSpecies( contentDir, taxa, "list_species.html", "All Species" ).create();
+
+        new TOCPage( contentDir ).create();
+    }
+
+    async #importImages() {
+
+        const photoDirSrc = "external_data/photos";
+        const imagePrefix = "i";
+        const photoDirTarget = this.getContentDir() + "/" + imagePrefix;
+        fs.mkdirSync( photoDirSrc, { recursive: true } );
+        fs.mkdirSync( photoDirTarget, { recursive: true } );
+
+        const rows = CSV.parseFile( Config.getPackageDir() + "/data", "photos.csv" );
+        for ( const row of rows ) {
+
+            const name = row[ "taxon_name" ];
+            const taxon = Taxa.getTaxon( name );
+            if ( !taxon ) {
+                continue;
+            }
+
+            let imageList = this.#images[ name ];
+            if ( !imageList ) {
+                imageList = [];
+                this.#images[ name ] = imageList;
+            }
+
+            const src = new URL( row[ "source" ] );
+            const parts = path.parse( src.pathname ).dir.split( "/" );
+            const prefix = src.host.includes( "calflora" ) ? "cf-" : "inat-";
+            const filename = prefix + parts.slice( -1 )[ 0 ] + ".jpg";
+            const srcFileName = photoDirSrc + "/" + filename;
+            const targetFileName = photoDirTarget + "/" + filename;
+
+            if ( !fs.existsSync( srcFileName ) ) {
+                // File is not there; retrieve it.
+                console.log( "retrieving " + srcFileName );
+                await Files.fetch( src, srcFileName );
+            }
+
+            await new sharp( srcFileName ).resize( { width: 400 } ).jpeg( { quality: 40 } ).toFile( targetFileName );
+
+            imageList.push( new Image( imagePrefix + "/" + filename, row[ "credit" ] ) );
+
+        }
+    }
+
+    renderManifestEntries() {
+
+        let xml = "";
+
+        xml += "<item id=\"f0\" href=\"i/f-blue.svg\" media-type=\"image/svg+xml\" />";
+        xml += "<item id=\"f1\" href=\"i/f-orange.svg\" media-type=\"image/svg+xml\" />";
+        xml += "<item id=\"f2\" href=\"i/f-pink.svg\" media-type=\"image/svg+xml\" />";
+        xml += "<item id=\"f3\" href=\"i/f-red.svg\" media-type=\"image/svg+xml\" />";
+        xml += "<item id=\"f4\" href=\"i/f-white.svg\" media-type=\"image/svg+xml\" />";
+        xml += "<item id=\"f5\" href=\"i/f-yellow.svg\" media-type=\"image/svg+xml\" />";
+
+        // Add lists.
+        xml += "<item id=\"lspecies\" href=\"list_species.html\" media-type=\"application/xhtml+xml\" />";
+        xml += "<item id=\"lfamilies\" href=\"list_families.html\" media-type=\"application/xhtml+xml\" />";
+        for ( const colorName of FLOWER_COLOR_NAMES ) {
+            const color = Taxa.getFlowerColor( colorName );
+            xml += "<item id=\"l" + color.getColorName() + "\" href=\"" + color.getFileName() + "\" media-type=\"application/xhtml+xml\" />";
+        }
+
+        // Add family pages.
+        for ( const family of Families.getFamilies() ) {
+            const taxa = family.getTaxa();
+            if ( !taxa ) {
+                continue;
+            }
+            xml += "<item id=\"fam" + family.getName() + "\" href=\"" + family.getFileName() + "\" media-type=\"application/xhtml+xml\" />";
+        }
+
+        // Add taxon pages.
+        const taxa = Taxa.getTaxa();
+        for ( let index = 0; index < taxa.length; index++ ) {
+            const taxon = taxa[ index ];
+            xml += "<item id=\"t" + index + "\" href=\"" + taxon.getFileName() + "\" media-type=\"application/xhtml+xml\" />";
+        }
+
+        // Add images.
+        let index = 0;
+        for ( const imageList of Object.values( this.#images ) ) {
+            for ( const image of imageList ) {
+                xml += "<item id=\"i" + index + "\" href=\"" + image.getSrc() + "\" media-type=\"image/jpeg\" />";
+                index++;
+            }
+        }
+        return xml;
+    }
+
+    renderSpineElements() {
+        let xml = "";
+
+        // Add lists.
+        for ( const colorName of FLOWER_COLOR_NAMES ) {
+            const color = Taxa.getFlowerColor( colorName );
+            xml += "<itemref idref=\"l" + color.getColorName() + "\"/>";
+        }
+        xml += "<itemref idref=\"lfamilies\"/>";
+        xml += "<itemref idref=\"lspecies\"/>";
+
+        // Add families.
+        for ( const family of Families.getFamilies() ) {
+            const taxa = family.getTaxa();
+            if ( !taxa ) {
+                continue;
+            }
+            xml += "<itemref idref=\"fam" + family.getName() + "\"/>";
+        }
+
+        // Add taxa.
+        for ( let index = 0; index < Taxa.getTaxa().length; index++ ) {
+            xml += "<itemref idref=\"t" + index + "\"/>";
+        }
+        return xml;
+    }
+}
+
+export { PlantBook };

package/lib/ebook/xhtml.js

@@ -0,0 +1,7 @@
+import { HTML } from "@ca-plant-list/ca-plant-list";
+
+class XHTML extends HTML {
+
+}
+
+export { XHTML };

package/lib/exceptions.js

@@ -1,3 +1,4 @@
+import { Config } from "./config.js";
 import { Files } from "./files.js";
 
 class Exceptions {
@@ -32,11 +33,20 @@ class Exceptions {
     }
 
     static init( dir ) {
-        try {
-            this.#exceptions = JSON.parse( Files.read( dir + "/exceptions.json" ) );
-        } catch ( e ) {
-            console.log( e );
+
+        function readConfig( fileName ) {
+            return JSON.parse( Files.read( fileName ) );
         }
+
+        // Read default configuration.
+        this.#exceptions = readConfig( Config.getPackageDir() + "/data/exceptions.json" );
+
+        // Add/overwrite with local configuration.
+        const localExceptions = readConfig( dir + "/exceptions.json" );
+        for ( const [ k, v ] of Object.entries( localExceptions ) ) {
+            this.#exceptions[ k ] = v;
+        }
+
     }
 
 }

package/lib/families.js

@@ -10,6 +10,10 @@ class Families {
 
     static #families;
 
+    static getFamilies() {
+        return Object.values( this.#families ).sort( ( a, b ) => a.getName().localeCompare( b.getName() ) );
+    }
+
     static getFamily( familyName ) {
         return this.#families[ familyName ];
     }

package/lib/index.d.ts

@@ -33,14 +33,15 @@ export class ErrorLog {
     static write(fileName: any): void;
 }
 export class Exceptions {
-    static "__#16@#exceptions": {};
+    static "__#17@#exceptions": {};
     static getExceptions(): [string, any][];
     static getValue(name: any, cat: any, subcat: any, defaultValue: any): any;
     static hasException(name: any, cat: any, subcat: any): boolean;
     static init(dir: any): void;
 }
 export class Families {
-    static "__#10@#families": any;
+    static "__#11@#families": any;
+    static getFamilies(): any[];
     static getFamily(familyName: any): any;
     static init(): void;
     static renderPages(outputDir: any, taxaColumns: any): void;
@@ -135,10 +136,11 @@ import { Families } from "./families.js";
 import { Files } from "./files.js";
 import { HTML } from "./html.js";
 import { Jekyll } from "./jekyll.js";
+import { PlantBook } from "./ebook/plantbook.js";
 import { Taxa } from "./taxa.js";
 import { TAXA_COLNAMES } from "./taxon.js";
 import { Taxon } from "./taxon.js";
-export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, Jekyll, Taxa, TAXA_COLNAMES, Taxon };
+export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, Jekyll, PlantBook, Taxa, TAXA_COLNAMES, Taxon };
 export class Jekyll {
     static hasInclude(baseDir: any, path: any): boolean;
     static include(path: any): string;
@@ -153,18 +155,21 @@ export class RarePlants {
     static getRPIRankDescription(rank: any): any;
     static getRPIRankAndThreatDescriptions(rank: any): any[];
 }
+export const FLOWER_COLOR_NAMES: string[];
 export class Taxa {
-    static "__#9@#taxa": {};
-    static "__#9@#sortedTaxa": any;
+    static "__#10@#taxa": {};
+    static "__#10@#flower_colors": {};
+    static "__#10@#sortedTaxa": any;
     static getHTMLTable(taxa: any, columns?: {
         title: string;
         data: (t: any) => any;
     }[]): string;
+    static getFlowerColor(name: any): any;
     static getTaxa(): any;
     static getTaxon(name: any): any;
     static init(inclusionList: any, taxaMeta?: {}, taxonClass?: typeof Taxon, extraTaxa?: any[], extraSynonyms?: any[]): void;
-    static "__#9@#loadSyns"(synCSV: any, inclusionList: any): void;
-    static "__#9@#loadTaxa"(taxaCSV: any, inclusionList: any, taxaMeta: any, taxonClass: any): void;
+    static "__#10@#loadSyns"(synCSV: any, inclusionList: any): void;
+    static "__#10@#loadTaxa"(taxaCSV: any, inclusionList: any, taxaMeta: any, taxonClass: any): void;
 }
 export namespace TAXA_LIST_COLS {
     namespace CESA {
@@ -205,6 +210,7 @@ export namespace TAXA_LIST_COLS {
 import { Taxon } from "./taxon.js";
 export namespace TAXA_COLNAMES {
     const COMMON_NAME: string;
+    const FLOWER_COLOR: string;
 }
 export class Taxon {
     constructor(data: any);
@@ -219,6 +225,7 @@ export class Taxon {
     getFamily(): any;
     getFESA(): any;
     getFileName(ext?: string): string;
+    getFlowerColors(): any;
     getGenus(): {
         "__#5@#data": any;
         getTaxa(): any;

package/lib/index.js

@@ -8,7 +8,8 @@ import { Families } from "./families.js";
 import { Files } from "./files.js";
 import { HTML } from "./html.js";
 import { Jekyll } from "./jekyll.js";
+import { PlantBook } from "./ebook/plantbook.js";
 import { Taxa } from "./taxa.js";
 import { Taxon, TAXA_COLNAMES } from "./taxon.js";
 
-export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, Jekyll, Taxa, TAXA_COLNAMES, Taxon };
+export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Families, Files, HTML, Jekyll, PlantBook, Taxa, TAXA_COLNAMES, Taxon };

package/lib/pagetaxon.js

@@ -153,8 +153,8 @@ class PageTaxon extends GenericPage {
 
         html += "</div>";
 
-        html += "<div class=\"grid\">";
-        html += this.#getListSectionHTML( this.#getInfoLinks(), "Information", "info" );
+        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" );

package/lib/taxa.js

@@ -5,6 +5,8 @@ import { HTML } from "./html.js";
 import { CSV } from "./csv.js";
 import { RarePlants } from "./rareplants.js";
 
+const FLOWER_COLOR_NAMES = [ "white", "red", "pink", "orange", "yellow", "blue" ];
+
 const TAXA_LIST_COLS = {
     CESA: {
         title: "California",
@@ -34,11 +36,45 @@ const TAXA_LIST_COLS = {
 
 const DEFAULT_COLUMNS = [ TAXA_LIST_COLS.SPECIES, TAXA_LIST_COLS.COMMON_NAME ];
 
+class FlowerColor {
+
+    #color;
+    #taxa = [];
+
+    constructor( color ) {
+        this.#color = color;
+    }
+
+    addTaxon( taxon ) {
+        this.#taxa.push( taxon );
+    }
+
+    getColorName( uc = false ) {
+        return uc ? ( this.#color[ 0 ].toUpperCase() + this.#color.substring( 1 ) ) : this.#color;
+    }
+
+    getFileName() {
+        return "list_fc_" + this.#color + ".html";
+    }
+
+    getTaxa() {
+        return this.#taxa;
+    }
+
+}
+
 class Taxa {
 
     static #taxa = {};
+    static #flower_colors = {};
     static #sortedTaxa;
 
+    static {
+        for ( const color of FLOWER_COLOR_NAMES ) {
+            this.#flower_colors[ color ] = new FlowerColor( color );
+        }
+    }
+
     static getHTMLTable( taxa, columns = DEFAULT_COLUMNS ) {
 
         let html = "<table><thead>";
@@ -67,6 +103,10 @@ class Taxa {
         return html;
     }
 
+    static getFlowerColor( name ) {
+        return this.#flower_colors[ name ];
+    }
+
     static getTaxa() {
         return this.#sortedTaxa;
     }
@@ -134,7 +174,18 @@ class Taxa {
             if ( status !== undefined ) {
                 row[ "status" ] = status;
             }
-            this.#taxa[ name ] = new taxonClass( row, taxaMeta[ name ] );
+            const taxon = new taxonClass( row, taxaMeta[ name ] );
+            this.#taxa[ name ] = taxon;
+            const colors = taxon.getFlowerColors();
+            if ( colors ) {
+                for ( const colorName of colors ) {
+                    const color = this.#flower_colors[ colorName ];
+                    if ( !color ) {
+                        throw new Error( "flower color \"" + colorName + "\" not found" );
+                    }
+                    color.addTaxon( taxon );
+                }
+            }
 
         }
 
@@ -143,4 +194,4 @@ class Taxa {
 
 }
 
-export { Taxa, TAXA_LIST_COLS };
+export { FLOWER_COLOR_NAMES, Taxa, TAXA_LIST_COLS };

package/lib/taxon.js

@@ -4,7 +4,8 @@ import { HTML } from "./html.js";
 import { RarePlants } from "./rareplants.js";
 
 const TAXA_COLNAMES = {
-    COMMON_NAME: "common name"
+    COMMON_NAME: "common name",
+    FLOWER_COLOR: "flower_color",
 };
 
 class Taxon {
@@ -18,6 +19,7 @@ class Taxon {
     #cfSyn;
     #iNatID;
     #iNatSyn;
+    #flowerColors;
     #rpiID;
     #rankRPI;
     #cesa;
@@ -40,6 +42,8 @@ class Taxon {
         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.#rpiID = data[ "RPI ID" ];
         this.#rankRPI = data[ "CRPR" ];
         this.#cesa = cesa ? cesa : undefined;
@@ -112,6 +116,10 @@ class Taxon {
         return this.getBaseFileName() + "." + ext;
     }
 
+    getFlowerColors() {
+        return this.#flowerColors;
+    }
+
     getGenus() {
         return Genera.getGenus( this.#genus );
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -18,13 +18,18 @@
     },
     "types": "./lib/index.d.ts",
     "bin": {
-        "ca-plant-list": "scripts/build-site.js"
+        "ca-plant-list": "scripts/build-site.js",
+        "ca-plant-book": "scripts/build-ebook.js"
     },
     "dependencies": {
         "@ca-plant-list/tools": "file:../ca-tools",
+        "archiver": "^5.3.1",
         "command-line-args": "^5.2.1",
         "command-line-usage": "^6.1.3",
         "csv-parse": "^5.3.1",
+        "image-size": "^1.0.2",
+        "markdown-it": "^13.0.1",
+        "sharp": "^0.32.1",
         "unzipper": "^0.10.11"
     },
     "devDependencies": {

package/scripts/build-ebook.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import commandLineArgs from "command-line-args";
+import { PlantBook } from "@ca-plant-list/ca-plant-list";
+import { DataLoader } from "../lib/dataloader.js";
+
+const options = commandLineArgs( DataLoader.getOptionDefs() );
+
+DataLoader.load( options );
+
+const ebook = new PlantBook();
+await ebook.create();