diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 87d3d84..2afb750 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.56.0" + ".": "0.57.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index e0a033e..6f5d31f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 112 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-982efd191c23737c9e1cdbcbf9237fa2231b9f74e0a25db2870293bdf9951c21.yml -openapi_spec_hash: eeb27952a4cc939316c24fc0ce2c9e3a -config_hash: 08d55086449943a8fec212b870061a3f +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-5d96fec7a84722f300bd99db7352d6284141826f3412f6d370ac0926edf03d42.yml +openapi_spec_hash: d4e1a29ac06f9543e0ef69372eb3ff35 +config_hash: ae3dea7997fb5d36fa41979f9585ed78 diff --git a/CHANGELOG.md b/CHANGELOG.md index 849f750..1574fc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Changelog +## 0.57.0 (2026-05-22) + +Full Changelog: [v0.56.0...v0.57.0](https://github.com/kernel/kernel-go-sdk/compare/v0.56.0...v0.57.0) + +### Features + +* [kernel-1116] browser events api integration ([e0a367b](https://github.com/kernel/kernel-go-sdk/commit/e0a367b4fd596424dc913c9e999831ae1fdc068e)) +* **api:** type can_reauth_reason as an enum on ManagedAuth ([61f5842](https://github.com/kernel/kernel-go-sdk/commit/61f5842a55a7e846c6cf04f6d2c2dd7df5b40862)) +* browsers: accept chrome_policy on POST /browsers (KERNEL-1216) ([6f29adc](https://github.com/kernel/kernel-go-sdk/commit/6f29adc513752623a3ea761195005f5a50d46e5b)) +* EOL persistent browsers: openapi limits ([b79f2fd](https://github.com/kernel/kernel-go-sdk/commit/b79f2fd415108f84cf99377bd3b4c60e64af1ba3)) + ## 0.56.0 (2026-05-18) Full Changelog: [v0.55.0...v0.56.0](https://github.com/kernel/kernel-go-sdk/compare/v0.55.0...v0.56.0) diff --git a/README.md b/README.md index 140e875..c26afe8 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Or to pin the version: ```sh -go get -u 'github.com/kernel/kernel-go-sdk@v0.56.0' +go get -u 'github.com/kernel/kernel-go-sdk@v0.57.0' ``` diff --git a/api.md b/api.md index 4f475a5..1bafa99 100644 --- a/api.md +++ b/api.md @@ -68,13 +68,8 @@ Methods: # Browsers -Params Types: - -- kernel.BrowserPersistenceParam - Response Types: -- kernel.BrowserPersistence - kernel.BrowserPoolRef - kernel.BrowserUsage - kernel.Profile @@ -90,11 +85,56 @@ Methods: - client.Browsers.Get(ctx context.Context, id string, query kernel.BrowserGetParams) (\*kernel.BrowserGetResponse, error) - client.Browsers.Update(ctx context.Context, id string, body kernel.BrowserUpdateParams) (\*kernel.BrowserUpdateResponse, error) - client.Browsers.List(ctx context.Context, query kernel.BrowserListParams) (\*pagination.OffsetPagination[kernel.BrowserListResponse], error) -- client.Browsers.Delete(ctx context.Context, body kernel.BrowserDeleteParams) error - client.Browsers.Curl(ctx context.Context, id string, body kernel.BrowserCurlParams) (\*kernel.BrowserCurlResponse, error) - client.Browsers.DeleteByID(ctx context.Context, id string) error - client.Browsers.LoadExtensions(ctx context.Context, id string, body kernel.BrowserLoadExtensionsParams) error +## Telemetry + +Params Types: + +- kernel.BrowserTelemetryCategoriesConfigParam +- kernel.BrowserTelemetryCategoryConfigParam +- kernel.BrowserTelemetryConfigParam + +Response Types: + +- kernel.BrowserCallStack +- kernel.BrowserConsoleErrorEvent +- kernel.BrowserConsoleLogEvent +- kernel.BrowserEventContext +- kernel.BrowserEventSource +- kernel.BrowserHTTPHeaders +- kernel.BrowserInteractionClickEvent +- kernel.BrowserInteractionKeyEvent +- kernel.BrowserInteractionScrollSettledEvent +- kernel.BrowserMonitorDisconnectedEvent +- kernel.BrowserMonitorInitFailedEvent +- kernel.BrowserMonitorReconnectFailedEvent +- kernel.BrowserMonitorReconnectedEvent +- kernel.BrowserMonitorScreenshotEvent +- kernel.BrowserNetworkIdleEvent +- kernel.BrowserNetworkLoadingFailedEvent +- kernel.BrowserNetworkRequestEvent +- kernel.BrowserNetworkResponseEvent +- kernel.BrowserPageDomContentLoadedEvent +- kernel.BrowserPageLayoutSettledEvent +- kernel.BrowserPageLayoutShiftEvent +- kernel.BrowserPageLcpEvent +- kernel.BrowserPageLoadEvent +- kernel.BrowserPageNavigationEvent +- kernel.BrowserPageNavigationSettledEvent +- kernel.BrowserPageTabOpenedEvent +- kernel.BrowserTelemetryCategoriesConfig +- kernel.BrowserTelemetryCategoryConfig +- kernel.BrowserTelemetryConfig +- kernel.BrowserTelemetryEventUnion +- kernel.BrowserTelemetryStreamResponse + +Methods: + +- client.Browsers.Telemetry.Stream(ctx context.Context, id string, query kernel.BrowserTelemetryStreamParams) (\*kernel.BrowserTelemetryStreamResponse, error) + ## Replays Response Types: diff --git a/authconnection.go b/authconnection.go index 43c5260..11f8b81 100644 --- a/authconnection.go +++ b/authconnection.go @@ -261,11 +261,47 @@ type ManagedAuth struct { // in progress). Use this to inspect or terminate the browser session via the // `/browsers` API. BrowserSessionID string `json:"browser_session_id" api:"nullable"` - // Whether automatic re-authentication is possible (has credential, selectors, and - // login_url) + // Whether Kernel can automatically re-authenticate this connection when the + // session expires. Requires a prior successful login plus either a Kernel + // credential or an external credential reference. See `can_reauth_reason` for the + // specific outcome. CanReauth bool `json:"can_reauth"` - // Reason why automatic re-authentication is or is not possible - CanReauthReason string `json:"can_reauth_reason"` + // Machine-readable reason for the current value of `can_reauth`. Affirmative + // values (re-auth is possible): + // + // - `external_credential` — an external credential provider is attached + // - `cua_has_credential` — CUA flow with a stored credential + // - `has_credential` — Kernel credential is attached (optimistic; plan viability + // not checked) + // - `viable_plans_found` — at least one stored login plan can be replayed + // - `no_requirements_recorded` — no recorded credential requirements to fail + // against + // - `requirements_satisfiable` — recorded requirements can be met by the attached + // credential + // + // Negative values (a human must complete the login flow): + // + // - `no_prior_successful_login` — connection has never completed a successful + // login + // - `no_credential` — no Kernel or external credential attached + // - `no_viable_plans` — credential attached but no replayable login plan exists + // yet + // - `viable_plans_require_external_action` — stored plans need an external step + // (email link, push, etc.) + // - `requires_external_action` — recorded requirements include an external step + // - `requires_totp_without_secret` — flow needs a TOTP code but no TOTP secret is + // stored + // - `requires_sms_code` — flow needs an SMS code that cannot be received + // automatically + // - `requires_email_code` — flow needs an email code that cannot be received + // automatically + // + // Any of "external_credential", "cua_has_credential", "has_credential", + // "viable_plans_found", "no_requirements_recorded", "requirements_satisfiable", + // "no_prior_successful_login", "no_credential", "no_viable_plans", + // "viable_plans_require_external_action", "requires_external_action", + // "requires_totp_without_secret", "requires_sms_code", "requires_email_code". + CanReauthReason ManagedAuthCanReauthReason `json:"can_reauth_reason"` // Reference to credentials for the auth connection. Use one of: // // - { name } for Kernel credentials @@ -404,6 +440,54 @@ const ( ManagedAuthStatusNeedsAuth ManagedAuthStatus = "NEEDS_AUTH" ) +// Machine-readable reason for the current value of `can_reauth`. Affirmative +// values (re-auth is possible): +// +// - `external_credential` — an external credential provider is attached +// - `cua_has_credential` — CUA flow with a stored credential +// - `has_credential` — Kernel credential is attached (optimistic; plan viability +// not checked) +// - `viable_plans_found` — at least one stored login plan can be replayed +// - `no_requirements_recorded` — no recorded credential requirements to fail +// against +// - `requirements_satisfiable` — recorded requirements can be met by the attached +// credential +// +// Negative values (a human must complete the login flow): +// +// - `no_prior_successful_login` — connection has never completed a successful +// login +// - `no_credential` — no Kernel or external credential attached +// - `no_viable_plans` — credential attached but no replayable login plan exists +// yet +// - `viable_plans_require_external_action` — stored plans need an external step +// (email link, push, etc.) +// - `requires_external_action` — recorded requirements include an external step +// - `requires_totp_without_secret` — flow needs a TOTP code but no TOTP secret is +// stored +// - `requires_sms_code` — flow needs an SMS code that cannot be received +// automatically +// - `requires_email_code` — flow needs an email code that cannot be received +// automatically +type ManagedAuthCanReauthReason string + +const ( + ManagedAuthCanReauthReasonExternalCredential ManagedAuthCanReauthReason = "external_credential" + ManagedAuthCanReauthReasonCuaHasCredential ManagedAuthCanReauthReason = "cua_has_credential" + ManagedAuthCanReauthReasonHasCredential ManagedAuthCanReauthReason = "has_credential" + ManagedAuthCanReauthReasonViablePlansFound ManagedAuthCanReauthReason = "viable_plans_found" + ManagedAuthCanReauthReasonNoRequirementsRecorded ManagedAuthCanReauthReason = "no_requirements_recorded" + ManagedAuthCanReauthReasonRequirementsSatisfiable ManagedAuthCanReauthReason = "requirements_satisfiable" + ManagedAuthCanReauthReasonNoPriorSuccessfulLogin ManagedAuthCanReauthReason = "no_prior_successful_login" + ManagedAuthCanReauthReasonNoCredential ManagedAuthCanReauthReason = "no_credential" + ManagedAuthCanReauthReasonNoViablePlans ManagedAuthCanReauthReason = "no_viable_plans" + ManagedAuthCanReauthReasonViablePlansRequireExternalAction ManagedAuthCanReauthReason = "viable_plans_require_external_action" + ManagedAuthCanReauthReasonRequiresExternalAction ManagedAuthCanReauthReason = "requires_external_action" + ManagedAuthCanReauthReasonRequiresTotpWithoutSecret ManagedAuthCanReauthReason = "requires_totp_without_secret" + ManagedAuthCanReauthReasonRequiresSMSCode ManagedAuthCanReauthReason = "requires_sms_code" + ManagedAuthCanReauthReasonRequiresEmailCode ManagedAuthCanReauthReason = "requires_email_code" +) + // Reference to credentials for the auth connection. Use one of: // // - { name } for Kernel credentials diff --git a/browser.go b/browser.go index 0fd6ffd..4afdd04 100644 --- a/browser.go +++ b/browser.go @@ -5,7 +5,6 @@ package kernel import ( "bytes" "context" - "encoding/json" "errors" "fmt" "io" @@ -36,6 +35,8 @@ import ( // the [NewBrowserService] method instead. type BrowserService struct { Options []option.RequestOption + // Stream live telemetry events from a browser session. + Telemetry BrowserTelemetryService // Record and manage browser session video replays. Replays BrowserReplayService // Read, write, and manage files on the browser instance. @@ -55,6 +56,7 @@ type BrowserService struct { func NewBrowserService(opts ...option.RequestOption) (r BrowserService) { r = BrowserService{} r.Options = opts + r.Telemetry = NewBrowserTelemetryService(opts...) r.Replays = NewBrowserReplayService(opts...) r.Fs = NewBrowserFService(opts...) r.Process = NewBrowserProcessService(opts...) @@ -121,18 +123,6 @@ func (r *BrowserService) ListAutoPaging(ctx context.Context, query BrowserListPa return pagination.NewOffsetPaginationAutoPager(r.List(ctx, query, opts...)) } -// DEPRECATED: Use DELETE /browsers/{id} instead. Delete a persistent browser -// session by its persistent_id. -// -// Deprecated: deprecated -func (r *BrowserService) Delete(ctx context.Context, body BrowserDeleteParams, opts ...option.RequestOption) (err error) { - opts = slices.Concat(r.Options, opts) - opts = append([]option.RequestOption{option.WithHeader("Accept", "*/*")}, opts...) - path := "browsers" - err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, body, nil, opts...) - return err -} - // Sends an HTTP request through Chrome's HTTP request stack, inheriting the // browser's TLS fingerprint, cookies, proxy configuration, and headers. Returns a // structured JSON response with status, headers, body, and timing. @@ -174,54 +164,6 @@ func (r *BrowserService) LoadExtensions(ctx context.Context, id string, body Bro return err } -// DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. -// -// Deprecated: deprecated -type BrowserPersistence struct { - // DEPRECATED: Unique identifier for the persistent browser session. - ID string `json:"id" api:"required"` - // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. - JSON struct { - ID respjson.Field - ExtraFields map[string]respjson.Field - raw string - } `json:"-"` -} - -// Returns the unmodified JSON received from the API -func (r BrowserPersistence) RawJSON() string { return r.JSON.raw } -func (r *BrowserPersistence) UnmarshalJSON(data []byte) error { - return apijson.UnmarshalRoot(data, r) -} - -// ToParam converts this BrowserPersistence to a BrowserPersistenceParam. -// -// Warning: the fields of the param type will not be present. ToParam should only -// be used at the last possible moment before sending a request. Test for this with -// BrowserPersistenceParam.Overrides() -func (r BrowserPersistence) ToParam() BrowserPersistenceParam { - return param.Override[BrowserPersistenceParam](json.RawMessage(r.RawJSON())) -} - -// DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. -// -// Deprecated: deprecated -// -// The property ID is required. -type BrowserPersistenceParam struct { - // DEPRECATED: Unique identifier for the persistent browser session. - ID string `json:"id" api:"required"` - paramObj -} - -func (r BrowserPersistenceParam) MarshalJSON() (data []byte, err error) { - type shadow BrowserPersistenceParam - return param.MarshalObject(r, (*shadow)(&r)) -} -func (r *BrowserPersistenceParam) UnmarshalJSON(data []byte) error { - return apijson.UnmarshalRoot(data, r) -} - // Browser pool this session was acquired from, if any. type BrowserPoolRef struct { // Browser pool ID @@ -311,6 +253,10 @@ type BrowserNewResponse struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -318,18 +264,20 @@ type BrowserNewResponse struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -356,14 +304,15 @@ type BrowserNewResponse struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field @@ -397,6 +346,10 @@ type BrowserGetResponse struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -404,18 +357,20 @@ type BrowserGetResponse struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -442,14 +397,15 @@ type BrowserGetResponse struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field @@ -483,6 +439,10 @@ type BrowserUpdateResponse struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -490,18 +450,20 @@ type BrowserUpdateResponse struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -528,14 +490,15 @@ type BrowserUpdateResponse struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field @@ -569,6 +532,10 @@ type BrowserListResponse struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -576,18 +543,20 @@ type BrowserListResponse struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -614,14 +583,15 @@ type BrowserListResponse struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field @@ -690,14 +660,21 @@ type BrowserNewParams struct { // check for inactivity every 5 seconds, so the actual timeout behavior you will // see is +/- 5 seconds around the specified value. TimeoutSeconds param.Opt[int64] `json:"timeout_seconds,omitzero"` + // Custom Chrome enterprise policy overrides applied to this browser session. Keys + // are Chrome enterprise policy names; values must match their expected types. + // Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See + // https://chromeenterprise.google/policies/ + ChromePolicy map[string]any `json:"chrome_policy,omitzero"` // List of browser extensions to load into the session. Provide each by id or name. Extensions []shared.BrowserExtensionParam `json:"extensions,omitzero"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - Persistence BrowserPersistenceParam `json:"persistence,omitzero"` // Profile selection for the browser session. Provide either id or name. If // specified, the matching profile will be loaded into the browser session. // Profiles must be created beforehand. Profile shared.BrowserProfileParam `json:"profile,omitzero"` + // Telemetry configuration for the browser session. If provided, telemetry capture + // starts with the specified category filter when the session is created. If + // omitted, no telemetry capture is started. + Telemetry BrowserTelemetryConfigParam `json:"telemetry,omitzero"` // Initial browser window size in pixels with optional refresh rate. If omitted, // image defaults apply (1920x1080@25). For GPU images, the default is // 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted. @@ -746,6 +723,11 @@ type BrowserUpdateParams struct { // Profile to load into the browser session. Only allowed if the session does not // already have a profile loaded. Profile shared.BrowserProfileParam `json:"profile,omitzero"` + // Telemetry configuration. Omit, set to null, or set to an empty object ({}) to + // leave the existing configuration unchanged (no-op). To enable capture for all + // categories using VM defaults, set browser to an empty object ({"browser": {}}). + // To stop capture, set every category's enabled to false. + Telemetry BrowserTelemetryConfigParam `json:"telemetry,omitzero"` // Viewport configuration to apply to the browser session. Viewport BrowserUpdateParamsViewport `json:"viewport,omitzero"` paramObj @@ -813,20 +795,6 @@ const ( BrowserListParamsStatusAll BrowserListParamsStatus = "all" ) -type BrowserDeleteParams struct { - // Persistent browser identifier - PersistentID string `query:"persistent_id" api:"required" json:"-"` - paramObj -} - -// URLQuery serializes [BrowserDeleteParams]'s query parameters as `url.Values`. -func (r BrowserDeleteParams) URLQuery() (v url.Values, err error) { - return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{ - ArrayFormat: apiquery.ArrayQueryFormatComma, - NestedFormat: apiquery.NestedQueryFormatBrackets, - }) -} - type BrowserCurlParams struct { // Target URL (must be http or https). URL string `json:"url" api:"required"` diff --git a/browser_test.go b/browser_test.go index b4d0090..ac46837 100644 --- a/browser_test.go +++ b/browser_test.go @@ -30,6 +30,9 @@ func TestBrowserNewWithOptionalParams(t *testing.T) { option.WithAPIKey("My API Key"), ) _, err := client.Browsers.New(context.TODO(), kernel.BrowserNewParams{ + ChromePolicy: map[string]any{ + "foo": "bar", + }, Extensions: []shared.BrowserExtensionParam{{ ID: kernel.String("id"), Name: kernel.String("name"), @@ -38,17 +41,30 @@ func TestBrowserNewWithOptionalParams(t *testing.T) { Headless: kernel.Bool(false), InvocationID: kernel.String("rr33xuugxj9h0bkf1rdt2bet"), KioskMode: kernel.Bool(true), - Persistence: kernel.BrowserPersistenceParam{ - ID: "my-awesome-browser-for-user-1234", - }, Profile: shared.BrowserProfileParam{ ID: kernel.String("id"), Name: kernel.String("name"), SaveChanges: kernel.Bool(true), }, - ProxyID: kernel.String("proxy_id"), - StartURL: kernel.String("https://example.com"), - Stealth: kernel.Bool(true), + ProxyID: kernel.String("proxy_id"), + StartURL: kernel.String("https://example.com"), + Stealth: kernel.Bool(true), + Telemetry: kernel.BrowserTelemetryConfigParam{ + Browser: kernel.BrowserTelemetryCategoriesConfigParam{ + Console: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Interaction: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Network: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Page: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + }, + }, TimeoutSeconds: kernel.Int(10), Viewport: shared.BrowserViewportParam{ Height: 800, @@ -118,6 +134,22 @@ func TestBrowserUpdateWithOptionalParams(t *testing.T) { SaveChanges: kernel.Bool(true), }, ProxyID: kernel.String("proxy_id"), + Telemetry: kernel.BrowserTelemetryConfigParam{ + Browser: kernel.BrowserTelemetryCategoriesConfigParam{ + Console: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Interaction: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Network: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + Page: kernel.BrowserTelemetryCategoryConfigParam{ + Enabled: kernel.Bool(true), + }, + }, + }, Viewport: kernel.BrowserUpdateParamsViewport{ BrowserViewportParam: shared.BrowserViewportParam{ Height: 800, @@ -166,31 +198,6 @@ func TestBrowserListWithOptionalParams(t *testing.T) { } } -func TestBrowserDelete(t *testing.T) { - t.Skip("Mock server tests are disabled") - baseURL := "http://localhost:4010" - if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok { - baseURL = envURL - } - if !testutil.CheckTestServer(t, baseURL) { - return - } - client := kernel.NewClient( - option.WithBaseURL(baseURL), - option.WithAPIKey("My API Key"), - ) - err := client.Browsers.Delete(context.TODO(), kernel.BrowserDeleteParams{ - PersistentID: "persistent_id", - }) - if err != nil { - var apierr *kernel.Error - if errors.As(err, &apierr) { - t.Log(string(apierr.DumpRequest(true))) - } - t.Fatalf("err should be nil: %s", err.Error()) - } -} - func TestBrowserCurlWithOptionalParams(t *testing.T) { t.Skip("Mock server tests are disabled") baseURL := "http://localhost:4010" diff --git a/browserpool.go b/browserpool.go index cdacc31..4a6aed0 100644 --- a/browserpool.go +++ b/browserpool.go @@ -196,9 +196,11 @@ type BrowserPoolBrowserPoolConfig struct { // Optional proxy to associate to the browser session. Must reference a proxy // belonging to the caller's org. ProxyID string `json:"proxy_id"` - // Optional URL to open when a browser is created for the pool. Navigation is - // best-effort, so navigation failures do not prevent the pool from filling. Reused - // browsers keep the page left by the previous lease. + // Optional URL to navigate to when a new browser is warmed into the pool. + // Best-effort: failures to navigate do not fail pool fill. Only applied to + // newly-warmed browsers; browsers reused via release/acquire keep whatever URL the + // previous lease left them on. Accepts any URL Chromium can resolve, including + // chrome:// pages. StartURL string `json:"start_url"` // If true, launches the browser in stealth mode to reduce detection by anti-bot // mechanisms. @@ -265,6 +267,10 @@ type BrowserPoolAcquireResponse struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -272,18 +278,20 @@ type BrowserPoolAcquireResponse struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -310,14 +318,15 @@ type BrowserPoolAcquireResponse struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field @@ -348,9 +357,11 @@ type BrowserPoolNewParams struct { // Optional proxy to associate to the browser session. Must reference a proxy // belonging to the caller's org. ProxyID param.Opt[string] `json:"proxy_id,omitzero"` - // Optional URL to open when a browser is created for the pool. Navigation is - // best-effort, so navigation failures do not prevent the pool from filling. Reused - // browsers keep the page left by the previous lease. + // Optional URL to navigate to when a new browser is warmed into the pool. + // Best-effort: failures to navigate do not fail pool fill. Only applied to + // newly-warmed browsers; browsers reused via release/acquire keep whatever URL the + // previous lease left them on. Accepts any URL Chromium can resolve, including + // chrome:// pages. StartURL param.Opt[string] `json:"start_url,omitzero"` // If true, launches the browser in stealth mode to reduce detection by anti-bot // mechanisms. @@ -413,9 +424,11 @@ type BrowserPoolUpdateParams struct { // Optional proxy to associate to the browser session. Must reference a proxy // belonging to the caller's org. ProxyID param.Opt[string] `json:"proxy_id,omitzero"` - // Optional URL to open when a browser is created for the pool. Navigation is - // best-effort, so navigation failures do not prevent the pool from filling. Reused - // browsers keep the page left by the previous lease. + // Optional URL to navigate to when a new browser is warmed into the pool. + // Best-effort: failures to navigate do not fail pool fill. Only applied to + // newly-warmed browsers; browsers reused via release/acquire keep whatever URL the + // previous lease left them on. Accepts any URL Chromium can resolve, including + // chrome:// pages. StartURL param.Opt[string] `json:"start_url,omitzero"` // If true, launches the browser in stealth mode to reduce detection by anti-bot // mechanisms. diff --git a/browsertelemetry.go b/browsertelemetry.go new file mode 100644 index 0000000..c983430 --- /dev/null +++ b/browsertelemetry.go @@ -0,0 +1,2141 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +package kernel + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "net/http" + "slices" + + "github.com/kernel/kernel-go-sdk/internal/apijson" + "github.com/kernel/kernel-go-sdk/internal/requestconfig" + "github.com/kernel/kernel-go-sdk/option" + "github.com/kernel/kernel-go-sdk/packages/param" + "github.com/kernel/kernel-go-sdk/packages/respjson" + "github.com/kernel/kernel-go-sdk/packages/ssestream" + "github.com/kernel/kernel-go-sdk/shared/constant" +) + +// Stream live telemetry events from a browser session. +// +// BrowserTelemetryService contains methods and other services that help with +// interacting with the kernel API. +// +// Note, unlike clients, this service does not read variables from the environment +// automatically. You should not instantiate this service directly, and instead use +// the [NewBrowserTelemetryService] method instead. +type BrowserTelemetryService struct { + Options []option.RequestOption +} + +// NewBrowserTelemetryService generates a new service that applies the given +// options to each request. These options are applied after the parent client's +// options (if there is one), and before any request-specific options. +func NewBrowserTelemetryService(opts ...option.RequestOption) (r BrowserTelemetryService) { + r = BrowserTelemetryService{} + r.Options = opts + return +} + +// Streams browser telemetry events as a server-sent events (SSE) stream. The +// stream closes when the browser session terminates. Each event frame includes an +// id: field containing a monotonically increasing sequence number; pass it as +// Last-Event-ID on reconnect to resume without gaps. The event: field is never +// set; all frames carry JSON in the data: field. A keepalive comment frame is sent +// every 15 seconds when no events arrive. Returns 404 if the browser session does +// not exist. If telemetry was not enabled on the session, the stream opens but no +// events are delivered. +func (r *BrowserTelemetryService) StreamStreaming(ctx context.Context, id string, query BrowserTelemetryStreamParams, opts ...option.RequestOption) (stream *ssestream.Stream[BrowserTelemetryStreamResponse]) { + var ( + raw *http.Response + err error + ) + if !param.IsOmitted(query.LastEventID) { + opts = append(opts, option.WithHeader("Last-Event-ID", fmt.Sprintf("%v", query.LastEventID.Value))) + } + opts = slices.Concat(r.Options, opts) + opts = append([]option.RequestOption{option.WithHeader("Accept", "text/event-stream")}, opts...) + if id == "" { + err = errors.New("missing required id parameter") + return ssestream.NewStream[BrowserTelemetryStreamResponse](nil, err) + } + path := fmt.Sprintf("browsers/%s/telemetry", id) + err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &raw, opts...) + return ssestream.NewStream[BrowserTelemetryStreamResponse](ssestream.NewDecoder(raw), err) +} + +// CDP Runtime.StackTrace representing the JavaScript call stack at the time of an +// event. Fields use CDP naming conventions rather than snake_case to match the +// Chrome DevTools Protocol wire format. +type BrowserCallStack struct { + // Ordered list of call frames, outermost first. + CallFrames []BrowserCallStackCallFrame `json:"callFrames" api:"required"` + // Optional label for the stack trace (e.g. async cause). + Description string `json:"description"` + // Parent stack trace for async stacks. + Parent *BrowserCallStack `json:"parent"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + CallFrames respjson.Field + Description respjson.Field + Parent respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserCallStack) RawJSON() string { return r.JSON.raw } +func (r *BrowserCallStack) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserCallStackCallFrame struct { + // Zero-based column number within the line. + ColumnNumber int64 `json:"columnNumber" api:"required"` + // JavaScript function name, or empty string for anonymous functions. + FunctionName string `json:"functionName" api:"required"` + // Zero-based line number within the script. + LineNumber int64 `json:"lineNumber" api:"required"` + // CDP script identifier. + ScriptID string `json:"scriptId" api:"required"` + // URL or name of the script file. + URL string `json:"url" api:"required"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + ColumnNumber respjson.Field + FunctionName respjson.Field + LineNumber respjson.Field + ScriptID respjson.Field + URL respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserCallStackCallFrame) RawJSON() string { return r.JSON.raw } +func (r *BrowserCallStackCallFrame) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser console error or uncaught JavaScript exception event. Emitted from two +// distinct CDP sources with different data shapes. Runtime.consoleAPICalled +// (console.error calls) produces level, text, args, and stack_trace. +// Runtime.exceptionThrown (uncaught exceptions) produces text, line, column, +// source_url, and stack_trace. Fields not applicable to the source are absent. +type BrowserConsoleErrorEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.ConsoleError `json:"type" default:"console_error"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserConsoleErrorEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserConsoleErrorEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserConsoleErrorEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserConsoleErrorEventData struct { + // Error message text. Present in both source paths. + Text string `json:"text" api:"required"` + // All console arguments coerced to strings. Present only when sourced from + // Runtime.consoleAPICalled. + Args []string `json:"args"` + // Column number in the script where the exception was thrown. Present only when + // sourced from Runtime.exceptionThrown. + Column int64 `json:"column"` + // CDP console type value, always "error". Present only when sourced from + // Runtime.consoleAPICalled. + Level string `json:"level"` + // Line number in the script where the exception was thrown. Present only when + // sourced from Runtime.exceptionThrown. + Line int64 `json:"line"` + // URL of the script file that threw the exception. Present only when sourced from + // Runtime.exceptionThrown. + SourceURL string `json:"source_url"` + // CDP Runtime.StackTrace representing the JavaScript call stack at the time of an + // event. Fields use CDP naming conventions rather than snake_case to match the + // Chrome DevTools Protocol wire format. + StackTrace BrowserCallStack `json:"stack_trace"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Text respjson.Field + Args respjson.Field + Column respjson.Field + Level respjson.Field + Line respjson.Field + SourceURL respjson.Field + StackTrace respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserConsoleErrorEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserConsoleErrorEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser console log event (console.log, console.info, console.warn, etc.). +type BrowserConsoleLogEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.ConsoleLog `json:"type" default:"console_log"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserConsoleLogEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserConsoleLogEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserConsoleLogEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserConsoleLogEventData struct { + // All console arguments coerced to strings. + Args []string `json:"args"` + // CDP Runtime.consoleAPICalled type, passed through unfiltered from Chrome. error + // is routed to console_error events instead; all other CDP console types appear + // here. See CDP spec for the full enum. + Level string `json:"level"` + // CDP Runtime.StackTrace representing the JavaScript call stack at the time of an + // event. Fields use CDP naming conventions rather than snake_case to match the + // Chrome DevTools Protocol wire format. + StackTrace BrowserCallStack `json:"stack_trace"` + // First console argument coerced to string. + Text string `json:"text"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Args respjson.Field + Level respjson.Field + StackTrace respjson.Field + Text respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserConsoleLogEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserConsoleLogEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserEventContext struct { + // CDP frame identifier within the target. + FrameID string `json:"frame_id"` + // CDP document loader identifier, reset on each navigation. + LoaderID string `json:"loader_id"` + // Monotonically increasing navigation sequence number, incremented on each + // top-level navigation within the target. + NavSeq int64 `json:"nav_seq"` + // CDP session identifier for the target connection. + SessionID string `json:"session_id"` + // Browser target identifier (stable across navigations within a tab). + TargetID string `json:"target_id"` + // CDP target type of the page that produced the event. + // + // Any of "page", "background_page", "service_worker", "shared_worker", "other". + TargetType BrowserEventContextTargetType `json:"target_type"` + // URL relevant to this event — page URL for navigation and page events, request + // URL for network events. + URL string `json:"url"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + FrameID respjson.Field + LoaderID respjson.Field + NavSeq respjson.Field + SessionID respjson.Field + TargetID respjson.Field + TargetType respjson.Field + URL respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserEventContext) RawJSON() string { return r.JSON.raw } +func (r *BrowserEventContext) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// CDP target type of the page that produced the event. +type BrowserEventContextTargetType string + +const ( + BrowserEventContextTargetTypePage BrowserEventContextTargetType = "page" + BrowserEventContextTargetTypeBackgroundPage BrowserEventContextTargetType = "background_page" + BrowserEventContextTargetTypeServiceWorker BrowserEventContextTargetType = "service_worker" + BrowserEventContextTargetTypeSharedWorker BrowserEventContextTargetType = "shared_worker" + BrowserEventContextTargetTypeOther BrowserEventContextTargetType = "other" +) + +// Provenance metadata identifying which producer emitted the event. +type BrowserEventSource struct { + // Event producer. cdp: Chrome DevTools Protocol events from the browser. + // kernel_api: Kernel API server. extension: injected Chrome extension. + // local_process: system process running alongside the browser. + // + // Any of "cdp", "kernel_api", "extension", "local_process". + Kind BrowserEventSourceKind `json:"kind" api:"required"` + // Producer-specific event name (e.g. Runtime.consoleAPICalled for CDP-sourced + // console events, Runtime.exceptionThrown for uncaught exceptions). + Event string `json:"event"` + // Producer-specific context (e.g. CDP target/session/frame IDs). + Metadata map[string]string `json:"metadata"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Kind respjson.Field + Event respjson.Field + Metadata respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserEventSource) RawJSON() string { return r.JSON.raw } +func (r *BrowserEventSource) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Event producer. cdp: Chrome DevTools Protocol events from the browser. +// kernel_api: Kernel API server. extension: injected Chrome extension. +// local_process: system process running alongside the browser. +type BrowserEventSourceKind string + +const ( + BrowserEventSourceKindCdp BrowserEventSourceKind = "cdp" + BrowserEventSourceKindKernelAPI BrowserEventSourceKind = "kernel_api" + BrowserEventSourceKindExtension BrowserEventSourceKind = "extension" + BrowserEventSourceKindLocalProcess BrowserEventSourceKind = "local_process" +) + +type BrowserHTTPHeaders map[string]any + +// A browser user click event captured via injected page script. +type BrowserInteractionClickEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.InteractionClick `json:"type" default:"interaction_click"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserInteractionClickEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionClickEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionClickEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserInteractionClickEventData struct { + // CSS selector path to the clicked element. + Selector string `json:"selector"` + // HTML tag name of the clicked element in uppercase (e.g. BUTTON, A, DIV). + Tag string `json:"tag"` + // Visible text content of the clicked element, trimmed. + Text string `json:"text"` + // Viewport x-coordinate of the click in CSS pixels. + X int64 `json:"x"` + // Viewport y-coordinate of the click in CSS pixels. + Y int64 `json:"y"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Selector respjson.Field + Tag respjson.Field + Text respjson.Field + X respjson.Field + Y respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionClickEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionClickEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser keyboard event captured via injected page script. +type BrowserInteractionKeyEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.InteractionKey `json:"type" default:"interaction_key"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserInteractionKeyEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionKeyEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionKeyEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserInteractionKeyEventData struct { + // Key value from the KeyboardEvent (e.g. Enter, Backspace, a). + Key string `json:"key"` + // CSS selector path to the element that had focus when the key was pressed. + Selector string `json:"selector"` + // HTML tag name of the focused element in uppercase (e.g. INPUT, TEXTAREA, DIV). + Tag string `json:"tag"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Key respjson.Field + Selector respjson.Field + Tag respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionKeyEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionKeyEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser scroll settled event emitted after scroll position stops changing, +// captured via injected page script. +type BrowserInteractionScrollSettledEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.InteractionScrollSettled `json:"type" default:"interaction_scroll_settled"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserInteractionScrollSettledEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionScrollSettledEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionScrollSettledEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserInteractionScrollSettledEventData struct { + // Scroll x-position at the start of the scroll gesture in CSS pixels. + FromX int64 `json:"from_x"` + // Scroll y-position at the start of the scroll gesture in CSS pixels. + FromY int64 `json:"from_y"` + // CSS selector path to the scrolled element. + TargetSelector string `json:"target_selector"` + // Final scroll x-position after the gesture settled in CSS pixels. + ToX int64 `json:"to_x"` + // Final scroll y-position after the gesture settled in CSS pixels. + ToY int64 `json:"to_y"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + FromX respjson.Field + FromY respjson.Field + TargetSelector respjson.Field + ToX respjson.Field + ToY respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserInteractionScrollSettledEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserInteractionScrollSettledEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// The CDP connection to Chrome was lost. Telemetry events may be dropped until +// monitor_reconnected arrives. Treat any in-progress computed state (network_idle, +// page_layout_settled) as unreliable until then. +type BrowserMonitorDisconnectedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.MonitorDisconnected `json:"type" default:"monitor_disconnected"` + Data BrowserMonitorDisconnectedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorDisconnectedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorDisconnectedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserMonitorDisconnectedEventData struct { + // Reason for the disconnection. chrome_restarted: Chrome process restarted. + // + // Any of "chrome_restarted". + Reason string `json:"reason"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Reason respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorDisconnectedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorDisconnectedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// The CDP session could not be initialized. +type BrowserMonitorInitFailedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.MonitorInitFailed `json:"type" default:"monitor_init_failed"` + Data BrowserMonitorInitFailedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorInitFailedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorInitFailedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserMonitorInitFailedEventData struct { + // The CDP method or initialization step that failed (e.g. Target.setAutoAttach). + Step string `json:"step"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Step respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorInitFailedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorInitFailedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// The CDP connection to Chrome could not be re-established after exhausting all +// reconnection attempts. No further telemetry events will arrive on this session. +type BrowserMonitorReconnectFailedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.MonitorReconnectFailed `json:"type" default:"monitor_reconnect_failed"` + Data BrowserMonitorReconnectFailedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorReconnectFailedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorReconnectFailedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserMonitorReconnectFailedEventData struct { + // Reason for the reconnection failure. reconnect_exhausted: all retry attempts + // were used up without successfully restoring the CDP connection. + // + // Any of "reconnect_exhausted". + Reason string `json:"reason"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Reason respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorReconnectFailedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorReconnectFailedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// The CDP connection to Chrome was successfully re-established after a +// disconnection. Events emitted during the gap are lost. Computed state is reset, +// so navigation and network tracking restart fresh from this point. +type BrowserMonitorReconnectedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.MonitorReconnected `json:"type" default:"monitor_reconnected"` + Data BrowserMonitorReconnectedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorReconnectedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorReconnectedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserMonitorReconnectedEventData struct { + // Wall-clock time in milliseconds taken to reconnect after the disconnection. + ReconnectDurationMs int64 `json:"reconnect_duration_ms"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + ReconnectDurationMs respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorReconnectedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorReconnectedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A periodic screenshot of the browser viewport. +type BrowserMonitorScreenshotEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.MonitorScreenshot `json:"type" default:"monitor_screenshot"` + Data BrowserMonitorScreenshotEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorScreenshotEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorScreenshotEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserMonitorScreenshotEventData struct { + // Base64-encoded PNG screenshot of the browser viewport. + Png string `json:"png"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Png respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserMonitorScreenshotEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserMonitorScreenshotEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser network idle event emitted after a 500ms quiet period with no +// in-flight HTTP requests. +type BrowserNetworkIdleEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.NetworkIdle `json:"type" default:"network_idle"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserEventContext `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkIdleEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkIdleEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser network loading failed event. If the request was already in flight +// when CDP attached (no prior network_request was emitted for it), url, frame_id, +// loader_id, and resource_type are absent; BrowserEventContext is partially +// populated in that case. +type BrowserNetworkLoadingFailedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.NetworkLoadingFailed `json:"type" default:"network_loading_failed"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserNetworkLoadingFailedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkLoadingFailedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkLoadingFailedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserNetworkLoadingFailedEventData struct { + // True if the request was canceled by the browser or page script. + Canceled bool `json:"canceled"` + // Network error description (e.g. net::ERR_CONNECTION_REFUSED). + ErrorText string `json:"error_text"` + // CDP request identifier matching the originating network_request event. + RequestID string `json:"request_id"` + // CDP Network.ResourceType for the request, passed through as-is from Chrome. + // Known values include Document, Fetch, XHR, Script, Stylesheet, Image, Media, + // Font, TextTrack, EventSource, WebSocket, Manifest, Prefetch, Other, and more. + ResourceType string `json:"resource_type"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Canceled respjson.Field + ErrorText respjson.Field + RequestID respjson.Field + ResourceType respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkLoadingFailedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkLoadingFailedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser network request sent event. +type BrowserNetworkRequestEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.NetworkRequest `json:"type" default:"network_request"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserNetworkRequestEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkRequestEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkRequestEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserNetworkRequestEventData struct { + // URL of the document that initiated the request. + DocumentURL string `json:"document_url"` + // Request headers. + Headers BrowserHTTPHeaders `json:"headers"` + // CDP Initiator.type indicating what caused the request, passed through as-is from + // Chrome. Known values include script, parser, preload, and other. + InitiatorType string `json:"initiator_type"` + // True if this request is the result of a redirect. + IsRedirect bool `json:"is_redirect"` + // HTTP method as sent on the wire (e.g. GET, POST). + Method string `json:"method"` + // Request body for POST/PUT requests, if available. + PostData string `json:"post_data"` + // Original URL before the redirect, present when is_redirect is true. + RedirectURL string `json:"redirect_url"` + // CDP request identifier, unique within the session. + RequestID string `json:"request_id"` + // CDP Network.ResourceType for the request, passed through as-is from Chrome. + // Known values include Document, Fetch, XHR, Script, Stylesheet, Image, Media, + // Font, TextTrack, EventSource, WebSocket, Manifest, Prefetch, Other, and more. + ResourceType string `json:"resource_type"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + DocumentURL respjson.Field + Headers respjson.Field + InitiatorType respjson.Field + IsRedirect respjson.Field + Method respjson.Field + PostData respjson.Field + RedirectURL respjson.Field + RequestID respjson.Field + ResourceType respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkRequestEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkRequestEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser network response received event. Fired after the response body is +// fully received, not when headers arrive. +type BrowserNetworkResponseEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.NetworkResponse `json:"type" default:"network_response"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserNetworkResponseEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkResponseEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkResponseEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserNetworkResponseEventData struct { + // Truncated response body, present only for text MIME types. + Body string `json:"body"` + // Response headers. + Headers BrowserHTTPHeaders `json:"headers"` + // HTTP method of the original request. + Method string `json:"method"` + // MIME type of the response (e.g. text/html, application/json). + MimeType string `json:"mime_type"` + // CDP request identifier matching the originating network_request event. + RequestID string `json:"request_id"` + // CDP Network.ResourceType for the request, passed through as-is from Chrome. + // Known values include Document, Fetch, XHR, Script, Stylesheet, Image, Media, + // Font, TextTrack, EventSource, WebSocket, Manifest, Prefetch, Other, and more. + ResourceType string `json:"resource_type"` + // HTTP response status code. + Status int64 `json:"status"` + // HTTP response status text (e.g. OK, Not Found). + StatusText string `json:"status_text"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Body respjson.Field + Headers respjson.Field + Method respjson.Field + MimeType respjson.Field + RequestID respjson.Field + ResourceType respjson.Field + Status respjson.Field + StatusText respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserNetworkResponseEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserNetworkResponseEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser DOMContentLoaded event (CDP Page.domContentEventFired). +type BrowserPageDomContentLoadedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageDomContentLoaded `json:"type" default:"page_dom_content_loaded"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserPageDomContentLoadedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageDomContentLoadedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageDomContentLoadedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserPageDomContentLoadedEventData struct { + // Chrome monotonic clock value in seconds at which DOMContentLoaded fired, + // relative to browser process start (not Unix epoch). Use ts for wall-clock time. + CdpTimestamp float64 `json:"cdp_timestamp"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + CdpTimestamp respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageDomContentLoadedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageDomContentLoadedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser layout settled event emitted 1 second after page load with no +// intervening layout shifts, indicating visual stability. Each layout shift resets +// the 1-second timer. +type BrowserPageLayoutSettledEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageLayoutSettled `json:"type" default:"page_layout_settled"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserEventContext `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLayoutSettledEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLayoutSettledEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser cumulative layout shift (CLS) event from the Performance Timeline API. +type BrowserPageLayoutShiftEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageLayoutShift `json:"type" default:"page_layout_shift"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserPageLayoutShiftEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLayoutShiftEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLayoutShiftEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserPageLayoutShiftEventData struct { + // Duration of the layout shift entry in milliseconds (always 0 for layout shifts + // per spec). + Duration float64 `json:"duration"` + // PerformanceLayoutShift attributes from the Performance Timeline entry. + LayoutShiftDetails BrowserPageLayoutShiftEventDataLayoutShiftDetails `json:"layout_shift_details"` + // CDP frame identifier of the frame where the layout shift occurred. + SourceFrameID string `json:"source_frame_id"` + // Performance Timeline timestamp of the layout shift in milliseconds. + Time float64 `json:"time"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Duration respjson.Field + LayoutShiftDetails respjson.Field + SourceFrameID respjson.Field + Time respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLayoutShiftEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLayoutShiftEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// PerformanceLayoutShift attributes from the Performance Timeline entry. +type BrowserPageLayoutShiftEventDataLayoutShiftDetails struct { + // True if the layout shift was preceded by user input within 500ms, excluding it + // from CLS. + HadRecentInput bool `json:"had_recent_input"` + // Layout shift score for this entry (contribution to CLS). + Value float64 `json:"value"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + HadRecentInput respjson.Field + Value respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLayoutShiftEventDataLayoutShiftDetails) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLayoutShiftEventDataLayoutShiftDetails) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser Largest Contentful Paint (LCP) event from the Performance Timeline +// API. +type BrowserPageLcpEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageLcp `json:"type" default:"page_lcp"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserPageLcpEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLcpEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLcpEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserPageLcpEventData struct { + // LargestContentfulPaint attributes from the Performance Timeline entry. + LcpDetails BrowserPageLcpEventDataLcpDetails `json:"lcp_details"` + // CDP frame identifier of the frame where the LCP element was rendered. + SourceFrameID string `json:"source_frame_id"` + // Performance Timeline timestamp of the LCP entry in milliseconds. + Time float64 `json:"time"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + LcpDetails respjson.Field + SourceFrameID respjson.Field + Time respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLcpEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLcpEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// LargestContentfulPaint attributes from the Performance Timeline entry. +type BrowserPageLcpEventDataLcpDetails struct { + // id attribute of the LCP element, if present. + ElementID string `json:"element_id"` + // Load time of the LCP element in milliseconds. + LoadTime float64 `json:"load_time"` + // CDP DOM node identifier of the LCP element. + NodeID int64 `json:"node_id"` + // Render time of the LCP element in milliseconds; 0 for cross-origin images + // without Timing-Allow-Origin. + RenderTime float64 `json:"render_time"` + // Visible area of the LCP element in pixels squared. + Size float64 `json:"size"` + // URL of the LCP element for image or video elements. + URL string `json:"url"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + ElementID respjson.Field + LoadTime respjson.Field + NodeID respjson.Field + RenderTime respjson.Field + Size respjson.Field + URL respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLcpEventDataLcpDetails) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLcpEventDataLcpDetails) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser page load event (CDP Page.loadEventFired). +type BrowserPageLoadEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageLoad `json:"type" default:"page_load"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserPageLoadEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLoadEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLoadEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Browser event context stamped by the browser monitor onto all CDP-sourced +// events. Identifies the target, frame, and navigation epoch in which the event +// occurred. +type BrowserPageLoadEventData struct { + // Chrome monotonic clock value in seconds at which the load event fired, relative + // to browser process start (not Unix epoch). Use ts for wall-clock time. + CdpTimestamp float64 `json:"cdp_timestamp"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + CdpTimestamp respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` + BrowserEventContext +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageLoadEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageLoadEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A browser page navigation started event (CDP Page.frameNavigated). Carries nav +// context fields inline but not nav_seq, as this event resets the navigation +// epoch. +type BrowserPageNavigationEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageNavigation `json:"type" default:"page_navigation"` + Data BrowserPageNavigationEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageNavigationEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageNavigationEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserPageNavigationEventData struct { + // CDP frame identifier of the navigated frame. + FrameID string `json:"frame_id"` + // New CDP document loader identifier assigned for this navigation. + LoaderID string `json:"loader_id"` + // Parent frame identifier for subframe navigations; absent for top-level + // navigations. + ParentFrameID string `json:"parent_frame_id"` + // CDP session identifier. + SessionID string `json:"session_id"` + // Browser target identifier. + TargetID string `json:"target_id"` + // CDP target type of the page that produced the event. + // + // Any of "page", "background_page", "service_worker", "shared_worker", "other". + TargetType string `json:"target_type"` + // URL navigated to. + URL string `json:"url"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + FrameID respjson.Field + LoaderID respjson.Field + ParentFrameID respjson.Field + SessionID respjson.Field + TargetID respjson.Field + TargetType respjson.Field + URL respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageNavigationEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageNavigationEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Emitted when page_dom_content_loaded and page_layout_settled have both fired for +// the same navigation, indicating the page is loaded and visually stable. +// Independent of network_idle; a single pending request does not block it. +type BrowserPageNavigationSettledEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageNavigationSettled `json:"type" default:"page_navigation_settled"` + // Browser event context stamped by the browser monitor onto all CDP-sourced + // events. Identifies the target, frame, and navigation epoch in which the event + // occurred. + Data BrowserEventContext `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageNavigationSettledEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageNavigationSettledEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// A new browser tab or target was opened (CDP Target.attachedToTarget for page +// targets). Fires before a CDP session is attached to the new target, so +// session_id, frame_id, loader_id, and nav_seq are absent; this event does not +// compose BrowserEventContext. Consumers reading context fields generically should +// treat it as a special case. +type BrowserPageTabOpenedEvent struct { + // Provenance metadata identifying which producer emitted the event. + Source BrowserEventSource `json:"source" api:"required"` + // Event timestamp in Unix microseconds. + Ts int64 `json:"ts" api:"required"` + Type constant.PageTabOpened `json:"type" default:"page_tab_opened"` + Data BrowserPageTabOpenedEventData `json:"data"` + // True if the data field was truncated due to size limits. + Truncated bool `json:"truncated"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageTabOpenedEvent) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageTabOpenedEvent) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserPageTabOpenedEventData struct { + // Target identifier of the tab that opened this one, if any. + OpenerID string `json:"opener_id"` + // CDP target identifier for the newly opened tab. + TargetID string `json:"target_id"` + // CDP target type of the page that produced the event. + // + // Any of "page", "background_page", "service_worker", "shared_worker", "other". + TargetType string `json:"target_type"` + // Initial page title of the new tab. + Title string `json:"title"` + // Initial URL of the new tab. + URL string `json:"url"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + OpenerID respjson.Field + TargetID respjson.Field + TargetType respjson.Field + Title respjson.Field + URL respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserPageTabOpenedEventData) RawJSON() string { return r.JSON.raw } +func (r *BrowserPageTabOpenedEventData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Per-category telemetry capture settings. +type BrowserTelemetryCategoriesConfig struct { + // Console output (log, warn, error) and uncaught exceptions. + Console BrowserTelemetryCategoryConfig `json:"console"` + // User interaction events including clicks, keydowns, and scroll-settled events. + Interaction BrowserTelemetryCategoryConfig `json:"interaction"` + // HTTP request and response metadata including URL, method, status code, and + // timing. Request post data is forwarded as-is from CDP. Text response bodies are + // truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other + // text types. Binary responses (images, fonts, media) are excluded. + Network BrowserTelemetryCategoryConfig `json:"network"` + // Page lifecycle events including navigation, DOMContentLoaded, load, layout + // shifts, and LCP. + Page BrowserTelemetryCategoryConfig `json:"page"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Console respjson.Field + Interaction respjson.Field + Network respjson.Field + Page respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserTelemetryCategoriesConfig) RawJSON() string { return r.JSON.raw } +func (r *BrowserTelemetryCategoriesConfig) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// ToParam converts this BrowserTelemetryCategoriesConfig to a +// BrowserTelemetryCategoriesConfigParam. +// +// Warning: the fields of the param type will not be present. ToParam should only +// be used at the last possible moment before sending a request. Test for this with +// BrowserTelemetryCategoriesConfigParam.Overrides() +func (r BrowserTelemetryCategoriesConfig) ToParam() BrowserTelemetryCategoriesConfigParam { + return param.Override[BrowserTelemetryCategoriesConfigParam](json.RawMessage(r.RawJSON())) +} + +// Per-category telemetry capture settings. +type BrowserTelemetryCategoriesConfigParam struct { + // Console output (log, warn, error) and uncaught exceptions. + Console BrowserTelemetryCategoryConfigParam `json:"console,omitzero"` + // User interaction events including clicks, keydowns, and scroll-settled events. + Interaction BrowserTelemetryCategoryConfigParam `json:"interaction,omitzero"` + // HTTP request and response metadata including URL, method, status code, and + // timing. Request post data is forwarded as-is from CDP. Text response bodies are + // truncated at 8 KB for structured types (JSON, XML, form data) and 4 KB for other + // text types. Binary responses (images, fonts, media) are excluded. + Network BrowserTelemetryCategoryConfigParam `json:"network,omitzero"` + // Page lifecycle events including navigation, DOMContentLoaded, load, layout + // shifts, and LCP. + Page BrowserTelemetryCategoryConfigParam `json:"page,omitzero"` + paramObj +} + +func (r BrowserTelemetryCategoriesConfigParam) MarshalJSON() (data []byte, err error) { + type shadow BrowserTelemetryCategoriesConfigParam + return param.MarshalObject(r, (*shadow)(&r)) +} +func (r *BrowserTelemetryCategoriesConfigParam) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Per-category telemetry configuration. +type BrowserTelemetryCategoryConfig struct { + // Whether this category is captured. Defaults to true if omitted. + Enabled bool `json:"enabled"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Enabled respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserTelemetryCategoryConfig) RawJSON() string { return r.JSON.raw } +func (r *BrowserTelemetryCategoryConfig) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// ToParam converts this BrowserTelemetryCategoryConfig to a +// BrowserTelemetryCategoryConfigParam. +// +// Warning: the fields of the param type will not be present. ToParam should only +// be used at the last possible moment before sending a request. Test for this with +// BrowserTelemetryCategoryConfigParam.Overrides() +func (r BrowserTelemetryCategoryConfig) ToParam() BrowserTelemetryCategoryConfigParam { + return param.Override[BrowserTelemetryCategoryConfigParam](json.RawMessage(r.RawJSON())) +} + +// Per-category telemetry configuration. +type BrowserTelemetryCategoryConfigParam struct { + // Whether this category is captured. Defaults to true if omitted. + Enabled param.Opt[bool] `json:"enabled,omitzero"` + paramObj +} + +func (r BrowserTelemetryCategoryConfigParam) MarshalJSON() (data []byte, err error) { + type shadow BrowserTelemetryCategoryConfigParam + return param.MarshalObject(r, (*shadow)(&r)) +} +func (r *BrowserTelemetryCategoryConfigParam) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Telemetry configuration for a browser session. +type BrowserTelemetryConfig struct { + // Per-category enable/disable flags. If omitted, all categories are captured. + Browser BrowserTelemetryCategoriesConfig `json:"browser"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Browser respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserTelemetryConfig) RawJSON() string { return r.JSON.raw } +func (r *BrowserTelemetryConfig) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// ToParam converts this BrowserTelemetryConfig to a BrowserTelemetryConfigParam. +// +// Warning: the fields of the param type will not be present. ToParam should only +// be used at the last possible moment before sending a request. Test for this with +// BrowserTelemetryConfigParam.Overrides() +func (r BrowserTelemetryConfig) ToParam() BrowserTelemetryConfigParam { + return param.Override[BrowserTelemetryConfigParam](json.RawMessage(r.RawJSON())) +} + +// Telemetry configuration for a browser session. +type BrowserTelemetryConfigParam struct { + // Per-category enable/disable flags. If omitted, all categories are captured. + Browser BrowserTelemetryCategoriesConfigParam `json:"browser,omitzero"` + paramObj +} + +func (r BrowserTelemetryConfigParam) MarshalJSON() (data []byte, err error) { + type shadow BrowserTelemetryConfigParam + return param.MarshalObject(r, (*shadow)(&r)) +} +func (r *BrowserTelemetryConfigParam) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// BrowserTelemetryEventUnion contains all possible properties and values from +// [BrowserConsoleLogEvent], [BrowserConsoleErrorEvent], +// [BrowserNetworkRequestEvent], [BrowserNetworkResponseEvent], +// [BrowserNetworkLoadingFailedEvent], [BrowserNetworkIdleEvent], +// [BrowserPageNavigationEvent], [BrowserPageDomContentLoadedEvent], +// [BrowserPageLoadEvent], [BrowserPageTabOpenedEvent], +// [BrowserPageLayoutShiftEvent], [BrowserPageLcpEvent], +// [BrowserPageLayoutSettledEvent], [BrowserPageNavigationSettledEvent], +// [BrowserInteractionClickEvent], [BrowserInteractionKeyEvent], +// [BrowserInteractionScrollSettledEvent], [BrowserMonitorScreenshotEvent], +// [BrowserMonitorDisconnectedEvent], [BrowserMonitorReconnectedEvent], +// [BrowserMonitorReconnectFailedEvent], [BrowserMonitorInitFailedEvent]. +// +// Use the [BrowserTelemetryEventUnion.AsAny] method to switch on the variant. +// +// Use the methods beginning with 'As' to cast the union to one of its variants. +type BrowserTelemetryEventUnion struct { + // This field is from variant [BrowserConsoleLogEvent]. + Source BrowserEventSource `json:"source"` + Ts int64 `json:"ts"` + // Any of "console_log", "console_error", "network_request", "network_response", + // "network_loading_failed", "network_idle", "page_navigation", + // "page_dom_content_loaded", "page_load", "page_tab_opened", "page_layout_shift", + // "page_lcp", "page_layout_settled", "page_navigation_settled", + // "interaction_click", "interaction_key", "interaction_scroll_settled", + // "monitor_screenshot", "monitor_disconnected", "monitor_reconnected", + // "monitor_reconnect_failed", "monitor_init_failed". + Type string `json:"type"` + // This field is a union of [BrowserConsoleLogEventData], + // [BrowserConsoleErrorEventData], [BrowserNetworkRequestEventData], + // [BrowserNetworkResponseEventData], [BrowserNetworkLoadingFailedEventData], + // [BrowserEventContext], [BrowserPageNavigationEventData], + // [BrowserPageDomContentLoadedEventData], [BrowserPageLoadEventData], + // [BrowserPageTabOpenedEventData], [BrowserPageLayoutShiftEventData], + // [BrowserPageLcpEventData], [BrowserInteractionClickEventData], + // [BrowserInteractionKeyEventData], [BrowserInteractionScrollSettledEventData], + // [BrowserMonitorScreenshotEventData], [BrowserMonitorDisconnectedEventData], + // [BrowserMonitorReconnectedEventData], [BrowserMonitorReconnectFailedEventData], + // [BrowserMonitorInitFailedEventData] + Data BrowserTelemetryEventUnionData `json:"data"` + Truncated bool `json:"truncated"` + JSON struct { + Source respjson.Field + Ts respjson.Field + Type respjson.Field + Data respjson.Field + Truncated respjson.Field + raw string + } `json:"-"` +} + +// anyBrowserTelemetryEvent is implemented by each variant of +// [BrowserTelemetryEventUnion] to add type safety for the return type of +// [BrowserTelemetryEventUnion.AsAny] +type anyBrowserTelemetryEvent interface { + implBrowserTelemetryEventUnion() +} + +func (BrowserConsoleLogEvent) implBrowserTelemetryEventUnion() {} +func (BrowserConsoleErrorEvent) implBrowserTelemetryEventUnion() {} +func (BrowserNetworkRequestEvent) implBrowserTelemetryEventUnion() {} +func (BrowserNetworkResponseEvent) implBrowserTelemetryEventUnion() {} +func (BrowserNetworkLoadingFailedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserNetworkIdleEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageNavigationEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageDomContentLoadedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageLoadEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageTabOpenedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageLayoutShiftEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageLcpEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageLayoutSettledEvent) implBrowserTelemetryEventUnion() {} +func (BrowserPageNavigationSettledEvent) implBrowserTelemetryEventUnion() {} +func (BrowserInteractionClickEvent) implBrowserTelemetryEventUnion() {} +func (BrowserInteractionKeyEvent) implBrowserTelemetryEventUnion() {} +func (BrowserInteractionScrollSettledEvent) implBrowserTelemetryEventUnion() {} +func (BrowserMonitorScreenshotEvent) implBrowserTelemetryEventUnion() {} +func (BrowserMonitorDisconnectedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserMonitorReconnectedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserMonitorReconnectFailedEvent) implBrowserTelemetryEventUnion() {} +func (BrowserMonitorInitFailedEvent) implBrowserTelemetryEventUnion() {} + +// Use the following switch statement to find the correct variant +// +// switch variant := BrowserTelemetryEventUnion.AsAny().(type) { +// case kernel.BrowserConsoleLogEvent: +// case kernel.BrowserConsoleErrorEvent: +// case kernel.BrowserNetworkRequestEvent: +// case kernel.BrowserNetworkResponseEvent: +// case kernel.BrowserNetworkLoadingFailedEvent: +// case kernel.BrowserNetworkIdleEvent: +// case kernel.BrowserPageNavigationEvent: +// case kernel.BrowserPageDomContentLoadedEvent: +// case kernel.BrowserPageLoadEvent: +// case kernel.BrowserPageTabOpenedEvent: +// case kernel.BrowserPageLayoutShiftEvent: +// case kernel.BrowserPageLcpEvent: +// case kernel.BrowserPageLayoutSettledEvent: +// case kernel.BrowserPageNavigationSettledEvent: +// case kernel.BrowserInteractionClickEvent: +// case kernel.BrowserInteractionKeyEvent: +// case kernel.BrowserInteractionScrollSettledEvent: +// case kernel.BrowserMonitorScreenshotEvent: +// case kernel.BrowserMonitorDisconnectedEvent: +// case kernel.BrowserMonitorReconnectedEvent: +// case kernel.BrowserMonitorReconnectFailedEvent: +// case kernel.BrowserMonitorInitFailedEvent: +// default: +// fmt.Errorf("no variant present") +// } +func (u BrowserTelemetryEventUnion) AsAny() anyBrowserTelemetryEvent { + switch u.Type { + case "console_log": + return u.AsConsoleLog() + case "console_error": + return u.AsConsoleError() + case "network_request": + return u.AsNetworkRequest() + case "network_response": + return u.AsNetworkResponse() + case "network_loading_failed": + return u.AsNetworkLoadingFailed() + case "network_idle": + return u.AsNetworkIdle() + case "page_navigation": + return u.AsPageNavigation() + case "page_dom_content_loaded": + return u.AsPageDomContentLoaded() + case "page_load": + return u.AsPageLoad() + case "page_tab_opened": + return u.AsPageTabOpened() + case "page_layout_shift": + return u.AsPageLayoutShift() + case "page_lcp": + return u.AsPageLcp() + case "page_layout_settled": + return u.AsPageLayoutSettled() + case "page_navigation_settled": + return u.AsPageNavigationSettled() + case "interaction_click": + return u.AsInteractionClick() + case "interaction_key": + return u.AsInteractionKey() + case "interaction_scroll_settled": + return u.AsInteractionScrollSettled() + case "monitor_screenshot": + return u.AsMonitorScreenshot() + case "monitor_disconnected": + return u.AsMonitorDisconnected() + case "monitor_reconnected": + return u.AsMonitorReconnected() + case "monitor_reconnect_failed": + return u.AsMonitorReconnectFailed() + case "monitor_init_failed": + return u.AsMonitorInitFailed() + } + return nil +} + +func (u BrowserTelemetryEventUnion) AsConsoleLog() (v BrowserConsoleLogEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsConsoleError() (v BrowserConsoleErrorEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsNetworkRequest() (v BrowserNetworkRequestEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsNetworkResponse() (v BrowserNetworkResponseEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsNetworkLoadingFailed() (v BrowserNetworkLoadingFailedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsNetworkIdle() (v BrowserNetworkIdleEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageNavigation() (v BrowserPageNavigationEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageDomContentLoaded() (v BrowserPageDomContentLoadedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageLoad() (v BrowserPageLoadEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageTabOpened() (v BrowserPageTabOpenedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageLayoutShift() (v BrowserPageLayoutShiftEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageLcp() (v BrowserPageLcpEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageLayoutSettled() (v BrowserPageLayoutSettledEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsPageNavigationSettled() (v BrowserPageNavigationSettledEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsInteractionClick() (v BrowserInteractionClickEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsInteractionKey() (v BrowserInteractionKeyEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsInteractionScrollSettled() (v BrowserInteractionScrollSettledEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsMonitorScreenshot() (v BrowserMonitorScreenshotEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsMonitorDisconnected() (v BrowserMonitorDisconnectedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsMonitorReconnected() (v BrowserMonitorReconnectedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsMonitorReconnectFailed() (v BrowserMonitorReconnectFailedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +func (u BrowserTelemetryEventUnion) AsMonitorInitFailed() (v BrowserMonitorInitFailedEvent) { + apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v) + return +} + +// Returns the unmodified JSON received from the API +func (u BrowserTelemetryEventUnion) RawJSON() string { return u.JSON.raw } + +func (r *BrowserTelemetryEventUnion) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// BrowserTelemetryEventUnionData is an implicit subunion of +// [BrowserTelemetryEventUnion]. BrowserTelemetryEventUnionData provides convenient +// access to the sub-properties of the union. +// +// For type safety it is recommended to directly use a variant of the +// [BrowserTelemetryEventUnion]. +type BrowserTelemetryEventUnionData struct { + FrameID string `json:"frame_id"` + LoaderID string `json:"loader_id"` + // This field is from variant [BrowserConsoleLogEventData], + // [BrowserConsoleErrorEventData], [BrowserNetworkRequestEventData], + // [BrowserNetworkResponseEventData], [BrowserNetworkLoadingFailedEventData], + // [BrowserEventContext], [BrowserPageDomContentLoadedEventData], + // [BrowserPageLoadEventData], [BrowserPageLayoutShiftEventData], + // [BrowserPageLcpEventData], [BrowserInteractionClickEventData], + // [BrowserInteractionKeyEventData], [BrowserInteractionScrollSettledEventData]. + NavSeq int64 `json:"nav_seq"` + SessionID string `json:"session_id"` + TargetID string `json:"target_id"` + TargetType string `json:"target_type"` + URL string `json:"url"` + Args []string `json:"args"` + Level string `json:"level"` + // This field is from variant [BrowserConsoleLogEventData]. + StackTrace BrowserCallStack `json:"stack_trace"` + Text string `json:"text"` + // This field is from variant [BrowserConsoleErrorEventData]. + Column int64 `json:"column"` + // This field is from variant [BrowserConsoleErrorEventData]. + Line int64 `json:"line"` + // This field is from variant [BrowserConsoleErrorEventData]. + SourceURL string `json:"source_url"` + // This field is from variant [BrowserNetworkRequestEventData]. + DocumentURL string `json:"document_url"` + // This field is from variant [BrowserNetworkRequestEventData]. + Headers BrowserHTTPHeaders `json:"headers"` + // This field is from variant [BrowserNetworkRequestEventData]. + InitiatorType string `json:"initiator_type"` + // This field is from variant [BrowserNetworkRequestEventData]. + IsRedirect bool `json:"is_redirect"` + Method string `json:"method"` + // This field is from variant [BrowserNetworkRequestEventData]. + PostData string `json:"post_data"` + // This field is from variant [BrowserNetworkRequestEventData]. + RedirectURL string `json:"redirect_url"` + RequestID string `json:"request_id"` + ResourceType string `json:"resource_type"` + // This field is from variant [BrowserNetworkResponseEventData]. + Body string `json:"body"` + // This field is from variant [BrowserNetworkResponseEventData]. + MimeType string `json:"mime_type"` + // This field is from variant [BrowserNetworkResponseEventData]. + Status int64 `json:"status"` + // This field is from variant [BrowserNetworkResponseEventData]. + StatusText string `json:"status_text"` + // This field is from variant [BrowserNetworkLoadingFailedEventData]. + Canceled bool `json:"canceled"` + // This field is from variant [BrowserNetworkLoadingFailedEventData]. + ErrorText string `json:"error_text"` + // This field is from variant [BrowserPageNavigationEventData]. + ParentFrameID string `json:"parent_frame_id"` + CdpTimestamp float64 `json:"cdp_timestamp"` + // This field is from variant [BrowserPageTabOpenedEventData]. + OpenerID string `json:"opener_id"` + // This field is from variant [BrowserPageTabOpenedEventData]. + Title string `json:"title"` + // This field is from variant [BrowserPageLayoutShiftEventData]. + Duration float64 `json:"duration"` + // This field is from variant [BrowserPageLayoutShiftEventData]. + LayoutShiftDetails BrowserPageLayoutShiftEventDataLayoutShiftDetails `json:"layout_shift_details"` + SourceFrameID string `json:"source_frame_id"` + Time float64 `json:"time"` + // This field is from variant [BrowserPageLcpEventData]. + LcpDetails BrowserPageLcpEventDataLcpDetails `json:"lcp_details"` + Selector string `json:"selector"` + Tag string `json:"tag"` + // This field is from variant [BrowserInteractionClickEventData]. + X int64 `json:"x"` + // This field is from variant [BrowserInteractionClickEventData]. + Y int64 `json:"y"` + // This field is from variant [BrowserInteractionKeyEventData]. + Key string `json:"key"` + // This field is from variant [BrowserInteractionScrollSettledEventData]. + FromX int64 `json:"from_x"` + // This field is from variant [BrowserInteractionScrollSettledEventData]. + FromY int64 `json:"from_y"` + // This field is from variant [BrowserInteractionScrollSettledEventData]. + TargetSelector string `json:"target_selector"` + // This field is from variant [BrowserInteractionScrollSettledEventData]. + ToX int64 `json:"to_x"` + // This field is from variant [BrowserInteractionScrollSettledEventData]. + ToY int64 `json:"to_y"` + // This field is from variant [BrowserMonitorScreenshotEventData]. + Png string `json:"png"` + Reason string `json:"reason"` + // This field is from variant [BrowserMonitorReconnectedEventData]. + ReconnectDurationMs int64 `json:"reconnect_duration_ms"` + // This field is from variant [BrowserMonitorInitFailedEventData]. + Step string `json:"step"` + JSON struct { + FrameID respjson.Field + LoaderID respjson.Field + NavSeq respjson.Field + SessionID respjson.Field + TargetID respjson.Field + TargetType respjson.Field + URL respjson.Field + Args respjson.Field + Level respjson.Field + StackTrace respjson.Field + Text respjson.Field + Column respjson.Field + Line respjson.Field + SourceURL respjson.Field + DocumentURL respjson.Field + Headers respjson.Field + InitiatorType respjson.Field + IsRedirect respjson.Field + Method respjson.Field + PostData respjson.Field + RedirectURL respjson.Field + RequestID respjson.Field + ResourceType respjson.Field + Body respjson.Field + MimeType respjson.Field + Status respjson.Field + StatusText respjson.Field + Canceled respjson.Field + ErrorText respjson.Field + ParentFrameID respjson.Field + CdpTimestamp respjson.Field + OpenerID respjson.Field + Title respjson.Field + Duration respjson.Field + LayoutShiftDetails respjson.Field + SourceFrameID respjson.Field + Time respjson.Field + LcpDetails respjson.Field + Selector respjson.Field + Tag respjson.Field + X respjson.Field + Y respjson.Field + Key respjson.Field + FromX respjson.Field + FromY respjson.Field + TargetSelector respjson.Field + ToX respjson.Field + ToY respjson.Field + Png respjson.Field + Reason respjson.Field + ReconnectDurationMs respjson.Field + Step respjson.Field + raw string + } `json:"-"` +} + +func (r *BrowserTelemetryEventUnionData) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +// Envelope wrapping a browser telemetry event with its monotonic sequence number. +// Each SSE data: frame carries one envelope as JSON. The seq value is also emitted +// as the SSE id: field so clients can pass it as Last-Event-ID on reconnect. +type BrowserTelemetryStreamResponse struct { + // Union type representing any browser telemetry event. Discriminated on `type`. + // Events with a `monitor_` prefix (monitor_screenshot, monitor_disconnected, + // monitor_reconnected, monitor_reconnect_failed, monitor_init_failed) are always + // emitted regardless of the category configuration in BrowserTelemetryConfig. All + // other event types are controlled by the per-category enable/disable flags. + Event BrowserTelemetryEventUnion `json:"event" api:"required"` + // Process-monotonic sequence number assigned by the browser VM. Pass as + // Last-Event-ID on reconnect to resume without gaps. Gaps in received seq values + // indicate dropped events. + Seq int64 `json:"seq" api:"required"` + // JSON contains metadata for fields, check presence with [respjson.Field.Valid]. + JSON struct { + Event respjson.Field + Seq respjson.Field + ExtraFields map[string]respjson.Field + raw string + } `json:"-"` +} + +// Returns the unmodified JSON received from the API +func (r BrowserTelemetryStreamResponse) RawJSON() string { return r.JSON.raw } +func (r *BrowserTelemetryStreamResponse) UnmarshalJSON(data []byte) error { + return apijson.UnmarshalRoot(data, r) +} + +type BrowserTelemetryStreamParams struct { + LastEventID param.Opt[string] `header:"Last-Event-ID,omitzero" json:"-"` + paramObj +} diff --git a/internal/version.go b/internal/version.go index c3078a6..dca821f 100644 --- a/internal/version.go +++ b/internal/version.go @@ -2,4 +2,4 @@ package internal -const PackageVersion = "0.56.0" // x-release-please-version +const PackageVersion = "0.57.0" // x-release-please-version diff --git a/invocation.go b/invocation.go index ae95443..e312d66 100644 --- a/invocation.go +++ b/invocation.go @@ -557,6 +557,10 @@ type InvocationListBrowsersResponseBrowser struct { // Remote URL for live viewing the browser session. Only available for non-headless // browsers. BrowserLiveViewURL string `json:"browser_live_view_url"` + // Custom Chrome enterprise policy overrides that were applied to this browser + // session, if any. Echoed back for verification. Keys are Chrome enterprise policy + // names. + ChromePolicy map[string]any `json:"chrome_policy"` // When the browser session was soft-deleted. Only present for deleted sessions. DeletedAt time.Time `json:"deleted_at" format:"date-time"` // Whether GPU acceleration is enabled for the browser session (only supported for @@ -564,18 +568,20 @@ type InvocationListBrowsersResponseBrowser struct { GPU bool `json:"gpu"` // Whether the browser session is running in kiosk mode. KioskMode bool `json:"kiosk_mode"` - // DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead. - // - // Deprecated: deprecated - Persistence BrowserPersistence `json:"persistence"` // Browser pool this session was acquired from, if any. Pool BrowserPoolRef `json:"pool"` // Browser profile metadata. Profile Profile `json:"profile"` // ID of the proxy associated with this browser session, if any. ProxyID string `json:"proxy_id"` - // Start URL requested for the session, if provided. + // URL the session was asked to navigate to on creation, if any. Recorded for + // debugging. Navigation is fire-and-forget — the URL is dispatched to the browser + // without waiting for it to load, and any errors (DNS failure, bad status, + // timeout) are silently dropped. Captures what was requested, not what the browser + // actually loaded. StartURL string `json:"start_url"` + // Active telemetry configuration for the session, if any. + Telemetry BrowserTelemetryConfig `json:"telemetry" api:"nullable"` // Session usage metrics. Usage BrowserUsage `json:"usage"` // Initial browser window size in pixels with optional refresh rate. If omitted, @@ -602,14 +608,15 @@ type InvocationListBrowsersResponseBrowser struct { WebdriverWsURL respjson.Field BaseURL respjson.Field BrowserLiveViewURL respjson.Field + ChromePolicy respjson.Field DeletedAt respjson.Field GPU respjson.Field KioskMode respjson.Field - Persistence respjson.Field Pool respjson.Field Profile respjson.Field ProxyID respjson.Field StartURL respjson.Field + Telemetry respjson.Field Usage respjson.Field Viewport respjson.Field ExtraFields map[string]respjson.Field diff --git a/projectlimit.go b/projectlimit.go index 94121a2..aa48e7b 100644 --- a/projectlimit.go +++ b/projectlimit.go @@ -72,9 +72,6 @@ type ProjectLimits struct { // Maximum concurrent browser sessions for this project. Null means no // project-level cap. MaxConcurrentSessions int64 `json:"max_concurrent_sessions" api:"nullable"` - // Maximum persistent browser sessions for this project. Null means no - // project-level cap. - MaxPersistentSessions int64 `json:"max_persistent_sessions" api:"nullable"` // Maximum pooled sessions capacity for this project. Null means no project-level // cap. MaxPooledSessions int64 `json:"max_pooled_sessions" api:"nullable"` @@ -82,7 +79,6 @@ type ProjectLimits struct { JSON struct { MaxConcurrentInvocations respjson.Field MaxConcurrentSessions respjson.Field - MaxPersistentSessions respjson.Field MaxPooledSessions respjson.Field ExtraFields map[string]respjson.Field raw string @@ -102,9 +98,6 @@ type UpdateProjectLimitsRequestParam struct { // Maximum concurrent browser sessions for this project. Set to 0 to remove the // cap; omit to leave unchanged. MaxConcurrentSessions param.Opt[int64] `json:"max_concurrent_sessions,omitzero"` - // Maximum persistent browser sessions for this project. Set to 0 to remove the - // cap; omit to leave unchanged. - MaxPersistentSessions param.Opt[int64] `json:"max_persistent_sessions,omitzero"` // Maximum pooled sessions capacity for this project. Set to 0 to remove the cap; // omit to leave unchanged. MaxPooledSessions param.Opt[int64] `json:"max_pooled_sessions,omitzero"` diff --git a/projectlimit_test.go b/projectlimit_test.go index 928783f..180bbf4 100644 --- a/projectlimit_test.go +++ b/projectlimit_test.go @@ -56,7 +56,6 @@ func TestProjectLimitUpdateWithOptionalParams(t *testing.T) { UpdateProjectLimitsRequest: kernel.UpdateProjectLimitsRequestParam{ MaxConcurrentInvocations: kernel.Int(0), MaxConcurrentSessions: kernel.Int(0), - MaxPersistentSessions: kernel.Int(0), MaxPooledSessions: kernel.Int(0), }, }, diff --git a/proxy.go b/proxy.go index 63b60dd..ba58f87 100644 --- a/proxy.go +++ b/proxy.go @@ -1600,7 +1600,9 @@ type ProxyCheckParams struct { // between requests, so a successful check validates proxy configuration but does // not guarantee that a subsequent browser session will use the same exit IP or // reach the same site — it is useful for verifying credentials and connectivity, - // not for predicting site-specific behavior. + // not for predicting site-specific behavior. When provided, the check result does + // not update the proxy's health status, since a failure may indicate a problem + // with the target site rather than the proxy itself. URL param.Opt[string] `json:"url,omitzero"` paramObj } diff --git a/shared/constant/constants.go b/shared/constant/constants.go index 104ffd3..8188adf 100644 --- a/shared/constant/constants.go +++ b/shared/constant/constants.go @@ -18,32 +18,100 @@ func ValueOf[T Constant[T]]() T { return t.Default() } -type AppVersionSummary string // Always "app_version_summary" -type AwsUsEast1a string // Always "aws.us-east-1a" -type DeploymentState string // Always "deployment_state" -type Error string // Always "error" -type InvocationState string // Always "invocation_state" -type Log string // Always "log" -type ManagedAuthState string // Always "managed_auth_state" -type SseHeartbeat string // Always "sse_heartbeat" +type AppVersionSummary string // Always "app_version_summary" +type AwsUsEast1a string // Always "aws.us-east-1a" +type ConsoleError string // Always "console_error" +type ConsoleLog string // Always "console_log" +type DeploymentState string // Always "deployment_state" +type Error string // Always "error" +type InteractionClick string // Always "interaction_click" +type InteractionKey string // Always "interaction_key" +type InteractionScrollSettled string // Always "interaction_scroll_settled" +type InvocationState string // Always "invocation_state" +type Log string // Always "log" +type ManagedAuthState string // Always "managed_auth_state" +type MonitorDisconnected string // Always "monitor_disconnected" +type MonitorInitFailed string // Always "monitor_init_failed" +type MonitorReconnectFailed string // Always "monitor_reconnect_failed" +type MonitorReconnected string // Always "monitor_reconnected" +type MonitorScreenshot string // Always "monitor_screenshot" +type NetworkIdle string // Always "network_idle" +type NetworkLoadingFailed string // Always "network_loading_failed" +type NetworkRequest string // Always "network_request" +type NetworkResponse string // Always "network_response" +type PageDomContentLoaded string // Always "page_dom_content_loaded" +type PageLayoutSettled string // Always "page_layout_settled" +type PageLayoutShift string // Always "page_layout_shift" +type PageLcp string // Always "page_lcp" +type PageLoad string // Always "page_load" +type PageNavigation string // Always "page_navigation" +type PageNavigationSettled string // Always "page_navigation_settled" +type PageTabOpened string // Always "page_tab_opened" +type SseHeartbeat string // Always "sse_heartbeat" func (c AppVersionSummary) Default() AppVersionSummary { return "app_version_summary" } func (c AwsUsEast1a) Default() AwsUsEast1a { return "aws.us-east-1a" } +func (c ConsoleError) Default() ConsoleError { return "console_error" } +func (c ConsoleLog) Default() ConsoleLog { return "console_log" } func (c DeploymentState) Default() DeploymentState { return "deployment_state" } func (c Error) Default() Error { return "error" } -func (c InvocationState) Default() InvocationState { return "invocation_state" } -func (c Log) Default() Log { return "log" } -func (c ManagedAuthState) Default() ManagedAuthState { return "managed_auth_state" } -func (c SseHeartbeat) Default() SseHeartbeat { return "sse_heartbeat" } - -func (c AppVersionSummary) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c AwsUsEast1a) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c DeploymentState) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c Error) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c InvocationState) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c Log) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c ManagedAuthState) MarshalJSON() ([]byte, error) { return marshalString(c) } -func (c SseHeartbeat) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c InteractionClick) Default() InteractionClick { return "interaction_click" } +func (c InteractionKey) Default() InteractionKey { return "interaction_key" } +func (c InteractionScrollSettled) Default() InteractionScrollSettled { + return "interaction_scroll_settled" +} +func (c InvocationState) Default() InvocationState { return "invocation_state" } +func (c Log) Default() Log { return "log" } +func (c ManagedAuthState) Default() ManagedAuthState { return "managed_auth_state" } +func (c MonitorDisconnected) Default() MonitorDisconnected { return "monitor_disconnected" } +func (c MonitorInitFailed) Default() MonitorInitFailed { return "monitor_init_failed" } +func (c MonitorReconnectFailed) Default() MonitorReconnectFailed { return "monitor_reconnect_failed" } +func (c MonitorReconnected) Default() MonitorReconnected { return "monitor_reconnected" } +func (c MonitorScreenshot) Default() MonitorScreenshot { return "monitor_screenshot" } +func (c NetworkIdle) Default() NetworkIdle { return "network_idle" } +func (c NetworkLoadingFailed) Default() NetworkLoadingFailed { return "network_loading_failed" } +func (c NetworkRequest) Default() NetworkRequest { return "network_request" } +func (c NetworkResponse) Default() NetworkResponse { return "network_response" } +func (c PageDomContentLoaded) Default() PageDomContentLoaded { return "page_dom_content_loaded" } +func (c PageLayoutSettled) Default() PageLayoutSettled { return "page_layout_settled" } +func (c PageLayoutShift) Default() PageLayoutShift { return "page_layout_shift" } +func (c PageLcp) Default() PageLcp { return "page_lcp" } +func (c PageLoad) Default() PageLoad { return "page_load" } +func (c PageNavigation) Default() PageNavigation { return "page_navigation" } +func (c PageNavigationSettled) Default() PageNavigationSettled { return "page_navigation_settled" } +func (c PageTabOpened) Default() PageTabOpened { return "page_tab_opened" } +func (c SseHeartbeat) Default() SseHeartbeat { return "sse_heartbeat" } + +func (c AppVersionSummary) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c AwsUsEast1a) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c ConsoleError) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c ConsoleLog) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c DeploymentState) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c Error) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c InteractionClick) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c InteractionKey) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c InteractionScrollSettled) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c InvocationState) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c Log) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c ManagedAuthState) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c MonitorDisconnected) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c MonitorInitFailed) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c MonitorReconnectFailed) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c MonitorReconnected) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c MonitorScreenshot) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c NetworkIdle) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c NetworkLoadingFailed) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c NetworkRequest) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c NetworkResponse) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageDomContentLoaded) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageLayoutSettled) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageLayoutShift) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageLcp) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageLoad) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageNavigation) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageNavigationSettled) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c PageTabOpened) MarshalJSON() ([]byte, error) { return marshalString(c) } +func (c SseHeartbeat) MarshalJSON() ([]byte, error) { return marshalString(c) } type constant[T any] interface { Constant[T]