@ca-plant-list/ca-plant-list 0.3.2 → 0.3.4

package/lib/index.d.ts

@@ -1,345 +0,0 @@
-export class BasePageRenderer {
-    static render(outputDir: any, taxa: any, familyCols: any): void;
-    static renderTools(outputDir: any, taxa: any): void;
-}
-export class CommandAndTaxaProcessor extends CommandProcessor {
-    constructor(commandName: any, commandDesc: any, optionDefs: any[], optionHelp: any[], commandHelp: any[], taxaLoaderClass: any);
-    process(commandRunner: any): Promise<void>;
-    #private;
-}
-import { CommandProcessor } from "./commandprocessor.js";
-export class CommandProcessor {
-    /**
-     * @param {String} commandName
-     * @param {String} commandDesc
-     * @param {*} optionDefs An array of command line options to be added to the standard options.
-     * @param {*} optionHelp An array of help descriptions to be added to the standard options in the first section.
-     * @param {*} commandHelp An array of help sections to be appended to the first option section in the help display.
-     */
-    constructor(commandName: string, commandDesc: string, optionDefs?: any, optionHelp?: any, commandHelp?: any);
-    getOptions(): any;
-    helpShown(): boolean;
-    showHelp(): void;
-    #private;
-}
-export class Config {
-    static "__#1@#packageDir": string;
-    static getPackageDir(): string;
-    constructor(dataDir: any);
-    getConfigValue(prefix: any, name: any, subcat: any, dflt: any): any;
-    getCountyCodes(): any;
-    getLabel(name: any, dflt: any): any;
-    #private;
-}
-export class CSV {
-    static getMap(dir: any, fileName: any): {};
-    static "__#8@#getOptions"(fileName: any, columns: any, delimiter: any): {
-        relax_column_count_less: boolean;
-    };
-    /**
-     * @param {string} dir
-     * @param {string} fileName
-     * @param {boolean|undefined} [columns]
-     * @param {string|undefined} [delimiter]
-     */
-    static parseFile(dir: string, fileName: string, columns?: boolean | undefined, delimiter?: string | undefined): any;
-    /**
-     * @param {string} dir
-     * @param {string} fileName
-     * @param {boolean|undefined} columns
-     * @param {string|undefined} delimiter
-     * @param {*} callback
-     */
-    static parseStream(dir: string, fileName: string, columns: boolean | undefined, delimiter: string | undefined, callback: any): Promise<void>;
-}
-export class DateUtils {
-    static getMonthName(monthNum: any): string;
-    static monthRangesOverlap(r1: any, r2: any): any;
-}
-export class ErrorLog {
-    constructor(fileName: any, echo?: boolean);
-    log(...args: any[]): void;
-    write(): void;
-    #private;
-}
-export class Exceptions {
-    constructor(dir: any);
-    getExceptions(): [string, any][];
-    getValue(name: any, cat: any, subcat: any, defaultValue: any): any;
-    hasException(name: any, cat: any, subcat: any): boolean;
-    #private;
-}
-export class Families {
-    static "__#12@#families": any;
-    static getFamilies(): any[];
-    static getFamily(familyName: any): any;
-    static renderPages(outputDir: any, taxaColumns: any): void;
-}
-export class Files {
-    static copyDir(srcDir: any, targetDir: any): void;
-    static createFileFromStream(fileName: any, inStream: any): Promise<any>;
-    static exists(path: any): boolean;
-    /**
-     * 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|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 fetch(url: string | URL, targetFileName: string | undefined, headers?: any): Promise<Headers>;
-    static getDirEntries(path: any): string[];
-    static isDir(path: any): boolean;
-    static join(...paths: any[]): any;
-    static mkdir(path: any): void;
-    static read(path: any): string;
-    static rmDir(dir: any): void;
-    static write(path: any, data: any, overwrite?: boolean): void;
-    static zipFileExtract(zipFilePath: any, fileNameToUnzip: any, targetFilePath: any): Promise<void>;
-}
-export class Genera {
-    static "__#5@#genera": any;
-    static addTaxon(taxon: any): void;
-    static getGenus(genusName: any): Genus;
-    static getFamily(genusName: any): any;
-}
-declare class Genus {
-    constructor(data: any);
-    getTaxa(): any;
-    #private;
-}
-export {};
-export class GenericPage {
-    constructor(outputDir: any, title: any, baseFileName: any, js: any);
-    getBaseFileName(): any;
-    getDefaultIntro(): string;
-    getFrontMatter(): string;
-    getMarkdown(): any;
-    getOutputDir(): any;
-    getTitle(): any;
-    writeFile(html: any): void;
-    #private;
-}
-export class GenericTaxaLoader {
-    constructor(options: any);
-    getErrorLog(): ErrorLog;
-    getOptions(): any;
-    getTaxa(): any;
-    load(): Promise<void>;
-    loadTaxa(): Promise<void>;
-    writeErrorLog(): void;
-    #private;
-}
-import { ErrorLog } from "./errorlog.js";
-export namespace HTML_OPTIONS {
-    let OPEN_NEW: number;
-    let 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 "__#4@#getElement"(elName: any, text: any, attributes: any, escape: any): string;
-    /**
-     * Generate HTML for an &lt;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.
-     * @returns {string} an HTML &lt;a> element.
-     */
-    static getLink(href: string | undefined, linkText: string, attributes?: any, openInNewWindow?: boolean): string;
-    /**
-     * Get a Bootstrap formatted tooltip element.
-     * @param {string} text - The text or HTML that should trigger the tooltip on hover.
-     * @param {string} tooltip - The tooltip text or HTML.
-     * @param {Object} options
-     * @param {boolean} options.icon [true] display an icon after the text
-     * @returns {string} A &lt;span> element to be used as a Bootstrap tooltip.
-     */
-    static getToolTip(text: string, tooltip: string, options?: {
-        icon: boolean;
-    }): 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;
-}
-import { BasePageRenderer } from "./basepagerenderer.js";
-import { CommandProcessor } from "./commandprocessor.js";
-import { CommandAndTaxaProcessor } from "./commandandtaxaprocessor.js";
-import { Config } from "./config.js";
-import { CSV } from "./csv.js";
-import { ErrorLog } from "./errorlog.js";
-import { Exceptions } from "./exceptions.js";
-import { Families } from "./families.js";
-import { Files } from "./files.js";
-import { GenericTaxaLoader } from "./generictaxaloader.js";
-import { HTML } from "./html.js";
-import { Jekyll } from "./jekyll.js";
-import { PlantBook } from "./ebook/plantbook.js";
-import { Taxa } from "./taxa.js";
-import { TaxaLoader } from "./taxaloader.js";
-import { TaxaProcessor } from "./taxaprocessor.js";
-import { TAXA_COLNAMES } from "./taxon.js";
-import { Taxon } from "./taxon.js";
-export { BasePageRenderer, CommandProcessor, CommandAndTaxaProcessor, Config, CSV, ErrorLog, Exceptions, Families, Files, GenericTaxaLoader, HTML, Jekyll, PlantBook, Taxa, TaxaLoader, TaxaProcessor, TAXA_COLNAMES, Taxon };
-export class Jekyll extends SiteGenerator {
-    static getFrontMatter(atts: any): string;
-    static hasInclude(baseDir: any, path: any): boolean;
-    static include(path: any): string;
-    static writeInclude(baseDir: any, path: any, data: any): void;
-    writeTemplate(content: any, attributes: any, filename: any): void;
-}
-import { SiteGenerator } from "./sitegenerator.js";
-export class Jepson {
-    static getEFloraLink(id: any): string;
-}
-export class Markdown {
-    static "__#2@#md": any;
-    static fileToHTML(filePath: any): any;
-    static strToHTML(str: any): any;
-}
-export class RarePlants {
-    static getCESADescription(cesa: any): any;
-    static getFESADescription(fesa: any): any;
-    static getRPIRankDescription(rank: any): any;
-    static getRPIRankAndThreatDescriptions(rank: any): any[];
-}
-export class SiteGenerator {
-    constructor(baseDir: any);
-    copyIllustrations(flowerColors: any): void;
-    getBaseDir(): any;
-    mkdir(path: any): void;
-    #private;
-}
-export class Taxa {
-    static getHTMLTable(taxa: any, columns?: {
-        title: string;
-        data: (t: any) => any;
-    }[]): string;
-    static getFlowerColorNames(): string[];
-    static getFlowerColors(): {
-        name: string;
-        color: string;
-    }[];
-    constructor(inclusionList: any, errorLog: any, showFlowerErrors: any, taxaMeta?: {}, taxonClass?: typeof Taxon, extraTaxa?: any[], extraSynonyms?: any[]);
-    getFlowerColor(name: any): any;
-    getTaxon(name: any): any;
-    getTaxonList(): any[];
-    hasSynonym(formerName: any): boolean;
-    /**
-     * true if an inclusion list was supplied when reading the taxa.
-     * @returns {boolean}
-     */
-    isSubset(): boolean;
-    #private;
-}
-export namespace TAXA_LIST_COLS {
-    namespace CESA {
-        let title: string;
-        function data(t: any): any;
-    }
-    namespace COMMON_NAME {
-        let title_1: string;
-        export { title_1 as title };
-        export function data_1(t: any): any;
-        export { data_1 as data };
-    }
-    namespace CNPS_RANK {
-        let title_2: string;
-        export { title_2 as title };
-        export function data_2(t: any): string;
-        export { data_2 as data };
-    }
-    namespace FESA {
-        let title_3: string;
-        export { title_3 as title };
-        export function data_3(t: any): any;
-        export { data_3 as data };
-    }
-    namespace SPECIES {
-        let title_4: string;
-        export { title_4 as title };
-        export function data_4(t: any): any;
-        export { data_4 as data };
-    }
-    namespace SPECIES_BARE {
-        let title_5: string;
-        export { title_5 as title };
-        export function data_5(t: any): any;
-        export { data_5 as data };
-    }
-}
-import { Taxon } from "./taxon.js";
-export class TaxaLoader extends GenericTaxaLoader {
-    loadTaxa(): Promise<Taxa>;
-}
-import { GenericTaxaLoader } from "./generictaxaloader.js";
-import { Taxa } from "./taxa.js";
-export class TaxaProcessor {
-    constructor(options: any, taxaLoaderClass?: typeof TaxaLoader);
-    getErrorLog(): any;
-    getOptions(): any;
-    getTaxa(): any;
-    process(commandRunner: any): Promise<void>;
-    #private;
-}
-import { TaxaLoader } from "./taxaloader.js";
-export namespace TAXA_COLNAMES {
-    let BLOOM_START: string;
-    let BLOOM_END: string;
-    let COMMON_NAME: string;
-    let FLOWER_COLOR: string;
-}
-export class Taxon {
-    constructor(data: any);
-    addSynonym(syn: any, type: any): void;
-    getBaseFileName(): any;
-    getBloomEnd(): any;
-    getBloomStart(): any;
-    getCalfloraName(): any;
-    getCalfloraID(): any;
-    getCalfloraTaxonLink(): string;
-    getCESA(): any;
-    getCNDDBRank(): any;
-    getCommonNames(): any;
-    getFamily(): any;
-    getFESA(): any;
-    getFileName(ext?: string): string;
-    getFlowerColors(): any;
-    getGenus(): {
-        "__#6@#data": any;
-        getTaxa(): any;
-    };
-    getGenusName(): any;
-    getGlobalRank(): any;
-    getHTMLLink(href?: boolean, includeRPI?: boolean): string;
-    getINatID(): any;
-    getINatName(): any;
-    getINatSyn(): any;
-    getINatTaxonLink(): string;
-    getJepsonID(): any;
-    getName(): any;
-    getRPIID(): any;
-    getRPIRank(): any;
-    getRPIRankAndThreat(): any;
-    getRPIRankAndThreatTooltip(): string;
-    getRPITaxonLink(): string;
-    getStatus(): any;
-    getStatusDescription(config: any): any;
-    getSynonyms(): any[];
-    isCANative(): boolean;
-    /**
-     * 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(): boolean;
-    isRare(): boolean;
-    shouldHaveFlowers(): boolean;
-    #private;
-}