browser-use-sdk 1.2.0 → 2.0.1

package/src/internal/uploads.ts

@@ -1,187 +0,0 @@
-import { type RequestOptions } from './request-options';
-import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { BrowserUse } from '../client';
-import { ReadableStreamFrom } from './shims';
-
-export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
-type FsReadStream = AsyncIterable<Uint8Array> & { path: string | { toString(): string } };
-
-// https://github.com/oven-sh/bun/issues/5980
-interface BunFile extends Blob {
-  readonly name?: string | undefined;
-}
-
-export const checkFileSupport = () => {
-  if (typeof File === 'undefined') {
-    const { process } = globalThis as any;
-    const isOldNode =
-      typeof process?.versions?.node === 'string' && parseInt(process.versions.node.split('.')) < 20;
-    throw new Error(
-      '`File` is not defined as a global, which is required for file uploads.' +
-        (isOldNode ?
-          " Update to Node 20 LTS or newer, or set `globalThis.File` to `import('node:buffer').File`."
-        : ''),
-    );
-  }
-};
-
-/**
- * Typically, this is a native "File" class.
- *
- * We provide the {@link toFile} utility to convert a variety of objects
- * into the File class.
- *
- * For convenience, you can also pass a fetch Response, or in Node,
- * the result of fs.createReadStream().
- */
-export type Uploadable = File | Response | FsReadStream | BunFile;
-
-/**
- * Construct a `File` instance. This is used to ensure a helpful error is thrown
- * for environments that don't define a global `File` yet.
- */
-export function makeFile(
-  fileBits: BlobPart[],
-  fileName: string | undefined,
-  options?: FilePropertyBag,
-): File {
-  checkFileSupport();
-  return new File(fileBits as any, fileName ?? 'unknown_file', options);
-}
-
-export function getName(value: any): string | undefined {
-  return (
-    (
-      (typeof value === 'object' &&
-        value !== null &&
-        (('name' in value && value.name && String(value.name)) ||
-          ('url' in value && value.url && String(value.url)) ||
-          ('filename' in value && value.filename && String(value.filename)) ||
-          ('path' in value && value.path && String(value.path)))) ||
-      ''
-    )
-      .split(/[\\/]/)
-      .pop() || undefined
-  );
-}
-
-export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
-  value != null && typeof value === 'object' && typeof value[Symbol.asyncIterator] === 'function';
-
-/**
- * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
- * Otherwise returns the request as is.
- */
-export const maybeMultipartFormRequestOptions = async (
-  opts: RequestOptions,
-  fetch: BrowserUse | Fetch,
-): Promise<RequestOptions> => {
-  if (!hasUploadableValue(opts.body)) return opts;
-
-  return { ...opts, body: await createForm(opts.body, fetch) };
-};
-
-type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknown };
-
-export const multipartFormRequestOptions = async (
-  opts: MultipartFormRequestOptions,
-  fetch: BrowserUse | Fetch,
-): Promise<RequestOptions> => {
-  return { ...opts, body: await createForm(opts.body, fetch) };
-};
-
-const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
-
-/**
- * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending
- * properly-encoded form data, it just stringifies the object, resulting in a request body of "[object FormData]".
- * This function detects if the fetch function provided supports the global FormData object to avoid
- * confusing error messages later on.
- */
-function supportsFormData(fetchObject: BrowserUse | Fetch): Promise<boolean> {
-  const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
-  const cached = supportsFormDataMap.get(fetch);
-  if (cached) return cached;
-  const promise = (async () => {
-    try {
-      const FetchResponse = (
-        'Response' in fetch ?
-          fetch.Response
-        : (await fetch('data:,')).constructor) as typeof Response;
-      const data = new FormData();
-      if (data.toString() === (await new FetchResponse(data).text())) {
-        return false;
-      }
-      return true;
-    } catch {
-      // avoid false negatives
-      return true;
-    }
-  })();
-  supportsFormDataMap.set(fetch, promise);
-  return promise;
-}
-
-export const createForm = async <T = Record<string, unknown>>(
-  body: T | undefined,
-  fetch: BrowserUse | Fetch,
-): Promise<FormData> => {
-  if (!(await supportsFormData(fetch))) {
-    throw new TypeError(
-      'The provided fetch function does not support file uploads with the current global FormData class.',
-    );
-  }
-  const form = new FormData();
-  await Promise.all(Object.entries(body || {}).map(([key, value]) => addFormValue(form, key, value)));
-  return form;
-};
-
-// We check for Blob not File because Bun.File doesn't inherit from File,
-// but they both inherit from Blob and have a `name` property at runtime.
-const isNamedBlob = (value: unknown) => value instanceof Blob && 'name' in value;
-
-const isUploadable = (value: unknown) =>
-  typeof value === 'object' &&
-  value !== null &&
-  (value instanceof Response || isAsyncIterable(value) || isNamedBlob(value));
-
-const hasUploadableValue = (value: unknown): boolean => {
-  if (isUploadable(value)) return true;
-  if (Array.isArray(value)) return value.some(hasUploadableValue);
-  if (value && typeof value === 'object') {
-    for (const k in value) {
-      if (hasUploadableValue((value as any)[k])) return true;
-    }
-  }
-  return false;
-};
-
-const addFormValue = async (form: FormData, key: string, value: unknown): Promise<void> => {
-  if (value === undefined) return;
-  if (value == null) {
-    throw new TypeError(
-      `Received null for "${key}"; to pass null in FormData, you must use the string 'null'`,
-    );
-  }
-
-  // TODO: make nested formats configurable
-  if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-    form.append(key, String(value));
-  } else if (value instanceof Response) {
-    form.append(key, makeFile([await value.blob()], getName(value)));
-  } else if (isAsyncIterable(value)) {
-    form.append(key, makeFile([await new Response(ReadableStreamFrom(value)).blob()], getName(value)));
-  } else if (isNamedBlob(value)) {
-    form.append(key, value, getName(value));
-  } else if (Array.isArray(value)) {
-    await Promise.all(value.map((entry) => addFormValue(form, key + '[]', entry)));
-  } else if (typeof value === 'object') {
-    await Promise.all(
-      Object.entries(value).map(([name, prop]) => addFormValue(form, `${key}[${name}]`, prop)),
-    );
-  } else {
-    throw new TypeError(
-      `Invalid value given to form, expected a string, number, boolean, object, Array, File or Blob but got ${value} instead`,
-    );
-  }
-};

