runtime

type AddBindingParams struct {
	Name                 string `json:"name"`
	ExecutionContextName string `json:"executionContextName,omitempty,omitzero"` // If specified, the binding is exposed to the executionContext with matching name, even for contexts created after the binding is added. See also ExecutionContext.name and worldName parameter to Page.addScriptToEvaluateOnNewDocument. This parameter is mutually exclusive with executionContextId.
}

type AwaitPromiseParams struct {
	PromiseObjectID RemoteObjectID `json:"promiseObjectId"`                    // Identifier of the promise.
	ReturnByValue   *bool          `json:"returnByValue,omitempty,omitzero"`   // Whether the result is expected to be a JSON object that should be sent by value.
	GeneratePreview *bool          `json:"generatePreview,omitempty,omitzero"` // Whether preview should be generated for the result.
}

type AwaitPromiseResult struct {
	Result           *RemoteObject     `json:"result,omitempty,omitzero"`           // Promise result. Will contain rejected value if promise was rejected.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"` // Exception details if stack strace is available.
}

type CallArgument struct {
	Value               jsonv2.Value        `json:"value,omitempty,omitzero"`               // Primitive value or serializable javascript object.
	UnserializableValue UnserializableValue `json:"unserializableValue,omitempty,omitzero"` // Primitive value which can not be JSON-stringified.
	ObjectID            RemoteObjectID      `json:"objectId,omitempty,omitzero"`            // Remote object handle.
}

type CallFrame struct {
	FunctionName string       `json:"functionName"` // JavaScript function name.
	ScriptID     cdp.ScriptID `json:"scriptId"`     // JavaScript script id.
	URL          string       `json:"url"`          // JavaScript script name or url.
	LineNumber   int64        `json:"lineNumber"`   // JavaScript script line number (0-based).
	ColumnNumber int64        `json:"columnNumber"` // JavaScript script column number (0-based).
}

type CallFunctionOnParams struct {
	FunctionDeclaration  string                `json:"functionDeclaration"`                     // Declaration of the function to call.
	ObjectID             RemoteObjectID        `json:"objectId,omitempty,omitzero"`             // Identifier of the object to call function on. Either objectId or executionContextId should be specified.
	Arguments            []*CallArgument       `json:"arguments,omitempty,omitzero"`            // Call arguments. All call arguments must belong to the same JavaScript world as the target object.
	Silent               *bool                 `json:"silent,omitempty,omitzero"`               // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
	ReturnByValue        *bool                 `json:"returnByValue,omitempty,omitzero"`        // Whether the result is expected to be a JSON object which should be sent by value. Can be overridden by serializationOptions.
	GeneratePreview      *bool                 `json:"generatePreview,omitempty,omitzero"`      // Whether preview should be generated for the result.
	UserGesture          *bool                 `json:"userGesture,omitempty,omitzero"`          // Whether execution should be treated as initiated by user in the UI.
	AwaitPromise         *bool                 `json:"awaitPromise,omitempty,omitzero"`         // Whether execution should await for resulting value and return once awaited promise is resolved.
	ExecutionContextID   ExecutionContextID    `json:"executionContextId,omitempty,omitzero"`   // Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.
	ObjectGroup          string                `json:"objectGroup,omitempty,omitzero"`          // Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.
	ThrowOnSideEffect    *bool                 `json:"throwOnSideEffect,omitempty,omitzero"`    // Whether to throw an exception if side effect cannot be ruled out during evaluation.
	UniqueContextID      string                `json:"uniqueContextId,omitempty,omitzero"`      // An alternative way to specify the execution context to call function on. Compared to contextId that may be reused across processes, this is guaranteed to be system-unique, so it can be used to prevent accidental function call in context different than intended (e.g. as a result of navigation across process boundaries). This is mutually exclusive with executionContextId.
	SerializationOptions *SerializationOptions `json:"serializationOptions,omitempty,omitzero"` // Specifies the result serialization. If provided, overrides generatePreview and returnByValue.
}

