kist 0.0.0 → 0.1.30

package/js/actions/PackageManagerAction/PackageManagerAction.js

@@ -0,0 +1,161 @@
+"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.PackageManagerAction = void 0;
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const Action_1 = require("../../core/pipeline/Action");
+const package_config_js_1 = __importDefault(require("./package.config.js"));
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * PackageManagerAction handles reading, validating, and creating `package.json`
+ * files, supporting custom configurations and merging with selected fields.
+ */
+class PackageManagerAction extends Action_1.Action {
+    /**
+     * Executes the package management action.
+     * Reads an existing `package.json`, extracts selected fields, and writes a new one.
+     *
+     * @param options - Options specifying input path, output directory, and fields to export.
+     * @returns A Promise that resolves when the action is completed successfully.
+     * @throws {Error} Throws an error if neither `packageJsonPath` nor `outputDir` is provided.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { packageJsonPath, outputDir, fields = [], // Specify which fields to copy
+            customConfig = {}, } = options;
+            if (!packageJsonPath) {
+                throw new Error("The 'packageJsonPath' option is required.");
+            }
+            if (!outputDir) {
+                throw new Error("The 'outputDir' option is required.");
+            }
+            const existingConfig = yield this.readPackageJson(packageJsonPath);
+            const filteredConfig = this.filterFields(existingConfig, fields);
+            yield this.createPackageJson(outputDir, filteredConfig, customConfig);
+        });
+    }
+    /**
+     * Reads and parses an existing `package.json`.
+     *
+     * @param packageJsonPath - Path to the `package.json` file.
+     * @returns Parsed JSON object.
+     * @throws {Error} If the file does not exist or contains invalid JSON.
+     */
+    readPackageJson(packageJsonPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fullPath = path_1.default.resolve(packageJsonPath);
+            try {
+                const fileContent = yield promises_1.default.readFile(fullPath, "utf-8");
+                const parsedContent = JSON.parse(fileContent);
+                this.logInfo(`Successfully read package.json from ${fullPath}`);
+                return parsedContent;
+            }
+            catch (error) {
+                if (error.code === "ENOENT") {
+                    throw new Error(`File not found at ${fullPath}. Please ensure the path is correct.`);
+                }
+                else if (error.name === "SyntaxError") {
+                    throw new Error(`Invalid JSON in ${fullPath}: ${error.message}`);
+                }
+                else {
+                    throw new Error(`Unexpected error while reading ${fullPath}: ${error.message}`);
+                }
+            }
+        });
+    }
+    /**
+     * Filters specified fields from a `package.json` object.
+     *
+     * @param config - The original package.json object.
+     * @param fields - List of fields to extract.
+     * @returns A new object containing only the selected fields.
+     */
+    filterFields(config, fields) {
+        if (!fields.length) {
+            return config; // If no fields are specified, return the full config.
+        }
+        const filteredConfig = {};
+        for (const field of fields) {
+            if (config[field] !== undefined) {
+                filteredConfig[field] = config[field];
+            }
+        }
+        this.logInfo(`Filtered package.json fields: ${JSON.stringify(filteredConfig, null, 2)}`);
+        return filteredConfig;
+    }
+    /**
+     * Creates a `package.json` file with selected fields and custom overrides.
+     *
+     * @param outputDir - Directory where the new `package.json` will be created.
+     * @param filteredConfig - The filtered package.json fields.
+     * @param customConfig - Custom overrides to apply.
+     * @returns A Promise that resolves when the file has been successfully created.
+     * @throws {Error} If the file cannot be written.
+     */
+    createPackageJson(outputDir, filteredConfig, customConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const filePath = path_1.default.join(outputDir, "package.json");
+            // Merge default settings with filtered config and custom overrides
+            const finalConfig = Object.assign(Object.assign(Object.assign({}, package_config_js_1.default), filteredConfig), customConfig);
+            const data = JSON.stringify(finalConfig, null, 2);
+            try {
+                yield this.ensureDirectoryExists(outputDir);
+                yield promises_1.default.writeFile(filePath, data, "utf-8");
+                this.logInfo(`package.json successfully created at ${filePath}`);
+            }
+            catch (error) {
+                this.logError("Error creating package.json", error);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Ensures that the specified directory exists, creating it if it does not.
+     *
+     * @param dirPath - The path of the directory to verify or create.
+     * @returns A Promise that resolves once the directory is verified or created.
+     * @throws {Error} If the directory cannot be created.
+     */
+    ensureDirectoryExists(dirPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield promises_1.default.mkdir(dirPath, { recursive: true });
+            }
+            catch (error) {
+                if (error.code !== "EEXIST") {
+                    throw error;
+                }
+            }
+        });
+    }
+    /**
+     * Provides a description of the action.
+     *
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Reads an existing package.json, extracts selected fields, and creates a new one.";
+    }
+}
+exports.PackageManagerAction = PackageManagerAction;
+// ============================================================================
+// Export
+// ============================================================================
+// export default PackageManagerAction;

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

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

package/js/actions/PackageManagerAction/index.js

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

package/js/actions/PackageManagerAction/package.config.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Configuration object for package.json properties, used to define metadata,
+ * file inclusions, and other necessary project configurations.
+ */
+declare const packageConfig: {
+    name: string;
+    version: string;
+    description: string;
+    keywords: string;
+    license: string;
+    homepage: string;
+    main: string;
+    types: string;
+    files: string[];
+};
+export default packageConfig;

