kist 0.0.0 → 0.1.30

package/ts/actions/SvgSpriteAction/svgsprite.config.ts

@@ -0,0 +1,123 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import svgSprite from "svg-sprite";
+
+// ============================================================================
+// Constants
+// ============================================================================
+
+const svgspriteConfig: svgSprite.Config = {
+    dest: "./dist/sprite", // Main output directory
+    // log: null, // Logging verbosity (default: no logging)
+    shape: {
+        // SVG shape related options
+        id: {
+            separator: "--", // Separator for directory name traversal
+            generator: "icon-%s",
+            // generator: function () { /*...*/ }, // SVG shape ID generator callback
+            pseudo: "~", // File name separator for shape states (e.g. ':hover')
+        },
+        dimension: {
+            // Dimension related options
+            maxWidth: 2000, // Max. shape width
+            maxHeight: 2000, // Max. shape height
+            precision: 2, // Floating point precision
+            attributes: false, // Width and height attributes on embedded shapes
+        },
+        spacing: {
+            // Spacing related options
+            padding: 0, // Padding around all shapes
+            box: "content", // Padding strategy (similar to CSS `box-sizing`)
+        },
+        transform: ["svgo"], // List of transformations / optimizations
+        // meta: null, // Path to YAML file with meta / accessibility data
+        // align: null, // Path to YAML file with extended alignment data
+        // dest: null // Output directory for optimized intermediate SVG shapes
+    },
+    svg: {
+        // General options for created SVG files
+        xmlDeclaration: false, // Add XML declaration to SVG sprite
+        // xmlDeclaration: true, // Add XML declaration to SVG sprite
+        doctypeDeclaration: true, // Add DOCTYPE declaration to SVG sprite
+        namespaceIDs: true, // Add namespace token to all IDs in SVG shapes
+        // namespaceIDPrefix: '', // Add a prefix to the automatically generated namespaceIDs
+        // namespaceClassnames: true, // Add namespace token to all CSS class names in SVG shapes
+        namespaceClassnames: false, // Add namespace token to all CSS class names in SVG shapes
+        dimensionAttributes: true, // Width and height attributes on the sprite
+    },
+    variables: {}, // Custom Mustache templating variables and functions
+    mode: {
+        css: {
+            // CSS sprite mode
+            render: {
+                css: true, // Render CSS stylesheet
+            },
+        },
+        view: true, // Create a «view» sprite
+        defs: true, // Create a «defs» sprite
+        // symbol: true, // Create a «symbol» sprite
+        symbol: {
+            // Create a «symbol» sprite
+            // dest: ".",
+            // inline: true, // Prepare for inline embedding
+            sprite: "icon.gl.svg",
+        },
+        stack: true, // Create a «stack» sprite
+        // symbol: true // Symbol sprite mode
+    },
+};
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export default svgspriteConfig;
+
+// "svgo": {
+//     "multipass": true,
+//     "plugins": [
+//         {
+//             "name": "preset-default",
+//             "params": {
+//             "overrides": {
+//                 "removeUnknownsAndDefaults": {
+//                     "keepDataAttrs": false,
+//                     "keepRoleAttr": true
+//                 },
+//                 "removeViewBox": false
+//             }
+//             }
+//         },
+//         "cleanupListOfValues",
+//         "removeXMLNS",
+//         {
+//             "name": "removeAttrs",
+//             "params": {
+//                 "attrs": [
+//                     "clip-rule",
+//                     "fill"
+//                 ]
+//             }
+//         }
+//     ]
+// }
+
+// <mode>: {
+//     dest: "<mode>", // Mode specific output directory
+//     prefix: "svg-%s", // Prefix for CSS selectors
+//     dimensions: "-dims", // Suffix for dimension CSS selectors
+//     sprite: "svg/sprite.<mode>.svg", // Sprite path and name
+//     bust: true || false, // Cache busting (mode dependent default value)
+//     render: { // Stylesheet rendering definitions
+//         /* -------------------------------------------
+//         css: false, // CSS stylesheet options
+//         scss: false, // Sass stylesheet options
+//         less: false, // LESS stylesheet options
+//         styl: false, // Stylus stylesheet options
+//         <custom>: ... // Custom stylesheet options
+//         -------------------------------------------    */
+//     },
+//     example: false // Create an HTML example document
+// }

