@simplens/onboard 1.0.8 → 1.0.10

package/src/utils/logger.ts

@@ -1,144 +0,0 @@
-import chalk from 'chalk';
-import { appendFile as fsAppendFile } from 'fs/promises';
-
-/**
- * Logging level
- */
-export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
-
-/**
- * Logger configuration
- */
-interface LoggerConfig {
-    verbose: boolean;
-    debug: boolean;
-    silent: boolean;
-    logFile?: string;
-}
-
-let loggerConfig: LoggerConfig = {
-    verbose: false,
-    debug: false,
-    silent: false,
-};
-
-function formatTag(tag: string, color: (text: string) => string): string {
-    return color(`[${tag.toUpperCase().padEnd(7)}]`);
-}
-
-function printLogLine(tag: 'debug' | 'info' | 'ok' | 'warn' | 'error', message: string): void {
-    if (loggerConfig.silent) return;
-    
-    switch (tag) {
-        case 'debug':
-            console.log(`${formatTag('debug', chalk.gray)} ${chalk.gray(message)}`);
-            return;
-        case 'info':
-            console.log(`${formatTag('info', chalk.blueBright)} ${message}`);
-            return;
-        case 'ok':
-            console.log(`${formatTag('ok', chalk.greenBright)} ${message}`);
-            return;
-        case 'warn':
-            console.log(`${formatTag('warn', chalk.yellowBright)} ${message}`);
-            return;
-        case 'error':
-            console.log(`${formatTag('error', chalk.redBright)} ${message}`);
-            return;
-    }
-}
-
-/**
- * Initialize logger with configuration
- */
-export function initLogger(config: Partial<LoggerConfig>): void {
-    loggerConfig = { ...loggerConfig, ...config };
-}
-
-/**
- * Get current logger configuration
- */
-export function getLoggerConfig(): Readonly<LoggerConfig> {
-    return { ...loggerConfig };
-}
-
-/**
- * Write log message to file if configured
- */
-async function writeToLogFile(level: LogLevel, message: string): Promise<void> {
-    if (!loggerConfig.logFile) return;
-
-    try {
-        const timestamp = new Date().toISOString();
-        const logEntry = `[${timestamp}] [${level.toUpperCase()}] ${message}\n`;
-        await fsAppendFile(loggerConfig.logFile, logEntry, 'utf-8');
-    } catch (error) {
-        // Silently fail on log file errors
-    }
-}
-
-/**
- * Log debug message (only shown with --debug flag)
- */
-export function logDebug(message: string): void {
-    if (loggerConfig.debug) {
-        printLogLine('debug', message);
-    }
-    writeToLogFile('debug', message);
-}
-
-/**
- * Log verbose message (shown with --verbose or --debug)
- */
-export function logVerbose(message: string): void {
-    if (!loggerConfig.silent && (loggerConfig.verbose || loggerConfig.debug)) {
-        console.log(`${formatTag('verbose', chalk.cyanBright)} ${message}`);
-    }
-    writeToLogFile('info', message);
-}
-
-/**
- * Log info message (always displayed)
- */
-export function logInfo(message: string): void {
-    printLogLine('info', message);
-    writeToLogFile('info', message);
-}
-
-/**
- * Log success message (always displayed)
- */
-export function logSuccess(message: string): void {
-    printLogLine('ok', message);
-    writeToLogFile('info', message);
-}
-
-/**
- * Log warning message (always displayed)
- */
-export function logWarning(message: string): void {
-    printLogLine('warn', message);
-    writeToLogFile('warn', message);
-}
-
-/**
- * Log error message (always displayed)
- */
-export function logError(message: string): void {
-    printLogLine('error', message);
-    writeToLogFile('error', message);
-}
-
-/**
- * Log command execution (debug level)
- */
-export function logCommand(command: string, args: string[]): void {
-    logDebug(`Executing: ${command} ${args.join(' ')}`);
-}
-
-/**
- * Log file operation (debug level)
- */
-export function logFileOperation(operation: string, filePath: string): void {
-    logDebug(`${operation}: ${filePath}`);
-}

package/src/utils.ts

