@highstate/backend 0.4.4 → 0.4.5

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { z } from 'zod';
 import { WhoAmIResult, Stack, ConfigMap } from '@pulumi/pulumi/automation';
 import { Logger } from 'pino';
-import { ComponentModel, Entity, BaseInstanceModel, CompositeInstance, InstanceInputMap, UnitSource } from '@highstate/contract';
-import { I as InstanceModel, P as Position, a as ProjectOperation, b as InstanceState, c as InstanceStatePatch, T as TerminalFactory, d as InstanceStatus, e as ProjectOperationRequest } from './operation-8k4Tv4dw.js';
+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-_gg6j6_K.js';
 import { BetterLock } from 'better-lock/dist/better_lock';
-import { Stream, Writable, PassThrough } from 'node:stream';
+import { Stream, Writable } from 'node:stream';
 
 declare class SecretAccessDeniedError extends Error {
     constructor(projectId: string, key: string);
@@ -64,7 +64,7 @@ declare class LocalPulumiHost {
     hasPassword(projectId: string): boolean;
     setPassword(projectId: string, password: string): void;
     private getPassword;
-    static tryUnlockStack(stack: Stack, error: unknown): Promise<boolean>;
+    tryUnlockStack(stack: Stack, error: unknown): Promise<boolean>;
     static create(logger: Logger): LocalPulumiHost;
 }
 
@@ -103,13 +103,13 @@ interface LibraryBackend {
      * @param allInstances The all instances defined in the project.
      * @param instanceIds The instance IDs to evaluate.
      */
-    evaluateCompositeInstances(allInstances: BaseInstanceModel[], instanceIds: string[]): Promise<readonly CompositeInstance[]>;
+    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 BaseInstanceModel[]>;
+    evaluateModules(modulePaths: string[]): Promise<readonly InstanceModel[]>;
 }
 
 declare const libraryBackendConfig: z.ZodObject<{
@@ -194,17 +194,21 @@ declare const configSchema: z.ZodObject<{
 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 of the project.
+     * Get the instances and hubs of the project.
      *
      * @param projectId The ID of the project.
      */
-    getInstances(projectId: string): Promise<InstanceModel[]>;
+    getProject(projectId: string): Promise<ProjectModel>;
     /**
      * Create the instance of the project.
      *
@@ -212,14 +216,6 @@ interface ProjectBackend {
      * @param instance The instance to update.
      */
     createInstance(projectId: string, instance: InstanceModel): Promise<InstanceModel>;
-    /**
-     * Change the position of the instance in the project.
-     *
-     * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance to move.
-     * @param position The new position of the instance.
-     */
-    moveInstance(projectId: string, instanceId: string, position: Position): Promise<InstanceModel>;
     /**
      * Rename the instance of the project.
      * Changes its id and updates all references to the instance.
@@ -227,28 +223,42 @@ interface ProjectBackend {
      */
     renameInstance(projectId: string, instanceId: string, newName: string): Promise<InstanceModel>;
     /**
-     * Update the arguments of the instance.
+     * Patches the instance of the project.
      *
      * @param projectId The ID of the project.
      * @param instanceId The ID of the instance to update.
-     * @param args The new arguments of the instance.
+     * @param patch The patch to apply to the instance.
      */
-    updateInstanceArgs(projectId: string, instanceId: string, args: Record<string, unknown>): Promise<InstanceModel>;
+    updateInstance(projectId: string, instanceId: string, patch: InstanceModelPatch): Promise<InstanceModel>;
     /**
-     * Update the inputs of the instance.
+     * Delete the instance of the project.
      *
      * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance to update.
-     * @param inputs The new inputs of the instance.
+     * @param instanceId The ID of the instance to delete.
      */
-    updateInstanceInputs(projectId: string, instanceId: string, inputs: InstanceInputMap): Promise<InstanceModel>;
+    deleteInstance(projectId: string, instanceId: string): Promise<void>;
     /**
-     * Delete the instance of the project.
+     * Create a hub in the project.
      *
      * @param projectId The ID of the project.
-     * @param instanceId The ID of the instance to delete.
+     * @param hub The hub to create.
      */
-    deleteInstance(projectId: string, instanceId: string): Promise<void>;
+    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 {
@@ -264,6 +274,7 @@ declare class ProjectLockManager {
 }
 
 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.
@@ -297,7 +308,7 @@ interface StateBackend {
      * @param projectId The ID of the project.
      * @param instanceId The ID of the instance.
      */
-    getInstanceState(projectId: string, instanceId: string): Promise<InstanceState | undefined>;
+    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.
@@ -370,6 +381,41 @@ interface StateBackend {
      * @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 {
@@ -381,13 +427,12 @@ declare class ProjectManager {
     private constructor();
     getCompositeInstance(projectId: string, instanceId: string): Promise<CompositeInstance>;
     createInstance(projectId: string, instance: InstanceModel): Promise<InstanceModel>;
-    updateInstanceArgs(projectId: string, instanceId: string, args: Record<string, unknown>): Promise<InstanceModel>;
-    updateInstanceInputs(projectId: string, instanceId: string, inputs: InstanceInputMap): Promise<InstanceModel>;
-    moveInstance(projectId: string, instanceId: string, position: Position): 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;
 }
 
@@ -443,13 +488,17 @@ interface RunnerBackend {
      */
     getState(options: RunnerBaseOptions): Promise<InstanceState>;
     /**
-     * Gets the content of the representation.
+     * Gets the content of the page.
      */
-    getRepresentationContent(options: RunnerBaseOptions): Promise<string | null>;
+    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): Promise<TerminalFactory | null>;
+    getTerminalFactory(options: RunnerBaseOptions, terminalName: string): Promise<InstanceTerminal | null>;
     /**
      * Updates the instance.
      *
@@ -544,7 +593,7 @@ type TerminalRunOptions = {
     /**
      * The factory to use.
      */
-    factory: TerminalFactory;
+    factory: InstanceTerminal;
     /**
      * The input stream.
      */
@@ -582,24 +631,21 @@ declare const terminalBackendConfig: z.ZodObject<{
 }>;
 declare function createTerminalBackend(config: z.infer<typeof terminalBackendConfig>, logger: Logger): TerminalBackend;
 
-type Terminal = {
-    readonly id: string;
-    readonly abortController: AbortController;
-    readonly stdin: PassThrough;
-    readonly stdout: PassThrough;
-    readonly history: string[];
-    attached: boolean;
-};
 declare class TerminalManager {
     private readonly terminalBackend;
+    private readonly stateBackend;
+    private readonly runnerBackend;
     private readonly logger;
-    private readonly terminals;
+    private readonly managedTerminals;
     private constructor();
-    create(factory: TerminalFactory): Terminal;
-    close(id: string): void;
-    attach(id: string, stdin: Stream, stdout: Writable, signal: AbortSignal): void;
+    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, logger: Logger): TerminalManager;
+    static create(terminalBackend: TerminalBackend, stateBackend: StateBackend, runnerBackend: RunnerBackend, logger: Logger): TerminalManager;
+    private persistHistory;
 }
 
 interface WorkspaceBackend {