@slicervm/sdk 0.1.8 → 0.1.9

package/dist/index.d.cts

@@ -320,11 +320,31 @@ interface VMForkNetworkPolicy {
     /** Omit to inherit; pass an empty array to clear the drop list. */
     drop?: string[];
 }
+type VMForkWait = 'agent' | 'none';
+type VMForkTagMode = 'append' | 'replace';
+type VMForkFixup = 'hostname' | 'machine-id' | 'ssh-host-keys';
 interface VMForkOptions {
-    /** Agent-readiness timeout in seconds. Forks always wait for the child agent. */
+    /**
+     * Defaults to agent. None acknowledges launch only; the daemon removes the
+     * child if requested asynchronous finalisation later fails.
+     */
+    wait?: VMForkWait;
+    /** Server-side agent/finalisation timeout in seconds when waiting. */
     waitTimeoutSec?: number;
     network?: VMForkNetworkPolicy;
+    /** Omit to inherit tags; provided tags append unless tagMode is replace. */
     tags?: string[];
+    tagMode?: VMForkTagMode;
+    /** Omit to inherit grants; pass an empty array to clear and blot secrets. */
+    secrets?: string[];
+    /** Defaults to true; false makes the fork ephemeral. */
+    persistent?: boolean;
+    /** Omit for all correctness fix-ups; pass an empty array to disable them. */
+    fixups?: VMForkFixup[];
+    /** Child vCPU count, up to the source host-group limit. */
+    vcpu?: number;
+    /** Child RAM in bytes, up to the source host-group limit. */
+    ramBytes?: number;
 }
 interface VMForkResponse {
     hostname: string;
@@ -334,6 +354,7 @@ interface VMForkResponse {
     parentStatus?: string;
     childStatus?: string;
     mode: string;
+    persistent?: boolean;
 }
 interface VMNetworkPolicy {
     allow: string[];
@@ -1088,4 +1109,4 @@ declare class SlicerShellSession {
     private teardown;
 }
 
-export { type AddProxyAllowRequest, type AddressMapping, type AgentHealth, type BgDeleteResponse, type BgExecInfo, type BgExecRequest, type BgExecResponse, type BgKillOptions, type BgKillResponse, type BgLogOptions, type BgWaitExitResponse, CommitsAPI, CommittedVM, type CreateProxyClientOptions, type CreateProxySecretRequest, type CreateSecretRequest, type CreateVMNetworkPolicy, type CreateVMOptions, type CreateVMRequest, type CreateVMResponse, type DeleteResponse, type ExecFrame, type ExecRequest, type ExecResult, type ExecResultBinary, type ExecStdio, ExecStdioBase64, ExecStdioText, FRAME_TYPE_DATA, FRAME_TYPE_HEARTBEAT, FRAME_TYPE_SESSION_CLOSE, FRAME_TYPE_SHUTDOWN, FRAME_TYPE_WINDOW_SIZE, type FSEntry, type FSMkdirRequest, type FSWatchEvent, type FSWatchEventType, type FSWatchRequest, Forwarder, type ForwarderListener, type ForwarderOptions, GiB, type HostGroup, HostGroupsAPI, type ListOptions, MiB, NonRootUser, ProxyAPI, type ProxyAllowRule, ProxyAllowsAPI, type ProxyClient, type ProxyClientCreated, ProxyClientsAPI, type ProxySecret, ProxySecretBasic, ProxySecretBearer, ProxySecretOAuthClientCredentials, type ProxySecretType, ProxySecretsAPI, type RemoveProxyAllowByTupleRequest, type Secret, SecretExistsError, SecretsAPI, type ShellSessionOptions, type ShutdownRequest, SlicerAPIError, SlicerClient, type SlicerClientOptions, type SlicerInfo, SlicerShellSession, type UpdateSecretRequest, VM, VMBg, type VMCommitDeleteResponse, type VMCommitInfo, type VMCommitListOptions, type VMCommitOptions, type VMCommitResponse, type VMDescription, VMFileSystem, type VMForkNetworkPolicy, type VMForkOptions, type VMForkResponse, type VMInfo, type VMInit, type VMLogs, type VMNetworkDescription, type VMNetworkPolicy, type VMSnapshot, type VMStat, VMsAPI, type WaitOptions, type XTermLike, encodeFrame, parseAddressMapping, parseFrame, resolveTransport };
+export { type AddProxyAllowRequest, type AddressMapping, type AgentHealth, type BgDeleteResponse, type BgExecInfo, type BgExecRequest, type BgExecResponse, type BgKillOptions, type BgKillResponse, type BgLogOptions, type BgWaitExitResponse, CommitsAPI, CommittedVM, type CreateProxyClientOptions, type CreateProxySecretRequest, type CreateSecretRequest, type CreateVMNetworkPolicy, type CreateVMOptions, type CreateVMRequest, type CreateVMResponse, type DeleteResponse, type ExecFrame, type ExecRequest, type ExecResult, type ExecResultBinary, type ExecStdio, ExecStdioBase64, ExecStdioText, FRAME_TYPE_DATA, FRAME_TYPE_HEARTBEAT, FRAME_TYPE_SESSION_CLOSE, FRAME_TYPE_SHUTDOWN, FRAME_TYPE_WINDOW_SIZE, type FSEntry, type FSMkdirRequest, type FSWatchEvent, type FSWatchEventType, type FSWatchRequest, Forwarder, type ForwarderListener, type ForwarderOptions, GiB, type HostGroup, HostGroupsAPI, type ListOptions, MiB, NonRootUser, ProxyAPI, type ProxyAllowRule, ProxyAllowsAPI, type ProxyClient, type ProxyClientCreated, ProxyClientsAPI, type ProxySecret, ProxySecretBasic, ProxySecretBearer, ProxySecretOAuthClientCredentials, type ProxySecretType, ProxySecretsAPI, type RemoveProxyAllowByTupleRequest, type Secret, SecretExistsError, SecretsAPI, type ShellSessionOptions, type ShutdownRequest, SlicerAPIError, SlicerClient, type SlicerClientOptions, type SlicerInfo, SlicerShellSession, type UpdateSecretRequest, VM, VMBg, type VMCommitDeleteResponse, type VMCommitInfo, type VMCommitListOptions, type VMCommitOptions, type VMCommitResponse, type VMDescription, VMFileSystem, type VMForkFixup, type VMForkNetworkPolicy, type VMForkOptions, type VMForkResponse, type VMForkTagMode, type VMForkWait, type VMInfo, type VMInit, type VMLogs, type VMNetworkDescription, type VMNetworkPolicy, type VMSnapshot, type VMStat, VMsAPI, type WaitOptions, type XTermLike, encodeFrame, parseAddressMapping, parseFrame, resolveTransport };

package/dist/index.d.ts

@@ -320,11 +320,31 @@ interface VMForkNetworkPolicy {
     /** Omit to inherit; pass an empty array to clear the drop list. */
     drop?: string[];
 }
+type VMForkWait = 'agent' | 'none';
+type VMForkTagMode = 'append' | 'replace';
+type VMForkFixup = 'hostname' | 'machine-id' | 'ssh-host-keys';
 interface VMForkOptions {
-    /** Agent-readiness timeout in seconds. Forks always wait for the child agent. */
+    /**
+     * Defaults to agent. None acknowledges launch only; the daemon removes the
+     * child if requested asynchronous finalisation later fails.
+     */
+    wait?: VMForkWait;
+    /** Server-side agent/finalisation timeout in seconds when waiting. */
     waitTimeoutSec?: number;
     network?: VMForkNetworkPolicy;
+    /** Omit to inherit tags; provided tags append unless tagMode is replace. */
     tags?: string[];
+    tagMode?: VMForkTagMode;
+    /** Omit to inherit grants; pass an empty array to clear and blot secrets. */
+    secrets?: string[];
+    /** Defaults to true; false makes the fork ephemeral. */
+    persistent?: boolean;
+    /** Omit for all correctness fix-ups; pass an empty array to disable them. */
+    fixups?: VMForkFixup[];
+    /** Child vCPU count, up to the source host-group limit. */
+    vcpu?: number;
+    /** Child RAM in bytes, up to the source host-group limit. */
+    ramBytes?: number;
 }
 interface VMForkResponse {
     hostname: string;
@@ -334,6 +354,7 @@ interface VMForkResponse {
     parentStatus?: string;
     childStatus?: string;
     mode: string;
+    persistent?: boolean;
 }
 interface VMNetworkPolicy {
     allow: string[];
@@ -1088,4 +1109,4 @@ declare class SlicerShellSession {
     private teardown;
 }
 
-export { type AddProxyAllowRequest, type AddressMapping, type AgentHealth, type BgDeleteResponse, type BgExecInfo, type BgExecRequest, type BgExecResponse, type BgKillOptions, type BgKillResponse, type BgLogOptions, type BgWaitExitResponse, CommitsAPI, CommittedVM, type CreateProxyClientOptions, type CreateProxySecretRequest, type CreateSecretRequest, type CreateVMNetworkPolicy, type CreateVMOptions, type CreateVMRequest, type CreateVMResponse, type DeleteResponse, type ExecFrame, type ExecRequest, type ExecResult, type ExecResultBinary, type ExecStdio, ExecStdioBase64, ExecStdioText, FRAME_TYPE_DATA, FRAME_TYPE_HEARTBEAT, FRAME_TYPE_SESSION_CLOSE, FRAME_TYPE_SHUTDOWN, FRAME_TYPE_WINDOW_SIZE, type FSEntry, type FSMkdirRequest, type FSWatchEvent, type FSWatchEventType, type FSWatchRequest, Forwarder, type ForwarderListener, type ForwarderOptions, GiB, type HostGroup, HostGroupsAPI, type ListOptions, MiB, NonRootUser, ProxyAPI, type ProxyAllowRule, ProxyAllowsAPI, type ProxyClient, type ProxyClientCreated, ProxyClientsAPI, type ProxySecret, ProxySecretBasic, ProxySecretBearer, ProxySecretOAuthClientCredentials, type ProxySecretType, ProxySecretsAPI, type RemoveProxyAllowByTupleRequest, type Secret, SecretExistsError, SecretsAPI, type ShellSessionOptions, type ShutdownRequest, SlicerAPIError, SlicerClient, type SlicerClientOptions, type SlicerInfo, SlicerShellSession, type UpdateSecretRequest, VM, VMBg, type VMCommitDeleteResponse, type VMCommitInfo, type VMCommitListOptions, type VMCommitOptions, type VMCommitResponse, type VMDescription, VMFileSystem, type VMForkNetworkPolicy, type VMForkOptions, type VMForkResponse, type VMInfo, type VMInit, type VMLogs, type VMNetworkDescription, type VMNetworkPolicy, type VMSnapshot, type VMStat, VMsAPI, type WaitOptions, type XTermLike, encodeFrame, parseAddressMapping, parseFrame, resolveTransport };
+export { type AddProxyAllowRequest, type AddressMapping, type AgentHealth, type BgDeleteResponse, type BgExecInfo, type BgExecRequest, type BgExecResponse, type BgKillOptions, type BgKillResponse, type BgLogOptions, type BgWaitExitResponse, CommitsAPI, CommittedVM, type CreateProxyClientOptions, type CreateProxySecretRequest, type CreateSecretRequest, type CreateVMNetworkPolicy, type CreateVMOptions, type CreateVMRequest, type CreateVMResponse, type DeleteResponse, type ExecFrame, type ExecRequest, type ExecResult, type ExecResultBinary, type ExecStdio, ExecStdioBase64, ExecStdioText, FRAME_TYPE_DATA, FRAME_TYPE_HEARTBEAT, FRAME_TYPE_SESSION_CLOSE, FRAME_TYPE_SHUTDOWN, FRAME_TYPE_WINDOW_SIZE, type FSEntry, type FSMkdirRequest, type FSWatchEvent, type FSWatchEventType, type FSWatchRequest, Forwarder, type ForwarderListener, type ForwarderOptions, GiB, type HostGroup, HostGroupsAPI, type ListOptions, MiB, NonRootUser, ProxyAPI, type ProxyAllowRule, ProxyAllowsAPI, type ProxyClient, type ProxyClientCreated, ProxyClientsAPI, type ProxySecret, ProxySecretBasic, ProxySecretBearer, ProxySecretOAuthClientCredentials, type ProxySecretType, ProxySecretsAPI, type RemoveProxyAllowByTupleRequest, type Secret, SecretExistsError, SecretsAPI, type ShellSessionOptions, type ShutdownRequest, SlicerAPIError, SlicerClient, type SlicerClientOptions, type SlicerInfo, SlicerShellSession, type UpdateSecretRequest, VM, VMBg, type VMCommitDeleteResponse, type VMCommitInfo, type VMCommitListOptions, type VMCommitOptions, type VMCommitResponse, type VMDescription, VMFileSystem, type VMForkFixup, type VMForkNetworkPolicy, type VMForkOptions, type VMForkResponse, type VMForkTagMode, type VMForkWait, type VMInfo, type VMInit, type VMLogs, type VMNetworkDescription, type VMNetworkPolicy, type VMSnapshot, type VMStat, VMsAPI, type WaitOptions, type XTermLike, encodeFrame, parseAddressMapping, parseFrame, resolveTransport };

package/dist/index.js

@@ -312,7 +312,8 @@ function vmForkFromWire(w) {
     status: w.status,
     ...w.parent_status !== void 0 && { parentStatus: w.parent_status },
     ...w.child_status !== void 0 && { childStatus: w.child_status },
-    mode: w.mode ?? ""
+    mode: w.mode ?? "",
+    ...w.persistent !== void 0 && { persistent: w.persistent }
   };
 }
 function vmDescriptionFromWire(w) {
@@ -362,6 +363,31 @@ function secretFromWire(w) {
     ...w.modified_at !== void 0 && { modifiedAt: w.modified_at }
   };
 }
+
+// src/fork.ts
+function buildForkRequest(opts) {
+  const wait = opts.wait ?? "agent";
+  if (wait !== "agent" && wait !== "none") {
+    throw new Error(`invalid fork wait mode ${JSON.stringify(wait)}`);
+  }
+  const query = new URLSearchParams({ wait });
+  if (opts.waitTimeoutSec !== void 0 && opts.waitTimeoutSec > 0) {
+    query.set("timeout", `${opts.waitTimeoutSec}s`);
+  }
+  const body = {};
+  if (opts.network !== void 0) body.network = opts.network;
+  if (opts.tags !== void 0) body.tags = opts.tags;
+  if (opts.tagMode !== void 0) body.tag_mode = opts.tagMode;
+  if (opts.secrets !== void 0) body.secrets = opts.secrets;
+  if (opts.persistent !== void 0) body.persistent = opts.persistent;
+  if (opts.fixups !== void 0) body.fixups = opts.fixups;
+  if (opts.vcpu !== void 0) body.vcpu = opts.vcpu;
+  if (opts.ramBytes !== void 0) body.ram_bytes = opts.ramBytes;
+  return {
+    query: query.toString(),
+    ...Object.keys(body).length > 0 && { body }
+  };
+}
 function looksLikeUnixSocketPath(s) {
   if (!s) return false;
   return s.startsWith("/") || s.startsWith("./") || s.startsWith("../") || s.includes("/");
@@ -1087,20 +1113,11 @@ function errMsg(e) {
 }
 async function forkPath(transport, commitId, opts) {
   const id = validateCommitId(commitId);
-  const q = new URLSearchParams();
-  q.set("wait", "agent");
-  if (opts.waitTimeoutSec !== void 0 && opts.waitTimeoutSec > 0) {
-    q.set("timeout", `${opts.waitTimeoutSec}s`);
-  }
-  const query = q.toString() ? `?${q.toString()}` : "";
-  const body = opts.network !== void 0 || (opts.tags?.length ?? 0) > 0 ? {
-    ...opts.network !== void 0 && { network: opts.network },
-    ...(opts.tags?.length ?? 0) > 0 && { tags: opts.tags }
-  } : void 0;
+  const request = buildForkRequest(opts);
   const wire = await transport.request(
     "POST",
-    `/vm/commits/${encodeURIComponent(id)}/fork${query}`,
-    body
+    `/vm/commits/${encodeURIComponent(id)}/fork?${request.query}`,
+    request.body
   );
   return vmForkFromWire(wire);
 }
@@ -1401,18 +1418,11 @@ var CommitsAPI = class {
   }
   async fork(commitId, opts = {}) {
     const id = validateCommitId2(commitId);
-    const qs = new URLSearchParams({ wait: "agent" });
-    if (opts.waitTimeoutSec !== void 0 && opts.waitTimeoutSec > 0) {
-      qs.set("timeout", `${opts.waitTimeoutSec}s`);
-    }
-    const body = opts.network !== void 0 || (opts.tags?.length ?? 0) > 0 ? {
-      ...opts.network !== void 0 && { network: opts.network },
-      ...(opts.tags?.length ?? 0) > 0 && { tags: opts.tags }
-    } : void 0;
+    const request = buildForkRequest(opts);
     const wire = await this.transport.request(
       "POST",
-      `/vm/commits/${encodeURIComponent(id)}/fork?${qs.toString()}`,
-      body
+      `/vm/commits/${encodeURIComponent(id)}/fork?${request.query}`,
+      request.body
     );
     return vmForkFromWire(wire);
   }