kist 0.0.0 → 0.1.30

package/js/actions/SvgSpriteAction/svgsprite.config.js

@@ -0,0 +1,117 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+// ============================================================================
+// Constants
+// ============================================================================
+const svgspriteConfig = {
+    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
+// ============================================================================
+exports.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/js/actions/SvgToPngAction/SvgToPngAction.d.ts

@@ -0,0 +1,28 @@
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+/**
+ * SvgToPngAction converts SVG content to PNG format.
+ * Uses `sharp` for conversion and `jsdom` for SVG element manipulation.
+ */
+export declare class SvgToPngAction extends Action {
+    /**
+     * Executes the SVG-to-PNG conversion process.
+     * @param options - Options including SVG content, output path, width,
+     * and height.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * 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 convert;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}
+export default SvgToPngAction;

package/js/actions/SvgToPngAction/SvgToPngAction.js

@@ -0,0 +1,108 @@
+"use strict";
+// ============================================================================
+// Imports
+// ============================================================================
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SvgToPngAction = void 0;
+const fs_1 = __importDefault(require("fs"));
+const jsdom_1 = require("jsdom");
+const path_1 = __importDefault(require("path"));
+const sharp_1 = __importDefault(require("sharp"));
+const Action_1 = require("../../core/pipeline/Action");
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * SvgToPngAction converts SVG content to PNG format.
+ * Uses `sharp` for conversion and `jsdom` for SVG element manipulation.
+ */
+class SvgToPngAction extends Action_1.Action {
+    // Methods
+    // ========================================================================
+    /**
+     * Executes the SVG-to-PNG conversion process.
+     * @param options - Options including SVG content, output path, width,
+     * and height.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 {
+                yield 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.
+     */
+    convert(svgContent, outputPath, width, height) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // Ensure the output directory exists
+                const outputDir = path_1.default.dirname(outputPath);
+                if (!fs_1.default.existsSync(outputDir)) {
+                    fs_1.default.mkdirSync(outputDir, { recursive: true });
+                }
+                // Create a JSDOM instance to parse the SVG
+                const dom = new jsdom_1.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 = yield (0, sharp_1.default)(Buffer.from(updatedSvgContent))
+                    .png()
+                    .toBuffer();
+                yield (0, sharp_1.default)(pngBuffer).toFile(outputPath);
+            }
+            catch (error) {
+                throw new Error(`Error converting SVG to PNG: ${error.message}`);
+            }
+        });
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Converts SVG content to PNG format with optional resizing.";
+    }
+}
+exports.SvgToPngAction = SvgToPngAction;
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = SvgToPngAction;

package/js/actions/SvgToPngAction/index.d.ts

@@ -0,0 +1,2 @@
+import { SvgToPngAction } from "./SvgToPngAction";
+export { SvgToPngAction };

package/js/actions/SvgToPngAction/index.js

@@ -0,0 +1,8 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SvgToPngAction = void 0;
+const SvgToPngAction_1 = require("./SvgToPngAction");
+Object.defineProperty(exports, "SvgToPngAction", { enumerable: true, get: function () { return SvgToPngAction_1.SvgToPngAction; } });

package/js/actions/TypeScriptCompilerAction/TypeScriptCompilerAction.d.ts

@@ -0,0 +1,28 @@
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+/**
+ * TypeScriptCompilerAction compiles TypeScript files into JavaScript.
+ */
+export declare 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.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * 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;
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}

package/js/actions/TypeScriptCompilerAction/TypeScriptCompilerAction.js

