@ca-plant-list/ca-plant-list 0.1.6 → 0.1.8

package/lib/basepagerenderer.js

@@ -7,7 +7,7 @@ class BasePageRenderer {
     static render( outputDir, Taxa ) {
 
         // Copy static files
-        fs.rmSync( outputDir, { force: true, recursive: true, maxRetries: 2, retryDelay: 400 } );
+        fs.rmSync( outputDir, { force: true, recursive: true, maxRetries: 2, retryDelay: 1000 } );
         // First copy default Jekyll files from package.
         fs.cpSync( Config.getPackageDir() + "/jekyll", outputDir, { recursive: true } );
         // Then copy Jekyll files from current dir (which may override default files).

package/lib/files.js

@@ -1,17 +1,49 @@
 import * as fs from "node:fs";
+import { default as unzipper } from "unzipper";
 
 class Files {
 
+    static createFileFromStream( fileName, inStream ) {
+
+        function implementation( fileName, inStream, resolve ) {
+            const outStream = fs.createWriteStream( fileName );
+            outStream.on( "finish", () => { resolve( true ); } );
+            inStream.pipe( outStream );
+        }
+
+        return new Promise( ( resolve ) => { implementation( fileName, inStream, resolve ); } );
+    }
+
     static async fetch( url, targetFileName ) {
         const response = await fetch( url );
-        const data = await response.text();
-        fs.writeFileSync( targetFileName, data );
+        const data = await response.blob();
+        const buffer = await data.arrayBuffer();
+        fs.writeFileSync( targetFileName, Buffer.from( buffer ) );
     }
 
     static read( path ) {
         return fs.readFileSync( path, "utf8" );
     }
 
+    static write( path, data ) {
+        if ( fs.existsSync( path ) ) {
+            throw new Error( path + " already exists" );
+        }
+        fs.writeFileSync( path, data );
+    }
+
+    static async zipFileExtract( zipFilePath, fileNameToUnzip, targetFilePath ) {
+
+        const zipDir = await unzipper.Open.file( zipFilePath );
+        for ( const entry of zipDir.files ) {
+            if ( entry.path === fileNameToUnzip ) {
+                await this.createFileFromStream( targetFilePath, entry.stream() );
+                break;
+            }
+        }
+
+    }
+
 }
 
 export { Files };

package/lib/html.js

@@ -1,12 +1,13 @@
 /**
  * @deprecated
  */
-const HTML_OPTIONS = {
+export const HTML_OPTIONS = {
     OPEN_NEW: 1,
     NO_ESCAPE: 2,
 };
 
-class HTML {
+/** HTML utility functions. */
+export class HTML {
 
     static arrayToLI( items ) {
         return items.reduce( ( itemHTML, currVal ) => itemHTML + "<li>" + currVal + "</li>", "" );
@@ -77,5 +78,3 @@ class HTML {
     }
 
 }
-
-export { HTML, HTML_OPTIONS };

package/lib/index.d.ts

@@ -0,0 +1,27 @@
+export class Files {
+    static createFileFromStream(fileName: any, inStream: any): Promise<any>;
+    static fetch(url: any, targetFileName: any): Promise<void>;
+    static read(path: any): string;
+    static write(path: any, data: any): void;
+    static zipFileExtract(zipFilePath: any, fileNameToUnzip: any, targetFilePath: any): Promise<void>;
+}
+export namespace HTML_OPTIONS {
+    const OPEN_NEW: number;
+    const NO_ESCAPE: number;
+}
+/** HTML utility functions. */
+export class HTML {
+    static arrayToLI(items: any): any;
+    static escapeAttribute(value: any): any;
+    static escapeText(text: any): any;
+    /**
+     * @deprecated
+     */
+    static getElement(elName: any, text: any, attributes?: {}, options?: number): string;
+    static "__#2@#getElement"(elName: any, text: any, attributes: any, escape: any): string;
+    static getLink(href: any, linkText: any, attributes?: {}, options?: number): string;
+    static renderAttribute(n: any, v: any): string;
+    static renderAttributes(attributes: any): string;
+    static textElement(elName: any, text: any, attributes?: {}): string;
+    static wrap(elName: any, text: any, attributes?: {}): string;
+}

package/lib/pagerenderer.js

@@ -1,12 +1,15 @@
 import * as fs from "node:fs";
-import { HTML, HTML_OPTIONS } from "./html.js";
-import { Taxa } from "./taxa.js";
+import { HTML } from "./html.js";
+import { Taxa, COLUMNS } from "./taxa.js";
 import { HTMLPage } from "./htmlpage.js";
 import { PageTaxon } from "./pagetaxon.js";
 import { Config } from "./config.js";
 import { RarePlants } from "./rareplants.js";
 import { BasePageRenderer } from "./basepagerenderer.js";
 
+const RPI_CESA = [ COLUMNS.COL_SPECIES, COLUMNS.COL_COMMON_NAME, COLUMNS.COL_CESA ];
+const RPI_COLUMNS = [ COLUMNS.COL_SPECIES, COLUMNS.COL_COMMON_NAME, COLUMNS.COL_CNPS_RANK ];
+
 class PageRenderer extends BasePageRenderer {
 
     static render( outputDir ) {
@@ -24,7 +27,8 @@ class PageRenderer extends BasePageRenderer {
 
     static renderLists( outputDir ) {
 
-        function getListArray( listInfo, attributes = {} ) {
+        function getListArray( listInfo, attributes = {}, columns ) {
+
             const listArray = [];
             for ( const list of listInfo ) {
                 const taxa = [];
@@ -45,23 +49,25 @@ class PageRenderer extends BasePageRenderer {
                 fs.writeFileSync( outputDir + "/calflora_" + list.filename + ".txt", calfloraTaxa.join( "\n" ) );
                 fs.writeFileSync( outputDir + "/inat_" + list.filename + ".txt", iNatTaxa.join( "\n" ) );
 
-                new PageTaxonList().render( outputDir, taxa, list.filename, list.name );
+                const cols = columns ? columns : list.columns;
+                new PageTaxonList().render( outputDir, taxa, list.filename, list.name, cols );
 
                 // Check for sublists.
-                const subListHTML = list.listInfo ? getListArray( list.listInfo, { class: "indent" } ) : "";
+                const subListHTML = list.listInfo ? getListArray( list.listInfo, { class: "indent" }, cols ) : "";
 
                 listArray.push( HTML.getLink( "./" + list.filename + ".html", list.name ) + " (" + taxa.length + ")" + subListHTML );
             }
+
             return renderList( listArray, attributes );
         }
 
         function renderList( listsHTML, attributes = {} ) {
-            return HTML.getElement( "ul", HTML.arrayToLI( listsHTML ), attributes, HTML_OPTIONS.NO_ESCAPE );
+            return HTML.wrap( "ul", HTML.arrayToLI( listsHTML ), attributes );
         }
 
         function renderSection( title, listsHTML ) {
             let html = "<div class=\"section\">";
-            html += HTML.getElement( "h2", title );
+            html += HTML.textElement( "h2", title );
             html += listsHTML;
             html += "</div>";
             return html;
@@ -83,6 +89,7 @@ class PageRenderer extends BasePageRenderer {
                         name: "CNPS Ranked Plants",
                         filename: "list_rpi",
                         include: ( t ) => t.getRPIRank() !== undefined,
+                        columns: RPI_COLUMNS,
                         listInfo: [
                             {
                                 name: RarePlants.getRPIRankDescription( "1A" ),
@@ -120,6 +127,7 @@ class PageRenderer extends BasePageRenderer {
                         name: "California Endangered Species Act",
                         filename: "list_cesa",
                         include: ( t ) => t.getCESA() !== undefined,
+                        columns: RPI_CESA,
                         listInfo: [
                             {
                                 name: RarePlants.getCESADescription( "CE" ),
@@ -150,7 +158,7 @@ class PageRenderer extends BasePageRenderer {
         let html = "<div class=\"wrapper\">";
         for ( const section of sections ) {
 
-            const listHTML = getListArray( section.listInfo );
+            const listHTML = getListArray( section.listInfo, section.listInfo.columns );
 
             if ( listHTML.length > 0 ) {
                 html += renderSection( section.title, listHTML );
@@ -170,20 +178,20 @@ class PageRenderer extends BasePageRenderer {
 
 class PageTaxonList extends HTMLPage {
 
-    render( outputDir, taxa, baseName, title ) {
+    render( outputDir, taxa, baseName, title, columns ) {
 
         let html = this.getFrontMatter( title );
 
-        html += HTML.getElement( "h1", title );
+        html += HTML.textElement( "h1", title );
 
         html += "<div class=\"wrapper\">";
 
         html += "<div class=\"section\">";
-        html += Taxa.getHTMLTable( taxa );
+        html += Taxa.getHTMLTable( taxa, columns );
         html += "</div>";
 
         html += "<div class=\"section\">";
-        html += HTML.getElement( "h2", "Download" );
+        html += HTML.textElement( "h2", "Download" );
         html += "<ul>";
         html += "<li>" + HTML.getLink( "./calflora_" + baseName + ".txt", "Calflora List" ) + "</li>";
         html += "<li>" + HTML.getLink( "./inat_" + baseName + ".txt", "iNaturalist List" ) + "</li>";

package/lib/taxa.js

@@ -1,29 +1,56 @@
 import { Taxon } from "./taxon.js";
 import { ErrorLog } from "./errorlog.js";
-import { HTML, HTML_OPTIONS } from "./html.js";
+import { HTML } from "./html.js";
 import { CSV } from "./csv.js";
+import { RarePlants } from "./rareplants.js";
+
+const COLUMNS = {
+    COL_CESA: "CESA",
+    COL_COMMON_NAME: "Common Name",
+    COL_CNPS_RANK: "CNPS Rank",
+    COL_SPECIES: "Species",
+};
+
+const DEFAULT_COLUMNS = [ COLUMNS.COL_SPECIES, COLUMNS.COL_COMMON_NAME ];
 
 class Taxa {
 
     static #taxa = {};
     static #sortedTaxa;
 
-    static getHTMLTable( taxa ) {
+    static getHTMLTable( taxa, columns = DEFAULT_COLUMNS ) {
+
+        let includeRPI = true;
+
         let html = "<table><thead>";
-        html += HTML.getElement( "th", "Species" );
-        html += HTML.getElement( "th", "Common Name" );
+        for ( const column of columns ) {
+            html += HTML.textElement( "th", column );
+            if ( column === COLUMNS.COL_CNPS_RANK ) {
+                // Don't show rarity with species link if CNPS Rank column is included.
+                includeRPI = false;
+            }
+        }
         html += "</thead>";
         html += "<tbody>";
 
         for ( const taxon of taxa ) {
             html += "<tr>";
-            html += HTML.getElement(
-                "td",
-                taxon.getHTMLLink(),
-                undefined,
-                HTML_OPTIONS.NO_ESCAPE
-            );
-            html += HTML.getElement( "td", taxon.getCommonNames().join( ", " ) );
+            for ( const column of columns ) {
+                switch ( column ) {
+                    case COLUMNS.COL_CESA:
+                        html += HTML.textElement( "td", RarePlants.getCESADescription( taxon.getCESA() ) );
+                        break;
+                    case COLUMNS.COL_COMMON_NAME:
+                        html += HTML.textElement( "td", taxon.getCommonNames().join( ", " ) );
+                        break;
+                    case COLUMNS.COL_CNPS_RANK:
+                        html += HTML.wrap( "td", HTML.wrap( "span", taxon.getRPIRankAndThreat(), taxon.getRPIRankAndThreatTooltip( {} ) ) );
+                        break;
+                    case COLUMNS.COL_SPECIES:
+                        html += HTML.wrap( "td", taxon.getHTMLLink( true, includeRPI ) );
+                        break;
+                }
+            }
             html += "</tr>";
         }
 
@@ -93,4 +120,4 @@ class Taxa {
 
 }
 
-export { Taxa };
+export { Taxa, COLUMNS };

package/lib/taxon.js

@@ -100,14 +100,17 @@ class Taxon {
         return this.#genus;
     }
 
-    getHTMLLink( href = true ) {
+    getHTMLLink( href = true, includeRPI = true ) {
         href = href ? ( "./" + this.getFileName() ) : undefined;
-        const className = this.isNative() ? ( this.isRare() ? "rare" : "native" ) : "non-native";
+        let className = this.isNative() ? "native" : "non-native";
+        if ( includeRPI && this.isRare() ) {
+            className = "rare";
+        }
         const attributes = { class: className };
         if ( className === "rare" ) {
-            attributes[ "title" ] = RarePlants.getRPIRankAndThreatDescriptions( this.getRPIRankAndThreat() ).join( "\n" );
+            this.getRPIRankAndThreatTooltip( attributes );
         }
-        return HTML.getElement( "span", HTML.getLink( href, this.getName() ), attributes, HTML_OPTIONS.NO_ESCAPE );
+        return HTML.wrap( "span", HTML.getLink( href, this.getName() ), attributes );
     }
 
     getINatID() {
@@ -151,6 +154,11 @@ class Taxon {
         return this.#rankRPI;
     }
 
+    getRPIRankAndThreatTooltip( attributes ) {
+        attributes[ "title" ] = RarePlants.getRPIRankAndThreatDescriptions( this.getRPIRankAndThreat() ).join( "\n" );
+        return attributes;
+    }
+
     getRPITaxonLink() {
         const rpiID = this.getRPIID();
         if ( !rpiID ) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.1.6",
+    "version": "0.1.8",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -10,16 +10,21 @@
     "homepage": "https://github.com/ca-plants/ca-plant-list",
     "type": "module",
     "exports": {
-        ".": "./lib/index.js"
+        ".": "./lib/index.js",
+        "./HTML": "./lib/HTML.js"
     },
+    "types": "./lib/index.d.ts",
     "bin": {
         "ca-plant-list": "build-site.js"
     },
     "dependencies": {
         "command-line-args": "^5.2.1",
-        "csv-parse": "^5.3.1"
+        "csv-parse": "^5.3.1",
+        "unzipper": "^0.10.11"
     },
     "devDependencies": {
-        "eslint": "^8.26.0"
+        "@types/node": "^18.11.9",
+        "eslint": "^8.26.0",
+        "typescript": "^4.9.3"
     }
-}
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    // Change this to match your project
+    "files": [
+        "lib/index.js",
+    ],
+    "compilerOptions": {
+        "allowJs": true,
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "outDir": "output",
+        "module": "es6",
+        "newLine": "lf"
+    }
+}