github-action-readme-generator 1.10.10 → 1.11.0

package/dist/types/inputs.d.ts

@@ -0,0 +1,153 @@
+import { context as githubContext } from '@actions/github';
+import nconf from 'nconf';
+type Context = typeof githubContext;
+declare const Context: new () => Context;
+import Action, { type Input } from './Action.js';
+import { type ReadmeSection } from './constants.js';
+import LogTask from './logtask/index.js';
+import ReadmeEditor from './readme-editor.js';
+declare const Provider: typeof nconf.Provider;
+type IOptions = nconf.IOptions;
+/**
+ * Change working directory to output of workingDirectory()
+ */
+export declare const metaActionPath = "../../action.yml";
+export type ArgvOptionProperties = {
+    [key: string]: {
+        alias: string | string[];
+        describe: string;
+        parseValues?: boolean;
+        type?: string;
+    };
+};
+/**
+ * Interface for key/value pair object
+ */
+type KVPairType = {
+    key: string;
+    value: string | undefined;
+};
+/**
+ * Type alias for Provider instance
+ */
+type ProviderInstance = InstanceType<typeof Provider>;
+export declare function transformGitHubInputsToArgv(log: LogTask, _config: ProviderInstance, obj: KVPairType): undefined | KVPairType;
+/**
+ * Sets config value from action file default
+ *
+ * @param {Action} actionInstance - The action instance
+ * @param {string} inputName - The input name
+ * @returns {string | boolean | undefined} The default value
+ */
+export declare function setConfigValueFromActionFileDefault(log: LogTask, actionInstance: Action, inputName: string): string | boolean | undefined;
+/**
+ * Collects all default values from action file
+ *
+ * @returns {IOptions} The default values object
+ */
+export declare function collectAllDefaultValuesFromAction(log: LogTask, providedMetaActionPath?: string, providedDefaults?: {
+    [key: string]: Input;
+}): IOptions;
+/**
+ * Loads the configuration
+ *
+ * @returns {ProviderInstance} The configuration instance
+ */
+export declare function loadConfig(log: LogTask, providedConfig?: ProviderInstance, configFilePath?: string): ProviderInstance;
+/**
+ * Loads the default configuration
+ *
+ * @param {ProviderInstance} config - The config instance
+ * @returns {ProviderInstance} The updated config instance
+ */
+export declare function loadDefaultConfig(log: LogTask, config: ProviderInstance, providedContext?: Context): ProviderInstance;
+/**
+ * Loads the required configuration
+ *
+ * @param {ProviderInstance} config - The config instance
+ * @returns {ProviderInstance} The updated config instance
+ */
+export declare function loadRequiredConfig(log: LogTask, config: ProviderInstance, requiredInputs?: readonly string[]): ProviderInstance;
+/**
+ *
+ */
+export declare function loadAction(log: LogTask, actionPath: string): Action;
+export type InputContext = {
+    /**
+     * The configuration instance
+     */
+    config?: ProviderInstance;
+    /**
+     * The readme sections
+     */
+    sections?: ReadmeSection[];
+    /**
+     * The readme file path
+     */
+    readmePath?: string;
+    /**
+     * The config file path
+     */
+    configPath?: string;
+    /**
+     * The action instance
+     */
+    action?: Action;
+    /**
+     * The readme editor instance
+     */
+    readmeEditor?: ReadmeEditor;
+    /**
+     * The repository owner
+     */
+    owner?: string;
+    /**
+     * The repository name
+     */
+    repo?: string;
+};
+/**
+ * Main Inputs class that handles configuration
+ */
+export default class Inputs {
+    /**
+     * The configuration instance
+     */
+    config: ProviderInstance;
+    /**
+     * The readme sections
+     */
+    sections: ReadmeSection[];
+    /**
+     * The readme file path
+     */
+    readmePath: string;
+    /**
+     * The config file path
+     */
+    configPath: string;
+    /**
+     * The action instance
+     */
+    action: Action;
+    /**
+     * The readme editor instance
+     */
+    readmeEditor: ReadmeEditor;
+    /**
+     * The repository owner
+     */
+    owner: string;
+    /**
+     * The repository name
+     */
+    repo: string;
+    /** The logger for this instance */
+    log: LogTask;
+    /**
+     * Initializes a new instance of the Inputs class.
+     */
+    constructor(providedInputContext?: InputContext, log?: LogTask);
+    stringify(): string;
+}
+export {};

