@simplens/onboard 1.0.8 → 1.0.10

package/src/templates.ts

@@ -1,278 +0,0 @@
-// Docker Compose templates as constants
-
-export const INFRA_COMPOSE_TEMPLATE = `
-services:
-  # ============================================
-  # Infrastructure Services
-  # ============================================
-  mongo:
-    image: mongo:7.0
-    container_name: mongo
-    command: [ "--replSet", "rs0", "--bind_ip_all", "--port", "27017" ]
-    ports:
-      - 27017:27017
-    healthcheck:
-      test: echo "try { rs.status() } catch (err) { rs.initiate({_id:'rs0',members:[{_id:0,host:'mongo:27017'}]}) }" | mongosh --port 27017 --quiet
-      interval: 5s
-      timeout: 30s
-      start_period: 0s
-      start_interval: 1s
-      retries: 30
-    volumes:
-      - "mongo_data:/data/db"
-      - "mongo_config:/data/configdb"
-
-  kafka:
-    image: apache/kafka-native
-    container_name: kafka
-    ports:
-      - "9092:9092"
-    environment:
-      # Configure listeners for both docker and host communication
-      KAFKA_LISTENERS: CONTROLLER://localhost:9091,HOST://0.0.0.0:9092,DOCKER://0.0.0.0:9093
-      KAFKA_ADVERTISED_LISTENERS: HOST://kafka:9092,DOCKER://kafka:9093
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: CONTROLLER:PLAINTEXT,DOCKER:PLAINTEXT,HOST:PLAINTEXT
-
-      # Settings required for KRaft mode
-      KAFKA_NODE_ID: 1
-      KAFKA_PROCESS_ROLES: broker,controller
-      KAFKA_CONTROLLER_LISTENER_NAMES: CONTROLLER
-      KAFKA_CONTROLLER_QUORUM_VOTERS: 1@localhost:9091
-
-      # Listener to use for broker-to-broker communication
-      KAFKA_INTER_BROKER_LISTENER_NAME: DOCKER
-
-      # Required for a single node cluster
-      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
-
-      # Disable auto-topic creation - API server will create topics with correct partitions
-      KAFKA_AUTO_CREATE_TOPICS_ENABLE: "false"
-    volumes:
-      - "kafka_data:/var/lib/kafka/data"
-
-  kafka-ui:
-    image: kafbat/kafka-ui:main
-    container_name: kafka-ui
-    ports:
-      - 8080:8080
-    environment:
-      DYNAMIC_CONFIG_ENABLED: "true"
-      KAFKA_CLUSTERS_0_NAME: local
-      KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: kafka:9093
-    depends_on:
-      - kafka
-
-  redis:
-    image: redis:7-alpine
-    container_name: redis
-    ports:
-      - "6379:6379"
-    command: redis-server --appendonly yes
-    volumes:
-      - "redis_data:/data"
-    healthcheck:
-      test: [ "CMD", "redis-cli", "ping" ]
-      interval: 5s
-      timeout: 3s
-      retries: 5
-
-  # ============================================
-  # Observability Services
-  # ============================================
-
-  loki:
-    image: grafana/loki:2.9.0
-    container_name: loki
-    ports:
-      - "3100:3100"
-    command: -config.file=/etc/loki/local-config.yaml
-    volumes:
-      - "loki_data:/loki"
-    healthcheck:
-      test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:3100/ready || exit 1" ]
-      interval: 10s
-      timeout: 5s
-      retries: 5
-
-  grafana:
-    image: grafana/grafana:10.2.0
-    container_name: grafana
-    ports:
-      - "3001:3000"
-    environment:
-      - GF_PATHS_PROVISIONING=/etc/grafana/provisioning
-      - GF_AUTH_ANONYMOUS_ENABLED=true
-      - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
-      - GF_SECURITY_ADMIN_PASSWORD=admin
-    volumes:
-      - "grafana_data:/var/lib/grafana"
-    depends_on:
-      loki:
-        condition: service_healthy
-
-volumes:
-  mongo_data:
-  mongo_config:
-  kafka_data:
-  redis_data:
-  loki_data:
-  grafana_data:
-`;
-
-export const APP_COMPOSE_TEMPLATE = `services:
-  api:
-    image: ghcr.io/simplenotificationsystem/simplens-core:\${CORE_VERSION:-latest}
-    container_name: api
-    ports:
-      - 3000:3000
-    env_file:
-      - .env
-    environment:
-      SIMPLENS_CONFIG_PATH: \${SIMPLENS_CONFIG_PATH:-/app/simplens.config.yaml}
-    volumes:
-      - plugin-data:/app/.plugins
-      - logs-data:/app/logs
-      - ./simplens.config.yaml:/app/simplens.config.yaml:ro
-    command: [ "node", "dist/api/server.js" ]
-    restart: unless-stopped
-    healthcheck:
-      test: [ "CMD", "node", "-e", "require('http').get('http://localhost:3000/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1)).on('error', () => process.exit(1))" ]
-      interval: 30s
-      timeout: 10s
-      retries: 3
-      start_period: 10s
-
-  worker:
-    image: ghcr.io/simplenotificationsystem/simplens-core:\${CORE_VERSION:-latest}
-    env_file:
-      - .env
-    volumes:
-      - logs-data:/app/logs
-    command: [ "node", "dist/workers/worker.js" ]
-    restart: unless-stopped
-
-  notification_processor:
-    image: ghcr.io/simplenotificationsystem/simplens-core:\${CORE_VERSION:-latest}
-    env_file:
-      - .env
-    environment:
-      SIMPLENS_CONFIG_PATH: \${SIMPLENS_CONFIG_PATH:-/app/simplens.config.yaml}
-    volumes:
-      - plugin-data:/app/.plugins
-      - logs-data:/app/logs
-      - ./simplens.config.yaml:/app/simplens.config.yaml:ro
-    command: [ "node", "dist/processors/unified/unified.processor.js" ]
-    depends_on:
-      api:
-        condition: service_healthy
-    restart: unless-stopped
-
-  delayed_processor:
-    image: ghcr.io/simplenotificationsystem/simplens-core:\${CORE_VERSION:-latest}
-    env_file:
-      - .env
-    volumes:
-      - logs-data:/app/logs
-    command: [ "node", "dist/processors/delayed/delayed.processor.js" ]
-    restart: unless-stopped
-
-  recovery:
-    image: ghcr.io/simplenotificationsystem/simplens-core:\${CORE_VERSION:-latest}
-    env_file:
-      - .env
-    volumes:
-      - logs-data:/app/logs
-    command: [ "node", "dist/workers/recovery/recovery.service.js" ]
-    restart: unless-stopped
-
-  dashboard:
-    image: ghcr.io/simplenotificationsystem/simplens-dashboard:\${DASHBOARD_VERSION:-latest}
-    ports:
-      - 3002:3002
-    container_name: dashboard
-    env_file:
-      - .env
-    environment:
-      PORT: \${DASHBOARD_PORT:-3002}
-      API_BASE_URL: http://api:\${PORT:-3000}
-      WEBHOOK_HOST: dashboard
-      WEBHOOK_PORT: \${DASHBOARD_PORT:-3002}
-    restart: unless-stopped
-
-volumes:
-  plugin-data:
-  logs-data:
-
-networks:
-  default:
-    name: simplens
-`;
-
-export const APP_NGINX_SERVICE_TEMPLATE = `  nginx:
-    image: nginx:alpine
-    container_name: nginx
-    ports:
-      - "80:80"
-    volumes:
-      - "./nginx.conf:/etc/nginx/conf.d/default.conf:ro"
-    depends_on:
-      - api
-      - dashboard
-    restart: unless-stopped`;
-
-export const APP_NGINX_SSL_SERVICE_TEMPLATE = `  nginx:
-    image: nginx:alpine
-    container_name: nginx
-    ports:
-      - "80:80"
-      - "443:443"
-    volumes:
-      - "./nginx.conf:/etc/nginx/conf.d/default.conf:ro"
-      - certbot-etc:/etc/letsencrypt
-      - certbot-www:/var/www/certbot
-    depends_on:
-      - api
-      - dashboard
-    restart: unless-stopped`;
-
-export const APP_CERTBOT_SERVICES_TEMPLATE = `  certbot:
-    image: certbot/certbot:latest
-    container_name: certbot
-    volumes:
-      - certbot-etc:/etc/letsencrypt
-      - certbot-www:/var/www/certbot
-    command: sh -c "trap exit TERM; while :; do sleep 86400; done"
-    restart: unless-stopped
-
-  certbot-renew:
-    image: docker:cli
-    container_name: certbot-renew
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-    depends_on:
-      - certbot
-      - nginx
-    command: sh -c "while :; do sleep 12h; docker exec certbot certbot renew --webroot -w /var/www/certbot --quiet && docker exec nginx nginx -s reload || true; done"
-    restart: unless-stopped`;
-
-export const INFRA_CERTBOT_SERVICES_TEMPLATE = `  certbot:
-    image: certbot/certbot:latest
-    container_name: certbot
-    volumes:
-      - certbot-etc:/etc/letsencrypt
-      - certbot-www:/var/www/certbot
-    command: sh -c "trap exit TERM; while :; do sleep 86400; done"
-    restart: unless-stopped
-
-  certbot-renew:
-    image: docker:cli
-    container_name: certbot-renew
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-    depends_on:
-      - certbot
-      - nginx
-    command: sh -c "while :; do sleep 12h; docker exec certbot certbot renew --webroot -w /var/www/certbot --quiet && docker exec nginx nginx -s reload || true; done"
-    restart: unless-stopped`;
-
-export const INFRA_CERTBOT_VOLUMES = ['certbot-etc', 'certbot-www'] as const;

