@ca-plant-list/ca-plant-list 0.1.7 → 0.1.9

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,53 @@
 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 exists( path ) {
+        return fs.existsSync( path );
+    }
+
     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 ( this.exists( 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,32 @@
+export class Files {
+    static createFileFromStream(fileName: any, inStream: any): Promise<any>;
+    static exists(path: any): boolean;
+    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;
+}
+export class Jekyll {
+    static hasInclude(baseDir: any, path: any): boolean;
+    static include(path: any): string;
+}

package/lib/index.js

@@ -6,7 +6,8 @@ import { ErrorLog } from "./errorlog.js";
 import { Exceptions } from "./exceptions.js";
 import { Files } from "./files.js";
 import { HTML, HTML_OPTIONS } from "./html.js";
+import { Jekyll } from "./jekyll.js";
 import { Taxa } from "./taxa.js";
 import { Taxon } from "./taxon.js";
 
-export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Files, HTML, HTML_OPTIONS, Taxa, Taxon };
+export { BasePageRenderer, Config, CSV, DataLoader, ErrorLog, Exceptions, Files, HTML, HTML_OPTIONS, Jekyll, Taxa, Taxon };

package/lib/jekyll.js

@@ -0,0 +1,15 @@
+import { Files } from "./files.js";
+
+class Jekyll {
+
+    static hasInclude( baseDir, path ) {
+        return Files.exists( baseDir + "/_includes/" + path );
+    }
+
+    static include( path ) {
+        return "{%include " + path + "%}";
+    }
+
+}
+
+export { Jekyll };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ca-plant-list/ca-plant-list",
-    "version": "0.1.7",
+    "version": "0.1.9",
     "description": "Tools to create Jekyll files for a website listing plants in an area of California.",
     "license": "MIT",
     "repository": {
@@ -10,16 +10,23 @@
     "homepage": "https://github.com/ca-plants/ca-plant-list",
     "type": "module",
     "exports": {
-        ".": "./lib/index.js"
+        ".": "./lib/index.js",
+        "./Files": "./lib/files.js",
+        "./HTML": "./lib/html.js",
+        "./Jekyll": "./lib/jekyll.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"
+    }
+}