package/dist/types/logtask/index.d.ts

@@ -0,0 +1,95 @@
+declare enum LogGroup {
+    NO_GROUP = 0,
+    START_GROUP = 1,
+    END_GROUP = 2,
+    IS_ERROR = 3,
+    IS_FAILED = 4,
+    IS_TITLE = 5
+}
+/**
+ * Represents a logging task with various log step methods.
+ */
+export default class LogTask {
+    /**
+     * Map of ingroup settings per task name.
+     */
+    private static ingroupSettings;
+    /**
+     * The width of the indentation for log messages.
+     */
+    private static indentWidth;
+    /**
+     * Checks if debug mode is enabled.
+     * @returns A boolean indicating if debug mode is enabled.
+     */
+    static isDebug(): boolean;
+    /**
+     * The name of the task.
+     */
+    private name;
+    /**
+     * Creates a new instance of the LogTask class.
+     * @param name - The name of the task.
+     */
+    constructor(name: string);
+    /**
+     * Gets the ingroup setting for the task.
+     */
+    get ingroup(): boolean;
+    /**
+     * Sets the ingroup setting for this task.
+     */
+    set ingroup(value: boolean);
+    getMessageString(step: string, desc: string, emojiStr: string): string;
+    /**
+     * Logs a step with the given emoji, type, message and group.
+     * @param emojiStr - The emoji string to display.
+     * @param step - The step type.
+     * @param message - The message of the step.
+     * @param startGroup - The start group type.
+     */
+    logStep(emojiStr: string, step: string, message: string, startGroup?: LogGroup): void;
+    /**
+     * Logs a debug message.
+     * @param message - The message of the debug message.
+     */
+    debug(message?: string): void;
+    /**
+     * Logs a start message.
+     * @param message - The message of the start message.
+     */
+    start(message?: string): void;
+    /**
+     * Logs an info message.
+     * @param message - The message of the info message.
+     */
+    info(message?: string): void;
+    /**
+     * Logs a warning message.
+     * @param message - The message of the warning message.
+     */
+    warn(message?: string): void;
+    /**
+     * Logs a success message.
+     * @param message - The message of the success message.
+     * @param ingroup - Indicates whether the success message is in a group.
+     */
+    success(message?: string, ingroup?: boolean): void;
+    /**
+     * Logs a failure message.
+     * @param message - The message of the failure message.
+     * @param ingroup - Indicates whether the failure message is in a group.
+     */
+    fail(message?: string, ingroup?: boolean): void;
+    /**
+     * Logs an error message.
+     * @param message - The message of the error message.
+     */
+    error(message?: string): void;
+    /**
+     * Logs a title message.
+     * @param message - The message of the title message.
+     */
+    title(message?: string): void;
+}
+export {};

