@archildata/client 0.8.7 → 0.8.8

package/dist/api/index.d.mts

@@ -102,6 +102,28 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/disks/{id}/exec": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Execute a command on a disk
+         * @description Launches a container with the specified disk mounted, runs the given
+         *     command to completion, and shuts down the container. Returns immediately
+         *     with the container info; poll the container endpoint for completion.
+         */
+        post: operations["execDisk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/tokens": {
         parameters: {
             query?: never;
@@ -552,6 +574,29 @@ interface components {
                 token?: string;
             };
         };
+        ExecDiskRequest: {
+            /**
+             * @description Shell command to execute inside the container
+             * @example ls -la /mnt/archil
+             */
+            command: string;
+        };
+        ExecDiskResult: {
+            /**
+             * @description Exit code of the command (0 = success)
+             * @example 0
+             */
+            exitCode: number;
+            /** @description Standard output from the command */
+            stdout: string;
+            /** @description Standard error from the command */
+            stderr: string;
+        };
+        ApiResponse_ExecDisk: {
+            /** @example true */
+            success: boolean;
+            data: components["schemas"]["ExecDiskResult"];
+        };
     };
     responses: {
         /** @description Invalid or missing authentication credentials */
@@ -807,6 +852,46 @@ interface operations {
             500: components["responses"]["InternalError"];
         };
     };
+    execDisk: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Disk ID (format `dsk-{16 hex chars}`) */
+                id: components["parameters"]["DiskId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ExecDiskRequest"];
+            };
+        };
+        responses: {
+            /** @description Command completed */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ExecDisk"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalError"];
+            /** @description Command timed out */
+            504: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listApiTokens: {
         parameters: {
             query?: {
@@ -917,6 +1002,20 @@ interface MountOptions {
     serverAddress?: string;
     insecure?: boolean;
 }
+interface ExecTiming {
+    /** End-to-end wall-clock measured on the server (from request arrival to response). */
+    totalMs: number;
+    /** Time spent queueing, scheduling, booting/claiming a VM, and mounting the filesystem. */
+    queueMs: number;
+    /** Time the user's command itself ran, measured by the runtime. */
+    executeMs: number;
+}
+interface ExecResult {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    timing: ExecTiming;
+}
 declare class Disk {
     readonly id: string;
     readonly name: string;
@@ -947,6 +1046,11 @@ declare class Disk {
     }>;
     removeTokenUser(identifier: string): Promise<void>;
     delete(): Promise<void>;
+    /**
+     * Execute a command in a container with this disk mounted.
+     * Blocks until the command completes and returns stdout, stderr, and exit code.
+     */
+    exec(command: string): Promise<ExecResult>;
     /**
      * Connect to this disk's data plane via the native ArchilClient.
      *
@@ -1019,4 +1123,4 @@ declare class ArchilApiError extends Error {
     constructor(message: string, status: number, code?: string);
 }
 
-export { type ApiTokenResponse, Archil, ArchilApiError, type ArchilOptions, type AuthorizedUser, type AwsStsUser, type AzureBlobMount, type ConnectedClient, type CreateApiTokenRequest, type CreateDiskRequest, type CreateDiskResult, Disk, type DiskMetrics, type DiskResponse, type DiskStatus, type DiskUser, Disks, type GCSMount, type ListDisksOptions, type ListTokensOptions, type MountConfig, type MountConfigResponse, type MountOptions, type MountResponse, type R2Mount, type S3CompatibleMount, type S3Mount, type TokenUser, Tokens };
+export { type ApiTokenResponse, Archil, ArchilApiError, type ArchilOptions, type AuthorizedUser, type AwsStsUser, type AzureBlobMount, type ConnectedClient, type CreateApiTokenRequest, type CreateDiskRequest, type CreateDiskResult, Disk, type DiskMetrics, type DiskResponse, type DiskStatus, type DiskUser, Disks, type ExecResult, type GCSMount, type ListDisksOptions, type ListTokensOptions, type MountConfig, type MountConfigResponse, type MountOptions, type MountResponse, type R2Mount, type S3CompatibleMount, type S3Mount, type TokenUser, Tokens };

package/dist/api/index.d.ts

@@ -102,6 +102,28 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/disks/{id}/exec": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Execute a command on a disk
+         * @description Launches a container with the specified disk mounted, runs the given
+         *     command to completion, and shuts down the container. Returns immediately
+         *     with the container info; poll the container endpoint for completion.
+         */
+        post: operations["execDisk"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/tokens": {
         parameters: {
             query?: never;
@@ -552,6 +574,29 @@ interface components {
                 token?: string;
             };
         };
+        ExecDiskRequest: {
+            /**
+             * @description Shell command to execute inside the container
+             * @example ls -la /mnt/archil
+             */
+            command: string;
+        };
+        ExecDiskResult: {
+            /**
+             * @description Exit code of the command (0 = success)
+             * @example 0
+             */
+            exitCode: number;
+            /** @description Standard output from the command */
+            stdout: string;
+            /** @description Standard error from the command */
+            stderr: string;
+        };
+        ApiResponse_ExecDisk: {
+            /** @example true */
+            success: boolean;
+            data: components["schemas"]["ExecDiskResult"];
+        };
     };
     responses: {
         /** @description Invalid or missing authentication credentials */
@@ -807,6 +852,46 @@ interface operations {
             500: components["responses"]["InternalError"];
         };
     };
+    execDisk: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Disk ID (format `dsk-{16 hex chars}`) */
+                id: components["parameters"]["DiskId"];
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ExecDiskRequest"];
+            };
+        };
+        responses: {
+            /** @description Command completed */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ExecDisk"];
+                };
+            };
+            400: components["responses"]["ValidationError"];
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+            500: components["responses"]["InternalError"];
+            /** @description Command timed out */
+            504: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     listApiTokens: {
         parameters: {
             query?: {
@@ -917,6 +1002,20 @@ interface MountOptions {
     serverAddress?: string;
     insecure?: boolean;
 }
+interface ExecTiming {
+    /** End-to-end wall-clock measured on the server (from request arrival to response). */
+    totalMs: number;
+    /** Time spent queueing, scheduling, booting/claiming a VM, and mounting the filesystem. */
+    queueMs: number;
+    /** Time the user's command itself ran, measured by the runtime. */
+    executeMs: number;
+}
+interface ExecResult {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    timing: ExecTiming;
+}
 declare class Disk {
     readonly id: string;
     readonly name: string;
@@ -947,6 +1046,11 @@ declare class Disk {
     }>;
     removeTokenUser(identifier: string): Promise<void>;
     delete(): Promise<void>;
+    /**
+     * Execute a command in a container with this disk mounted.
+     * Blocks until the command completes and returns stdout, stderr, and exit code.
+     */
+    exec(command: string): Promise<ExecResult>;
     /**
      * Connect to this disk's data plane via the native ArchilClient.
      *
@@ -1019,4 +1123,4 @@ declare class ArchilApiError extends Error {
     constructor(message: string, status: number, code?: string);
 }
 
-export { type ApiTokenResponse, Archil, ArchilApiError, type ArchilOptions, type AuthorizedUser, type AwsStsUser, type AzureBlobMount, type ConnectedClient, type CreateApiTokenRequest, type CreateDiskRequest, type CreateDiskResult, Disk, type DiskMetrics, type DiskResponse, type DiskStatus, type DiskUser, Disks, type GCSMount, type ListDisksOptions, type ListTokensOptions, type MountConfig, type MountConfigResponse, type MountOptions, type MountResponse, type R2Mount, type S3CompatibleMount, type S3Mount, type TokenUser, Tokens };
+export { type ApiTokenResponse, Archil, ArchilApiError, type ArchilOptions, type AuthorizedUser, type AwsStsUser, type AzureBlobMount, type ConnectedClient, type CreateApiTokenRequest, type CreateDiskRequest, type CreateDiskResult, Disk, type DiskMetrics, type DiskResponse, type DiskStatus, type DiskUser, Disks, type ExecResult, type GCSMount, type ListDisksOptions, type ListTokensOptions, type MountConfig, type MountConfigResponse, type MountOptions, type MountResponse, type R2Mount, type S3CompatibleMount, type S3Mount, type TokenUser, Tokens };

package/dist/api/index.js

@@ -198,6 +198,21 @@ var Disk = class {
       })
     );
   }
+  /**
+   * Execute a command in a container with this disk mounted.
+   * Blocks until the command completes and returns stdout, stderr, and exit code.
+   */
+  async exec(command) {
+    return unwrap(
+      this._client.POST(
+        "/api/disks/{id}/exec",
+        {
+          params: { path: { id: this.id } },
+          body: { command }
+        }
+      )
+    );
+  }
   /**
    * Connect to this disk's data plane via the native ArchilClient.
    *

package/dist/api/index.mjs

@@ -157,6 +157,21 @@ var Disk = class {
       })
     );
   }
+  /**
+   * Execute a command in a container with this disk mounted.
+   * Blocks until the command completes and returns stdout, stderr, and exit code.
+   */
+  async exec(command) {
+    return unwrap(
+      this._client.POST(
+        "/api/disks/{id}/exec",
+        {
+          params: { path: { id: this.id } },
+          body: { command }
+        }
+      )
+    );
+  }
   /**
    * Connect to this disk's data plane via the native ArchilClient.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/client",
-  "version": "0.8.7",
+  "version": "0.8.8",
   "description": "High-performance Node.js client for Archil distributed filesystem",
   "main": "main.js",
   "types": "main.d.ts",