All application state is managed by a top level ImmutableJS object. Child components should not modify top level state directly, instead they should call into an action which will dispatch a message to the store to make any such changes.
AppStore
{
firstRunTimestamp: integer,
extensions: {
[id]: { // the unique id of the extension
id: string,
base_path: string,
description: string,
enabled: boolean,
manifest: object,
browserAction: {
title: string,
popup: string,
icon: string/object
},
tabs: {
[tabId]: {
browserAction: {} // tab specific browser action properties
}
}
}
},
sites: [{
location: string,
title: string,
customTitle: string, // User provided title for bookmark; overrides title
tags: [string], // empty, 'bookmark', 'bookmark-folder', 'pinned', or 'reader'
favicon: string, // URL of the favicon
themeColor: string, // css compatible color string
lastAccessedTime: number, // datetime.getTime()
partitionNumber: number, // Optionally specifies a specific session
folderId: number, // Set for bookmark folders only
parentFolderId: number // Set for bookmarks and bookmark folders only
}],
downloads: [{
[downloadId]: {
startTime: number, // datetime.getTime()
filename: string,
savePath: string,
url: string,
totalBytes: Number,
receivedBytes: Number,
state: string // One of: 'pending', 'in-progress', 'completed', 'cancelled', 'interrupted'
}
}],
siteSettings: {
[hostPattern]: {
zoomLevel: number,
mediaPermission: boolean,
geolocationPermission: boolean,
notificationsPermission: boolean,
midiSysexPermission: boolean,
pointerLockPermission: boolean,
fullscreenPermission: boolean,
openExternalPermission: boolean,
protocolRegistrationPermission: boolean,
savePasswords: boolean, // Only false or undefined/null
shieldsUp: boolean,
adControl: string, // (showBraveAds | blockAds | allowAdsAndTracking)
cookieControl: string, // (block3rdPartyCookie | allowAllCookies)
safeBrowsing: boolean,
noScript: (number|boolean), // true = block scripts, false = allow, 0 = allow once, 1 = allow until restart
httpsEverywhere: boolean,
fingerprintingProtection: boolean,
flash: (number|boolean), // approval expiration time if allowed, false if never allow
ledgerPayments: boolean, // False if site should not be paid by the ledger. Defaults to true.
ledgerPaymentsShown: boolean, // False if site should not be paid by the ledger and should not be shown in the UI. Defaults to true.
runInsecureContent: boolean // Allow active mixed content
}
},
temporarySiteSettings: {
// Same as above but never gets written to disk
// XXX: This was intended for Private Browsing but is currently unused.
},
visits: [{
location: string,
startTime: number, // datetime.getTime()
endTime: number // datetime.getTime()
}],
passwords: [{
origin: string, // origin of the form
action: string, // URL of the form action
username: string,
encryptedPassword: string, // encrypted by master password, binary-encoded
authTag: string, // AES-GCM authentication data, binary-encoded
iv: string // AES-GCM initialization vector, binary-encoded
}],
// resourceIdentifier is one of: `adblock`, `safeBrowsing`, `trackingProtection`,
// `httpsEverywhere`, or another additional resource by name such as
// adblock regional resource files.
[resourceIdentifier]: {
etag: string, // last downloaded data file etag
lastCheckVersion: string, // last checked data file version
lastCheckDate: number, // last checked data file date.getTime()
enabled: boolean, // Enable the resource
count: number // Number of blocked ads application wide
},
adInsertion: {
enabled: boolean // Enable ad insertion
},
cookieblock: {
enabled: boolean // Enable 3p cookie/referer blocking
},
noScript: {
enabled: boolean // Enable noscript
},
flash: {
enabled: boolean // Enable flash
},
defaultWindowHeight: number,
defaultWindowWidth: number,
updates: {
status: string, // UpdateStatus from js/constants/updateStatus.js
metadata: {
name: string, // Name of the update
notes: string, // Release notes for the active update
},
verbose: boolean, // Whether to show update UI for checking, downloading, and errors
lastCheckTimestamp: boolean
},
notifications: [{
message: string,
buttons: [{
text: string, // button text
className: string, // button class e.g. 'primary'. see notificationBar.less
}],
frameOrigin: (string|undefined), // origin that the notification is from, or undefined if not applicable.
options: {
advancedText: string, // more info text
advancedLink: string, // more info link URL
persist: boolean, // whether to show a 'Remember this decision' checkbox
style: string // css class for notification bar. See notificationBar.less
}
}], // the notifications for the frame. not preserved across restart.
settings: [{
// See defaults in js/constants/appConfig.js
'general.startup-mode': string, // One of: lastTime, homePage, newTabPage
'general.homepage': string, // URL of the user's homepage
'general.show-home-button': boolean, // true if the home button should be shown
'general.useragent.value': (undefined|string), // custom user agent value
'general.downloads.default-save-path': string, // default path for saving files
'general.autohide-menu': boolean, // true if the Windows menu should be autohidden
'general.disable-title-mode': boolean, // true if title mode should always be disabled
'search.default-search-engine': string, // name of search engine, from js/data/searchProviders.js
'search.offer-search-suggestions': boolean, // true if suggestions should be offered from the default search engine when available.
'tabs.switch-to-new-tabs': boolean, // true if newly opened tabs should be focused immediately
'tabs.paint-tabs': boolean, // true if the page theme color and favicon color should be used for tabs
'tabs.tabs-per-page': number, // Number of tabs per tab page
'tabs.show-tab-previews': boolean, // True to show tab previews
'privacy.history-suggestions': boolean, // Auto suggest for history enabled
'privacy.bookmark-suggestions': boolean, // Auto suggest for bookmarks enabled
'privacy.opened-tab-suggestions': boolean, // Auto suggest for opened tabs enabled
'privacy.autocomplete.history-size': number, // Number of autocomplete entries to keep
'privacy.do-not-track': boolean, // whether DNT is 1
'privacy.block-canvas-fingerprinting': boolean, // Canvas fingerprinting defense
'privacy.autofill-enabled': boolean, // true to enable autofill
'security.passwords.manager-enabled': boolean, // whether to use default password manager
'security.passwords.one-password-enabled': boolean, // true if the 1Password extension should be enabled
'security.passwords.dashlane-enabled': boolean, // true if the Dashlane extension should be enabled
'bookmarks.toolbar.show': boolean, // true if the bookmakrs toolbar should be shown
'bookmarks.toolbar.showFavicon': boolean, // true if bookmark favicons should be shown on the bookmarks toolbar
'bookmarks.toolbar.showOnlyFavicon': boolean, // true if only favicons should be shown on the bookmarks toolbar
'general.language': string, // The language code to use for localization and spell check or null to use the system default
'payments.enabled': boolean, // true if the Payments pane is active
'payments.contribution-amount': number, // in USD
'advanced.hardware-acceleration-enabled': boolean, // false if hardware acceleration should be explicitly disabled
'advanced.default-zoom-level': number, // the default zoom level for sites that have no specific setting
'advanced.pdfjs-enabled': boolean, // Whether or not to render PDF documents in the browser
'advanced.smooth-scroll-enabled': boolean, // false if smooth scrolling should be explicitly disabled
'shutdown.clear-history': boolean, // true to clear history on shutdown
'shutdown.clear-downloads': boolean, // true to clear downloads on shutdown
'shutdown.clear-cache': boolean, // true to clear cache on shutdown
'shutdown.clear-all-site-cookies': boolean, // true to clear all site cookies on shutdown
'adblock.customRules': string, // custom rules in ABP filter syntax
}],
dictionary: {
locale: string, // en_US, en, or any other locale string
ignoredWords: Array<string>, // List of words to ignore
addedWords: Array<string> // List of words to add to the dictionary
},
autofill: {
addresses: {
guid: Array<string>, // List of id used to access the autofill entry in database
timestamp: number
},
creditCards: {
guid: Array<string>, // List of id used to access the autofill entry in database
timestamp: number
}
},
about: {
newtab: {
gridLayout: string // 'small', 'medium', 'large'
}
},
menu: {
template: object // used on Windows and by our tests: template object with Menubar control
}
}WindowStore
{
activeFrameKey: number,
previewFrameKey: number,
tabs: [{
themeColor: string, // css compatible color string
computedThemeColor: string, // css computed theme color from the favicon
icon: string, // favicon url
audioPlaybackActive: boolean, // frame is playing audio
audioMuted: boolean, // frame is muted
title: string, // page title
isPrivate: boolean, // private browsing tab
partitionNumber: number, // the session partition to use
pinnedLocation: string, // Indicates if a frame is pinned and its pin location
provisionalLocation: string,
icon: string, // favicon url
location: string, // The currently navigated location
loading: boolean,
frameKey: number
}],
frames: [{
audioMuted: boolean, // frame is muted
audioPlaybackActive: boolean, // frame is playing audio
canGoBack: boolean,
canGoForward: boolean,
icon: string, // favicon url
location: string, // The currently navigated location
src: string, // The iframe src attribute
pinnedLocation: string, // Indicates if a frame is pinned and its pin location
title: string, // page title
findbarShown: boolean, // whether the findbar is shown
findbarSelected: boolean, // findbar text input is selected
hrefPreview: string, // show hovered link preview
key: number,
isPrivate: boolean, // private browsing tab
partitionNumber: number, // the session partition to use
loading: boolean,
themeColor: string, // css compatible color string
computedThemeColor: string, // css computed theme color from the favicon
isFullScreen: boolean, // true if the frame should be shown as full screen
showFullScreenWarning: boolean, // true if a warning should be shown about full screen
startLoadTime: datetime,
endtLoadTime: datetime,
guestInstanceId: string, // not persisted
tabId: number, // session tab id not persisted
closedAtIndex: number, // Index the frame was last closed at, cleared unless the frame is inside of closedFrames
activeShortcut: string, // Set by the application store when the component should react to a shortcut
activeShortcutDetails: object, // Additional parameters for the active shortcut action if any
lastZoomPercentage: number, // Last value that was used for zooming
adblock: {
blocked: Array<string>
},
trackingProtection: {
blocked: Array<string>
},
httpsEverywhere: Object.<string, Array.<string>>, // map of XML rulesets name to redirected resources
noScript: {
blocked: Array<string>
},
fingerprintingProtection: {
blocked: Array<string>
},
provisionalLocation: string,
security: {
isSecure: boolean, // is using https
loginRequiredDetail: {
isProxy: boolean,
host: string,
port: number,
realm: string
},
isExtendedValidation: boolean, // is using https ev
runInsecureContent: boolean, // has active mixed content
blockedRunInsecureContent: Array<string> // sources of blocked active mixed content
},
parentFrameKey: number, // the key of the frame this frame was opened from
modalPromptDetail: {...},
basicAuthDetail: {...},
findDetail: {
searchString: string, // the string being searched
caseSensitivity: boolean, // whether we are doing a case sensitive search
numberOfMatches: number, // Total number of matches on the page
activeMatchOrdinal: number, // The current ordinal of the match
internalFindStatePresent: boolean // true if a find-first (ie findNext: false) call has been made
}
unloaded: boolean, // true if the tab is unloaded
navbar: {
focused: boolean, // whether the navbar is focused
urlbar: {
location: string, // the string displayed in the urlbar
urlPreview: string,
suggestions: {
selectedIndex: number, // index of the item in focus
searchResults: array, // autocomplete server results if enabled
suggestionList: {
title: string, // The title of the autocomplete entry
location: string, // The location represented by the autocomplete entry
onClick: function, // The onClick handler for suggestion clicks (e.g. URL load or tab switch)
type: string // The type of suggestion (one of js/constants/suggestionTypes.js)
},
urlSuffix: string, // autocomplete suffix
autocompleteEnabled: boolean // used to enable or disable autocomplete
},
focused: boolean, // whether the urlbar is focused
active: boolean, // whether the user is typing in the urlbar
selected: boolean // is the urlbar text selected
}
},
aboutDetails: object, // details for about pages
history: array // navigation history
}],
closedFrames: [], // holds the same type of frame objects as above
ui: {
isMaximized: boolean, // true if window is maximized
position: array, // last known window position [x, y]
size: array, // last known window size [x, y]
isFullScreen: boolean, // true if window is fullscreen
mouseInTitlebar: boolean, //Whether or not the mouse is in the titlebar
dragging: {
dragType: string, // tab, bookmark
draggingOver: {
draggingOverLeft: boolean,
draggingOverRight: boolean,
dragKey: any,
dragType: string
}
},
tabs: {
tabPageIndex: number, // Index of the current tab page
previewTabPageIndex: number // Index of the tab being previewed
},
siteInfo: {
isVisible: boolean // Whether or not to show site info like # of blocked ads
},
noScriptInfo: {
isVisible: boolean, // Whether the noscript infobox is visible
},
downloadsToolbar: {
isVisible: boolean, // Whether or not the downloads toolbar is visible
},
releaseNotes: {
isVisible: boolean, // Whether or not to show release notes
},
menubar: { // windows only
isVisible: boolean, // true if Menubar control is visible
selectedIndex: Array<number>, // indices of the selected menu item(s) (or null for none selected)
lastFocusedSelector: string // selector for the last selected element (browser ui, not frame content)
},
bookmarksToolbar: {
selectedFolderId: number // folderId from the siteDetail of the currently expanded folder
}
},
searchDetail: {
searchURL: string, // with replacement var in string: {searchTerms}
autocompleteURL: string, // ditto re: {searchTerms}
},
bookmarkDetail: {
currentDetail: Object, // Detail of the current bookmark which is in add/edit mode
originalDetails: Object // Detail of the original bookmark to edit
},
braveryPanelDetail: {
advancedControls: boolean, // If specified, indicates if advanced controls should be shown
expandAdblock: boolean, // If specified, indicates if the tracking protection and adblock section should be expanded
expandHttpse: boolean, // If specified, indicates if the httpse section should be expanded
expandNoScript: boolean, // Whether noscript section should be expanded
expandFp: boolean // Whether fingerprinting protection should be expanded
},
clearBrowsingDataDetail: {
browserHistory: boolean,
downloadHistory: boolean,
cachedImagesAndFiles: boolean,
savedPasswords: boolean,
allSiteCookies: boolean
},
contextMenuDetail: {
left: number, // the left position of the context menu
right: number, // the right position of the context menu
top: number, // the top position of the context menu
bottom: number, // the bottom position of the context menu
maxHeight: number, // the maximum height of the context menu
template: [{
label: string, // label of context menu item
click: function, // callback for the context menu to call when clicked
dragOver: function, // callback for when something is dragged over this item
drop: function, // callback for when something is dropped on this item
}],
openedSubmenuDetails: [{
y: number, // the relative y position
template: [
// per above
]
}]
},
popupWindowDetail: {
left: number, // the left position of the popup window
right: number, // the right position of the popup window
top: number, // the top position of the popup window
bottom: number, // the bottom position of the popup window
maxHeight: number, // the maximum height of the popup window
src: string, // the src for the popup window webview
},
flashInitialized: boolean, // Whether flash was initialized successfully. Cleared on shutdown.
cleanedOnShutdown: boolean, // whether app data was successfully cleared on shutdown
lastAppVersion: string, // Version of the last file that was saved
ledgerInfo: {
creating: boolean, // wallet is being created
created: boolean, // wallet is created
reconcileStamp: number, // timestamp for the next reconcilation
transactions: [ { // contributions reconciling/reconciled
viewingId: string, // UUIDv4 for this contribution
contribution: { //
fiat: { // roughly-equivalent fiat amount
amount: number, // e.g., 5
currency: string // e.g., "USD"
},
rates: { // exchange rate
[currency]: number // e.g., { "USD": 575.45 }
},
satoshis: number, // actual number of satoshis transferred
fee: number // bitcoin transaction fee
},
submissionStamp: number, // timestamp for this contribution
count: number, // total number of ballots allowed to be cast
ballots: { // number of ballots cast for each publisher
[publisher]: number // e.g., "wikipedia.org": 3
}
} ],
address: string, // the BTC wallet address (in base58)
passphrase: string, // the BTC wallet passphrase
balance: string, // confirmed balance in BTC.toFixed(4)
unconfirmed: string, // unconfirmed balance in BTC.toFixed(4)
satoshis: number, // confirmed balance as an integer number of satoshis
btc: string, // BTC to contribute per reconciliation period
amount: number, // fiat amount to contribute per reconciliation period
currency: string, // fiat currency denominating the amount
paymentURL: string, // bitcoin:...?amount={btc}&label=Brave%20Software
buyURL: string, // URL to buy bitcoin using debit/credit card
bravery: { // values round-tripped through the ledger-client
fee: {
amount: number, // set from `amount` above
currency: string // set from `currency` above
}
},
hasBitcoinHandler: boolean, // brave browser has a `bitcoin:` URI handler
countryCode: string, // ISO3166 2-letter code for country of browser's location
exchangeInfo: { // information about the corresponding "friendliest" BTC exchange (suggestions welcome!)
exchangeName: string, // the name of the BTC exchange
exchangeURL: string // the URL of the BTC exchange
},
paymentIMG: string, // the QR code equivalent of `paymentURL` expressed as "data:image/...;base64,..."
error: { // non-null if the last updateLedgerInfo happened concurrently with an error
caller: string // function in which error was handled
error: object // error object returned
}
},
publisherInfo: [ // one entry for each publisher having a non-zero `score`
{
rank: number, // i.e., 1, 2, 3, ...
verified: boolean, // there is a verified wallet for this publisher
site: string, // publisher name, e.g., "wikipedia.org"
views: number, // total page-views
duration: number, // total millisecond-views, e.g., 93784000 = 1 day, 2 hours, 3 minutes, 4 seconds
daysSpent: number, // e.g., 1
hoursSpent: number, // e.g., 2
minutesSpent: number, // e.g., 3
secondsSpent: number, // e.g., 4
score: number, // float indicating the current score
percentage: number, // i.e., 0, 1, ... 100
publisherURL: string, // publisher site, e.g., "https://wikipedia.org/"
faviconURL: string // i.e., "data:image/...;base64,..."
}
],
autofillAddressDetail: {
name: string,
organization: string,
streetAddress: string,
city: string,
state: string,
postalCode: string,
country: string,
phone: string,
email: string,
guid: string // id used to access the autofill entry in database
},
autofillCreditCardDetail: {
name: string,
card: string,
month: string,
year: string,
guid: string // id used to access the autofill entry in database
},
importBrowserDataDetail: [
{
index: string,
type: number,
name: string,
history: boolean,
favorites: boolean,
cookies: boolean
}
],
importBrowserDataSelected: {
index: string,
type: number,
history: boolean,
favorites: boolean,
mergeFavorites: boolean,
cookies: boolean
}
}