@codifycli/plugin-core 1.1.0-beta9 → 1.2.1-beta.1

package/dist/test.js

@@ -1,5 +0,0 @@
-import { SequentialPty } from './pty/seqeuntial-pty.js';
-import { VerbosityLevel } from './utils/verbosity-level.js';
-VerbosityLevel.set(1);
-const $ = new SequentialPty();
-await $.spawn('sudo ls', { interactive: true });

package/dist/utils/codify-spawn.d.ts

@@ -1,29 +0,0 @@
-import { SpawnOptions } from 'node:child_process';
-export declare enum SpawnStatus {
-    SUCCESS = "success",
-    ERROR = "error"
-}
-export interface SpawnResult {
-    status: SpawnStatus;
-    data: string;
-}
-type CodifySpawnOptions = {
-    cwd?: string;
-    throws?: boolean;
-    requiresRoot?: boolean;
-    requestsTTY?: boolean;
-} & Omit<SpawnOptions, 'detached' | 'shell' | 'stdio'>;
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export declare function codifySpawn(cmd: string, opts?: CodifySpawnOptions): Promise<SpawnResult>;
-export declare function isDebug(): boolean;
-export {};

package/dist/utils/codify-spawn.js

@@ -1,136 +0,0 @@
-import { Ajv } from 'ajv';
-import { MessageCmd, SudoRequestResponseDataSchema } from 'codify-schemas';
-import { nanoid } from 'nanoid';
-import { spawn } from 'node:child_process';
-import stripAnsi from 'strip-ansi';
-import { VerbosityLevel } from './utils.js';
-import { SudoError } from '../errors.js';
-const ajv = new Ajv({
-    strict: true,
-});
-const validateSudoRequestResponse = ajv.compile(SudoRequestResponseDataSchema);
-export var SpawnStatus;
-(function (SpawnStatus) {
-    SpawnStatus["SUCCESS"] = "success";
-    SpawnStatus["ERROR"] = "error";
-})(SpawnStatus || (SpawnStatus = {}));
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export async function codifySpawn(cmd, opts) {
-    const throws = opts?.throws ?? true;
-    console.log(`Running command: ${cmd}` + (opts?.cwd ? `(${opts?.cwd})` : ''));
-    try {
-        // TODO: Need to benchmark the effects of using sh vs zsh for shell.
-        //  Seems like zsh shells run slower
-        const result = await (opts?.requiresRoot
-            ? externalSpawnWithSudo(cmd, opts)
-            : internalSpawn(cmd, opts ?? {}));
-        if (result.status !== SpawnStatus.SUCCESS) {
-            throw new Error(result.data);
-        }
-        return result;
-    }
-    catch (error) {
-        if (isDebug()) {
-            console.error(`CodifySpawn error for command ${cmd}`, error);
-        }
-        // @ts-ignore
-        if (error.message?.startsWith('sudo:')) {
-            throw new SudoError(cmd);
-        }
-        if (throws) {
-            throw error;
-        }
-        if (error instanceof Error) {
-            return {
-                status: SpawnStatus.ERROR,
-                data: error.message,
-            };
-        }
-        return {
-            status: SpawnStatus.ERROR,
-            data: String(error),
-        };
-    }
-}
-async function internalSpawn(cmd, opts) {
-    return new Promise((resolve) => {
-        const output = [];
-        // If TERM_PROGRAM=Apple_Terminal is set then ANSI escape characters may be included
-        // in the response.
-        const env = { ...process.env, ...opts.env, TERM_PROGRAM: 'codify', COMMAND_MODE: 'unix2003', COLORTERM: 'truecolor' };
-        const shell = getDefaultShell();
-        const rcFile = shell === 'zsh' ? '~/.zshrc' : '~/.bashrc';
-        // Source start up shells to emulate a users environment vs. a non-interactive non-login shell script
-        // Ignore all stdin
-        // If tty is requested then we'll need to sleep 1 to avoid race conditions. This is because if the terminal updates async after the tty message is
-        // displayed then it'll disappear. By adding sleep 1 it'll allow ink.js to finish all the updates before the tty message is shown
-        const _process = spawn(`source ${rcFile}; ${opts.requestsTTY ? 'sleep 1;' : ''}${cmd}`, [], {
-            ...opts,
-            stdio: ['ignore', 'pipe', 'pipe'],
-            shell,
-            env
-        });
-        const { stdout, stderr, stdin } = _process;
-        stdout.setEncoding('utf8');
-        stderr.setEncoding('utf8');
-        stdout.on('data', (data) => {
-            output.push(data.toString());
-        });
-        stderr.on('data', (data) => {
-            output.push(data.toString());
-        });
-        _process.on('error', (data) => { });
-        // please node that this is not a full replacement for 'inherit'
-        // the child process can and will detect if stdout is a pty and change output based on it
-        // the terminal context is lost & ansi information (coloring) etc will be lost
-        if (stdout && stderr && VerbosityLevel.get() > 0) {
-            stdout.pipe(process.stdout);
-            stderr.pipe(process.stderr);
-        }
-        _process.on('close', (code) => {
-            resolve({
-                status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
-                data: stripAnsi(output.join('\n')),
-            });
-        });
-    });
-}
-async function externalSpawnWithSudo(cmd, opts) {
-    return new Promise((resolve) => {
-        const requestId = nanoid(8);
-        const listener = (data) => {
-            if (data.requestId === requestId) {
-                process.removeListener('message', listener);
-                if (!validateSudoRequestResponse(data.data)) {
-                    throw new Error(`Invalid response for sudo request: ${JSON.stringify(validateSudoRequestResponse.errors, null, 2)}`);
-                }
-                resolve(data.data);
-            }
-        };
-        process.on('message', listener);
-        process.send({
-            cmd: MessageCmd.SUDO_REQUEST,
-            data: {
-                command: cmd,
-                options: opts ?? {},
-            },
-            requestId
-        });
-    });
-}
-export function isDebug() {
-    return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
-}
-function getDefaultShell() {
-    return process.platform === 'darwin' ? 'zsh' : 'bash';
-}

