penguins-eggs 10.0.60 → 10.1.1

package/dist/classes/utils.d.ts

@@ -1,327 +1,95 @@
 /**
-* ./src/classes/utils.tsx
-* penguins-eggs v.10.0.0 / ecmascript 2020
-* author: Piero Proietti
-* email: piero.proietti@gmail.com
-* license: MIT
-*/
-import IOsRelease from '../interfaces/i-os-release.js';
+ * ./src/classes/utils.ts
+ * penguins-eggs v.10.0.0 / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ *
+ * Refactored Utils class - imports from modular utilities
+ */
+import System from './utils.d/system.js';
+import PackageInfo from './utils.d/package-info.js';
+import Network from './utils.d/network.js';
+import Filesystem from './utils.d/filesystem.js';
+import Snapshot from './utils.d/snapshot.js';
+import Architecture from './utils.d/architecture.js';
+import UserInteraction from './utils.d/user-interaction.js';
+import ConsoleOutput from './utils.d/console-output.js';
+import Formatters from './utils.d/formatters.js';
+import Kernel from './utils.d/kernel.js';
 /**
- * Utils: general porpourse utils
- * @remarks all the utilities
+ * Utils: general purpose utils
+ * @remarks all the utilities - refactored into modular structure
  */
 export default class Utils {
-    /**
-    * Custom function to sort object keys
-    * @param obj
-    * @returns
-    */
-    static sortObjectKeys(obj: {
-        [key: string]: any;
-    }): {
-        [key: string]: any;
-    };
-    /**
-     *
-     * @param file
-     * @param search
-     * @returns value
-     */
-    static searchOnFile(file?: string, search?: string): string;
-    /**
-     * Restituisce il prefisso della iso
-     * @param distroId
-     * @param codenameId
-     */
-    static snapshotPrefix(distroId: string, codenameId: string): string;
-    /**
-     *  isSystemd
-     */
-    static isSystemd(): boolean;
-    /**
-     * isSysvinit
-     */
-    static isSysvinit(): boolean;
-    /**
-     *  isOpenRc
-     */
-    static isOpenRc(): boolean;
-    /**
-     * ricava path per vmlinuz
-     * Normalmente cerca BOOT_IMAGE
-     * BOOT_IMAGE=/boot/vmlinuz-5.16.0-3-amd64 root=UUID=13768873-d6ba-4ae5-9e14-b5011f5aa31c ro quiet splash resume=UUID=beafb9b4-c429-4e1f-a268-4270b63a14e6
-     * se non è presente, come nel caso di Franco, cerca initrd e ricostruisce vmlinuz
-     * ro root=UUID=3dc0f202-8ac8-4686-9316-dddcec060c48 initrd=boot\initrd.img-5.15.0-0.bpo.3-amd64 // Conidi
-     */
-    static vmlinuz(): string;
-    /**
-     * ricava path per initrdImg
-     */
-    static initrdImg(): string;
-    /**
-     * Occore vedere un modo per creare machine-id dove non esiste
-     */
-    static machineId(): string;
-    /**
-     *
-     * @param msg
-     */
-    static warning(msg?: string): void;
-    static error(msg?: string): void;
-    /**
-     * Return the primary user's name
-     */
-    static getPrimaryUser(): Promise<string>;
-    /**
-     * restituisce uuid
-     * @param device
-     */
-    static uuid(device: string): string;
-    /**
-     *
-     * @param device
-     * @returns
-     */
-    static uuidGen(): string;
-    /**
-     *
-     * @param date
-     */
-    static formatDate(date: Date): string;
-    /**
-     * return the name of the package: penguins-eggs
-     * @returns penguins-eggs
-     */
-    static getPackageName(): string;
-    /**
-     * Count the eggs present in the nest
-     * @returns {number} Numero degli snapshot presenti
-     */
-    static getSnapshotCount(snapshot_dir?: string): number;
-    /**
-     * Get the syze of the snapshot
-     * @returns {string} grandezza dello snapshot in Byte
-     */
-    static getSnapshotSize(snapshot_dir?: string): number;
-    /**
-     * uefiArch
-     * @returns arch
-     */
-    static uefiArch(): string;
-    /**
-     * i386-pc,
-     * i386-efi,
-     * x86_64-efi,
-     * arm64-efi,
-     *
-     * ATTEMZIONE: install efibootmgr
-     *
-     * Fedora/RHEL have i386-pc
-     */
-    static uefiFormat(): string;
-    /**
-     *
-     * @returns
-     */
-    static usrLibPath(): string;
-    /**
-     *
-     * @param prefix
-     * @param backup
-     * @returns
-     */
-    static getPrefix(prefix: string, backup?: boolean): string;
-    /**
-     *
-     * @param volid
-     */
-    static getVolid(volid?: string): string;
-    /**
-     * Return postfix
-     * @param basename
-     * @returns eggName
-     */
-    static getPostfix(): string;
-    /**
-     * Calculate the space used on the disk
-     * @return {void}
-     */
-    static getUsedSpace(): number;
-    /**
-     * Extimate the linuxfs dimension
-     * probably is better to rename it as
-     * getLiveSpaceRootNeed
-     * @returns {number} Byte
-     */
-    static getLiveRootSpace(type?: string): number;
-    /**
-     * Return true if i686 architecture
-     * @remarks to move in Utils
-     * @returns {boolean} true se l'architettura è i686
-     */
-    static isi686(): boolean;
-    /**
-     * Controlla se è un pacchetto deb
-     * /usr/lib/penguins-eggs/bin/node
-     */
-    static isDebPackage(): boolean;
-    /**
-     * Controlla se è un pacchetto sorgente
-     */
-    static isSources(): boolean;
-    /**
-     * Controlla se è un pacchetto npm
-     */
-    static isNpmPackage(): boolean;
-    /**
-     *
-     */
-    static rootPenguin(): string;
-    /**
-     * return the short name of the package: eggs
-     * @returns eggs
-     */
-    static getFriendName(): string;
-    /**
-     * return the version of the package
-     * @returns version example 8.0.0
-     */
-    static getPackageVersion(): string;
-    /**
-     * Get author name
-     */
-    static getAuthorName(): string;
-    /**
-     * Return the Debian version
-     * @returns {number} Versione di Debian
-     */
-    static getDebianVersion(): number;
-    /**
-     * Return true if live system
-     * @returns {boolean} isLive
-     */
-    static isLive(): boolean;
-    /**
-     * Ritorna vero se path è un mountpoint
-     * @param path
-     */
-    static isMountpoint(path?: string): boolean;
-    /**
-     *
-     * @param device
-     * @returns
-     */
-    static isBlockDevice(device?: string): boolean;
-    /**
-     * return true if eggs run as root
-     * @returns isRoot
-     */
-    static isRoot(command?: string): boolean;
-    /**
-     *
-     * @param command
-     */
-    static useRoot(command?: string): void;
-    /**
-     * get the kernel version
-     */
-    static kernelVersion(): string;
-    /**
-     * return the name of network device
-     */
-    static iface(): Promise<string>;
-    /**
-     * address
-     */
-    static address(): string;
-    /**
-     * netmask
-     */
-    static netmask(): string;
-    /**
-     * cidr
-     */
-    static cidr(): string;
-    /**
-     *
-     * broadcast
-    */
-    static broadcast(): string;
-    /**
-     * dns
-     */
-    static getDns(): string[];
-    /**
-     * getDomain
-     */
-    static getDomain(): string;
-    /**
-     * @returns gateway
-     */
-    static gateway(): string;
-    /**
-     * write a file
-     * @param file
-     * @param text
-     */
-    static write(file: string, text: string): void;
-    /**
-     *
-     * @param file
-     * @param cmd
-     */
-    static writeX(file: string, cmd: string): void;
-    /**
-     *
-     * @param file
-     * @param cmd
-     */
-    static writeXs(file: string, cmds: string[]): void;
-    /**
-     *
-     * @param msg
-     */
-    static customConfirm(msg?: string): Promise<boolean>;
-    /**
-     *
-     * @param msg
-     */
-    static customConfirmCompanion(msg?: string): Promise<any>;
-    /**
-     *
-     * @param msg
-     */
-    static customConfirmAbort(msg?: string): Promise<any>;
-    /**
-     *
-     */
-    static pressKeyToExit(warming?: string, procContinue?: boolean): Promise<void>;
-    /**
-     * titles
-     * Penguin's are gettings alive!
-     */
-    static titles(command?: string): void;
-    /**
-     *
-     * @returns flag
-     */
-    static flag(): string;
-    /**
-     *
-     * @param verbose
-     */
-    static setEcho(verbose?: boolean): object;
-    /**
-     *
-     * @param bytes
-     * @param decimals
-     * @returns
-     */
-    static formatBytes(bytes: number, decimals?: number): string;
-    /**
-     *
-     * @returns wardrobe
-     */
-    static wardrobe(): Promise<string>;
-    static getOsRelease(): IOsRelease;
+    static isContainer: typeof System.isContainer;
+    static isSystemd: typeof System.isSystemd;
+    static isSysvinit: typeof System.isSysvinit;
+    static isOpenRc: typeof System.isOpenRc;
+    static isLive: typeof System.isLive;
+    static isMountpoint: typeof System.isMountpoint;
+    static isBlockDevice: typeof System.isBlockDevice;
+    static isRoot: typeof System.isRoot;
+    static machineId: typeof System.machineId;
+    static getDebianVersion: typeof System.getDebianVersion;
+    static getLiveRootSpace: typeof System.getLiveRootSpace;
+    static getPackageName: typeof PackageInfo.getPackageName;
+    static getFriendName: typeof PackageInfo.getFriendName;
+    static getPackageVersion: typeof PackageInfo.getPackageVersion;
+    static getAuthorName: typeof PackageInfo.getAuthorName;
+    static isPackage: typeof PackageInfo.isPackage;
+    static isSources: typeof PackageInfo.isSources;
+    static isNpmPackage: typeof PackageInfo.isNpmPackage;
+    static rootPenguin: typeof PackageInfo.rootPenguin;
+    static wardrobe: typeof PackageInfo.wardrobe;
+    static getPrimaryUser: typeof PackageInfo.getPrimaryUser;
+    static iface: typeof Network.iface;
+    static address: typeof Network.address;
+    static netmask: typeof Network.netmask;
+    static cidr: typeof Network.cidr;
+    static broadcast: typeof Network.broadcast;
+    static getDns: typeof Network.getDns;
+    static getDomain: typeof Network.getDomain;
+    static gateway: typeof Network.gateway;
+    static searchOnFile: typeof Filesystem.searchOnFile;
+    static uuid: typeof Filesystem.uuid;
+    static uuidGen: typeof Filesystem.uuidGen;
+    static getUsedSpace: typeof Filesystem.getUsedSpace;
+    static write: typeof Filesystem.write;
+    static writeX: typeof Filesystem.writeX;
+    static writeXs: typeof Filesystem.writeXs;
+    static getOsRelease: typeof Filesystem.getOsRelease;
+    static snapshotPrefix: typeof Snapshot.snapshotPrefix;
+    static getSnapshotCount: typeof Snapshot.getSnapshotCount;
+    static getSnapshotSize: typeof Snapshot.getSnapshotSize;
+    static getPrefix: typeof Snapshot.getPrefix;
+    static getVolid: typeof Snapshot.getVolid;
+    static getPostfix: typeof Snapshot.getPostfix;
+    static isi686: typeof Architecture.isi686;
+    static uefiArch: typeof Architecture.uefiArch;
+    static uefiFormat: typeof Architecture.uefiFormat;
+    static usrLibPath: typeof Architecture.usrLibPath;
+    static kernelVersion: typeof Architecture.kernelVersion;
+    static customConfirm: typeof UserInteraction.customConfirm;
+    static customConfirmCompanion: typeof UserInteraction.customConfirmCompanion;
+    static customConfirmAbort: typeof UserInteraction.customConfirmAbort;
+    static pressKeyToExit: typeof UserInteraction.pressKeyToExit;
+    static useRoot: typeof UserInteraction.useRoot;
+    static setEcho: typeof UserInteraction.setEcho;
+    static warning: typeof ConsoleOutput.warning;
+    static error: typeof ConsoleOutput.error;
+    static titles: typeof ConsoleOutput.titles;
+    static flag: typeof ConsoleOutput.flag;
+    static sortObjectKeys: typeof Formatters.sortObjectKeys;
+    static formatDate: typeof Formatters.formatDate;
+    static formatBytes: typeof Formatters.formatBytes;
+    /**
+     * @deprecated Use Kernel.vmlinuz() instead
+     */
+    static vmlinuz(kernel?: string): string;
+    /**
+     * @deprecated Use Kernel.initramfs() instead
+     */
+    static initrdImg(kernel?: string): string;
 }
+export { System, PackageInfo, Network, Filesystem, Snapshot, Architecture, UserInteraction, ConsoleOutput, Formatters, Kernel };