package/dist/types/markdowner/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Types representing a 2D array of strings for a Markdown table.
+ */
+export type MarkdownArrayRowType = string[][];
+export type MarkdownArrayItemType = string;
+/**
+ * Fills a string to a desired width by padding with spaces.
+ *
+ * @param text - The text to pad.
+ * @param width - The desired total width.
+ * @param paddingStart - Number of spaces to pad at the start.
+ * @returns The padded string.
+ */
+export declare function padString(text: string, width: number, paddingStart: number): string;
+/**
+ * Escapes special Markdown characters in a string.
+ *
+ * @param text - The text to escape.
+ * @returns The escaped text.
+ */
+export declare function markdownEscapeTableCell(text: string): string;
+/**
+ * Escapes inline code blocks in a Markdown string.
+ *
+ * @param content - Markdown string.
+ * @returns String with escaped inline code blocks.
+ */
+export declare function markdownEscapeInlineCode(content: string): string;
+/**
+ * Clones a 2D array.
+ *
+ * @param arr - Array to clone.
+ * @returns Cloned array.
+ */
+export declare function cloneArray(arr: MarkdownArrayRowType): MarkdownArrayRowType;
+/**
+ * Gets max and min column counts from 2D array.
+ *
+ * @param data - 2D string array.
+ * @returns Object with max and min cols.
+ */
+export declare function getColumnCounts(data: MarkdownArrayRowType): {
+    maxCols: number;
+    minCols: number;
+};
+/**
+ * Pads 2D array rows to equal length.
+ *
+ * @param data - 2D array to pad.
+ * @param maxCols - Number of columns to pad to.
+ * @returns Padded 2D array.
+ */
+export declare function padArrayRows(data: MarkdownArrayRowType, maxCols: number): MarkdownArrayRowType;
+/**
+ * Converts a 2D array of strings to a Markdown table.
+ *
+ * @param data - 2D string array.
+ * @returns Markdown table string.
+ */
+export declare function ArrayOfArraysToMarkdownTable(providedTableContent: MarkdownArrayRowType): string;
+export default ArrayOfArraysToMarkdownTable;

package/dist/types/prettier.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This TypeScript code exports three functions: `formatYaml`, `formatMarkdown`, and `wrapDescription`.
+ *
+ * - `formatYaml` takes a YAML string and an optional filepath as parameters and uses the `prettier` library to format the YAML code. It returns the formatted YAML string.
+ * - `formatMarkdown` takes a Markdown string and an optional filepath as parameters and uses the `prettier` library to format the Markdown code. It returns the formatted Markdown string.
+ * - `wrapDescription` takes a string value, an array of content, and an optional prefix as parameters. It wraps the description text with the specified prefix and formats it using `prettier`. It returns the updated content array with the formatted description lines.
+ *
+ * The code utilizes the `prettier` library for code formatting and the `LogTask` class for logging purposes.
+ */
+/**
+ * Formats a YAML string using `prettier`.
+ * @param {string} value - The YAML string to format.
+ * @param {string} [filepath] - The optional filepath.
+ * @returns {Promise<string>} A promise that resolves with the formatted YAML string.
+ */
+export declare function formatYaml(value: string, filepath?: string): Promise<string>;
+/**
+ * Formats a Markdown string using `prettier`.
+ * @param {string} value - The Markdown string to format.
+ * @param {string} [filepath] - The optional filepath.
+ * @returns {Promise<string>} A promise that resolves with the formatted Markdown string.
+ */
+export declare function formatMarkdown(value: string, filepath?: string): Promise<string>;
+/**
+ * Wraps a description text with a prefix and formats it using `prettier`.
+ * @param {string | undefined} value - The description text to wrap and format.
+ * @param {string[]} content - The array of content to update.
+ * @param {string} [prefix='    # '] - The optional prefix to wrap the description lines.
+ * @returns {Promise<string[]>} A promise that resolves with the updated content array.
+ */
+export declare function wrapDescription(value: string | undefined, content: string[], prefix?: string): Promise<string[]>;