package/src/internal/utils/base64.ts

@@ -1,40 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { BrowserUseError } from '../../core/error';
-import { encodeUTF8 } from './bytes';
-
-export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
-  if (!data) return '';
-
-  if (typeof (globalThis as any).Buffer !== 'undefined') {
-    return (globalThis as any).Buffer.from(data).toString('base64');
-  }
-
-  if (typeof data === 'string') {
-    data = encodeUTF8(data);
-  }
-
-  if (typeof btoa !== 'undefined') {
-    return btoa(String.fromCharCode.apply(null, data as any));
-  }
-
-  throw new BrowserUseError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
-};
-
-export const fromBase64 = (str: string): Uint8Array => {
-  if (typeof (globalThis as any).Buffer !== 'undefined') {
-    const buf = (globalThis as any).Buffer.from(str, 'base64');
-    return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
-  }
-
-  if (typeof atob !== 'undefined') {
-    const bstr = atob(str);
-    const buf = new Uint8Array(bstr.length);
-    for (let i = 0; i < bstr.length; i++) {
-      buf[i] = bstr.charCodeAt(i);
-    }
-    return buf;
-  }
-
-  throw new BrowserUseError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
-};

package/src/internal/utils/bytes.ts

@@ -1,32 +0,0 @@
-export function concatBytes(buffers: Uint8Array[]): Uint8Array {
-  let length = 0;
-  for (const buffer of buffers) {
-    length += buffer.length;
-  }
-  const output = new Uint8Array(length);
-  let index = 0;
-  for (const buffer of buffers) {
-    output.set(buffer, index);
-    index += buffer.length;
-  }
-
-  return output;
-}
-
-let encodeUTF8_: (str: string) => Uint8Array;
-export function encodeUTF8(str: string) {
-  let encoder;
-  return (
-    encodeUTF8_ ??
-    ((encoder = new (globalThis as any).TextEncoder()), (encodeUTF8_ = encoder.encode.bind(encoder)))
-  )(str);
-}
-
-let decodeUTF8_: (bytes: Uint8Array) => string;
-export function decodeUTF8(bytes: Uint8Array) {
-  let decoder;
-  return (
-    decodeUTF8_ ??
-    ((decoder = new (globalThis as any).TextDecoder()), (decodeUTF8_ = decoder.decode.bind(decoder)))
-  )(bytes);
-}

package/src/internal/utils/env.ts

@@ -1,18 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-/**
- * Read an environment variable.
- *
- * Trims beginning and trailing whitespace.
- *
- * Will return undefined if the environment variable doesn't exist or cannot be accessed.
- */
-export const readEnv = (env: string): string | undefined => {
-  if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
-  }
-  if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
-  }
-  return undefined;
-};

package/src/internal/utils/log.ts

