matchlock-sdk 0.1.29 → 0.2.4

package/README.md

@@ -77,8 +77,9 @@ const sandbox = new Sandbox("alpine:latest").withNetworkInterception({
 - Fluent sandbox builder (`Sandbox`) with network, secrets, mounts, env, VFS hooks, image config
 - Typed network interception rules and local callback hooks via `withNetworkInterception(...)`
 - Supports fully offline mode via `.withNoNetwork()` (no guest NIC / no egress)
-- JSON-RPC `create`, `exec`, `exec_stream`, `exec_pipe`, `exec_tty`, `write_file`, `read_file`, `list_files`, `port_forward`, `cancel`, `close`
+- JSON-RPC `create`, `exec`, `exec_stream`, `exec_pipe`, `exec_tty`, `log`, `log_stream`, `write_file`, `read_file`, `list_files`, `port_forward`, `cancel`, `close`
 - Streaming stdout/stderr via `execStream` and bidirectional stdin/stdout/stderr via `execPipe`
+- VM log access via `log()` and `logStream()`
 - Interactive PTY shell/commands via `execInteractive` (stdin/stdout + resize events)
 - Local VFS callbacks (`hook`, `dangerousHook`, `mutateHook`, `actionHook`)
 - Port forwarding API parity (`portForward`, `portForwardWithAddresses`)

package/dist/client/transport.js

@@ -13,6 +13,7 @@ const REQUEST_NOTIFICATION_METHODS = new Set([
     "exec_pipe.stderr",
     "exec_tty.ready",
     "exec_tty.stdout",
+    "log_stream.data",
 ]);
 class RPCTransport {
     config;
@@ -29,7 +30,9 @@ class RPCTransport {
         this.onClosed = onClosed;
     }
     async start() {
-        if (this.process && this.process.exitCode === null && !this.process.killed) {
+        if (this.process &&
+            this.process.exitCode === null &&
+            !this.process.killed) {
             return;
         }
         const command = this.config.useSudo ? "sudo" : this.config.binaryPath;
@@ -55,7 +58,7 @@ class RPCTransport {
         this.process = child;
     }
     isRunning() {
-        return !!this.process && this.process.exitCode === null && !this.process.killed;
+        return (!!this.process && this.process.exitCode === null && !this.process.killed);
     }
     async close(timeoutSeconds = 0) {
         if (!this.isRunning()) {

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { Sandbox } from "./builder";
-import { type BinaryLike, type Config, type CreateOptions, type ExecInteractiveOptions, type ExecInteractiveResult, type ExecOptions, type ExecPipeOptions, type ExecPipeResult, type ExecResult, type ExecStreamOptions, type ExecStreamResult, type FileInfo, type PortForwardBinding, type RequestOptions, type StreamReader, type StreamWriter, type VolumeInfo } from "./types";
+import { type BinaryLike, type Config, type CreateOptions, type ExecInteractiveOptions, type ExecInteractiveResult, type ExecOptions, type ExecPipeOptions, type ExecPipeResult, type ExecResult, type ExecStreamOptions, type ExecStreamResult, type FileInfo, type LogStreamOptions, type PortForwardBinding, type RequestOptions, type StreamReader, type StreamWriter, type VolumeInfo } from "./types";
 export { defaultConfig } from "./client/utils";
 export declare class Client {
     private readonly config;
@@ -28,6 +28,8 @@ export declare class Client {
     execPipe(command: string, options?: ExecPipeOptions): Promise<ExecPipeResult>;
     execPipeWithDir(command: string, workingDir?: string, stdin?: StreamReader, stdout?: StreamWriter, stderr?: StreamWriter, options?: RequestOptions): Promise<ExecPipeResult>;
     execInteractive(command: string, options?: ExecInteractiveOptions): Promise<ExecInteractiveResult>;
+    log(options?: RequestOptions): Promise<string>;
+    logStream(options?: LogStreamOptions): Promise<void>;
     writeFile(path: string, content: BinaryLike, options?: RequestOptions): Promise<void>;
     writeFileMode(path: string, content: BinaryLike, mode: number, options?: RequestOptions): Promise<void>;
     readFile(path: string, options?: RequestOptions): Promise<Buffer>;
@@ -37,4 +39,5 @@ export declare class Client {
     private portForwardMappings;
     private sendRequest;
     private handleNotification;
+    private writeStreamChunk;
 }

package/dist/client.js

@@ -152,6 +152,30 @@ class Client {
     async execInteractive(command, options = {}) {
         return this.execAPI.execInteractive(command, options);
     }
+    async log(options = {}) {
+        const result = (0, utils_1.asObject)(await this.sendRequest("log", undefined, options));
+        return Buffer.from((0, utils_1.asString)(result.content), "base64").toString("utf8");
+    }
+    async logStream(options = {}) {
+        const onNotification = (method, params) => {
+            if (method !== "log_stream.data") {
+                return;
+            }
+            const data = (0, utils_1.asString)(params.data);
+            if (!data) {
+                return;
+            }
+            let decoded;
+            try {
+                decoded = Buffer.from(data, "base64");
+            }
+            catch {
+                return;
+            }
+            this.writeStreamChunk(options.stdout, decoded);
+        };
+        await this.sendRequest("log_stream", undefined, options, onNotification);
+    }
     async writeFile(path, content, options = {}) {
         await this.writeFileMode(path, content, 0o644, options);
     }
@@ -224,5 +248,15 @@ class Client {
             this.vfsHooks.handleFileEventNotification(params, this);
         }
     }
+    writeStreamChunk(writer, chunk) {
+        if (!writer) {
+            return;
+        }
+        if (typeof writer === "function") {
+            void writer(chunk);
+            return;
+        }
+        writer.write(chunk);
+    }
 }
 exports.Client = Client;

package/dist/index.d.ts

@@ -2,4 +2,4 @@ export { Client, defaultConfig } from "./client";
 export { Sandbox, createSandbox } from "./builder";
 export { MatchlockError, RPCError } from "./errors";
 export { NETWORK_HOOK_ACTION_ALLOW, NETWORK_HOOK_ACTION_BLOCK, NETWORK_HOOK_ACTION_MUTATE, NETWORK_HOOK_PHASE_AFTER, NETWORK_HOOK_PHASE_BEFORE, VFS_HOOK_ACTION_ALLOW, VFS_HOOK_ACTION_BLOCK, VFS_HOOK_OP_STAT, VFS_HOOK_OP_READDIR, VFS_HOOK_OP_OPEN, VFS_HOOK_OP_CREATE, VFS_HOOK_OP_MKDIR, VFS_HOOK_OP_CHMOD, VFS_HOOK_OP_REMOVE, VFS_HOOK_OP_REMOVE_ALL, VFS_HOOK_OP_RENAME, VFS_HOOK_OP_SYMLINK, VFS_HOOK_OP_READLINK, VFS_HOOK_OP_READ, VFS_HOOK_OP_WRITE, VFS_HOOK_OP_CLOSE, VFS_HOOK_OP_SYNC, VFS_HOOK_OP_TRUNCATE, VFS_HOOK_PHASE_BEFORE, VFS_HOOK_PHASE_AFTER, } from "./types";
-export type { BinaryLike, Config, CreateOptions, ExecInteractiveOptions, ExecInteractiveResult, ExecOptions, ExecPipeOptions, ExecPipeResult, ExecResult, ExecStreamOptions, ExecStreamResult, FileInfo, VolumeInfo, HostIPMapping, ImageConfig, MountConfig, NetworkBodyTransform, NetworkHookFunc, NetworkHookRequest, NetworkHookRequestMutation, NetworkHookResponseMutation, NetworkHookResult, NetworkHookAction, NetworkHookPhase, NetworkHookRule, NetworkInterceptionConfig, PortForward, PortForwardBinding, RequestOptions, Secret, TTYSize, StreamWriter, StreamReader, VFSActionHookFunc, VFSActionRequest, VFSDangerousHookFunc, VFSHookAction, VFSHookEvent, VFSHookFunc, VFSHookOp, VFSHookPhase, VFSHookRule, VFSInterceptionConfig, VFSMutateHookFunc, VFSMutateRequest, } from "./types";
+export type { BinaryLike, Config, CreateOptions, ExecInteractiveOptions, ExecInteractiveResult, ExecOptions, ExecPipeOptions, ExecPipeResult, ExecResult, ExecStreamOptions, ExecStreamResult, FileInfo, VolumeInfo, HostIPMapping, ImageConfig, LogStreamOptions, MountConfig, NetworkBodyTransform, NetworkHookFunc, NetworkHookRequest, NetworkHookRequestMutation, NetworkHookResponseMutation, NetworkHookResult, NetworkHookAction, NetworkHookPhase, NetworkHookRule, NetworkInterceptionConfig, PortForward, PortForwardBinding, RequestOptions, Secret, TTYSize, StreamWriter, StreamReader, VFSActionHookFunc, VFSActionRequest, VFSDangerousHookFunc, VFSHookAction, VFSHookEvent, VFSHookFunc, VFSHookOp, VFSHookPhase, VFSHookRule, VFSInterceptionConfig, VFSMutateHookFunc, VFSMutateRequest, } from "./types";

package/dist/types.d.ts

@@ -241,3 +241,6 @@ export interface ExecInteractiveOptions extends ExecOptions {
     cols?: number;
     resize?: AsyncIterable<TTYSize> | Iterable<TTYSize>;
 }
+export interface LogStreamOptions extends RequestOptions {
+    stdout?: StreamWriter;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matchlock-sdk",
-  "version": "0.1.29",
+  "version": "0.2.4",
   "description": "TypeScript SDK for Matchlock sandboxes",
   "license": "MIT",
   "repository": {