penguins-eggs 25.10.28 → 25.11.8

package/dist/classes/compressors.d.ts

@@ -0,0 +1,54 @@
+/**
+ * ./src/classes/compressors.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+export default class Compressors {
+    dest: string;
+    isEnabled: {
+        error: boolean;
+        gzip: boolean;
+        lz4: boolean;
+        lzma: boolean;
+        lzo: boolean;
+        xz: boolean;
+        zstd: boolean;
+    };
+    source: string;
+    /**
+     * fast compression
+     * @returns
+     */
+    fast(): string;
+    /**
+     * max
+     * @returns
+     */
+    max(): string;
+    pendrive(level?: string): string;
+    /**
+     * populate
+     */
+    populate(): Promise<void>;
+    /**
+     * standard
+     * @returns
+     */
+    standard(): string;
+    /**
+     * check mksquashfs exists
+     * @param compressor
+     * @returns
+     */
+    private check;
+    /**
+     * prepareCheck
+     */
+    private prepareCheck;
+    /**
+     * removeCheck
+     */
+    private removeCheck;
+}

package/dist/classes/compressors.js

@@ -0,0 +1,109 @@
+/**
+ * ./src/classes/compressors.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import shx from 'shelljs';
+export default class Compressors {
+    dest = '/tmp/eggs-mksquash-dest';
+    isEnabled = {
+        error: false,
+        gzip: true,
+        lz4: false,
+        lzma: false,
+        lzo: false,
+        xz: false,
+        zstd: false
+    };
+    source = '/tmp/eggs-mksquash-test';
+    /**
+     * fast compression
+     * @returns
+     */
+    fast() {
+        let comp = 'gzip';
+        if (this.isEnabled.zstd) {
+            comp = 'zstd -b 1M -Xcompression-level 3';
+        }
+        else if (this.isEnabled.lz4) {
+            comp = 'lz4';
+        }
+        return comp;
+    }
+    /**
+     * max
+     * @returns
+     */
+    max() {
+        let filter = 'x86';
+        if (process.arch === 'arm64') {
+            filter = 'arm';
+        }
+        const options = '-b 1M -no-duplicates -no-recovery -always-use-fragments';
+        if (process.arch === 'ia32') {
+            // options = '-b 1M'
+        }
+        const comp = `xz -Xbcj ${filter} ${options}`;
+        return comp;
+    }
+    pendrive(level = '15') {
+        let comp = 'gzip';
+        if (this.isEnabled.zstd) {
+            comp = `zstd -b 1M -Xcompression-level ${level}`;
+        }
+        else if (this.isEnabled.lz4) {
+            comp = 'lz4';
+        }
+        return comp;
+    }
+    /**
+     * populate
+     */
+    async populate() {
+        await this.prepareCheck();
+        this.isEnabled.error = await this.check('error');
+        this.isEnabled.lzma = await this.check('lzma');
+        this.isEnabled.lzo = await this.check('lzo');
+        this.isEnabled.lz4 = await this.check('lz4');
+        this.isEnabled.xz = await this.check('xz');
+        this.isEnabled.zstd = await this.check('zstd');
+        await this.removeCheck();
+    }
+    /**
+     * standard
+     * @returns
+     */
+    standard() {
+        const comp = 'xz -b 1M';
+        return comp;
+    }
+    /**
+     * check mksquashfs exists
+     * @param compressor
+     * @returns
+     */
+    async check(compressor) {
+        let result = false;
+        const { stderr } = shx.exec('mksquashfs ' + this.source + ' ' + this.dest + ' -comp ' + compressor + ' -no-xattrs -ef ' + this.dest, { silent: true });
+        if (stderr === '') {
+            result = true;
+        }
+        return result;
+    }
+    /**
+     * prepareCheck
+     */
+    async prepareCheck() {
+        shx.exec('rm -rf ' + this.source, { silent: true });
+        shx.exec('mkdir ' + this.source, { silent: true });
+    }
+    /**
+     * removeCheck
+     */
+    async removeCheck() {
+        shx.exec('rm -rf ' + this.source, { silent: true });
+        shx.exec('rm -f  ' + this.dest, { silent: true });
+    }
+}