package/dist/types/readme-editor.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This TypeScript code imports the necessary modules and defines a class named `ReadmeEditor`.
+ * The class represents an editor for modifying a README file.
+ * It has methods to update specific sections within the file and dump the modified content back to the file.
+ */
+import LogTask from './logtask/index.js';
+/**
+ * The format for the start token of a section.
+ */
+export declare const startTokenFormat = "(^|[^`\\\\])<!--\\s+start\\s+%s\\s+-->";
+/**
+ * The format for the end token of a section.
+ */
+export declare const endTokenFormat = "(^|[^`\\\\])<!--\\s+end\\s+%s\\s+-->";
+export default class ReadmeEditor {
+    private log;
+    /**
+     * The path to the README file.
+     */
+    private readonly filePath;
+    private fileContent;
+    /**
+     * Creates a new instance of `ReadmeEditor`.
+     * @param {string} filePath - The path to the README file.
+     */
+    constructor(filePath: string);
+    /**
+     * Gets the current README content.
+     * @returns {string} - The README file content.
+     */
+    getReadmeContent(): string;
+    /**
+     * Gets the indexes of the start and end tokens for a given section.
+     * @param {string} token - The section token.
+     * @returns {number[]} - The indexes of the start and end tokens.
+     */
+    getTokenIndexes(token: string, logTask?: LogTask): number[];
+    /**
+     * Updates a specific section in the README file with the provided content.
+     * @param {string} name - The name of the section.
+     * @param {string | string[]} providedContent - The content to update the section with.
+     * @param {boolean} addNewlines - Whether to add newlines before and after the content.
+     */
+    updateSection(name: string, providedContent: string | string[], addNewlines?: boolean): void;
+    /**
+     * Dumps the modified content back to the README file.
+     * @returns {Promise<void>}
+     */
+    dumpToFile(): Promise<void>;
+}

package/dist/types/readme-generator.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This TypeScript code imports various modules and defines a function named 'generateDocs'.
+ * The function is responsible for generating documentation for the README.md file based on the provided inputs.
+ * It iterates through each section defined in the 'inputs.sections' array and calls the 'updateSection' function to update the corresponding section in the README.md file.
+ * If an error occurs during the update of a section, it logs the error message and stops the process.
+ * Finally, it saves the updated README.md file and calls the 'save' function.
+ */
+import type { ReadmeSection } from './constants.js';
+import type Inputs from './inputs.js';
+import type LogTask from './logtask/index.js';
+export type SectionKV = Record<string, string>;
+/**
+ * Class for managing README generation.
+ */
+export declare class ReadmeGenerator {
+    /**
+     * The Inputs instance.
+     */
+    private inputs;
+    /**
+     * The Logger instance.
+     */
+    private log;
+    /**
+     * Initializes the ReadmeGenerator.
+     *
+     * @param inputs - The Inputs instance
+     * @param log - The Logger instance
+     */
+    constructor(inputs: Inputs, log: LogTask);
+    /**
+     * Updates the README sections.
+     *
+     * @param sections - The sections array
+     * @returns Promise array of section KV objects
+     */
+    updateSections(sections: ReadmeSection[]): Promise<SectionKV>[];
+    /**
+     * Resolves the section update promises.
+     *
+     * @param promises - The promise array
+     * @returns Promise resolving to combined sections KV
+     */
+    resolveUpdates(promises: Promise<SectionKV>[]): Promise<SectionKV>;
+    /**
+     * Outputs the sections KV to GitHub output.
+     *
+     * @param sections - The sections KV
+     */
+    outputSections(sections: SectionKV): void;
+    /**
+     * Generates the README documentation.
+     *
+     * @returns Promise resolving when done
+     */
+    generate(providedSections?: ReadmeSection[]): Promise<void>;
+}

package/dist/types/save.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This code exports a function named 'save' which takes an instance of the 'Inputs' class as its parameter.
+ * The function reads the configuration inputs from the 'inputs' parameter and uses them to create a new instance of the 'GHActionDocsConfig' class.
+ * If the 'save' property is set to true in the configuration inputs, the function saves the configuration to the file specified in the 'configPath' property of the 'inputs' parameter.
+ * This script is used to update the usage section in the README.md file to match the contents of the action.yml file.
+ */
+import type Inputs from './inputs.js';
+import type LogTask from './logtask/index.js';
+/**
+ * This script rebuilds the usage section in the README.md to be consistent with the action.yml
+ * @param {Inputs} inputs - the inputs class
+ */
+export default function save(inputs: Inputs, log: LogTask): void;