package/js/actions/PackageManagerAction/package.config.js

@@ -0,0 +1,91 @@
+"use strict";
+// ============================================================================
+// Constants
+// ============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Configuration object for package.json properties, used to define metadata,
+ * file inclusions, and other necessary project configurations.
+ */
+const packageConfig = {
+    name: "example-project",
+    version: "0.1.0",
+    description: "",
+    keywords: "",
+    license: "MIT",
+    homepage: "https://www.example.com",
+    // funding: [
+    //     {
+    //         "type": "github",
+    //         "url": "https://github.com/sponsors/scape-foundation"
+    //     }
+    // ],
+    // type: "module",
+    // main: "js/index",
+    main: "js/index.js",
+    // types: "js/index",
+    types: "js/index.d.ts",
+    // "module": "dist/js/unit.gl.js",
+    // "style": "dist/css/unit.gl.css",
+    // "sass": "src/scss/index.scss",
+    // main: 'index.js',
+    files: [
+        "code-snippets/**/*.code-snippets",
+        "css/**/*.{css,map}",
+        "font/**/*.{eot,otf,ttf,woff,woff2}",
+        "inkscape/**/*.inkscape",
+        "jinja/**/*.jinja",
+        "js/**/*.d.ts",
+        "js/**/*.{js,map}",
+        "less/**/*.less",
+        "md/**/*.md",
+        "oco/**/*.oco",
+        "png/**/*.png",
+        "py/**/*.py",
+        "rcpx/**/*.rcpx",
+        "scss/**/*.scss",
+        "sketchpalette/**/*.sketchpalette",
+        "styl/**/*.styl",
+        "svg/**/*.svg",
+        "tex/**/*.tex",
+        "ts/**/*.ts",
+        "!.DS_Store",
+    ],
+    // exports: {
+    //     ".": {
+    //         // "sass": "./src/scss/index.scss",
+    //         // "import": "./dist/js/index.mjs",
+    //         // "default": "./dist/js/index.js"
+    //         "sass": "./scss/index.scss",
+    //         "scss": "./scss/index.scss",
+    //         "typescript": "./ts/index.ts",
+    //         "default": "./js/index.js"
+    //     }
+    // }
+    // repository: {
+    //     type: pack.repository.type,
+    //     url: pack.repository.url,
+    // },
+    // author?: string | {
+    //     name: string;
+    //     email?: string;
+    //     url?: string;
+    // };
+    // bugs?: {
+    //     url?: string;
+    //     email?: string;
+    // };
+    // contributors?: Array<string | {
+    //     name: string;
+    //     email?: string;
+    //     url?: string;
+    // }>;
+    // funding?: string | {
+    //     type: string;
+    //     url: string;
+    // };
+};
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = packageConfig;

package/js/actions/StyleProcessingAction/StyleProcessingAction.d.ts

