@mutagent/sdk 0.11.5 → 0.12.0

package/dist/commonjs/sdk/helix-sessions.js

@@ -4,73 +4,150 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HelixSessions = void 0;
+const helix_sessions_checkpoint_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-checkpoint-helix-session-deprecated.js");
 const helix_sessions_checkpoint_helix_session_js_1 = require("../funcs/helix-sessions-checkpoint-helix-session.js");
+const helix_sessions_close_helix_session_input_deprecated_js_1 = require("../funcs/helix-sessions-close-helix-session-input-deprecated.js");
 const helix_sessions_close_helix_session_input_js_1 = require("../funcs/helix-sessions-close-helix-session-input.js");
+const helix_sessions_end_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-end-helix-session-deprecated.js");
 const helix_sessions_end_helix_session_js_1 = require("../funcs/helix-sessions-end-helix-session.js");
 const helix_sessions_get_helix_access_js_1 = require("../funcs/helix-sessions-get-helix-access.js");
 const helix_sessions_get_helix_models_js_1 = require("../funcs/helix-sessions-get-helix-models.js");
+const helix_sessions_launch_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-launch-helix-session-deprecated.js");
 const helix_sessions_launch_helix_session_js_1 = require("../funcs/helix-sessions-launch-helix-session.js");
+const helix_sessions_list_helix_session_checkpoints_deprecated_js_1 = require("../funcs/helix-sessions-list-helix-session-checkpoints-deprecated.js");
 const helix_sessions_list_helix_session_checkpoints_js_1 = require("../funcs/helix-sessions-list-helix-session-checkpoints.js");
+const helix_sessions_list_helix_sessions_deprecated_js_1 = require("../funcs/helix-sessions-list-helix-sessions-deprecated.js");
 const helix_sessions_list_helix_sessions_js_1 = require("../funcs/helix-sessions-list-helix-sessions.js");
 const helix_sessions_refresh_helix_session_token_js_1 = require("../funcs/helix-sessions-refresh-helix-session-token.js");
+const helix_sessions_restore_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-restore-helix-session-deprecated.js");
 const helix_sessions_restore_helix_session_js_1 = require("../funcs/helix-sessions-restore-helix-session.js");
+const helix_sessions_send_helix_session_input_deprecated_js_1 = require("../funcs/helix-sessions-send-helix-session-input-deprecated.js");
 const helix_sessions_send_helix_session_input_js_1 = require("../funcs/helix-sessions-send-helix-session-input.js");
 const helix_sessions_set_helix_default_models_js_1 = require("../funcs/helix-sessions-set-helix-default-models.js");
+const helix_sessions_signal_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-signal-helix-session-deprecated.js");
 const helix_sessions_signal_helix_session_js_1 = require("../funcs/helix-sessions-signal-helix-session.js");
