kist 0.0.0 → 0.1.30

package/js/actions/SvgPackagerAction/SvgPackagerAction.d.ts

@@ -0,0 +1,68 @@
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+/**
+ * SvgPackagerAction is responsible for optimizing and packaging SVG files.
+ * It reads SVG files from a specified directory, optimizes them using SVGO,
+ * and then outputs them as TypeScript files and JSON indexes.
+ */
+export declare class SvgPackagerAction extends Action {
+    /**
+     * Executes the SVG processing action.
+     * @param options - The options specifying input and output directories.
+     * @returns A Promise that resolves when the action completes successfully.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * Reads the content of an SVG file.
+     * @param filePath The path to the SVG file.
+     * @returns The content of the SVG file.
+     */
+    private readSvgFile;
+    /**
+     * Sanitizes a file name to be a valid TypeScript identifier.
+     * @param fileName The original file name.
+     * @returns A sanitized version of the file name.
+     */
+    private sanitizeFileName;
+    /**
+     * Optimizes SVG content using SVGO.
+     * @param svgoConfigPath Path to the SVGO configuration file.
+     * @param svgContent The raw SVG content.
+     * @returns The optimized SVG content.
+     */
+    private optimizeSvg;
+    /**
+     * Writes optimized SVG content to files (SVG & TypeScript).
+     * @param iconName The name of the icon.
+     * @param svgContent The optimized SVG content.
+     * @param outputDirectory The directory for SVG output.
+     * @param tsOutputDirectory The directory for TypeScript output.
+     */
+    private writeFiles;
+    /**
+     * Writes the optimized SVG content to an output file.
+     * @param iconName The name of the icon.
+     * @param svgContent The SVG content to be written.
+     * @param outputDirectory The directory to output the SVG file.
+     */
+    private writeSvgFile;
+    /**
+     * Creates a TypeScript file from the optimized SVG content.
+     * @param iconName The name of the icon.
+     * @param svgContent The optimized SVG content.
+     * @param tsOutputDirectory The directory for TypeScript output.
+     */
+    private writeTypeScriptFile;
+    /**
+     * Writes a JSON file containing the names of processed icons.
+     * @param iconNames An array of processed icon names.
+     * @param jsonOutputDirectory The directory to output the JSON file.
+     */
+    private writeIconsJson;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}
+export default SvgPackagerAction;

package/js/actions/SvgPackagerAction/SvgPackagerAction.js