type CallFunctionOnResult struct {
	Result           *RemoteObject     `json:"result,omitempty,omitzero"`           // Call result.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"` // Exception details.
}

type CompileScriptParams struct {
	Expression         string             `json:"expression"`                            // Expression to compile.
	SourceURL          string             `json:"sourceURL"`                             // Source url to be set for the script.
	PersistScript      bool               `json:"persistScript"`                         // Specifies whether the compiled script should be persisted.
	ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty,omitzero"` // Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
}

type CompileScriptResult struct {
	ScriptID         cdp.ScriptID      `json:"scriptId,omitempty,omitzero"`         // Id of the script.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"` // Exception details.
}

type ConsoleAPICalledType string

type CustomPreview struct {
	Header       string         `json:"header"`                          // The JSON-stringified result of formatter.header(object, config) call. It contains json ML array that represents RemoteObject.
	BodyGetterID RemoteObjectID `json:"bodyGetterId,omitempty,omitzero"` // If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call. The result value is json ML array.
}

type DeepSerializedValue struct {
	Type                     DeepSerializedValueType `json:"type"`
	Value                    jsonv2.Value            `json:"value,omitempty,omitzero"`
	ObjectID                 string                  `json:"objectId,omitempty,omitzero"`
	WeakLocalObjectReference int64                   `json:"weakLocalObjectReference,omitempty,omitzero"` // Set if value reference met more then once during serialization. In such case, value is provided only to one of the serialized values. Unique per value in the scope of one CDP call.
}

type DeepSerializedValueType string

type EntryPreview struct {
	Key   *ObjectPreview `json:"key,omitempty,omitzero"` // Preview of the key. Specified for map-like collection entries.
	Value *ObjectPreview `json:"value"`                  // Preview of the value.
}

type EvaluateParams struct {
	Expression                  string                `json:"expression"`                                     // Expression to evaluate.
	ObjectGroup                 string                `json:"objectGroup,omitempty,omitzero"`                 // Symbolic group name that can be used to release multiple objects.
	IncludeCommandLineAPI       *bool                 `json:"includeCommandLineAPI,omitempty,omitzero"`       // Determines whether Command Line API should be available during the evaluation.
	Silent                      *bool                 `json:"silent,omitempty,omitzero"`                      // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
	ContextID                   ExecutionContextID    `json:"contextId,omitempty,omitzero"`                   // Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page. This is mutually exclusive with uniqueContextId, which offers an alternative way to identify the execution context that is more reliable in a multi-process environment.
	ReturnByValue               *bool                 `json:"returnByValue,omitempty,omitzero"`               // Whether the result is expected to be a JSON object that should be sent by value.
	GeneratePreview             *bool                 `json:"generatePreview,omitempty,omitzero"`             // Whether preview should be generated for the result.
	UserGesture                 *bool                 `json:"userGesture,omitempty,omitzero"`                 // Whether execution should be treated as initiated by user in the UI.
	AwaitPromise                *bool                 `json:"awaitPromise,omitempty,omitzero"`                // Whether execution should await for resulting value and return once awaited promise is resolved.
	ThrowOnSideEffect           *bool                 `json:"throwOnSideEffect,omitempty,omitzero"`           // Whether to throw an exception if side effect cannot be ruled out during evaluation. This implies disableBreaks below.
	Timeout                     TimeDelta             `json:"timeout,omitempty,omitzero"`                     // Terminate execution after timing out (number of milliseconds).
	DisableBreaks               *bool                 `json:"disableBreaks,omitempty,omitzero"`               // Disable breakpoints during execution.
	ReplMode                    *bool                 `json:"replMode,omitempty,omitzero"`                    // Setting this flag to true enables let re-declaration and top-level await. Note that let variables can only be re-declared if they originate from replMode themselves.
	AllowUnsafeEvalBlockedByCSP *bool                 `json:"allowUnsafeEvalBlockedByCSP,omitempty,omitzero"` // The Content Security Policy (CSP) for the target might block 'unsafe-eval' which includes eval(), Function(), setTimeout() and setInterval() when called with non-callable arguments. This flag bypasses CSP for this evaluation and allows unsafe-eval. Defaults to true.
	UniqueContextID             string                `json:"uniqueContextId,omitempty,omitzero"`             // An alternative way to specify the execution context to evaluate in. Compared to contextId that may be reused across processes, this is guaranteed to be system-unique, so it can be used to prevent accidental evaluation of the expression in context different than intended (e.g. as a result of navigation across process boundaries). This is mutually exclusive with contextId.
	SerializationOptions        *SerializationOptions `json:"serializationOptions,omitempty,omitzero"`        // Specifies the result serialization. If provided, overrides generatePreview and returnByValue.
}