package/ts/actions/SvgToPngAction/SvgToPngAction.ts

@@ -0,0 +1,113 @@
+// ============================================================================
+// Imports
+// ============================================================================
+
+import fs from "fs";
+import { JSDOM } from "jsdom";
+import path from "path";
+import sharp from "sharp";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+
+// ============================================================================
+// Classes
+// ============================================================================
+
+/**
+ * SvgToPngAction converts SVG content to PNG format.
+ * Uses `sharp` for conversion and `jsdom` for SVG element manipulation.
+ */
+export class SvgToPngAction extends Action {
+    // Methods
+    // ========================================================================
+
+    /**
+     * Executes the SVG-to-PNG conversion process.
+     * @param options - Options including SVG content, output path, width,
+     * and height.
+     */
+    async execute(options: ActionOptionsType): Promise<void> {
+        const { svgContent, outputPath, width, height } = options;
+
+        if (!svgContent || !outputPath) {
+            throw new Error(
+                "Both 'svgContent' and 'outputPath' must be provided.",
+            );
+        }
+
+        this.logInfo(`Converting SVG to PNG: ${outputPath}`);
+
+        try {
+            await this.convert(svgContent, outputPath, width, height);
+            this.logInfo(`SVG successfully converted to PNG: ${outputPath}`);
+        } catch (error) {
+            this.logError("Error converting SVG to PNG:", error);
+            throw error;
+        }
+    }
+
+    /**
+     * Converts SVG content to a PNG file, optionally resizing the output.
+     * @param svgContent - The SVG content to be converted.
+     * @param outputPath - The filesystem path where the PNG should be saved.
+     * @param width - Optional width for resizing.
+     * @param height - Optional height for resizing.
+     */
+    private async convert(
+        svgContent: string,
+        outputPath: string,
+        width?: number,
+        height?: number,
+    ): Promise<void> {
+        try {
+            // Ensure the output directory exists
+            const outputDir = path.dirname(outputPath);
+            if (!fs.existsSync(outputDir)) {
+                fs.mkdirSync(outputDir, { recursive: true });
+            }
+
+            // Create a JSDOM instance to parse the SVG
+            const dom = new JSDOM(svgContent);
+            const svgElement = dom.window.document.querySelector("svg");
+
+            if (!svgElement) {
+                throw new Error("Invalid SVG content");
+            }
+
+            if (width) {
+                svgElement.setAttribute("width", width.toString());
+            }
+
+            if (height) {
+                svgElement.setAttribute("height", height.toString());
+            }
+
+            // Serialize the updated SVG content
+            const updatedSvgContent = svgElement.outerHTML;
+
+            // Convert SVG to PNG using Sharp
+            const pngBuffer = await sharp(Buffer.from(updatedSvgContent))
+                .png()
+                .toBuffer();
+            await sharp(pngBuffer).toFile(outputPath);
+        } catch (error) {
+            throw new Error(
+                `Error converting SVG to PNG: ${(error as Error).message}`,
+            );
+        }
+    }
+
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string {
+        return "Converts SVG content to PNG format with optional resizing.";
+    }
+}
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export default SvgToPngAction;

package/ts/actions/SvgToPngAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { SvgToPngAction } from "./SvgToPngAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export { SvgToPngAction };

package/ts/actions/TypeScriptCompilerAction/TypeScriptCompilerAction.ts

