@boxrouter/sdk 0.0.1-alpha.0 → 0.12.190

package/dist/client/types.gen.d.ts

@@ -1,7 +1,7 @@
-import type { Auth } from '../core/auth.gen.js';
-import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
-import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
-import type { Middleware } from './utils.gen.js';
+import type { Auth } from '../core/auth.gen';
+import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen';
+import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen';
+import type { Middleware } from './utils.gen';
 export type ResponseStyle = 'data' | 'fields';
 export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
     /**
@@ -30,7 +30,7 @@ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<Re
      *
      * @default 'auto'
      */
-    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    parseAs?: 'arrayBuffer' | 'auto' | 'binaryStream' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
     /**
      * Should we return only data or multiple fields (data, error, response, etc.)?
      *
@@ -47,7 +47,7 @@ export interface Config<T extends ClientOptions = ClientOptions> extends Omit<Re
 export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
     responseStyle: TResponseStyle;
     throwOnError: ThrowOnError;
-}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseMaxBufferSize' | 'validateStreamEnd'> {
     /**
      * Any body that you want to add to your request.
      *

package/dist/client/types.gen.js

@@ -1,2 +1,3 @@
+"use strict";
 // This file is auto-generated by @hey-api/openapi-ts
-export {};
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/client/utils.gen.d.ts

@@ -1,5 +1,5 @@
-import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
-import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
+import type { QuerySerializerOptions } from '../core/bodySerializer.gen';
+import type { Client, ClientOptions, Config, RequestOptions } from './types.gen';
 export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => ((queryParams: T) => string);
 /**
  * Infers parseAs value from provided Content-Type header.

package/dist/client/utils.gen.js

@@ -1,9 +1,13 @@
+"use strict";
 // This file is auto-generated by @hey-api/openapi-ts
-import { getAuthToken } from '../core/auth.gen.js';
-import { jsonBodySerializer } from '../core/bodySerializer.gen.js';
-import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam, } from '../core/pathSerializer.gen.js';
-import { getUrl } from '../core/utils.gen.js';
-export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfig = exports.createInterceptors = exports.mergeHeaders = exports.mergeConfigs = exports.buildUrl = exports.getParseAs = exports.createQuerySerializer = void 0;
+exports.setAuthParams = setAuthParams;
+const auth_gen_1 = require("../core/auth.gen");
+const bodySerializer_gen_1 = require("../core/bodySerializer.gen");
+const pathSerializer_gen_1 = require("../core/pathSerializer.gen");
+const utils_gen_1 = require("../core/utils.gen");
+const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
     const querySerializer = (queryParams) => {
         const search = [];
         if (queryParams && typeof queryParams === 'object') {
@@ -14,7 +18,7 @@ export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
                 }
                 const options = parameters[name] || args;
                 if (Array.isArray(value)) {
-                    const serializedArray = serializeArrayParam({
+                    const serializedArray = (0, pathSerializer_gen_1.serializeArrayParam)({
                         allowReserved: options.allowReserved,
                         explode: true,
                         name,
@@ -26,7 +30,7 @@ export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
                         search.push(serializedArray);
                 }
                 else if (typeof value === 'object') {
-                    const serializedObject = serializeObjectParam({
+                    const serializedObject = (0, pathSerializer_gen_1.serializeObjectParam)({
                         allowReserved: options.allowReserved,
                         explode: true,
                         name,
@@ -38,7 +42,7 @@ export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
                         search.push(serializedObject);
                 }
                 else {
-                    const serializedPrimitive = serializePrimitiveParam({
+                    const serializedPrimitive = (0, pathSerializer_gen_1.serializePrimitiveParam)({
                         allowReserved: options.allowReserved,
                         name,
                         value: value,
@@ -52,10 +56,11 @@ export const createQuerySerializer = ({ parameters = {}, ...args } = {}) => {
     };
     return querySerializer;
 };
+exports.createQuerySerializer = createQuerySerializer;
 /**
  * Infers parseAs value from provided Content-Type header.
  */