@@ -0,0 +1,96 @@
+"use strict";
+// ============================================================================
+// Imports
+// ============================================================================
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeScriptCompilerAction = void 0;
+const path_1 = __importDefault(require("path"));
+const typescript_1 = __importDefault(require("typescript"));
+const Action_1 = require("../../core/pipeline/Action");
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * TypeScriptCompilerAction compiles TypeScript files into JavaScript.
+ */
+class TypeScriptCompilerAction extends Action_1.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.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { tsconfigPath = "tsconfig.json" } = options;
+            const resolvedTsconfigPath = path_1.default.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 = typescript_1.default.createProgram(parsedConfig.fileNames, parsedConfig.options);
+                const emitResult = program.emit();
+                // **Collect Diagnostics**
+                const allDiagnostics = typescript_1.default
+                    .getPreEmitDiagnostics(program)
+                    .concat(emitResult.diagnostics);
+                if (allDiagnostics.length > 0) {
+                    allDiagnostics.forEach((diagnostic) => {
+                        const message = typescript_1.default.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) {
+                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.
+     */
+    loadAndParseTsConfig(tsconfigPath) {
+        // **Read and Parse tsconfig.json**
+        const configFile = typescript_1.default.readConfigFile(tsconfigPath, typescript_1.default.sys.readFile);
+        if (configFile.error) {
+            throw new Error(`Error reading tsconfig.json: ${typescript_1.default.flattenDiagnosticMessageText(configFile.error.messageText, "\n")}`);
+        }
+        // **Parse the configuration content**
+        const parsedConfig = typescript_1.default.parseJsonConfigFileContent(configFile.config, typescript_1.default.sys, path_1.default.dirname(tsconfigPath));
+        if (parsedConfig.errors.length > 0) {
+            throw new Error(`Error parsing tsconfig.json: ${parsedConfig.errors
+                .map((diag) => typescript_1.default.flattenDiagnosticMessageText(diag.messageText, "\n"))
+                .join("\n")}`);
+        }
+        return parsedConfig;
+    }
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Compiles TypeScript files using a given tsconfig.json configuration.";
+    }
+}
+exports.TypeScriptCompilerAction = TypeScriptCompilerAction;

package/js/actions/TypeScriptCompilerAction/index.d.ts

@@ -0,0 +1,2 @@
+import { TypeScriptCompilerAction } from "./TypeScriptCompilerAction";
+export { TypeScriptCompilerAction };

package/js/actions/TypeScriptCompilerAction/index.js

@@ -0,0 +1,8 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeScriptCompilerAction = void 0;
+const TypeScriptCompilerAction_1 = require("./TypeScriptCompilerAction");
+Object.defineProperty(exports, "TypeScriptCompilerAction", { enumerable: true, get: function () { return TypeScriptCompilerAction_1.TypeScriptCompilerAction; } });

package/js/actions/VersionWriteAction/VersionWriteAction.d.ts

@@ -0,0 +1,45 @@
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types";
+/**
+ * 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 declare class VersionWriteAction extends Action {
+    /**
+     * 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.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * 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 getVersionFromPackageJson;
+    /**
+     * 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 replaceVersionInFile;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}

package/js/actions/VersionWriteAction/VersionWriteAction.js

@@ -0,0 +1,147 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionWriteAction = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const Action_1 = require("../../core/pipeline/Action");
+// ============================================================================
+// 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.
+ */
+class VersionWriteAction extends Action_1.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.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const files = options.files;
+            let version = options.version;
+            if (!files) {
+                throw new Error(`Missing required option: files.`);
+            }
+            // Retrieve version from package.json if not explicitly provided
+            if (!version) {
+                version = yield 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
+                yield 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.
+     */
+    getVersionFromPackageJson() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const packageJsonPath = path_1.default.resolve(process.cwd(), "package.json");
+                const packageJsonContent = yield fs_1.promises.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.
+     */
+    replaceVersionInFile(filePath, version, key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const content = yield fs_1.promises.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;
+                });
+                yield fs_1.promises.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.message}`);
+            }
+        });
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        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;
+    }
+}
+exports.VersionWriteAction = VersionWriteAction;
+// ============================================================================
+// Export
+// ============================================================================
+// export default VersionWriteAction;

package/js/actions/VersionWriteAction/index.d.ts

@@ -0,0 +1,2 @@
+import { VersionWriteAction } from "./VersionWriteAction";
+export { VersionWriteAction };

package/js/actions/VersionWriteAction/index.js

@@ -0,0 +1,8 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionWriteAction = void 0;
+const VersionWriteAction_1 = require("./VersionWriteAction");
+Object.defineProperty(exports, "VersionWriteAction", { enumerable: true, get: function () { return VersionWriteAction_1.VersionWriteAction; } });