@@ -0,0 +1,117 @@
+// ============================================================================
+// Imports
+// ============================================================================
+
+import path from "path";
+import ts from "typescript";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+
+// ============================================================================
+// Classes
+// ============================================================================
+
+/**
+ * TypeScriptCompilerAction compiles TypeScript files into JavaScript.
+ */
+export class TypeScriptCompilerAction extends Action {
+    /**
+     * Executes the TypeScript compilation process.
+     *
+     * @param options - The options specifying the tsconfig path and additional compiler options.
+     * @returns A Promise that resolves when compilation is completed successfully.
+     * @throws {Error} Throws an error if compilation fails.
+     */
+    async execute(options: ActionOptionsType): Promise<void> {
+        const { tsconfigPath = "tsconfig.json" } = options;
+        const resolvedTsconfigPath = path.resolve(tsconfigPath);
+
+        this.logInfo(
+            `Compiling TypeScript using configuration: ${resolvedTsconfigPath}`,
+        );
+
+        try {
+            // **Properly Parse tsconfig.json**
+            const parsedConfig = this.loadAndParseTsConfig(
+                resolvedTsconfigPath,
+            );
+
+            // **Create a TypeScript Program**
+            const program = ts.createProgram(
+                parsedConfig.fileNames,
+                parsedConfig.options,
+            );
+            const emitResult = program.emit();
+
+            // **Collect Diagnostics**
+            const allDiagnostics = ts
+                .getPreEmitDiagnostics(program)
+                .concat(emitResult.diagnostics);
+            if (allDiagnostics.length > 0) {
+                allDiagnostics.forEach((diagnostic) => {
+                    const message = ts.flattenDiagnosticMessageText(
+                        diagnostic.messageText,
+                        "\n",
+                    );
+                    this.logError(`TypeScript Error: ${message}`);
+                });
+                throw new Error(
+                    "TypeScript compilation failed due to errors.",
+                );
+            }
+
+            this.logInfo("TypeScript compilation completed successfully.");
+        } catch (error: any) {
+            this.logError("Error during TypeScript compilation:", error);
+            throw new Error(`TypeScript compilation failed: ${error.message}`);
+        }
+    }
+
+    /**
+     * Loads and parses `tsconfig.json` properly before passing it to the compiler.
+     *
+     * @param tsconfigPath - The path to the tsconfig.json file.
+     * @returns Parsed TypeScript compiler options and source files.
+     */
+    private loadAndParseTsConfig(tsconfigPath: string): ts.ParsedCommandLine {
+        // **Read and Parse tsconfig.json**
+        const configFile = ts.readConfigFile(tsconfigPath, ts.sys.readFile);
+
+        if (configFile.error) {
+            throw new Error(
+                `Error reading tsconfig.json: ${ts.flattenDiagnosticMessageText(configFile.error.messageText, "\n")}`,
+            );
+        }
+
+        // **Parse the configuration content**
+        const parsedConfig = ts.parseJsonConfigFileContent(
+            configFile.config,
+            ts.sys,
+            path.dirname(tsconfigPath),
+        );
+
+        if (parsedConfig.errors.length > 0) {
+            throw new Error(
+                `Error parsing tsconfig.json: ${parsedConfig.errors
+                    .map((diag) =>
+                        ts.flattenDiagnosticMessageText(
+                            diag.messageText,
+                            "\n",
+                        ),
+                    )
+                    .join("\n")}`,
+            );
+        }
+
+        return parsedConfig;
+    }
+
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe(): string {
+        return "Compiles TypeScript files using a given tsconfig.json configuration.";
+    }
+}

package/ts/actions/TypeScriptCompilerAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { TypeScriptCompilerAction } from "./TypeScriptCompilerAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export { TypeScriptCompilerAction };

package/ts/actions/VersionWriteAction/VersionWriteAction.ts