package/dist/utils/internal-utils.d.ts

@@ -1,12 +0,0 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
-export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
-    parameters: T;
-    coreParameters: ResourceConfig;
-};
-export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
-export declare function untildify(pathWithTilde: string): string;
-export declare function tildify(pathWithTilde: string): string;
-export declare function resolvePathWithVariables(pathWithVariables: string): string;
-export declare function addVariablesToPath(pathWithoutVariables: string): string;
-export declare function unhome(pathWithHome: string): string;
-export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/internal-utils.js

@@ -1,74 +0,0 @@
-import os from 'node:os';
-import path from 'node:path';
-export function splitUserConfig(config) {
-    const coreParameters = {
-        type: config.type,
-        ...(config.name ? { name: config.name } : {}),
-        ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
-    };
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { type, name, dependsOn, ...parameters } = config;
-    return {
-        parameters: parameters,
-        coreParameters,
-    };
-}
-export function setsEqual(set1, set2) {
-    return set1.size === set2.size && [...set1].every((v) => set2.has(v));
-}
-const homeDirectory = os.homedir();
-export function untildify(pathWithTilde) {
-    return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
-}
-export function tildify(pathWithTilde) {
-    return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
-}
-export function resolvePathWithVariables(pathWithVariables) {
-    // @ts-expect-error Ignore this for now
-    return pathWithVariables.replace(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b]);
-}
-export function addVariablesToPath(pathWithoutVariables) {
-    let result = pathWithoutVariables;
-    for (const [key, value] of Object.entries(process.env)) {
-        if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
-            continue;
-        }
-        result = result.replaceAll(value, `$${key}`);
-    }
-    return result;
-}
-export function unhome(pathWithHome) {
-    return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
-}
-export function areArraysEqual(isElementEqual, desired, current) {
-    if (!desired || !current) {
-        return false;
-    }
-    if (!Array.isArray(desired) || !Array.isArray(current)) {
-        throw new Error(`A non-array value:
-          
-Desired: ${JSON.stringify(desired, null, 2)}
-
-Current: ${JSON.stringify(desired, null, 2)}
-
-Was provided even though type array was specified.
-`);
-    }
-    if (desired.length !== current.length) {
-        return false;
-    }
-    const desiredCopy = [...desired];
-    const currentCopy = [...current];
-    // Algorithm for to check equality between two un-ordered; un-hashable arrays using
-    // an isElementEqual method. Time: O(n^2)
-    for (let counter = desiredCopy.length - 1; counter >= 0; counter--) {
-        const idx = currentCopy.findIndex((e2) => (isElementEqual
-            ?? ((a, b) => a === b))(desiredCopy[counter], e2));
-        if (idx === -1) {
-            return false;
-        }
-        desiredCopy.splice(counter, 1);
-        currentCopy.splice(idx, 1);
-    }
-    return currentCopy.length === 0;
-}

