@simplens/onboard 1.0.0 → 1.0.2

package/src/types/domain.ts

@@ -1,127 +1,129 @@
-/**
- * Domain type definitions for the onboarding system
- */
-
-/**
- * Plugin information returned by config-gen
- */
-export interface PluginInfo {
-    /** Package name (e.g., '@simplens/nodemailer-gmail') */
-    package: string;
-    /** Display name */
-    name: string;
-    /** Description of what the plugin does */
-    description: string;
-}
-
-/**
- * Infrastructure service option
- */
-export interface InfraService {
-    /** Display name (e.g., 'MongoDB (Database)') */
-    name: string;
-    /** Service identifier (e.g., 'mongo') */
-    value: string;
-    /** Whether checked by default */
-    checked: boolean;
-}
-
-/**
- * Environment variable definition
- */
-export interface EnvVariable {
-    /** Environment variable key */
-    key: string;
-    /** Current or default value */
-    value: string;
-    /** Optional description/comment */
-    description?: string;
-    /** Whether this variable is required */
-    required: boolean;
-}
-
-/**
- * Setup options provided via CLI or prompts
- */
-export interface SetupOptions {
-    /** Whether to setup infrastructure services */
-    infra: boolean;
-    /** Environment configuration mode */
-    envMode: 'default' | 'interactive';
-    /** Target directory for setup */
-    targetDir: string;
-}
-
-/**
- * Service definition for docker-compose generation
- */
-export interface ServiceDefinition {
-    /** Service identifier */
-    id: string;
-    /** Display name */
-    name: string;
-    /** Docker compose YAML block */
-    dockerCompose: string;
-    /** Required volumes */
-    volumes: string[];
-    /** Service dependencies */
-    dependencies?: string[];
-    /** Whether service has health check */
-    healthCheck?: boolean;
-}
-
-/**
- * SimplensConfig YAML structure
- */
-export interface SimplensConfig {
-    providers: ProviderConfig[];
-}
-
-/**
- * Provider configuration in simplens.config.yaml
- */
-export interface ProviderConfig {
-    /** Package name */
-    package: string;
-    /** Provider ID */
-    id: string;
-    /** Required credentials as key-value pairs */
-    credentials: Record<string, string>;
-    /** Optional configuration */
-    optionalConfig?: Record<string, string | number | boolean>;
-}
-
-/**
- * Docker compose file structure (simplified)
- */
-export interface DockerComposeFile {
-    services: Record<string, DockerService>;
-    volumes?: Record<string, DockerVolume>;
-    networks?: Record<string, DockerNetwork>;
-}
-
-export interface DockerService {
-    image: string;
-    container_name?: string;
-    ports?: string[];
-    environment?: Record<string, string> | string[];
-    volumes?: string[];
-    command?: string | string[];
-    depends_on?: string[] | Record<string, { condition: string }>;
-    healthcheck?: {
-        test: string | string[];
-        interval?: string;
-        timeout?: string;
-        retries?: number;
-        start_period?: string;
-    };
-}
-
-export interface DockerVolume {
-    driver?: string;
-    driver_opts?: Record<string, string>;
-}
-
-export interface DockerNetwork {
-    driver?: string;
-}
+/**
+ * Domain type definitions for the onboarding system
+ */
+
+/**
+ * Plugin information returned by config-gen
+ */
+export interface PluginInfo {
+    /** Package name (e.g., '@simplens/nodemailer-gmail') */
+    package: string;
+    /** Display name */
+    name: string;
+    /** Description of what the plugin does */
+    description: string;
+}
+
+/**
+ * Infrastructure service option
+ */
+export interface InfraService {
+    /** Display name (e.g., 'MongoDB (Database)') */
+    name: string;
+    /** Service identifier (e.g., 'mongo') */
+    value: string;
+    /** Whether checked by default */
+    checked: boolean;
+}
+
+/**
+ * Environment variable definition
+ */
+export interface EnvVariable {
+    /** Environment variable key */
+    key: string;
+    /** Current or default value */
+    value: string;
+    /** Optional description/comment */
+    description?: string;
+    /** Whether this variable is required */
+    required: boolean;
+}
+
+/**
+ * Setup options provided via CLI or prompts
+ */
+export interface SetupOptions {
+    /** Whether to setup infrastructure services */
+    infra: boolean;
+    /** Environment configuration mode */
+    envMode: 'default' | 'interactive';
+    /** Target directory for setup */
+    targetDir: string;
+    /** Dashboard base path (empty string means root) */
+    basePath: string;
+}
+
+/**
+ * Service definition for docker-compose generation
+ */
+export interface ServiceDefinition {
+    /** Service identifier */
+    id: string;
+    /** Display name */
+    name: string;
+    /** Docker compose YAML block */
+    dockerCompose: string;
+    /** Required volumes */
+    volumes: string[];
+    /** Service dependencies */
+    dependencies?: string[];
+    /** Whether service has health check */
+    healthCheck?: boolean;
+}
+
+/**
+ * SimplensConfig YAML structure
+ */
+export interface SimplensConfig {
+    providers: ProviderConfig[];
+}
+
+/**
+ * Provider configuration in simplens.config.yaml
+ */
+export interface ProviderConfig {
+    /** Package name */
+    package: string;
+    /** Provider ID */
+    id: string;
+    /** Required credentials as key-value pairs */
+    credentials: Record<string, string>;
+    /** Optional configuration */
+    optionalConfig?: Record<string, string | number | boolean>;
+}
+
+/**
+ * Docker compose file structure (simplified)
+ */
+export interface DockerComposeFile {
+    services: Record<string, DockerService>;
+    volumes?: Record<string, DockerVolume>;
+    networks?: Record<string, DockerNetwork>;
+}
+
+export interface DockerService {
+    image: string;
+    container_name?: string;
+    ports?: string[];
+    environment?: Record<string, string> | string[];
+    volumes?: string[];
+    command?: string | string[];
+    depends_on?: string[] | Record<string, { condition: string }>;
+    healthcheck?: {
+        test: string | string[];
+        interval?: string;
+        timeout?: string;
+        retries?: number;
+        start_period?: string;
+    };
+}
+
+export interface DockerVolume {
+    driver?: string;
+    driver_opts?: Record<string, string>;
+}
+
+export interface DockerNetwork {
+    driver?: string;
+}