@@ -0,0 +1,186 @@
+"use strict";
+// ============================================================================
+// Imports
+// ============================================================================
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SvgPackagerAction = void 0;
+const fs = __importStar(require("fs/promises"));
+const glob = __importStar(require("glob"));
+const path = __importStar(require("path"));
+const svgo_1 = __importStar(require("svgo"));
+const Action_1 = require("../../core/pipeline/Action");
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * SvgPackagerAction is responsible for optimizing and packaging SVG files.
+ * It reads SVG files from a specified directory, optimizes them using SVGO,
+ * and then outputs them as TypeScript files and JSON indexes.
+ */
+class SvgPackagerAction extends Action_1.Action {
+    // Methods
+    // ========================================================================
+    /**
+     * Executes the SVG processing action.
+     * @param options - The options specifying input and output directories.
+     * @returns A Promise that resolves when the action completes successfully.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { svgoConfigPath = "./config/svgo.config.js", inputDirectory = "src/icons", outputDirectory = "dist/icons", tsOutputDirectory = "dist/ts", jsonOutputDirectory = "dist", } = options;
+            this.logInfo(`Processing SVG files from ${inputDirectory}...`);
+            const iconNames = [];
+            try {
+                const svgFiles = glob.sync(`${inputDirectory}/**/*.svg`);
+                for (const file of svgFiles) {
+                    const iconName = this.sanitizeFileName(path.basename(file, ".svg"));
+                    iconNames.push(iconName);
+                    const svgContent = yield this.readSvgFile(file);
+                    const optimizedSvg = yield this.optimizeSvg(svgoConfigPath, svgContent);
+                    yield this.writeFiles(iconName, optimizedSvg, outputDirectory, tsOutputDirectory);
+                }
+                yield this.writeIconsJson(iconNames, jsonOutputDirectory);
+                this.logInfo(`Successfully processed ${svgFiles.length} SVG files.`);
+            }
+            catch (error) {
+                this.logError("Error processing SVG files.", error);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Reads the content of an SVG file.
+     * @param filePath The path to the SVG file.
+     * @returns The content of the SVG file.
+     */
+    readSvgFile(filePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return fs.readFile(filePath, "utf8");
+        });
+    }
+    /**
+     * Sanitizes a file name to be a valid TypeScript identifier.
+     * @param fileName The original file name.
+     * @returns A sanitized version of the file name.
+     */
+    sanitizeFileName(fileName) {
+        return fileName.replace(/[^a-zA-Z0-9_]/g, "_");
+    }
+    /**
+     * Optimizes SVG content using SVGO.
+     * @param svgoConfigPath Path to the SVGO configuration file.
+     * @param svgContent The raw SVG content.
+     * @returns The optimized SVG content.
+     */
+    optimizeSvg(svgoConfigPath, svgContent) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const config = yield (0, svgo_1.loadConfig)(svgoConfigPath);
+            const result = yield svgo_1.default.optimize(svgContent, Object.assign({}, config));
+            return result.data.trim();
+        });
+    }
+    /**
+     * Writes optimized SVG content to files (SVG & TypeScript).
+     * @param iconName The name of the icon.
+     * @param svgContent The optimized SVG content.
+     * @param outputDirectory The directory for SVG output.
+     * @param tsOutputDirectory The directory for TypeScript output.
+     */
+    writeFiles(iconName, svgContent, outputDirectory, tsOutputDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.writeSvgFile(iconName, svgContent, outputDirectory);
+            yield this.writeTypeScriptFile(iconName, svgContent, tsOutputDirectory);
+        });
+    }
+    /**
+     * Writes the optimized SVG content to an output file.
+     * @param iconName The name of the icon.
+     * @param svgContent The SVG content to be written.
+     * @param outputDirectory The directory to output the SVG file.
+     */
+    writeSvgFile(iconName, svgContent, outputDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const outputPath = path.join(outputDirectory, `${iconName}.svg`);
+            yield fs.writeFile(outputPath, svgContent);
+        });
+    }
+    /**
+     * Creates a TypeScript file from the optimized SVG content.
+     * @param iconName The name of the icon.
+     * @param svgContent The optimized SVG content.
+     * @param tsOutputDirectory The directory for TypeScript output.
+     */
+    writeTypeScriptFile(iconName, svgContent, tsOutputDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tsContent = `export const icon_${iconName} = \`${svgContent}\`;\n`;
+            const outputPath = path.join(tsOutputDirectory, `${iconName}.ts`);
+            yield fs.writeFile(outputPath, tsContent);
+        });
+    }
+    /**
+     * Writes a JSON file containing the names of processed icons.
+     * @param iconNames An array of processed icon names.
+     * @param jsonOutputDirectory The directory to output the JSON file.
+     */
+    writeIconsJson(iconNames, jsonOutputDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const jsonContent = JSON.stringify(iconNames, null, 2);
+            const outputPath = path.join(jsonOutputDirectory, "icons.json");
+            yield fs.writeFile(outputPath, jsonContent);
+        });
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Optimizes and packages SVG files into multiple formats (SVG, TypeScript, JSON).";
+    }
+}
+exports.SvgPackagerAction = SvgPackagerAction;
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = SvgPackagerAction;

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

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

package/js/actions/SvgPackagerAction/index.js

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

package/js/actions/SvgReaderAction/SvgReaderAction.d.ts

@@ -0,0 +1,32 @@
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+/**
+ * SvgReaderAction is responsible for reading SVG file contents and
+ * making them available for further processing in the pipeline.
+ */
+export declare class SvgReaderAction extends Action {
+    private svgContent;
+    /**
+     * Executes the SVG reading action.
+     * @param options - The options specifying the SVG file path.
+     * @returns A Promise that resolves when the SVG file is successfully read.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * Reads the content of an SVG file asynchronously.
+     * @param filePath The path to the SVG file.
+     * @returns A promise that resolves to the SVG file content.
+     */
+    private readSvg;
+    /**
+     * Retrieves the last read SVG content.
+     * @returns The last read SVG content.
+     */
+    getSvgContent(): string;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}
+export default SvgReaderAction;

package/js/actions/SvgReaderAction/SvgReaderAction.js

@@ -0,0 +1,87 @@
+"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.SvgReaderAction = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const Action_1 = require("../../core/pipeline/Action");
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * SvgReaderAction is responsible for reading SVG file contents and
+ * making them available for further processing in the pipeline.
+ */
+class SvgReaderAction extends Action_1.Action {
+    constructor() {
+        super(...arguments);
+        this.svgContent = "";
+    }
+    // Methods
+    // ========================================================================
+    /**
+     * Executes the SVG reading action.
+     * @param options - The options specifying the SVG file path.
+     * @returns A Promise that resolves when the SVG file is successfully read.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { filePath } = options;
+            if (!filePath) {
+                throw new Error("Missing required option: 'filePath'.");
+            }
+            this.logInfo(`Reading SVG file: ${filePath}`);
+            try {
+                this.svgContent = yield this.readSvg(filePath);
+                this.logInfo(`Successfully read SVG file: ${filePath}`);
+            }
+            catch (error) {
+                this.logError(`Error reading SVG file: ${filePath}`, error);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Reads the content of an SVG file asynchronously.
+     * @param filePath The path to the SVG file.
+     * @returns A promise that resolves to the SVG file content.
+     */
+    readSvg(filePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return fs_1.promises.readFile(path_1.default.resolve(filePath), "utf-8");
+        });
+    }
+    /**
+     * Retrieves the last read SVG content.
+     * @returns The last read SVG content.
+     */
+    getSvgContent() {
+        return this.svgContent;
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Reads an SVG file and stores its content for further processing.";
+    }
+}
+exports.SvgReaderAction = SvgReaderAction;
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = SvgReaderAction;

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

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