@@ -0,0 +1,174 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { promises as fs } from "fs";
+import path from "path";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types";
+
+// ============================================================================
+// Classes
+// ============================================================================
+
+/**
+ * VersionWriteAction is a step action responsible for replacing a version
+ * string in one or more specified files. The version is located and replaced
+ * based on a specified key and pattern.
+ */
+export class VersionWriteAction extends Action {
+    // Methods
+    // ========================================================================
+
+    /**
+     * Executes the version writing action.
+     * @param options - The options specific to version writing, including the
+     * files, key, and version string or a flag to retrieve it from
+     * `package.json`.
+     * @returns A Promise that resolves when the version has been successfully
+     * replaced in all specified files, or rejects with an error if the
+     * action fails.
+     */
+    async execute(options: ActionOptionsType): Promise<void> {
+        const files = options.files as
+            | { path: string; key?: string }[]
+            | undefined;
+        let version = options.version as string | undefined;
+
+        if (!files) {
+            throw new Error(`Missing required option: files.`);
+        }
+
+        // Retrieve version from package.json if not explicitly provided
+        if (!version) {
+            version = await this.getVersionFromPackageJson();
+            if (!version) {
+                throw new Error(
+                    `Version is not provided in options and could not be retrieved from package.json.`,
+                );
+            }
+        }
+
+        this.logInfo(`Replacing version "${version}" in specified files.`);
+
+        try {
+            // Replace the version in each file
+            await Promise.all(
+                files.map(({ path: filePath, key }) =>
+                    this.replaceVersionInFile(
+                        filePath,
+                        version!,
+                        key || "version:",
+                    ),
+                ),
+            );
+            this.logInfo(
+                `Version "${version}" replaced successfully in all specified files.`,
+            );
+        } catch (error) {
+            this.logError(
+                `Failed to replace version in one or more files.`,
+                error,
+            );
+            throw error;
+        }
+    }
+
+    /**
+     * Retrieves the version string from the `package.json` file.
+     * @returns A promise that resolves to the version string or `undefined`
+     * if not found.
+     * @throws {Error} Throws an error if `package.json` cannot be read.
+     */
+    private async getVersionFromPackageJson(): Promise<string | undefined> {
+        try {
+            const packageJsonPath = path.resolve(
+                process.cwd(),
+                "package.json",
+            );
+            const packageJsonContent = await fs.readFile(
+                packageJsonPath,
+                "utf8",
+            );
+            const packageJson = JSON.parse(packageJsonContent);
+            const version = packageJson.version;
+
+            if (version && /^\d+\.\d+\.\d+$/.test(version)) {
+                this.logInfo(
+                    `Version "${version}" retrieved from package.json.`,
+                );
+                return version;
+            } else {
+                this.logWarn(`Invalid or missing version in package.json.`);
+                return undefined;
+            }
+        } catch (error) {
+            this.logError(
+                `Error reading package.json for version retrieval.`,
+                error,
+            );
+            return undefined;
+        }
+    }
+
+    /**
+     * Replaces a version string in a file for a specific key.
+     * This method reads the file, replaces the version for the key, and
+     * writes the updated content back to the file.
+     *
+     * @param filePath - The file path where the version should be replaced.
+     * @param version - The new version string to replace in the file.
+     * @param key - The key prefix that identifies the version line (e.g.,
+     * `version:`).
+     * @returns A promise that resolves when the version has been successfully
+     * replaced.
+     * @throws {Error} Throws an error if reading or writing the file fails.
+     */
+    private async replaceVersionInFile(
+        filePath: string,
+        version: string,
+        key: string,
+    ): Promise<void> {
+        try {
+            const content = await fs.readFile(filePath, "utf8");
+            const lines = content.split("\n");
+
+            const updatedLines = lines.map((line) => {
+                const regex = new RegExp(`^\\s*${key}\\s*\\d+\\.\\d+\\.\\d+`);
+                if (regex.test(line)) {
+                    return line.replace(/\d+\.\d+\.\d+$/, version);
+                }
+                return line;
+            });
+
+            await fs.writeFile(filePath, updatedLines.join("\n"), "utf8");
+            this.logInfo(
+                `Version replaced in file "${filePath}" for key "${key}".`,
+            );
+        } catch (error) {
+            throw new Error(
+                `Error replacing version in file "${filePath}":
+                ${(error as Error).message}`,
+            );
+        }
+    }
+
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string {
+        let description = `
+            Replaces a version string in one or more specified files based on
+            a key and pattern. Can retrieve the version from package.json or
+            set it manually.
+            `;
+        return description;
+    }
+}
+
+// ============================================================================
+// Export
+// ============================================================================
+
+// export default VersionWriteAction;

package/ts/actions/VersionWriteAction/index.ts

@@ -0,0 +1,11 @@
+// ============================================================================
+// Import
+// ============================================================================
+
+import { VersionWriteAction } from "./VersionWriteAction";
+
+// ============================================================================
+// Export
+// ============================================================================
+
+export { VersionWriteAction };