@ca-plant-list/ca-plant-list 0.1.13 → 0.1.14

package/build-site.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-import { Config } from "./lib/config.js";
 import { DataLoader } from "./lib/dataloader.js";
 import { ErrorLog } from "./lib/errorlog.js";
 import { PageRenderer } from "./lib/pagerenderer.js";
@@ -8,11 +7,9 @@ import commandLineArgs from "command-line-args";
 
 const options = commandLineArgs( DataLoader.getOptionDefs() );
 
-const CONFIG_DATA_DIR = "./data";
 const OUTPUT_DIR = "./output";
 
-Config.init( CONFIG_DATA_DIR );
 DataLoader.load( options );
 PageRenderer.render( OUTPUT_DIR );
 
-ErrorLog.write( OUTPUT_DIR + "/errors.txt" );
+ErrorLog.write( OUTPUT_DIR + "/errors.tsv" );

package/data/genera.json

@@ -11,6 +11,10 @@
         "family": "Lycopodiaceae",
         "id": "9179"
     },
+    "Rhinotropis": {
+        "family": "Polygalaceae",
+        "id": 99965
+    },
     "Selaginella": {
         "family": "Selaginellaceae",
         "id": "8877"

package/lib/config.js

@@ -1,12 +1,20 @@
 import * as path from "node:path";
 import * as url from "node:url";
-import * as fs from "node:fs";
+import { Files } from "./files.js";
 
 class Config {
 
     static #config = {};
     static #packageDir = path.dirname( path.dirname( url.fileURLToPath( import.meta.url ) ) );
 
+    static {
+        try {
+            this.#config = JSON.parse( Files.read( "./data/config.json" ) );
+        } catch ( e ) {
+            console.log( e );
+        }
+    }
+
     static getConfigValue( prefix, name, subcat, dflt ) {
         const obj = this.#config[ prefix ];
         if ( obj ) {
@@ -26,6 +34,10 @@ class Config {
         return dflt;
     }
 
+    static getCountyCodes() {
+        return this.#config[ "counties" ];
+    }
+
     static getLabel( name, dflt ) {
         return this.getConfigValue( "labels", name, undefined, dflt );
     }
@@ -34,14 +46,6 @@ class Config {
         return this.#packageDir;
     }
 
-    static init( dir ) {
-        try {
-            this.#config = JSON.parse( fs.readFileSync( dir + "/config.json" ) );
-        } catch ( e ) {
-            console.log( e );
-        }
-    }
-
 }
 
 export { Config };

package/lib/exceptions.js

@@ -1,35 +1,39 @@
-import * as fs from "node:fs";
+import { Files } from "./files.js";
 
 class Exceptions {
 
     static #exceptions = {};
 
-    static hasException( name, cat, subcat ) {
+    static getExceptions() {
+        return Object.entries( this.#exceptions );
+    }
+
+    static getValue( name, cat, subcat, defaultValue ) {
         const taxonData = this.#exceptions[ name ];
         if ( taxonData ) {
             const catData = taxonData[ cat ];
             if ( catData ) {
-                return catData[ subcat ] !== undefined;
+                const val = catData[ subcat ];
+                return ( val === undefined ) ? defaultValue : val;
             }
         }
-        return false;
+        return defaultValue;
     }
 
-    static getValue( name, cat, subcat, defaultValue ) {
+    static hasException( name, cat, subcat ) {
         const taxonData = this.#exceptions[ name ];
         if ( taxonData ) {
             const catData = taxonData[ cat ];
             if ( catData ) {
-                const val = catData[ subcat ];
-                return ( val === undefined ) ? defaultValue : val;
+                return catData[ subcat ] !== undefined;
             }
         }
-        return defaultValue;
+        return false;
     }
 
     static init( dir ) {
         try {
-            this.#exceptions = JSON.parse( fs.readFileSync( dir + "/exceptions.json" ) );
+            this.#exceptions = JSON.parse( Files.read( dir + "/exceptions.json" ) );
         } catch ( e ) {
             console.log( e );
         }

package/lib/files.js

@@ -22,11 +22,30 @@ class Files {
         return fs.existsSync( path );
     }
 
-    static async fetch( url, targetFileName ) {
-        const response = await fetch( url );
+    /**
+     * Retrieve data from a URL and write it to a file.
+     * @param {string|URL} url 
+     * @param {string|undefined} targetFileName If targetFileName is undefined, the data will be retrieved but not written to a file.
+     * @param {Object} [headers={}] Request Headers.
+     */
+    static async fetch( url, targetFileName, headers = {} ) {
+        const response = await fetch( url, headers );
         const data = await response.blob();
-        const buffer = await data.arrayBuffer();
-        fs.writeFileSync( targetFileName, Buffer.from( buffer ) );
+        const arrayBuffer = await data.arrayBuffer();
+        const buffer = Buffer.from( arrayBuffer );
+        if ( targetFileName ) {
+            fs.writeFileSync( targetFileName, buffer );
+        }
+    }
+
+    /**
+     * Retrieve data from a URL and return the Response Header.
+     * @param {string|URL} url 
+     * @returns {Headers}
+     */
+    static async fetchHeaders( url ) {
+        const response = await fetch( url );
+        return response.headers;
     }
 
     static mkdir( path ) {
@@ -41,8 +60,8 @@ class Files {
         fs.rmSync( dir, { force: true, recursive: true, maxRetries: 2, retryDelay: 1000 } );
     }
 
-    static write( path, data ) {
-        if ( this.exists( path ) ) {
+    static write( path, data, overwrite = false ) {
+        if ( !overwrite && this.exists( path ) ) {
             throw new Error( path + " already exists" );
         }
         fs.writeFileSync( path, data );

package/lib/index.d.ts

@@ -2,11 +2,23 @@ export class Files {
     static copyDir(srcDir: any, targetDir: any): void;
     static createFileFromStream(fileName: any, inStream: any): Promise<any>;
     static exists(path: any): boolean;
-    static fetch(url: any, targetFileName: any): Promise<void>;
+    /**
+     * Retrieve data from a URL and write it to a file.
+     * @param {string|URL} url
+     * @param {string|undefined} targetFileName If targetFileName is undefined, the data will be retrieved but not written to a file.
+     * @param {Object} [headers={}] Request Headers.
+     */
+    static fetch(url: string | URL, targetFileName: string | undefined, headers?: any): Promise<void>;
+    /**
+     * Retrieve data from a URL and return the Response Header.
+     * @param {string|URL} url
+     * @returns {Headers}
+     */
+    static fetchHeaders(url: string | URL): Headers;
     static mkdir(path: any): void;
     static read(path: any): string;
     static rmDir(dir: any): void;
-    static write(path: any, data: any): void;
+    static write(path: any, data: any, overwrite?: boolean): void;
     static zipFileExtract(zipFilePath: any, fileNameToUnzip: any, targetFilePath: any): Promise<void>;
 }
 export namespace HTML_OPTIONS {

package/lib/pagetaxon.js

@@ -40,7 +40,7 @@ class PageTaxon extends GenericPage {
         links.push(
             HTML.getLink(
                 "https://www.calflora.org/entry/observ.html?track=m#srch=t&grezc=5&cols=b&lpcli=t&cc="
-                + Config.getConfigValue( "calflora", "counties" ).join( "!" ) + "&incobs=f&taxon="
+                + Config.getCountyCodes().join( "!" ) + "&incobs=f&taxon="
                 + this.#taxon.getCalfloraName().replaceAll( " ", "+" ),
                 "Calflora",
                 {},

package/lib/taxon.js

@@ -192,6 +192,10 @@ class Taxon {
         return this.#status === "N" || this.#status === "NC";
     }
 
+    /**
+     * Determine whether a species is a local native.
+     * @returns {boolean} true if taxon is a local native; false if not a CA native, or native elsewhere in CA.
+     */
     isNative() {
         return this.#status === "N";
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.1.13",
+    "version": "0.1.14",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {