@highstate/backend 0.6.2 → 0.7.1

package/dist/index.d.ts

@@ -2,7 +2,7 @@ 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-NNJYvGqi.js';
+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';
 
@@ -51,14 +51,23 @@ interface SecretBackend {
     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>;
-    runInline<T>(projectId: string, pulumiProjectName: string, pulumiStackName: string, program: () => Promise<void> | Promise<Record<string, unknown>>, fn: (stack: Stack) => Promise<T>): Promise<T>;
-    runEmpty<T>(projectId: string, pulumiProjectName: string, pulumiStackName: string, fn: (stack: Stack) => Promise<T>): Promise<T>;
-    runLocal<T>(projectId: string, pulumiProjectName: string, pulumiStackName: string, programPathResolver: () => Promise<string> | string, fn: (stack: Stack) => Promise<T>, stackConfig?: ConfigMap): Promise<T>;
+    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;
@@ -137,6 +146,7 @@ declare const configSchema: z.ZodObject<{
     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"]>>;
@@ -167,6 +177,7 @@ declare const configSchema: z.ZodObject<{
     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;
 }, {
@@ -183,6 +194,7 @@ declare const configSchema: z.ZodObject<{
     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;
@@ -272,6 +284,7 @@ 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>;
 }
@@ -474,6 +487,24 @@ type InstanceUpdateOptions = RunnerBaseOptions & {
      * 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 & {
     /**
@@ -514,6 +545,14 @@ interface RunnerBackend {
      * 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.
      *
@@ -521,7 +560,7 @@ interface RunnerBackend {
      * If the instance is not created, it should exit immediately.
      * If the instance is running another operation, it should throw an error.
      */
-    destroy(options: RunnerBaseOptions): Promise<void>;
+    destroy(options: InstanceDestroyOptions): Promise<void>;
     /**
      * Refreshes the instance.
      *
@@ -586,7 +625,7 @@ declare class OperationManager {
      *
      * @param request The operation request to launch.
      */
-    launch(request: ProjectOperationRequest): Promise<void>;
+    launch(request: ProjectOperationRequest): Promise<ProjectOperation>;
     /**
      * Cancels the current operation.
      * Does nothing if no operation is running.