@declaw/sdk 1.1.1 → 1.1.2

package/dist/index.d.cts

@@ -55,6 +55,8 @@ declare class ApiClient {
     });
     /** Send a GET request and return parsed JSON. */
     get(path: string, opts?: RequestOpts): Promise<unknown>;
+    /** Send a GET request and return the response body as raw bytes. */
+    getBytes(path: string, opts?: RequestOpts): Promise<Uint8Array>;
     /** Send a POST request and return parsed JSON. */
     post(path: string, opts?: RequestOpts): Promise<unknown>;
     /** Send a PATCH request and return parsed JSON. */
@@ -697,16 +699,27 @@ declare class Filesystem {
     private readonly client;
     constructor(sandboxId: string, client: ApiClient);
     /**
-     * Read a file's contents as a string.
+     * Read a file's contents.
+     *
+     * Default returns the content as a string. Pass `{ format: "bytes" }`
+     * to get a `Uint8Array` for binary-safe reads — the SDK negotiates
+     * `application/octet-stream` end-to-end so high-bit bytes survive the
+     * round trip.
      *
      * @param path - Absolute path to the file.
-     * @param opts - Optional user and request timeout.
-     * @returns The file contents as a string.
+     * @param opts - Optional format, user, and request timeout.
+     * @returns The file contents as a string, or Uint8Array when format="bytes".
      */
     read(path: string, opts?: {
+        format?: 'text';
         user?: string;
         requestTimeout?: number;
     }): Promise<string>;
+    read(path: string, opts: {
+        format: 'bytes';
+        user?: string;
+        requestTimeout?: number;
+    }): Promise<Uint8Array>;
     /**
      * Write data to a file.
      *

package/dist/index.d.ts

@@ -55,6 +55,8 @@ declare class ApiClient {
     });
     /** Send a GET request and return parsed JSON. */
     get(path: string, opts?: RequestOpts): Promise<unknown>;
+    /** Send a GET request and return the response body as raw bytes. */
+    getBytes(path: string, opts?: RequestOpts): Promise<Uint8Array>;
     /** Send a POST request and return parsed JSON. */
     post(path: string, opts?: RequestOpts): Promise<unknown>;
     /** Send a PATCH request and return parsed JSON. */
@@ -697,16 +699,27 @@ declare class Filesystem {
     private readonly client;
     constructor(sandboxId: string, client: ApiClient);
     /**
-     * Read a file's contents as a string.
+     * Read a file's contents.
+     *
+     * Default returns the content as a string. Pass `{ format: "bytes" }`
+     * to get a `Uint8Array` for binary-safe reads — the SDK negotiates
+     * `application/octet-stream` end-to-end so high-bit bytes survive the
+     * round trip.
      *
      * @param path - Absolute path to the file.
-     * @param opts - Optional user and request timeout.
-     * @returns The file contents as a string.
+     * @param opts - Optional format, user, and request timeout.
+     * @returns The file contents as a string, or Uint8Array when format="bytes".
      */
     read(path: string, opts?: {
+        format?: 'text';
         user?: string;
         requestTimeout?: number;
     }): Promise<string>;
+    read(path: string, opts: {
+        format: 'bytes';
+        user?: string;
+        requestTimeout?: number;
+    }): Promise<Uint8Array>;
     /**
      * Write data to a file.
      *

package/dist/index.js

@@ -139,6 +139,12 @@ var ApiClient = class {
   async get(path, opts) {
     return this.requestWithRetry("GET", path, opts);
   }
+  /** Send a GET request and return the response body as raw bytes. */
+  async getBytes(path, opts) {
+    const response = await this.requestWithRetry("GET", path, opts, true);
+    const buf = await response.arrayBuffer();
+    return new Uint8Array(buf);
+  }
   /** Send a POST request and return parsed JSON. */
   async post(path, opts) {
     return this.requestWithRetry("POST", path, opts);
@@ -1263,15 +1269,18 @@ var Filesystem = class {
     this.sandboxId = sandboxId;
     this.client = client;
   }
-  /**
-   * Read a file's contents as a string.
-   *
-   * @param path - Absolute path to the file.
-   * @param opts - Optional user and request timeout.
-   * @returns The file contents as a string.
-   */
   async read(path, opts) {
     const user = opts?.user ?? DEFAULT_USER;
+    if (opts?.format === "bytes") {
+      return this.client.getBytes(
+        `/sandboxes/${this.sandboxId}/files`,
+        {
+          params: { path, username: user },
+          headers: { "Accept": "application/octet-stream" },
+          timeout: opts?.requestTimeout
+        }
+      );
+    }
     const result = await this.client.get(
       `/sandboxes/${this.sandboxId}/files`,
       {