+const helix_sessions_stream_helix_session_deprecated_js_1 = require("../funcs/helix-sessions-stream-helix-session-deprecated.js");
 const helix_sessions_stream_helix_session_js_1 = require("../funcs/helix-sessions-stream-helix-session.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("../types/fp.js");
 class HelixSessions extends sdks_js_1.ClientSDK {
     /**
-     * Launch a Helix session
+     * Launch a session (the helix harness)
      *
      * @remarks
-     * Uses the configured Helix preset and sandbox provider. Defaults: arm `classic`, mode `interactive`. With `agent`, runs a managed agent: the slot (agent and `environment`) selects the revision, the revision is copied into the sandbox and started on the `agent` arm, and the response names `agent.slug` and `agent.revision`. Returns the session reference. If the new sandbox cannot be set up, the start is refused after the sandbox is released: 503 `SANDBOX_SETUP_TIMEOUT` when setup ran out of time (retry), 502 `SANDBOX_SETUP_FAILED` when it failed. Disconnecting does not stop the session; an idle sandbox stops after 15 minutes.
+     * Starts a session of the helix harness. With `harness` helix: the configured Helix preset and sandbox provider; defaults: arm `classic`, mode `interactive`; with `agent`, runs a managed agent (the slot, agent and `environment`, selects the revision; the response names `agent.slug` and `agent.revision`). A harness preset (another harness) is a 422 `SESSION_HARNESS_MISMATCH`. Returns the session reference. If the new sandbox cannot be set up, the start is refused after the sandbox is released: 503 `SANDBOX_SETUP_TIMEOUT` (retry) or 502 `SANDBOX_SETUP_FAILED`. Disconnecting does not stop the session; an idle sandbox stops after 15 minutes.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
-    async launchHelixSession(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_launch_helix_session_js_1.helixSessionsLaunchHelixSession)(this, request, options));
+    async launchHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_launch_helix_session_deprecated_js_1.helixSessionsLaunchHelixSessionDeprecated)(this, request, options));
     }
     /**
-     * List the workspace's Helix sessions across all sandboxes
+     * List the workspace's sessions (the helix harness)
      *
      * @remarks
-     * Every Helix session the workspace has, live and ended, in every sandbox, newest activity first. Assembled from the persisted event log and the sandbox records: a live row is a session with no terminal frame in a live sandbox, ended rows carry the exit code, a session whose sandbox was stopped for idling is `stopped-for-idling`, and a session in a restored sandbox is `restored`. Each row has `reference`, `sandboxId`, `arm` and `mode` (when known), `seqHighWater` and activity times, and no Environment values. Requires `sandbox:read`. Paged: pass `nextCursor` back as `?cursor=`.
+     * The workspace's sessions of the helix harness only. Live and ended, in every sandbox, newest activity first. A live row is a session with no terminal frame in a live sandbox, ended rows carry the exit code, a session whose sandbox was stopped for idling is `stopped-for-idling`, and a session in a restored sandbox is `restored`. Each row has `reference`, `sandboxId`, `arm` and `mode` (when known), `caller` and `harness`, `seqHighWater` and activity times, and no Environment values. Requires `sandbox:read`. Paged: pass `nextCursor` back as `?cursor=`. With a filter, one request reads a bounded number of sessions, so a page can hold fewer rows than `limit` (even none) while `nextCursor` is present: keep paging until it is absent.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
-    async listHelixSessions(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_list_helix_sessions_js_1.helixSessionsListHelixSessions)(this, request, options));
+    async listHelixSessionsDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_list_helix_sessions_deprecated_js_1.helixSessionsListHelixSessionsDeprecated)(this, request, options));
     }
     /**
      * Send a JSON command to a session
      *
      * @remarks
-     * `line` is one serialised JSON object. Requires `sandbox:exec` on the session's workspace. Helix's reply arrives on the session stream. A session whose sandbox no longer runs it is ended and, when it can be, restored from its last checkpoint and sent the line (`wake`); otherwise 410 `SESSION_GONE`.
+     * `line` is one serialised JSON object. Requires `sandbox:exec` on the session's workspace. The reply arrives on the session stream. A session whose sandbox no longer runs it is ended and, when it can be, restored from its last checkpoint and sent the line (`wake`); otherwise 410 `SESSION_GONE`.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
-    async sendHelixSessionInput(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_send_helix_session_input_js_1.helixSessionsSendHelixSessionInput)(this, request, options));
+    async sendHelixSessionInputDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_send_helix_session_input_deprecated_js_1.helixSessionsSendHelixSessionInputDeprecated)(this, request, options));
     }
     /**
      * Close a session's input
      *
      * @remarks
      * Sends end-of-file to the session's stdin. Calling it again succeeds. It is not an abort and not a signal. A sandbox image that cannot close input answers 422. The session's remaining output and its exit arrive on the stream. 410 `SESSION_GONE` when the session's sandbox no longer runs it.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
-    async closeHelixSessionInput(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_close_helix_session_input_js_1.helixSessionsCloseHelixSessionInput)(this, request, options));
+    async closeHelixSessionInputDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_close_helix_session_input_deprecated_js_1.helixSessionsCloseHelixSessionInputDeprecated)(this, request, options));
     }
     /**
-     * End a Helix session
+     * End a session
      *
      * @remarks
      * Ends the session and removes the sandbox that hosts it, with every other session on it. Requires an operator token on the session's workspace (`sandbox:delete`), or the session's OWN sandbox token, which may end its own session only; any other sandbox token is 403 `SESSION_NOT_OWN`. A reference with no live session in the workspace is 404 `SESSION_NOT_FOUND`. Answers name the session reference only.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
-    async endHelixSession(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_end_helix_session_js_1.helixSessionsEndHelixSession)(this, request, options));
+    async endHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_end_helix_session_deprecated_js_1.helixSessionsEndHelixSessionDeprecated)(this, request, options));
+    }
+    /**
+     * Stop a session's live process
+     *
+     * @remarks
+     * Signals this session's process. The sandbox keeps running. Omitted `signal` sends SIGTERM. 409 when the session has already ended.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    async signalHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_signal_helix_session_deprecated_js_1.helixSessionsSignalHelixSessionDeprecated)(this, request, options));
+    }
+    /**
+     * Checkpoint a session
+     *
+     * @remarks
+     * Saves the session's transcript and, where supported, its working directory and settings. 409 before the session has finished a turn.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    async checkpointHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_checkpoint_helix_session_deprecated_js_1.helixSessionsCheckpointHelixSessionDeprecated)(this, request, options));
     }
     /**
-     * Refresh a running session's sandbox token
+     * List the checkpoints of a session's sandbox
+     *
+     * @remarks
+     * Newest first, without the stored bytes. Covers every session the sandbox has hosted; each row names its session. Requires `sandbox:read`.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    async listHelixSessionCheckpointsDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_list_helix_session_checkpoints_deprecated_js_1.helixSessionsListHelixSessionCheckpointsDeprecated)(this, request, options));
+    }
+    /**
+     * Restore a session from a checkpoint
+     *
+     * @remarks
+     * Rebuilds the session's sandbox from a checkpoint and starts a new session of the same harness; the response carries the new session reference. The old sandbox does not need to exist. Same body as `POST /api/sandbox/{id}/restore`. A session that ran a managed agent restores with the same revision re-staged and its environment rebuilt. It is refused with 409 `MANAGED_AGENT_REVISION_UNAVAILABLE`, `MANAGED_AGENT_SLOT_UNAVAILABLE`, `MANAGED_AGENT_SLOT_RETIRED` or `MANAGED_AGENT_ARCHIVED`, or 404 `AGENT_NOT_FOUND`, when the revision, the slot or the agent is gone, retired or archived, and with 409 `MANAGED_AGENT_RESTORE_UNSUPPORTED` when its checkpoint predates the agent record.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    async restoreHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_restore_helix_session_deprecated_js_1.helixSessionsRestoreHelixSessionDeprecated)(this, request, options));
+    }
+    /**
+     * Stream a session's output
+     *
+     * @remarks
+     * Server-sent events for this session only; pass `?since=<seq>` to resume. The stream ends when the session exits. `rpc` events carry the harness's JSON lines unchanged; the event name refers to the JSON-lines RPC protocol, not to the session mode. Disconnecting does not stop the session. After an API restart the stream can open with `live: false` and replay stored events only.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+     */
+    async streamHelixSessionDeprecated(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_stream_helix_session_deprecated_js_1.helixSessionsStreamHelixSessionDeprecated)(this, request, options));
+    }
+    /**
+     * Refresh a running session's sandbox token (deprecated: POST /api/sandbox/sessions/token)
      *
      * @remarks
      * A session's task token lives one hour. Its Helix process trades its LIVE token for a fresh one before it expires: the same session and scopes, a new expiry. Only a session's own token, while its sandbox exists (404 otherwise); an expired token is 401 and cannot be revived; any other token 403.
+     *
+     * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
     async refreshHelixSessionToken(options) {
         return (0, fp_js_1.unwrapAsync)((0, helix_sessions_refresh_helix_session_token_js_1.helixSessionsRefreshHelixSessionToken)(this, options));
@@ -85,16 +162,79 @@ class HelixSessions extends sdks_js_1.ClientSDK {
         return (0, fp_js_1.unwrapAsync)((0, helix_sessions_get_helix_access_js_1.helixSessionsGetHelixAccess)(this, options));
     }
     /**
-     * Stop a live Helix process
+     * List the workspace's Helix Cloud models and its default
+     *
+     * @remarks
+     * The platform model catalog restricted to the workspace's active LLM providers, each as `provider/model` as Helix names it, plus the stored ordered defaults and the model a run that names none uses now. LLM providers whose keys Helix cannot load are listed in `unmapped`. Requires `sandbox:read`.
+     */
+    async getHelixModels(options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_get_helix_models_js_1.helixSessionsGetHelixModels)(this, options));
+    }
+    /**
+     * Set the workspace's default Helix Cloud models
+     *
+     * @remarks
+     * Replaces the ordered list; the first entry becomes the default for session starts and agent runs that name no model. Every entry must be in the workspace’s list (422 names the list). `[]` clears the defaults, after which such runs answer 428 NO_PROVIDER_CONFIGURED. Operator tokens only. 409 `HELIX_DEFAULTS_UNAVAILABLE` when this server has no Helix Cloud model source configured.
+     */
+    async setHelixDefaultModels(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_set_helix_default_models_js_1.helixSessionsSetHelixDefaultModels)(this, request, options));
+    }
+    /**
+     * Launch a session (the helix harness)
+     *
+     * @remarks
+     * Starts a session of the helix harness. With `harness` helix: the configured Helix preset and sandbox provider; defaults: arm `classic`, mode `interactive`; with `agent`, runs a managed agent (the slot, agent and `environment`, selects the revision; the response names `agent.slug` and `agent.revision`). A harness preset (another harness) is a 422 `SESSION_HARNESS_MISMATCH`. Returns the session reference. If the new sandbox cannot be set up, the start is refused after the sandbox is released: 503 `SANDBOX_SETUP_TIMEOUT` (retry) or 502 `SANDBOX_SETUP_FAILED`. Disconnecting does not stop the session; an idle sandbox stops after 15 minutes.
+     */
+    async launchHelixSession(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_launch_helix_session_js_1.helixSessionsLaunchHelixSession)(this, request, options));
+    }
+    /**
+     * List the workspace's sessions (the helix harness)
+     *
+     * @remarks
+     * The workspace's sessions of the helix harness only. Live and ended, in every sandbox, newest activity first. A live row is a session with no terminal frame in a live sandbox, ended rows carry the exit code, a session whose sandbox was stopped for idling is `stopped-for-idling`, and a session in a restored sandbox is `restored`. Each row has `reference`, `sandboxId`, `arm` and `mode` (when known), `caller` and `harness`, `seqHighWater` and activity times, and no Environment values. Requires `sandbox:read`. Paged: pass `nextCursor` back as `?cursor=`. With a filter, one request reads a bounded number of sessions, so a page can hold fewer rows than `limit` (even none) while `nextCursor` is present: keep paging until it is absent.
+     */
+    async listHelixSessions(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_list_helix_sessions_js_1.helixSessionsListHelixSessions)(this, request, options));
+    }
+    /**
+     * Send a JSON command to a session
+     *
+     * @remarks
+     * `line` is one serialised JSON object. Requires `sandbox:exec` on the session's workspace. The reply arrives on the session stream. A session whose sandbox no longer runs it is ended and, when it can be, restored from its last checkpoint and sent the line (`wake`); otherwise 410 `SESSION_GONE`.
+     */
+    async sendHelixSessionInput(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_send_helix_session_input_js_1.helixSessionsSendHelixSessionInput)(this, request, options));
+    }
+    /**
+     * Close a session's input
      *
      * @remarks
-     * Signals this session's Helix process. The sandbox keeps running. Omitted `signal` sends SIGTERM. 409 when the session has already ended.
+     * Sends end-of-file to the session's stdin. Calling it again succeeds. It is not an abort and not a signal. A sandbox image that cannot close input answers 422. The session's remaining output and its exit arrive on the stream. 410 `SESSION_GONE` when the session's sandbox no longer runs it.
+     */
+    async closeHelixSessionInput(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_close_helix_session_input_js_1.helixSessionsCloseHelixSessionInput)(this, request, options));
+    }
+    /**
+     * End a session
+     *
+     * @remarks
+     * Ends the session and removes the sandbox that hosts it, with every other session on it. Requires an operator token on the session's workspace (`sandbox:delete`), or the session's OWN sandbox token, which may end its own session only; any other sandbox token is 403 `SESSION_NOT_OWN`. A reference with no live session in the workspace is 404 `SESSION_NOT_FOUND`. Answers name the session reference only.
+     */
+    async endHelixSession(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_end_helix_session_js_1.helixSessionsEndHelixSession)(this, request, options));
+    }
+    /**
+     * Stop a session's live process
+     *
+     * @remarks
+     * Signals this session's process. The sandbox keeps running. Omitted `signal` sends SIGTERM. 409 when the session has already ended.
      */
     async signalHelixSession(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, helix_sessions_signal_helix_session_js_1.helixSessionsSignalHelixSession)(this, request, options));
     }
     /**
-     * Checkpoint a Helix session
+     * Checkpoint a session
      *
      * @remarks
      * Saves the session's transcript and, where supported, its working directory and settings. 409 before the session has finished a turn.
@@ -115,7 +255,7 @@ class HelixSessions extends sdks_js_1.ClientSDK {
      * Restore a session from a checkpoint
      *
      * @remarks
-     * Rebuilds the session's sandbox from a checkpoint and starts a new session; the response carries the new session reference. The old sandbox does not need to exist. Same body as `POST /api/sandbox/{id}/restore`. A session that ran a managed agent restores with the same revision re-staged and its environment rebuilt. It is refused with 409 `MANAGED_AGENT_REVISION_UNAVAILABLE`, `MANAGED_AGENT_SLOT_UNAVAILABLE`, `MANAGED_AGENT_SLOT_RETIRED` or `MANAGED_AGENT_ARCHIVED`, or 404 `AGENT_NOT_FOUND`, when the revision, the slot or the agent is gone, retired or archived, and with 409 `MANAGED_AGENT_RESTORE_UNSUPPORTED` when its checkpoint predates the agent record.
+     * Rebuilds the session's sandbox from a checkpoint and starts a new session of the same harness; the response carries the new session reference. The old sandbox does not need to exist. Same body as `POST /api/sandbox/{id}/restore`. A session that ran a managed agent restores with the same revision re-staged and its environment rebuilt. It is refused with 409 `MANAGED_AGENT_REVISION_UNAVAILABLE`, `MANAGED_AGENT_SLOT_UNAVAILABLE`, `MANAGED_AGENT_SLOT_RETIRED` or `MANAGED_AGENT_ARCHIVED`, or 404 `AGENT_NOT_FOUND`, when the revision, the slot or the agent is gone, retired or archived, and with 409 `MANAGED_AGENT_RESTORE_UNSUPPORTED` when its checkpoint predates the agent record.
      */
     async restoreHelixSession(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, helix_sessions_restore_helix_session_js_1.helixSessionsRestoreHelixSession)(this, request, options));