package/src/types/domain.ts

@@ -1,135 +0,0 @@
-/**
- * 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;
-    /** Whether SSL automation with Certbot is enabled */
-    enableSsl?: boolean;
-    /** Public domain for SSL certificate */
-    sslDomain?: string;
-    /** Registration email for Let's Encrypt */
-    sslEmail?: 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 +0,0 @@
-/**
- * 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 (fallback: docker-compose)`,
-            details || 'Check service logs for more details:\n  docker compose logs\n  (fallback: 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  (fallback: 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 +0,0 @@
-export * from './errors.js';
-export * from './domain.js';

package/src/ui.ts

@@ -1,91 +0,0 @@
-/**
- * Centralized UI helpers — themed intro/outro and cancellation handling.
- * 
- * NOTE: Individual @clack/prompts functions (text, confirm, select, etc.)
- * should be imported directly from '@clack/prompts' in each consumer file.
- * Re-exporting from here causes TypeScript resolution issues with .d.mts types.
- */
-
-import { intro as clackIntro, outro as clackOutro, cancel as clackCancel, isCancel, log as clackLog, note as clackNote, spinner as clackSpinner } from '@clack/prompts';
-import chalk from 'chalk';
-import { getLoggerConfig } from './utils/logger.js';
-
-/**
- * Themed intro — blue bar
- */
-export function intro(title?: string): void {
-    if (getLoggerConfig().silent) return;
-    clackIntro(chalk.bgBlueBright.black(` ${title ?? ''} `));
-}
-
-/**
- * Themed outro — blue text
- */
-export function outro(message?: string): void {
-    if (getLoggerConfig().silent) return;
-    clackOutro(chalk.blueBright(message ?? 'Done'));
-}
-
-/**
- * Wrapped log functions that respect silent mode
- */
-export const log = {
-    step: (message: string) => {
-        if (getLoggerConfig().silent) return;
-        clackLog.step(message);
-    },
-    info: (message: string) => {
-        if (getLoggerConfig().silent) return;
-        clackLog.info(message);
-    },
-    warning: (message: string) => {
-        if (getLoggerConfig().silent) return;
-        clackLog.warning(message);
-    },
-    error: (message: string) => {
-        if (getLoggerConfig().silent) return;
-        clackLog.error(message);
-    },
-    success: (message: string) => {
-        if (getLoggerConfig().silent) return;
-        clackLog.success(message);
-    },
-};
-
-/**
- * Wrapped note function that respects silent mode
- */
-export function note(message: string, title?: string): void {
-    if (getLoggerConfig().silent) return;
-    clackNote(message, title);
-}
-
-/**
- * Wrapped spinner that respects silent mode
- * Returns a no-op spinner in silent mode
- */
-export function spinner() {
-    if (getLoggerConfig().silent) {
-        // Return a no-op spinner with all required methods
-        return {
-            start: () => {},
-            stop: () => {},
-            message: () => {},
-            error: () => {},
-        };
-    }
-    return clackSpinner();
-}
-
-/**
- * Handle user cancellation (Ctrl-C) for any prompt value.
- * Exits the process with code 0 after printing a message.
- */
-export function handleCancel(value: unknown, message = 'Setup cancelled.'): void {
-    if (isCancel(value)) {
-        if (!getLoggerConfig().silent) {
-            clackCancel(chalk.blueBright(message));
-        }
-        process.exit(0);
-    }
-}

package/src/utils/index.ts

@@ -1 +0,0 @@
-export * from './logger.js';