@synsci/sdk 2.0.23 → 2.0.24

package/dist/src/v2/gen/sdk.gen.js

@@ -351,7 +351,7 @@ export class Storage extends HeyApiClient {
     /**
      * Get storage usage
      *
-     * Real on-disk sizes for the OpenScience data directory and its top-level entries.
+     * Real on-disk sizes for the active OpenScience data directory and its top-level entries.
      */
     usage(options) {
         return (options?.client ?? this.client).get({
@@ -362,18 +362,15 @@ export class Storage extends HeyApiClient {
     /**
      * Reset data location
      *
-     * Remove the data-location pointer so ~/.openscience is used on next launch.
+     * Reverse-migrate the active data into ~/.openscience, atomically switch every running process, and preserve the previous default as a timestamped backup.
      */
     resetLocation(options) {
-        return (options?.client ?? this.client).delete({
-            url: "/settings/storage/location",
-            ...options,
-        });
+        return (options?.client ?? this.client).delete({ url: "/settings/storage/location", ...options });
     }
     /**
      * Change data location
      *
-     * Copy the data directory to a new absolute path and record a pointer honoured on next launch. Requires restart.
+     * Take a verified snapshot, drain active writers, atomically switch every running OpenScience process, and retain the source as a safety copy.
      */
     relocate(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "body", key: "path" }] }]);
@@ -550,6 +547,8 @@ export class Ssh extends HeyApiClient {
                     { in: "body", key: "port" },
                     { in: "body", key: "scheduler" },
                     { in: "body", key: "workdir" },
+                    { in: "body", key: "notes" },
+                    { in: "body", key: "concurrency" },
                 ],
             },
         ]);
@@ -586,6 +585,29 @@ export class Ssh extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * Update SSH host notes
+     */
+    update(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "id" },
+                    { in: "body", key: "notes" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).patch({
+            url: "/settings/compute/ssh/{id}",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
 }
 export class Jobs extends HeyApiClient {
     /**
@@ -600,7 +622,7 @@ export class Jobs extends HeyApiClient {
         });
     }
     /**
-     * Start a local compute job
+     * Start a compute job
      */
     start(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -608,6 +630,7 @@ export class Jobs extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "name" },
+                    { in: "body", key: "purpose" },
                     { in: "body", key: "command" },
                     { in: "body", key: "cwd" },
                     { in: "body", key: "target" },
@@ -637,7 +660,7 @@ export class Jobs extends HeyApiClient {
         });
     }
     /**
-     * Prepare an exact Modal run plan for approval
+     * Prepare an exact remote run plan for approval
      */
     plan(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -645,6 +668,7 @@ export class Jobs extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "name" },
+                    { in: "body", key: "purpose" },
                     { in: "body", key: "command" },
                     { in: "body", key: "cwd" },
                     { in: "body", key: "target" },
