devchain-cli 0.23.4 → 0.24.1

package/dist/server/modules/remotes/operations/remote-host.client.d.ts

@@ -0,0 +1,607 @@
+import { RemoteApiKeyService } from '../auth/remote-api-key.service';
+import { type HostProviderCliSettings, type HostProviderCliSettingsStatus } from '@devchain/shared';
+import { Readable } from 'node:stream';
+import { DockerVersion } from '../../core/controllers/docker-engine.client';
+import { type DockerArchiveRequest, type DockerArchiveWriteResult, type DockerBindPrepare, type DockerCapacityResult, type DockerContainerCreate, type DockerHostOptions, type DockerImageLoadResult, type DockerNetworkCreate, type DockerScanResult, type DockerVolumeCreate, type DockerVolumeHolder } from '../host/host-docker.dto';
+import { TranscriptFilesService } from '../transcripts/transcript-files.service';
+import { type TranscriptFile, type TranscriptRef, type TranscriptListing } from '../transcripts/transcript-transfer.dto';
+import { z } from 'zod';
+import { type HostSkillSettings, type HostSkillSettingsStatus, type ProjectReplicaChanges, type ProjectReplicaOfScope, type ProjectReplicaV1 } from '@devchain/shared';
+import { AppError } from '../../../common/errors/error-types';
+import { type FrozenProject, type RemoteStorage } from '../../storage/interfaces/storage.interface';
+import { type ProjectTimeSettlement } from '../time/project-time-settler.service';
+import { type FolderSyncStatus, type SyncDevice, type SyncFolder, type SyncFolderPatch, type SyncFolderRequest } from '../../file-sync/file-sync.dto';
+import type { ProviderAuthClaimBundle } from '../../provider-auth/provider-auth-adapters';
+import type { HostProviderApplyInput } from '../host/host-provider-auth.service';
+declare const HostRuntimeSchema: z.ZodObject<{
+    state: z.ZodOptional<z.ZodString>;
+    bootId: z.ZodOptional<z.ZodString>;
+    docker: z.ZodOptional<z.ZodObject<{
+        installed: z.ZodBoolean;
+        engineVersion: z.ZodNullable<z.ZodString>;
+        composeVersion: z.ZodNullable<z.ZodString>;
+        userInGroup: z.ZodBoolean;
+        dataRootFreeBytes: z.ZodNullable<z.ZodNumber>;
+        capacity: z.ZodOptional<z.ZodObject<{
+            dockerRoot: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            imageStore: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            home: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    homePath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    uid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    gid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    cliVersions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    state: z.ZodOptional<z.ZodString>;
+    bootId: z.ZodOptional<z.ZodString>;
+    docker: z.ZodOptional<z.ZodObject<{
+        installed: z.ZodBoolean;
+        engineVersion: z.ZodNullable<z.ZodString>;
+        composeVersion: z.ZodNullable<z.ZodString>;
+        userInGroup: z.ZodBoolean;
+        dataRootFreeBytes: z.ZodNullable<z.ZodNumber>;
+        capacity: z.ZodOptional<z.ZodObject<{
+            dockerRoot: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            imageStore: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            home: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    homePath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    uid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    gid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    cliVersions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    state: z.ZodOptional<z.ZodString>;
+    bootId: z.ZodOptional<z.ZodString>;
+    docker: z.ZodOptional<z.ZodObject<{
+        installed: z.ZodBoolean;
+        engineVersion: z.ZodNullable<z.ZodString>;
+        composeVersion: z.ZodNullable<z.ZodString>;
+        userInGroup: z.ZodBoolean;
+        dataRootFreeBytes: z.ZodNullable<z.ZodNumber>;
+        capacity: z.ZodOptional<z.ZodObject<{
+            dockerRoot: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            imageStore: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+            home: z.ZodNullable<z.ZodObject<{
+                path: z.ZodString;
+                filesystemId: z.ZodString;
+                freeBytes: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }, {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }, {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }, {
+        installed: boolean;
+        engineVersion: string | null;
+        composeVersion: string | null;
+        userInGroup: boolean;
+        dataRootFreeBytes: number | null;
+        capacity?: {
+            dockerRoot: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            imageStore: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+            home: {
+                path: string;
+                filesystemId: string;
+                freeBytes: number;
+            } | null;
+        } | undefined;
+    }>>;
+    version: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    homePath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    uid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    gid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    imageVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    cliVersions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, z.ZodTypeAny, "passthrough">>;
+export type HostRuntime = z.infer<typeof HostRuntimeSchema>;
+declare const HostProviderVerifySchema: z.ZodObject<{
+    ok: z.ZodBoolean;
+    summary: z.ZodString;
+    hint: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    ok: boolean;
+    summary: string;
+    hint: string | null;
+}, {
+    ok: boolean;
+    summary: string;
+    hint: string | null;
+}>;
+export type HostProviderVerify = z.infer<typeof HostProviderVerifySchema>;
+declare const HostUpdateStatusBodySchema: z.ZodObject<{
+    status: z.ZodNullable<z.ZodObject<Omit<{
+        state: z.ZodEnum<["pending", "installing", "installing_clis", "restarting", "done", "failed"]>;
+        version: z.ZodString;
+        error: z.ZodOptional<z.ZodString>;
+        at: z.ZodString;
+    }, "at">, "passthrough", z.ZodTypeAny, z.objectOutputType<Omit<{
+        state: z.ZodEnum<["pending", "installing", "installing_clis", "restarting", "done", "failed"]>;
+        version: z.ZodString;
+        error: z.ZodOptional<z.ZodString>;
+        at: z.ZodString;
+    }, "at">, z.ZodTypeAny, "passthrough">, z.objectInputType<Omit<{
+        state: z.ZodEnum<["pending", "installing", "installing_clis", "restarting", "done", "failed"]>;
+        version: z.ZodString;
+        error: z.ZodOptional<z.ZodString>;
+        at: z.ZodString;
+    }, "at">, z.ZodTypeAny, "passthrough">>>;
+}, "strip", z.ZodTypeAny, {
+    status: z.objectOutputType<Omit<{
+        state: z.ZodEnum<["pending", "installing", "installing_clis", "restarting", "done", "failed"]>;
+        version: z.ZodString;
+        error: z.ZodOptional<z.ZodString>;
+        at: z.ZodString;
+    }, "at">, z.ZodTypeAny, "passthrough"> | null;
+}, {
+    status: z.objectInputType<Omit<{
+        state: z.ZodEnum<["pending", "installing", "installing_clis", "restarting", "done", "failed"]>;
+        version: z.ZodString;
+        error: z.ZodOptional<z.ZodString>;
+        at: z.ZodString;
+    }, "at">, z.ZodTypeAny, "passthrough"> | null;
+}>;
+export type HostUpdateProgress = NonNullable<z.infer<typeof HostUpdateStatusBodySchema>['status']>;
+export interface HostClaimRequest {
+    userName: string;
+    homePath: string;
+    uid?: number;
+    version: string;
+    port: number;
+    providerAuth: ProviderAuthClaimBundle;
+}
+export type HostClaimOutcome = 'claimed' | 'starting' | 'already_claimed';
+export interface HostEpicCreate {
+    projectId: string;
+    statusId: string;
+    title: string;
+    description: string | null;
+    data: Record<string, unknown> | null;
+}
+export declare class RemoteHostRequestError extends AppError {
+    constructor(message: string, details: {
+        remoteId: string;
+        path: string;
+        status: number | null;
+        hostCode: string | null;
+    });
+    get status(): number | null;
+}
+export type HostImportOutcome = {
+    imported: true;
+    cursor: string;
+} | {
+    imported: false;
+    reason: 'PROJECT_EXISTS';
+};
+export declare class RemoteHostClient {
+    private readonly storage;
+    private readonly apiKeys;
+    constructor(storage: RemoteStorage, apiKeys: RemoteApiKeyService);
+    private dockerClient;
+    private dockerCall;
+    private dockerJson;
+    dockerScan(remoteId: string, paths: string[], options?: DockerHostOptions, volumes?: string[]): Promise<DockerScanResult>;
+    dockerCapacity(remoteId: string, paths: string[], options?: DockerHostOptions): Promise<DockerCapacityResult>;
+    dockerImagesPresent(remoteId: string, ids: string[], options?: DockerHostOptions): Promise<{
+        ids: string[];
+    }>;
+    dockerCreateVolume(remoteId: string, input: DockerVolumeCreate, options?: DockerHostOptions): Promise<{
+        Name: string;
+        Labels?: Record<string, string>;
+    }>;
+    dockerCreateNetwork(remoteId: string, input: DockerNetworkCreate, options?: DockerHostOptions): Promise<{
+        Id: string;
+        created: boolean;
+    }>;
+    dockerCreateContainer(remoteId: string, input: DockerContainerCreate, options?: DockerHostOptions): Promise<{
+        Id: string;
+    }>;
+    dockerVolumeHolders(remoteId: string, name: string, options?: DockerHostOptions): Promise<{
+        holders: DockerVolumeHolder[];
+    }>;
+    dockerDelete(remoteId: string, kind: 'volumes' | 'containers' | 'networks', id: string, projectId: string, options?: DockerHostOptions): Promise<void>;
+    dockerSaveImage(remoteId: string, id: string, options?: DockerHostOptions): Promise<Readable>;
+    dockerReadArchive(remoteId: string, input: DockerArchiveRequest, options?: DockerHostOptions): Promise<{
+        archive: Readable;
+        sha256: () => string | null;
+    }>;
+    dockerStopContainer(remoteId: string, id: string, projectId: string, options?: DockerHostOptions): Promise<void>;
+    dockerLoadImage(remoteId: string, body: Readable, options?: DockerHostOptions): Promise<DockerImageLoadResult>;
+    dockerWriteArchive(remoteId: string, input: DockerArchiveRequest, body: Readable, options?: DockerHostOptions): Promise<DockerArchiveWriteResult>;
+    dockerPrepareBinds(remoteId: string, input: DockerBindPrepare, options?: DockerHostOptions): Promise<void>;
+    dockerStopProject(remoteId: string, projectId: string, options?: DockerHostOptions): Promise<{
+        stopped: string[];
+    }>;
+    dockerProbe(remoteId: string, body: Readable, options?: DockerHostOptions): Promise<void>;
+    private dockerUpload;
+    dockerVersion(remoteId: string, options?: DockerHostOptions): Promise<DockerVersion>;
+    listTranscripts(remoteId: string, refs: TranscriptRef[]): Promise<TranscriptListing>;
+    uploadTranscript(remoteId: string, file: TranscriptFile, files: TranscriptFilesService, signal?: AbortSignal): Promise<void>;
+    downloadTranscript(remoteId: string, file: TranscriptFile, files: TranscriptFilesService, signal?: AbortSignal): Promise<void>;
+    private transferTranscript;
+    projectExists(remoteId: string, projectId: string): Promise<boolean>;
+    importProject(remoteId: string, replica: ProjectReplicaV1): Promise<HostImportOutcome>;
+    exportReplica<S extends 'attach' | 'detach'>(remoteId: string, projectId: string, scope: S): Promise<ProjectReplicaOfScope<S>>;
+    changes(remoteId: string, projectId: string, options: {
+        since: string | null;
+        full: boolean;
+    }): Promise<ProjectReplicaChanges>;
+    freeze(remoteId: string, projectId: string): Promise<FrozenProject>;
+    thaw(remoteId: string, projectId: string): Promise<void>;
+    stopSessions(remoteId: string, projectId: string): Promise<void>;
+    settleTime(remoteId: string, projectId: string): Promise<ProjectTimeSettlement>;
+    release(remoteId: string, projectId: string): Promise<void>;
+    findEpicByIdempotencyKey(remoteId: string, projectId: string, key: string): Promise<string | null>;
+    createEpic(remoteId: string, epic: HostEpicCreate): Promise<{
+        id: string;
+    }>;
+    syncDevice(remoteId: string): Promise<SyncDevice>;
+    syncPeer(remoteId: string, peer: SyncDevice): Promise<void>;
+    syncFolders(remoteId: string, folder: SyncFolderRequest): Promise<SyncFolder>;
+    syncFolderType(remoteId: string, folderId: string, patch: SyncFolderPatch): Promise<void>;
+    syncRemoveFolder(remoteId: string, folderId: string): Promise<void>;
+    syncScan(remoteId: string, folderId: string): Promise<void>;
+    syncRevert(remoteId: string, folderId: string): Promise<void>;
+    syncStatus(remoteId: string, folderId: string, deviceId?: string): Promise<FolderSyncStatus>;
+    setInstanceLabel(remoteId: string, label: string): Promise<void>;
+    remoteRuntime(remoteId: string): Promise<HostRuntime>;
+    certificateOf(remoteId: string): Promise<string>;
+    runtimeAt(baseUrl: string, certificate: string): Promise<HostRuntime>;
+    discoverRuntime(origin: string): Promise<{
+        runtime: HostRuntime | null;
+        certificate: string;
+    }>;
+    claim(bootstrapUrl: string, certificate: string, body: HostClaimRequest, apiKey?: string): Promise<HostClaimOutcome>;
+    verifyProviderAuth(remoteId: string, provider: string, opencodeProviderIds: string[]): Promise<HostProviderVerify>;
+    applyProviderAuth(remoteId: string, bundle: HostProviderApplyInput): Promise<void>;
+    applySshKeys(remoteId: string, keys: string[]): Promise<void>;
+    requestHostUpdate(remoteId: string, version: string): Promise<'started' | 'in_progress'>;
+    hostUpdateStatus(remoteId: string): Promise<HostUpdateProgress | null>;
+    requestDocker(remoteId: string): Promise<{
+        jobId: string | null;
+    }>;
+    dockerStatus(remoteId: string): Promise<{
+        state: "installing" | "failed" | "done" | "pending" | "restarting";
+        at: string;
+        jobId: string;
+        error?: string | undefined;
+        code?: string | undefined;
+    } | null>;
+    getProviderCliSettingsStatus(remoteId: string): Promise<HostProviderCliSettingsStatus>;
+    putProviderCliSettings(remoteId: string, body: HostProviderCliSettings): Promise<void>;
+    checkProviderClis(remoteId: string): Promise<void>;
+    getSkillSettingsStatus(remoteId: string): Promise<HostSkillSettingsStatus>;
+    putSkillSettings(remoteId: string, body: HostSkillSettings): Promise<void>;
+    uploadSkillSourceContent(remoteId: string, name: string, contentHash: string, stream: Readable, signal?: AbortSignal): Promise<void>;
+    private hostSettingsRequest;
+    private request;
+    private fetchUrl;
+}
+export declare function dialAddress(address: string, baseUrl: string): string;
+export {};