{{ message }}
Repository navigation
Expand file tree
/
Copy pathindex.ts
More file actions
375 lines (335 loc) · 11.8 KB
/
Copy pathindex.ts
File metadata and controls
375 lines (335 loc) · 11.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { type Agent } from './_shims/index';
import * as Core from './core';
import * as Errors from './error';
import * as Uploads from './uploads';
import * as API from './resources/index';
import {
Certificate,
CertificateCreateParams,
CertificateListResponse,
Certificates,
} from './resources/certificates';
import {
Context,
ContextCreateParams,
ContextCreateResponse,
ContextUpdateResponse,
Contexts,
} from './resources/contexts';
import { Extension, ExtensionCreateParams, Extensions } from './resources/extensions';
import { FetchAPI, FetchAPICreateParams, FetchAPICreateResponse } from './resources/fetch-api';
import { Project, ProjectListResponse, ProjectUsage, Projects } from './resources/projects';
import { Search, SearchWebParams, SearchWebResponse } from './resources/search';
import {
Secret,
SecretCreateParams,
SecretListParams,
SecretListResponse,
SecretUpdateParams,
Secrets,
SecretsKeypair,
} from './resources/secrets';
import {
Webhook,
WebhookCreateParams,
WebhookCreateResponse,
WebhookListParams,
WebhookListResponse,
WebhookRotateSecretParams,
WebhookRotateSecretResponse,
WebhookUpdateParams,
Webhooks,
} from './resources/webhooks';
import {
AgentCreateParams,
AgentCreateResponse,
AgentListParams,
AgentListResponse,
AgentRetrieveResponse,
AgentUpdateParams,
AgentUpdateResponse,
Agents,
} from './resources/agents/agents';
import { Functions } from './resources/functions/functions';
import {
Session,
SessionCreateParams,
SessionCreateResponse,
SessionDebugParams,
SessionListParams,
SessionListResponse,
SessionLiveURLs,
SessionRetrieveResponse,
SessionUpdateParams,
Sessions,
} from './resources/sessions/sessions';
export interface ClientOptions {
/**
* Your [Browserbase API Key](https://www.browserbase.com/settings).
*/
apiKey?: string | undefined;
/**
* Override the default base URL for the API, e.g., "https://api.example.com/v2/"
*
* Defaults to process.env['BROWSERBASE_BASE_URL'].
*/
baseURL?: string | null | undefined;
/**
* The maximum amount of time (in milliseconds) that the client should wait for a response
* from the server before timing out a single request.
*
* Note that request timeouts are retried by default, so in a worst-case scenario you may wait
* much longer than this timeout before the promise succeeds or fails.
*
* @unit milliseconds
*/
timeout?: number | undefined;
/**
* An HTTP agent used to manage HTTP(S) connections.
*
* If provided in Node.js, requests use the legacy `node-fetch` transport so the agent can be
* honored. The default modern Node.js transport uses `globalThis.fetch` and does not attach
* a node:http Agent.
*/
httpAgent?: Agent | undefined;
/**
* Specify a custom `fetch` function implementation.
*
* If not provided, we use `globalThis.fetch` in Node.js when available, fall back to
* `node-fetch` in older Node.js environments, and otherwise expect that `fetch` is defined
* globally.
*/
fetch?: Core.Fetch | undefined;
/**
* The maximum number of times that the client will retry a request in case of a
* temporary failure, like a network error or a 5XX error from the server.
*
* @default 2
*/
maxRetries?: number | undefined;
/**
* Default headers to include with every request to the API.
*
* These can be removed in individual requests by explicitly setting the
* header to `undefined` or `null` in request options.
*/
defaultHeaders?: Core.Headers | undefined;
/**
* Default query parameters to include with every request to the API.
*
* These can be removed in individual requests by explicitly setting the
* param to `undefined` in request options.
*/
defaultQuery?: Core.DefaultQuery | undefined;
}
/**
* API Client for interfacing with the Browserbase API.
*/
export class Browserbase extends Core.APIClient {
apiKey: string;
private _options: ClientOptions;
/**
* API Client for interfacing with the Browserbase API.
*
* @param {string | undefined} [opts.apiKey=process.env['BROWSERBASE_API_KEY'] ?? undefined]
* @param {string} [opts.baseURL=process.env['BROWSERBASE_BASE_URL'] ?? https://api.browserbase.com] - Override the default base URL for the API.
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
* @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
* @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
*/
constructor({
baseURL = Core.readEnv('BROWSERBASE_BASE_URL'),
apiKey = Core.readEnv('BROWSERBASE_API_KEY'),
...opts
}: ClientOptions = {}) {
if (apiKey === undefined) {
throw new Errors.BrowserbaseError(
"The BROWSERBASE_API_KEY environment variable is missing or empty; either provide it, or instantiate the Browserbase client with an apiKey option, like new Browserbase({ apiKey: 'My API Key' }).",
);
}
const options: ClientOptions = {
apiKey,
...opts,
baseURL: baseURL || `https://api.browserbase.com`,
};
super({
baseURL: options.baseURL!,
baseURLOverridden: baseURL ? baseURL !== 'https://api.browserbase.com' : false,
timeout: options.timeout ?? 60000 /* 1 minute */,
httpAgent: options.httpAgent,
maxRetries: options.maxRetries,
fetch: options.fetch,
});
const customHeadersEnv = Core.readEnv('BROWSERBASE_CUSTOM_HEADERS');
if (customHeadersEnv) {
const parsed: Record<string, string> = {};
for (const line of customHeadersEnv.split('\n')) {
const colon = line.indexOf(':');
if (colon >= 0) {
parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
}
}
options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
}
this._options = options;
this.apiKey = apiKey;
}
certificates: API.Certificates = new API.Certificates(this);
contexts: API.Contexts = new API.Contexts(this);
extensions: API.Extensions = new API.Extensions(this);
fetchAPI: API.FetchAPI = new API.FetchAPI(this);
functions: API.Functions = new API.Functions(this);
projects: API.Projects = new API.Projects(this);
search: API.Search = new API.Search(this);
secrets: API.Secrets = new API.Secrets(this);
sessions: API.Sessions = new API.Sessions(this);
agents: API.Agents = new API.Agents(this);
webhooks: API.Webhooks = new API.Webhooks(this);
/**
* Check whether the base URL is set to its default.
*/
#baseURLOverridden(): boolean {
return this.baseURL !== 'https://api.browserbase.com';
}
protected override defaultQuery(): Core.DefaultQuery | undefined {
return this._options.defaultQuery;
}
protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
return {
...super.defaultHeaders(opts),
...this._options.defaultHeaders,
};
}
protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
return { 'X-BB-API-Key': this.apiKey };
}
static Browserbase = this;
static DEFAULT_TIMEOUT = 60000; // 1 minute
static BrowserbaseError = Errors.BrowserbaseError;
static APIError = Errors.APIError;
static APIConnectionError = Errors.APIConnectionError;
static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
static APIUserAbortError = Errors.APIUserAbortError;
static NotFoundError = Errors.NotFoundError;
static ConflictError = Errors.ConflictError;
static RateLimitError = Errors.RateLimitError;
static BadRequestError = Errors.BadRequestError;
static AuthenticationError = Errors.AuthenticationError;
static InternalServerError = Errors.InternalServerError;
static PermissionDeniedError = Errors.PermissionDeniedError;
static UnprocessableEntityError = Errors.UnprocessableEntityError;
static toFile = Uploads.toFile;
static fileFromPath = Uploads.fileFromPath;
}
Browserbase.Certificates = Certificates;
Browserbase.Contexts = Contexts;
Browserbase.Extensions = Extensions;
Browserbase.FetchAPI = FetchAPI;
Browserbase.Functions = Functions;
Browserbase.Projects = Projects;
Browserbase.Search = Search;
Browserbase.Secrets = Secrets;
Browserbase.Sessions = Sessions;
Browserbase.Agents = Agents;
Browserbase.Webhooks = Webhooks;
export declare namespace Browserbase {
export type RequestOptions = Core.RequestOptions;
export {
Certificates as Certificates,
type Certificate as Certificate,
type CertificateListResponse as CertificateListResponse,
type CertificateCreateParams as CertificateCreateParams,
};
export {
Contexts as Contexts,
type Context as Context,
type ContextCreateResponse as ContextCreateResponse,
type ContextUpdateResponse as ContextUpdateResponse,
type ContextCreateParams as ContextCreateParams,
};
export {
Extensions as Extensions,
type Extension as Extension,
type ExtensionCreateParams as ExtensionCreateParams,
};
export {
FetchAPI as FetchAPI,
type FetchAPICreateResponse as FetchAPICreateResponse,
type FetchAPICreateParams as FetchAPICreateParams,
};
export { Functions as Functions };
export {
Projects as Projects,
type Project as Project,
type ProjectUsage as ProjectUsage,
type ProjectListResponse as ProjectListResponse,
};
export {
Search as Search,
type SearchWebResponse as SearchWebResponse,
type SearchWebParams as SearchWebParams,
};
export {
Secrets as Secrets,
type Secret as Secret,
type SecretsKeypair as SecretsKeypair,
type SecretListResponse as SecretListResponse,
type SecretCreateParams as SecretCreateParams,
type SecretUpdateParams as SecretUpdateParams,
type SecretListParams as SecretListParams,
};
export {
Sessions as Sessions,
type Session as Session,
type SessionLiveURLs as SessionLiveURLs,
type SessionCreateResponse as SessionCreateResponse,
type SessionRetrieveResponse as SessionRetrieveResponse,
type SessionListResponse as SessionListResponse,
type SessionCreateParams as SessionCreateParams,
type SessionUpdateParams as SessionUpdateParams,
type SessionListParams as SessionListParams,
type SessionDebugParams as SessionDebugParams,
};
export {
Agents as Agents,
type AgentCreateResponse as AgentCreateResponse,
type AgentRetrieveResponse as AgentRetrieveResponse,
type AgentUpdateResponse as AgentUpdateResponse,
type AgentListResponse as AgentListResponse,
type AgentCreateParams as AgentCreateParams,
type AgentUpdateParams as AgentUpdateParams,
type AgentListParams as AgentListParams,
};
export {
Webhooks as Webhooks,
type Webhook as Webhook,
type WebhookCreateResponse as WebhookCreateResponse,
type WebhookListResponse as WebhookListResponse,
type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
type WebhookCreateParams as WebhookCreateParams,
type WebhookUpdateParams as WebhookUpdateParams,
type WebhookListParams as WebhookListParams,
type WebhookRotateSecretParams as WebhookRotateSecretParams,
};
}
export { toFile, fileFromPath } from './uploads';
export {
BrowserbaseError,
APIError,
APIConnectionError,
APIConnectionTimeoutError,
APIUserAbortError,
NotFoundError,
ConflictError,
RateLimitError,
BadRequestError,
AuthenticationError,
InternalServerError,
PermissionDeniedError,
UnprocessableEntityError,
} from './error';
export default Browserbase;
You can’t perform that action at this time.