package/js/actions/SvgReaderAction/index.js

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

package/js/actions/SvgSpriteAction/SvgSpriteAction.d.ts

@@ -0,0 +1,37 @@
+import svgSprite from "svg-sprite";
+import { Action } from "../../core/pipeline/Action";
+import { ActionOptionsType } from "../../types/ActionOptionsType";
+/**
+ * SvgSpriteAction compiles multiple SVG files into a single sprite sheet,
+ * making it more efficient to manage and use SVG assets in web applications.
+ */
+export declare class SvgSpriteAction extends Action {
+    private config;
+    /**
+     * Default configuration for SVG sprite generation.
+     */
+    private static defaultConfig;
+    /**
+     * Constructs an instance with merged default and custom configurations.
+     * @param {svgSprite.Config} customConfig - Optional custom configuration
+     * for svg-sprite.
+     */
+    constructor(customConfig?: svgSprite.Config);
+    /**
+     * Executes the SVG sprite generation process.
+     * @param options - Options including source directory and output directory.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * Generates an SVG sprite from all SVG files in the specified directory.
+     * @param sourceDir - Directory containing source SVG files.
+     * @param outputDir - Directory where the generated sprite will be saved.
+     */
+    private generateSprite;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}
+export default SvgSpriteAction;

package/js/actions/SvgSpriteAction/SvgSpriteAction.js

@@ -0,0 +1,114 @@
+"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.SvgSpriteAction = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const svg_sprite_1 = __importDefault(require("svg-sprite"));
+const Action_1 = require("../../core/pipeline/Action");
+const svgsprite_config_js_1 = __importDefault(require("./svgsprite.config.js"));
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * SvgSpriteAction compiles multiple SVG files into a single sprite sheet,
+ * making it more efficient to manage and use SVG assets in web applications.
+ */
+class SvgSpriteAction extends Action_1.Action {
+    // Constructor
+    // ========================================================================
+    /**
+     * Constructs an instance with merged default and custom configurations.
+     * @param {svgSprite.Config} customConfig - Optional custom configuration
+     * for svg-sprite.
+     */
+    constructor(customConfig = {}) {
+        super();
+        this.config = Object.assign(Object.assign({}, SvgSpriteAction.defaultConfig), customConfig);
+    }
+    // Methods
+    // ========================================================================
+    /**
+     * Executes the SVG sprite generation process.
+     * @param options - Options including source directory and output directory.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { sourceDir, outputDir } = options;
+            if (!sourceDir || !outputDir) {
+                throw new Error("Both 'sourceDir' and 'outputDir' must be specified.");
+            }
+            this.logInfo(`Generating SVG sprite from: ${sourceDir}`);
+            try {
+                yield this.generateSprite(sourceDir, outputDir);
+                this.logInfo(`SVG sprite successfully generated in: ${outputDir}`);
+            }
+            catch (error) {
+                this.logError("Error generating SVG sprite:", error);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Generates an SVG sprite from all SVG files in the specified directory.
+     * @param sourceDir - Directory containing source SVG files.
+     * @param outputDir - Directory where the generated sprite will be saved.
+     */
+    generateSprite(sourceDir, outputDir) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const files = fs_1.default.readdirSync(sourceDir);
+            const sprite = new svg_sprite_1.default(this.config);
+            for (const file of files) {
+                if (path_1.default.extname(file) === ".svg") {
+                    const svgPath = path_1.default.resolve(sourceDir, file);
+                    const content = fs_1.default.readFileSync(svgPath, "utf8");
+                    sprite.add(svgPath, null, content);
+                }
+            }
+            sprite.compile((error, result) => {
+                if (error) {
+                    throw error;
+                }
+                for (const mode in result) {
+                    for (const resource in result[mode]) {
+                        const outputPath = path_1.default.resolve(outputDir, result[mode][resource].path);
+                        fs_1.default.mkdirSync(path_1.default.dirname(outputPath), {
+                            recursive: true,
+                        });
+                        fs_1.default.writeFileSync(outputPath, result[mode][resource].contents);
+                    }
+                }
+            });
+        });
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Generates an SVG sprite from a directory of SVG files.";
+    }
+}
+exports.SvgSpriteAction = SvgSpriteAction;
+/**
+ * Default configuration for SVG sprite generation.
+ */
+SvgSpriteAction.defaultConfig = svgsprite_config_js_1.default;
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = SvgSpriteAction;

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

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

package/js/actions/SvgSpriteAction/index.js

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

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

@@ -0,0 +1,3 @@
+import svgSprite from "svg-sprite";
+declare const svgspriteConfig: svgSprite.Config;
+export default svgspriteConfig;