@ca-plant-list/ca-plant-list 0.3.1 → 0.3.3

package/lib/files.js

@@ -3,91 +3,149 @@ import * as path from "node:path";
 import { default as unzipper } from "unzipper";
 
 class Files {
-
-    static copyDir( srcDir, targetDir ) {
-        fs.cpSync( srcDir, targetDir, { recursive: true } );
+    /**
+     * @param {string} srcDir
+     * @param {string} targetDir
+     */
+    static copyDir(srcDir, targetDir) {
+        fs.cpSync(srcDir, targetDir, { recursive: true });
     }
 
-    static createFileFromStream( fileName, inStream ) {
-
-        function implementation( fileName, inStream, resolve ) {
-            const outStream = fs.createWriteStream( fileName );
-            outStream.on( "finish", () => { resolve( true ); } );
-            inStream.pipe( outStream );
+    /**
+     * @param {string} fileName
+     * @param {*} inStream
+     * @access private
+     */
+    static #createFileFromStream(fileName, inStream) {
+        /**
+         *
+         * @param {string} fileName
+         * @param {*} inStream
+         * @param {*} resolve
+         */
+        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 ); } );
+        return new Promise((resolve) => {
+            implementation(fileName, inStream, resolve);
+        });
     }
 
-    static exists( path ) {
-        return fs.existsSync( path );
+    /**
+     * @param {string} path
+     * @returns {boolean}
+     */
+    static exists(path) {
+        return fs.existsSync(path);
     }
 
     /**
      * Retrieve data from a URL and write it to a file. If the response status is anything other than 200, an Error is thrown.
-     * @param {string|URL} url 
+     * @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.
      * @returns {Promise<Headers>} The Response headers.
      */
-    static async fetch( url, targetFileName, headers = {} ) {
-        const response = await fetch( url, headers );
-        if ( response.status !== 200 ) {
-            throw new Error( response.status + " retrieving " + url );
+    static async fetch(url, targetFileName, headers = {}) {
+        const response = await fetch(url, headers);
+        if (response.status !== 200) {
+            throw new Error(response.status + " retrieving " + url);
         }
         const data = await response.blob();
         const arrayBuffer = await data.arrayBuffer();
-        const buffer = Buffer.from( arrayBuffer );
-        if ( targetFileName ) {
-            fs.writeFileSync( targetFileName, buffer );
+        const buffer = Buffer.from(arrayBuffer);
+        if (targetFileName) {
+            fs.writeFileSync(targetFileName, buffer);
         }
         return response.headers;
     }
 
-    static getDirEntries( path ) {
-        return fs.readdirSync( path );
+    /**
+     * @param {string} path
+     * @returns {string[]}
+     */
+    static getDirEntries(path) {
+        return fs.readdirSync(path);
     }
 
-    static isDir( path ) {
-        const stats = fs.statSync( path, { throwIfNoEntry: false } );
+    /**
+     * @param {string} path
+     * @returns {boolean}
+     */
+    static isDir(path) {
+        const stats = fs.statSync(path, { throwIfNoEntry: false });
         return stats !== undefined && stats.isDirectory();
     }
 
-    static join( ...paths ) {
-        return path.join( ...paths ).replaceAll( "\\", "/" );
+    /**
+     * @param {string[]} paths
+     * @returns {string}
+     */
+    static join(...paths) {
+        return path.join(...paths).replaceAll("\\", "/");
     }
 
-    static mkdir( path ) {
-        fs.mkdirSync( path, { recursive: true } );
+    /**
+     * @param {string} path
+     */
+    static mkdir(path) {
+        fs.mkdirSync(path, { recursive: true });
     }
 
-    static read( path ) {
-        return fs.readFileSync( path, "utf8" );
+    /**
+     * @param {string} path
+     * @returns {string}
+     */
+    static read(path) {
+        return fs.readFileSync(path, "utf8");
     }
 
-    static rmDir( dir ) {
-        fs.rmSync( dir, { force: true, recursive: true, maxRetries: 2, retryDelay: 1000 } );
+    /**
+     * @param {string} dir
+     */
+    static rmDir(dir) {
+        fs.rmSync(dir, {
+            force: true,
+            recursive: true,
+            maxRetries: 2,
+            retryDelay: 1000,
+        });
     }
 
-    static write( path, data, overwrite = false ) {
-        if ( !overwrite && this.exists( path ) ) {
-            throw new Error( path + " already exists" );
+    /**
+     * @param {string} path
+     * @param {string} data
+     * @param {boolean} overwrite
+     */
+    static write(path, data, overwrite = false) {
+        if (!overwrite && this.exists(path)) {
+            throw new Error(path + " already exists");
         }
-        fs.writeFileSync( path, data );
+        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() );
+    /**
+     * @param {string} zipFilePath
+     * @param {string} fileNameToUnzip
+     * @param {string} targetFilePath
+     */
+    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 };
+export { Files };

package/lib/generictaxaloader.js

@@ -1,16 +1,22 @@
-import { ErrorLog } from "./errorlog.js";
+import { ErrorLog } from "./index.js";
 
 class GenericTaxaLoader {
-
     #options;
     #errorLog;
+    /** @type {import("./index.js").Taxa|undefined}*/
     #taxa;
 
-    constructor( options ) {
+    /**
+     * @param {*} options
+     */
+    constructor(options) {
         this.#options = options;
-        this.#errorLog = new ErrorLog( options.outputdir + "/errors.tsv" );
+        this.#errorLog = new ErrorLog(options.outputdir + "/errors.tsv");
     }
 
+    /**
+     * @returns {ErrorLog}
+     */
     getErrorLog() {
         return this.#errorLog;
     }
@@ -27,14 +33,16 @@ class GenericTaxaLoader {
         this.#taxa = await this.loadTaxa();
     }
 
+    /**
+     * @return {Promise<import("./index.js").Taxa>}
+     */
     async loadTaxa() {
-        throw new Error( "must be implemented by subclass" );
+        throw new Error("must be implemented by subclass");
     }
 
     writeErrorLog() {
         this.#errorLog.write();
     }
-
 }
 
-export { GenericTaxaLoader };
+export { GenericTaxaLoader };

package/lib/html.js

@@ -52,8 +52,8 @@ export class HTML {
      * Generate HTML for an <a> element.
      * @param {string|undefined} href 
      * @param {string} linkText 
-     * @param {Object} attributes 
-     * @param {boolean} openInNewWindow true if the link should open in a new window.
+     * @param {Object} [attributes] 
+     * @param {boolean} [openInNewWindow] true if the link should open in a new window.
      * @returns {string} an HTML <a> element.
      */
     static getLink( href, linkText, attributes = {}, openInNewWindow ) {

package/lib/index.js

@@ -1,3 +1,22 @@
+/**
+ * @typedef {{
+ * bloom_end:string;
+ * bloom_start:string;
+ * calrecnum:string;
+ * CESA:string;
+ * CRPR:string;
+ * common_name:string;
+ * FESA:string;
+ * flower_color:string;
+ * GRank:string;
+ * "inat id":string;
+ * "jepson id":string;
+ * SRank:string;
+ * status:string;
+ * "RPI ID":string;
+ * taxon_name:string}} TaxonData
+ */
+
 import { BasePageRenderer } from "./basepagerenderer.js";
 import { CommandProcessor } from "./commandprocessor.js";
 import { CommandAndTaxaProcessor } from "./commandandtaxaprocessor.js";
@@ -17,6 +36,22 @@ import { TaxaProcessor } from "./taxaprocessor.js";
 import { Taxon, TAXA_COLNAMES } from "./taxon.js";
 
 export {
-    BasePageRenderer, CommandProcessor, CommandAndTaxaProcessor, Config, CSV, ErrorLog, Exceptions, Families, Files,
-    GenericTaxaLoader, HTML, Jekyll, PlantBook, Taxa, TaxaLoader, TaxaProcessor, TAXA_COLNAMES, Taxon
-};
+    BasePageRenderer,
+    CommandProcessor,
+    CommandAndTaxaProcessor,
+    Config,
+    CSV,
+    ErrorLog,
+    Exceptions,
+    Families,
+    Files,
+    GenericTaxaLoader,
+    HTML,
+    Jekyll,
+    PlantBook,
+    Taxa,
+    TaxaLoader,
+    TaxaProcessor,
+    TAXA_COLNAMES,
+    Taxon,
+};