This was auto-generated by the 'npm run schema' command. It uses JSON schema files located in the 'schema' folder

The 'Interfaces' listed below can be used to document API boundaries where JSON is sent/received to the various platforms. They all have a corresponding Zod parser that can be used in runtime code to verify incoming/outgoing data.

For example, RequestData is used by all platforms to describe the minimum amount of data required by the Privacy Dashboard - it's parser can be imported from 'schema/generated/schema.parsers.js' and used to validate incoming Tracker data.

Interfaces

API
BreakageReport
BreakageReportRequest
CategorySelected
CategoryTypeSelected
CloseMessageParams
CookiePromptManagementStatus
DetectedRequest
EmailProtectionUserData
EventOrigin
ExtensionMessageGetPrivacyDashboardData
ExtensionMessageSetListOptions
FireButton
FireButtonData
FireOption
GetPrivacyDashboardData
IncomingClosePopup
IncomingDidResetTrackersData
IncomingResponse
IncomingToggleReport
IncomingUpdateTabData
LocaleSettings
MaliciousSiteStatus
OutgoingExtensionMessage
ParentEntity
PrimaryScreen
ProtectionsStatus
RefreshAliasResponse
RemoteFeatureSettings
RequestData
Search
SetListOptions
SetProtectionParams
SiteUrlAdditionalData
StateAllowed
StateBlocked
Tab
TelemetrySpan
ToggleReportScreen
ToggleReportScreenDataItem
ToggleSkipped
WebBreakageForm
WindowsIncomingToggleReportOptions
WindowsIncomingViewModel
WindowsIncomingVisibility
WindowsViewModel

Type Aliases

AdClickAttributionReason
AppVersion
ATB
DataItemId
Description
Device
DidOpenReportInfo
ErrorDescriptions
ExtensionVersion
Features
HTTPErrorCodes
IncomingExtensionMessage
JSPerformance
LastSentDay
ListVersions
Locale
OpenerContext
OS
OtherThirdPartyRequestReason
OwnedByFirstPartyReason
ProtectionsDisabledReason
ReportFlow
Requests
RuleExceptionReason
ScreenKind
SiteURL
ToggleReportCounter
UserRefreshCount
WindowsIncomingMessage
WVVersion