@@ -1,183 +0,0 @@
-import chalk from 'chalk';
-import { execa } from 'execa';
-import fs from 'fs/promises';
-import path from 'path';
-import figlet from 'figlet';
-import { getLoggerConfig } from './utils/logger.js';
-
-// Re-export logger functions for backward compatibility
-export {
-    logSuccess,
-    logError,
-    logWarning,
-    logInfo,
-    logDebug,
-    logVerbose,
-    logCommand,
-    logFileOperation,
-    initLogger,
-    getLoggerConfig,
-} from './utils/logger.js';
-
-const MAX_TUI_WIDTH = 78;
-const MIN_TUI_WIDTH = 52;
-
-type AccentColor = 'blue' | 'cyan' | 'green' | 'yellow' | 'red' | 'gray';
-
-function getTerminalWidth(): number {
-    const columns = process.stdout.columns ?? MAX_TUI_WIDTH;
-    return Math.max(MIN_TUI_WIDTH, Math.min(MAX_TUI_WIDTH, columns));
-}
-
-function accent(text: string, color: AccentColor): string {
-    switch (color) {
-        case 'blue':
-            return chalk.blueBright(text);
-        case 'cyan':
-            return chalk.cyanBright(text);
-        case 'green':
-            return chalk.greenBright(text);
-        case 'yellow':
-            return chalk.yellowBright(text);
-        case 'red':
-            return chalk.redBright(text);
-        case 'gray':
-        default:
-            return chalk.gray(text);
-    }
-}
-
-export function divider(color: AccentColor = 'gray', char: string = '─'): string {
-    return accent(char.repeat(getTerminalWidth()), color);
-}
-
-export function printStepHeader(step: number, total: number, title: string): void {
-    if (getLoggerConfig().silent) return;
-    
-    const filled = '■'.repeat(Math.max(0, step));
-    const empty = '·'.repeat(Math.max(0, total - step));
-    const progress = chalk.gray(`${filled}${empty}`);
-
-    console.log(`\n${divider()}`);
-    console.log(`${accent(`[${step}/${total}]`, 'cyan')} ${chalk.whiteBright(title)} ${progress}`);
-    console.log(divider());
-}
-
-export function printSummaryCard(
-    title: string,
-    rows: Array<{ label: string; value: string }>
-): void {
-    if (getLoggerConfig().silent) return;
-    
-    const labelWidth = Math.max(...rows.map(row => row.label.length), 0);
-
-    console.log(`\n${accent(title, 'cyan')}`);
-    console.log(divider());
-    for (const row of rows) {
-        const label = chalk.gray(row.label.padEnd(labelWidth));
-        console.log(`${label}  ${chalk.white(row.value)}`);
-    }
-    console.log(`${divider()}\n`);
-}
-
-export function printCommandHints(title: string, commands: string[]): void {
-    if (getLoggerConfig().silent) return;
-    
-    console.log(accent(title, 'cyan'));
-    for (const command of commands) {
-        console.log(`  ${accent('›', 'gray')} ${chalk.white(command)}`);
-    }
-    console.log('');
-}
-
-/**
- * Display SimpleNS banner in blue using figlet
- */
-export function displayBanner(): void {
-    if (getLoggerConfig().silent) return;
-    
-    const simpleNS = figlet.textSync('SimpleNS', {
-        font: 'Standard',
-        horizontalLayout: 'default',
-    });
-    
-    const onboard = figlet.textSync('Onboard', {
-        font: 'Standard',
-        horizontalLayout: 'default',
-    });
-
-    console.log('');
-    console.log(divider('blue', '═'));
-    console.log(chalk.blueBright(simpleNS));
-    console.log(chalk.cyanBright(onboard));
-    console.log(chalk.gray('SimpleNS local setup assistant'));
-    console.log(divider('blue', '═'));
-    console.log('');
-}
-
-/**
- * Execute a shell command with error handling
- */
-export async function executeCommand(
-    command: string,
-    args: string[],
-    options?: { cwd?: string; silent?: boolean }
-): Promise<{ stdout: string; stderr: string }> {
-    // Import dynamically to avoid circular dependency
-    const { logCommand } = await import('./utils/logger.js');
-    
-    logCommand(command, args);
-    
-    try {
-        const result = await execa(command, args, {
-            cwd: options?.cwd || process.cwd(),
-            stdio: options?.silent ? 'pipe' : 'inherit',
-        });
-        return { stdout: result.stdout, stderr: result.stderr };
-    } catch (error: any) {
-        throw new Error(`Command failed: ${command} ${args.join(' ')}\n${error.message}`);
-    }
-}
-
-/**
- * Check if file exists
- */
-export async function fileExists(filePath: string): Promise<boolean> {
-    try {
-        await fs.access(filePath);
-        return true;
-    } catch {
-        return false;
-    }
-}
-
-/**
- * Write file content
- */
-export async function writeFile(filePath: string, content: string): Promise<void> {
-    const { logFileOperation } = await import('./utils/logger.js');
-    
-    logFileOperation('Writing file', filePath);
-    
-    const dir = path.dirname(filePath);
-    await fs.mkdir(dir, { recursive: true });
-    await fs.writeFile(filePath, content, 'utf-8');
-}
-
-/**
- * Read file content
- */
-export async function readFile(filePath: string): Promise<string> {
-    return await fs.readFile(filePath, 'utf-8');
-}
-
-/**
- * Append content to file
- */
-export async function appendFile(filePath: string, content: string): Promise<void> {
-    // Ensure parent directory exists, similar to writeFile
-    const dir = path.dirname(filePath);
-    await fs.mkdir(dir, { recursive: true });
-    
-    await fs.appendFile(filePath, content, 'utf-8');
-}