package/dist/classes/daddy.d.ts

@@ -0,0 +1,44 @@
+/**
+ * ./src/classes/daddy.ts
+ * penguins-eggs v.25.7.x / ECMAScript 2020
+ * author: Piero Proietti (modified by Hossein Seilani)
+ * license: MIT
+ */
+import Settings from '../classes/settings.js';
+import { IEggsConfig } from '../interfaces/i-eggs-config.js';
+export default class Daddy {
+    settings: Settings;
+    /**
+     * [CHANGE 1] Modular, type-safe, interactive configuration editor
+     * This method asks the user for LiveCD parameters using inquirer and returns
+     * a fully typed IEggsConfig object. It replaces the older JSON.stringify/parse approach.
+     */
+    editConfig(config: IEggsConfig): Promise<IEggsConfig>;
+    /**
+     * [CHANGE 2] Central method to manage environment, configuration and save
+     * This method is modular, type-safe, and handles:
+     * - Pacman and distro templates check
+     * - Load, reset, or apply custom configuration
+     * - Save configuration to disk
+     * - Provide clear guidance to the user
+     */
+    helpMe(reset?: boolean, isCustom?: boolean, fileCustom?: string, verbose?: boolean): Promise<void>;
+    /**
+     * Check and install Pacman configuration and templates if missing
+     */
+    private checkPacman;
+    /**
+     * Apply reset or custom configuration
+     */
+    private applyResetOrCustomConfig;
+    /**
+     * Load and apply a custom YAML configuration
+     * [CHANGE 3] Async reading of file and type-safe parsing
+     */
+    private applyCustomYAML;
+    /**
+     * Display final guidance and tips to the user
+     * [CHANGE 4] Modular, clear, user-friendly messages
+     */
+    private displayFinalHelp;
+}

package/dist/classes/daddy.js