@@ -0,0 +1,34 @@
+import { Action } from "../../core/pipeline/Action.js";
+import { ActionOptionsType } from "../../types/ActionOptionsType.js";
+/**
+ * StyleProcessingAction is a step action responsible for processing styles,
+ * including compiling SCSS and applying PostCSS transformations. It supports
+ * expanded and compressed output styles based on the provided configuration.
+ */
+export declare class StyleProcessingAction extends Action {
+    /**
+     * Executes the style processing action.
+     * @param options - The options specific to style processing, including
+     * input/output file paths and style format.
+     * @returns A Promise that resolves when the styles are processed
+     * successfully, or rejects with an error if the action fails.
+     */
+    execute(options: ActionOptionsType): Promise<void>;
+    /**
+     * Processes the given CSS with PostCSS based on the provided style option.
+     * @param css - The CSS string to process.
+     * @param styleOption - The style option, either "expanded" or "compressed".
+     * @returns Processed CSS string.
+     */
+    private processPostCSS;
+    /**
+     * Ensures that the given directory exists, creating it if it does not.
+     * @param dirPath - The path of the directory to check and create.
+     */
+    private ensureDirectoryExists;
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe(): string;
+}

package/js/actions/StyleProcessingAction/StyleProcessingAction.js

@@ -0,0 +1,164 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StyleProcessingAction = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const postcss_1 = __importDefault(require("postcss"));
+const sass = __importStar(require("sass"));
+const Action_js_1 = require("../../core/pipeline/Action.js");
+// Assuming the PostCSS configurations are available at the given paths
+const postcss_config_compressed_js_1 = __importDefault(require("./postcss.config.compressed.js"));
+const postcss_config_expanded_js_1 = __importDefault(require("./postcss.config.expanded.js"));
+// ============================================================================
+// Classes
+// ============================================================================
+/**
+ * StyleProcessingAction is a step action responsible for processing styles,
+ * including compiling SCSS and applying PostCSS transformations. It supports
+ * expanded and compressed output styles based on the provided configuration.
+ */
+class StyleProcessingAction extends Action_js_1.Action {
+    // Parameters
+    // ========================================================================
+    // Constructor
+    // ========================================================================
+    // Methods
+    // ========================================================================
+    /**
+     * Executes the style processing action.
+     * @param options - The options specific to style processing, including
+     * input/output file paths and style format.
+     * @returns A Promise that resolves when the styles are processed
+     * successfully, or rejects with an error if the action fails.
+     */
+    execute(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const inputFile = options.inputFile;
+            const outputFile = options.outputFile;
+            const styleOption = options.styleOption;
+            if (!inputFile || !outputFile || !styleOption) {
+                throw new Error("Missing required options: inputFile, outputFile, or styleOption.");
+            }
+            this.logInfo(`Processing styles from ${inputFile} to ${outputFile} with ${styleOption} style.`);
+            try {
+                // Ensure the output directory exists
+                const outputDir = path_1.default.dirname(outputFile);
+                yield this.ensureDirectoryExists(outputDir);
+                // Compile SCSS to CSS
+                const result = yield sass.compileAsync(inputFile, {
+                    style: styleOption,
+                    importers: [new sass.NodePackageImporter()],
+                });
+                // Process the compiled CSS with PostCSS
+                const processedCss = yield this.processPostCSS(result.css, styleOption);
+                // Write the processed CSS to a file
+                yield fs_1.promises.writeFile(outputFile, processedCss, "utf-8");
+                this.logInfo(`Styles processed successfully from ${inputFile} to ${outputFile}.`);
+            }
+            catch (error) {
+                this.logError(`Error processing styles from ${inputFile}: ${error}`);
+                throw error;
+            }
+        });
+    }
+    /**
+     * Processes the given CSS with PostCSS based on the provided style option.
+     * @param css - The CSS string to process.
+     * @param styleOption - The style option, either "expanded" or "compressed".
+     * @returns Processed CSS string.
+     */
+    processPostCSS(css, styleOption) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const config = styleOption === "expanded"
+                ? postcss_config_expanded_js_1.default
+                : postcss_config_compressed_js_1.default;
+            const result = yield (0, postcss_1.default)(config.plugins).process(css, {
+                from: undefined,
+                map: { inline: false },
+            });
+            return result.css;
+        });
+    }
+    /**
+     * Ensures that the given directory exists, creating it if it does not.
+     * @param dirPath - The path of the directory to check and create.
+     */
+    ensureDirectoryExists(dirPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield fs_1.promises.mkdir(dirPath, { recursive: true });
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    const nodeError = error;
+                    if (nodeError.code !== "EEXIST") {
+                        throw nodeError;
+                    }
+                }
+                else {
+                    throw error;
+                }
+            }
+        });
+    }
+    /**
+     * Provides a description of the action.
+     * @returns A string description of the action.
+     */
+    describe() {
+        return "Processes SCSS files into CSS, applying PostCSS transformations for expanded or compressed outputs.";
+    }
+}
+exports.StyleProcessingAction = StyleProcessingAction;
+// ============================================================================
+// Export
+// ============================================================================
+// export default StyleProcessingAction;

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

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