package/src/types/errors.ts

@@ -1,173 +1,173 @@
-/**
- * Custom error types for better error handling and troubleshooting
- */
-
-/**
- * Base error class for all onboarding errors
- */
-export class OnboardingError extends Error {
-    constructor(
-        public readonly code: string,
-        message: string,
-        public readonly troubleshooting?: string
-    ) {
-        super(message);
-        this.name = 'OnboardingError';
-        Error.captureStackTrace(this, this.constructor);
-    }
-}
-
-/**
- * Docker-related errors
- */
-export class DockerError extends OnboardingError {
-    constructor(message: string, troubleshooting?: string) {
-        super('DOCKER_ERROR', message, troubleshooting);
-        this.name = 'DockerError';
-    }
-}
-
-export class DockerNotInstalledError extends DockerError {
-    constructor() {
-        super(
-            'Docker is not installed on this system',
-            'Please install Docker from: https://docs.docker.com/get-docker/'
-        );
-        this.name = 'DockerNotInstalledError';
-    }
-}
-
-export class DockerNotRunningError extends DockerError {
-    constructor() {
-        super(
-            'Docker daemon is not running',
-            'Please start Docker Desktop or Docker daemon, then try again'
-        );
-        this.name = 'DockerNotRunningError';
-    }
-}
-
-export class DockerPermissionError extends DockerError {
-    constructor() {
-        super(
-            'Permission denied when accessing Docker',
-            'Try running with sudo or add your user to the docker group:\n' +
-            '  sudo usermod -aG docker $USER\n' +
-            '  Then log out and log back in'
-        );
-        this.name = 'DockerPermissionError';
-    }
-}
-
-export class DockerComposeError extends DockerError {
-    constructor(operation: string, details?: string) {
-        super(
-            `Failed to ${operation} with docker-compose`,
-            details || 'Check docker-compose logs for more details:\n  docker-compose logs'
-        );
-        this.name = 'DockerComposeError';
-    }
-}
-
-/**
- * File system errors
- */
-export class FileSystemError extends OnboardingError {
-    constructor(message: string, public readonly path: string, troubleshooting?: string) {
-        super('FILESYSTEM_ERROR', message, troubleshooting);
-        this.name = 'FileSystemError';
-    }
-}
-
-export class DirectoryNotWritableError extends FileSystemError {
-    constructor(path: string) {
-        super(
-            `Directory is not writable: ${path}`,
-            path,
-            'Check directory permissions or choose a different directory'
-        );
-        this.name = 'DirectoryNotWritableError';
-    }
-}
-
-export class FileNotFoundError extends FileSystemError {
-    constructor(path: string) {
-        super(
-            `File not found: ${path}`,
-            path,
-            'Ensure the file exists or check the path'
-        );
-        this.name = 'FileNotFoundError';
-    }
-}
-
-/**
- * Configuration errors
- */
-export class ConfigurationError extends OnboardingError {
-    constructor(message: string, troubleshooting?: string) {
-        super('CONFIG_ERROR', message, troubleshooting);
-        this.name = 'ConfigurationError';
-    }
-}
-
-export class InvalidEnvironmentValueError extends ConfigurationError {
-    constructor(key: string, value: string, expectedFormat: string) {
-        super(
-            `Invalid value for ${key}: ${value}`,
-            `Expected format: ${expectedFormat}`
-        );
-        this.name = 'InvalidEnvironmentValueError';
-    }
-}
-
-export class PluginConfigurationError extends ConfigurationError {
-    constructor(pluginName: string, details: string) {
-        super(
-            `Failed to configure plugin ${pluginName}`,
-            details
-        );
-        this.name = 'PluginConfigurationError';
-    }
-}
-
-/**
- * Service health errors
- */
-export class ServiceHealthError extends OnboardingError {
-    constructor(serviceName: string, timeout: number) {
-        super(
-            'SERVICE_HEALTH_ERROR',
-            `Service '${serviceName}' did not become healthy within ${timeout}ms`,
-            `Check service logs:\n  docker-compose logs ${serviceName}\n\n` +
-            'Or check container status:\n  docker ps -a'
-        );
-        this.name = 'ServiceHealthError';
-    }
-}
-
-/**
- * Type guard to check if an error is an OnboardingError
- */
-export function isOnboardingError(error: unknown): error is OnboardingError {
-    return error instanceof OnboardingError;
-}
-
-/**
- * Format error for user display
- */
-export function formatErrorForUser(error: unknown): string {
-    if (isOnboardingError(error)) {
-        let message = `❌ ${error.message}`;
-        if (error.troubleshooting) {
-            message += `\n\n💡 Troubleshooting:\n${error.troubleshooting}`;
-        }
-        return message;
-    }
-    
-    if (error instanceof Error) {
-        return `❌ Unexpected error: ${error.message}`;
-    }
-    
-    return `❌ An unknown error occurred`;
-}
+/**
+ * Custom error types for better error handling and troubleshooting
+ */
+
+/**
+ * Base error class for all onboarding errors
+ */
+export class OnboardingError extends Error {
+    constructor(
+        public readonly code: string,
+        message: string,
+        public readonly troubleshooting?: string
+    ) {
+        super(message);
+        this.name = 'OnboardingError';
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+
+/**
+ * Docker-related errors
+ */
+export class DockerError extends OnboardingError {
+    constructor(message: string, troubleshooting?: string) {
+        super('DOCKER_ERROR', message, troubleshooting);
+        this.name = 'DockerError';
+    }
+}
+
+export class DockerNotInstalledError extends DockerError {
+    constructor() {
+        super(
+            'Docker is not installed on this system',
+            'Please install Docker from: https://docs.docker.com/get-docker/'
+        );
+        this.name = 'DockerNotInstalledError';
+    }
+}
+
+export class DockerNotRunningError extends DockerError {
+    constructor() {
+        super(
+            'Docker daemon is not running',
+            'Please start Docker Desktop or Docker daemon, then try again'
+        );
+        this.name = 'DockerNotRunningError';
+    }
+}
+
+export class DockerPermissionError extends DockerError {
+    constructor() {
+        super(
+            'Permission denied when accessing Docker',
+            'Try running with sudo or add your user to the docker group:\n' +
+            '  sudo usermod -aG docker $USER\n' +
+            '  Then log out and log back in'
+        );
+        this.name = 'DockerPermissionError';
+    }
+}
+
+export class DockerComposeError extends DockerError {
+    constructor(operation: string, details?: string) {
+        super(
+            `Failed to ${operation} with docker-compose`,
+            details || 'Check docker-compose logs for more details:\n  docker-compose logs'
+        );
+        this.name = 'DockerComposeError';
+    }
+}
+
+/**
+ * File system errors
+ */
+export class FileSystemError extends OnboardingError {
+    constructor(message: string, public readonly path: string, troubleshooting?: string) {
+        super('FILESYSTEM_ERROR', message, troubleshooting);
+        this.name = 'FileSystemError';
+    }
+}
+
+export class DirectoryNotWritableError extends FileSystemError {
+    constructor(path: string) {
+        super(
+            `Directory is not writable: ${path}`,
+            path,
+            'Check directory permissions or choose a different directory'
+        );
+        this.name = 'DirectoryNotWritableError';
+    }
+}
+
+export class FileNotFoundError extends FileSystemError {
+    constructor(path: string) {
+        super(
+            `File not found: ${path}`,
+            path,
+            'Ensure the file exists or check the path'
+        );
+        this.name = 'FileNotFoundError';
+    }
+}
+
+/**
+ * Configuration errors
+ */
+export class ConfigurationError extends OnboardingError {
+    constructor(message: string, troubleshooting?: string) {
+        super('CONFIG_ERROR', message, troubleshooting);
+        this.name = 'ConfigurationError';
+    }
+}
+
+export class InvalidEnvironmentValueError extends ConfigurationError {
+    constructor(key: string, value: string, expectedFormat: string) {
+        super(
+            `Invalid value for ${key}: ${value}`,
+            `Expected format: ${expectedFormat}`
+        );
+        this.name = 'InvalidEnvironmentValueError';
+    }
+}
+
+export class PluginConfigurationError extends ConfigurationError {
+    constructor(pluginName: string, details: string) {
+        super(
+            `Failed to configure plugin ${pluginName}`,
+            details
+        );
+        this.name = 'PluginConfigurationError';
+    }
+}
+
+/**
+ * Service health errors
+ */
+export class ServiceHealthError extends OnboardingError {
+    constructor(serviceName: string, timeout: number) {
+        super(
+            'SERVICE_HEALTH_ERROR',
+            `Service '${serviceName}' did not become healthy within ${timeout}ms`,
+            `Check service logs:\n  docker-compose logs ${serviceName}\n\n` +
+            'Or check container status:\n  docker ps -a'
+        );
+        this.name = 'ServiceHealthError';
+    }
+}
+
+/**
+ * Type guard to check if an error is an OnboardingError
+ */
+export function isOnboardingError(error: unknown): error is OnboardingError {
+    return error instanceof OnboardingError;
+}
+
+/**
+ * Format error for user display
+ */
+export function formatErrorForUser(error: unknown): string {
+    if (isOnboardingError(error)) {
+        let message = `❌ ${error.message}`;
+        if (error.troubleshooting) {
+            message += `\n\n💡 Troubleshooting:\n${error.troubleshooting}`;
+        }
+        return message;
+    }
+    
+    if (error instanceof Error) {
+        return `❌ Unexpected error: ${error.message}`;
+    }
+    
+    return `❌ An unknown error occurred`;
+}

package/src/types/index.ts

@@ -1,2 +1,2 @@
-export * from './errors.js';
-export * from './domain.js';
+export * from './errors.js';
+export * from './domain.js';