@cloudflare/workers-types 5.20260916.1 → 5.20260918.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 +206 -0
- package/experimental/index.ts +209 -0
- package/index.d.ts +200 -0
- package/index.ts +203 -0
- package/package.json +1 -1
package/experimental/index.d.ts
CHANGED
|
@@ -382,6 +382,7 @@ interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
|
|
|
382
382
|
FixedLengthStream: typeof FixedLengthStream;
|
|
383
383
|
IdentityTransformStream: typeof IdentityTransformStream;
|
|
384
384
|
HTMLRewriter: typeof HTMLRewriter;
|
|
385
|
+
Datagram: typeof Datagram;
|
|
385
386
|
Performance: typeof Performance;
|
|
386
387
|
PerformanceEntry: typeof PerformanceEntry;
|
|
387
388
|
PerformanceMark: typeof PerformanceMark;
|
|
@@ -3967,6 +3968,7 @@ interface Socket {
|
|
|
3967
3968
|
get opened(): Promise<SocketInfo>;
|
|
3968
3969
|
get upgraded(): boolean;
|
|
3969
3970
|
get secureTransport(): "on" | "off" | "starttls";
|
|
3971
|
+
get protocol(): "tcp" | "udp";
|
|
3970
3972
|
close(): Promise<void>;
|
|
3971
3973
|
startTls(options?: TlsOptions): Socket;
|
|
3972
3974
|
}
|
|
@@ -3986,6 +3988,10 @@ interface SocketInfo {
|
|
|
3986
3988
|
remoteAddress?: string;
|
|
3987
3989
|
localAddress?: string;
|
|
3988
3990
|
}
|
|
3991
|
+
declare class Datagram {
|
|
3992
|
+
constructor(data: Uint8Array);
|
|
3993
|
+
get data(): Uint8Array;
|
|
3994
|
+
}
|
|
3989
3995
|
/**
|
|
3990
3996
|
* The **`EventSource`** interface is web content's interface to server-sent events.
|
|
3991
3997
|
*
|
|
@@ -13166,6 +13172,178 @@ type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
13166
13172
|
/** Raw AI response text for debugging */
|
|
13167
13173
|
rawAiResponse?: string;
|
|
13168
13174
|
};
|
|
13175
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
13176
|
+
type BrowserRunAcquireGuardrails = {
|
|
13177
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
13178
|
+
allowedDomains?: string[];
|
|
13179
|
+
/** Named domain sets that the browser may access. */
|
|
13180
|
+
allowedDomainSets?: string[];
|
|
13181
|
+
};
|
|
13182
|
+
/** Options for acquiring a new browser session. */
|
|
13183
|
+
type BrowserRunAcquireOptions = {
|
|
13184
|
+
/** Idle session lifetime in milliseconds. */
|
|
13185
|
+
keepAlive?: number;
|
|
13186
|
+
/** Record the browser session. */
|
|
13187
|
+
recording?: boolean;
|
|
13188
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
13189
|
+
location?: string;
|
|
13190
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
13191
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
13192
|
+
/** Session-scoped network guardrails. */
|
|
13193
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
13194
|
+
/** Include the session's DevTools targets in the result. */
|
|
13195
|
+
targets?: boolean;
|
|
13196
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
13197
|
+
liveViewUrlExpiresInMs?: number;
|
|
13198
|
+
};
|
|
13199
|
+
/** Metadata returned when a browser session is acquired. */
|
|
13200
|
+
type BrowserRunAcquireResult = {
|
|
13201
|
+
sessionId: string;
|
|
13202
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13203
|
+
};
|
|
13204
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
13205
|
+
type BrowserRunConnectOptions = {
|
|
13206
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
13207
|
+
targetId?: string;
|
|
13208
|
+
};
|
|
13209
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
13210
|
+
type BrowserRunConnection = {
|
|
13211
|
+
sessionId: string;
|
|
13212
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
13213
|
+
webSocket: Fetcher;
|
|
13214
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13215
|
+
};
|
|
13216
|
+
/** The UI mode for a live-view link. */
|
|
13217
|
+
type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
13218
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
13219
|
+
type BrowserRunConnectionGuardrails = {
|
|
13220
|
+
mode: "readonly";
|
|
13221
|
+
};
|
|
13222
|
+
/** Options for minting a live-view link. */
|
|
13223
|
+
type BrowserRunLiveViewOptions = {
|
|
13224
|
+
mode?: BrowserRunLiveViewMode;
|
|
13225
|
+
targetId?: string;
|
|
13226
|
+
expiresInMs?: number;
|
|
13227
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13228
|
+
};
|
|
13229
|
+
/** Live-view link metadata. */
|
|
13230
|
+
type BrowserRunLiveView = {
|
|
13231
|
+
webSocketDebuggerUrl: string;
|
|
13232
|
+
devtoolsFrontendUrl: string;
|
|
13233
|
+
id: string;
|
|
13234
|
+
options: {
|
|
13235
|
+
mode: BrowserRunLiveViewMode;
|
|
13236
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13237
|
+
};
|
|
13238
|
+
};
|
|
13239
|
+
/** Options for listing active browser sessions. */
|
|
13240
|
+
type BrowserRunListSessionsOptions = {
|
|
13241
|
+
limit?: number;
|
|
13242
|
+
offset?: number;
|
|
13243
|
+
};
|
|
13244
|
+
/** Options for listing session history. */
|
|
13245
|
+
type BrowserRunHistoryOptions = {
|
|
13246
|
+
limit?: number;
|
|
13247
|
+
offset?: number;
|
|
13248
|
+
};
|
|
13249
|
+
/** A browser session returned by the session-management methods. */
|
|
13250
|
+
type BrowserRunSession = {
|
|
13251
|
+
sessionId: string;
|
|
13252
|
+
startTime?: number;
|
|
13253
|
+
endTime?: number;
|
|
13254
|
+
closeReason?: number;
|
|
13255
|
+
closeReasonText?: string;
|
|
13256
|
+
connectionId?: string;
|
|
13257
|
+
connectionStartTime?: number;
|
|
13258
|
+
connectionEndTime?: number;
|
|
13259
|
+
lastUpdated?: number;
|
|
13260
|
+
webSocketDebuggerUrl?: string;
|
|
13261
|
+
devtoolsFrontendUrl?: string;
|
|
13262
|
+
};
|
|
13263
|
+
/** Account browser-session and browser-time limits. */
|
|
13264
|
+
type BrowserRunLimits = {
|
|
13265
|
+
activeSessions: Array<{
|
|
13266
|
+
id: string;
|
|
13267
|
+
}>;
|
|
13268
|
+
maxConcurrentSessions: number;
|
|
13269
|
+
allowedBrowserAcquisitions: number;
|
|
13270
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
13271
|
+
usedBrowserTimeSeconds?: number;
|
|
13272
|
+
};
|
|
13273
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
13274
|
+
type BrowserRunDevToolsTarget = {
|
|
13275
|
+
id: string;
|
|
13276
|
+
type: string;
|
|
13277
|
+
url: string;
|
|
13278
|
+
title?: string;
|
|
13279
|
+
description?: string;
|
|
13280
|
+
webSocketDebuggerUrl?: string;
|
|
13281
|
+
devtoolsFrontendUrl?: string;
|
|
13282
|
+
};
|
|
13283
|
+
/** Browser and protocol version metadata. */
|
|
13284
|
+
type BrowserRunDevToolsVersion = {
|
|
13285
|
+
Browser: string;
|
|
13286
|
+
"Protocol-Version": string;
|
|
13287
|
+
"User-Agent": string;
|
|
13288
|
+
"V8-Version": string;
|
|
13289
|
+
"WebKit-Version": string;
|
|
13290
|
+
webSocketDebuggerUrl: string;
|
|
13291
|
+
};
|
|
13292
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13293
|
+
interface BrowserRunDevToolsProtocolDomain extends Record<string, unknown> {
|
|
13294
|
+
domain: string;
|
|
13295
|
+
experimental?: boolean;
|
|
13296
|
+
dependencies?: string[];
|
|
13297
|
+
types?: Array<Record<string, any>>;
|
|
13298
|
+
commands?: Array<Record<string, any>>;
|
|
13299
|
+
events?: Array<Record<string, any>>;
|
|
13300
|
+
}
|
|
13301
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13302
|
+
interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13303
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13304
|
+
version?: {
|
|
13305
|
+
major: string;
|
|
13306
|
+
minor: string;
|
|
13307
|
+
};
|
|
13308
|
+
}
|
|
13309
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13310
|
+
type BrowserRunTargetOptions = {
|
|
13311
|
+
liveViewUrlExpiresInMs?: number;
|
|
13312
|
+
};
|
|
13313
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13314
|
+
type BrowserRunTargetActionResult = {
|
|
13315
|
+
message: string;
|
|
13316
|
+
};
|
|
13317
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13318
|
+
type BrowserRunDevtools = {
|
|
13319
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13320
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13321
|
+
listTargets(
|
|
13322
|
+
sessionId: string,
|
|
13323
|
+
options?: BrowserRunTargetOptions,
|
|
13324
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13325
|
+
getTarget(
|
|
13326
|
+
sessionId: string,
|
|
13327
|
+
targetId: string,
|
|
13328
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13329
|
+
newTarget(
|
|
13330
|
+
sessionId: string,
|
|
13331
|
+
url?: string,
|
|
13332
|
+
options?: BrowserRunTargetOptions,
|
|
13333
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13334
|
+
activateTarget(
|
|
13335
|
+
sessionId: string,
|
|
13336
|
+
targetId: string,
|
|
13337
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13338
|
+
closeTarget(
|
|
13339
|
+
sessionId: string,
|
|
13340
|
+
targetId: string,
|
|
13341
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13342
|
+
};
|
|
13343
|
+
/** Result returned when closing a browser session. */
|
|
13344
|
+
type BrowserRunCloseSessionResult = {
|
|
13345
|
+
status: "closing" | "closed";
|
|
13346
|
+
};
|
|
13169
13347
|
/**
|
|
13170
13348
|
* Browser Run API binding for automating headless browsers.
|
|
13171
13349
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13354,6 +13532,34 @@ declare abstract class BrowserRun {
|
|
|
13354
13532
|
action: "accessibilityTree",
|
|
13355
13533
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13356
13534
|
): Promise<Response>;
|
|
13535
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13536
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13537
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13538
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13539
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13540
|
+
connectSession(
|
|
13541
|
+
sessionId: string,
|
|
13542
|
+
options?: BrowserRunConnectOptions,
|
|
13543
|
+
): Promise<BrowserRunConnection>;
|
|
13544
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13545
|
+
getLiveView(
|
|
13546
|
+
sessionId: string,
|
|
13547
|
+
options?: BrowserRunLiveViewOptions,
|
|
13548
|
+
): Promise<BrowserRunLiveView>;
|
|
13549
|
+
/** List the caller's active browser sessions. */
|
|
13550
|
+
listSessions(
|
|
13551
|
+
options?: BrowserRunListSessionsOptions,
|
|
13552
|
+
): Promise<BrowserRunSession[]>;
|
|
13553
|
+
/** List recent active and closed browser sessions. */
|
|
13554
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13555
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13556
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13557
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13558
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13559
|
+
/** Close a browser session. */
|
|
13560
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13561
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13562
|
+
get devtools(): BrowserRunDevtools;
|
|
13357
13563
|
}
|
|
13358
13564
|
/**
|
|
13359
13565
|
* In addition to the properties you can set in the RequestInit dict
|
package/experimental/index.ts
CHANGED
|
@@ -382,6 +382,7 @@ export interface ServiceWorkerGlobalScope extends WorkerGlobalScope {
|
|
|
382
382
|
FixedLengthStream: typeof FixedLengthStream;
|
|
383
383
|
IdentityTransformStream: typeof IdentityTransformStream;
|
|
384
384
|
HTMLRewriter: typeof HTMLRewriter;
|
|
385
|
+
Datagram: typeof Datagram;
|
|
385
386
|
Performance: typeof Performance;
|
|
386
387
|
PerformanceEntry: typeof PerformanceEntry;
|
|
387
388
|
PerformanceMark: typeof PerformanceMark;
|
|
@@ -3976,6 +3977,7 @@ export interface Socket {
|
|
|
3976
3977
|
get opened(): Promise<SocketInfo>;
|
|
3977
3978
|
get upgraded(): boolean;
|
|
3978
3979
|
get secureTransport(): "on" | "off" | "starttls";
|
|
3980
|
+
get protocol(): "tcp" | "udp";
|
|
3979
3981
|
close(): Promise<void>;
|
|
3980
3982
|
startTls(options?: TlsOptions): Socket;
|
|
3981
3983
|
}
|
|
@@ -3995,6 +3997,10 @@ export interface SocketInfo {
|
|
|
3995
3997
|
remoteAddress?: string;
|
|
3996
3998
|
localAddress?: string;
|
|
3997
3999
|
}
|
|
4000
|
+
export declare class Datagram {
|
|
4001
|
+
constructor(data: Uint8Array);
|
|
4002
|
+
get data(): Uint8Array;
|
|
4003
|
+
}
|
|
3998
4004
|
/**
|
|
3999
4005
|
* The **`EventSource`** interface is web content's interface to server-sent events.
|
|
4000
4006
|
*
|
|
@@ -13180,6 +13186,181 @@ export type BrowserRunJsonErrorResponse = BrowserRunErrorResponse & {
|
|
|
13180
13186
|
/** Raw AI response text for debugging */
|
|
13181
13187
|
rawAiResponse?: string;
|
|
13182
13188
|
};
|
|
13189
|
+
/** Session-scoped guardrails applied when acquiring a browser session. */
|
|
13190
|
+
export type BrowserRunAcquireGuardrails = {
|
|
13191
|
+
/** Domains that the browser may access. An empty list denies all domains. */
|
|
13192
|
+
allowedDomains?: string[];
|
|
13193
|
+
/** Named domain sets that the browser may access. */
|
|
13194
|
+
allowedDomainSets?: string[];
|
|
13195
|
+
};
|
|
13196
|
+
/** Options for acquiring a new browser session. */
|
|
13197
|
+
export type BrowserRunAcquireOptions = {
|
|
13198
|
+
/** Idle session lifetime in milliseconds. */
|
|
13199
|
+
keepAlive?: number;
|
|
13200
|
+
/** Record the browser session. */
|
|
13201
|
+
recording?: boolean;
|
|
13202
|
+
/** Geoegress hint as an ISO-3166 alpha-2 country code. */
|
|
13203
|
+
location?: string;
|
|
13204
|
+
/** Map hostnames to caller-provided Workers that handle outbound requests. */
|
|
13205
|
+
outboundByHost?: Record<string, Fetcher>;
|
|
13206
|
+
/** Session-scoped network guardrails. */
|
|
13207
|
+
guardrails?: BrowserRunAcquireGuardrails;
|
|
13208
|
+
/** Include the session's DevTools targets in the result. */
|
|
13209
|
+
targets?: boolean;
|
|
13210
|
+
/** Lifetime of target live-view URLs in milliseconds. */
|
|
13211
|
+
liveViewUrlExpiresInMs?: number;
|
|
13212
|
+
};
|
|
13213
|
+
/** Metadata returned when a browser session is acquired. */
|
|
13214
|
+
export type BrowserRunAcquireResult = {
|
|
13215
|
+
sessionId: string;
|
|
13216
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13217
|
+
};
|
|
13218
|
+
/** Options for connecting to an already-acquired browser session. */
|
|
13219
|
+
export type BrowserRunConnectOptions = {
|
|
13220
|
+
/** Connect to a specific page target instead of the browser-level CDP endpoint. */
|
|
13221
|
+
targetId?: string;
|
|
13222
|
+
};
|
|
13223
|
+
/** Connection capability returned by `connectSession()` and `launch()`. */
|
|
13224
|
+
export type BrowserRunConnection = {
|
|
13225
|
+
sessionId: string;
|
|
13226
|
+
/** A session-pinned Fetcher. Use its `fetch()` method for a WebSocket upgrade. */
|
|
13227
|
+
webSocket: Fetcher;
|
|
13228
|
+
targets?: BrowserRunDevToolsTarget[];
|
|
13229
|
+
};
|
|
13230
|
+
/** The UI mode for a live-view link. */
|
|
13231
|
+
export type BrowserRunLiveViewMode = "devtools" | "tab" | "full";
|
|
13232
|
+
/** Connection-scoped guardrails applied to a live-view link. */
|
|
13233
|
+
export type BrowserRunConnectionGuardrails = {
|
|
13234
|
+
mode: "readonly";
|
|
13235
|
+
};
|
|
13236
|
+
/** Options for minting a live-view link. */
|
|
13237
|
+
export type BrowserRunLiveViewOptions = {
|
|
13238
|
+
mode?: BrowserRunLiveViewMode;
|
|
13239
|
+
targetId?: string;
|
|
13240
|
+
expiresInMs?: number;
|
|
13241
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13242
|
+
};
|
|
13243
|
+
/** Live-view link metadata. */
|
|
13244
|
+
export type BrowserRunLiveView = {
|
|
13245
|
+
webSocketDebuggerUrl: string;
|
|
13246
|
+
devtoolsFrontendUrl: string;
|
|
13247
|
+
id: string;
|
|
13248
|
+
options: {
|
|
13249
|
+
mode: BrowserRunLiveViewMode;
|
|
13250
|
+
guardrails?: BrowserRunConnectionGuardrails;
|
|
13251
|
+
};
|
|
13252
|
+
};
|
|
13253
|
+
/** Options for listing active browser sessions. */
|
|
13254
|
+
export type BrowserRunListSessionsOptions = {
|
|
13255
|
+
limit?: number;
|
|
13256
|
+
offset?: number;
|
|
13257
|
+
};
|
|
13258
|
+
/** Options for listing session history. */
|
|
13259
|
+
export type BrowserRunHistoryOptions = {
|
|
13260
|
+
limit?: number;
|
|
13261
|
+
offset?: number;
|
|
13262
|
+
};
|
|
13263
|
+
/** A browser session returned by the session-management methods. */
|
|
13264
|
+
export type BrowserRunSession = {
|
|
13265
|
+
sessionId: string;
|
|
13266
|
+
startTime?: number;
|
|
13267
|
+
endTime?: number;
|
|
13268
|
+
closeReason?: number;
|
|
13269
|
+
closeReasonText?: string;
|
|
13270
|
+
connectionId?: string;
|
|
13271
|
+
connectionStartTime?: number;
|
|
13272
|
+
connectionEndTime?: number;
|
|
13273
|
+
lastUpdated?: number;
|
|
13274
|
+
webSocketDebuggerUrl?: string;
|
|
13275
|
+
devtoolsFrontendUrl?: string;
|
|
13276
|
+
};
|
|
13277
|
+
/** Account browser-session and browser-time limits. */
|
|
13278
|
+
export type BrowserRunLimits = {
|
|
13279
|
+
activeSessions: Array<{
|
|
13280
|
+
id: string;
|
|
13281
|
+
}>;
|
|
13282
|
+
maxConcurrentSessions: number;
|
|
13283
|
+
allowedBrowserAcquisitions: number;
|
|
13284
|
+
timeUntilNextAllowedBrowserAcquisition: number;
|
|
13285
|
+
usedBrowserTimeSeconds?: number;
|
|
13286
|
+
};
|
|
13287
|
+
/** A browser target returned by the DevTools JSON methods. */
|
|
13288
|
+
export type BrowserRunDevToolsTarget = {
|
|
13289
|
+
id: string;
|
|
13290
|
+
type: string;
|
|
13291
|
+
url: string;
|
|
13292
|
+
title?: string;
|
|
13293
|
+
description?: string;
|
|
13294
|
+
webSocketDebuggerUrl?: string;
|
|
13295
|
+
devtoolsFrontendUrl?: string;
|
|
13296
|
+
};
|
|
13297
|
+
/** Browser and protocol version metadata. */
|
|
13298
|
+
export type BrowserRunDevToolsVersion = {
|
|
13299
|
+
Browser: string;
|
|
13300
|
+
"Protocol-Version": string;
|
|
13301
|
+
"User-Agent": string;
|
|
13302
|
+
"V8-Version": string;
|
|
13303
|
+
"WebKit-Version": string;
|
|
13304
|
+
webSocketDebuggerUrl: string;
|
|
13305
|
+
};
|
|
13306
|
+
/** A DevTools protocol domain. Protocol definitions may gain additional fields over time. */
|
|
13307
|
+
export interface BrowserRunDevToolsProtocolDomain extends Record<
|
|
13308
|
+
string,
|
|
13309
|
+
unknown
|
|
13310
|
+
> {
|
|
13311
|
+
domain: string;
|
|
13312
|
+
experimental?: boolean;
|
|
13313
|
+
dependencies?: string[];
|
|
13314
|
+
types?: Array<Record<string, any>>;
|
|
13315
|
+
commands?: Array<Record<string, any>>;
|
|
13316
|
+
events?: Array<Record<string, any>>;
|
|
13317
|
+
}
|
|
13318
|
+
/** The DevTools protocol definition. Additional protocol fields may be returned by Chrome. */
|
|
13319
|
+
export interface BrowserRunDevToolsProtocol extends Record<string, any> {
|
|
13320
|
+
domains: BrowserRunDevToolsProtocolDomain[];
|
|
13321
|
+
version?: {
|
|
13322
|
+
major: string;
|
|
13323
|
+
minor: string;
|
|
13324
|
+
};
|
|
13325
|
+
}
|
|
13326
|
+
/** Options shared by DevTools target-listing and target-creation methods. */
|
|
13327
|
+
export type BrowserRunTargetOptions = {
|
|
13328
|
+
liveViewUrlExpiresInMs?: number;
|
|
13329
|
+
};
|
|
13330
|
+
/** Result returned by DevTools target activation and close methods. */
|
|
13331
|
+
export type BrowserRunTargetActionResult = {
|
|
13332
|
+
message: string;
|
|
13333
|
+
};
|
|
13334
|
+
/** Methods exposed by the nested `devtools` binding target. */
|
|
13335
|
+
export type BrowserRunDevtools = {
|
|
13336
|
+
getVersion(sessionId: string): Promise<BrowserRunDevToolsVersion>;
|
|
13337
|
+
getProtocol(sessionId: string): Promise<BrowserRunDevToolsProtocol>;
|
|
13338
|
+
listTargets(
|
|
13339
|
+
sessionId: string,
|
|
13340
|
+
options?: BrowserRunTargetOptions,
|
|
13341
|
+
): Promise<BrowserRunDevToolsTarget[]>;
|
|
13342
|
+
getTarget(
|
|
13343
|
+
sessionId: string,
|
|
13344
|
+
targetId: string,
|
|
13345
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13346
|
+
newTarget(
|
|
13347
|
+
sessionId: string,
|
|
13348
|
+
url?: string,
|
|
13349
|
+
options?: BrowserRunTargetOptions,
|
|
13350
|
+
): Promise<BrowserRunDevToolsTarget>;
|
|
13351
|
+
activateTarget(
|
|
13352
|
+
sessionId: string,
|
|
13353
|
+
targetId: string,
|
|
13354
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13355
|
+
closeTarget(
|
|
13356
|
+
sessionId: string,
|
|
13357
|
+
targetId: string,
|
|
13358
|
+
): Promise<BrowserRunTargetActionResult>;
|
|
13359
|
+
};
|
|
13360
|
+
/** Result returned when closing a browser session. */
|
|
13361
|
+
export type BrowserRunCloseSessionResult = {
|
|
13362
|
+
status: "closing" | "closed";
|
|
13363
|
+
};
|
|
13183
13364
|
/**
|
|
13184
13365
|
* Browser Run API binding for automating headless browsers.
|
|
13185
13366
|
* @see https://developers.cloudflare.com/browser-run/
|
|
@@ -13368,6 +13549,34 @@ export declare abstract class BrowserRun {
|
|
|
13368
13549
|
action: "accessibilityTree",
|
|
13369
13550
|
options: BrowserRunAccessibilityTreeOptions,
|
|
13370
13551
|
): Promise<Response>;
|
|
13552
|
+
/** Acquire a new browser session and return its metadata. */
|
|
13553
|
+
acquire(options?: BrowserRunAcquireOptions): Promise<BrowserRunAcquireResult>;
|
|
13554
|
+
/** Acquire a browser session and return a session-pinned WebSocket capability. */
|
|
13555
|
+
launch(options?: BrowserRunAcquireOptions): Promise<BrowserRunConnection>;
|
|
13556
|
+
/** Return a session-pinned WebSocket capability for an existing session. */
|
|
13557
|
+
connectSession(
|
|
13558
|
+
sessionId: string,
|
|
13559
|
+
options?: BrowserRunConnectOptions,
|
|
13560
|
+
): Promise<BrowserRunConnection>;
|
|
13561
|
+
/** Mint an authenticated live-view link for a browser session. */
|
|
13562
|
+
getLiveView(
|
|
13563
|
+
sessionId: string,
|
|
13564
|
+
options?: BrowserRunLiveViewOptions,
|
|
13565
|
+
): Promise<BrowserRunLiveView>;
|
|
13566
|
+
/** List the caller's active browser sessions. */
|
|
13567
|
+
listSessions(
|
|
13568
|
+
options?: BrowserRunListSessionsOptions,
|
|
13569
|
+
): Promise<BrowserRunSession[]>;
|
|
13570
|
+
/** List recent active and closed browser sessions. */
|
|
13571
|
+
history(options?: BrowserRunHistoryOptions): Promise<BrowserRunSession[]>;
|
|
13572
|
+
/** Return the caller's browser-session and browser-time limits. */
|
|
13573
|
+
limits(): Promise<BrowserRunLimits>;
|
|
13574
|
+
/** Return details for one browser session, or `null` when it does not exist. */
|
|
13575
|
+
getSession(sessionId: string): Promise<BrowserRunSession | null>;
|
|
13576
|
+
/** Close a browser session. */
|
|
13577
|
+
closeSession(sessionId: string): Promise<BrowserRunCloseSessionResult>;
|
|
13578
|
+
/** DevTools JSON methods exposed through one nested binding target. */
|
|
13579
|
+
get devtools(): BrowserRunDevtools;
|
|
13371
13580
|
}
|
|
13372
13581
|
/**
|
|
13373
13582
|
* 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