package/src/validators.ts

@@ -1,196 +0,0 @@
-import { execa } from 'execa';
-import { logSuccess, logWarning } from './utils.js';
-import { spinner } from './ui.js';
-import {
-    DockerNotInstalledError,
-    DockerNotRunningError,
-    DockerPermissionError,
-} from './types/errors.js';
-import { VALIDATION } from './config/constants.js';
-
-export type OSType = 'windows' | 'linux' | 'darwin';
-
-/**
- * Validate a public domain used for ACME/Certbot.
- * Accepts FQDN only (no protocol, path, query, port, or wildcard).
- */
-export function validatePublicDomain(input: string): true | string {
-    const value = input.trim().toLowerCase();
-
-    if (!value) {
-        return 'Domain is required';
-    }
-
-    if (
-        value.includes('://') ||
-        value.includes('/') ||
-        value.includes('?') ||
-        value.includes('#') ||
-        value.includes(':') ||
-        value.includes('*')
-    ) {
-        return 'Enter only a domain name (example: app.example.com)';
-    }
-
-    // RFC-ish practical FQDN validation
-    const domainRegex =
-        /^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$/;
-
-    if (!domainRegex.test(value)) {
-        return 'Invalid domain format (example: app.example.com)';
-    }
-
-    return true;
-}
-
-/**
- * Validate email format for Let's Encrypt registration.
- */
-export function validateEmailAddress(input: string): true | string {
-    const value = input.trim();
-
-    if (!value) {
-        return 'Email is required';
-    }
-
-    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-    if (!emailRegex.test(value)) {
-        return 'Invalid email format (example: admin@example.com)';
-    }
-
-    return true;
-}
-
-/**
- * Checks if Docker is installed on the system by running `docker --version`.
- *
- * @throws {DockerNotInstalledError} When Docker is not found in PATH or not installed
- */
-export async function checkDockerInstalled(): Promise<void> {
-    try {
-        await execa('docker', ['--version']);
-    } catch (error: unknown) {
-        throw new DockerNotInstalledError();
-    }
-}
-
-/**
- * Checks if the Docker daemon is running by executing `docker ps`.
- * Provides specific error types based on the failure reason.
- *
- * @throws {DockerPermissionError} When user lacks permissions to access Docker socket
- * @throws {DockerNotRunningError} When Docker daemon is not running or unreachable
- */
-export async function checkDockerRunning(): Promise<void> {
-    try {
-        await execa('docker', ['ps']);
-    } catch (error: unknown) {
-        const errorMessage = (error as Error).message?.toLowerCase() || '';
-
-        if (errorMessage.includes('permission denied') || errorMessage.includes('eacces')) {
-            throw new DockerPermissionError();
-        }
-
-        if (errorMessage.includes('cannot connect') || errorMessage.includes('is the docker daemon running')) {
-            throw new DockerNotRunningError();
-        }
-
-        // Generic docker error
-        throw new DockerNotRunningError();
-    }
-}
-
-/**
- * Detects the operating system platform.
- *
- * @returns OS type: 'windows', 'darwin' (macOS), or 'linux'
- * @note Defaults to 'linux' for unknown platforms
- */
-export function detectOS(): OSType {
-    const platform = process.platform;
-    if (platform === 'win32') return 'windows';
-    if (platform === 'linux') return 'linux';
-    if (platform === 'darwin') return 'darwin';
-    return 'linux'; // Default fallback
-}
-
-/**
- * Validates all system prerequisites before starting the onboarding process.
- * Checks Docker installation, daemon status, and detects the operating system.
- * Uses clack spinners for visual feedback.
- *
- * @throws {DockerNotInstalledError} If Docker is not installed
- * @throws {DockerNotRunningError} If Docker daemon is not running
- * @throws {DockerPermissionError} If user lacks Docker permissions
- */
-export async function validatePrerequisites(): Promise<void> {
-    logSuccess('Running prerequisite checks...');
-
-    // Check Docker installation
-    const s = spinner();
-    s.start('Checking Docker installation...');
-    try {
-        await checkDockerInstalled();
-        s.stop('Docker installation detected');
-    } catch (error) {
-        s.error('Docker installation check failed');
-        throw error;
-    }
-
-    // Check Docker daemon
-    s.start('Checking Docker daemon status...');
-    try {
-        await checkDockerRunning();
-        s.stop('Docker daemon is running');
-    } catch (error) {
-        s.error('Docker daemon check failed');
-        throw error;
-    }
-
-    // Detect OS
-    const os = detectOS();
-    logSuccess(`Detected OS: ${os}`);
-
-    if (os === 'linux') {
-        logWarning('Linux detected: You may need to provide your machine IP for infra services.');
-    }
-}
-
-/**
- * Validates environment variable values based on the variable name/type.
- * Performs format-specific validation for URLs, ports, and security credentials.
- *
- * @param key - Environment variable name (e.g., 'MONGO_URI', 'PORT', 'API_KEY')
- * @param value - Value to validate
- * @returns `true` if valid, `false` otherwise
- */
-export function validateEnvValue(key: string, value: string): boolean {
-    // URL validation
-    if (key.includes('URL') || key.includes('URI')) {
-        if (!value) return false;
-        // Basic URL format check
-        if (key === 'MONGO_URI' && !value.includes('mongodb://')) {
-            return false;
-        }
-        if (key === 'REDIS_URL' && !value.includes('redis://')) {
-            return false;
-        }
-    }
-
-    // Port validation
-    if (key.includes('PORT')) {
-        const port = parseInt(value, 10);
-        if (isNaN(port) || port < VALIDATION.PORT_MIN || port > VALIDATION.PORT_MAX) {
-            return false;
-        }
-    }
-
-    // API Key validation (should not be empty for security)
-    if (key.includes('API_KEY') || key.includes('SECRET') || key.includes('PASSWORD')) {
-        if (!value || value.length < VALIDATION.MIN_PASSWORD_LENGTH) {
-            return false;
-        }
-    }
-
-    return true;
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "Node16",
-    "moduleResolution": "Node16",
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/vitest.config.ts

@@ -1,22 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    include: ['src/**/*.{test,spec}.{js,ts}'],
-    exclude: ['node_modules/**', 'dist/**'],
-    coverage: {
-      provider: 'v8',
-      reporter: ['text', 'json', 'html'],
-      exclude: [
-        'node_modules/**',
-        'dist/**',
-        '**/*.test.ts',
-        '**/*.spec.ts',
-        'src/templates.ts', // Large constant file
-      ],
-    },
-    testTimeout: 10000,
-  },
-});