package/js/actions/StyleProcessingAction/index.js

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

package/js/actions/StyleProcessingAction/postcss.config.compressed.d.ts

@@ -0,0 +1,10 @@
+import autoprefixer from "autoprefixer";
+/**
+ * Configuration object for PostCSS that includes plugins for optimization and compression
+ * of CSS. This setup is typically used for production builds where minimized CSS is preferred
+ * to reduce file size and improve loading times.
+ */
+declare const postcssConfigCompressed: {
+    plugins: (typeof autoprefixer | import("postcss").Processor)[];
+};
+export default postcssConfigCompressed;

package/js/actions/StyleProcessingAction/postcss.config.compressed.js

@@ -0,0 +1,31 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const autoprefixer_1 = __importDefault(require("autoprefixer")); // Handles CSS vendor prefixing automatically
+const cssnano_1 = __importDefault(require("cssnano")); // A PostCSS plugin for CSS minimization
+// ============================================================================
+// Constants
+// ============================================================================
+/**
+ * Configuration object for PostCSS that includes plugins for optimization and compression
+ * of CSS. This setup is typically used for production builds where minimized CSS is preferred
+ * to reduce file size and improve loading times.
+ */
+const postcssConfigCompressed = {
+    plugins: [
+        autoprefixer_1.default, // Automatically adds vendor prefixes to CSS rules
+        (0, cssnano_1.default)({
+            // Compresses CSS output
+            preset: "default", // Uses the default settings for compression
+        }),
+    ],
+};
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = postcssConfigCompressed;

package/js/actions/StyleProcessingAction/postcss.config.expanded.d.ts

@@ -0,0 +1,16 @@
+import autoprefixer from "autoprefixer";
+/**
+ * Configuration object for PostCSS that focuses on generating expanded, readable CSS
+ * for development environments. Includes plugins that enhance CSS handling like nesting,
+ * variable support, and import inlining, alongside autoprefixer for browser compatibility.
+ */
+declare const postcssConfigExpanded: {
+    plugins: (typeof autoprefixer)[];
+};
+export default postcssConfigExpanded;
+/**
+ * Note: This configuration is intended for development use where extended readability
+ * and ease of debugging are critical. The cssnano plugin is commented out by default
+ * to keep the output CSS as clean and readable as possible; it can be enabled for
+ * environments that require slightly more optimized output without full minification.
+ */

package/js/actions/StyleProcessingAction/postcss.config.expanded.js

@@ -0,0 +1,45 @@
+"use strict";
+// ============================================================================
+// Import
+// ============================================================================
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const autoprefixer_1 = __importDefault(require("autoprefixer")); // Automatically adds vendor prefixes to CSS rules
+// import postcssSimpleVars from 'postcss-simple-vars'; // Plugin to handle CSS variables
+// import postcssNested from 'postcss-nested'; // Plugin to allow nesting of CSS rules
+// import postcssImport from 'postcss-import'; // Plugin to inline import CSS files into a single CSS
+// ============================================================================
+// Constants
+// ============================================================================
+/**
+ * Configuration object for PostCSS that focuses on generating expanded, readable CSS
+ * for development environments. Includes plugins that enhance CSS handling like nesting,
+ * variable support, and import inlining, alongside autoprefixer for browser compatibility.
+ */
+const postcssConfigExpanded = {
+    plugins: [
+        autoprefixer_1.default,
+        // Include other plugins suited for the expanded output
+    ],
+    // plugins: [
+    //     postcssImport(),  // Allows importing of other CSS files within a CSS file
+    //     autoprefixer(),   // Adds vendor prefixes to CSS, using data from Can I Use
+    //     postcssSimpleVars(), // Enables the use of Sass-like variables in CSS
+    //     postcssNested(),  // Process nested rules, which is similar to how Sass handles nesting
+    //     // cssnano({
+    //     //     preset: 'default', // Optionally include for light compression or reformatting
+    //     // }),
+    // ]
+};
+// ============================================================================
+// Export
+// ============================================================================
+exports.default = postcssConfigExpanded;
+/**
+ * Note: This configuration is intended for development use where extended readability
+ * and ease of debugging are critical. The cssnano plugin is commented out by default
+ * to keep the output CSS as clean and readable as possible; it can be enabled for
+ * environments that require slightly more optimized output without full minification.
+ */