package/dist/utils/load-resources.d.ts

@@ -1 +0,0 @@
-export declare const listAllResources: (root?: string) => Promise<string[]>;

package/dist/utils/load-resources.js

@@ -1,46 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import * as url from 'node:url';
-export const listAllResources = async (root = path.join(path.dirname(url.fileURLToPath(import.meta.url)), '..', '..', '..', '..')) => {
-    console.log('Dirname', root);
-    const resourcesPath = path.join(root, 'src', 'resources');
-    const resourceDir = await fs.readdir(resourcesPath);
-    const dedupSet = new Set();
-    const result = new Set();
-    for (const folder of resourceDir) {
-        if (await fs.stat(path.join(resourcesPath, folder)).then(s => s.isDirectory()).catch(() => false)) {
-            for (const folderContents of await fs.readdir(path.join(resourcesPath, folder))) {
-                const isDirectory = await fs.stat(path.join(resourcesPath, folder, folderContents)).then(s => s.isDirectory());
-                // console.log(folderContents, isDirectory);
-                if (isDirectory) {
-                    for (const innerContents of await fs.readdir(path.join(resourcesPath, folder, folderContents))) {
-                        if (!dedupSet.has(path.join(resourcesPath, folder, folderContents))) {
-                            dedupSet.add(path.join(resourcesPath, folder, folderContents));
-                            addResourceFromDir(path.join(resourcesPath, folder, folderContents), result);
-                        }
-                    }
-                }
-                else {
-                    if (!dedupSet.has(path.join(resourcesPath, folder))) {
-                        dedupSet.add(path.join(resourcesPath, folder));
-                        addResourceFromDir(path.join(resourcesPath, folder), result);
-                    }
-                }
-            }
-        }
-        else {
-            throw new Error('Only directories are allowed in resources folder');
-        }
-    }
-    return [...result];
-};
-function addResourceFromDir(dir, result) {
-    try {
-        const resourceFile = path.resolve(path.join(dir, 'resource.ts'));
-        if (!(fs.stat(resourceFile).then((s) => s.isFile())).catch(() => false)) {
-            return;
-        }
-        result.add(resourceFile);
-    }
-    catch { }
-}

package/dist/utils/package-json-utils.d.ts

@@ -1,12 +0,0 @@
-/**
- * Find the nearest package.json starting from a directory and walking upward.
- * @param {string} startDir - Directory to start searching from
- * @returns {string|null} Absolute path to package.json or null if not found
- */
-export declare function findNearestPackageJson(startDir?: string): string | null;
-/**
- * Read and parse the nearest package.json
- * @param {string} startDir
- * @returns {object|null}
- */
-export declare function readNearestPackageJson(startDir?: string): any;

package/dist/utils/package-json-utils.js

@@ -1,34 +0,0 @@
-import * as fs from 'node:fs';
-import path from 'node:path';
-/**
- * Find the nearest package.json starting from a directory and walking upward.
- * @param {string} startDir - Directory to start searching from
- * @returns {string|null} Absolute path to package.json or null if not found
- */
-export function findNearestPackageJson(startDir = process.cwd()) {
-    let currentDir = path.resolve(startDir);
-    while (true) {
-        const pkgPath = path.join(currentDir, "package.json");
-        if (fs.existsSync(pkgPath)) {
-            return pkgPath;
-        }
-        const parentDir = path.dirname(currentDir);
-        if (parentDir === currentDir) {
-            // Reached filesystem root
-            return null;
-        }
-        currentDir = parentDir;
-    }
-}
-/**
- * Read and parse the nearest package.json
- * @param {string} startDir
- * @returns {object|null}
- */
-export function readNearestPackageJson(startDir = process.cwd()) {
-    const pkgPath = findNearestPackageJson(startDir);
-    if (!pkgPath)
-        return null;
-    const contents = fs.readFileSync(pkgPath, 'utf8');
-    return JSON.parse(contents);
-}