type EvaluateResult struct {
	Result           *RemoteObject     `json:"result,omitempty,omitzero"`           // Evaluation result.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"` // Exception details.
}

type EventBindingCalled struct {
	Name               string             `json:"name"`
	Payload            string             `json:"payload"`
	ExecutionContextID ExecutionContextID `json:"executionContextId"` // Identifier of the context where the call was made.
}

type EventConsoleAPICalled struct {
	Type               ConsoleAPICalledType `json:"type"`                          // Type of the call.
	Args               []*RemoteObject      `json:"args"`                          // Call arguments.
	ExecutionContextID ExecutionContextID   `json:"executionContextId"`            // Identifier of the context where the call was made.
	Timestamp          Timestamp            `json:"timestamp"`                     // Call timestamp.
	StackTrace         *StackTrace          `json:"stackTrace,omitempty,omitzero"` // Stack trace captured when the call was made. The async stack chain is automatically reported for the following call types: assert, error, trace, warning. For other types the async call chain can be retrieved using Debugger.getStackTrace and stackTrace.parentId field.
	Context            string               `json:"context,omitempty,omitzero"`    // Console context descriptor for calls on non-default console context (not console.*): 'anonymous#unique-logger-id' for call on unnamed context, 'name#unique-logger-id' for call on named context.
}

type EventExceptionRevoked struct {
	Reason      string `json:"reason"`      // Reason describing why exception was revoked.
	ExceptionID int64  `json:"exceptionId"` // The id of revoked exception, as reported in exceptionThrown.
}

type EventExceptionThrown struct {
	Timestamp        Timestamp         `json:"timestamp"` // Timestamp of the exception.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails"`
}

type EventExecutionContextCreated struct {
	Context *ExecutionContextDescription `json:"context"` // A newly created execution context.
}

type EventExecutionContextDestroyed struct {
	ExecutionContextUniqueID string `json:"executionContextUniqueId"` // Unique Id of the destroyed context
}

type EventExecutionContextsCleared struct{}

type EventInspectRequested struct {
	Object             *RemoteObject      `json:"object"`
	Hints              jsonv2.Value       `json:"hints"`
	ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty,omitzero"` // Identifier of the context where the call was made.
}

type ExceptionDetails struct {
	ExceptionID        int64              `json:"exceptionId"`                           // Exception id.
	Text               string             `json:"text"`                                  // Exception text, which should be used together with exception object when available.
	LineNumber         int64              `json:"lineNumber"`                            // Line number of the exception location (0-based).
	ColumnNumber       int64              `json:"columnNumber"`                          // Column number of the exception location (0-based).
	ScriptID           cdp.ScriptID       `json:"scriptId,omitempty,omitzero"`           // Script ID of the exception location.
	URL                string             `json:"url,omitempty,omitzero"`                // URL of the exception location, to be used when the script was not reported.
	StackTrace         *StackTrace        `json:"stackTrace,omitempty,omitzero"`         // JavaScript stack trace if available.
	Exception          *RemoteObject      `json:"exception,omitempty,omitzero"`          // Exception object if available.
	ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty,omitzero"` // Identifier of the context where exception happened.
	ExceptionMetaData  jsonv2.Value       `json:"exceptionMetaData,omitempty,omitzero"`
}