@@ -124,29 +264,11 @@ class HelixSessions extends sdks_js_1.ClientSDK {
      * Stream a session's output
      *
      * @remarks
-     * Server-sent events for this session only; pass `?since=<seq>` to resume. The stream ends when the session exits. `rpc` events carry Helix's JSON lines unchanged; the event name refers to the JSON-lines RPC protocol Helix speaks, not to the session mode. Disconnecting does not stop the session. After an API restart the stream can open with `live: false` and replay stored events only.
+     * Server-sent events for this session only; pass `?since=<seq>` to resume. The stream ends when the session exits. `rpc` events carry the harness's JSON lines unchanged; the event name refers to the JSON-lines RPC protocol, not to the session mode. Disconnecting does not stop the session. After an API restart the stream can open with `live: false` and replay stored events only.
      */
     async streamHelixSession(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, helix_sessions_stream_helix_session_js_1.helixSessionsStreamHelixSession)(this, request, options));
     }
-    /**
-     * List the workspace's Helix Cloud models and its default
-     *
-     * @remarks
-     * The platform model catalog restricted to the workspace's active LLM providers, each as `provider/model` as Helix names it, plus the stored ordered defaults and the model a run that names none uses now. LLM providers whose keys Helix cannot load are listed in `unmapped`. Requires `sandbox:read`.
-     */
-    async getHelixModels(options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_get_helix_models_js_1.helixSessionsGetHelixModels)(this, options));
-    }
-    /**
-     * Set the workspace's default Helix Cloud models
-     *
-     * @remarks
-     * Replaces the ordered list; the first entry becomes the default for session starts and agent runs that name no model. Every entry must be in the workspace’s list (422 names the list). `[]` clears the defaults, after which such runs answer 428 NO_PROVIDER_CONFIGURED. Operator tokens only. 409 `HELIX_DEFAULTS_UNAVAILABLE` when this server has no Helix Cloud model source configured.
-     */
-    async setHelixDefaultModels(request, options) {
-        return (0, fp_js_1.unwrapAsync)((0, helix_sessions_set_helix_default_models_js_1.helixSessionsSetHelixDefaultModels)(this, request, options));
-    }
 }
 exports.HelixSessions = HelixSessions;
 //# sourceMappingURL=helix-sessions.js.map