package/dist/utils/spawn-2.d.ts

@@ -1,5 +0,0 @@
-import { Shell } from 'zx';
-export declare class ShellContext implements Shell {
-    zx: Shell;
-    static create(): ShellContext;
-}

package/dist/utils/spawn-2.js

@@ -1,7 +0,0 @@
-import { $ } from 'zx';
-export class ShellContext {
-    zx = $({ shell: true });
-    static create() {
-        return new ShellContext();
-    }
-}

package/dist/utils/spawn.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import { SpawnOptions } from 'node:child_process';
-export declare enum SpawnStatus {
-    SUCCESS = "success",
-    ERROR = "error"
-}
-export interface SpawnResult {
-    status: SpawnStatus;
-    data: string;
-}
-type CodifySpawnOptions = {
-    cwd?: string;
-    throws?: boolean;
-    requiresRoot?: boolean;
-} & Omit<SpawnOptions, 'detached' | 'shell' | 'stdio'>;
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export declare function $(cmd: string, opts?: CodifySpawnOptions): Promise<SpawnResult>;
-export declare function isDebug(): boolean;
-export {};

package/dist/utils/spawn.js

@@ -1,124 +0,0 @@
-import { Ajv } from 'ajv';
-import { MessageCmd, SudoRequestResponseDataSchema } from 'codify-schemas';
-import { spawn } from 'node:child_process';
-import { SudoError } from '../errors.js';
-const ajv = new Ajv({
-    strict: true,
-});
-const validateSudoRequestResponse = ajv.compile(SudoRequestResponseDataSchema);
-export var SpawnStatus;
-(function (SpawnStatus) {
-    SpawnStatus["SUCCESS"] = "success";
-    SpawnStatus["ERROR"] = "error";
-})(SpawnStatus || (SpawnStatus = {}));
-/**
- *
- * @param cmd Command to run. Ex: `rm -rf`
- * @param opts Standard options for node spawn. Additional argument:
- * throws determines if a shell will throw a JS error. Defaults to true
- *
- * @see promiseSpawn
- * @see spawn
- *
- * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
- */
-export async function $(cmd, opts) {
-    const throws = opts?.throws ?? true;
-    console.log(`Running command: ${cmd}`);
-    try {
-        // TODO: Need to benchmark the effects of using sh vs zsh for shell.
-        //  Seems like zsh shells run slower
-        let result;
-        if (!opts?.requiresRoot) {
-            result = await internalSpawn(cmd, opts ?? {});
-        }
-        else {
-            result = await externalSpawnWithSudo(cmd, opts);
-        }
-        if (result.status !== SpawnStatus.SUCCESS) {
-            throw new Error(result.data);
-        }
-        return result;
-    }
-    catch (error) {
-        if (isDebug()) {
-            console.error(`CodifySpawn error for command ${cmd}`, error);
-        }
-        if (error.message?.startsWith('sudo:')) {
-            throw new SudoError(cmd);
-        }
-        if (throws) {
-            throw error;
-        }
-        if (error instanceof Error) {
-            return {
-                status: SpawnStatus.ERROR,
-                data: error.message,
-            };
-        }
-        return {
-            status: SpawnStatus.ERROR,
-            data: error + '',
-        };
-    }
-}
-async function internalSpawn(cmd, opts) {
-    return new Promise((resolve, reject) => {
-        const output = [];
-        // Source start up shells to emulate a users environment vs. a non-interactive non-login shell script
-        // Ignore all stdin
-        const _process = spawn(`source ~/.zshrc; ${cmd}`, [], {
-            ...opts,
-            stdio: ['ignore', 'pipe', 'pipe'],
-            shell: 'zsh',
-        });
-        const { stdout, stderr, stdin } = _process;
-        stdout.setEncoding('utf8');
-        stderr.setEncoding('utf8');
-        stdout.on('data', (data) => {
-            output.push(data.toString());
-        });
-        stderr.on('data', (data) => {
-            output.push(data.toString());
-        });
-        _process.on('error', (data) => {
-        });
-        // please node that this is not a full replacement for 'inherit'
-        // the child process can and will detect if stdout is a pty and change output based on it
-        // the terminal context is lost & ansi information (coloring) etc will be lost
-        if (stdout && stderr) {
-            stdout.pipe(process.stdout);
-            stderr.pipe(process.stderr);
-        }
-        _process.on('close', (code) => {
-            resolve({
-                status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
-                data: output.join('\n'),
-            });
-        });
-    });
-}
-async function externalSpawnWithSudo(cmd, opts) {
-    return await new Promise((resolve) => {
-        const listener = (data) => {
-            if (data.cmd === MessageCmd.SUDO_REQUEST + '_Response') {
-                process.removeListener('message', listener);
-                if (!validateSudoRequestResponse(data.data)) {
-                    throw new Error(`Invalid response for sudo request: ${JSON.stringify(validateSudoRequestResponse.errors, null, 2)}`);
-                }
-                resolve(data.data);
-            }
-        };
-        process.on('message', listener);
-        process.send({
-            cmd: MessageCmd.SUDO_REQUEST,
-            data: {
-                command: cmd,
-                options: opts ?? {},
-            }
-        });
-    });
-}
-export function isDebug() {
-    return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
-}

