Member Junction
    Preparing search index...

    Module @memberjunction/installer

    @memberjunction/installer — Public API surface.

    Headless, event-driven installer engine for MemberJunction. This barrel module re-exports every public type needed by consumer packages:

    Category Key exports
    Engine InstallerEngine
    Events InstallerEventEmitter, event payload types
    Errors InstallerError, PhaseId
    Models InstallPlan, InstallState, Diagnostics
    Adapters GitHubReleaseProvider, FileSystemAdapter, etc.
    Phases All 9 phase classes with their context/result types

    Primary consumers:

    • @memberjunction/cli — the mj install and mj doctor commands.
    • VSCode MemberJunction extension (planned).
    • Docker/CI automation scripts.
    import { InstallerEngine } from '@memberjunction/installer';

    const engine = new InstallerEngine();
    engine.On('phase:start', (e) => console.log(`Starting ${e.Phase}...`));
    engine.On('error', (e) => console.error(e.Error.message));

    const plan = await engine.CreatePlan({ Dir: '/app', Tag: 'latest' });
    const result = await engine.Run(plan, { Yes: true });
    console.log(result.Success ? 'Install complete!' : 'Install failed.');
    • InstallerEngine — the main entry point for programmatic installs.
    • InstallerEventEmitter — the typed event system for progress reporting.

    Classes

    CodeGenPhase
    ConfigurePhase
    DatabaseProvisionPhase
    DependencyPhase
    Diagnostics
    DistributionAssembler
    EventLogger
    FileSystemAdapter
    GitHubReleaseProvider
    InstallerEngine
    InstallerError
    InstallerEventEmitter
    InstallPlan
    InstallState
    MigratePhase
    PlatformCompatPhase
    PreflightPhase
    ProcessRunner
    RepoFetcher
    ReportGenerator
    ScaffoldPhase
    SmokeTestPhase
    SqlServerAdapter

    Interfaces

    AssembleOptions
    CodeGenContext
    CodeGenResult
    ConfigureContext
    ConfigureResult
    CreateBundleOptions
    CreateBundleResult
    CreatePlanInput
    DatabaseProvisionContext
    DatabaseProvisionResult
    DependencyContext
    DependencyResult
    DiagnosticCheck
    DiagnosticEvent
    DoctorOptions
    EnvironmentInfo
    ErrorEvent
    InstallConfig
    InstallerEventMap
    InstallResult
    InstallStateData
    KnownIssueDiagnostic
    KnownIssuePatch
    LastInstallInfo
    LogEntry
    LogEvent
    MigrateContext
    MigrateResult
    PhaseEndEvent
    PhaseInfo
    PhaseStartEvent
    PhaseState
    PlatformCompatContext
    PlatformCompatResult
    PreflightContext
    PreflightResult
    ProcessOptions
    ProcessResult
    PromptEvent
    ReportData
    RunOptions
    ScaffoldContext
    ScaffoldResult
    SmokeTestContext
    SmokeTestResult
    SparseFetchOptions
    SparseFetchResult
    SqlConnectivityResult
    StepProgressEvent
    VersionInfo
    WarnEvent

    Type Aliases

    DbPlatform
    DiagnosticStatus
    InstallerEvent
    InstallerEventHandler
    InstallerEventType
    LogLevel
    PartialInstallConfig
    PhaseId
    PhaseStatus
    WriteOp

    Variables

    InstallConfigDefaults

    Functions

    createDistributionBundle
    distributionSourcePaths
    loadConfigFile
    mergeConfigs
    resolveFromEnvironment