type ExecutionContextDescription struct {
	ID       ExecutionContextID `json:"id"`       // Unique id of the execution context. It can be used to specify in which execution context script evaluation should be performed.
	Origin   string             `json:"origin"`   // Execution context origin.
	Name     string             `json:"name"`     // Human readable name describing given context.
	UniqueID string             `json:"uniqueId"` // A system-unique execution context identifier. Unlike the id, this is unique across multiple processes, so can be reliably used to identify specific context while backend performs a cross-process navigation.
	AuxData  jsonv2.Value       `json:"auxData,omitempty,omitzero"`
}

type ExecutionContextID int64

type GetExceptionDetailsParams struct {
	ErrorObjectID RemoteObjectID `json:"errorObjectId"` // The error object for which to resolve the exception details.
}

type GetExceptionDetailsResult struct {
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"`
}

type GetHeapUsageResult struct {
	UsedSize             float64 `json:"usedSize,omitempty,omitzero"`             // Used JavaScript heap size in bytes.
	TotalSize            float64 `json:"totalSize,omitempty,omitzero"`            // Allocated JavaScript heap size in bytes.
	EmbedderHeapUsedSize float64 `json:"embedderHeapUsedSize,omitempty,omitzero"` // Used size in bytes in the embedder's garbage-collected heap.
	BackingStorageSize   float64 `json:"backingStorageSize,omitempty,omitzero"`   // Size in bytes of backing storage for array buffers and external strings.
}

type GetIsolateIDResult struct {
	ID string `json:"id,omitempty,omitzero"` // The isolate id.
}

type GetPropertiesParams struct {
	ObjectID                 RemoteObjectID `json:"objectId"`                                    // Identifier of the object to return properties for.
	OwnProperties            *bool          `json:"ownProperties,omitempty,omitzero"`            // If true, returns properties belonging only to the element itself, not to its prototype chain.
	AccessorPropertiesOnly   *bool          `json:"accessorPropertiesOnly,omitempty,omitzero"`   // If true, returns accessor properties (with getter/setter) only; internal properties are not returned either.
	GeneratePreview          *bool          `json:"generatePreview,omitempty,omitzero"`          // Whether preview should be generated for the results.
	NonIndexedPropertiesOnly *bool          `json:"nonIndexedPropertiesOnly,omitempty,omitzero"` // If true, returns non-indexed properties only.
}

type GetPropertiesResult struct {
	Result             []*PropertyDescriptor         `json:"result,omitempty,omitzero"`             // Object properties.
	InternalProperties []*InternalPropertyDescriptor `json:"internalProperties,omitempty,omitzero"` // Internal object properties (only of the element itself).
	PrivateProperties  []*PrivatePropertyDescriptor  `json:"privateProperties,omitempty,omitzero"`  // Object private properties.
	ExceptionDetails   *ExceptionDetails             `json:"exceptionDetails,omitempty,omitzero"`   // Exception details.
}

type GlobalLexicalScopeNamesParams struct {
	ExecutionContextID ExecutionContextID `json:"executionContextId,omitempty,omitzero"` // Specifies in which execution context to lookup global scope variables.
}

type GlobalLexicalScopeNamesResult struct {
	Names []string `json:"names,omitempty,omitzero"`
}

type InternalPropertyDescriptor struct {
	Name  string        `json:"name"`                     // Conventional property name.
	Value *RemoteObject `json:"value,omitempty,omitzero"` // The value associated with the property.
}