package/dist/utils/utils.d.ts

@@ -1,18 +0,0 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
-export declare const VerbosityLevel: {
-    level: number;
-    get(): number;
-    set(level: number): void;
-};
-export declare function isDebug(): boolean;
-export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
-    parameters: T;
-    coreParameters: ResourceConfig;
-};
-export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
-export declare function untildify(pathWithTilde: string): string;
-export declare function tildify(pathWithTilde: string): string;
-export declare function resolvePathWithVariables(pathWithVariables: string): string;
-export declare function addVariablesToPath(pathWithoutVariables: string): string;
-export declare function unhome(pathWithHome: string): string;
-export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/utils.js

@@ -1,86 +0,0 @@
-import os from 'node:os';
-import path from 'node:path';
-export const VerbosityLevel = new class {
-    level = 0;
-    get() {
-        return this.level;
-    }
-    set(level) {
-        this.level = level;
-    }
-};
-export function isDebug() {
-    return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
-}
-export function splitUserConfig(config) {
-    const coreParameters = {
-        type: config.type,
-        ...(config.name ? { name: config.name } : {}),
-        ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
-    };
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { type, name, dependsOn, ...parameters } = config;
-    return {
-        parameters: parameters,
-        coreParameters,
-    };
-}
-export function setsEqual(set1, set2) {
-    return set1.size === set2.size && [...set1].every((v) => set2.has(v));
-}
-const homeDirectory = os.homedir();
-export function untildify(pathWithTilde) {
-    return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
-}
-export function tildify(pathWithTilde) {
-    return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
-}
-export function resolvePathWithVariables(pathWithVariables) {
-    // @ts-expect-error Ignore this for now
-    return pathWithVariables.replace(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b]);
-}
-export function addVariablesToPath(pathWithoutVariables) {
-    let result = pathWithoutVariables;
-    for (const [key, value] of Object.entries(process.env)) {
-        if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
-            continue;
-        }
-        result = result.replaceAll(value, `$${key}`);
-    }
-    return result;
-}
-export function unhome(pathWithHome) {
-    return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
-}
-export function areArraysEqual(isElementEqual, desired, current) {
-    if (!desired || !current) {
-        return false;
-    }
-    if (!Array.isArray(desired) || !Array.isArray(current)) {
-        throw new Error(`A non-array value:
-          
-Desired: ${JSON.stringify(desired, null, 2)}
-
-Current: ${JSON.stringify(desired, null, 2)}
-
-Was provided even though type array was specified.
-`);
-    }
-    if (desired.length !== current.length) {
-        return false;
-    }
-    const desiredCopy = [...desired];
-    const currentCopy = [...current];
-    // Algorithm for to check equality between two un-ordered; un-hashable arrays using
-    // an isElementEqual method. Time: O(n^2)
-    for (let counter = desiredCopy.length - 1; counter >= 0; counter--) {
-        const idx = currentCopy.findIndex((e2) => (isElementEqual
-            ?? ((a, b) => a === b))(desiredCopy[counter], e2));
-        if (idx === -1) {
-            return false;
-        }
-        desiredCopy.splice(counter, 1);
-        currentCopy.splice(idx, 1);
-    }
-    return currentCopy.length === 0;
-}