@@ -0,0 +1,208 @@
+/**
+ * ./src/classes/daddy.ts
+ * penguins-eggs v.25.7.x / ECMAScript 2020
+ * author: Piero Proietti (modified by Hossein Seilani)
+ * license: MIT
+ */
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import yaml from 'js-yaml';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { exec } from '../lib/utils.js';
+import Pacman from '../classes/pacman.js';
+import Settings from '../classes/settings.js';
+import Utils from '../classes/utils.js';
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+export default class Daddy {
+    settings = {};
+    /**
+     * [CHANGE 1] Modular, type-safe, interactive configuration editor
+     * This method asks the user for LiveCD parameters using inquirer and returns
+     * a fully typed IEggsConfig object. It replaces the older JSON.stringify/parse approach.
+     */
+    async editConfig(config) {
+        console.log(chalk.cyan('Edit and save Live system parameters\n'));
+        // Determine default compression option
+        let compressionOpt;
+        switch (config.compression) {
+            case 'xz':
+                compressionOpt = 1;
+                break;
+            case 'xz -Xbcj x86':
+                compressionOpt = 2;
+                break;
+            default:
+                compressionOpt = 0;
+                break;
+        }
+        // Provide a default snapshot prefix if empty
+        if (!config.snapshot_prefix) {
+            config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId);
+        }
+        /**
+         *     // Define type-safe inquirer questions
+         * const questions: inquirer.QuestionCollection<IEggsConfig> = [
+         */
+        const questions = [
+            {
+                type: 'input',
+                name: 'snapshot_prefix',
+                message: 'LiveCD iso prefix: ',
+                default: config.snapshot_prefix,
+            },
+            {
+                type: 'input',
+                name: 'snapshot_basename',
+                message: 'LiveCD iso basename: ',
+                default: config.snapshot_basename,
+            },
+            {
+                type: 'input',
+                name: 'user_opt',
+                message: 'LiveCD user:',
+                default: config.user_opt,
+            },
+            {
+                type: 'input',
+                name: 'user_opt_passwd',
+                message: 'LiveCD user password:',
+                default: config.user_opt_passwd,
+            },
+            {
+                type: 'input',
+                name: 'root_passwd',
+                message: 'LiveCD root password:',
+                default: config.root_passwd,
+            },
+            {
+                type: 'list',
+                name: 'compression',
+                message: 'LiveCD compression: ',
+                choices: ['fast', 'max'],
+                default: compressionOpt,
+            },
+        ];
+        try {
+            // Prompt the user and return the typed config object
+            const answers = await inquirer.prompt(questions);
+            return answers;
+        }
+        catch (err) {
+            console.error(chalk.red('Error editing configuration:'), err);
+            throw err;
+        }
+    }
+    /**
+     * [CHANGE 2] Central method to manage environment, configuration and save
+     * This method is modular, type-safe, and handles:
+     * - Pacman and distro templates check
+     * - Load, reset, or apply custom configuration
+     * - Save configuration to disk
+     * - Provide clear guidance to the user
+     */
+    async helpMe(reset = false, isCustom = false, fileCustom = '', verbose = false) {
+        try {
+            if (isCustom)
+                console.log('Using custom file:', fileCustom);
+            // Step 1: Check system prerequisites
+            await this.checkPacman(verbose);
+            // Step 2: Load settings
+            this.settings = new Settings();
+            const loaded = await this.settings.load();
+            let config = loaded ? this.settings.config : {};
+            // Step 3: Apply reset or custom configuration
+            if (reset || isCustom) {
+                await this.applyResetOrCustomConfig(config, isCustom, fileCustom);
+            }
+            else {
+                config = await this.editConfig(config);
+            }
+            // Step 4: Save final configuration
+            await this.settings.save(config);
+            // Step 5: Display help messages
+            this.displayFinalHelp();
+        }
+        catch (err) {
+            console.error(chalk.red('An error occurred in helpMe:'), err);
+        }
+    }
+    /**
+     * Check and install Pacman configuration and templates if missing
+     */
+    async checkPacman(verbose) {
+        if (!Pacman.configurationCheck()) {
+            console.log('- creating configuration directory...');
+            await Pacman.configurationInstall(verbose);
+        }
+        if (!Pacman.distroTemplateCheck()) {
+            console.log('- installing distro template...');
+            await Pacman.distroTemplateInstall(verbose);
+        }
+        if (!Pacman.calamaresExists() && Pacman.isInstalledGui() && Pacman.isCalamaresAvailable()) {
+            console.log('- GUI system detected, calamares is available but not installed.');
+        }
+    }
+    /**
+     * Apply reset or custom configuration
+     */
+    async applyResetOrCustomConfig(config, isCustom, fileCustom) {
+        // Reset snapshot prefix if empty
+        if (!config.snapshot_prefix) {
+            let fstype = '';
+            try {
+                const { data } = await exec(`findmnt -n -o FSTYPE /`, { capture: true });
+                fstype = data.trim() === 'ext4' ? '' : `${data.trim()}-`;
+            }
+            catch (err) {
+                console.warn('Unable to detect FSTYPE:', err);
+            }
+            config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId) + fstype;
+        }
+        // Apply custom YAML if needed
+        if (isCustom && fileCustom) {
+            await this.applyCustomYAML(config, fileCustom);
+        }
+    }
+    /**
+     * Load and apply a custom YAML configuration
+     * [CHANGE 3] Async reading of file and type-safe parsing
+     */
+    async applyCustomYAML(config, fileCustom) {
+        try {
+            const conf = await fs.readFile(fileCustom, 'utf8');
+            const confCustom = yaml.load(conf);
+            // Safely copy fields from YAML to config
+            config.snapshot_basename = confCustom.snapshot_basename ?? config.snapshot_basename;
+            config.snapshot_prefix = confCustom.snapshot_prefix ?? config.snapshot_prefix;
+            config.user_opt = confCustom.user_opt ?? config.user_opt;
+            config.user_opt_passwd = confCustom.user_opt_passwd ?? config.user_opt_passwd;
+            config.root_passwd = confCustom.root_passwd ?? config.root_passwd;
+            config.theme = confCustom.theme ?? config.theme;
+        }
+        catch (err) {
+            console.error(chalk.red('Failed to load custom YAML config:'), err);
+            throw err;
+        }
+    }
+    /**
+     * Display final guidance and tips to the user
+     * [CHANGE 4] Modular, clear, user-friendly messages
+     */
+    displayFinalHelp() {
+        console.log();
+        console.log(chalk.cyan('Your configuration was saved on: /etc/penguins-eggs.d'));
+        console.log(chalk.cyan('You can create a clean ISO with: ') + chalk.white('sudo eggs produce'));
+        console.log(chalk.cyan('Or a full personal clone: ') + chalk.white('sudo eggs produce --clone'));
+        console.log();
+        console.log(chalk.cyan('If you don’t have enough space to remaster, you can mount remote or local space:'));
+        console.log(chalk.cyan('- Create a hidden mountpoint under the nest:'));
+        console.log(chalk.white('sudo mkdir /home/eggs/.mnt -p'));
+        console.log(chalk.cyan('- Mount remote space:'));
+        console.log(chalk.white('sudo sshfs -o allow_other root@192.168.1.2:/zfs/iso /home/eggs/.mnt'));
+        console.log(chalk.cyan('- Or mount a local partition:'));
+        console.log(chalk.white('sudo mount /dev/sdx1 /home/eggs/.mnt'));
+        console.log();
+        console.log(chalk.cyan('More help? ') + chalk.white('eggs mom'));
+    }
+}