type ObjectPreview struct {
	Type        ObjectPreviewType    `json:"type"`                           // Object type.
	Subtype     ObjectPreviewSubtype `json:"subtype,omitempty,omitzero"`     // Object subtype hint. Specified for object type values only.
	Description string               `json:"description,omitempty,omitzero"` // String representation of the object.
	Overflow    bool                 `json:"overflow"`                       // True iff some of the properties or entries of the original object did not fit.
	Properties  []*PropertyPreview   `json:"properties"`                     // List of the properties.
	Entries     []*EntryPreview      `json:"entries,omitempty,omitzero"`     // List of the entries. Specified for map and set subtype values only.
}

type ObjectPreviewSubtype string

type ObjectPreviewType string

type PrivatePropertyDescriptor struct {
	Name  string        `json:"name"`                     // Private property name.
	Value *RemoteObject `json:"value,omitempty,omitzero"` // The value associated with the private property.
	Get   *RemoteObject `json:"get,omitempty,omitzero"`   // A function which serves as a getter for the private property, or undefined if there is no getter (accessor descriptors only).
	Set   *RemoteObject `json:"set,omitempty,omitzero"`   // A function which serves as a setter for the private property, or undefined if there is no setter (accessor descriptors only).
}

type PropertyDescriptor struct {
	Name         string        `json:"name"`                      // Property name or symbol description.
	Value        *RemoteObject `json:"value,omitempty,omitzero"`  // The value associated with the property.
	Writable     bool          `json:"writable"`                  // True if the value associated with the property may be changed (data descriptors only).
	Get          *RemoteObject `json:"get,omitempty,omitzero"`    // A function which serves as a getter for the property, or undefined if there is no getter (accessor descriptors only).
	Set          *RemoteObject `json:"set,omitempty,omitzero"`    // A function which serves as a setter for the property, or undefined if there is no setter (accessor descriptors only).
	Configurable bool          `json:"configurable"`              // True if the type of this property descriptor may be changed and if the property may be deleted from the corresponding object.
	Enumerable   bool          `json:"enumerable"`                // True if this property shows up during enumeration of the properties on the corresponding object.
	WasThrown    bool          `json:"wasThrown"`                 // True if the result was thrown during the evaluation.
	IsOwn        bool          `json:"isOwn"`                     // True if the property is owned for the object.
	Symbol       *RemoteObject `json:"symbol,omitempty,omitzero"` // Property symbol object, if the property is of the symbol type.
}

type PropertyPreview struct {
	Name         string                 `json:"name"`                            // Property name.
	Type         PropertyPreviewType    `json:"type"`                            // Object type. Accessor means that the property itself is an accessor property.
	Value        string                 `json:"value,omitempty,omitzero"`        // User-friendly property value string.
	ValuePreview *ObjectPreview         `json:"valuePreview,omitempty,omitzero"` // Nested value preview.
	Subtype      PropertyPreviewSubtype `json:"subtype,omitempty,omitzero"`      // Object subtype hint. Specified for object type values only.
}

type PropertyPreviewSubtype string

type PropertyPreviewType string

type QueryObjectsParams struct {
	PrototypeObjectID RemoteObjectID `json:"prototypeObjectId"`              // Identifier of the prototype to return objects for.
	ObjectGroup       string         `json:"objectGroup,omitempty,omitzero"` // Symbolic group name that can be used to release the results.
}

type QueryObjectsResult struct {
	Objects *RemoteObject `json:"objects,omitempty,omitzero"` // Array with objects.
}

type ReleaseObjectGroupParams struct {
	ObjectGroup string `json:"objectGroup"` // Symbolic object group name.
}

type ReleaseObjectParams struct {
	ObjectID RemoteObjectID `json:"objectId"` // Identifier of the object to release.
}