package/dist/commonjs/sdk/helix-sessions.js.map

@@ -1 +1 @@
-{"version":3,"file":"helix-sessions.js","sourceRoot":"","sources":["../../../src/sdk/helix-sessions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,oHAA0G;AAC1G,sHAA2G;AAC3G,sGAA4F;AAC5F,oGAA0F;AAC1F,oGAA0F;AAC1F,4GAAkG;AAClG,gIAAqH;AACrH,0GAAgG;AAChG,0HAA+G;AAC/G,8GAAoG;AACpG,oHAAyG;AACzG,oHAAyG;AACzG,4GAAkG;AAClG,4GAAkG;AAClG,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAkC,EAClC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAyD,EACzD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sEAA8B,EAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,+EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,iFAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kEAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,qFAAqC,EACtD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA2B,EAC5C,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gFAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,2FAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAgC,EACjD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA2B,EAC5C,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,+EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAxOD,sCAwOC"}
+{"version":3,"file":"helix-sessions.js","sourceRoot":"","sources":["../../../src/sdk/helix-sessions.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0IAA+H;AAC/H,oHAA0G;AAC1G,4IAAgI;AAChI,sHAA2G;AAC3G,4HAAiH;AACjH,sGAA4F;AAC5F,oGAA0F;AAC1F,oGAA0F;AAC1F,kIAAuH;AACvH,4GAAkG;AAClG,sJAA0I;AAC1I,gIAAqH;AACrH,gIAAqH;AACrH,0GAAgG;AAChG,0HAA+G;AAC/G,oIAAyH;AACzH,8GAAoG;AACpG,0IAA8H;AAC9H,oHAAyG;AACzG,oHAAyG;AACzG,kIAAuH;AACvH,4GAAkG;AAClG,kIAAuH;AACvH,4GAAkG;AAClG,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,aAAc,SAAQ,mBAAS;IAC1C;;;;;;;OAOG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAkC,EAClC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,6FAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAmE,EACnE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,2FAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,+BAA+B,CACnC,OAA0D,EAC1D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oGAA4C,EAC7D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sGAA6C,EAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAAoD,EACpD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,uFAAsC,EACvD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,6FAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA2D,EAC3D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,qGAA6C,EAC9D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qCAAqC,CACzC,OAAgE,EAChE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gHAAkD,EACnE,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,6BAA6B,CACjC,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,+FAA0C,EAC3D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAuD,EACvD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,6FAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,qFAAqC,EACtD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA2B,EAC5C,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA2B,EAC5C,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,+EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAkC,EAClC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAyD,EACzD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sEAA8B,EAC/C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,+EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,iFAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,OAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kEAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gFAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAAsD,EACtD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,2FAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAgC,EACjD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAxaD,sCAwaC"}

package/dist/commonjs/sdk/sandbox-sessions.d.ts

@@ -0,0 +1,195 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+export declare class SandboxSessions extends ClientSDK {
+    /**
+     * Launch a session (any harness)
+     *
+     * @remarks
+     * Starts a session of the named `harness` (required). With `harness` helix: the configured Helix preset and sandbox provider; defaults: arm `classic`, mode `interactive`; with `agent`, runs a managed agent (the slot, agent and `environment`, selects the revision; the response names `agent.slug` and `agent.revision`). Another harness runs its own preset when `preset` is omitted; a preset of another harness, or `agent`, is a 422 `SESSION_HARNESS_MISMATCH`. Returns the session reference. If the new sandbox cannot be set up, the start is refused after the sandbox is released: 503 `SANDBOX_SETUP_TIMEOUT` (retry) or 502 `SANDBOX_SETUP_FAILED`. Disconnecting does not stop the session; an idle sandbox stops after 15 minutes.
+     */
+    launchSandboxSession(request: models.SandboxSessionLaunchRequest, options?: RequestOptions): Promise<models.HelixLaunchedSession>;
+    /**
+     * List the workspace's sessions (any harness)
+     *
+     * @remarks
+     * Every session the workspace has, of every harness unless `?harness=` names one. Live and ended, in every sandbox, newest activity first. A live row is a session with no terminal frame in a live sandbox, ended rows carry the exit code, a session whose sandbox was stopped for idling is `stopped-for-idling`, and a session in a restored sandbox is `restored`. Each row has `reference`, `sandboxId`, `arm` and `mode` (when known), `caller` and `harness`, `seqHighWater` and activity times, and no Environment values. Requires `sandbox:read`. Paged: pass `nextCursor` back as `?cursor=`. With a filter, one request reads a bounded number of sessions, so a page can hold fewer rows than `limit` (even none) while `nextCursor` is present: keep paging until it is absent.
+     */
+    listSandboxSessions(request?: operations.ListSandboxSessionsRequest | undefined, options?: RequestOptions): Promise<models.HelixSessionList>;
+    /**
+     * Send a JSON command to a session
+     *
+     * @remarks
+     * `line` is one serialised JSON object. Requires `sandbox:exec` on the session's workspace. The reply arrives on the session stream. A session whose sandbox no longer runs it is ended and, when it can be, restored from its last checkpoint and sent the line (`wake`); otherwise 410 `SESSION_GONE`.
+     */
+    sendSandboxSessionInput(request: operations.SendSandboxSessionInputRequest, options?: RequestOptions): Promise<models.SessionInputAccepted>;
+    /**
+     * Close a session's input
+     *
+     * @remarks
+     * Sends end-of-file to the session's stdin. Calling it again succeeds. It is not an abort and not a signal. A sandbox image that cannot close input answers 422. The session's remaining output and its exit arrive on the stream. 410 `SESSION_GONE` when the session's sandbox no longer runs it.
+     */
+    closeSandboxSessionInput(request: operations.CloseSandboxSessionInputRequest, options?: RequestOptions): Promise<operations.CloseSandboxSessionInputResponse>;
+    /**
+     * End a session
+     *
+     * @remarks
+     * Ends the session and removes the sandbox that hosts it, with every other session on it. Requires an operator token on the session's workspace (`sandbox:delete`), or the session's OWN sandbox token, which may end its own session only; any other sandbox token is 403 `SESSION_NOT_OWN`. A reference with no live session in the workspace is 404 `SESSION_NOT_FOUND`. Answers name the session reference only.
+     */
+    endSandboxSession(request: operations.EndSandboxSessionRequest, options?: RequestOptions): Promise<models.HelixSessionEndResponse>;
+    /**
+     * Stop a session's live process
+     *
+     * @remarks
+     * Signals this session's process. The sandbox keeps running. Omitted `signal` sends SIGTERM. 409 when the session has already ended.
+     */
+    signalSandboxSession(request: operations.SignalSandboxSessionRequest, options?: RequestOptions): Promise<models.SessionSignalled>;
+    /**
+     * Checkpoint a session
+     *
+     * @remarks
+     * Saves the session's transcript and, where supported, its working directory and settings. 409 before the session has finished a turn.
+     */
+    checkpointSandboxSession(request: operations.CheckpointSandboxSessionRequest, options?: RequestOptions): Promise<models.Checkpoint>;
+    /**
+     * List the checkpoints of a session's sandbox
+     *
+     * @remarks
+     * Newest first, without the stored bytes. Covers every session the sandbox has hosted; each row names its session. Requires `sandbox:read`.
+     */
+    listSandboxSessionCheckpoints(request: operations.ListSandboxSessionCheckpointsRequest, options?: RequestOptions): Promise<models.CheckpointList>;
+    /**
+     * Restore a session from a checkpoint
+     *
+     * @remarks
+     * Rebuilds the session's sandbox from a checkpoint and starts a new session of the same harness; the response carries the new session reference. The old sandbox does not need to exist. Same body as `POST /api/sandbox/{id}/restore`. A session that ran a managed agent restores with the same revision re-staged and its environment rebuilt. It is refused with 409 `MANAGED_AGENT_REVISION_UNAVAILABLE`, `MANAGED_AGENT_SLOT_UNAVAILABLE`, `MANAGED_AGENT_SLOT_RETIRED` or `MANAGED_AGENT_ARCHIVED`, or 404 `AGENT_NOT_FOUND`, when the revision, the slot or the agent is gone, retired or archived, and with 409 `MANAGED_AGENT_RESTORE_UNSUPPORTED` when its checkpoint predates the agent record.
+     */
+    restoreSandboxSession(request: operations.RestoreSandboxSessionRequest, options?: RequestOptions): Promise<models.HelixSessionRestoreResult>;
+    /**
+     * Stream a session's output
+     *
+     * @remarks
+     * Server-sent events for this session only; pass `?since=<seq>` to resume. The stream ends when the session exits. `rpc` events carry the harness's JSON lines unchanged; the event name refers to the JSON-lines RPC protocol, not to the session mode. Disconnecting does not stop the session. After an API restart the stream can open with `live: false` and replay stored events only.
+     */
+    streamSandboxSession(request: operations.StreamSandboxSessionRequest, options?: RequestOptions): Promise<string>;
+    /**
+     * Refresh a running session's sandbox token
+     *
+     * @remarks
+     * A session's task token lives one hour. Its harness process trades its LIVE token for a fresh one before it expires: the same session and scopes, a new expiry. Only a session's own token, while its sandbox exists (404 otherwise); an expired token is 401 and cannot be revived; any other token 403.
+     */
+    refreshSandboxSessionToken(options?: RequestOptions): Promise<models.HelixSessionToken>;
+    /**
+     * The workspace's Helix Cloud models and default
+     *
+     * @remarks
+     * The same data as `GET /api/sandbox/helix/defaults`, for a signed-in workspace member.
+     */
+    getSandboxSessionWebDefaults(options?: RequestOptions): Promise<models.HelixModelList>;
+    /**
+     * Can this workspace run a session
+     *
+     * @remarks
+     * `canRun` is true when nothing is missing. `missing` lists, in order: `llm-provider` (no LLM provider Helix can use), `default-model` (no default model), `sandbox-provider` (no reachable sandbox provider, or cloud sandboxes are not enabled for the workspace), `sandbox-preset` (this backend has no sandbox preset configured, so a start would fail; set by the server administrator). `advisory` lists what is worth setting up but does not stop a run: `repository` (no linked repository; a session starts without a checkout).
+     */
+    getSandboxSessionWebReadiness(options?: RequestOptions): Promise<models.HelixCloudReadiness>;
+    /**
+     * The workspace's sessions
+     *
+     * @remarks
+     * Every Helix Cloud session in the workspace, newest activity first, with its title, goal, repository, model, thinking and status. Archived sessions are left out unless `archived=true`; a page can then hold fewer rows than `limit`, and `nextCursor` still pages on.
+     */
+    listSandboxWebSessions(request?: operations.ListSandboxWebSessionsRequest | undefined, options?: RequestOptions): Promise<models.HelixCloudSessionList>;
+    /**
+     * Start a session with its goal
+     *
+     * @remarks
+     * Starts a Helix Cloud session on the platform preset and sends `goal` as its first prompt, in one call. 422 for a model outside the workspace list; 428 `NO_PROVIDER_CONFIGURED` when no model is named and the workspace has no default. `environment` names a workspace Environment to load; omitted, none is loaded; 404 when the workspace has none by that name, before any sandbox starts. `repository` (`owner/name`, any repository the GitHub installation of the workspace can reach; one not linked yet is linked to the workspace first, as the caller) is checked out in the new sandbox at `branch` (else its default branch) through the workspace GitHub installation, and the session starts in that checkout; the branch checked out is recorded on the session. The refusals are one table (`code`): 400 `BRANCH_WITHOUT_REPOSITORY` / `INVALID_BRANCH_NAME`; 409 `github_not_connected` / `installation_suspended` / `installation_revoked`; 422 `repository_inaccessible` (the Mutagent GitHub App cannot reach the repository: give it access on GitHub) / `BRANCH_NOT_FOUND`; 503 `BRANCH_CHECK_UNAVAILABLE` (GitHub unreachable) / `REPOSITORY_CHECKOUT_UNAVAILABLE` (this server cannot check out), all before any sandbox starts; 502 `CHECKOUT_FAILED` when the checkout fails, and its sandbox is released. `subject` (F20) opens the session for a Factory entry with no stage: bound to the entry, no stage run opened, `goal` is its hidden `/<stage> …` first message; refused before any sandbox with 404 `ENTRY_NOT_FOUND`, 409 `ENTRY_ARCHIVED`, or 403 `PERMISSION_DENIED` when the caller may launch none of its stages. Setting up the new sandbox can also refuse the start, after releasing it: 503 `SANDBOX_SETUP_TIMEOUT` when setup ran out of time (retry), 502 `SANDBOX_SETUP_FAILED` when it failed. If the goal cannot be sent, the new sandbox is released.
+     */
+    startSandboxWebSession(request: models.SandboxSessionWebStartRequest, options?: RequestOptions): Promise<models.HelixCloudStarted>;
+    /**
+     * One session
+     *
+     * @remarks
+     * The row the list shows for this session. 404 for a session outside the caller workspace.
+     */
+    getSandboxWebSession(request: operations.GetSandboxWebSessionRequest, options?: RequestOptions): Promise<models.HelixCloudSession>;
+    /**
+     * Rename a session
+     *
+     * @remarks
+     * Sets the session's title and answers its row as the list shows it. `title` is trimmed; blank, or over 200 characters, is 422. A session restored from another (a wake included) is one thread with it: renaming any member of that chain renames all of them. Works for a session started outside the web too. Nothing else changes: an archived session stays archived. 404 for a session outside the caller workspace.
+     */
+    renameSandboxWebSession(request: operations.RenameSandboxWebSessionRequest, options?: RequestOptions): Promise<models.HelixCloudSession>;
+    /**
+     * A session's branch, diff and files
+     *
+     * @remarks
+     * Read from the session's sandbox: the checked-out branch, the changes against HEAD (per file, lines classified) and the file index. The root is the session's home directory when it is a git work tree, else the first repository directly under it. Capped at 5000 files and 1 MiB of diff (`truncated` says which). 502 when the sandbox cannot answer.
+     */
+    getSandboxWebSessionWorkspace(request: operations.GetSandboxWebSessionWorkspaceRequest, options?: RequestOptions): Promise<models.HelixCloudSessionWorkspace>;
+    /**
+     * What the session is waiting on
+     *
+     * @remarks
+     * The questions the session asked and is waiting on a human to answer (a confirm, a choice, or text). While any is open the session is `needs-input`.
+     */
+    listSandboxSessionWebApprovals(request: operations.ListSandboxSessionWebApprovalsRequest, options?: RequestOptions): Promise<models.HelixCloudApprovalList>;
+    /**
+     * Answer what the session is waiting on
+     *
+     * @remarks
+     * Sends the answer to the session. 404 when the question is not open any more (answered elsewhere or timed out); 400 when the answer does not fit it (a value missing, or not one of the options).
+     */
+    answerSandboxSessionWebApproval(request: operations.AnswerSandboxSessionWebApprovalRequest, options?: RequestOptions): Promise<void>;
+    /**
+     * Attach a file to a session
+     *
+     * @remarks
+     * Uploads one file into the session's sandbox at `$HOME/uploads/<name>` and answers the path, which a message can then name. The name is reduced to a safe base name. 413 over 10 MiB.
+     */
+    attachSandboxSessionWebFile(request: operations.AttachSandboxSessionWebFileRequest, options?: RequestOptions): Promise<models.HelixCloudAttached>;
+    /**
+     * Archive a session
+     *
+     * @remarks
+     * Takes the session out of the default list. It keeps running if it is running; archiving is a list fact, not a stop. 404 for a session outside the caller workspace.
+     */
+    archiveSandboxWebSession(request: operations.ArchiveSandboxWebSessionRequest, options?: RequestOptions): Promise<void>;
+    /**
+     * Send a message to a session
+     *
+     * @remarks
+     * Sends `text` to the session as one prompt. The reply arrives on the session's stream. 404 for a session outside the caller's workspace. A session stopped for idling is woken: it is restored from its last checkpoint onto a new sandbox generation and the message is delivered once Helix is up; `wake` then carries the restored session's `reference` (`delivered`), or says the restore is still running (`waking`) and the message is delivered when it finishes. Messages sent meanwhile are delivered in order, each once. A session whose sandbox no longer runs it (its sandbox instance was replaced) is woken the same way when it can be; otherwise 410 `SESSION_GONE`, whose message says how to get it back.
+     */
+    sendSandboxWebSessionInput(request: operations.SendSandboxWebSessionInputRequest, options?: RequestOptions): Promise<models.HelixCloudAccepted>;
+    /**
+     * Stop the session's current reply
+     *
+     * @remarks
+     * Sends Helix's `abort` to the session: the reply it is writing ends, and the session stays running with its context, so the next message is answered at once. Between replies it changes nothing. 409 when the session is not running (it ended, or it is asleep after idling); nothing is woken. To end the session's process instead, use `POST /helix-cloud/sessions/{reference}/signal`.
+     */
+    interruptSandboxWebSession(request: operations.InterruptSandboxWebSessionRequest, options?: RequestOptions): Promise<models.HelixCloudInterrupted>;
+    /**
+     * Stop a session
+     *
+     * @remarks
+     * Signals the session's Helix process; the sandbox keeps running. Omitted `signal` sends SIGTERM. 409 when the session has already ended.
+     */
+    signalSandboxWebSession(request: operations.SignalSandboxWebSessionRequest, options?: RequestOptions): Promise<models.HelixCloudSignalled>;
+    /**
+     * Stream a session's events
+     *
+     * @remarks
+     * Server-sent events for this session; pass `?since=<seq>` to resume. The same stream `GET /api/sandbox/helix/sessions/{reference}/stream` serves.
+     */
+    streamSandboxWebSession(request: operations.StreamSandboxWebSessionRequest, options?: RequestOptions): Promise<string>;
+    /**
+     * Publish a session's work as a pull request
+     *
+     * @remarks
+     * Recreates the session's committed work (its checkout's HEAD against the commit it started from) as one commit on `helix/session-…` of the session's repository, and opens a pull request into the branch the session started from, as the MutagenT GitHub App. The sandbox never holds the write token: the platform reads the change out of it and writes it through GitHub's Git Data API. The branch is created, or fast-forwarded over this session's own last publish only; it is never forced and never the default branch. Symlinks and any path git refuses are refused. A second publish returns the open pull request (200). The commit and the pull request name the session (`Helix-Session: hs1_…`). The platform also publishes when a session ends. The base is the commit the platform recorded when the session started; the sandbox's claim must equal it. Refusals: 404 SESSION_NOT_FOUND; 409 SESSION_HAS_NO_REPOSITORY, SESSION_ENDED, NO_NEW_COMMITS, CHECKOUT_UNKNOWN, BASE_UNRECORDED, BASE_MISMATCH, BASE_NOT_IN_REPOSITORY, BASE_NOT_ON_BRANCH, BRANCH_DIVERGED, BRANCH_NOT_OURS, SANDBOX_UNSUPPORTED, PULL_REQUEST_REFUSED, REPOSITORY_ACCESS_DENIED, GITHUB_INSTALLATION_SUSPENDED; 422 UNSAFE_PATH, UNSUPPORTED_CHANGE, CHANGE_TOO_LARGE; 424 GITHUB_APP_PERMISSIONS_MISSING (the App installation must grant contents:write and pull_requests:write); 429 GITHUB_RATE_LIMITED; 502 HELPER_FAILED (the sandbox's helper crashed after it said it could export); 503 PUBLISH_UNAVAILABLE. SANDBOX_UNSUPPORTED means the sandbox's helper does not list both `export_changes` and `read_blob` in its probe. A sandbox token is refused with 403.
+     */
+    publishSandboxWebSession(request: operations.PublishSandboxWebSessionRequest, options?: RequestOptions): Promise<models.HelixCloudPublished>;
+}
+//# sourceMappingURL=sandbox-sessions.d.ts.map

package/dist/commonjs/sdk/sandbox-sessions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox-sessions.d.ts","sourceRoot":"","sources":["../../../src/sdk/sandbox-sessions.ts"],"names":[],"mappings":"AA+BA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,eAAgB,SAAQ,SAAS;IAC5C;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,MAAM,CAAC,2BAA2B,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;OAKG;IACG,mBAAmB,CACvB,OAAO,CAAC,EAAE,UAAU,CAAC,0BAA0B,GAAG,SAAS,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAQvC;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAQ1C;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;IAQ7B;;;;;OAKG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;IAQjC;;;;;OAKG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC;IAQ5C;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;;OAKG;IACG,0BAA0B,CAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;IAOpC;;;;;OAKG;IACG,4BAA4B,CAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;IAOjC;;;;;OAKG;IACG,6BAA6B,CACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAOtC;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,CAAC,EAAE,UAAU,CAAC,6BAA6B,GAAG,SAAS,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,MAAM,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;IAQpC;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;IAQpC;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;IAQpC;;;;;OAKG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,0BAA0B,CAAC;IAQ7C;;;;;OAKG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;OAKG;IACG,+BAA+B,CACnC,OAAO,EAAE,UAAU,CAAC,sCAAsC,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;OAKG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAQrC;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;OAKG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAQrC;;;;;OAKG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;IAQtC;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;IAQlB;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC;CAOvC"}