@highstate/backend 0.7.1 → 0.7.3

package/dist/index.d.ts

@@ -1,760 +0,0 @@
-import { z } from 'zod';
-import { WhoAmIResult, Stack, ConfigMap } from '@pulumi/pulumi/automation';
-import { Logger } from 'pino';
-import { ComponentModel, Entity, InstanceModel, CompositeInstance, UnitSource } from '@highstate/contract';
-import { H as HubModel, I as InstanceModelPatch, a as HubModelPatch, P as ProjectOperation, b as InstanceState, T as TerminalSession, c as InstanceStatus, d as InstanceStatePatch, e as InstancePageBlock, f as InstanceTerminal, g as ProjectOperationRequest } from './terminal-Cm2WqcyB.js';
-import { BetterLock } from 'better-lock/dist/better_lock';
-import { Stream, Writable } from 'node:stream';
-
-declare class SecretAccessDeniedError extends Error {
-    constructor(projectId: string, key: string);
-}
-interface SecretBackend {
-    /**
-     * Check if the state and secrets of the project are locked.
-     * The backend may not implement this method.
-     *
-     * @param projectId The ID of the project.
-     *
-     * @returns `true` if the project is locked, `false` if the project is unlocked.
-     */
-    isLocked?(projectId: string): Promise<boolean>;
-    /**
-     * Unlock the state and secrets of the project.
-     * The backend may not implement this method.
-     *
-     * @param projectId The ID of the project.
-     * @param password The password to unlock the secrets.
-     *
-     * @returns `true` if the project is unlocked, `false` if the password is incorrect.
-     */
-    unlock?(projectId: string, password: string): Promise<boolean>;
-    /**
-     * Get the secrets of the component.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     *
-     * @returns A record of secret key-value pairs or `null` if the secrets are not found.
-     * @throws {SecretAccessDeniedError} If access to the secrets is denied.
-     */
-    get(projectId: string, instanceId: string): Promise<Record<string, unknown>>;
-    /**
-     * Set the secrets of the component.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     * @param values The record of secret key-value pairs.
-     *
-     * @throws {SecretAccessDeniedError} If access to the secrets is denied.
-     */
-    set(projectId: string, instanceId: string, values: Record<string, unknown>): Promise<void>;
-}
-
-type RunOptions = {
-    projectId: string;
-    pulumiProjectName: string;
-    pulumiStackName: string;
-    envVars?: Record<string, string>;
-};
-type RunLocalOptions = RunOptions & {
-    projectPath: string;
-    stackConfig?: ConfigMap;
-};
-declare class LocalPulumiHost {
-    private readonly logger;
-    private lock;
-    private constructor();
-    getCurrentUser(): Promise<WhoAmIResult | null>;
-    runEmpty<T>(options: RunOptions, fn: (stack: Stack) => Promise<T>): Promise<T>;
-    runLocal<T>(options: RunLocalOptions, fn: (stack: Stack) => Promise<T>): Promise<T>;
-    private sharedPassword;
-    private passwords;
-    hasPassword(projectId: string): boolean;
-    setPassword(projectId: string, password: string): void;
-    removePassword(projectId: string): void;
-    private getPassword;
-    tryUnlockStack(stack: Stack, error: unknown): Promise<boolean>;
-    static create(logger: Logger): LocalPulumiHost;
-}
-
-declare const secretBackendConfig: z.ZodObject<{
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_SECRET_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-}, "strip", z.ZodTypeAny, {
-    HIGHSTATE_BACKEND_SECRET_TYPE: "local";
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME?: string | undefined;
-}, {
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_TYPE?: "local" | undefined;
-}>;
-declare function createSecretBackend(config: z.infer<typeof secretBackendConfig>, localPulumiHost: LocalPulumiHost, logger: Logger): Promise<SecretBackend>;
-
-type LibraryModel = Readonly<{
-    components: Readonly<Record<string, ComponentModel>>;
-    entities: Readonly<Record<string, Entity>>;
-}>;
-interface LibraryBackend {
-    /**
-     * Loads the library.
-     */
-    loadLibrary(): Promise<LibraryModel>;
-    /**
-     * Watches the library for changes.
-     * Returns an async iterable that emits the library whenever it changes.
-     */
-    watchLibrary?(signal?: AbortSignal): AsyncIterable<LibraryModel>;
-    /**
-     * Evaluates the instances and returns the evaluated composite instances.
-     *
-     * @param allInstances The all instances defined in the project.
-     * @param instanceIds The instance IDs to evaluate.
-     */
-    evaluateCompositeInstances(allInstances: InstanceModel[], instanceIds: string[]): Promise<readonly CompositeInstance[]>;
-    /**
-     * Evaluates the modules and returns the evaluated instances.
-     *
-     * @param modulePaths The module paths to evaluate.
-     */
-    evaluateModules(modulePaths: string[]): Promise<readonly InstanceModel[]>;
-}
-
-declare const libraryBackendConfig: z.ZodObject<{
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES: z.ZodDefault<z.ZodEffects<z.ZodString, string[], string>>;
-    HIGHSTATE_BACKEND_LIBRARY_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-}, "strip", z.ZodTypeAny, {
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES: string[];
-    HIGHSTATE_BACKEND_LIBRARY_TYPE: "local";
-}, {
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES?: string | undefined;
-    HIGHSTATE_BACKEND_LIBRARY_TYPE?: "local" | undefined;
-}>;
-declare function createLibraryBackend(config: z.infer<typeof libraryBackendConfig>, logger: Logger): LibraryBackend;
-
-declare const configSchema: z.ZodObject<{
-    HIGHSTATE_BACKEND_LOGGER_NAME: z.ZodDefault<z.ZodString>;
-    HIGHSTATE_BACKEND_LOGGER_LEVEL: z.ZodDefault<z.ZodEnum<["fatal", "error", "warn", "info", "debug", "trace"]>>;
-    HIGHSTATE_BACKEND_WORKSPACE_LOCAL_DIR: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_WORKSPACE_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY: z.ZodDefault<z.ZodString>;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE: z.ZodDefault<z.ZodEnum<["docker"]>>;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_SOURCE_CHECK: z.ZodDefault<z.ZodBoolean>;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_STATE_CHECK: z.ZodDefault<z.ZodBoolean>;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_PRINT_OUTPUT: z.ZodDefault<z.ZodBoolean>;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SOURCE_BASE_PATH: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_CACHE_DIR: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_RUNNER_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-    HIGHSTATE_BACKEND_STATE_LOCAL_DIR: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_STATE_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_SECRET_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-    HIGHSTATE_BACKEND_PROJECT_PROJECTS_DIR: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_PROJECT_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES: z.ZodDefault<z.ZodEffects<z.ZodString, string[], string>>;
-    HIGHSTATE_BACKEND_LIBRARY_TYPE: z.ZodDefault<z.ZodEnum<["local"]>>;
-}, "strip", z.ZodTypeAny, {
-    HIGHSTATE_BACKEND_SECRET_TYPE: "local";
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES: string[];
-    HIGHSTATE_BACKEND_LIBRARY_TYPE: "local";
-    HIGHSTATE_BACKEND_PROJECT_TYPE: "local";
-    HIGHSTATE_BACKEND_STATE_TYPE: "local";
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_SOURCE_CHECK: boolean;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_STATE_CHECK: boolean;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_PRINT_OUTPUT: boolean;
-    HIGHSTATE_BACKEND_RUNNER_TYPE: "local";
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY: string;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE: "docker";
-    HIGHSTATE_BACKEND_WORKSPACE_TYPE: "local";
-    HIGHSTATE_BACKEND_LOGGER_NAME: string;
-    HIGHSTATE_BACKEND_LOGGER_LEVEL: "fatal" | "error" | "warn" | "info" | "debug" | "trace";
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME?: string | undefined;
-    HIGHSTATE_BACKEND_PROJECT_PROJECTS_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_STATE_LOCAL_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SOURCE_BASE_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_CACHE_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST?: string | undefined;
-    HIGHSTATE_BACKEND_WORKSPACE_LOCAL_DIR?: string | undefined;
-}, {
-    HIGHSTATE_BACKEND_SECRET_PROJECT_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_PROJECT_NAME?: string | undefined;
-    HIGHSTATE_BACKEND_SECRET_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_LIBRARY_LOCAL_MODULES?: string | undefined;
-    HIGHSTATE_BACKEND_LIBRARY_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_PROJECT_PROJECTS_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_PROJECT_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_STATE_LOCAL_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_STATE_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_SOURCE_CHECK?: boolean | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SKIP_STATE_CHECK?: boolean | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_PRINT_OUTPUT?: boolean | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_SOURCE_BASE_PATH?: string | undefined;
-    HIGHSTATE_BACKEND_RUNNER_LOCAL_CACHE_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_RUNNER_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY?: string | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST?: string | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE?: "docker" | undefined;
-    HIGHSTATE_BACKEND_WORKSPACE_LOCAL_DIR?: string | undefined;
-    HIGHSTATE_BACKEND_WORKSPACE_TYPE?: "local" | undefined;
-    HIGHSTATE_BACKEND_LOGGER_NAME?: string | undefined;
-    HIGHSTATE_BACKEND_LOGGER_LEVEL?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | undefined;
-}>;
-type Config = z.infer<typeof configSchema>;
-declare function loadConfig(env?: NodeJS.ProcessEnv, useDotenv?: boolean): Promise<Config>;
-
-type ProjectModel = {
-    instances: InstanceModel[];
-    hubs: HubModel[];
-};
-interface ProjectBackend {
-    /**
-     * List the names of the available projects.
-     */
-    getProjectNames(): Promise<string[]>;
-    /**
-     * Get the instances and hubs of the project.
-     *
-     * @param projectId The ID of the project.
-     */
-    getProject(projectId: string): Promise<ProjectModel>;
-    /**
-     * Create an empty project.
-     *
-     * @param projectId The ID of the project.
-     */
-    createProject(projectId: string): Promise<void>;
-    /**
-     * Create the instance of the project.
-     *
-     * @param projectId The ID of the project.
-     * @param instance The instance to update.
-     */
-    createInstance(projectId: string, instance: InstanceModel): Promise<InstanceModel>;
-    /**
-     * Rename the instance of the project.
-     * Changes its id and updates all references to the instance.
-     * Potentially dangerous, but safe when the instance is not yet created.
-     */
-    renameInstance(projectId: string, instanceId: string, newName: string): Promise<InstanceModel>;
-    /**
-     * Patches the instance of the project.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance to update.
-     * @param patch The patch to apply to the instance.
-     */
-    updateInstance(projectId: string, instanceId: string, patch: InstanceModelPatch): Promise<InstanceModel>;
-    /**
-     * Delete the instance of the project.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance to delete.
-     */
-    deleteInstance(projectId: string, instanceId: string): Promise<void>;
-    /**
-     * Create a hub in the project.
-     *
-     * @param projectId The ID of the project.
-     * @param hub The hub to create.
-     */
-    createHub(projectId: string, hub: HubModel): Promise<HubModel>;
-    /**
-     * Patches the hub of the project.
-     *
-     * @param projectId The ID of the project.
-     * @param hubId The ID of the hub to update.
-     * @param patch The patch to apply to the hub.
-     */
-    updateHub(projectId: string, hubId: string, patch: HubModelPatch): Promise<HubModel>;
-    /**
-     * Delete the hub of the project.
-     *
-     * @param projectId The ID of the project.
-     * @param hubId The ID of the hub to delete.
-     */
-    deleteHub(projectId: string, hubId: string): Promise<void>;
-}
-
-declare class ProjectLock {
-    private readonly lock;
-    private readonly projectId;
-    constructor(lock: BetterLock, projectId: string);
-    canImmediatelyAcquireLock(instanceId: string): boolean;
-    lockInstance<T>(instanceId: string, fn: () => Promise<T>): Promise<T>;
-    lockInstances<T>(instanceIds: string[], fn: () => Promise<T>): Promise<T>;
-}
-declare class ProjectLockManager {
-    private readonly lock;
-    getLock(projectId: string): ProjectLock;
-}
-
-type LogEntry = [instanceId: string, line: string];
-type TerminalHistoryEntry = [sessionId: string, line: string];
-type EvaluatedCompositeInstance = CompositeInstance & {
-    /**
-     * The hash of the input of the instance at the moment of the evaluation.
-     */
-    inputHash: string;
-};
-interface StateBackend {
-    /**
-     * Gets the active operations which are not completed or failed.
-     */
-    getActiveOperations(): Promise<ProjectOperation[]>;
-    /**
-     * Gets recent operations of the project.
-     * If `beforeOperationId` is provided, returns the operations before the specified operation ID.
-     * The page size is fixed to 10.
-     *
-     * @param projectId The ID of the project.
-     * @param beforeOperationId The ID of the operation to get the operations before.
-     */
-    getOperations(projectId: string, beforeOperationId?: string): Promise<ProjectOperation[]>;
-    /**
-     * Gets the current (cached) instance states of the project.
-     * Actual states should be retrieved from the runner (and they are still may not be up-to-date).
-     *
-     * @param projectId The ID of the project.
-     */
-    getInstanceStates(projectId: string): Promise<InstanceState[]>;
-    /**
-     * Gets the current (cached) state of the instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    getInstanceState(projectId: string, instanceId: string): Promise<InstanceState | null>;
-    /**
-     * Gets the affected instance states at the moment of the operation completion.
-     * The logs are not included.
-     *
-     * @param operationId The ID of the operation.
-     */
-    getAffectedInstanceStates(operationId: string): Promise<InstanceState[]>;
-    /**
-     * Gets the full logs of the instance at the moment of the operation completion.
-     *
-     * @param operationId The ID of the operation.
-     * @param instanceId The ID of the instance.
-     */
-    getInstanceLogs(operationId: string, instanceId: string): Promise<string[]>;
-    /**
-     * Puts the operation to the state.
-     * The operation must have a unique ID sortable chronologically.
-     * Also, the operation must have the project ID.
-     *
-     * @param operation The operation to put.
-     */
-    putOperation(operation: ProjectOperation): Promise<void>;
-    /**
-     * Puts the instance states affected by the operation to the state.
-     *
-     * @param projectId The ID of the project.
-     * @param operationId The ID of the operation.
-     * @param states The instance states to put.
-     */
-    putAffectedInstanceStates(projectId: string, operationId: string, states: InstanceState[]): Promise<void>;
-    /**
-     * Puts the instance states of the project to the state.
-     *
-     * @param projectId The ID of the project.
-     * @param states The instance states to put.
-     */
-    putInstanceStates(projectId: string, states: InstanceState[]): Promise<void>;
-    /**
-     * Appends the log lines to the instance logs.
-     *
-     * @param operationId The ID of the operation.
-     * @param logs The logs to append. Each log is a tuple of the instance ID and the log line.
-     */
-    appendInstanceLogs(operationId: string, logs: LogEntry[]): Promise<void>;
-    /**
-     * Gets the evaluated composite instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    getCompositeInstance(projectId: string, instanceId: string): Promise<EvaluatedCompositeInstance | null>;
-    /**
-     * Gets the input hash of the evaluated composite instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    getCompositeInstanceInputHash(projectId: string, instanceId: string): Promise<string | null>;
-    /**
-     * Puts the evaluated composite instances of the project to the state.
-     *
-     * @param projectId The ID of the project.
-     * @param instances The instances to put.
-     */
-    putCompositeInstances(projectId: string, instances: EvaluatedCompositeInstance[]): Promise<void>;
-    /**
-     * Clears the evaluation state of the instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceIds The IDs of the instances to clear.
-     */
-    clearCompositeInstances(projectId: string, instanceIds: string[]): Promise<void>;
-    /**
-     * Gets all the terminal sessions of the instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    getTerminalSessions(projectId: string, instanceId: string): Promise<TerminalSession[]>;
-    /**
-     * Gets the terminal session.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     * @param sessionId The ID of the session.
-     */
-    getTerminalSession(projectId: string, instanceId: string, sessionId: string): Promise<TerminalSession | null>;
-    /**
-     * Puts the terminal sessions of the instance to the state.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     * @param session The terminal session to put.
-     */
-    putTerminalSession(projectId: string, instanceId: string, session: TerminalSession): Promise<void>;
-    /**
-     * Gets the history lines of the terminal session.
-     *
-     * @param sessionId The ID of the session.
-     */
-    getTerminalSessionHistory(sessionId: string): Promise<string[]>;
-    /**
-     * Appends the history lines to the terminal sessions.
-     *
-     * @param entries The entries to append.
-     */
-    appendTerminalSessionHistory(entries: TerminalHistoryEntry[]): Promise<void>;
-}
-
-declare class ProjectManager {
-    private readonly projectBackend;
-    private readonly stateBackend;
-    private readonly operationManager;
-    private readonly library;
-    private readonly logger;
-    private constructor();
-    getCompositeInstance(projectId: string, instanceId: string): Promise<CompositeInstance>;
-    createInstance(projectId: string, instance: InstanceModel): Promise<InstanceModel>;
-    updateInstance(projectId: string, instanceId: string, patch: InstanceModelPatch): Promise<InstanceModel>;
-    renameInstance(projectId: string, instanceId: string, newName: string): Promise<InstanceModel>;
-    deleteInstance(projectId: string, instanceId: string): Promise<void>;
-    private updateInstanceChildren;
-    private waitForCompositeInstance;
-    private prepareInputHashResolver;
-    static create(projectBackend: ProjectBackend, stateBackend: StateBackend, operationManager: OperationManager, library: LibraryBackend, logger: Logger): ProjectManager;
-}
-
-type RunnerBaseOptions = {
-    /**
-     * The HighState project ID.
-     */
-    projectId: string;
-    /**
-     * The type of the instance to run.
-     */
-    instanceType: string;
-    /**
-     * The name of the instance to run.
-     */
-    instanceName: string;
-    /**
-     * The signal to abort the operation.
-     */
-    signal?: AbortSignal;
-};
-type InstanceUpdateOptions = RunnerBaseOptions & {
-    /**
-     * The source of the unit.
-     */
-    source: UnitSource;
-    /**
-     * The configuration of the stack.
-     */
-    config: Record<string, string>;
-    /**
-     * The values of the secrets.
-     */
-    secrets: Record<string, string>;
-    /**
-     * Whether to refresh the state before updating.
-     */
-    refresh?: boolean;
-};
-type InstanceDestroyOptions = RunnerBaseOptions & {
-    /**
-     * The source of the unit.
-     */
-    source: UnitSource;
-    /**
-     * Whether to refresh the state before updating.
-     */
-    refresh?: boolean;
-    /**
-     * Whether to delete the unreachable resources (e.g. k8s resources in unreachable clusters).
-     */
-    deleteUnreachable?: boolean;
-};
-type InstanceWatchOptions = RunnerBaseOptions & {
-    /**
-     * The final statuses to watch.
-     * If the instance reaches one of these statuses, it should return the current state and exit.
-     */
-    finalStatuses?: InstanceStatus[];
-};
-interface RunnerBackend {
-    /**
-     * Watches the instance state.
-     *
-     * Returns the async iterable of the instance state patches.
-     * The fields with `undefined` values should be ignored, and the fields with `null` values should be removed.
-     */
-    watch(options: InstanceWatchOptions): AsyncIterable<InstanceStatePatch>;
-    /**
-     * Gets the actual state of the instance.
-     */
-    getState(options: RunnerBaseOptions): Promise<InstanceState>;
-    /**
-     * Gets the content of the page.
-     */
-    getPageContent(options: RunnerBaseOptions, pageName: string): Promise<InstancePageBlock[] | null>;
-    /**
-     * Gets the content of the file.
-     */
-    getFileContent(options: RunnerBaseOptions, fileName: string): Promise<string | null>;
-    /**
-     * Gets the terminal factory.
-     */
-    getTerminalFactory(options: RunnerBaseOptions, terminalName: string): Promise<InstanceTerminal | null>;
-    /**
-     * Updates the instance.
-     *
-     * The operation must only be aborted by the signal, not even when the connection is closed.
-     * If the instance is already updating, it should exit immediately.
-     * If the instance is running another operation, it should throw an error.
-     */
-    update(options: InstanceUpdateOptions): Promise<void>;
-    /**
-     * Previews the instance update without actually applying the changes.
-     *
-     * The operation must only be aborted by the signal, not even when the connection is closed.
-     * If the instance is already updating, it should exit immediately.
-     * If the instance is running another operation, it should throw an error.
-     */
-    preview(options: InstanceUpdateOptions): Promise<void>;
-    /**
-     * Destroys the instance.
-     *
-     * The operation must only be aborted by the signal, not even when the connection is closed.
-     * If the instance is not created, it should exit immediately.
-     * If the instance is running another operation, it should throw an error.
-     */
-    destroy(options: InstanceDestroyOptions): Promise<void>;
-    /**
-     * Refreshes the instance.
-     *
-     * The operation must only be aborted by the signal, not even when the connection is closed.
-     * If the instance is not created, it should exit immediately.
-     * If the instance is running another operation, it should throw an error.
-     * If the instance is not running, it should exit immediately.
-     */
-    refresh(options: RunnerBaseOptions): Promise<void>;
-}
-
-type OperationEvents = Record<string, [ProjectOperation]>;
-type StateEvents = Record<string, [Partial<InstanceState>]>;
-type CompositeInstanceEvents = Record<string, [CompositeInstance]>;
-type InstanceLogsEvents = Record<string, [string]>;
-declare class OperationManager {
-    private readonly runnerBackend;
-    private readonly stateBackend;
-    private readonly libraryBackend;
-    private readonly projectBackend;
-    private readonly secretBackend;
-    private readonly projectLockManager;
-    private readonly logger;
-    constructor(runnerBackend: RunnerBackend, stateBackend: StateBackend, libraryBackend: LibraryBackend, projectBackend: ProjectBackend, secretBackend: SecretBackend, projectLockManager: ProjectLockManager, logger: Logger);
-    private readonly operationEE;
-    private readonly stateEE;
-    private readonly compositeInstanceEE;
-    private readonly instanceLogsEE;
-    private readonly runtimeOperations;
-    /**
-     * Watches for all instance state changes in the project.
-     *
-     * @param projectId The project ID to watch.
-     * @param signal The signal to abort the operation.
-     */
-    watchInstanceStates(projectId: string, signal?: AbortSignal): AsyncIterable<Partial<InstanceState>>;
-    /**
-     * Watches for all project operations in the project.
-     *
-     * @param projectId The project ID to watch.
-     * @param signal The signal to abort the operation.
-     */
-    watchOperations(projectId: string, signal?: AbortSignal): AsyncIterable<ProjectOperation>;
-    /**
-     * Watches for changes in the composite instance.
-     *
-     * @param projectId The project ID to watch.
-     * @param instanceId The instance ID to watch.
-     * @param signal The signal to abort the operation.
-     */
-    watchCompositeInstance(projectId: string, instanceId: string, signal?: AbortSignal): AsyncIterable<CompositeInstance>;
-    /**
-     * Watches for logs of the instance in the operation.
-     *
-     * @param operationId The operation ID to watch.
-     * @param instanceId The instance ID to watch.
-     * @param signal The signal to abort the operation.
-     */
-    watchInstanceLogs(operationId: string, instanceId: string, signal?: AbortSignal): AsyncIterable<string>;
-    /**
-     * Launches the project operation.
-     *
-     * @param request The operation request to launch.
-     */
-    launch(request: ProjectOperationRequest): Promise<ProjectOperation>;
-    /**
-     * Cancels the current operation.
-     * Does nothing if no operation is running.
-     */
-    cancel(operationId: string): void;
-    private startOperation;
-    static create(runnerBackend: RunnerBackend, stateBackend: StateBackend, libraryBackend: LibraryBackend, projectBackend: ProjectBackend, secretBackend: SecretBackend, projectLockManager: ProjectLockManager, logger: Logger): Promise<OperationManager>;
-}
-
-type TerminalRunOptions = {
-    /**
-     * The factory to use.
-     */
-    factory: InstanceTerminal;
-    /**
-     * The input stream.
-     */
-    stdin: Stream;
-    /**
-     * The output stream.
-     */
-    stdout: NodeJS.WritableStream;
-    /**
-     * The signal to abort the terminal.
-     */
-    signal?: AbortSignal;
-};
-interface TerminalBackend {
-    /**
-     * Creates a new terminal and runs it.
-     *
-     * @param options The options.
-     */
-    run(options: TerminalRunOptions): Promise<void>;
-}
-
-declare const terminalBackendConfig: z.ZodObject<{
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY: z.ZodDefault<z.ZodString>;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST: z.ZodOptional<z.ZodString>;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE: z.ZodDefault<z.ZodEnum<["docker"]>>;
-}, "strip", z.ZodTypeAny, {
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY: string;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE: "docker";
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST?: string | undefined;
-}, {
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_BINARY?: string | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_DOCKER_HOST?: string | undefined;
-    HIGHSTATE_BACKEND_TERMINAL_TYPE?: "docker" | undefined;
-}>;
-declare function createTerminalBackend(config: z.infer<typeof terminalBackendConfig>, logger: Logger): TerminalBackend;
-
-declare class TerminalManager {
-    private readonly terminalBackend;
-    private readonly stateBackend;
-    private readonly runnerBackend;
-    private readonly logger;
-    private readonly managedTerminals;
-    private constructor();
-    createSession(projectId: string, instanceId: string, terminalName: string): Promise<TerminalSession>;
-    ensureSessionCreated(projectId: string, instanceId: string, terminalName: string): Promise<TerminalSession>;
-    close(sessionId: string): void;
-    attach(projectId: string, instanceId: string, sessionId: string, stdin: Stream, stdout: Writable, signal: AbortSignal): Promise<void>;
-    private createManagedTerminal;
-    private closeTerminalIfNotAttached;
-    static create(terminalBackend: TerminalBackend, stateBackend: StateBackend, runnerBackend: RunnerBackend, logger: Logger): TerminalManager;
-    private persistHistory;
-}
-
-interface WorkspaceBackend {
-    /**
-     * Gets the layout of the workspace.
-     */
-    getWorkspaceLayout(): Promise<unknown>;
-    /**
-     * Sets the layout of the workspace.
-     */
-    setWorkspaceLayout(layout: unknown): Promise<void>;
-    /**
-     * Gets the viewport of the project.
-     *
-     * @param projectId The ID of the project.
-     */
-    getProjectViewport(projectId: string): Promise<unknown>;
-    /**
-     * Sets the viewport of the project.
-     *
-     * @param projectId The ID of the project.
-     */
-    setProjectViewport(projectId: string, viewport: unknown): Promise<void>;
-    /**
-     * Gets the viewport of the composite instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    getInstanceViewport(projectId: string, instanceId: string): Promise<unknown>;
-    /**
-     * Sets the viewport of the composite instance.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance.
-     */
-    setInstanceViewport(projectId: string, instanceId: string, viewport: unknown): Promise<void>;
-}
-
-type Services = {
-    readonly logger: Logger;
-    readonly libraryBackend: LibraryBackend;
-    readonly secretBackend: SecretBackend;
-    readonly runnerBackend: RunnerBackend;
-    readonly projectBackend: ProjectBackend;
-    readonly projectManager: ProjectManager;
-    readonly stateBackend: StateBackend;
-    readonly operationManager: OperationManager;
-    readonly terminalBackend: TerminalBackend;
-    readonly terminalManager: TerminalManager;
-    readonly workspaceBackend: WorkspaceBackend;
-};
-interface CreateServicesOptions {
-    /**
-     * The config to use. If not provided, it will be loaded from the environment.
-     */
-    readonly config?: Config;
-    /**
-     * The already created services to use. If the particular service is not provided, it will be created.
-     */
-    readonly services?: Partial<Services>;
-}
-declare function createServices({ config, services: { logger, libraryBackend, secretBackend, runnerBackend, projectBackend, projectManager, stateBackend, operationManager, terminalBackend, terminalManager, workspaceBackend, }, }?: CreateServicesOptions): Promise<Services>;
-declare function getSharedServices(options?: CreateServicesOptions): Promise<Services>;
-
-export { type CompositeInstanceEvents, type Config, type CreateServicesOptions, type InstanceLogsEvents, type LibraryBackend, type LibraryModel, type OperationEvents, OperationManager, SecretAccessDeniedError, type SecretBackend, type Services, type StateEvents, type TerminalBackend, TerminalManager, type TerminalRunOptions, createLibraryBackend, createSecretBackend, createServices, createTerminalBackend, getSharedServices, libraryBackendConfig, loadConfig, secretBackendConfig, terminalBackendConfig };