package/dist/classes/distro-hossein.d.ts

@@ -0,0 +1,52 @@
+/**
+ * penguins-eggs
+ * class: distro.ts
+ * author: Piero Proietti (modified by Hossein Seilani)
+ * license: MIT
+ *
+ * FINAL VERSION WITH EXPLAINED COMMENTS AND NEW CHANGE TAGS
+ */
+import { IDistro } from '../interfaces/index.js';
+declare class Distro implements IDistro {
+    bugReportUrl: string;
+    codenameId: string;
+    distroUniqueId: string;
+    distroId: string;
+    distroLike: string;
+    familyId: string;
+    homeUrl: string;
+    isCalamaresAvailable: boolean;
+    liveMediumPath: string;
+    releaseId: string;
+    squashfs: string;
+    supportUrl: string;
+    syslinuxPath: string;
+    usrLibPath: string;
+    constructor();
+    /**
+     * NEW CHANGE6: Modular configuration for main distro types like Alpine, Fedora-family, etc.
+     * This simplifies the constructor and keeps distro-specific logic isolated.
+     */
+    private configureDistro;
+    /**
+     * NEW CHANGE12: Map Debian, Ubuntu, Devuan codenames to proper IDs and paths
+     * This avoids long if/else chains and allows easier future updates.
+     */
+    private debianFamily;
+    /**
+     * NEW CHANGE15: Async derivative detection from YAML files
+     * This allows future-proofing and easy updates for new distros.
+     */
+    private detectDerivatives;
+    /**
+     * NEW CHANGE16: Apply family-specific paths for usrLibPath, squashfs, and liveMediumPath
+     * Handles Debian, openSUSE, Manjaro and derivatives consistently.
+     */
+    private applyFamilySpecificPaths;
+    /**
+     * NEW CHANGE17: Load custom HOME, SUPPORT, BUG_REPORT URLs from /etc/os-release
+     * Allows overrides of default URLs for user-friendly experience.
+     */
+    private loadOSReleaseUrls;
+}
+export default Distro;