@@ -721,7 +745,7 @@ export class Jobs extends HeyApiClient {
         });
     }
     /**
-     * Retry delivery from a retained Modal resource
+     * Retry output delivery from a retained remote resource
      */
     retry(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -738,6 +762,24 @@ export class Jobs extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * Release retained compute resources
+     */
+    release(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "id" },
+                    { in: "query", key: "directory" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/settings/compute/jobs/{id}/release",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Cancel a compute job
      */
@@ -1085,7 +1127,7 @@ export class Trust extends HeyApiClient {
     /**
      * Inspect project trust
      *
-     * Inspect whether project-local code may execute. Project code is enabled by default and remains disabled only after an explicit revocation.
+     * Inspect whether project-local code may execute. New and relocated projects are untrusted until their canonical root is explicitly approved.
      */
     get(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -2008,6 +2050,7 @@ export class Session extends HeyApiClient {
                     { in: "body", key: "agent" },
                     { in: "body", key: "noReply" },
                     { in: "body", key: "tools" },
+                    { in: "body", key: "effort" },
                     { in: "body", key: "delegation" },
                     { in: "body", key: "system" },
                     { in: "body", key: "variant" },
@@ -2064,6 +2107,7 @@ export class Session extends HeyApiClient {
                     { in: "body", key: "agent" },
                     { in: "body", key: "noReply" },
                     { in: "body", key: "tools" },
+                    { in: "body", key: "effort" },
                     { in: "body", key: "delegation" },
                     { in: "body", key: "system" },
                     { in: "body", key: "variant" },
@@ -2354,6 +2398,77 @@ export class Permission extends HeyApiClient {
         return (this._standing ??= new Standing({ client: this.client }));
     }
 }
+export class Runtime extends HeyApiClient {
+    /**
+     * Start a research run
+     *
+     * Accepts a prompt and returns immediately while the Research agent continues in the background.
+     */
+    prompt(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                    { in: "body", key: "message" },
+                    { in: "body", key: "effort" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/runtime/prompt",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Replay research run events
+     *
+     * Returns retained events strictly after the supplied per-session sequence cursor.
+     */
+    replay(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                    { in: "query", key: "afterSequence" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/runtime/events/replay",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Subscribe to research run events
+     *
+     * Replays retained events after a cursor, then streams live events with SSE id fields equal to their sequence numbers.
+     */
+    subscribe(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                    { in: "query", key: "afterSequence" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).sse.get({
+            url: "/runtime/events",
+            ...options,
+            ...params,
+        });
+    }
+}
 export class Search extends HeyApiClient {
     /**
      * Search sessions, messages, and artifacts
@@ -2589,6 +2704,47 @@ export class Find extends HeyApiClient {
         });
     }
 }
+export class Trash extends HeyApiClient {
+    /**
+     * List recoverable source files
+     *
+     * List source and workspace files deleted by approved edit operations during the 30-day recovery window.
+     */
+    list(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "query", key: "directory" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/file/trash",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Restore a deleted source file
+     *
+     * Restore a source or workspace file during its 30-day recovery window without overwriting an existing path.
+     */
+    restore(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "id" },
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/file/trash/{id}/restore",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+}
 export class Artifact extends HeyApiClient {
     /**
      * Save a file as a versioned artifact
@@ -2621,7 +2777,7 @@ export class Artifact extends HeyApiClient {
 }
 export class ArtifactStore extends HeyApiClient {
     /**
-     * List saved artifacts
+     * List saved Results
      *
      * List active or recoverable trashed artifacts from this project's local artifact database.
      */
@@ -2641,7 +2797,7 @@ export class ArtifactStore extends HeyApiClient {
         });
     }
     /**
-     * Move a saved artifact to trash
+     * Move a saved Result to trash
      *
      * Hide an artifact from active Files while retaining every version for 30 days.
      */
@@ -2661,9 +2817,9 @@ export class ArtifactStore extends HeyApiClient {
         });
     }
     /**
-     * Read one saved artifact record
+     * Read one saved Result record
      *
-     * Read immutable version metadata and the current execution record for a saved artifact.
+     * Read immutable version metadata and the current execution record for a saved Result.
      */
     get(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -2681,7 +2837,7 @@ export class ArtifactStore extends HeyApiClient {
         });
     }
     /**
-     * Rename a saved artifact
+     * Rename a saved Result
      *
      * Rename the artifact record without changing any immutable version bytes.
      */
@@ -3245,6 +3401,10 @@ export class File extends HeyApiClient {
             ...params,
         });
     }
+    _trash;
+    get trash() {
+        return (this._trash ??= new Trash({ client: this.client }));
+    }
     _artifact;
     get artifact() {
         return (this._artifact ??= new Artifact({ client: this.client }));
@@ -3263,6 +3423,303 @@ export class File extends HeyApiClient {
     }
 }
 export class Command extends HeyApiClient {
+    /**
+     * Stop a live shell command
+     */
+    stop(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "commandID" },
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/commands/{commandID}/stop",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+}
+export class Kernels extends HeyApiClient {
+    /**
+     * Report live local runtime capacity
+     */
+    compute(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "query", key: "directory" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/kernels/compute",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * List live project shell commands
+     */
+    commands(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/kernels/commands",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * List session runtime records
+     */
+    list(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/kernels",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Restart in a fresh runtime
+     */
+    restartById(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "kernelID" },
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/{kernelID}/restart",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Stop a runtime process
+     */
+    stopById(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "kernelID" },
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/{kernelID}/stop",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Interrupt a live runtime
+     */
+    interruptById(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "kernelID" },
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/{kernelID}/interrupt",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Forget an inactive runtime record
+     */
+    delete(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "kernelID" },
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).delete({
+            url: "/kernels/{kernelID}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Run Python or R code
+     *
+     * Run code in a long-lived project-scoped Python or R process. State persists until restart, stop, or idle expiry.
+     */
+    execute(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                    { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                    { in: "body", key: "source" },
+                    { in: "body", key: "code" },
+                    { in: "body", key: "timeout" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/execute",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Get runtime status
+     */
+    status(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                    { in: "query", key: "language" },
+                    { in: "query", key: "environment" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/kernels/status",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Restart a runtime
+     */
+    restart(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                    { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/restart",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Stop a runtime
+     */
+    stop(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                    { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/stop",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Interrupt a running execution
+     *
+     * Stop the running execution while preserving process state when the runtime supports interruption.
+     */
+    interrupt(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "body", key: "sessionID" },
+                    { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/kernels/interrupt",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    _command;
+    get command() {
+        return (this._command ??= new Command({ client: this.client }));
+    }
+}
+export class Command2 extends HeyApiClient {
     /**
      * Stop a live shell command
      */
@@ -3440,8 +3897,9 @@ export class Notebook extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "sessionID" },
-                    { in: "body", key: "id" },
                     { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                    { in: "body", key: "id" },
                     { in: "body", key: "code" },
                     { in: "body", key: "timeout" },
                 ],
@@ -3467,8 +3925,9 @@ export class Notebook extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "query", key: "sessionID" },
-                    { in: "query", key: "id" },
                     { in: "query", key: "language" },
+                    { in: "query", key: "environment" },
+                    { in: "query", key: "id" },
                 ],
             },
         ]);
@@ -3487,8 +3946,9 @@ export class Notebook extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "sessionID" },
-                    { in: "body", key: "id" },
                     { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                    { in: "body", key: "id" },
                 ],
             },
         ]);
@@ -3512,8 +3972,9 @@ export class Notebook extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "sessionID" },
-                    { in: "body", key: "id" },
                     { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                    { in: "body", key: "id" },
                 ],
             },
         ]);
@@ -3539,8 +4000,9 @@ export class Notebook extends HeyApiClient {
                 args: [
                     { in: "query", key: "directory" },
                     { in: "body", key: "sessionID" },
-                    { in: "body", key: "id" },
                     { in: "body", key: "language" },
+                    { in: "body", key: "environment" },
+                    { in: "body", key: "id" },
                 ],
             },
         ]);
@@ -3557,7 +4019,7 @@ export class Notebook extends HeyApiClient {
     }
     _command;
     get command() {
-        return (this._command ??= new Command({ client: this.client }));
+        return (this._command ??= new Command2({ client: this.client }));
     }
     _kernel;
     get kernel() {
@@ -3692,6 +4154,26 @@ export class Provenance extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * List durable execution history
+     *
+     * Returns the ordered, project-scoped execution record used by Activity, including runtime identity, restarts, outputs, files, artifacts, and provenance.
+     */
+    executions(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "directory" },
+                    { in: "query", key: "sessionID" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/provenance/executions",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Trace a provenance node
      */
@@ -4003,7 +4485,7 @@ export class Vcs extends HeyApiClient {
         });
     }
 }
-export class Command2 extends HeyApiClient {
+export class Command3 extends HeyApiClient {
     /**
      * List commands
      *
@@ -4308,6 +4790,10 @@ export class OpenScienceClient extends HeyApiClient {
     get permission() {
         return (this._permission ??= new Permission({ client: this.client }));
     }
+    _runtime;
+    get runtime() {
+        return (this._runtime ??= new Runtime({ client: this.client }));
+    }
     _search;
     get search() {
         return (this._search ??= new Search({ client: this.client }));
@@ -4328,6 +4814,10 @@ export class OpenScienceClient extends HeyApiClient {
     get file() {
         return (this._file ??= new File({ client: this.client }));
     }
+    _kernels;
+    get kernels() {
+        return (this._kernels ??= new Kernels({ client: this.client }));
+    }
     _notebook;
     get notebook() {
         return (this._notebook ??= new Notebook({ client: this.client }));
@@ -4354,7 +4844,7 @@ export class OpenScienceClient extends HeyApiClient {
     }
     _command;
     get command() {
-        return (this._command ??= new Command2({ client: this.client }));
+        return (this._command ??= new Command3({ client: this.client }));
     }
     _app;
     get app() {