type RemoteObject struct {
	Type                RemoteObjectType     `json:"type"`                                   // Object type.
	Subtype             RemoteObjectSubtype  `json:"subtype,omitempty,omitzero"`             // Object subtype hint. Specified for object type values only. NOTE: If you change anything here, make sure to also update subtype in ObjectPreview and PropertyPreview below.
	ClassName           string               `json:"className,omitempty,omitzero"`           // Object class (constructor) name. Specified for object type values only.
	Value               jsonv2.Value         `json:"value,omitempty,omitzero"`               // Remote object value in case of primitive values or JSON values (if it was requested).
	UnserializableValue UnserializableValue  `json:"unserializableValue,omitempty,omitzero"` // Primitive value which can not be JSON-stringified does not have value, but gets this property.
	Description         string               `json:"description,omitempty,omitzero"`         // String representation of the object.
	DeepSerializedValue *DeepSerializedValue `json:"deepSerializedValue,omitempty,omitzero"` // Deep serialized value.
	ObjectID            RemoteObjectID       `json:"objectId,omitempty,omitzero"`            // Unique object identifier (for non-primitive values).
	Preview             *ObjectPreview       `json:"preview,omitempty,omitzero"`             // Preview containing abbreviated property values. Specified for object type values only.
	CustomPreview       *CustomPreview       `json:"customPreview,omitempty,omitzero"`
}

type RemoteObjectID string

type RemoteObjectSubtype string

type RemoteObjectType string

type RemoveBindingParams struct {
	Name string `json:"name"`
}

type RunScriptParams struct {
	ScriptID              cdp.ScriptID       `json:"scriptId"`                                 // Id of the script to run.
	ExecutionContextID    ExecutionContextID `json:"executionContextId,omitempty,omitzero"`    // Specifies in which execution context to perform script run. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
	ObjectGroup           string             `json:"objectGroup,omitempty,omitzero"`           // Symbolic group name that can be used to release multiple objects.
	Silent                *bool              `json:"silent,omitempty,omitzero"`                // In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
	IncludeCommandLineAPI *bool              `json:"includeCommandLineAPI,omitempty,omitzero"` // Determines whether Command Line API should be available during the evaluation.
	ReturnByValue         *bool              `json:"returnByValue,omitempty,omitzero"`         // Whether the result is expected to be a JSON object which should be sent by value.
	GeneratePreview       *bool              `json:"generatePreview,omitempty,omitzero"`       // Whether preview should be generated for the result.
	AwaitPromise          *bool              `json:"awaitPromise,omitempty,omitzero"`          // Whether execution should await for resulting value and return once awaited promise is resolved.
}

type RunScriptResult struct {
	Result           *RemoteObject     `json:"result,omitempty,omitzero"`           // Run result.
	ExceptionDetails *ExceptionDetails `json:"exceptionDetails,omitempty,omitzero"` // Exception details.
}

type SerializationOptions struct {
	Serialization        SerializationOptionsSerialization `json:"serialization"`
	MaxDepth             *int64                            `json:"maxDepth,omitempty,omitzero"` // Deep serialization depth. Default is full depth. Respected only in deep serialization mode.
	AdditionalParameters jsonv2.Value                      `json:"additionalParameters,omitempty,omitzero"`
}

type SerializationOptionsSerialization string

type SetCustomObjectFormatterEnabledParams struct {
	Enabled bool `json:"enabled"`
}

type SetMaxCallStackSizeToCaptureParams struct {
	Size int64 `json:"size"`
}

type StackTrace struct {
	Description string        `json:"description,omitempty,omitzero"` // String label of this stack trace. For async traces this may be a name of the function that initiated the async call.
	CallFrames  []*CallFrame  `json:"callFrames"`                     // JavaScript function name.
	Parent      *StackTrace   `json:"parent,omitempty,omitzero"`      // Asynchronous JavaScript stack trace that preceded this stack, if available.
	ParentID    *StackTraceID `json:"parentId,omitempty,omitzero"`    // Asynchronous JavaScript stack trace that preceded this stack, if available.
}

type StackTraceID struct {
	ID         string               `json:"id"`
	DebuggerID cdp.UniqueDebuggerID `json:"debuggerId,omitempty,omitzero"`
}

type TimeDelta float64

type Timestamp float64

type UnserializableValue string