package/dist/types/sections/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This TypeScript code exports a function named 'updateSection' which takes a section (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating different sections of the README.md file based on the provided section input.
+ * It utilizes various update functions (e.g., updateBranding, updateBadges) to update specific sections.
+ * @param {ReadmeSection} section - The section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ * @returns {Promise<void>} A promise that resolves once the section is updated.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateSection(section: ReadmeSection, inputs: Inputs): Promise<Record<string, string>>;

package/dist/types/sections/update-badges.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This TypeScript code imports necessary modules and defines a function named 'updateBadges' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating the badges section in the README.md file based on the provided inputs.
+ * It utilizes the 'LogTask' class for logging purposes.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+/**
+ * Interface for a badge.
+ */
+export interface IBadge {
+    alt: string;
+    img: string;
+    url?: string;
+}
+export default function updateBadges(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-branding.d.ts

@@ -0,0 +1,55 @@
+import type { FeatherIconNames } from 'feather-icons';
+import type { BrandColors } from '../constants.js';
+import { type ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export interface IBranding {
+    alt: string;
+    img: string;
+    url?: string;
+}
+/**
+ * Generates a svg branding image.
+ * example:
+ * ```ts
+ * generateSvgImage('/path/to/file.svg', 'home', 'red')
+ * ```
+ *
+ * @param svgPath - The path to where the svg file will be saved
+ * @param icon - The icon name from the feather-icons list
+ * @param bgcolor - The background color of the circle behind the icon
+ */
+export declare function generateSvgImage(svgPath: string, icon: Partial<FeatherIconNames>, bgcolor: Partial<BrandColors>): void;
+/**
+ * This function returns a valid icon name based on the provided branding.
+ * If the branding is undefined or not a valid icon name, an error is thrown.
+ * It checks if the branding icon is present in the GITHUB_ACTIONS_BRANDING_ICONS set,
+ * and if so, returns the corresponding feather icon key array.
+ * If the branding icon is present in the GITHUB_ACTIONS_OMITTED_ICONS set,
+ * an error is thrown specifying that the icon is part of the omitted icons list.
+ * If the branding icon is not a valid icon from the feather-icons list, an error is thrown.
+ * @param brand - The branding object
+ * @returns The corresponding feather icon key array
+ * @throws Error if the branding icon is undefined, not a valid icon name, or part of the omitted icons list
+ */
+export declare function getValidIconName(icon?: Partial<FeatherIconNames>): FeatherIconNames;
+/**
+ * This function generates an HTML image markup with branding information.
+ * It takes inputs and an optional width parameter.
+ * If the branding_svg_path is provided, it generates an action.yml branding image for the specified icon and color.
+ * Otherwise, it returns an error message.
+ *
+ * @param inputs - The inputs instance with data for the function.
+ * @param width - The width of the image (default is '15%').
+ * @returns The HTML image markup with branding information or an error message.
+ */
+export declare function generateImgMarkup(inputs: Inputs, width?: string): string;
+/**
+ * This is a TypeScript function named "updateBranding" that takes in a sectionToken string and an object of inputs.
+ * It exports the function as the default export.
+ * The function logs the brand details from the inputs, starts a log task, generates image markup,
+ * updates a section in the readme editor using the sectionToken and content, and logs success or failure messages.
+ *
+ * @param sectionToken - The sectionToken string that is used to identify the section in the readme editor.
+ * @param inputs - The inputs object that contains data for the function.
+ */
+export default function updateBranding(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-contents.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This TypeScript code exports a function named 'updateContents' which generates
+ * a table of contents from the README.md headers.
+ * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateContents(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-description.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This TypeScript code exports a function named 'updateDescription' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating the description section in the README.md file based on the provided inputs.
+ * It utilizes the 'LogTask' class for logging purposes.
+ * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateDescription(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-inputs.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This TypeScript code exports a function named 'updateInputs' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating the inputs section in the README.md file based on the provided inputs.
+ * It utilizes the 'LogTask' class for logging purposes, 'columnHeader' and 'rowHeader' functions from '../helpers.js' for formatting table headers, and 'markdowner' function from '../markdowner/index.js' for generating markdown content.
+ * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateInputs(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-outputs.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This TypeScript code exports a function named 'updateOutputs' which takes a sectionToken (string) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating the outputs section in the README.md file based on the provided inputs.
+ * It generates a table with three columns: Output name, Description, and Value (for composite actions).
+ * It utilizes the 'LogTask' class for logging purposes, 'columnHeader' and 'rowHeader' functions from '../helpers.js' for formatting table headers, and 'markdowner' function from '../markdowner/index.js' for generating markdown content.
+ * @param {ReadmeSection} sectionToken - The sectionToken used for identifying the section.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateOutputs(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-title.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This TypeScript code exports a function named 'updateTitle' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
+ * The function is responsible for updating the title section in the README.md file based on the provided inputs.
+ * It utilizes the 'LogTask' class for logging purposes, the 'generateImgMarkup' function from './update-branding.js' for generating image markup.
+ * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
+ * @param {Inputs} inputs - The Inputs class instance.
+ */
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateTitle(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;

package/dist/types/sections/update-usage.d.ts

@@ -0,0 +1,3 @@
+import type { ReadmeSection } from '../constants.js';
+import type Inputs from '../inputs.js';
+export default function updateUsage(sectionToken: ReadmeSection, inputs: Inputs): Promise<Record<string, string>>;

package/dist/types/svg-editor.d.mts

@@ -0,0 +1,47 @@
+/**
+ * This TypeScript code imports necessary modules and defines a class named 'SVGEditor' for generating SVG images.
+ * The class has methods for initializing the SVG window, generating SVG content, and writing SVG files.
+ * It utilizes various packages such as 'fs', 'path', '@svgdotjs/svg.js', 'feather-icons', and 'svgdom' for SVG manipulation and file operations.
+ * The class also defines interfaces for badges and brand colors.
+ */
+import type { FeatherIconNames } from 'feather-icons';
+import type { BrandColors } from './constants.js';
+/**
+ * Utility class for generating SVG images.
+ */
+export default class SVGEditor {
+    private log;
+    private window?;
+    private canvas?;
+    private document?;
+    /**
+     * Initializes a new SVGEditor instance.
+     */
+    constructor();
+    /**
+     * Initializes the SVG window, document, and canvas if not already set up.
+     */
+    initSVG(): void;
+    /**
+     * Generates a branded SVG image.
+     * @param {string | undefined} svgPath - Path to write the generated SVG file to.
+     * @param {Partial<FeatherIconNames>} icon - Name of the icon to use.
+     * @param {Partial<BrandColors>} bgcolor - Background color for the image.
+     * @returns {Promise<void>} A promise that resolves when the image is generated.
+     */
+    generateSvgImage(svgPath: string | undefined, icon?: Partial<FeatherIconNames>, bgcolor?: Partial<BrandColors>): void;
+    /**
+     * Writes the SVG xml to disk.
+     * @param {string} svgPath - File path to save the SVG to.
+     * @param {string} svgContent - The XML for the SVG file.
+     */
+    writeSVGFile(svgPath: string, svgContent: string): void;
+    /**
+     * Generates the SVG content for the branding image.
+     * @param {FeatherIconNames} icon - Name of the icon to use.
+     * @param {BrandColors} color - Background color for the image.
+     * @param {number} outerViewBox - Size of the canvas for the image.
+     * @returns {string} The generated SVG content.
+     */
+    generateSVGContent(icon: FeatherIconNames, color: BrandColors, outerViewBox?: number): string;
+}

package/dist/types/unicode-word-match.d.ts

@@ -0,0 +1 @@
+export declare const unicodeWordMatch: RegExp;

package/dist/types/util.d.ts

@@ -0,0 +1,2 @@
+export type Nullable<T> = T | null | undefined;
+export declare function notEmpty(str: Nullable<string>): str is string;