Class InstallerEngine

Core orchestrator for MemberJunction installs.

Headless and event-driven — never writes to stdout. Frontends subscribe to typed events via InstallerEngine.On to render progress, handle prompts, and display diagnostics. Supports checkpoint/resume for long-running installs.

Example

const engine = new InstallerEngine();

// Subscribe to events
engine.On('phase:start', (e) => console.log(`Phase: ${e.Phase}`));
engine.On('step:progress', (e) => console.log(`  ${e.Message}`));
engine.On('error', (e) => console.error(e.Error.message));

// Create and execute a plan
const plan = await engine.CreatePlan({ Dir: '/app', Tag: 'v5.1.0' });
const result = await engine.Run(plan, { Verbose: true, Yes: true });

Index

Constructors

constructor

Methods

CreatePlan Doctor ListVersions Off On Resume Run

Constructors

constructor

new InstallerEngine(): InstallerEngine
Returns InstallerEngine

Methods

CreatePlan

CreatePlan(input: CreatePlanInput): Promise<InstallPlan>
Build an install plan (dry-run friendly — no side effects).

The plan describes which phases will run, which will be skipped, and with what configuration. It can be inspected before execution (e.g., with plan.Summarize()) or passed directly to Run.
Parameters
- input: CreatePlanInput
  Plan inputs including target directory, tag, skip flags, and config overrides.
Returns Promise<InstallPlan>
A new InstallPlan ready for execution or inspection.
- Defined in packages/MJInstaller/src/InstallerEngine.ts:184

Doctor

Doctor(targetDir: string, options?: DoctorOptions): Promise<Diagnostics>
Run diagnostics on an existing or target install directory.

Performs preflight checks (Node version, disk space, SQL connectivity, etc.) and known-issue detection. Does not modify any files. Results are returned as a Diagnostics object and also emitted as diagnostic events.
Parameters
- targetDir: string
  Absolute path to the directory to diagnose.
- Optionaloptions: DoctorOptions
  Optional doctor options (currently reserved for future use).
Returns Promise<Diagnostics>
Diagnostics with environment info, check results, and last install info.
- Defined in packages/MJInstaller/src/InstallerEngine.ts:424

ListVersions

ListVersions(includePrerelease?: boolean): Promise<VersionInfo[]>
List available MemberJunction release versions from GitHub.

Fetches releases from the MemberJunction GitHub repository using the unauthenticated REST API (60 requests/hour rate limit).
Parameters
- includePrerelease: boolean = false
  Whether to include pre-release tags (default: false).
Returns Promise<VersionInfo[]>
Array of available versions sorted by publish date (newest first).
- Defined in packages/MJInstaller/src/InstallerEngine.ts:170

Off

Off<K extends keyof InstallerEventMap>(
event: K,
handler: (...args: InstallerEventMap[K]) => void,
): void
Unsubscribe from installer events.
Type Parameters
- K extends keyof InstallerEventMap
  The event name.
Parameters
- event: K
  The event to stop listening for.
- handler: (...args: InstallerEventMap[K]) => void
  The same handler reference passed to On.
Returns void
- Defined in packages/MJInstaller/src/InstallerEngine.ts:157

On

On<K extends keyof InstallerEventMap>(
event: K,
handler: (...args: InstallerEventMap[K]) => void,
): void
Subscribe to installer events.
Type Parameters
- K extends keyof InstallerEventMap
  The event name (e.g., 'phase:start', 'step:progress', 'error').
Parameters
- event: K
  The event to listen for.
- handler: (...args: InstallerEventMap[K]) => void
  Callback invoked with the event payload.
Returns void
Example
```
engine.On('phase:end', (e) => {
  console.log(`${e.Phase} ${e.Status} in ${e.DurationMs}ms`);
});
```
- Defined in packages/MJInstaller/src/InstallerEngine.ts:146

Resume

Resume(stateFileDir: string, options?: RunOptions): Promise<InstallResult>
Resume a previously interrupted install from a checkpoint state file.

Loads the .mj-install-state.json from the given directory, reconstructs a plan from the saved tag, and calls Run with resume enabled.
Parameters
- stateFileDir: string
  Directory containing the .mj-install-state.json file.
- Optionaloptions: RunOptions
  Runtime options forwarded to Run.
Returns Promise<InstallResult>
Install result from the resumed execution.

Throws
With code NO_STATE_FILE if no checkpoint exists.
- Defined in packages/MJInstaller/src/InstallerEngine.ts:508

Run

Run(plan: InstallPlan, options?: RunOptions): Promise<InstallResult>
Execute an install plan, emitting events throughout.

Iterates through plan phases in order. Supports checkpoint/resume — if a previous install left a .mj-install-state.json, completed phases are skipped automatically. Pass NoResume: true in options to force a fresh start.

Stops on the first phase failure and returns partial results. The state file is updated after each phase, so re-running resumes from the failed phase.
Parameters
- plan: InstallPlan
  The install plan from CreatePlan.
- Optionaloptions: RunOptions
  Runtime options (verbose, yes, fast, no-resume, config overrides).
Returns Promise<InstallResult>
Install result with success status, duration, warnings, and phase lists.
- Defined in packages/MJInstaller/src/InstallerEngine.ts:219

Class InstallerEngine

Example

Index

Constructors

Methods

Constructors

constructor

Returns InstallerEngine

Methods

CreatePlan

Parameters

Returns Promise<InstallPlan>

Doctor

Parameters

Returns Promise<Diagnostics>

ListVersions

Parameters

Returns Promise<VersionInfo[]>

Off

Type Parameters

Parameters

Returns void

On

Type Parameters

Parameters

Returns void

Example

Resume

Parameters

Returns Promise<InstallResult>

Throws

Run

Parameters

Returns Promise<InstallResult>

Settings

On This Page