-export const getParseAs = (contentType) => {
+const getParseAs = (contentType) => {
     if (!contentType) {
         // If no Content-Type header is provided, the best we can do is return the raw response body,
         // which is effectively the same as the 'stream' option.
@@ -79,6 +84,7 @@ export const getParseAs = (contentType) => {
     }
     return;
 };
+exports.getParseAs = getParseAs;
 const checkForExistence = (options, name) => {
     if (!name) {
         return false;
@@ -90,12 +96,12 @@ const checkForExistence = (options, name) => {
     }
     return false;
 };
-export async function setAuthParams(options) {
+async function setAuthParams(options) {
     for (const auth of options.security ?? []) {
         if (checkForExistence(options, auth.name)) {
             continue;
         }
-        const token = await getAuthToken(auth, options.auth);
+        const token = await (0, auth_gen_1.getAuthToken)(auth, options.auth);
         if (!token) {
             continue;
         }
@@ -117,23 +123,25 @@ export async function setAuthParams(options) {
         }
     }
 }
-export const buildUrl = (options) => getUrl({
+const buildUrl = (options) => (0, utils_gen_1.getUrl)({
     baseUrl: options.baseUrl,
     path: options.path,
     query: options.query,
     querySerializer: typeof options.querySerializer === 'function'
         ? options.querySerializer
-        : createQuerySerializer(options.querySerializer),
+        : (0, exports.createQuerySerializer)(options.querySerializer),
     url: options.url,
 });
-export const mergeConfigs = (a, b) => {
+exports.buildUrl = buildUrl;
+const mergeConfigs = (a, b) => {
     const config = { ...a, ...b };
     if (config.baseUrl?.endsWith('/')) {
         config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1);
     }
-    config.headers = mergeHeaders(a.headers, b.headers);
+    config.headers = (0, exports.mergeHeaders)(a.headers, b.headers);
     return config;
 };
+exports.mergeConfigs = mergeConfigs;
 const headersEntries = (headers) => {
     const entries = [];
     headers.forEach((value, key) => {
@@ -141,7 +149,7 @@ const headersEntries = (headers) => {
     });
     return entries;
 };
-export const mergeHeaders = (...headers) => {
+const mergeHeaders = (...headers) => {
     const mergedHeaders = new Headers();
     for (const header of headers) {
         if (!header) {
@@ -166,6 +174,7 @@ export const mergeHeaders = (...headers) => {
     }
     return mergedHeaders;
 };
+exports.mergeHeaders = mergeHeaders;
 class Interceptors {
     fns = [];
     clear() {
@@ -200,12 +209,13 @@ class Interceptors {
         return this.fns.length - 1;
     }
 }
-export const createInterceptors = () => ({
+const createInterceptors = () => ({
     error: new Interceptors(),
     request: new Interceptors(),
     response: new Interceptors(),
 });
-const defaultQuerySerializer = createQuerySerializer({
+exports.createInterceptors = createInterceptors;
+const defaultQuerySerializer = (0, exports.createQuerySerializer)({
     allowReserved: false,
     array: {
         explode: true,
@@ -219,10 +229,11 @@ const defaultQuerySerializer = createQuerySerializer({
 const defaultHeaders = {
     'Content-Type': 'application/json',
 };
-export const createConfig = (override = {}) => ({
-    ...jsonBodySerializer,
+const createConfig = (override = {}) => ({
+    ...bodySerializer_gen_1.jsonBodySerializer,
     headers: defaultHeaders,
     parseAs: 'auto',
     querySerializer: defaultQuerySerializer,
     ...override,
 });
+exports.createConfig = createConfig;

package/dist/client.gen.d.ts

@@ -1,5 +1,5 @@
-import { type Client, type ClientOptions, type Config } from './client/index.js';
-import type { ClientOptions as ClientOptions2 } from './types.gen.js';
+import { type Client, type ClientOptions, type Config } from './client';
+import type { ClientOptions as ClientOptions2 } from './types.gen';
 /**
  * The `createClientConfig()` function will be called on client initialization
  * and the returned object will become the client's initial configuration.

package/dist/client.gen.js

@@ -1,3 +1,6 @@
+"use strict";
 // This file is auto-generated by @hey-api/openapi-ts
-import { createClient, createConfig } from './client/index.js';
-export const client = createClient(createConfig({ baseUrl: '/', throwOnError: true }));
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.client = void 0;
+const client_1 = require("./client");
+exports.client = (0, client_1.createClient)((0, client_1.createConfig)({ baseUrl: '/api/v1', throwOnError: true }));

package/dist/command-check.gen.d.ts

@@ -0,0 +1,14 @@
+import type { CommandBytesResult } from './sandboxes';
+import type { CommandResult } from './types.gen';
+type Result = CommandResult | CommandBytesResult;
+/** A command's result failed the check it was asked for; the result is on `result`. */
+export declare class CommandFailed extends Error {
+    readonly result: Result;
+    constructor(result: Result);
+    get exit_code(): Result['exit_code'];
+    get stdout(): Result['stdout'];
+    get stderr(): Result['stderr'];
+    get timed_out(): Result['timed_out'];
+}
+export declare function checkedCommand<T extends Result>(result: T, check: boolean | undefined): T;
+export {};

package/dist/command-check.gen.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandFailed = void 0;
+exports.checkedCommand = checkedCommand;
+/** A command's result failed the check it was asked for; the result is on `result`. */
+class CommandFailed extends Error {
+    result;
+    constructor(result) {
+        super(`Command failed: exit_code=${result.exit_code}, timed_out=${result.timed_out}`);
+        this.result = result;
+        this.name = 'CommandFailed';
+    }
+    get exit_code() { return this.result.exit_code; }
+    get stdout() { return this.result.stdout; }
+    get stderr() { return this.result.stderr; }
+    get timed_out() { return this.result.timed_out; }
+}
+exports.CommandFailed = CommandFailed;
+function checkedCommand(result, check) {
+    if (check && (result.exit_code !== 0 || result.timed_out))
+        throw new CommandFailed(result);
+    return result;
+}

package/dist/command-input.gen.d.ts

@@ -0,0 +1,6 @@
+import type { RunCommand, StartProcess, CreateSandbox } from './types.gen';
+export declare function validateCommand(value: RunCommand): void;
+export declare function validateProcess(value: StartProcess): void;
+export declare function validateCreation(value: Partial<Pick<CreateSandbox, 'preferences'>>): void;
+export declare function validateLaunchRun(value: unknown): void;
+export declare function validateLaunchInputs(value: unknown): void;

package/dist/command-input.gen.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCommand = validateCommand;
+exports.validateProcess = validateProcess;
+exports.validateCreation = validateCreation;
+exports.validateLaunchRun = validateLaunchRun;
+exports.validateLaunchInputs = validateLaunchInputs;
+const commandValidators_cjs_1 = __importDefault(require("./core/commandValidators.cjs"));
+function validateCommand(value) {
+    if (!commandValidators_cjs_1.default.command(value.command))
+        throw new TypeError("Command must not contain NUL bytes");
+    if (value.env !== undefined && !commandValidators_cjs_1.default.env(value.env))
+        throw new TypeError("Command env requires valid shell variable names and values without NUL");
+    if (value.cwd !== undefined && !commandValidators_cjs_1.default.cwd(value.cwd))
+        throw new TypeError("Command cwd must be an absolute sandbox path without NUL bytes");
+    if (value.timeout_seconds !== undefined && !commandValidators_cjs_1.default.timeout_seconds(value.timeout_seconds))
+        throw new TypeError("Command timeout_seconds must be a positive integer");
+    if (value.output !== undefined && !commandValidators_cjs_1.default.output(value.output))
+        throw new TypeError("Invalid command field: output");
+    if (value.output_limit_bytes !== undefined && !commandValidators_cjs_1.default.output_limit_bytes(value.output_limit_bytes))
+        throw new TypeError("Invalid command field: output_limit_bytes");
+}
+function validateProcess(value) {
+    if (!commandValidators_cjs_1.default.process_command(value.command))
+        throw new TypeError("Command must not contain NUL bytes");
+    if (value.env !== undefined && !commandValidators_cjs_1.default.process_env(value.env))
+        throw new TypeError("Command env requires valid shell variable names and values without NUL");
+    if (value.cwd !== undefined && !commandValidators_cjs_1.default.process_cwd(value.cwd))
+        throw new TypeError("Command cwd must be an absolute sandbox path without NUL bytes");
+    if (value.stdin !== undefined && !commandValidators_cjs_1.default.process_stdin(value.stdin))
+        throw new TypeError("Invalid process field: stdin");
+    if (value.wait_for_port !== undefined && !commandValidators_cjs_1.default.process_wait_for_port(value.wait_for_port))
+        throw new TypeError("Invalid process field: wait_for_port");
+}
+function validateCreation(value) {
+    if (value.preferences !== undefined && !commandValidators_cjs_1.default.creation_preferences(value.preferences))
+        throw new TypeError("Invalid creation field: preferences");
+}
+function validateLaunchRun(value) { if (!commandValidators_cjs_1.default.launch_run(value))
+    throw new TypeError('Invalid LaunchRunRequest'); }
+function validateLaunchInputs(value) { if (!commandValidators_cjs_1.default.launch_inputs(value))
+    throw new TypeError('Invalid launch input'); }

package/dist/core/auth.gen.js

@@ -1,5 +1,8 @@
+"use strict";
 // This file is auto-generated by @hey-api/openapi-ts
-export const getAuthToken = async (auth, callback) => {
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthToken = void 0;
+const getAuthToken = async (auth, callback) => {
     const token = typeof callback === 'function' ? await callback(auth) : callback;
     if (!token) {
         return;
@@ -12,3 +15,4 @@ export const getAuthToken = async (auth, callback) => {
     }
     return token;
 };
+exports.getAuthToken = getAuthToken;

package/dist/core/binaryStream.d.ts

@@ -0,0 +1,8 @@
+import { type RequestTrace } from '../telemetry';
+type StreamBody<T> = T extends Blob ? ReadableStream<Uint8Array> : T;
+export type BinaryStreamResponses<T> = {
+    [Status in keyof T]: StreamBody<T[Status]>;
+};
+/** Retain mutation identity and observe consumption without prefetching bytes. */
+export declare function binaryStream(body: ReadableStream<Uint8Array> | null, response: Response, request: Request, telemetry: RequestTrace): ReadableStream<Uint8Array>;
+export {};

package/dist/core/binaryStream.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.binaryStream = binaryStream;
+const api_error_1 = require("../api-error");
+const telemetry_1 = require("../telemetry");
+/** Retain mutation identity and observe consumption without prefetching bytes. */
+function binaryStream(body, response, request, telemetry) {
+    const reader = body?.getReader();
+    let ended = false;
+    let bytes = 0;
+    let abort;
+    telemetry.finishObserverOutcome('success');
+    telemetry.streaming = true;
+    telemetry.startStreamLifetime();
+    const finish = (outcome, reason) => {
+        if (ended)
+            return;
+        ended = true;
+        request.signal.removeEventListener('abort', abort);
+        telemetry.span.setAttribute('boxrouter.stream.bytes', bytes);
+        telemetry.span.setAttribute('boxrouter.stream.end', outcome);
+        if (outcome === 'error')
+            telemetry.error(reason);
+        telemetry.finishStreamLifetime(outcome === 'completed' ? 'success'
+            : outcome === 'cancelled' ? 'stream_cancelled' : 'stream_error');
+        telemetry.span.end();
+    };
+    const release = async () => {
+        if (!reader)
+            return;
+        await reader.cancel().catch(() => { });
+        reader.releaseLock();
+    };
+    return new ReadableStream({
+        start(controller) {
+            abort = () => {
+                if (ended)
+                    return;
+                const reason = request.signal.reason;
+                finish(reason instanceof DOMException && reason.name === 'AbortError' ? 'cancelled' : 'error', reason);
+                controller.error((0, api_error_1.invalidResponse)(response, request));
+                void release();
+            };
+            request.signal.addEventListener('abort', abort, { once: true });
+            if (request.signal.aborted)
+                abort();
+        },
+        async pull(controller) {
+            try {
+                const next = await reader?.read();
+                if (ended)
+                    return;
+                if (!next || next.done) {
+                    finish('completed');
+                    reader?.releaseLock();
+                    controller.close();
+                }
+                else {
+                    bytes += next.value.byteLength;
+                    controller.enqueue(next.value);
+                }
+            }
+            catch (error) {
+                if (ended)
+                    return;
+                finish('error', error);
+                controller.error((0, api_error_1.invalidResponse)(response, request));
+                await release();
+            }
+        },
+        async cancel(reason) {
+            finish((0, telemetry_1.isTimeoutError)(reason) ? 'error' : 'cancelled', reason);
+            await release();
+        },
+    }, { highWaterMark: 0 });
+}

package/dist/core/bodySerializer.gen.d.ts

@@ -1,4 +1,4 @@
-import type { ArrayStyle, ObjectStyle, SerializerOptions } from './pathSerializer.gen.js';
+import type { ArrayStyle, ObjectStyle, SerializerOptions } from './pathSerializer.gen';
 export type QuerySerializer = (query: Record<string, unknown>) => string;
 export type BodySerializer = (body: unknown) => unknown;
 type QuerySerializerOptionsObject = {

package/dist/core/bodySerializer.gen.js

@@ -1,4 +1,7 @@
-// This file is auto-generated by @hey-api/openapi-ts
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlSearchParamsBodySerializer = exports.jsonBodySerializer = exports.formDataBodySerializer = void 0;
+const json_1 = require("./json");
 const serializeFormDataPair = (data, key, value) => {
     if (typeof value === 'string' || value instanceof Blob) {
         data.append(key, value);
@@ -18,7 +21,7 @@ const serializeUrlSearchParamsPair = (data, key, value) => {
         data.append(key, JSON.stringify(value));
     }
 };
-export const formDataBodySerializer = {
+exports.formDataBodySerializer = {
     bodySerializer: (body) => {
         const data = new FormData();
         Object.entries(body).forEach(([key, value]) => {
@@ -35,10 +38,10 @@ export const formDataBodySerializer = {
         return data;
     },
 };
-export const jsonBodySerializer = {
-    bodySerializer: (body) => JSON.stringify(body, (_key, value) => (typeof value === 'bigint' ? value.toString() : value)),
+exports.jsonBodySerializer = {
+    bodySerializer: (body) => (0, json_1.stringifyJson)(body),
 };
-export const urlSearchParamsBodySerializer = {
+exports.urlSearchParamsBodySerializer = {
     bodySerializer: (body) => {
         const data = new URLSearchParams();
         Object.entries(body).forEach(([key, value]) => {