@declaw/sdk 1.1.0 → 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. */
@@ -75,6 +77,12 @@ declare class ApiClient {
     streamGet(path: string, opts?: RequestOpts): Promise<Response>;
     /**
      * Abort all in-flight requests and release resources.
+     *
+     * Since 1.1.1 the SDK maintains a process-wide shared ApiClient cache
+     * for hot class-method paths (Sandbox.create, Volumes.*, Template.*).
+     * Calling `close()` on a shared instance aborts its AbortController,
+     * which would cancel any concurrent in-flight call. Prefer
+     * `resetSharedClients()` if you want to tear down every cached client.
      */
     close(): void;
     private buildUrl;
@@ -87,6 +95,8 @@ declare class ApiClient {
      */
     private delay;
 }
+declare function getSharedClient(config: ConnectionConfig): ApiClient;
+declare function resetSharedClients(): void;
 
 /** CIDR for all traffic. */
 declare const ALL_TRAFFIC = "0.0.0.0/0";
@@ -689,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.
      *
@@ -1185,7 +1206,11 @@ declare class Sandbox {
         requestTimeout?: number;
     }): Promise<Sandbox>;
     /**
-     * Close the underlying HTTP client and release resources.
+     * Historically closed the sandbox's HTTP client; since 1.1.1 the SDK
+     * maintains a process-wide shared ApiClient (see `getSharedClient` in
+     * api/client.ts) so per-sandbox close no longer tears the connection
+     * pool down. Kept as a no-op for backwards compatibility — call
+     * `resetSharedClients()` if you want to force a full teardown.
      */
     close(): void;
     /**
@@ -1464,4 +1489,4 @@ declare class Volumes {
     static delete(volumeId: string, opts?: VolumeRequestOpts): Promise<void>;
 }
 
-export { ALL_TRAFFIC, ApiClient, type AuditConfig, type AuditEntry, AuthenticationError, BuildError, type BuildInfo, type CodeSecurityConfig, CommandExitError, CommandHandle, type CommandResult, type CommandWaitOpts, Commands, ConnectionConfig, type ConnectionConfigOptions, type CopyItem, DEFAULT_MASK_PATTERNS, type EntryInfo, type EnvSecurityConfig, FileType, FileUploadError, Filesystem, type FilesystemEvent, FilesystemEventType, type GetBuildStatusOpts, GitAuthError, GitUpstreamError, InjectionAction, type InjectionDefenseConfig, InjectionSensitivity, InvalidArgumentError, type InvisibleTextConfig, type NetworkPolicy, NotEnoughSpaceError, NotFoundError, type PIIConfig, PIIType, type ProcessInfo, Pty, type PtyConnectOpts, type PtyCreateOpts, PtyHandle, type PtyOutput, type PtyResult, type PtySize, RedactionAction, type RequestOpts, type RunOpts, type RunStreamOpts, Sandbox, SandboxError, type SandboxInfo, type SandboxLifecycle, type SandboxMetrics, type SandboxNetworkOpts, type SandboxOpts, SandboxPaginator, type SandboxQuery, SandboxState, type SecureEnvVar, type SecurityPolicy, type Snapshot, type SnapshotInfo, SnapshotPaginator, type SnapshotSource, type Stderr, type Stdout, Template, TemplateBase, type TemplateBuildOpts, type TemplateBuildStatus, TemplateError, TimeoutError, type ToxicityConfig, TransformDirection, type TransformationRule, type VolumeAttachment, type VolumeCreateOpts, type VolumeInfo, type VolumeRequestOpts, Volumes, WatchHandle, type WriteEntry, type WriteInfo, applyTransformation, codeSecurityConfigToJSON, createAuditConfig, createCodeSecurityConfig, createEnvSecurityConfig, createInjectionDefenseConfig, createInvisibleTextConfig, createNetworkPolicy, createPIIConfig, createSecurityPolicy, createToxicityConfig, createTransformationRule, domainMatches, invisibleTextConfigToJSON, isSensitive, networkPolicyToOpts, parseAuditConfig, parseAuditEntry, parseBuildInfo, parseCodeSecurityConfig, parseCommandResult, parseEntryInfo, parseEnvSecurityConfig, parseFilesystemEvent, parseInjectionDefenseConfig, parseInvisibleTextConfig, parseNetworkPolicy, parsePIIConfig, parseProcessInfo, parseSandboxInfo, parseSandboxLifecycle, parseSandboxMetrics, parseSecurityPolicy, parseSnapshot, parseSnapshotInfo, parseTemplateBuildStatus, parseToxicityConfig, parseVolumeInfo, parseWriteInfo, requiresTlsInterception, securityPolicyToJSON, toxicityConfigToJSON, validateNetworkEntry, volumeAttachmentToJSON };
+export { ALL_TRAFFIC, ApiClient, type AuditConfig, type AuditEntry, AuthenticationError, BuildError, type BuildInfo, type CodeSecurityConfig, CommandExitError, CommandHandle, type CommandResult, type CommandWaitOpts, Commands, ConnectionConfig, type ConnectionConfigOptions, type CopyItem, DEFAULT_MASK_PATTERNS, type EntryInfo, type EnvSecurityConfig, FileType, FileUploadError, Filesystem, type FilesystemEvent, FilesystemEventType, type GetBuildStatusOpts, GitAuthError, GitUpstreamError, InjectionAction, type InjectionDefenseConfig, InjectionSensitivity, InvalidArgumentError, type InvisibleTextConfig, type NetworkPolicy, NotEnoughSpaceError, NotFoundError, type PIIConfig, PIIType, type ProcessInfo, Pty, type PtyConnectOpts, type PtyCreateOpts, PtyHandle, type PtyOutput, type PtyResult, type PtySize, RedactionAction, type RequestOpts, type RunOpts, type RunStreamOpts, Sandbox, SandboxError, type SandboxInfo, type SandboxLifecycle, type SandboxMetrics, type SandboxNetworkOpts, type SandboxOpts, SandboxPaginator, type SandboxQuery, SandboxState, type SecureEnvVar, type SecurityPolicy, type Snapshot, type SnapshotInfo, SnapshotPaginator, type SnapshotSource, type Stderr, type Stdout, Template, TemplateBase, type TemplateBuildOpts, type TemplateBuildStatus, TemplateError, TimeoutError, type ToxicityConfig, TransformDirection, type TransformationRule, type VolumeAttachment, type VolumeCreateOpts, type VolumeInfo, type VolumeRequestOpts, Volumes, WatchHandle, type WriteEntry, type WriteInfo, applyTransformation, codeSecurityConfigToJSON, createAuditConfig, createCodeSecurityConfig, createEnvSecurityConfig, createInjectionDefenseConfig, createInvisibleTextConfig, createNetworkPolicy, createPIIConfig, createSecurityPolicy, createToxicityConfig, createTransformationRule, domainMatches, getSharedClient, invisibleTextConfigToJSON, isSensitive, networkPolicyToOpts, parseAuditConfig, parseAuditEntry, parseBuildInfo, parseCodeSecurityConfig, parseCommandResult, parseEntryInfo, parseEnvSecurityConfig, parseFilesystemEvent, parseInjectionDefenseConfig, parseInvisibleTextConfig, parseNetworkPolicy, parsePIIConfig, parseProcessInfo, parseSandboxInfo, parseSandboxLifecycle, parseSandboxMetrics, parseSecurityPolicy, parseSnapshot, parseSnapshotInfo, parseTemplateBuildStatus, parseToxicityConfig, parseVolumeInfo, parseWriteInfo, requiresTlsInterception, resetSharedClients, securityPolicyToJSON, toxicityConfigToJSON, validateNetworkEntry, volumeAttachmentToJSON };

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. */
@@ -75,6 +77,12 @@ declare class ApiClient {
     streamGet(path: string, opts?: RequestOpts): Promise<Response>;
     /**
      * Abort all in-flight requests and release resources.
+     *
+     * Since 1.1.1 the SDK maintains a process-wide shared ApiClient cache
+     * for hot class-method paths (Sandbox.create, Volumes.*, Template.*).
+     * Calling `close()` on a shared instance aborts its AbortController,
+     * which would cancel any concurrent in-flight call. Prefer
+     * `resetSharedClients()` if you want to tear down every cached client.
      */
     close(): void;
     private buildUrl;
@@ -87,6 +95,8 @@ declare class ApiClient {
      */
     private delay;
 }
+declare function getSharedClient(config: ConnectionConfig): ApiClient;
+declare function resetSharedClients(): void;
 
 /** CIDR for all traffic. */
 declare const ALL_TRAFFIC = "0.0.0.0/0";
@@ -689,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.
      *
@@ -1185,7 +1206,11 @@ declare class Sandbox {
         requestTimeout?: number;
     }): Promise<Sandbox>;
     /**
-     * Close the underlying HTTP client and release resources.
+     * Historically closed the sandbox's HTTP client; since 1.1.1 the SDK
+     * maintains a process-wide shared ApiClient (see `getSharedClient` in
+     * api/client.ts) so per-sandbox close no longer tears the connection
+     * pool down. Kept as a no-op for backwards compatibility — call
+     * `resetSharedClients()` if you want to force a full teardown.
      */
     close(): void;
     /**
@@ -1464,4 +1489,4 @@ declare class Volumes {
     static delete(volumeId: string, opts?: VolumeRequestOpts): Promise<void>;
 }
 
-export { ALL_TRAFFIC, ApiClient, type AuditConfig, type AuditEntry, AuthenticationError, BuildError, type BuildInfo, type CodeSecurityConfig, CommandExitError, CommandHandle, type CommandResult, type CommandWaitOpts, Commands, ConnectionConfig, type ConnectionConfigOptions, type CopyItem, DEFAULT_MASK_PATTERNS, type EntryInfo, type EnvSecurityConfig, FileType, FileUploadError, Filesystem, type FilesystemEvent, FilesystemEventType, type GetBuildStatusOpts, GitAuthError, GitUpstreamError, InjectionAction, type InjectionDefenseConfig, InjectionSensitivity, InvalidArgumentError, type InvisibleTextConfig, type NetworkPolicy, NotEnoughSpaceError, NotFoundError, type PIIConfig, PIIType, type ProcessInfo, Pty, type PtyConnectOpts, type PtyCreateOpts, PtyHandle, type PtyOutput, type PtyResult, type PtySize, RedactionAction, type RequestOpts, type RunOpts, type RunStreamOpts, Sandbox, SandboxError, type SandboxInfo, type SandboxLifecycle, type SandboxMetrics, type SandboxNetworkOpts, type SandboxOpts, SandboxPaginator, type SandboxQuery, SandboxState, type SecureEnvVar, type SecurityPolicy, type Snapshot, type SnapshotInfo, SnapshotPaginator, type SnapshotSource, type Stderr, type Stdout, Template, TemplateBase, type TemplateBuildOpts, type TemplateBuildStatus, TemplateError, TimeoutError, type ToxicityConfig, TransformDirection, type TransformationRule, type VolumeAttachment, type VolumeCreateOpts, type VolumeInfo, type VolumeRequestOpts, Volumes, WatchHandle, type WriteEntry, type WriteInfo, applyTransformation, codeSecurityConfigToJSON, createAuditConfig, createCodeSecurityConfig, createEnvSecurityConfig, createInjectionDefenseConfig, createInvisibleTextConfig, createNetworkPolicy, createPIIConfig, createSecurityPolicy, createToxicityConfig, createTransformationRule, domainMatches, invisibleTextConfigToJSON, isSensitive, networkPolicyToOpts, parseAuditConfig, parseAuditEntry, parseBuildInfo, parseCodeSecurityConfig, parseCommandResult, parseEntryInfo, parseEnvSecurityConfig, parseFilesystemEvent, parseInjectionDefenseConfig, parseInvisibleTextConfig, parseNetworkPolicy, parsePIIConfig, parseProcessInfo, parseSandboxInfo, parseSandboxLifecycle, parseSandboxMetrics, parseSecurityPolicy, parseSnapshot, parseSnapshotInfo, parseTemplateBuildStatus, parseToxicityConfig, parseVolumeInfo, parseWriteInfo, requiresTlsInterception, securityPolicyToJSON, toxicityConfigToJSON, validateNetworkEntry, volumeAttachmentToJSON };
+export { ALL_TRAFFIC, ApiClient, type AuditConfig, type AuditEntry, AuthenticationError, BuildError, type BuildInfo, type CodeSecurityConfig, CommandExitError, CommandHandle, type CommandResult, type CommandWaitOpts, Commands, ConnectionConfig, type ConnectionConfigOptions, type CopyItem, DEFAULT_MASK_PATTERNS, type EntryInfo, type EnvSecurityConfig, FileType, FileUploadError, Filesystem, type FilesystemEvent, FilesystemEventType, type GetBuildStatusOpts, GitAuthError, GitUpstreamError, InjectionAction, type InjectionDefenseConfig, InjectionSensitivity, InvalidArgumentError, type InvisibleTextConfig, type NetworkPolicy, NotEnoughSpaceError, NotFoundError, type PIIConfig, PIIType, type ProcessInfo, Pty, type PtyConnectOpts, type PtyCreateOpts, PtyHandle, type PtyOutput, type PtyResult, type PtySize, RedactionAction, type RequestOpts, type RunOpts, type RunStreamOpts, Sandbox, SandboxError, type SandboxInfo, type SandboxLifecycle, type SandboxMetrics, type SandboxNetworkOpts, type SandboxOpts, SandboxPaginator, type SandboxQuery, SandboxState, type SecureEnvVar, type SecurityPolicy, type Snapshot, type SnapshotInfo, SnapshotPaginator, type SnapshotSource, type Stderr, type Stdout, Template, TemplateBase, type TemplateBuildOpts, type TemplateBuildStatus, TemplateError, TimeoutError, type ToxicityConfig, TransformDirection, type TransformationRule, type VolumeAttachment, type VolumeCreateOpts, type VolumeInfo, type VolumeRequestOpts, Volumes, WatchHandle, type WriteEntry, type WriteInfo, applyTransformation, codeSecurityConfigToJSON, createAuditConfig, createCodeSecurityConfig, createEnvSecurityConfig, createInjectionDefenseConfig, createInvisibleTextConfig, createNetworkPolicy, createPIIConfig, createSecurityPolicy, createToxicityConfig, createTransformationRule, domainMatches, getSharedClient, invisibleTextConfigToJSON, isSensitive, networkPolicyToOpts, parseAuditConfig, parseAuditEntry, parseBuildInfo, parseCodeSecurityConfig, parseCommandResult, parseEntryInfo, parseEnvSecurityConfig, parseFilesystemEvent, parseInjectionDefenseConfig, parseInvisibleTextConfig, parseNetworkPolicy, parsePIIConfig, parseProcessInfo, parseSandboxInfo, parseSandboxLifecycle, parseSandboxMetrics, parseSecurityPolicy, parseSnapshot, parseSnapshotInfo, parseTemplateBuildStatus, parseToxicityConfig, parseVolumeInfo, parseWriteInfo, requiresTlsInterception, resetSharedClients, securityPolicyToJSON, toxicityConfigToJSON, validateNetworkEntry, volumeAttachmentToJSON };