@@ -1,127 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { hasOwn } from './values';
-import { type BrowserUse } from '../../client';
-import { RequestOptions } from '../request-options';
-
-type LogFn = (message: string, ...rest: unknown[]) => void;
-export type Logger = {
-  error: LogFn;
-  warn: LogFn;
-  info: LogFn;
-  debug: LogFn;
-};
-export type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
-
-const levelNumbers = {
-  off: 0,
-  error: 200,
-  warn: 300,
-  info: 400,
-  debug: 500,
-};
-
-export const parseLogLevel = (
-  maybeLevel: string | undefined,
-  sourceName: string,
-  client: BrowserUse,
-): LogLevel | undefined => {
-  if (!maybeLevel) {
-    return undefined;
-  }
-  if (hasOwn(levelNumbers, maybeLevel)) {
-    return maybeLevel;
-  }
-  loggerFor(client).warn(
-    `${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify(
-      Object.keys(levelNumbers),
-    )}`,
-  );
-  return undefined;
-};
-
-function noop() {}
-
-function makeLogFn(fnLevel: keyof Logger, logger: Logger | undefined, logLevel: LogLevel) {
-  if (!logger || levelNumbers[fnLevel] > levelNumbers[logLevel]) {
-    return noop;
-  } else {
-    // Don't wrap logger functions, we want the stacktrace intact!
-    return logger[fnLevel].bind(logger);
-  }
-}
-
-const noopLogger = {
-  error: noop,
-  warn: noop,
-  info: noop,
-  debug: noop,
-};
-
-let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
-
-export function loggerFor(client: BrowserUse): Logger {
-  const logger = client.logger;
-  const logLevel = client.logLevel ?? 'off';
-  if (!logger) {
-    return noopLogger;
-  }
-
-  const cachedLogger = cachedLoggers.get(logger);
-  if (cachedLogger && cachedLogger[0] === logLevel) {
-    return cachedLogger[1];
-  }
-
-  const levelLogger = {
-    error: makeLogFn('error', logger, logLevel),
-    warn: makeLogFn('warn', logger, logLevel),
-    info: makeLogFn('info', logger, logLevel),
-    debug: makeLogFn('debug', logger, logLevel),
-  };
-
-  cachedLoggers.set(logger, [logLevel, levelLogger]);
-
-  return levelLogger;
-}
-
-export const formatRequestDetails = (details: {
-  options?: RequestOptions | undefined;
-  headers?: Headers | Record<string, string> | undefined;
-  retryOfRequestLogID?: string | undefined;
-  retryOf?: string | undefined;
-  url?: string | undefined;
-  status?: number | undefined;
-  method?: string | undefined;
-  durationMs?: number | undefined;
-  message?: unknown;
-  body?: unknown;
-}) => {
-  if (details.options) {
-    details.options = { ...details.options };
-    delete details.options['headers']; // redundant + leaks internals
-  }
-  if (details.headers) {
-    details.headers = Object.fromEntries(
-      (details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map(
-        ([name, value]) => [
-          name,
-          (
-            name.toLowerCase() === 'x-browser-use-api-key' ||
-            name.toLowerCase() === 'authorization' ||
-            name.toLowerCase() === 'cookie' ||
-            name.toLowerCase() === 'set-cookie'
-          ) ?
-            '***'
-          : value,
-        ],
-      ),
-    );
-  }
-  if ('retryOfRequestLogID' in details) {
-    if (details.retryOfRequestLogID) {
-      details.retryOf = details.retryOfRequestLogID;
-    }
-    delete details.retryOfRequestLogID;
-  }
-  return details;
-};

package/src/internal/utils/path.ts

@@ -1,88 +0,0 @@
-import { BrowserUseError } from '../../core/error';
-
-/**
- * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
- *
- * Taken from https://datatracker.ietf.org/doc/html/rfc3986#section-3.3:
- * > unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
- * > sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
- * > pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
- */
-export function encodeURIPath(str: string) {
-  return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
-}
-
-const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
-
-export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
-  function path(statics: readonly string[], ...params: readonly unknown[]): string {
-    // If there are no params, no processing is needed.
-    if (statics.length === 1) return statics[0]!;
-
-    let postPath = false;
-    const invalidSegments = [];
-    const path = statics.reduce((previousValue, currentValue, index) => {
-      if (/[?#]/.test(currentValue)) {
-        postPath = true;
-      }
-      const value = params[index];
-      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
-      if (
-        index !== params.length &&
-        (value == null ||
-          (typeof value === 'object' &&
-            // handle values from other realms
-            value.toString ===
-              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
-                ?.toString))
-      ) {
-        encoded = value + '';
-        invalidSegments.push({
-          start: previousValue.length + currentValue.length,
-          length: encoded.length,
-          error: `Value of type ${Object.prototype.toString
-            .call(value)
-            .slice(8, -1)} is not a valid path parameter`,
-        });
-      }
-      return previousValue + currentValue + (index === params.length ? '' : encoded);
-    }, '');
-
-    const pathOnly = path.split(/[?#]/, 1)[0]!;
-    const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
-    let match;
-
-    // Find all invalid segments
-    while ((match = invalidSegmentPattern.exec(pathOnly)) !== null) {
-      invalidSegments.push({
-        start: match.index,
-        length: match[0].length,
-        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
-      });
-    }
-
-    invalidSegments.sort((a, b) => a.start - b.start);
-
-    if (invalidSegments.length > 0) {
-      let lastEnd = 0;
-      const underline = invalidSegments.reduce((acc, segment) => {
-        const spaces = ' '.repeat(segment.start - lastEnd);
-        const arrows = '^'.repeat(segment.length);
-        lastEnd = segment.start + segment.length;
-        return acc + spaces + arrows;
-      }, '');
-
-      throw new BrowserUseError(
-        `Path parameters result in path with invalid segments:\n${invalidSegments
-          .map((e) => e.error)
-          .join('\n')}\n${path}\n${underline}`,
-      );
-    }
-
-    return path;
-  };
-
-/**
- * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
- */
-export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/sleep.ts

@@ -1,3 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -1,17 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-/**
- * https://stackoverflow.com/a/2117523
- */
-export let uuid4 = function () {
-  const { crypto } = globalThis as any;
-  if (crypto?.randomUUID) {
-    uuid4 = crypto.randomUUID.bind(crypto);
-    return crypto.randomUUID();
-  }
-  const u8 = new Uint8Array(1);
-  const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff;
-  return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) =>
-    (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16),
-  );
-};

package/src/internal/utils/values.ts

@@ -1,105 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { BrowserUseError } from '../../core/error';
-
-// https://url.spec.whatwg.org/#url-scheme-string
-const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
-
-export const isAbsoluteURL = (url: string): boolean => {
-  return startsWithSchemeRegexp.test(url);
-};
-
-export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
-export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
-
-/** Returns an object if the given value isn't an object, otherwise returns as-is */
-export function maybeObj(x: unknown): object {
-  if (typeof x !== 'object') {
-    return {};
-  }
-
-  return x ?? {};
-}
-
-// https://stackoverflow.com/a/34491287
-export function isEmptyObj(obj: Object | null | undefined): boolean {
-  if (!obj) return true;
-  for (const _k in obj) return false;
-  return true;
-}
-
-// https://eslint.org/docs/latest/rules/no-prototype-builtins
-export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
-  return Object.prototype.hasOwnProperty.call(obj, key);
-}
-
-export function isObj(obj: unknown): obj is Record<string, unknown> {
-  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
-}
-
-export const ensurePresent = <T>(value: T | null | undefined): T => {
-  if (value == null) {
-    throw new BrowserUseError(`Expected a value to be given but received ${value} instead.`);
-  }
-
-  return value;
-};
-
-export const validatePositiveInteger = (name: string, n: unknown): number => {
-  if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new BrowserUseError(`${name} must be an integer`);
-  }
-  if (n < 0) {
-    throw new BrowserUseError(`${name} must be a positive integer`);
-  }
-  return n;
-};
-
-export const coerceInteger = (value: unknown): number => {
-  if (typeof value === 'number') return Math.round(value);
-  if (typeof value === 'string') return parseInt(value, 10);
-
-  throw new BrowserUseError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
-};
-
-export const coerceFloat = (value: unknown): number => {
-  if (typeof value === 'number') return value;
-  if (typeof value === 'string') return parseFloat(value);
-
-  throw new BrowserUseError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
-};
-
-export const coerceBoolean = (value: unknown): boolean => {
-  if (typeof value === 'boolean') return value;
-  if (typeof value === 'string') return value === 'true';
-  return Boolean(value);
-};
-
-export const maybeCoerceInteger = (value: unknown): number | undefined => {
-  if (value === undefined) {
-    return undefined;
-  }
-  return coerceInteger(value);
-};
-
-export const maybeCoerceFloat = (value: unknown): number | undefined => {
-  if (value === undefined) {
-    return undefined;
-  }
-  return coerceFloat(value);
-};
-
-export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
-  if (value === undefined) {
-    return undefined;
-  }
-  return coerceBoolean(value);
-};
-
-export const safeJSON = (text: string) => {
-  try {
-    return JSON.parse(text);
-  } catch (err) {
-    return undefined;
-  }
-};

package/src/internal/utils.ts

@@ -1,8 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-export * from './utils/values';
-export * from './utils/base64';
-export * from './utils/env';
-export * from './utils/log';
-export * from './utils/uuid';
-export * from './utils/sleep';

package/src/lib/.keep

@@ -1,4 +0,0 @@
-File generated from our OpenAPI spec by Stainless.
-
-This directory can be used to store custom files to expand the SDK.
-It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.