jishushell 0.6.5 → 0.6.18

package/dist/services/setup/setup-manager.d.ts

@@ -0,0 +1,158 @@
+import { type Task } from "../tasks/registry.js";
+export type ExpectedSystemFileFix = "none" | "system-reload" | "manual";
+export type ExpectedSystemInstallScope = "core" | "panel" | "nomad";
+export interface ExpectedSystemFile {
+    component: "wrapper" | "systemd" | "launchd" | "nomad";
+    id: string;
+    path: string;
+    content: string;
+    installScope: ExpectedSystemInstallScope;
+    requiresSudo: boolean;
+    reloadRequired: boolean;
+    fix: ExpectedSystemFileFix;
+}
+export declare function setServerPort(port: number): void;
+export declare function hasBundledPanel(): boolean;
+export declare function getExpectedCoreSystemFiles(port?: number): ExpectedSystemFile[];
+export declare function getExpectedPanelSystemFiles(corePort?: number, panelPort?: number): ExpectedSystemFile[];
+export declare function getExpectedNomadSystemFiles(): ExpectedSystemFile[];
+export declare function getExpectedSystemFiles(options?: {
+    corePort?: number;
+    panelPort?: number;
+    includePanel?: boolean;
+    includeNomad?: boolean;
+}): ExpectedSystemFile[];
+export { createTask, emitTask, getTask, getTaskSnapshot, getRunningTasks, subscribeTask, } from "../tasks/registry.js";
+export type { Task, TaskEvent, TaskSnapshot } from "../tasks/registry.js";
+/** Run a shell command as a spawned process, streaming output to a task */
+export declare function spawnWithTask(task: Task, cmd: string, args: string[], options?: {
+    timeout?: number;
+    env?: Record<string, string>;
+    cwd?: string;
+    progressParser?: (line: string) => number | null;
+}): Promise<{
+    ok: boolean;
+    output: string;
+}>;
+export declare function npmProgressParser(line: string): number | null;
+export declare function dockerBuildProgressParser(line: string): number | null;
+export declare function getDirSizeMB(dir: string): number;
+export interface DependencyStatus {
+    name: string;
+    installed: boolean;
+    running: boolean;
+    version: string;
+    path: string;
+    error?: string;
+    needsUpgrade?: boolean;
+}
+export interface SetupStatus {
+    node: DependencyStatus;
+    docker: DependencyStatus;
+    nomad: DependencyStatus;
+    openclaw: DependencyStatus;
+    ready: boolean;
+    providerConfigured: boolean;
+    runtimeImageReady: boolean;
+    hasSudo: boolean;
+    /** True when cgroup memory was just enabled and a reboot is needed for Docker memory stats */
+    needsReboot?: boolean;
+    /** Currently running setup tasks (so frontend can resume polling after refresh) */
+    runningTasks?: Array<{
+        id: string;
+        name: string;
+    }>;
+    /**
+     * Per-runtime install status, keyed by kind. Populated by iterating
+     * over `listRegisteredIntegrations()` and calling each integration's
+     * `getInstallStatus()`.
+     */
+    runtimes?: Record<string, {
+        installed: boolean;
+        imageReady: boolean;
+        version?: string;
+        digest?: string;
+        /**
+         * Mirror of `manifest.requiredForSetupReady`. The Setup wizard must gate overall
+         * completion on required runtimes only; optional runtimes
+         * (the default for third-party agents) stay advertised in the UI
+         * but do not block progress when absent.
+         */
+        required: boolean;
+    }>;
+}
+/** Enable cgroup memory in boot cmdline if not already enabled. Returns true if a reboot is needed. */
+export declare function ensureCgroupMemory(): boolean;
+export declare function getSetupStatus(): Promise<SetupStatus>;
+export interface InstallResult {
+    ok: boolean;
+    message: string;
+    error?: string;
+    taskId?: string;
+    needsReboot?: boolean;
+}
+export declare function upgradeNode(targetMajor?: number): Promise<InstallResult>;
+export declare function installDocker(): Promise<InstallResult>;
+export declare function startInstallDocker(): InstallResult;
+export declare function installNomad(): Promise<InstallResult>;
+export declare function buildExpectedNomadConfigContent(): string;
+export declare function loadNomadToken(): void;
+export declare function ensureNomadMemoryOversubscriptionEnabled(): Promise<void>;
+export declare function startNomad(): Promise<InstallResult>;
+export declare function stopNomad(): Promise<InstallResult>;
+export declare function installNomadSystemd(): InstallResult;
+export declare function installJishushellSystemd(port?: number, startNow?: boolean): InstallResult;
+export declare function installJishushellPanelSystemd(corePort?: number, panelPort?: number, startNow?: boolean): InstallResult;
+/**
+ * Install OpenClaw runtime — thin dispatch wrapper.
+ *
+ * The heavy lifting lives in `OpenClawIntegration.installRuntime()`.
+ * This wrapper is kept only for back-compat with the existing
+ * `routes/setup.ts` endpoint and the CLI installer.
+ */
+export declare function installOpenclaw(version?: string): Promise<InstallResult>;
+/**
+ * Capture the immutable digest of a locally-present image so HermesIntegration
+ * can pin via digest rather than the mutable tag. Returns undefined if the
+ * image has no RepoDigests (e.g. locally-built image) — caller may still
+ * proceed using the tag alone.
+ */
+export declare function captureImageDigest(imageRef: string): string | undefined;
+/**
+ * Install Hermes runtime — thin dispatch wrapper.
+ *
+ * Heavy lifting lives in `HermesIntegration.installRuntime()`.
+ */
+export declare function installHermes(): Promise<InstallResult>;
+/**
+ * Non-blocking variant — returns a task id immediately. Implementation
+ * dispatches via `HermesIntegration.startInstallRuntime()`.
+ */
+export declare function startInstallHermes(): InstallResult;
+/** Helper for setup status — true when Hermes has a persisted runtime install record. */
+export declare function isHermesInstalled(): boolean;
+export type DockerInvocation = {
+    cmd: string;
+    argsPrefix: string[];
+};
+export declare function resolveDockerInvocation(): DockerInvocation;
+/** Blocking: pull or build the OpenClaw docker image. */
+export declare function buildSlimOpenclawImage(tag?: string): Promise<InstallResult>;
+/** Non-blocking: returns immediately with a task id for SSE polling. */
+export declare function startBuildSlimOpenclawImage(tag?: string): InstallResult;
+/** @deprecated Use buildSlimOpenclawImage instead */
+export declare function buildCustomOpenclawImage(tag?: string): Promise<InstallResult>;
+/** @deprecated Use startBuildSlimOpenclawImage instead */
+export declare function startBuildCustomOpenclawImage(tag?: string): InstallResult;
+export interface SetupProgress {
+    step: string;
+    status: "pending" | "running" | "done" | "error";
+    message: string;
+}
+export declare function runFullSetup(options?: {
+    installNomad?: boolean;
+    buildDockerImage?: boolean;
+}): Promise<{
+    ok: boolean;
+    steps: SetupProgress[];
+}>;