@cloudflare/workers-types 5.20260915.1 → 5.20260917.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/experimental/index.d.ts +200 -0
- package/experimental/index.ts +203 -0
- package/index.d.ts +200 -0
- package/index.ts +203 -0
- package/package.json +1 -1
package/experimental/index.d.ts
CHANGED
|
@@ -13166,6 +13166,178 @@ type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
13166
13166
|
/** Raw AI response text for debugging */
|
|
13167
13167
|
rawAiResponse?: string;
|
|
13168
13168
|
};
|
|
13169
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
13170
|
+
type BrowserRunAcquireGuardrails = {
|
|
13171
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
13172
|
+
allowedDomains?: string[];
|
|
13173
|
+
/** Named domain sets that the browser may access. */
|
|
13174
|
+
allowedDomainSets?: string[];
|
|
13175
|
+
};
|
|
13176
|
+
/** Options for acquiring a new browser session. */
|
|
13177
|
+
type BrowserRunAcquireOptions = {
|
|
13178
|
+
/** Idle session lifetime in milliseconds. */
|
|
13179
|
+
keepAlive?: number;
|
|
13180
|
+
/** Record the browser session. */
|
|
13181
|
+
recording?: boolean;
|
|
13182
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
13183
|
+
location?: string;
|
|
13184
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
13185
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
13186
|
+
/** Session-scoped network guardrails. */
|
|
13187
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
13188
|
+
/** Include the session's DevTools targets in the result. */
|
|
13189
|
+
targets?: boolean;
|
|
13190
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
13191
|
+
liveViewUrlExpiresInMs?: number;
|
|
13192
|
+
};
|
|
13193
|
+
/** Metadata returned when a browser session is acquired. */
|
|
13194
|
+
type BrowserRunAcquireResult = {
|
|
13195
|
+
sessionId: string;
|
|
13196
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13197
|
+
};
|
|
13198
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
13199
|
+
type BrowserRunConnectOptions = {
|
|
13200
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
13201
|
+
targetId?: string;
|
|
13202
|
+
};
|
|
13203
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
13204
|
+
type BrowserRunConnection = {
|
|
13205
|
+
sessionId: string;
|
|
13206
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
13207
|
+
webSocket: Fetcher;
|
|
13208
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13209
|
+
};
|
|
13210
|
+
/** The UI mode for a live-view link. */
|
|
13211
|
+
type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
13212
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
13213
|
+
type BrowserRunConnectionGuardrails = {
|
|
13214
|
+
mode: "readonly";
|
|
13215
|
+
};
|
|
13216
|
+
/** Options for minting a live-view link. */
|
|
13217
|
+
type BrowserRunLiveViewOptions = {
|
|
13218
|
+
mode?: BrowserRunLiveViewMode;
|
|
13219
|
+
targetId?: string;
|
|
13220
|
+
expiresInMs?: number;
|
|
13221
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13222
|
+
};
|
|
13223
|
+
/** Live-view link metadata. */
|
|
13224
|
+
type BrowserRunLiveView = {
|
|
13225
|
+
webSocketDebuggerUrl: string;
|
|
13226
|
+
devtoolsFrontendUrl: string;
|
|
13227
|
+
id: string;
|
|
13228
|
+
options: {
|
|
13229
|
+
mode: BrowserRunLiveViewMode;
|
|
13230
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13231
|
+
};
|
|
13232
|
+
};
|
|
13233
|
+
/** Options for listing active browser sessions. */
|
|
13234
|
+
type BrowserRunListSessionsOptions = {
|
|
13235
|
+
limit?: number;
|
|
13236
|
+
offset?: number;
|
|
13237
|
+
};
|
|
13238
|
+
/** Options for listing session history. */
|
|
13239
|
+
type BrowserRunHistoryOptions = {
|
|
13240
|
+
limit?: number;
|
|
13241
|
+
offset?: number;
|
|
13242
|
+
};
|
|
13243
|
+
/** A browser session returned by the session-management methods. */
|
|
13244
|
+
type BrowserRunSession = {
|
|
13245
|
+
sessionId: string;
|
|
13246
|
+
startTime?: number;
|
|
13247
|
+
endTime?: number;
|
|
13248
|
+
closeReason?: number;
|
|
13249
|
+
closeReasonText?: string;
|
|
13250
|
+
connectionId?: string;
|
|
13251
|
+
connectionStartTime?: number;
|
|
13252
|
+
connectionEndTime?: number;
|
|
13253
|
+
lastUpdated?: number;
|
|
13254
|
+
webSocketDebuggerUrl?: string;
|
|
13255
|
+
devtoolsFrontendUrl?: string;
|
|
13256
|
+
};
|
|
13257
|
+
/** Account browser-session and browser-time limits. */
|
|
13258
|
+
type BrowserRunLimits = {
|
|
13259
|
+
activeSessions: Array<{
|
|
13260
|
+
id: string;
|
|
13261
|
+
}>;
|
|
13262
|
+
maxConcurrentSessions: number;
|
|
13263
|
+
allowedBrowserAcquisitions: number;
|
|
13264
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
13265
|
+
usedBrowserTimeSeconds?: number;
|
|
13266
|
+
};
|
|
13267
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
13268
|
+
type BrowserRunDevToolsTarget = {
|
|
13269
|
+
id: string;
|
|
13270
|
+
type: string;
|
|
13271
|
+
url: string;
|
|
13272
|
+
title?: string;
|
|
13273
|
+
description?: string;
|
|
13274
|
+
webSocketDebuggerUrl?: string;
|
|
13275
|
+
devtoolsFrontendUrl?: string;
|
|
13276
|
+
};
|
|
13277
|
+
/** Browser and protocol version metadata. */
|
|
13278
|
+
type BrowserRunDevToolsVersion = {
|
|
13279
|
+
Browser: string;
|
|
13280
|
+
"Protocol-Version": string;
|
|
13281
|
+
"User-Agent": string;
|
|
13282
|
+
"V8-Version": string;
|
|
13283
|
+
"WebKit-Version": string;
|
|
13284
|
+
webSocketDebuggerUrl: string;
|
|
13285
|
+
};
|
|
13286
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13287
|
+
interface BrowserRunDevToolsProtocolDomain extends Record<string, unknown> {
|
|
13288
|
+
domain: string;
|
|
13289
|
+
experimental?: boolean;
|
|
13290
|
+
dependencies?: string[];
|
|
13291
|
+
types?: Array<Record<string, any>>;
|
|
13292
|
+
commands?: Array<Record<string, any>>;
|
|
13293
|
+
events?: Array<Record<string, any>>;
|
|
13294
|
+
}
|
|
13295
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13296
|
+
interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13297
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13298
|
+
version?: {
|
|
13299
|
+
major: string;
|
|
13300
|
+
minor: string;
|
|
13301
|
+
};
|
|
13302
|
+
}
|
|
13303
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13304
|
+
type BrowserRunTargetOptions = {
|
|
13305
|
+
liveViewUrlExpiresInMs?: number;
|
|
13306
|
+
};
|
|
13307
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13308
|
+
type BrowserRunTargetActionResult = {
|
|
13309
|
+
message: string;
|
|
13310
|
+
};
|
|
13311
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13312
|
+
type BrowserRunDevtools = {
|
|
13313
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13314
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13315
|
+
listTargets(
|
|
13316
|
+
sessionId: string,
|
|
13317
|
+
options?: BrowserRunTargetOptions,
|
|
13318
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13319
|
+
getTarget(
|
|
13320
|
+
sessionId: string,
|
|
13321
|
+
targetId: string,
|
|
13322
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13323
|
+
newTarget(
|
|
13324
|
+
sessionId: string,
|
|
13325
|
+
url?: string,
|
|
13326
|
+
options?: BrowserRunTargetOptions,
|
|
13327
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13328
|
+
activateTarget(
|
|
13329
|
+
sessionId: string,
|
|
13330
|
+
targetId: string,
|
|
13331
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13332
|
+
closeTarget(
|
|
13333
|
+
sessionId: string,
|
|
13334
|
+
targetId: string,
|
|
13335
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13336
|
+
};
|
|
13337
|
+
/** Result returned when closing a browser session. */
|
|
13338
|
+
type BrowserRunCloseSessionResult = {
|
|
13339
|
+
status: "closing" | "closed";
|
|
13340
|
+
};
|
|
13169
13341
|
/**
|
|
13170
13342
|
* Browser Run API binding for automating headless browsers.
|
|
13171
13343
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13354,6 +13526,34 @@ declare abstract class BrowserRun {
|
|
|
13354
13526
|
action: "accessibilityTree",
|
|
13355
13527
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13356
13528
|
): Promise<Response>;
|
|
13529
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13530
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13531
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13532
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13533
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13534
|
+
connectSession(
|
|
13535
|
+
sessionId: string,
|
|
13536
|
+
options?: BrowserRunConnectOptions,
|
|
13537
|
+
): Promise<BrowserRunConnection>;
|
|
13538
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13539
|
+
getLiveView(
|
|
13540
|
+
sessionId: string,
|
|
13541
|
+
options?: BrowserRunLiveViewOptions,
|
|
13542
|
+
): Promise<BrowserRunLiveView>;
|
|
13543
|
+
/** List the caller's active browser sessions. */
|
|
13544
|
+
listSessions(
|
|
13545
|
+
options?: BrowserRunListSessionsOptions,
|
|
13546
|
+
): Promise<BrowserRunSession[]>;
|
|
13547
|
+
/** List recent active and closed browser sessions. */
|
|
13548
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13549
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13550
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13551
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13552
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13553
|
+
/** Close a browser session. */
|
|
13554
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13555
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13556
|
+
get devtools(): BrowserRunDevtools;
|
|
13357
13557
|
}
|
|
13358
13558
|
/**
|
|
13359
13559
|
* In addition to the properties you can set in the RequestInit dict
|
package/experimental/index.ts
CHANGED
|
@@ -13180,6 +13180,181 @@ export type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
13180
13180
|
/** Raw AI response text for debugging */
|
|
13181
13181
|
rawAiResponse?: string;
|
|
13182
13182
|
};
|
|
13183
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
13184
|
+
export type BrowserRunAcquireGuardrails = {
|
|
13185
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
13186
|
+
allowedDomains?: string[];
|
|
13187
|
+
/** Named domain sets that the browser may access. */
|
|
13188
|
+
allowedDomainSets?: string[];
|
|
13189
|
+
};
|
|
13190
|
+
/** Options for acquiring a new browser session. */
|
|
13191
|
+
export type BrowserRunAcquireOptions = {
|
|
13192
|
+
/** Idle session lifetime in milliseconds. */
|
|
13193
|
+
keepAlive?: number;
|
|
13194
|
+
/** Record the browser session. */
|
|
13195
|
+
recording?: boolean;
|
|
13196
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
13197
|
+
location?: string;
|
|
13198
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
13199
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
13200
|
+
/** Session-scoped network guardrails. */
|
|
13201
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
13202
|
+
/** Include the session's DevTools targets in the result. */
|
|
13203
|
+
targets?: boolean;
|
|
13204
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
13205
|
+
liveViewUrlExpiresInMs?: number;
|
|
13206
|
+
};
|
|
13207
|
+
/** Metadata returned when a browser session is acquired. */
|
|
13208
|
+
export type BrowserRunAcquireResult = {
|
|
13209
|
+
sessionId: string;
|
|
13210
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13211
|
+
};
|
|
13212
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
13213
|
+
export type BrowserRunConnectOptions = {
|
|
13214
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
13215
|
+
targetId?: string;
|
|
13216
|
+
};
|
|
13217
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
13218
|
+
export type BrowserRunConnection = {
|
|
13219
|
+
sessionId: string;
|
|
13220
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
13221
|
+
webSocket: Fetcher;
|
|
13222
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13223
|
+
};
|
|
13224
|
+
/** The UI mode for a live-view link. */
|
|
13225
|
+
export type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
13226
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
13227
|
+
export type BrowserRunConnectionGuardrails = {
|
|
13228
|
+
mode: "readonly";
|
|
13229
|
+
};
|
|
13230
|
+
/** Options for minting a live-view link. */
|
|
13231
|
+
export type BrowserRunLiveViewOptions = {
|
|
13232
|
+
mode?: BrowserRunLiveViewMode;
|
|
13233
|
+
targetId?: string;
|
|
13234
|
+
expiresInMs?: number;
|
|
13235
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13236
|
+
};
|
|
13237
|
+
/** Live-view link metadata. */
|
|
13238
|
+
export type BrowserRunLiveView = {
|
|
13239
|
+
webSocketDebuggerUrl: string;
|
|
13240
|
+
devtoolsFrontendUrl: string;
|
|
13241
|
+
id: string;
|
|
13242
|
+
options: {
|
|
13243
|
+
mode: BrowserRunLiveViewMode;
|
|
13244
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13245
|
+
};
|
|
13246
|
+
};
|
|
13247
|
+
/** Options for listing active browser sessions. */
|
|
13248
|
+
export type BrowserRunListSessionsOptions = {
|
|
13249
|
+
limit?: number;
|
|
13250
|
+
offset?: number;
|
|
13251
|
+
};
|
|
13252
|
+
/** Options for listing session history. */
|
|
13253
|
+
export type BrowserRunHistoryOptions = {
|
|
13254
|
+
limit?: number;
|
|
13255
|
+
offset?: number;
|
|
13256
|
+
};
|
|
13257
|
+
/** A browser session returned by the session-management methods. */
|
|
13258
|
+
export type BrowserRunSession = {
|
|
13259
|
+
sessionId: string;
|
|
13260
|
+
startTime?: number;
|
|
13261
|
+
endTime?: number;
|
|
13262
|
+
closeReason?: number;
|
|
13263
|
+
closeReasonText?: string;
|
|
13264
|
+
connectionId?: string;
|
|
13265
|
+
connectionStartTime?: number;
|
|
13266
|
+
connectionEndTime?: number;
|
|
13267
|
+
lastUpdated?: number;
|
|
13268
|
+
webSocketDebuggerUrl?: string;
|
|
13269
|
+
devtoolsFrontendUrl?: string;
|
|
13270
|
+
};
|
|
13271
|
+
/** Account browser-session and browser-time limits. */
|
|
13272
|
+
export type BrowserRunLimits = {
|
|
13273
|
+
activeSessions: Array<{
|
|
13274
|
+
id: string;
|
|
13275
|
+
}>;
|
|
13276
|
+
maxConcurrentSessions: number;
|
|
13277
|
+
allowedBrowserAcquisitions: number;
|
|
13278
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
13279
|
+
usedBrowserTimeSeconds?: number;
|
|
13280
|
+
};
|
|
13281
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
13282
|
+
export type BrowserRunDevToolsTarget = {
|
|
13283
|
+
id: string;
|
|
13284
|
+
type: string;
|
|
13285
|
+
url: string;
|
|
13286
|
+
title?: string;
|
|
13287
|
+
description?: string;
|
|
13288
|
+
webSocketDebuggerUrl?: string;
|
|
13289
|
+
devtoolsFrontendUrl?: string;
|
|
13290
|
+
};
|
|
13291
|
+
/** Browser and protocol version metadata. */
|
|
13292
|
+
export type BrowserRunDevToolsVersion = {
|
|
13293
|
+
Browser: string;
|
|
13294
|
+
"Protocol-Version": string;
|
|
13295
|
+
"User-Agent": string;
|
|
13296
|
+
"V8-Version": string;
|
|
13297
|
+
"WebKit-Version": string;
|
|
13298
|
+
webSocketDebuggerUrl: string;
|
|
13299
|
+
};
|
|
13300
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13301
|
+
export interface BrowserRunDevToolsProtocolDomain extends Record<
|
|
13302
|
+
string,
|
|
13303
|
+
unknown
|
|
13304
|
+
> {
|
|
13305
|
+
domain: string;
|
|
13306
|
+
experimental?: boolean;
|
|
13307
|
+
dependencies?: string[];
|
|
13308
|
+
types?: Array<Record<string, any>>;
|
|
13309
|
+
commands?: Array<Record<string, any>>;
|
|
13310
|
+
events?: Array<Record<string, any>>;
|
|
13311
|
+
}
|
|
13312
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13313
|
+
export interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13314
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13315
|
+
version?: {
|
|
13316
|
+
major: string;
|
|
13317
|
+
minor: string;
|
|
13318
|
+
};
|
|
13319
|
+
}
|
|
13320
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13321
|
+
export type BrowserRunTargetOptions = {
|
|
13322
|
+
liveViewUrlExpiresInMs?: number;
|
|
13323
|
+
};
|
|
13324
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13325
|
+
export type BrowserRunTargetActionResult = {
|
|
13326
|
+
message: string;
|
|
13327
|
+
};
|
|
13328
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13329
|
+
export type BrowserRunDevtools = {
|
|
13330
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13331
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13332
|
+
listTargets(
|
|
13333
|
+
sessionId: string,
|
|
13334
|
+
options?: BrowserRunTargetOptions,
|
|
13335
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13336
|
+
getTarget(
|
|
13337
|
+
sessionId: string,
|
|
13338
|
+
targetId: string,
|
|
13339
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13340
|
+
newTarget(
|
|
13341
|
+
sessionId: string,
|
|
13342
|
+
url?: string,
|
|
13343
|
+
options?: BrowserRunTargetOptions,
|
|
13344
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13345
|
+
activateTarget(
|
|
13346
|
+
sessionId: string,
|
|
13347
|
+
targetId: string,
|
|
13348
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13349
|
+
closeTarget(
|
|
13350
|
+
sessionId: string,
|
|
13351
|
+
targetId: string,
|
|
13352
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13353
|
+
};
|
|
13354
|
+
/** Result returned when closing a browser session. */
|
|
13355
|
+
export type BrowserRunCloseSessionResult = {
|
|
13356
|
+
status: "closing" | "closed";
|
|
13357
|
+
};
|
|
13183
13358
|
/**
|
|
13184
13359
|
* Browser Run API binding for automating headless browsers.
|
|
13185
13360
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13368,6 +13543,34 @@ export declare abstract class BrowserRun {
|
|
|
13368
13543
|
action: "accessibilityTree",
|
|
13369
13544
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13370
13545
|
): Promise<Response>;
|
|
13546
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13547
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13548
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13549
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13550
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13551
|
+
connectSession(
|
|
13552
|
+
sessionId: string,
|
|
13553
|
+
options?: BrowserRunConnectOptions,
|
|
13554
|
+
): Promise<BrowserRunConnection>;
|
|
13555
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13556
|
+
getLiveView(
|
|
13557
|
+
sessionId: string,
|
|
13558
|
+
options?: BrowserRunLiveViewOptions,
|
|
13559
|
+
): Promise<BrowserRunLiveView>;
|
|
13560
|
+
/** List the caller's active browser sessions. */
|
|
13561
|
+
listSessions(
|
|
13562
|
+
options?: BrowserRunListSessionsOptions,
|
|
13563
|
+
): Promise<BrowserRunSession[]>;
|
|
13564
|
+
/** List recent active and closed browser sessions. */
|
|
13565
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13566
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13567
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13568
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13569
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13570
|
+
/** Close a browser session. */
|
|
13571
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13572
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13573
|
+
get devtools(): BrowserRunDevtools;
|
|
13371
13574
|
}
|
|
13372
13575
|
/**
|
|
13373
13576
|
* In addition to the properties you can set in the RequestInit dict
|
package/index.d.ts
CHANGED
|
@@ -12889,6 +12889,178 @@ type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
12889
12889
|
/** Raw AI response text for debugging */
|
|
12890
12890
|
rawAiResponse?: string;
|
|
12891
12891
|
};
|
|
12892
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
12893
|
+
type BrowserRunAcquireGuardrails = {
|
|
12894
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
12895
|
+
allowedDomains?: string[];
|
|
12896
|
+
/** Named domain sets that the browser may access. */
|
|
12897
|
+
allowedDomainSets?: string[];
|
|
12898
|
+
};
|
|
12899
|
+
/** Options for acquiring a new browser session. */
|
|
12900
|
+
type BrowserRunAcquireOptions = {
|
|
12901
|
+
/** Idle session lifetime in milliseconds. */
|
|
12902
|
+
keepAlive?: number;
|
|
12903
|
+
/** Record the browser session. */
|
|
12904
|
+
recording?: boolean;
|
|
12905
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
12906
|
+
location?: string;
|
|
12907
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
12908
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
12909
|
+
/** Session-scoped network guardrails. */
|
|
12910
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
12911
|
+
/** Include the session's DevTools targets in the result. */
|
|
12912
|
+
targets?: boolean;
|
|
12913
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
12914
|
+
liveViewUrlExpiresInMs?: number;
|
|
12915
|
+
};
|
|
12916
|
+
/** Metadata returned when a browser session is acquired. */
|
|
12917
|
+
type BrowserRunAcquireResult = {
|
|
12918
|
+
sessionId: string;
|
|
12919
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
12920
|
+
};
|
|
12921
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
12922
|
+
type BrowserRunConnectOptions = {
|
|
12923
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
12924
|
+
targetId?: string;
|
|
12925
|
+
};
|
|
12926
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
12927
|
+
type BrowserRunConnection = {
|
|
12928
|
+
sessionId: string;
|
|
12929
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
12930
|
+
webSocket: Fetcher;
|
|
12931
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
12932
|
+
};
|
|
12933
|
+
/** The UI mode for a live-view link. */
|
|
12934
|
+
type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
12935
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
12936
|
+
type BrowserRunConnectionGuardrails = {
|
|
12937
|
+
mode: "readonly";
|
|
12938
|
+
};
|
|
12939
|
+
/** Options for minting a live-view link. */
|
|
12940
|
+
type BrowserRunLiveViewOptions = {
|
|
12941
|
+
mode?: BrowserRunLiveViewMode;
|
|
12942
|
+
targetId?: string;
|
|
12943
|
+
expiresInMs?: number;
|
|
12944
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
12945
|
+
};
|
|
12946
|
+
/** Live-view link metadata. */
|
|
12947
|
+
type BrowserRunLiveView = {
|
|
12948
|
+
webSocketDebuggerUrl: string;
|
|
12949
|
+
devtoolsFrontendUrl: string;
|
|
12950
|
+
id: string;
|
|
12951
|
+
options: {
|
|
12952
|
+
mode: BrowserRunLiveViewMode;
|
|
12953
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
12954
|
+
};
|
|
12955
|
+
};
|
|
12956
|
+
/** Options for listing active browser sessions. */
|
|
12957
|
+
type BrowserRunListSessionsOptions = {
|
|
12958
|
+
limit?: number;
|
|
12959
|
+
offset?: number;
|
|
12960
|
+
};
|
|
12961
|
+
/** Options for listing session history. */
|
|
12962
|
+
type BrowserRunHistoryOptions = {
|
|
12963
|
+
limit?: number;
|
|
12964
|
+
offset?: number;
|
|
12965
|
+
};
|
|
12966
|
+
/** A browser session returned by the session-management methods. */
|
|
12967
|
+
type BrowserRunSession = {
|
|
12968
|
+
sessionId: string;
|
|
12969
|
+
startTime?: number;
|
|
12970
|
+
endTime?: number;
|
|
12971
|
+
closeReason?: number;
|
|
12972
|
+
closeReasonText?: string;
|
|
12973
|
+
connectionId?: string;
|
|
12974
|
+
connectionStartTime?: number;
|
|
12975
|
+
connectionEndTime?: number;
|
|
12976
|
+
lastUpdated?: number;
|
|
12977
|
+
webSocketDebuggerUrl?: string;
|
|
12978
|
+
devtoolsFrontendUrl?: string;
|
|
12979
|
+
};
|
|
12980
|
+
/** Account browser-session and browser-time limits. */
|
|
12981
|
+
type BrowserRunLimits = {
|
|
12982
|
+
activeSessions: Array<{
|
|
12983
|
+
id: string;
|
|
12984
|
+
}>;
|
|
12985
|
+
maxConcurrentSessions: number;
|
|
12986
|
+
allowedBrowserAcquisitions: number;
|
|
12987
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
12988
|
+
usedBrowserTimeSeconds?: number;
|
|
12989
|
+
};
|
|
12990
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
12991
|
+
type BrowserRunDevToolsTarget = {
|
|
12992
|
+
id: string;
|
|
12993
|
+
type: string;
|
|
12994
|
+
url: string;
|
|
12995
|
+
title?: string;
|
|
12996
|
+
description?: string;
|
|
12997
|
+
webSocketDebuggerUrl?: string;
|
|
12998
|
+
devtoolsFrontendUrl?: string;
|
|
12999
|
+
};
|
|
13000
|
+
/** Browser and protocol version metadata. */
|
|
13001
|
+
type BrowserRunDevToolsVersion = {
|
|
13002
|
+
Browser: string;
|
|
13003
|
+
"Protocol-Version": string;
|
|
13004
|
+
"User-Agent": string;
|
|
13005
|
+
"V8-Version": string;
|
|
13006
|
+
"WebKit-Version": string;
|
|
13007
|
+
webSocketDebuggerUrl: string;
|
|
13008
|
+
};
|
|
13009
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13010
|
+
interface BrowserRunDevToolsProtocolDomain extends Record<string, unknown> {
|
|
13011
|
+
domain: string;
|
|
13012
|
+
experimental?: boolean;
|
|
13013
|
+
dependencies?: string[];
|
|
13014
|
+
types?: Array<Record<string, any>>;
|
|
13015
|
+
commands?: Array<Record<string, any>>;
|
|
13016
|
+
events?: Array<Record<string, any>>;
|
|
13017
|
+
}
|
|
13018
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13019
|
+
interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13020
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13021
|
+
version?: {
|
|
13022
|
+
major: string;
|
|
13023
|
+
minor: string;
|
|
13024
|
+
};
|
|
13025
|
+
}
|
|
13026
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13027
|
+
type BrowserRunTargetOptions = {
|
|
13028
|
+
liveViewUrlExpiresInMs?: number;
|
|
13029
|
+
};
|
|
13030
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13031
|
+
type BrowserRunTargetActionResult = {
|
|
13032
|
+
message: string;
|
|
13033
|
+
};
|
|
13034
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13035
|
+
type BrowserRunDevtools = {
|
|
13036
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13037
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13038
|
+
listTargets(
|
|
13039
|
+
sessionId: string,
|
|
13040
|
+
options?: BrowserRunTargetOptions,
|
|
13041
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13042
|
+
getTarget(
|
|
13043
|
+
sessionId: string,
|
|
13044
|
+
targetId: string,
|
|
13045
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13046
|
+
newTarget(
|
|
13047
|
+
sessionId: string,
|
|
13048
|
+
url?: string,
|
|
13049
|
+
options?: BrowserRunTargetOptions,
|
|
13050
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13051
|
+
activateTarget(
|
|
13052
|
+
sessionId: string,
|
|
13053
|
+
targetId: string,
|
|
13054
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13055
|
+
closeTarget(
|
|
13056
|
+
sessionId: string,
|
|
13057
|
+
targetId: string,
|
|
13058
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13059
|
+
};
|
|
13060
|
+
/** Result returned when closing a browser session. */
|
|
13061
|
+
type BrowserRunCloseSessionResult = {
|
|
13062
|
+
status: "closing" | "closed";
|
|
13063
|
+
};
|
|
12892
13064
|
/**
|
|
12893
13065
|
* Browser Run API binding for automating headless browsers.
|
|
12894
13066
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13077,6 +13249,34 @@ declare abstract class BrowserRun {
|
|
|
13077
13249
|
action: "accessibilityTree",
|
|
13078
13250
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13079
13251
|
): Promise<Response>;
|
|
13252
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13253
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13254
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13255
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13256
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13257
|
+
connectSession(
|
|
13258
|
+
sessionId: string,
|
|
13259
|
+
options?: BrowserRunConnectOptions,
|
|
13260
|
+
): Promise<BrowserRunConnection>;
|
|
13261
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13262
|
+
getLiveView(
|
|
13263
|
+
sessionId: string,
|
|
13264
|
+
options?: BrowserRunLiveViewOptions,
|
|
13265
|
+
): Promise<BrowserRunLiveView>;
|
|
13266
|
+
/** List the caller's active browser sessions. */
|
|
13267
|
+
listSessions(
|
|
13268
|
+
options?: BrowserRunListSessionsOptions,
|
|
13269
|
+
): Promise<BrowserRunSession[]>;
|
|
13270
|
+
/** List recent active and closed browser sessions. */
|
|
13271
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13272
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13273
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13274
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13275
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13276
|
+
/** Close a browser session. */
|
|
13277
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13278
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13279
|
+
get devtools(): BrowserRunDevtools;
|
|
13080
13280
|
}
|
|
13081
13281
|
/**
|
|
13082
13282
|
* In addition to the properties you can set in the RequestInit dict
|
package/index.ts
CHANGED
|
@@ -12903,6 +12903,181 @@ export type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
12903
12903
|
/** Raw AI response text for debugging */
|
|
12904
12904
|
rawAiResponse?: string;
|
|
12905
12905
|
};
|
|
12906
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
12907
|
+
export type BrowserRunAcquireGuardrails = {
|
|
12908
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
12909
|
+
allowedDomains?: string[];
|
|
12910
|
+
/** Named domain sets that the browser may access. */
|
|
12911
|
+
allowedDomainSets?: string[];
|
|
12912
|
+
};
|
|
12913
|
+
/** Options for acquiring a new browser session. */
|
|
12914
|
+
export type BrowserRunAcquireOptions = {
|
|
12915
|
+
/** Idle session lifetime in milliseconds. */
|
|
12916
|
+
keepAlive?: number;
|
|
12917
|
+
/** Record the browser session. */
|
|
12918
|
+
recording?: boolean;
|
|
12919
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
12920
|
+
location?: string;
|
|
12921
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
12922
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
12923
|
+
/** Session-scoped network guardrails. */
|
|
12924
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
12925
|
+
/** Include the session's DevTools targets in the result. */
|
|
12926
|
+
targets?: boolean;
|
|
12927
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
12928
|
+
liveViewUrlExpiresInMs?: number;
|
|
12929
|
+
};
|
|
12930
|
+
/** Metadata returned when a browser session is acquired. */
|
|
12931
|
+
export type BrowserRunAcquireResult = {
|
|
12932
|
+
sessionId: string;
|
|
12933
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
12934
|
+
};
|
|
12935
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
12936
|
+
export type BrowserRunConnectOptions = {
|
|
12937
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
12938
|
+
targetId?: string;
|
|
12939
|
+
};
|
|
12940
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
12941
|
+
export type BrowserRunConnection = {
|
|
12942
|
+
sessionId: string;
|
|
12943
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
12944
|
+
webSocket: Fetcher;
|
|
12945
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
12946
|
+
};
|
|
12947
|
+
/** The UI mode for a live-view link. */
|
|
12948
|
+
export type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
12949
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
12950
|
+
export type BrowserRunConnectionGuardrails = {
|
|
12951
|
+
mode: "readonly";
|
|
12952
|
+
};
|
|
12953
|
+
/** Options for minting a live-view link. */
|
|
12954
|
+
export type BrowserRunLiveViewOptions = {
|
|
12955
|
+
mode?: BrowserRunLiveViewMode;
|
|
12956
|
+
targetId?: string;
|
|
12957
|
+
expiresInMs?: number;
|
|
12958
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
12959
|
+
};
|
|
12960
|
+
/** Live-view link metadata. */
|
|
12961
|
+
export type BrowserRunLiveView = {
|
|
12962
|
+
webSocketDebuggerUrl: string;
|
|
12963
|
+
devtoolsFrontendUrl: string;
|
|
12964
|
+
id: string;
|
|
12965
|
+
options: {
|
|
12966
|
+
mode: BrowserRunLiveViewMode;
|
|
12967
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
12968
|
+
};
|
|
12969
|
+
};
|
|
12970
|
+
/** Options for listing active browser sessions. */
|
|
12971
|
+
export type BrowserRunListSessionsOptions = {
|
|
12972
|
+
limit?: number;
|
|
12973
|
+
offset?: number;
|
|
12974
|
+
};
|
|
12975
|
+
/** Options for listing session history. */
|
|
12976
|
+
export type BrowserRunHistoryOptions = {
|
|
12977
|
+
limit?: number;
|
|
12978
|
+
offset?: number;
|
|
12979
|
+
};
|
|
12980
|
+
/** A browser session returned by the session-management methods. */
|
|
12981
|
+
export type BrowserRunSession = {
|
|
12982
|
+
sessionId: string;
|
|
12983
|
+
startTime?: number;
|
|
12984
|
+
endTime?: number;
|
|
12985
|
+
closeReason?: number;
|
|
12986
|
+
closeReasonText?: string;
|
|
12987
|
+
connectionId?: string;
|
|
12988
|
+
connectionStartTime?: number;
|
|
12989
|
+
connectionEndTime?: number;
|
|
12990
|
+
lastUpdated?: number;
|
|
12991
|
+
webSocketDebuggerUrl?: string;
|
|
12992
|
+
devtoolsFrontendUrl?: string;
|
|
12993
|
+
};
|
|
12994
|
+
/** Account browser-session and browser-time limits. */
|
|
12995
|
+
export type BrowserRunLimits = {
|
|
12996
|
+
activeSessions: Array<{
|
|
12997
|
+
id: string;
|
|
12998
|
+
}>;
|
|
12999
|
+
maxConcurrentSessions: number;
|
|
13000
|
+
allowedBrowserAcquisitions: number;
|
|
13001
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
13002
|
+
usedBrowserTimeSeconds?: number;
|
|
13003
|
+
};
|
|
13004
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
13005
|
+
export type BrowserRunDevToolsTarget = {
|
|
13006
|
+
id: string;
|
|
13007
|
+
type: string;
|
|
13008
|
+
url: string;
|
|
13009
|
+
title?: string;
|
|
13010
|
+
description?: string;
|
|
13011
|
+
webSocketDebuggerUrl?: string;
|
|
13012
|
+
devtoolsFrontendUrl?: string;
|
|
13013
|
+
};
|
|
13014
|
+
/** Browser and protocol version metadata. */
|
|
13015
|
+
export type BrowserRunDevToolsVersion = {
|
|
13016
|
+
Browser: string;
|
|
13017
|
+
"Protocol-Version": string;
|
|
13018
|
+
"User-Agent": string;
|
|
13019
|
+
"V8-Version": string;
|
|
13020
|
+
"WebKit-Version": string;
|
|
13021
|
+
webSocketDebuggerUrl: string;
|
|
13022
|
+
};
|
|
13023
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13024
|
+
export interface BrowserRunDevToolsProtocolDomain extends Record<
|
|
13025
|
+
string,
|
|
13026
|
+
unknown
|
|
13027
|
+
> {
|
|
13028
|
+
domain: string;
|
|
13029
|
+
experimental?: boolean;
|
|
13030
|
+
dependencies?: string[];
|
|
13031
|
+
types?: Array<Record<string, any>>;
|
|
13032
|
+
commands?: Array<Record<string, any>>;
|
|
13033
|
+
events?: Array<Record<string, any>>;
|
|
13034
|
+
}
|
|
13035
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13036
|
+
export interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13037
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13038
|
+
version?: {
|
|
13039
|
+
major: string;
|
|
13040
|
+
minor: string;
|
|
13041
|
+
};
|
|
13042
|
+
}
|
|
13043
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13044
|
+
export type BrowserRunTargetOptions = {
|
|
13045
|
+
liveViewUrlExpiresInMs?: number;
|
|
13046
|
+
};
|
|
13047
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13048
|
+
export type BrowserRunTargetActionResult = {
|
|
13049
|
+
message: string;
|
|
13050
|
+
};
|
|
13051
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13052
|
+
export type BrowserRunDevtools = {
|
|
13053
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13054
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13055
|
+
listTargets(
|
|
13056
|
+
sessionId: string,
|
|
13057
|
+
options?: BrowserRunTargetOptions,
|
|
13058
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13059
|
+
getTarget(
|
|
13060
|
+
sessionId: string,
|
|
13061
|
+
targetId: string,
|
|
13062
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13063
|
+
newTarget(
|
|
13064
|
+
sessionId: string,
|
|
13065
|
+
url?: string,
|
|
13066
|
+
options?: BrowserRunTargetOptions,
|
|
13067
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13068
|
+
activateTarget(
|
|
13069
|
+
sessionId: string,
|
|
13070
|
+
targetId: string,
|
|
13071
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13072
|
+
closeTarget(
|
|
13073
|
+
sessionId: string,
|
|
13074
|
+
targetId: string,
|
|
13075
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13076
|
+
};
|
|
13077
|
+
/** Result returned when closing a browser session. */
|
|
13078
|
+
export type BrowserRunCloseSessionResult = {
|
|
13079
|
+
status: "closing" | "closed";
|
|
13080
|
+
};
|
|
12906
13081
|
/**
|
|
12907
13082
|
* Browser Run API binding for automating headless browsers.
|
|
12908
13083
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13091,6 +13266,34 @@ export declare abstract class BrowserRun {
|
|
|
13091
13266
|
action: "accessibilityTree",
|
|
13092
13267
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13093
13268
|
): Promise<Response>;
|
|
13269
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13270
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13271
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13272
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13273
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13274
|
+
connectSession(
|
|
13275
|
+
sessionId: string,
|
|
13276
|
+
options?: BrowserRunConnectOptions,
|
|
13277
|
+
): Promise<BrowserRunConnection>;
|
|
13278
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13279
|
+
getLiveView(
|
|
13280
|
+
sessionId: string,
|
|
13281
|
+
options?: BrowserRunLiveViewOptions,
|
|
13282
|
+
): Promise<BrowserRunLiveView>;
|
|
13283
|
+
/** List the caller's active browser sessions. */
|
|
13284
|
+
listSessions(
|
|
13285
|
+
options?: BrowserRunListSessionsOptions,
|
|
13286
|
+
): Promise<BrowserRunSession[]>;
|
|
13287
|
+
/** List recent active and closed browser sessions. */
|
|
13288
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13289
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13290
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13291
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13292
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13293
|
+
/** Close a browser session. */
|
|
13294
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13295
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13296
|
+
get devtools(): BrowserRunDevtools;
|
|
13094
13297
|
}
|
|
13095
13298
|
/**
|
|
13096
13299
|
* In addition to the properties you can set in the RequestInit dict
|
package/package.json
CHANGED