*Merge in @types package
This commit is contained in:
parent
1f7f73c23b
commit
9ee7c32ed0
|
@ -3,6 +3,7 @@
|
||||||
"version": "0.8.0",
|
"version": "0.8.0",
|
||||||
"description": "A lightweight polyfill library for Promise-based WebExtension APIs in Chrome.",
|
"description": "A lightweight polyfill library for Promise-based WebExtension APIs in Chrome.",
|
||||||
"main": "src/browser-polyfill.js",
|
"main": "src/browser-polyfill.js",
|
||||||
|
"types": "types/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
"dist"
|
"dist"
|
||||||
],
|
],
|
||||||
|
|
|
@ -0,0 +1,240 @@
|
||||||
|
// Type definitions for webextension-polyfill 0.8
|
||||||
|
// Project: https://github.com/mozilla/webextension-polyfill
|
||||||
|
// Definitions by: Santo Pfingsten <https://github.com/Lusito>
|
||||||
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||||
|
// Generated using https://github.com/Lusito/webextension-polyfill-ts
|
||||||
|
|
||||||
|
// Generated from Mozilla sources. Do not manually edit!
|
||||||
|
|
||||||
|
import { ActivityLog as ImportedActivityLog } from "./namespaces/activityLog";
|
||||||
|
import { Alarms as ImportedAlarms } from "./namespaces/alarms";
|
||||||
|
import { Bookmarks as ImportedBookmarks } from "./namespaces/bookmarks";
|
||||||
|
import { Action as ImportedAction } from "./namespaces/action";
|
||||||
|
import { BrowserAction as ImportedBrowserAction } from "./namespaces/browserAction";
|
||||||
|
import { BrowserSettings as ImportedBrowserSettings } from "./namespaces/browserSettings";
|
||||||
|
import { BrowsingData as ImportedBrowsingData } from "./namespaces/browsingData";
|
||||||
|
import { CaptivePortal as ImportedCaptivePortal } from "./namespaces/captivePortal";
|
||||||
|
import { Clipboard as ImportedClipboard } from "./namespaces/clipboard";
|
||||||
|
import { Commands as ImportedCommands } from "./namespaces/commands";
|
||||||
|
import { ContentScripts as ImportedContentScripts } from "./namespaces/contentScripts";
|
||||||
|
import { ContextualIdentities as ImportedContextualIdentities } from "./namespaces/contextualIdentities";
|
||||||
|
import { Cookies as ImportedCookies } from "./namespaces/cookies";
|
||||||
|
import { DeclarativeContent as ImportedDeclarativeContent } from "./namespaces/declarativeContent";
|
||||||
|
import { Devtools as ImportedDevtools } from "./namespaces/devtools";
|
||||||
|
import { Dns as ImportedDns } from "./namespaces/dns";
|
||||||
|
import { Downloads as ImportedDownloads } from "./namespaces/downloads";
|
||||||
|
import { Events as ImportedEvents } from "./namespaces/events";
|
||||||
|
import { Experiments as ImportedExperiments } from "./namespaces/experiments";
|
||||||
|
import { Extension as ImportedExtension } from "./namespaces/extension";
|
||||||
|
import { ExtensionTypes as ImportedExtensionTypes } from "./namespaces/extensionTypes";
|
||||||
|
import { Find as ImportedFind } from "./namespaces/find";
|
||||||
|
import { GeckoProfiler as ImportedGeckoProfiler } from "./namespaces/geckoProfiler";
|
||||||
|
import { History as ImportedHistory } from "./namespaces/history";
|
||||||
|
import { I18n as ImportedI18n } from "./namespaces/i18n";
|
||||||
|
import { Identity as ImportedIdentity } from "./namespaces/identity";
|
||||||
|
import { Idle as ImportedIdle } from "./namespaces/idle";
|
||||||
|
import { Management as ImportedManagement } from "./namespaces/management";
|
||||||
|
import { Manifest as ImportedManifest } from "./namespaces/manifest";
|
||||||
|
import { ContextMenus as ImportedContextMenus } from "./namespaces/contextMenus";
|
||||||
|
import { Menus as ImportedMenus } from "./namespaces/menus";
|
||||||
|
import { NetworkStatus as ImportedNetworkStatus } from "./namespaces/networkStatus";
|
||||||
|
import { NormandyAddonStudy as ImportedNormandyAddonStudy } from "./namespaces/normandyAddonStudy";
|
||||||
|
import { Notifications as ImportedNotifications } from "./namespaces/notifications";
|
||||||
|
import { Omnibox as ImportedOmnibox } from "./namespaces/omnibox";
|
||||||
|
import { PageAction as ImportedPageAction } from "./namespaces/pageAction";
|
||||||
|
import { Permissions as ImportedPermissions } from "./namespaces/permissions";
|
||||||
|
import { Pkcs11 as ImportedPkcs11 } from "./namespaces/pkcs11";
|
||||||
|
import { Privacy as ImportedPrivacy } from "./namespaces/privacy";
|
||||||
|
import { Proxy as ImportedProxy } from "./namespaces/proxy";
|
||||||
|
import { Runtime as ImportedRuntime } from "./namespaces/runtime";
|
||||||
|
import { Scripting as ImportedScripting } from "./namespaces/scripting";
|
||||||
|
import { Search as ImportedSearch } from "./namespaces/search";
|
||||||
|
import { Sessions as ImportedSessions } from "./namespaces/sessions";
|
||||||
|
import { SidebarAction as ImportedSidebarAction } from "./namespaces/sidebarAction";
|
||||||
|
import { Storage as ImportedStorage } from "./namespaces/storage";
|
||||||
|
import { Tabs as ImportedTabs } from "./namespaces/tabs";
|
||||||
|
import { Theme as ImportedTheme } from "./namespaces/theme";
|
||||||
|
import { TopSites as ImportedTopSites } from "./namespaces/topSites";
|
||||||
|
import { Types as ImportedTypes } from "./namespaces/types";
|
||||||
|
import { Urlbar as ImportedUrlbar } from "./namespaces/urlbar";
|
||||||
|
import { UserScripts as ImportedUserScripts } from "./namespaces/userScripts";
|
||||||
|
import { WebNavigation as ImportedWebNavigation } from "./namespaces/webNavigation";
|
||||||
|
import { WebRequest as ImportedWebRequest } from "./namespaces/webRequest";
|
||||||
|
import { Windows as ImportedWindows } from "./namespaces/windows";
|
||||||
|
|
||||||
|
declare namespace Browser {
|
||||||
|
const activityLog: ActivityLog.Static;
|
||||||
|
const alarms: Alarms.Static;
|
||||||
|
const bookmarks: Bookmarks.Static;
|
||||||
|
const action: Action.Static;
|
||||||
|
const browserAction: BrowserAction.Static;
|
||||||
|
const browserSettings: BrowserSettings.Static;
|
||||||
|
const browsingData: BrowsingData.Static;
|
||||||
|
const captivePortal: CaptivePortal.Static;
|
||||||
|
const clipboard: Clipboard.Static;
|
||||||
|
const commands: Commands.Static;
|
||||||
|
const contentScripts: ContentScripts.Static;
|
||||||
|
const contextualIdentities: ContextualIdentities.Static;
|
||||||
|
const cookies: Cookies.Static;
|
||||||
|
const declarativeContent: DeclarativeContent.Static;
|
||||||
|
const devtools: Devtools.Static;
|
||||||
|
const dns: Dns.Static;
|
||||||
|
const downloads: Downloads.Static;
|
||||||
|
const events: Events.Static;
|
||||||
|
const experiments: Experiments.Static;
|
||||||
|
const extension: Extension.Static;
|
||||||
|
const extensionTypes: ExtensionTypes.Static;
|
||||||
|
const find: Find.Static;
|
||||||
|
const geckoProfiler: GeckoProfiler.Static;
|
||||||
|
const history: History.Static;
|
||||||
|
const i18n: I18n.Static;
|
||||||
|
const identity: Identity.Static;
|
||||||
|
const idle: Idle.Static;
|
||||||
|
const management: Management.Static;
|
||||||
|
const manifest: Manifest.Static;
|
||||||
|
const contextMenus: ContextMenus.Static;
|
||||||
|
const menus: Menus.Static;
|
||||||
|
const networkStatus: NetworkStatus.Static;
|
||||||
|
const normandyAddonStudy: NormandyAddonStudy.Static;
|
||||||
|
const notifications: Notifications.Static;
|
||||||
|
const omnibox: Omnibox.Static;
|
||||||
|
const pageAction: PageAction.Static;
|
||||||
|
const permissions: Permissions.Static;
|
||||||
|
const pkcs11: Pkcs11.Static;
|
||||||
|
const privacy: Privacy.Static;
|
||||||
|
const proxy: Proxy.Static;
|
||||||
|
const runtime: Runtime.Static;
|
||||||
|
const scripting: Scripting.Static;
|
||||||
|
const search: Search.Static;
|
||||||
|
const sessions: Sessions.Static;
|
||||||
|
const sidebarAction: SidebarAction.Static;
|
||||||
|
const storage: Storage.Static;
|
||||||
|
const tabs: Tabs.Static;
|
||||||
|
const theme: Theme.Static;
|
||||||
|
const topSites: TopSites.Static;
|
||||||
|
const types: Types.Static;
|
||||||
|
const urlbar: Urlbar.Static;
|
||||||
|
const userScripts: UserScripts.Static;
|
||||||
|
const webNavigation: WebNavigation.Static;
|
||||||
|
const webRequest: WebRequest.Static;
|
||||||
|
const windows: Windows.Static;
|
||||||
|
|
||||||
|
interface Browser {
|
||||||
|
activityLog: ActivityLog.Static;
|
||||||
|
alarms: Alarms.Static;
|
||||||
|
bookmarks: Bookmarks.Static;
|
||||||
|
action: Action.Static;
|
||||||
|
browserAction: BrowserAction.Static;
|
||||||
|
browserSettings: BrowserSettings.Static;
|
||||||
|
browsingData: BrowsingData.Static;
|
||||||
|
captivePortal: CaptivePortal.Static;
|
||||||
|
clipboard: Clipboard.Static;
|
||||||
|
commands: Commands.Static;
|
||||||
|
contentScripts: ContentScripts.Static;
|
||||||
|
contextualIdentities: ContextualIdentities.Static;
|
||||||
|
cookies: Cookies.Static;
|
||||||
|
declarativeContent: DeclarativeContent.Static;
|
||||||
|
devtools: Devtools.Static;
|
||||||
|
dns: Dns.Static;
|
||||||
|
downloads: Downloads.Static;
|
||||||
|
events: Events.Static;
|
||||||
|
experiments: Experiments.Static;
|
||||||
|
extension: Extension.Static;
|
||||||
|
extensionTypes: ExtensionTypes.Static;
|
||||||
|
find: Find.Static;
|
||||||
|
geckoProfiler: GeckoProfiler.Static;
|
||||||
|
history: History.Static;
|
||||||
|
i18n: I18n.Static;
|
||||||
|
identity: Identity.Static;
|
||||||
|
idle: Idle.Static;
|
||||||
|
management: Management.Static;
|
||||||
|
manifest: Manifest.Static;
|
||||||
|
contextMenus: ContextMenus.Static;
|
||||||
|
menus: Menus.Static;
|
||||||
|
networkStatus: NetworkStatus.Static;
|
||||||
|
normandyAddonStudy: NormandyAddonStudy.Static;
|
||||||
|
notifications: Notifications.Static;
|
||||||
|
omnibox: Omnibox.Static;
|
||||||
|
pageAction: PageAction.Static;
|
||||||
|
permissions: Permissions.Static;
|
||||||
|
pkcs11: Pkcs11.Static;
|
||||||
|
privacy: Privacy.Static;
|
||||||
|
proxy: Proxy.Static;
|
||||||
|
runtime: Runtime.Static;
|
||||||
|
scripting: Scripting.Static;
|
||||||
|
search: Search.Static;
|
||||||
|
sessions: Sessions.Static;
|
||||||
|
sidebarAction: SidebarAction.Static;
|
||||||
|
storage: Storage.Static;
|
||||||
|
tabs: Tabs.Static;
|
||||||
|
theme: Theme.Static;
|
||||||
|
topSites: TopSites.Static;
|
||||||
|
types: Types.Static;
|
||||||
|
urlbar: Urlbar.Static;
|
||||||
|
userScripts: UserScripts.Static;
|
||||||
|
webNavigation: WebNavigation.Static;
|
||||||
|
webRequest: WebRequest.Static;
|
||||||
|
windows: Windows.Static;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* tslint:disable:strict-export-declare-modifiers */
|
||||||
|
export import ActivityLog = ImportedActivityLog;
|
||||||
|
export import Alarms = ImportedAlarms;
|
||||||
|
export import Bookmarks = ImportedBookmarks;
|
||||||
|
export import Action = ImportedAction;
|
||||||
|
export import BrowserAction = ImportedBrowserAction;
|
||||||
|
export import BrowserSettings = ImportedBrowserSettings;
|
||||||
|
export import BrowsingData = ImportedBrowsingData;
|
||||||
|
export import CaptivePortal = ImportedCaptivePortal;
|
||||||
|
export import Clipboard = ImportedClipboard;
|
||||||
|
export import Commands = ImportedCommands;
|
||||||
|
export import ContentScripts = ImportedContentScripts;
|
||||||
|
export import ContextualIdentities = ImportedContextualIdentities;
|
||||||
|
export import Cookies = ImportedCookies;
|
||||||
|
export import DeclarativeContent = ImportedDeclarativeContent;
|
||||||
|
export import Devtools = ImportedDevtools;
|
||||||
|
export import Dns = ImportedDns;
|
||||||
|
export import Downloads = ImportedDownloads;
|
||||||
|
export import Events = ImportedEvents;
|
||||||
|
export import Experiments = ImportedExperiments;
|
||||||
|
export import Extension = ImportedExtension;
|
||||||
|
export import ExtensionTypes = ImportedExtensionTypes;
|
||||||
|
export import Find = ImportedFind;
|
||||||
|
export import GeckoProfiler = ImportedGeckoProfiler;
|
||||||
|
export import History = ImportedHistory;
|
||||||
|
export import I18n = ImportedI18n;
|
||||||
|
export import Identity = ImportedIdentity;
|
||||||
|
export import Idle = ImportedIdle;
|
||||||
|
export import Management = ImportedManagement;
|
||||||
|
export import Manifest = ImportedManifest;
|
||||||
|
export import ContextMenus = ImportedContextMenus;
|
||||||
|
export import Menus = ImportedMenus;
|
||||||
|
export import NetworkStatus = ImportedNetworkStatus;
|
||||||
|
export import NormandyAddonStudy = ImportedNormandyAddonStudy;
|
||||||
|
export import Notifications = ImportedNotifications;
|
||||||
|
export import Omnibox = ImportedOmnibox;
|
||||||
|
export import PageAction = ImportedPageAction;
|
||||||
|
export import Permissions = ImportedPermissions;
|
||||||
|
export import Pkcs11 = ImportedPkcs11;
|
||||||
|
export import Privacy = ImportedPrivacy;
|
||||||
|
export import Proxy = ImportedProxy;
|
||||||
|
export import Runtime = ImportedRuntime;
|
||||||
|
export import Scripting = ImportedScripting;
|
||||||
|
export import Search = ImportedSearch;
|
||||||
|
export import Sessions = ImportedSessions;
|
||||||
|
export import SidebarAction = ImportedSidebarAction;
|
||||||
|
export import Storage = ImportedStorage;
|
||||||
|
export import Tabs = ImportedTabs;
|
||||||
|
export import Theme = ImportedTheme;
|
||||||
|
export import TopSites = ImportedTopSites;
|
||||||
|
export import Types = ImportedTypes;
|
||||||
|
export import Urlbar = ImportedUrlbar;
|
||||||
|
export import UserScripts = ImportedUserScripts;
|
||||||
|
export import WebNavigation = ImportedWebNavigation;
|
||||||
|
export import WebRequest = ImportedWebRequest;
|
||||||
|
export import Windows = ImportedWindows;
|
||||||
|
/* tslint:enable:strict-export-declare-modifiers */
|
||||||
|
}
|
||||||
|
|
||||||
|
// tslint:disable-next-line:export-just-namespace
|
||||||
|
export = Browser;
|
|
@ -0,0 +1,240 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.action
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use browser actions to put icons in the main browser toolbar, to the right of the address bar. In addition to its icon,
|
||||||
|
* a browser action can also have a tooltip, a badge, and a popup.
|
||||||
|
* Permissions: "manifest:action", "manifest:browser_action"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Action {
|
||||||
|
/**
|
||||||
|
* Specifies to which tab or window the value should be set, or from which one it should be retrieved.
|
||||||
|
* If no tab nor window is specified, the global value is set or retrieved.
|
||||||
|
*/
|
||||||
|
interface Details {
|
||||||
|
/**
|
||||||
|
* When setting a value, it will be specific to the specified tab, and will automatically reset when the tab navigates.
|
||||||
|
* When getting, specifies the tab to get the value from; if there is no tab-specific value,
|
||||||
|
* the window one will be inherited.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When setting a value, it will be specific to the specified window. When getting, specifies the window to get the value
|
||||||
|
* from; if there is no window-specific value, the global one will be inherited.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
type ColorArray = [number, number, number, number];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).
|
||||||
|
*/
|
||||||
|
interface ImageDataType extends ImageData {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example,
|
||||||
|
* opaque red is <code>[255, 0, 0, 255]</code>. Can also be a string with a CSS value, with opaque red being <code>
|
||||||
|
* #FF0000</code> or <code>#F00</code>.
|
||||||
|
*/
|
||||||
|
type ColorValue = string | ColorArray | null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information sent when a browser action is clicked.
|
||||||
|
*/
|
||||||
|
interface OnClickData {
|
||||||
|
/**
|
||||||
|
* An array of keyboard modifiers that were held while the menu item was clicked.
|
||||||
|
*/
|
||||||
|
modifiers: OnClickDataModifiersItemEnum[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An integer value of button by which menu item was clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
button?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetTitleDetailsType extends Details {
|
||||||
|
/**
|
||||||
|
* The string the browser action should display when moused over.
|
||||||
|
*/
|
||||||
|
title: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetIconDetailsType extends Details {
|
||||||
|
/**
|
||||||
|
* Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.
|
||||||
|
* imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageData?: ImageDataType | Record<string, ImageDataType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
path?: string | Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetPopupDetailsType extends Details {
|
||||||
|
/**
|
||||||
|
* The html file to show in a popup. If set to the empty string (''), no popup is shown.
|
||||||
|
*/
|
||||||
|
popup: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetBadgeTextDetailsType extends Details {
|
||||||
|
/**
|
||||||
|
* Any number of characters can be passed, but only about four can fit in the space.
|
||||||
|
*/
|
||||||
|
text: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetBadgeBackgroundColorDetailsType extends Details {
|
||||||
|
color: ColorValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetBadgeTextColorDetailsType extends Details {
|
||||||
|
color: ColorValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
type OnClickDataModifiersItemEnum = "Shift" | "Alt" | "Command" | "Ctrl" | "MacCtrl";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Sets the title of the browser action. This shows up in the tooltip.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setTitle(details: SetTitleDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the title of the browser action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getTitle(details: Details): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data
|
||||||
|
* from a canvas element, or as dictionary of either one of those. Either the <b>path</b> or the <b>imageData</b>
|
||||||
|
* property must be specified.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setIcon(details: SetIconDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the html document to be opened as a popup when the user clicks on the browser action's icon.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setPopup(details: SetPopupDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the html document set as the popup for this browser action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getPopup(details: Details): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the badge text for the browser action. The badge is displayed on top of the icon.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setBadgeText(details: SetBadgeTextDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the badge text of the browser action. If no tab nor window is specified is specified,
|
||||||
|
* the global badge text is returned.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getBadgeText(details: Details): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the background color for the badge.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setBadgeBackgroundColor(details: SetBadgeBackgroundColorDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the background color of the browser action badge.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getBadgeBackgroundColor(details: Details): Promise<ColorArray>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the text color for the badge.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setBadgeTextColor(details: SetBadgeTextColorDetailsType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the text color of the browser action badge.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getBadgeTextColor(details: Details): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables the browser action for a tab. By default, browser actions are enabled.
|
||||||
|
*
|
||||||
|
* @param tabId Optional. The id of the tab for which you want to modify the browser action.
|
||||||
|
*/
|
||||||
|
enable(tabId?: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables the browser action for a tab.
|
||||||
|
*
|
||||||
|
* @param tabId Optional. The id of the tab for which you want to modify the browser action.
|
||||||
|
*/
|
||||||
|
disable(tabId?: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the browser action is enabled.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
isEnabled(details: Details): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the extension popup window in the active window.
|
||||||
|
*/
|
||||||
|
openPopup(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.
|
||||||
|
*
|
||||||
|
* @param tab
|
||||||
|
* @param info Optional.
|
||||||
|
*/
|
||||||
|
onClicked: Events.Event<(tab: Tabs.Tab, info: OnClickData | undefined) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,107 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.activityLog
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Monitor extension activity
|
||||||
|
* Permissions: "activityLog"
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace ActivityLog {
|
||||||
|
interface OnExtensionActivityDetailsType {
|
||||||
|
/**
|
||||||
|
* The date string when this call is triggered.
|
||||||
|
*/
|
||||||
|
timeStamp: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of log entry. api_call is a function call made by the extension and api_event is an event callback to the
|
||||||
|
* extension. content_script is logged when a content script is injected.
|
||||||
|
*/
|
||||||
|
type: OnExtensionActivityDetailsTypeTypeEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of view where the activity occurred. Content scripts will not have a viewType.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
viewType?: OnExtensionActivityDetailsTypeViewTypeEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the api call or event, or the script url if this is a content or user script event.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
data: OnExtensionActivityDetailsTypeDataType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of log entry. api_call is a function call made by the extension and api_event is an event callback to the
|
||||||
|
* extension. content_script is logged when a content script is injected.
|
||||||
|
*/
|
||||||
|
type OnExtensionActivityDetailsTypeTypeEnum = "api_call" | "api_event" | "content_script" | "user_script";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of view where the activity occurred. Content scripts will not have a viewType.
|
||||||
|
*/
|
||||||
|
type OnExtensionActivityDetailsTypeViewTypeEnum =
|
||||||
|
| "background"
|
||||||
|
| "popup"
|
||||||
|
| "sidebar"
|
||||||
|
| "tab"
|
||||||
|
| "devtools_page"
|
||||||
|
| "devtools_panel";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The result of the call.
|
||||||
|
*/
|
||||||
|
interface OnExtensionActivityDetailsTypeDataResultType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnExtensionActivityDetailsTypeDataType {
|
||||||
|
/**
|
||||||
|
* A list of arguments passed to the call.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
args?: any[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The result of the call.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
result?: OnExtensionActivityDetailsTypeDataResultType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tab associated with this event if it is a tab or content script.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the type is content_script, this is the url of the script that was injected.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Receives an activityItem for each logging event.
|
||||||
|
*/
|
||||||
|
interface onExtensionActivityEvent extends Events.Event<(details: OnExtensionActivityDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnExtensionActivityDetailsType) => void, id: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Receives an activityItem for each logging event.
|
||||||
|
*/
|
||||||
|
onExtensionActivity: onExtensionActivityEvent;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,117 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.alarms
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "alarms"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Alarms {
|
||||||
|
interface Alarm {
|
||||||
|
/**
|
||||||
|
* Name of this alarm.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Time when the alarm is scheduled to fire, in milliseconds past the epoch.
|
||||||
|
*/
|
||||||
|
scheduledTime: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When present, signals that the alarm triggers periodically after so many minutes.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
periodInMinutes?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details about the alarm. The alarm first fires either at 'when' milliseconds past the epoch (if 'when' is provided),
|
||||||
|
* after 'delayInMinutes' minutes from the current time (if 'delayInMinutes' is provided instead),
|
||||||
|
* or after 'periodInMinutes' minutes from the current time (if only 'periodInMinutes' is provided).
|
||||||
|
* Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided,
|
||||||
|
* then the alarm recurs repeatedly after that many minutes.
|
||||||
|
*/
|
||||||
|
interface CreateAlarmInfoType {
|
||||||
|
/**
|
||||||
|
* Time when the alarm is scheduled to first fire, in milliseconds past the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
when?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of minutes from the current time after which the alarm should first fire.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
delayInMinutes?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of minutes after which the alarm should recur repeatedly.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
periodInMinutes?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Creates an alarm. After the delay is expired, the onAlarm event is fired. If there is another alarm with the same name
|
||||||
|
* (or no name if none is specified), it will be cancelled and replaced by this alarm.
|
||||||
|
*
|
||||||
|
* @param name Optional. Optional name to identify this alarm. Defaults to the empty string.
|
||||||
|
* @param alarmInfo Details about the alarm. The alarm first fires either at 'when' milliseconds past the epoch (if 'when'
|
||||||
|
* is provided), after 'delayInMinutes' minutes from the current time (if 'delayInMinutes' is provided instead),
|
||||||
|
* or after 'periodInMinutes' minutes from the current time (if only 'periodInMinutes' is provided).
|
||||||
|
* Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided,
|
||||||
|
* then the alarm recurs repeatedly after that many minutes.
|
||||||
|
*/
|
||||||
|
create(name: string | undefined, alarmInfo: CreateAlarmInfoType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an alarm. After the delay is expired, the onAlarm event is fired. If there is another alarm with the same name
|
||||||
|
* (or no name if none is specified), it will be cancelled and replaced by this alarm.
|
||||||
|
*
|
||||||
|
* @param alarmInfo Details about the alarm. The alarm first fires either at 'when' milliseconds past the epoch (if 'when'
|
||||||
|
* is provided), after 'delayInMinutes' minutes from the current time (if 'delayInMinutes' is provided instead),
|
||||||
|
* or after 'periodInMinutes' minutes from the current time (if only 'periodInMinutes' is provided).
|
||||||
|
* Users should never provide both 'when' and 'delayInMinutes'. If 'periodInMinutes' is provided,
|
||||||
|
* then the alarm recurs repeatedly after that many minutes.
|
||||||
|
*/
|
||||||
|
create(alarmInfo: CreateAlarmInfoType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves details about the specified alarm.
|
||||||
|
*
|
||||||
|
* @param name Optional. The name of the alarm to get. Defaults to the empty string.
|
||||||
|
*/
|
||||||
|
get(name?: string): Promise<Alarm>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets an array of all the alarms.
|
||||||
|
*/
|
||||||
|
getAll(): Promise<Alarm[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the alarm with the given name.
|
||||||
|
*
|
||||||
|
* @param name Optional. The name of the alarm to clear. Defaults to the empty string.
|
||||||
|
*/
|
||||||
|
clear(name?: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears all alarms.
|
||||||
|
*/
|
||||||
|
clearAll(): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an alarm has expired. Useful for transient background pages.
|
||||||
|
*
|
||||||
|
* @param name The alarm that has expired.
|
||||||
|
*/
|
||||||
|
onAlarm: Events.Event<(name: Alarm) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,316 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.bookmarks
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks.
|
||||||
|
* Also see $(topic:override)[Override Pages], which you can use to create a custom Bookmark Manager page.
|
||||||
|
* Permissions: "bookmarks"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Bookmarks {
|
||||||
|
/**
|
||||||
|
* Indicates the reason why this node is unmodifiable. The <var>managed</var> value indicates that this node was configured
|
||||||
|
* by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user
|
||||||
|
* and the extension (default).
|
||||||
|
*/
|
||||||
|
type BookmarkTreeNodeUnmodifiable = "managed";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates the type of a BookmarkTreeNode, which can be one of bookmark, folder or separator.
|
||||||
|
*/
|
||||||
|
type BookmarkTreeNodeType = "bookmark" | "folder" | "separator";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.
|
||||||
|
*/
|
||||||
|
interface BookmarkTreeNode {
|
||||||
|
/**
|
||||||
|
* The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the
|
||||||
|
* browser is restarted.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The <code>id</code> of the parent folder. Omitted for the root node.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The 0-based position of this node within its parent folder.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
index?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL navigated to when a user clicks the bookmark. Omitted for folders.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The text displayed for the node.
|
||||||
|
*/
|
||||||
|
title: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When this node was created, in milliseconds since the epoch (<code>new Date(dateAdded)</code>).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
dateAdded?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When the contents of this folder last changed, in milliseconds since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
dateGroupModified?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates the reason why this node is unmodifiable. The <var>managed</var> value indicates that this node was configured
|
||||||
|
* by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user
|
||||||
|
* and the extension (default).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
unmodifiable?: BookmarkTreeNodeUnmodifiable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates the type of the BookmarkTreeNode, which can be one of bookmark, folder or separator.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: BookmarkTreeNodeType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An ordered list of children of this node.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
children?: BookmarkTreeNode[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Object passed to the create() function.
|
||||||
|
*/
|
||||||
|
interface CreateDetails {
|
||||||
|
/**
|
||||||
|
* Defaults to the Other Bookmarks folder.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
index?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates the type of BookmarkTreeNode to create, which can be one of bookmark, folder or separator.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: BookmarkTreeNodeType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object specifying properties and values to match when searching. Produces bookmarks matching all properties.
|
||||||
|
*/
|
||||||
|
interface SearchQueryC2Type {
|
||||||
|
/**
|
||||||
|
* A string of words that are matched against bookmark URLs and titles.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
query?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the bookmark; matches verbatim. Note that folders have no URL.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of the bookmark; matches verbatim.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface MoveDestinationType {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
index?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UpdateChangesType {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnRemovedRemoveInfoType {
|
||||||
|
parentId: string;
|
||||||
|
|
||||||
|
index: number;
|
||||||
|
|
||||||
|
node: BookmarkTreeNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnChangedChangeInfoType {
|
||||||
|
title: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnMovedMoveInfoType {
|
||||||
|
parentId: string;
|
||||||
|
|
||||||
|
index: number;
|
||||||
|
|
||||||
|
oldParentId: string;
|
||||||
|
|
||||||
|
oldIndex: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Retrieves the specified BookmarkTreeNode(s).
|
||||||
|
*
|
||||||
|
* @param idOrIdList A single string-valued id, or an array of string-valued ids
|
||||||
|
*/
|
||||||
|
get(idOrIdList: string | string[]): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the children of the specified BookmarkTreeNode id.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
getChildren(id: string): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the recently added bookmarks.
|
||||||
|
*
|
||||||
|
* @param numberOfItems The maximum number of items to return.
|
||||||
|
*/
|
||||||
|
getRecent(numberOfItems: number): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the entire Bookmarks hierarchy.
|
||||||
|
*/
|
||||||
|
getTree(): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves part of the Bookmarks hierarchy, starting at the specified node.
|
||||||
|
*
|
||||||
|
* @param id The ID of the root of the subtree to retrieve.
|
||||||
|
*/
|
||||||
|
getSubTree(id: string): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Searches for BookmarkTreeNodes matching the given query. Queries specified with an object produce BookmarkTreeNodes
|
||||||
|
* matching all specified properties.
|
||||||
|
*
|
||||||
|
* @param query Either a string of words that are matched against bookmark URLs and titles, or an object. If an object,
|
||||||
|
* the properties <code>query</code>, <code>url</code>, and <code>title</code> may be specified and bookmarks matching all
|
||||||
|
* specified properties will be produced.
|
||||||
|
*/
|
||||||
|
search(query: string | SearchQueryC2Type): Promise<BookmarkTreeNode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.
|
||||||
|
*
|
||||||
|
* @param bookmark
|
||||||
|
*/
|
||||||
|
create(bookmark: CreateDetails): Promise<BookmarkTreeNode>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Moves the specified BookmarkTreeNode to the provided location.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param destination
|
||||||
|
*/
|
||||||
|
move(id: string, destination: MoveDestinationType): Promise<BookmarkTreeNode>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified
|
||||||
|
* properties will be left unchanged. <b>Note:</b> Currently, only 'title' and 'url' are supported.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param changes
|
||||||
|
*/
|
||||||
|
update(id: string, changes: UpdateChangesType): Promise<BookmarkTreeNode>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a bookmark or an empty bookmark folder.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
remove(id: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recursively removes a bookmark folder.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
*/
|
||||||
|
removeTree(id: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a bookmark or folder is created.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param bookmark
|
||||||
|
*/
|
||||||
|
onCreated: Events.Event<(id: string, bookmark: BookmarkTreeNode) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a bookmark or folder is removed. When a folder is removed recursively,
|
||||||
|
* a single notification is fired for the folder, and none for its contents.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param removeInfo
|
||||||
|
*/
|
||||||
|
onRemoved: Events.Event<(id: string, removeInfo: OnRemovedRemoveInfoType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a bookmark or folder changes. <b>Note:</b> Currently, only title and url changes trigger this.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param changeInfo
|
||||||
|
*/
|
||||||
|
onChanged: Events.Event<(id: string, changeInfo: OnChangedChangeInfoType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a bookmark or folder is moved to a different parent folder.
|
||||||
|
*
|
||||||
|
* @param id
|
||||||
|
* @param moveInfo
|
||||||
|
*/
|
||||||
|
onMoved: Events.Event<(id: string, moveInfo: OnMovedMoveInfoType) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,18 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.browserAction
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "manifest:action", "manifest:browser_action"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Action } from "./action";
|
||||||
|
|
||||||
|
export namespace BrowserAction {
|
||||||
|
interface Static extends Action.Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,125 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.browserSettings
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.browserSettings</code> API to control global settings of the browser.
|
||||||
|
* Permissions: "browserSettings"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { BrowserSettingsColorManagement } from "./browserSettings_colorManagement";
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace BrowserSettings {
|
||||||
|
/**
|
||||||
|
* How images should be animated in the browser.
|
||||||
|
*/
|
||||||
|
type ImageAnimationBehavior = "normal" | "none" | "once";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* After which mouse event context menus should popup.
|
||||||
|
*/
|
||||||
|
type ContextMenuMouseEvent = "mouseup" | "mousedown";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Color management mode.
|
||||||
|
*/
|
||||||
|
type ColorManagementMode = "off" | "full" | "tagged_only";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Allows or disallows pop-up windows from opening in response to user events.
|
||||||
|
*/
|
||||||
|
allowPopupsForUserEvents: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables or disables the browser cache.
|
||||||
|
*/
|
||||||
|
cacheEnabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether the selected tab can be closed with a double click.
|
||||||
|
*/
|
||||||
|
closeTabsByDoubleClick: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Controls after which mouse event context menus popup. This setting's value is of type ContextMenuMouseEvent,
|
||||||
|
* which has possible values of <code>mouseup</code> and <code>mousedown</code>.
|
||||||
|
*/
|
||||||
|
contextMenuShowEvent: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the value of the overridden home page. Read-only.
|
||||||
|
*/
|
||||||
|
homepageOverride: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Controls the behaviour of image animation in the browser. This setting's value is of type ImageAnimationBehavior,
|
||||||
|
* defaulting to <code>normal</code>.
|
||||||
|
*/
|
||||||
|
imageAnimationBehavior: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the value of the overridden new tab page. Read-only.
|
||||||
|
*/
|
||||||
|
newTabPageOverride: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Controls where new tabs are opened. `afterCurrent` will open all new tabs next to the current tab,
|
||||||
|
* `relatedAfterCurrent` will open only related tabs next to the current tab, and `atEnd` will open all tabs at the end of
|
||||||
|
* the tab strip. The default is `relatedAfterCurrent`.
|
||||||
|
*/
|
||||||
|
newTabPosition: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether bookmarks are opened in the current tab or in a new tab.
|
||||||
|
*/
|
||||||
|
openBookmarksInNewTabs: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether search results are opened in the current tab or in a new tab.
|
||||||
|
*/
|
||||||
|
openSearchResultsInNewTabs: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether urlbar results are opened in the current tab or in a new tab.
|
||||||
|
*/
|
||||||
|
openUrlbarResultsInNewTabs: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Disables webAPI notifications.
|
||||||
|
*/
|
||||||
|
webNotificationsDisabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This setting controls whether the user-chosen colors override the page's colors.
|
||||||
|
*/
|
||||||
|
overrideDocumentColors: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This setting controls whether a light or dark color scheme overrides the page's preferred color scheme.
|
||||||
|
*/
|
||||||
|
overrideContentColorScheme: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This setting controls whether the document's fonts are used.
|
||||||
|
*/
|
||||||
|
useDocumentFonts: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether zoom is applied to the full page or to text only.
|
||||||
|
*/
|
||||||
|
zoomFullPage: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether zoom is applied on a per-site basis or to the current tab only. If privacy.
|
||||||
|
* resistFingerprinting is true, this setting has no effect and zoom is applied to the current tab only.
|
||||||
|
*/
|
||||||
|
zoomSiteSpecific: Types.Setting;
|
||||||
|
|
||||||
|
colorManagement: BrowserSettingsColorManagement.Static;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,33 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.browserSettings.colorManagement
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browserSettings.colorManagement</code> API to query and set items related to color management.
|
||||||
|
* Permissions: "browserSettings"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace BrowserSettingsColorManagement {
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* This setting controls the mode used for color management and must be a string from $(ref:browserSettings.
|
||||||
|
* ColorManagementMode)
|
||||||
|
*/
|
||||||
|
mode: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether or not native sRGB color management is used.
|
||||||
|
*/
|
||||||
|
useNativeSRGB: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This boolean setting controls whether or not the WebRender compositor is used.
|
||||||
|
*/
|
||||||
|
useWebRenderCompositor: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,243 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.browsingData
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.browsingData</code> API to remove browsing data from a user's local profile.
|
||||||
|
* Permissions: "browsingData"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
|
||||||
|
export namespace BrowsingData {
|
||||||
|
/**
|
||||||
|
* Options that determine exactly what data will be removed.
|
||||||
|
*/
|
||||||
|
interface RemovalOptions {
|
||||||
|
/**
|
||||||
|
* Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the <code>
|
||||||
|
* getTime</code> method of the JavaScript <code>Date</code> object). If absent, defaults to 0 (which would remove all
|
||||||
|
* browsing data).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
since?: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only remove data associated with these hostnames (only applies to cookies and localStorage).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostnames?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Only remove data associated with this specific cookieStoreId.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object whose properties specify which origin types ought to be cleared. If this object isn't specified,
|
||||||
|
* it defaults to clearing only "unprotected" origins. Please ensure that you <em>really</em>
|
||||||
|
* want to remove application data before adding 'protectedWeb' or 'extensions'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
originTypes?: RemovalOptionsOriginTypesType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A set of data types. Missing data types are interpreted as <code>false</code>.
|
||||||
|
*/
|
||||||
|
interface DataTypeSet {
|
||||||
|
/**
|
||||||
|
* The browser's cache. Note: when removing data, this clears the <em>entire</em> cache: it is not limited to the range you
|
||||||
|
* specify.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cache?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's cookies.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookies?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's download list.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
downloads?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's stored form data.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
formData?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's history.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
history?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Websites' IndexedDB data.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
indexedDB?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Websites' local storage data.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
localStorage?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Server-bound certificates.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
serverBoundCertificates?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stored passwords.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
passwords?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plugins' data.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pluginData?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Service Workers.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
serviceWorkers?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SettingsCallbackResultType {
|
||||||
|
options: RemovalOptions;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All of the types will be present in the result, with values of <code>true</code> if they are both selected to be removed
|
||||||
|
* and permitted to be removed, otherwise <code>false</code>.
|
||||||
|
*/
|
||||||
|
dataToRemove: DataTypeSet;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All of the types will be present in the result, with values of <code>true</code> if they are permitted to be removed (e.
|
||||||
|
* g., by enterprise policy) and <code>false</code> if not.
|
||||||
|
*/
|
||||||
|
dataRemovalPermitted: DataTypeSet;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object whose properties specify which origin types ought to be cleared. If this object isn't specified,
|
||||||
|
* it defaults to clearing only "unprotected" origins. Please ensure that you <em>really</em>
|
||||||
|
* want to remove application data before adding 'protectedWeb' or 'extensions'.
|
||||||
|
*/
|
||||||
|
interface RemovalOptionsOriginTypesType {
|
||||||
|
/**
|
||||||
|
* Normal websites.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
unprotectedWeb?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Websites that have been installed as hosted applications (be careful!).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
protectedWeb?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extensions and packaged applications a user has installed (be _really_ careful!).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
extension?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Reports which types of data are currently selected in the 'Clear browsing data' settings UI.
|
||||||
|
* Note: some of the data types included in this API are not available in the settings UI,
|
||||||
|
* and some UI settings control more than one data type listed here.
|
||||||
|
*/
|
||||||
|
settings(): Promise<SettingsCallbackResultType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears various types of browsing data stored in a user's profile.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @param dataToRemove The set of data types to remove.
|
||||||
|
* @returns Called when deletion has completed.
|
||||||
|
*/
|
||||||
|
remove(options: RemovalOptions, dataToRemove: DataTypeSet): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's cache.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's cache has been cleared.
|
||||||
|
*/
|
||||||
|
removeCache(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's cookies and server-bound certificates modified within a particular timeframe.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's cookies and server-bound certificates have been cleared.
|
||||||
|
*/
|
||||||
|
removeCookies(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's list of downloaded files (<em>not</em> the downloaded files themselves).
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's list of downloaded files has been cleared.
|
||||||
|
*/
|
||||||
|
removeDownloads(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's stored form data (autofill).
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's form data has been cleared.
|
||||||
|
*/
|
||||||
|
removeFormData(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's history.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's history has cleared.
|
||||||
|
*/
|
||||||
|
removeHistory(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears websites' local storage data.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when websites' local storage has been cleared.
|
||||||
|
*/
|
||||||
|
removeLocalStorage(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears plugins' data.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when plugins' data has been cleared.
|
||||||
|
*/
|
||||||
|
removePluginData(options: RemovalOptions): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the browser's stored passwords.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
* @returns Called when the browser's passwords have been cleared.
|
||||||
|
*/
|
||||||
|
removePasswords(options: RemovalOptions): Promise<void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,58 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.captivePortal
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* This API provides the ability detect the captive portal state of the users connection.
|
||||||
|
* Permissions: "captivePortal"
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace CaptivePortal {
|
||||||
|
interface OnStateChangedDetailsType {
|
||||||
|
/**
|
||||||
|
* The current captive portal state.
|
||||||
|
*/
|
||||||
|
state: OnStateChangedDetailsTypeStateEnum;
|
||||||
|
}
|
||||||
|
|
||||||
|
type OnConnectivityAvailableStatusEnum = "captive" | "clear";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current captive portal state.
|
||||||
|
*/
|
||||||
|
type OnStateChangedDetailsTypeStateEnum = "unknown" | "not_captive" | "unlocked_portal" | "locked_portal";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns the current portal state, one of `unknown`, `not_captive`, `unlocked_portal`, `locked_portal`.
|
||||||
|
*/
|
||||||
|
getState(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the time difference between NOW and the last time a request was completed in milliseconds.
|
||||||
|
*/
|
||||||
|
getLastChecked(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the captive portal state changes.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
onStateChanged: Events.Event<(details: OnStateChangedDetailsType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This notification will be emitted when the captive portal service has determined that we can connect to the internet.
|
||||||
|
* The service will pass either `captive` if there is an unlocked captive portal present,
|
||||||
|
* or `clear` if no captive portal was detected.
|
||||||
|
*
|
||||||
|
* @param status
|
||||||
|
*/
|
||||||
|
onConnectivityAvailable: Events.Event<(status: OnConnectivityAvailableStatusEnum) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the canonical captive-portal detection URL. Read-only.
|
||||||
|
*/
|
||||||
|
canonicalURL: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,25 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.clipboard
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Offers the ability to write to the clipboard. Reading is not supported because the clipboard can already be read through
|
||||||
|
* the standard web platform APIs.
|
||||||
|
* Permissions: "clipboardWrite"
|
||||||
|
*/
|
||||||
|
export namespace Clipboard {
|
||||||
|
/**
|
||||||
|
* The type of imageData.
|
||||||
|
*/
|
||||||
|
type SetImageDataImageTypeEnum = "jpeg" | "png";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Copy an image to the clipboard. The image is re-encoded before it is written to the clipboard. If the image is invalid,
|
||||||
|
* the clipboard is not modified.
|
||||||
|
*
|
||||||
|
* @param imageData The image data to be copied.
|
||||||
|
* @param imageType The type of imageData.
|
||||||
|
*/
|
||||||
|
setImageData(imageData: ArrayBuffer, imageType: SetImageDataImageTypeEnum): Promise<void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,87 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.commands
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example,
|
||||||
|
* an action to open the browser action or send a command to the xtension.
|
||||||
|
* Permissions: "manifest:commands"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Commands {
|
||||||
|
interface Command {
|
||||||
|
/**
|
||||||
|
* The name of the Extension Command
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Extension Command description
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
description?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The shortcut active for this command, or blank if not active.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
shortcut?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new description for the command.
|
||||||
|
*/
|
||||||
|
interface UpdateDetailType {
|
||||||
|
/**
|
||||||
|
* The name of the command.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new description for the command.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
description?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
shortcut?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Update the details of an already defined command.
|
||||||
|
*
|
||||||
|
* @param detail The new description for the command.
|
||||||
|
*/
|
||||||
|
update(detail: UpdateDetailType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reset a command's details to what is specified in the manifest.
|
||||||
|
*
|
||||||
|
* @param name The name of the command.
|
||||||
|
*/
|
||||||
|
reset(name: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns all the registered extension commands for this extension and their shortcut (if active).
|
||||||
|
*
|
||||||
|
* @returns Called to return the registered commands.
|
||||||
|
*/
|
||||||
|
getAll(): Promise<Command[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a registered command is activated using a keyboard shortcut.
|
||||||
|
*
|
||||||
|
* @param command
|
||||||
|
*/
|
||||||
|
onCommand: Events.Event<(command: string) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,86 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.contentScripts
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
|
||||||
|
export namespace ContentScripts {
|
||||||
|
/**
|
||||||
|
* Details of a content script registered programmatically
|
||||||
|
*/
|
||||||
|
interface RegisteredContentScriptOptions {
|
||||||
|
matches: Manifest.MatchPattern[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
excludeMatches?: Manifest.MatchPattern[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeGlobs?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
excludeGlobs?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The list of CSS files to inject
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
css?: ExtensionTypes.ExtensionFileOrCode[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The list of JS files to inject
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
js?: ExtensionTypes.ExtensionFileOrCode[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If allFrames is <code>true</code>, implies that the JavaScript or CSS should be injected into all frames of current page.
|
||||||
|
* By default, it's <code>false</code> and is only injected into the top frame.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has
|
||||||
|
* access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is <code>false</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
matchAboutBlank?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The soonest that the JavaScript or CSS will be injected into the tab. Defaults to "document_idle".
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
runAt?: ExtensionTypes.RunAt;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object that represents a content script registered programmatically
|
||||||
|
*/
|
||||||
|
interface RegisteredContentScript {
|
||||||
|
/**
|
||||||
|
* Unregister a content script registered programmatically
|
||||||
|
*/
|
||||||
|
unregister(): Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Register a content script programmatically
|
||||||
|
*
|
||||||
|
* @param contentScriptOptions
|
||||||
|
*/
|
||||||
|
register(contentScriptOptions: RegisteredContentScriptOptions): Promise<RegisteredContentScript>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,20 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.contextMenus
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the browser.contextMenus API to add items to the browser's context menu. You can choose what types of objects your
|
||||||
|
* context menu additions apply to, such as images, hyperlinks, and pages.
|
||||||
|
* Permissions: "contextMenus"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Menus } from "./menus";
|
||||||
|
|
||||||
|
export namespace ContextMenus {
|
||||||
|
interface Static extends Menus.Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,184 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.contextualIdentities
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.contextualIdentities</code> API to query and modify contextual identity, also called as containers.
|
||||||
|
* Permissions: "contextualIdentities"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace ContextualIdentities {
|
||||||
|
/**
|
||||||
|
* Represents information about a contextual identity.
|
||||||
|
*/
|
||||||
|
interface ContextualIdentity {
|
||||||
|
/**
|
||||||
|
* The name of the contextual identity.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The icon name of the contextual identity.
|
||||||
|
*/
|
||||||
|
icon: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The icon url of the contextual identity.
|
||||||
|
*/
|
||||||
|
iconUrl: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The color name of the contextual identity.
|
||||||
|
*/
|
||||||
|
color: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The color hash of the contextual identity.
|
||||||
|
*/
|
||||||
|
colorCode: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store ID of the contextual identity.
|
||||||
|
*/
|
||||||
|
cookieStoreId: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information to filter the contextual identities being retrieved.
|
||||||
|
*/
|
||||||
|
interface QueryDetailsType {
|
||||||
|
/**
|
||||||
|
* Filters the contextual identity by name.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details about the contextual identity being created.
|
||||||
|
*/
|
||||||
|
interface CreateDetailsType {
|
||||||
|
/**
|
||||||
|
* The name of the contextual identity.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The color of the contextual identity.
|
||||||
|
*/
|
||||||
|
color: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The icon of the contextual identity.
|
||||||
|
*/
|
||||||
|
icon: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details about the contextual identity being created.
|
||||||
|
*/
|
||||||
|
interface UpdateDetailsType {
|
||||||
|
/**
|
||||||
|
* The name of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The color of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
color?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The icon of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
icon?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnUpdatedChangeInfoType {
|
||||||
|
/**
|
||||||
|
* Contextual identity that has been updated
|
||||||
|
*/
|
||||||
|
contextualIdentity: ContextualIdentity;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnCreatedChangeInfoType {
|
||||||
|
/**
|
||||||
|
* Contextual identity that has been created
|
||||||
|
*/
|
||||||
|
contextualIdentity: ContextualIdentity;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnRemovedChangeInfoType {
|
||||||
|
/**
|
||||||
|
* Contextual identity that has been removed
|
||||||
|
*/
|
||||||
|
contextualIdentity: ContextualIdentity;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Retrieves information about a single contextual identity.
|
||||||
|
*
|
||||||
|
* @param cookieStoreId The ID of the contextual identity cookie store.
|
||||||
|
*/
|
||||||
|
get(cookieStoreId: string): Promise<ContextualIdentity>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves all contextual identities
|
||||||
|
*
|
||||||
|
* @param details Information to filter the contextual identities being retrieved.
|
||||||
|
*/
|
||||||
|
query(details: QueryDetailsType): Promise<ContextualIdentity[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a contextual identity with the given data.
|
||||||
|
*
|
||||||
|
* @param details Details about the contextual identity being created.
|
||||||
|
*/
|
||||||
|
create(details: CreateDetailsType): Promise<ContextualIdentity>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates a contextual identity with the given data.
|
||||||
|
*
|
||||||
|
* @param cookieStoreId The ID of the contextual identity cookie store.
|
||||||
|
* @param details Details about the contextual identity being created.
|
||||||
|
*/
|
||||||
|
update(cookieStoreId: string, details: UpdateDetailsType): Promise<ContextualIdentity>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes a contetual identity by its cookie Store ID.
|
||||||
|
*
|
||||||
|
* @param cookieStoreId The ID of the contextual identity cookie store.
|
||||||
|
*/
|
||||||
|
remove(cookieStoreId: string): Promise<ContextualIdentity>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a container is updated.
|
||||||
|
*
|
||||||
|
* @param changeInfo
|
||||||
|
*/
|
||||||
|
onUpdated: Events.Event<(changeInfo: OnUpdatedChangeInfoType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a new container is created.
|
||||||
|
*
|
||||||
|
* @param changeInfo
|
||||||
|
*/
|
||||||
|
onCreated: Events.Event<(changeInfo: OnCreatedChangeInfoType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a container is removed.
|
||||||
|
*
|
||||||
|
* @param changeInfo
|
||||||
|
*/
|
||||||
|
onRemoved: Events.Event<(changeInfo: OnRemovedChangeInfoType) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,450 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.cookies
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.cookies</code> API to query and modify cookies, and to be notified when they change.
|
||||||
|
* Permissions: "cookies"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Cookies {
|
||||||
|
/**
|
||||||
|
* A cookie's 'SameSite' state (https://tools.ietf.org/html/draft-west-first-party-cookies).
|
||||||
|
* 'no_restriction' corresponds to a cookie set without a 'SameSite' attribute, 'lax' to 'SameSite=Lax',
|
||||||
|
* and 'strict' to 'SameSite=Strict'.
|
||||||
|
*/
|
||||||
|
type SameSiteStatus = "no_restriction" | "lax" | "strict";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The description of the storage partition of a cookie. This object may be omitted (null) if a cookie is not partitioned.
|
||||||
|
*/
|
||||||
|
interface PartitionKey {
|
||||||
|
/**
|
||||||
|
* The first-party URL of the cookie, if the cookie is in storage partitioned by the top-level site.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
topLevelSite?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents information about an HTTP cookie.
|
||||||
|
*/
|
||||||
|
interface Cookie {
|
||||||
|
/**
|
||||||
|
* The name of the cookie.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The value of the cookie.
|
||||||
|
*/
|
||||||
|
value: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The domain of the cookie (e.g. "www.google.com", "example.com").
|
||||||
|
*/
|
||||||
|
domain: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie).
|
||||||
|
*/
|
||||||
|
hostOnly: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path of the cookie.
|
||||||
|
*/
|
||||||
|
path: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS).
|
||||||
|
*/
|
||||||
|
secure: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts).
|
||||||
|
*/
|
||||||
|
httpOnly: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie's same-site status (i.e. whether the cookie is sent with cross-site requests).
|
||||||
|
*/
|
||||||
|
sameSite: SameSiteStatus;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date.
|
||||||
|
*/
|
||||||
|
session: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
expirationDate?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the cookie store containing this cookie, as provided in getAllCookieStores().
|
||||||
|
*/
|
||||||
|
storeId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The first-party domain of the cookie.
|
||||||
|
*/
|
||||||
|
firstPartyDomain: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie's storage partition, if any. null if not partitioned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a
|
||||||
|
* non-incognito window.
|
||||||
|
*/
|
||||||
|
interface CookieStore {
|
||||||
|
/**
|
||||||
|
* The unique identifier for the cookie store.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Identifiers of all the browser tabs that share this cookie store.
|
||||||
|
*/
|
||||||
|
tabIds: number[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates if this is an incognito cookie store
|
||||||
|
*/
|
||||||
|
incognito: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to
|
||||||
|
* $(ref:cookies.remove), "cause" will be "explicit". If a cookie was automatically removed due to expiry,
|
||||||
|
* "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date,
|
||||||
|
* "cause" will be set to "expired_overwrite". If a cookie was automatically removed due to garbage collection,
|
||||||
|
* "cause" will be "evicted". If a cookie was automatically removed due to a "set" call that overwrote it,
|
||||||
|
* "cause" will be "overwrite". Plan your response accordingly.
|
||||||
|
*/
|
||||||
|
type OnChangedCause = "evicted" | "expired" | "explicit" | "expired_overwrite" | "overwrite";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details to identify the cookie being retrieved.
|
||||||
|
*/
|
||||||
|
interface GetDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL with which the cookie to retrieve is associated. This argument may be a full URL,
|
||||||
|
* in which case any data following the URL path (e.g. the query string) is simply ignored.
|
||||||
|
* If host permissions for this URL are not specified in the manifest file, the API call will fail.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the cookie to retrieve.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store
|
||||||
|
* will be used.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
storeId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The first-party domain which the cookie to retrieve is associated. This attribute is required if First-Party Isolation
|
||||||
|
* is enabled.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
firstPartyDomain?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The storage partition, if the cookie is part of partitioned storage. By default, only non-partitioned cookies are
|
||||||
|
* returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information to filter the cookies being retrieved.
|
||||||
|
*/
|
||||||
|
interface GetAllDetailsType {
|
||||||
|
/**
|
||||||
|
* Restricts the retrieved cookies to those that would match the given URL.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters the cookies by name.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restricts the retrieved cookies to those whose domains match or are subdomains of this one.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
domain?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restricts the retrieved cookies to those whose path exactly matches this string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
path?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters the cookies by their Secure property.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
secure?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters out session vs. persistent cookies.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
session?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
storeId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restricts the retrieved cookies to those whose first-party domains match this one.
|
||||||
|
* This attribute is required if First-Party Isolation is enabled. To not filter by a specific first-party domain,
|
||||||
|
* use `null` or `undefined`.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
firstPartyDomain?: string | null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Selects a specific storage partition to look up cookies. Defaults to null, in which case only non-partitioned cookies
|
||||||
|
* are retrieved. If an object iis passed, partitioned cookies are also included, and filtered based on the keys present in
|
||||||
|
* the given PartitionKey description. An empty object ({}) returns all cookies (partitioned + unpartitioned),
|
||||||
|
* a non-empty object (e.g. {topLevelSite: '...'}) only returns cookies whose partition match all given attributes.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details about the cookie being set.
|
||||||
|
*/
|
||||||
|
interface SetDetailsType {
|
||||||
|
/**
|
||||||
|
* The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of
|
||||||
|
* the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the cookie. Empty by default if omitted.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The value of the cookie. Empty by default if omitted.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
value?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The domain of the cookie. If omitted, the cookie becomes a host-only cookie.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
domain?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path of the cookie. Defaults to the path portion of the url parameter.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
path?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the cookie should be marked as Secure. Defaults to false.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
secure?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the cookie should be marked as HttpOnly. Defaults to false.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
httpOnly?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie's same-site status.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
sameSite?: SameSiteStatus;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted,
|
||||||
|
* the cookie becomes a session cookie.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
expirationDate?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's
|
||||||
|
* cookie store.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
storeId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The first-party domain of the cookie. This attribute is required if First-Party Isolation is enabled.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
firstPartyDomain?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The storage partition, if the cookie is part of partitioned storage. By default, non-partitioned storage is used.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information to identify the cookie to remove.
|
||||||
|
*/
|
||||||
|
interface RemoveDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file,
|
||||||
|
* the API call will fail.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the cookie to remove.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current
|
||||||
|
* execution context's cookie store.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
storeId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The first-party domain associated with the cookie. This attribute is required if First-Party Isolation is enabled.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
firstPartyDomain?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The storage partition, if the cookie is part of partitioned storage. By default, non-partitioned storage is used.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains details about the cookie that's been removed. If removal failed for any reason, this will be "null",
|
||||||
|
* and $(ref:runtime.lastError) will be set.
|
||||||
|
*/
|
||||||
|
interface RemoveCallbackDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL associated with the cookie that's been removed.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the cookie that's been removed.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the cookie store from which the cookie was removed.
|
||||||
|
*/
|
||||||
|
storeId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The first-party domain associated with the cookie that's been removed.
|
||||||
|
*/
|
||||||
|
firstPartyDomain: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The storage partition, if the cookie is part of partitioned storage. null if not partitioned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
partitionKey?: PartitionKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnChangedChangeInfoType {
|
||||||
|
/**
|
||||||
|
* True if a cookie was removed.
|
||||||
|
*/
|
||||||
|
removed: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about the cookie that was set or removed.
|
||||||
|
*/
|
||||||
|
cookie: Cookie;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The underlying reason behind the cookie's change.
|
||||||
|
*/
|
||||||
|
cause: OnChangedCause;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL,
|
||||||
|
* the one with the longest path will be returned. For cookies with the same path length,
|
||||||
|
* the cookie with the earliest creation time will be returned.
|
||||||
|
*
|
||||||
|
* @param details Details to identify the cookie being retrieved.
|
||||||
|
*/
|
||||||
|
get(details: GetDetailsType): Promise<Cookie>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted,
|
||||||
|
* with those with the longest path first. If multiple cookies have the same path length,
|
||||||
|
* those with the earliest creation time will be first.
|
||||||
|
*
|
||||||
|
* @param details Information to filter the cookies being retrieved.
|
||||||
|
*/
|
||||||
|
getAll(details: GetAllDetailsType): Promise<Cookie[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
|
||||||
|
*
|
||||||
|
* @param details Details about the cookie being set.
|
||||||
|
*/
|
||||||
|
set(details: SetDetailsType): Promise<Cookie>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes a cookie by name.
|
||||||
|
*
|
||||||
|
* @param details Information to identify the cookie to remove.
|
||||||
|
*/
|
||||||
|
remove(details: RemoveDetailsType): Promise<RemoveCallbackDetailsType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lists all existing cookie stores.
|
||||||
|
*/
|
||||||
|
getAllCookieStores(): Promise<CookieStore[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a
|
||||||
|
* two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of
|
||||||
|
* "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with
|
||||||
|
* "cause" "explicit".
|
||||||
|
*
|
||||||
|
* @param changeInfo
|
||||||
|
*/
|
||||||
|
onChanged: Events.Event<(changeInfo: OnChangedChangeInfoType) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,179 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.declarativeContent
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.declarativeContent</code> API to take actions depending on the content of a page,
|
||||||
|
* without requiring permission to read the page's content.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace DeclarativeContent {
|
||||||
|
/**
|
||||||
|
* See <a href="https://developer.mozilla.org/en-US/docs/Web/API/ImageData">https://developer.mozilla.
|
||||||
|
* org/en-US/docs/Web/API/ImageData</a>.
|
||||||
|
*/
|
||||||
|
interface ImageDataType extends ImageData {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches the state of a web page based on various criteria.
|
||||||
|
*/
|
||||||
|
interface PageStateMatcher {
|
||||||
|
/**
|
||||||
|
* Matches if the conditions of the <code>UrlFilter</code> are fulfilled for the top-level URL of the page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pageUrl?: Events.UrlFilter;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if all of the CSS selectors in the array match displayed elements in a frame with the same origin as the page's
|
||||||
|
* main frame. All selectors in this array must be <a href="http://www.w3.org/TR/selectors4/#compound">
|
||||||
|
* compound selectors</a> to speed up matching. Note: Listing hundreds of CSS selectors or listing CSS selectors that match
|
||||||
|
* hundreds of times per page can slow down web sites.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
css?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the bookmarked state of the page is equal to the specified value. Requres the <a href='declare_permissions'>
|
||||||
|
* bookmarks permission</a>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
isBookmarked?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Please use ShowAction.
|
||||||
|
*/
|
||||||
|
type ShowPageAction = never;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Declarative event action that shows the extension's toolbar action ($(ref:pageAction page action)
|
||||||
|
* or $(ref:browserAction browser action)) while the corresponding conditions are met.
|
||||||
|
* This action can be used without <a href="declare_permissions#host-permissions">host permissions</a>.
|
||||||
|
* If the extension has the <a href="activeTab.html">activeTab</a> permission, clicking the page action grants access to
|
||||||
|
* the active tab.
|
||||||
|
*/
|
||||||
|
interface ShowAction {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Declarative event action that sets the n-<abbr title="device-independent pixel">dip</abbr>
|
||||||
|
* square icon for the extension's $(ref:pageAction page action) or $(ref:browserAction browser action)
|
||||||
|
* while the corresponding conditions are met. This action can be used without <a href="declare_permissions.
|
||||||
|
* html#host-permissions">host permissions</a>, but the extension must have a page or browser action.<p>
|
||||||
|
* Exactly one of <code>imageData</code> or <code>path</code> must be specified. Both are dictionaries mapping a number of
|
||||||
|
* pixels to an image representation. The image representation in <code>imageData</code> is an <a href="https://developer.
|
||||||
|
* mozilla.org/en-US/docs/Web/API/ImageData">ImageData</a> object; for example, from a <code>canvas</code> element,
|
||||||
|
* while the image representation in <code>path</code> is the path to an image file relative to the extension's manifest.
|
||||||
|
* If <code>scale</code> screen pixels fit into a device-independent pixel, the <code>scale * n</code> icon is used.
|
||||||
|
* If that scale is missing, another image is resized to the required size.</p>
|
||||||
|
*/
|
||||||
|
interface SetIcon {
|
||||||
|
/**
|
||||||
|
* Either an <code>ImageData</code> object or a dictionary {size -> ImageData} representing an icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the image used is chosen depending on the screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>,
|
||||||
|
* then an image with size <code>scale * n</code> is selected, where <i>n</i> is the size of the icon in the UI.
|
||||||
|
* At least one image must be specified. Note that <code>details.imageData = foo</code> is equivalent to <code>details.
|
||||||
|
* imageData = {'16': foo}</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageData?: ImageDataType | SetIconImageDataC2Type;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Declarative event action that injects a content script. <p><b>WARNING:</b> This action is still experimental and is not
|
||||||
|
* supported on stable builds of Chrome.</p>
|
||||||
|
*/
|
||||||
|
interface RequestContentScript {
|
||||||
|
/**
|
||||||
|
* Names of CSS files to be injected as a part of the content script.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
css?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Names of JavaScript files to be injected as a part of the content script.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
js?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the content script runs in all frames of the matching page, or in only the top frame. Default is <code>
|
||||||
|
* false</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to insert the content script on <code>about:blank</code> and <code>about:srcdoc</code>. Default is <code>
|
||||||
|
* false</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
matchAboutBlank?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Rule<TCondition, TAction> {
|
||||||
|
/**
|
||||||
|
* List of conditions that can trigger the actions.
|
||||||
|
*/
|
||||||
|
conditions: TCondition[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of actions that are triggered if one of the conditions is fulfilled.
|
||||||
|
*/
|
||||||
|
actions: TAction[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object which allows the addition and removal of rules for declarative content.
|
||||||
|
*/
|
||||||
|
interface RuleEvent<TCondition, TAction> {
|
||||||
|
/**
|
||||||
|
* Registers rules to handle events.
|
||||||
|
*
|
||||||
|
* @param rules Rules to be registered. These do not replace previously registered rules.
|
||||||
|
*/
|
||||||
|
addRules(rules: Array<Rule<TCondition, TAction>>): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetches currently registered rules.
|
||||||
|
*
|
||||||
|
* @param rules Optional. Rule ids to fetch.
|
||||||
|
* @param callback Optional. Called when rules have been fetched.
|
||||||
|
*/
|
||||||
|
getRules(rules?: string[], callback?: (rules: Array<Rule<TCondition, TAction>>) => void): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unregisters currently registered rules.
|
||||||
|
*
|
||||||
|
* @param rules Optional. Rule ids to be unregistered.
|
||||||
|
* @param callback Optional. Called when rules were unregistered.
|
||||||
|
*/
|
||||||
|
removeRules(rules?: string[], callback?: () => void): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetIconImageDataC2Type {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
PageStateMatcher: { new (options?: PageStateMatcher): PageStateMatcher };
|
||||||
|
|
||||||
|
ShowAction: { new (options?: ShowAction): ShowAction };
|
||||||
|
|
||||||
|
SetIcon: { new (options?: SetIcon): SetIcon };
|
||||||
|
|
||||||
|
RequestContentScript: { new (options?: RequestContentScript): RequestContentScript };
|
||||||
|
|
||||||
|
onPageChanged: RuleEvent<PageStateMatcher, RequestContentScript | SetIcon | ShowPageAction | ShowAction>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,17 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.devtools
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "manifest:devtools_page"
|
||||||
|
*/
|
||||||
|
import { DevtoolsInspectedWindow } from "./devtools_inspectedWindow";
|
||||||
|
import { DevtoolsNetwork } from "./devtools_network";
|
||||||
|
import { DevtoolsPanels } from "./devtools_panels";
|
||||||
|
|
||||||
|
export namespace Devtools {
|
||||||
|
interface Static {
|
||||||
|
inspectedWindow: DevtoolsInspectedWindow.Static;
|
||||||
|
network: DevtoolsNetwork.Static;
|
||||||
|
panels: DevtoolsPanels.Static;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,123 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.devtools.inspectedWindow
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.devtools.inspectedWindow</code> API to interact with the inspected window: obtain the tab ID for
|
||||||
|
* the inspected page, evaluate the code in the context of the inspected window, reload the page,
|
||||||
|
* or obtain the list of resources within the page.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
export namespace DevtoolsInspectedWindow {
|
||||||
|
/**
|
||||||
|
* A resource within the inspected page, such as a document, a script, or an image.
|
||||||
|
*/
|
||||||
|
interface Resource {
|
||||||
|
/**
|
||||||
|
* The URL of the resource.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The options parameter can contain one or more options.
|
||||||
|
*/
|
||||||
|
interface EvalOptionsType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object providing details if an exception occurred while evaluating the expression.
|
||||||
|
*/
|
||||||
|
interface EvalCallbackExceptionInfoType {
|
||||||
|
/**
|
||||||
|
* Set if the error occurred on the DevTools side before the expression is evaluated.
|
||||||
|
*/
|
||||||
|
isError: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the error occurred on the DevTools side before the expression is evaluated.
|
||||||
|
*/
|
||||||
|
code: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the error occurred on the DevTools side before the expression is evaluated.
|
||||||
|
*/
|
||||||
|
description: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the error occurred on the DevTools side before the expression is evaluated,
|
||||||
|
* contains the array of the values that may be substituted into the description string to provide more information about
|
||||||
|
* the cause of the error.
|
||||||
|
*/
|
||||||
|
details: any[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the evaluated code produces an unhandled exception.
|
||||||
|
*/
|
||||||
|
isException: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set if the evaluated code produces an unhandled exception.
|
||||||
|
*/
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ReloadReloadOptionsType {
|
||||||
|
/**
|
||||||
|
* When true, the loader will bypass the cache for all inspected page resources loaded before the <code>load</code>
|
||||||
|
* event is fired. The effect is similar to pressing Ctrl+Shift+R in the inspected window or within the Developer Tools
|
||||||
|
* window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
ignoreCache?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If specified, the string will override the value of the <code>User-Agent</code> HTTP header that's sent while loading
|
||||||
|
* the resources of the inspected page. The string will also override the value of the <code>navigator.userAgent</code>
|
||||||
|
* property that's returned to any scripts that are running within the inspected page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
userAgent?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If specified, the script will be injected into every frame of the inspected page immediately upon load,
|
||||||
|
* before any of the frame's scripts. The script will not be injected after subsequent reloads—for example,
|
||||||
|
* if the user presses Ctrl+R.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
injectedScript?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Evaluates a JavaScript expression in the context of the main frame of the inspected page.
|
||||||
|
* The expression must evaluate to a JSON-compliant object, otherwise an exception is thrown.
|
||||||
|
* The eval function can report either a DevTools-side error or a JavaScript exception that occurs during evaluation.
|
||||||
|
* In either case, the <code>result</code> parameter of the callback is <code>undefined</code>.
|
||||||
|
* In the case of a DevTools-side error, the <code>isException</code> parameter is non-null and has <code>isError</code>
|
||||||
|
* set to true and <code>code</code> set to an error code. In the case of a JavaScript error, <code>isException</code>
|
||||||
|
* is set to true and <code>value</code> is set to the string value of thrown object.
|
||||||
|
*
|
||||||
|
* @param expression An expression to evaluate.
|
||||||
|
* @param options Optional. The options parameter can contain one or more options.
|
||||||
|
* @returns A function called when evaluation completes.
|
||||||
|
*/
|
||||||
|
eval(expression: string, options?: EvalOptionsType): Promise<[any, EvalCallbackExceptionInfoType]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reloads the inspected page.
|
||||||
|
*
|
||||||
|
* @param reloadOptions Optional.
|
||||||
|
*/
|
||||||
|
reload(reloadOptions?: ReloadReloadOptionsType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab being inspected. This ID may be used with chrome.tabs.* API.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,57 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.devtools.network
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.devtools.network</code> API to retrieve the information about network requests displayed by the
|
||||||
|
* Developer Tools in the Network panel.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace DevtoolsNetwork {
|
||||||
|
/**
|
||||||
|
* Represents a network request for a document resource (script, image and so on). See HAR Specification for reference.
|
||||||
|
*/
|
||||||
|
interface Request {
|
||||||
|
/**
|
||||||
|
* Returns content of the response body.
|
||||||
|
*
|
||||||
|
* @returns A function that receives the response body when the request completes.
|
||||||
|
*/
|
||||||
|
getContent(): Promise<[string, string]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A HAR log. See HAR specification for details.
|
||||||
|
*/
|
||||||
|
interface GetHARCallbackHarLogType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns HAR log that contains all known network requests.
|
||||||
|
*
|
||||||
|
* @returns A function that receives the HAR log when the request completes.
|
||||||
|
*/
|
||||||
|
getHAR(): Promise<GetHARCallbackHarLogType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a network request is finished and all request data are available.
|
||||||
|
*
|
||||||
|
* @param request Description of a network request in the form of a HAR entry. See HAR specification for details.
|
||||||
|
*/
|
||||||
|
onRequestFinished: Events.Event<(request: Request) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the inspected window navigates to a new page.
|
||||||
|
*
|
||||||
|
* @param url URL of the new page.
|
||||||
|
*/
|
||||||
|
onNavigated: Events.Event<(url: string) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,150 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.devtools.panels
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.devtools.panels</code> API to integrate your extension into Developer Tools window UI: create your
|
||||||
|
* own panels, access existing panels, and add sidebars.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
|
||||||
|
export namespace DevtoolsPanels {
|
||||||
|
/**
|
||||||
|
* Represents the Elements panel.
|
||||||
|
*/
|
||||||
|
interface ElementsPanel {
|
||||||
|
/**
|
||||||
|
* Creates a pane within panel's sidebar.
|
||||||
|
*
|
||||||
|
* @param title Text that is displayed in sidebar caption.
|
||||||
|
* @returns A callback invoked when the sidebar is created.
|
||||||
|
*/
|
||||||
|
createSidebarPane(title: string): Promise<ExtensionSidebarPane>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an object is selected in the panel.
|
||||||
|
*/
|
||||||
|
onSelectionChanged: Events.Event<() => void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents the Sources panel.
|
||||||
|
*/
|
||||||
|
interface SourcesPanel {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Represents a panel created by extension.
|
||||||
|
*/
|
||||||
|
interface ExtensionPanel {
|
||||||
|
/**
|
||||||
|
* Fired when the user switches to the panel.
|
||||||
|
*
|
||||||
|
* @param window The JavaScript <code>window</code> object of panel's page.
|
||||||
|
*/
|
||||||
|
onShown: Events.Event<(window: Window) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the user switches away from the panel.
|
||||||
|
*/
|
||||||
|
onHidden: Events.Event<() => void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A sidebar created by the extension.
|
||||||
|
*/
|
||||||
|
interface ExtensionSidebarPane {
|
||||||
|
/**
|
||||||
|
* Sets an expression that is evaluated within the inspected page. The result is displayed in the sidebar pane.
|
||||||
|
*
|
||||||
|
* @param expression An expression to be evaluated in context of the inspected page. JavaScript objects and DOM nodes are
|
||||||
|
* displayed in an expandable tree similar to the console/watch.
|
||||||
|
* @param rootTitle Optional. An optional title for the root of the expression tree.
|
||||||
|
* @returns A callback invoked after the sidebar pane is updated with the expression evaluation results.
|
||||||
|
*/
|
||||||
|
setExpression(expression: string, rootTitle?: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets a JSON-compliant object to be displayed in the sidebar pane.
|
||||||
|
*
|
||||||
|
* @param jsonObject An object to be displayed in context of the inspected page. Evaluated in the context of the caller
|
||||||
|
* (API client).
|
||||||
|
* @param rootTitle Optional. An optional title for the root of the expression tree.
|
||||||
|
* @returns A callback invoked after the sidebar is updated with the object.
|
||||||
|
*/
|
||||||
|
setObject(jsonObject: string | unknown[] | Record<string, unknown>, rootTitle?: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets an HTML page to be displayed in the sidebar pane.
|
||||||
|
*
|
||||||
|
* @param path Relative path of an extension page to display within the sidebar.
|
||||||
|
*/
|
||||||
|
setPage(path: Manifest.ExtensionURL): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the sidebar pane becomes visible as a result of user switching to the panel that hosts it.
|
||||||
|
*
|
||||||
|
* @param window The JavaScript <code>window</code> object of the sidebar page, if one was set with the <code>setPage()
|
||||||
|
* </code> method.
|
||||||
|
*/
|
||||||
|
onShown: Events.Event<(window: Window) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the sidebar pane becomes hidden as a result of the user switching away from the panel that hosts the sidebar
|
||||||
|
* pane.
|
||||||
|
*/
|
||||||
|
onHidden: Events.Event<() => void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A button created by the extension.
|
||||||
|
*/
|
||||||
|
interface Button {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Creates an extension panel.
|
||||||
|
*
|
||||||
|
* @param title Title that is displayed next to the extension icon in the Developer Tools toolbar.
|
||||||
|
* @param iconPath Path of the panel's icon relative to the extension directory, or an empty string to use the default
|
||||||
|
* extension icon as the panel icon.
|
||||||
|
* @param pagePath Path of the panel's HTML page relative to the extension directory.
|
||||||
|
* @returns A function that is called when the panel is created.
|
||||||
|
*/
|
||||||
|
create(
|
||||||
|
title: string,
|
||||||
|
iconPath: "" | Manifest.ExtensionURL,
|
||||||
|
pagePath: Manifest.ExtensionURL
|
||||||
|
): Promise<ExtensionPanel>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the devtools theme changes.
|
||||||
|
*
|
||||||
|
* @param themeName The name of the current devtools theme.
|
||||||
|
*/
|
||||||
|
onThemeChanged: Events.Event<(themeName: string) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Elements panel.
|
||||||
|
*/
|
||||||
|
elements: ElementsPanel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sources panel.
|
||||||
|
*/
|
||||||
|
sources: SourcesPanel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the current devtools theme.
|
||||||
|
*/
|
||||||
|
themeName: string;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,51 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.dns
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Asynchronous DNS API
|
||||||
|
* Permissions: "dns"
|
||||||
|
*/
|
||||||
|
export namespace Dns {
|
||||||
|
/**
|
||||||
|
* An object encapsulating a DNS Record.
|
||||||
|
*/
|
||||||
|
interface DNSRecord {
|
||||||
|
/**
|
||||||
|
* The canonical hostname for this record. this value is empty if the record was not fetched with the 'canonical_name'
|
||||||
|
* flag.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
canonicalName?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Record retreived with TRR.
|
||||||
|
*/
|
||||||
|
isTRR: string;
|
||||||
|
|
||||||
|
addresses: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
type ResolveFlags = ResolveFlagsItemEnum[];
|
||||||
|
|
||||||
|
type ResolveFlagsItemEnum =
|
||||||
|
| "allow_name_collisions"
|
||||||
|
| "bypass_cache"
|
||||||
|
| "canonical_name"
|
||||||
|
| "disable_ipv4"
|
||||||
|
| "disable_ipv6"
|
||||||
|
| "disable_trr"
|
||||||
|
| "offline"
|
||||||
|
| "priority_low"
|
||||||
|
| "priority_medium"
|
||||||
|
| "speculate";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Resolves a hostname to a DNS record.
|
||||||
|
*
|
||||||
|
* @param hostname
|
||||||
|
* @param flags Optional.
|
||||||
|
*/
|
||||||
|
resolve(hostname: string, flags?: ResolveFlags): Promise<DNSRecord>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,658 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.downloads
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "downloads"
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Downloads {
|
||||||
|
type FilenameConflictAction = "uniquify" | "overwrite" | "prompt";
|
||||||
|
|
||||||
|
type InterruptReason =
|
||||||
|
| "FILE_FAILED"
|
||||||
|
| "FILE_ACCESS_DENIED"
|
||||||
|
| "FILE_NO_SPACE"
|
||||||
|
| "FILE_NAME_TOO_LONG"
|
||||||
|
| "FILE_TOO_LARGE"
|
||||||
|
| "FILE_VIRUS_INFECTED"
|
||||||
|
| "FILE_TRANSIENT_ERROR"
|
||||||
|
| "FILE_BLOCKED"
|
||||||
|
| "FILE_SECURITY_CHECK_FAILED"
|
||||||
|
| "FILE_TOO_SHORT"
|
||||||
|
| "NETWORK_FAILED"
|
||||||
|
| "NETWORK_TIMEOUT"
|
||||||
|
| "NETWORK_DISCONNECTED"
|
||||||
|
| "NETWORK_SERVER_DOWN"
|
||||||
|
| "NETWORK_INVALID_REQUEST"
|
||||||
|
| "SERVER_FAILED"
|
||||||
|
| "SERVER_NO_RANGE"
|
||||||
|
| "SERVER_BAD_CONTENT"
|
||||||
|
| "SERVER_UNAUTHORIZED"
|
||||||
|
| "SERVER_CERT_PROBLEM"
|
||||||
|
| "SERVER_FORBIDDEN"
|
||||||
|
| "USER_CANCELED"
|
||||||
|
| "USER_SHUTDOWN"
|
||||||
|
| "CRASH";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <dl><dt>file</dt><dd>The download's filename is suspicious.</dd><dt>url</dt><dd>The download's URL is known to be
|
||||||
|
* malicious.</dd><dt>content</dt><dd>The downloaded file is known to be malicious.</dd><dt>uncommon</dt><dd>
|
||||||
|
* The download's URL is not commonly downloaded and could be dangerous.</dd><dt>safe</dt><dd>
|
||||||
|
* The download presents no known danger to the user's computer.</dd></dl>These string constants will never change,
|
||||||
|
* however the set of DangerTypes may change.
|
||||||
|
*/
|
||||||
|
type DangerType = "file" | "url" | "content" | "uncommon" | "host" | "unwanted" | "safe" | "accepted";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <dl><dt>in_progress</dt><dd>The download is currently receiving data from the server.</dd><dt>interrupted</dt><dd>
|
||||||
|
* An error broke the connection with the file host.</dd><dt>complete</dt><dd>The download completed successfully.</dd></dl>
|
||||||
|
* These string constants will never change, however the set of States may change.
|
||||||
|
*/
|
||||||
|
type State = "in_progress" | "interrupted" | "complete";
|
||||||
|
|
||||||
|
interface DownloadItem {
|
||||||
|
/**
|
||||||
|
* An identifier that is persistent across browser sessions.
|
||||||
|
*/
|
||||||
|
id: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Absolute URL.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
referrer?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Absolute local path.
|
||||||
|
*/
|
||||||
|
filename: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* False if this download is recorded in the history, true if it is not recorded.
|
||||||
|
*/
|
||||||
|
incognito: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store ID of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indication of whether this download is thought to be safe or known to be suspicious.
|
||||||
|
*/
|
||||||
|
danger: DangerType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The file's MIME type.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
mime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of milliseconds between the unix epoch and when this download began.
|
||||||
|
*/
|
||||||
|
startTime: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of milliseconds between the unix epoch and when this download ended.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endTime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
estimatedEndTime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates whether the download is progressing, interrupted, or complete.
|
||||||
|
*/
|
||||||
|
state: State;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the download has stopped reading data from the host, but kept the connection open.
|
||||||
|
*/
|
||||||
|
paused: boolean;
|
||||||
|
|
||||||
|
canResume: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number indicating why a download was interrupted.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
error?: InterruptReason;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes received so far from the host, without considering file compression.
|
||||||
|
*/
|
||||||
|
bytesReceived: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes in the whole file, without considering file compression, or -1 if unknown.
|
||||||
|
*/
|
||||||
|
totalBytes: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes in the whole file post-decompression, or -1 if unknown.
|
||||||
|
*/
|
||||||
|
fileSize: number;
|
||||||
|
|
||||||
|
exists: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
byExtensionId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
byExtensionName?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface StringDelta {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
current?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
previous?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DoubleDelta {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
current?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
previous?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface BooleanDelta {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
current?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
previous?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A time specified as a Date object, a number or string representing milliseconds since the epoch, or an ISO 8601 string
|
||||||
|
*/
|
||||||
|
type DownloadTime = string | ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameters that combine to specify a predicate that can be used to select a set of downloads.
|
||||||
|
* Used for example in search() and erase()
|
||||||
|
*/
|
||||||
|
interface DownloadQuery {
|
||||||
|
/**
|
||||||
|
* This array of search terms limits results to <a href='#type-DownloadItem'>DownloadItems</a> whose <code>filename</code>
|
||||||
|
* or <code>url</code> contain all of the search terms that do not begin with a dash '-' and none of the search terms that
|
||||||
|
* do begin with a dash.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
query?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads that started before the given ms since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
startedBefore?: DownloadTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads that started after the given ms since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
startedAfter?: DownloadTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads that ended before the given ms since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endedBefore?: DownloadTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads that ended after the given ms since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endedAfter?: DownloadTime;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads whose totalBytes is greater than the given integer.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
totalBytesGreater?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to downloads whose totalBytes is less than the given integer.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
totalBytesLess?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to <a href='#type-DownloadItem'>DownloadItems</a> whose <code>filename</code>
|
||||||
|
* matches the given regular expression.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
filenameRegex?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limits results to <a href='#type-DownloadItem'>DownloadItems</a> whose <code>url</code>
|
||||||
|
* matches the given regular expression.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlRegex?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Setting this integer limits the number of results. Otherwise, all matching <a href='#type-DownloadItem'>DownloadItems</a>
|
||||||
|
* will be returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
limit?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Setting elements of this array to <a href='#type-DownloadItem'>DownloadItem</a> properties in order to sort the search
|
||||||
|
* results. For example, setting <code>orderBy='startTime'</code> sorts the <a href='#type-DownloadItem'>DownloadItems</a>
|
||||||
|
* by their start time in ascending order. To specify descending order, prefix <code>orderBy</code>
|
||||||
|
* with a hyphen: '-startTime'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
orderBy?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Absolute URL.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Absolute local path.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
filename?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store ID of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indication of whether this download is thought to be safe or known to be suspicious.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
danger?: DangerType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The file's MIME type.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
mime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
startTime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endTime?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates whether the download is progressing, interrupted, or complete.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
state?: State;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True if the download has stopped reading data from the host, but kept the connection open.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
paused?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Why a download was interrupted.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
error?: InterruptReason;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes received so far from the host, without considering file compression.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
bytesReceived?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes in the whole file, without considering file compression, or -1 if unknown.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
totalBytes?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of bytes in the whole file post-decompression, or -1 if unknown.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
fileSize?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
exists?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* What to download and how.
|
||||||
|
*/
|
||||||
|
interface DownloadOptionsType {
|
||||||
|
/**
|
||||||
|
* The URL to download.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A file path relative to the Downloads directory to contain the downloaded file.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
filename?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to associate the download with a private browsing session.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognito?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store ID of the contextual identity; requires "cookies" permission.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
conflictAction?: FilenameConflictAction;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use a file-chooser to allow the user to select a filename. If the option is not specified,
|
||||||
|
* the file chooser will be shown only if the Firefox "Always ask you where to save files" option is enabled (i.e.
|
||||||
|
* the pref <code>browser.download.useDownloadDir</code> is set to <code>false</code>).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
saveAs?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The HTTP method to use if the URL uses the HTTP[S] protocol.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
method?: DownloadOptionsTypeMethodEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a
|
||||||
|
* dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>,
|
||||||
|
* restricted to those allowed by XMLHttpRequest.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
headers?: DownloadOptionsTypeHeadersItemType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Post body.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
body?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When this flag is set to <code>true</code>, then the browser will allow downloads to proceed after encountering HTTP
|
||||||
|
* errors such as <code>404 Not Found</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allowHttpErrors?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetFileIconOptionsType {
|
||||||
|
/**
|
||||||
|
* The size of the icon. The returned icon will be square with dimensions size * size pixels.
|
||||||
|
* The default size for the icon is 32x32 pixels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
size?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnChangedDownloadDeltaType {
|
||||||
|
/**
|
||||||
|
* The <code>id</code> of the <a href='#type-DownloadItem'>DownloadItem</a> that changed.
|
||||||
|
*/
|
||||||
|
id: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>url</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>filename</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
filename?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>danger</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
danger?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>mime</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
mime?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>startTime</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
startTime?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>endTime</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endTime?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>state</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
state?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
canResume?: BooleanDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>paused</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
paused?: BooleanDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>error</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
error?: StringDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>totalBytes</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
totalBytes?: DoubleDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describes a change in a <a href='#type-DownloadItem'>DownloadItem</a>'s <code>fileSize</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
fileSize?: DoubleDelta;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
exists?: BooleanDelta;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The HTTP method to use if the URL uses the HTTP[S] protocol.
|
||||||
|
*/
|
||||||
|
type DownloadOptionsTypeMethodEnum = "GET" | "POST";
|
||||||
|
|
||||||
|
interface DownloadOptionsTypeHeadersItemType {
|
||||||
|
/**
|
||||||
|
* Name of the HTTP header.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Value of the HTTP header.
|
||||||
|
*/
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Download a URL. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its
|
||||||
|
* hostname. If both <code>filename</code> and <code>saveAs</code> are specified, then the Save As dialog will be displayed,
|
||||||
|
* pre-populated with the specified <code>filename</code>. If the download started successfully, <code>callback</code>
|
||||||
|
* will be called with the new <a href='#type-DownloadItem'>DownloadItem</a>'s <code>downloadId</code>.
|
||||||
|
* If there was an error starting the download, then <code>callback</code> will be called with <code>
|
||||||
|
* downloadId=undefined</code> and <a href='extension.html#property-lastError'>chrome.extension.lastError</a>
|
||||||
|
* will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases.
|
||||||
|
* You must not parse it.
|
||||||
|
*
|
||||||
|
* @param options What to download and how.
|
||||||
|
*/
|
||||||
|
download(options: DownloadOptionsType): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find <a href='#type-DownloadItem'>DownloadItems</a>. Set <code>query</code> to the empty object to get all <a
|
||||||
|
* href='#type-DownloadItem'>DownloadItems</a>. To get a specific <a href='#type-DownloadItem'>DownloadItem</a>,
|
||||||
|
* set only the <code>id</code> field.
|
||||||
|
*
|
||||||
|
* @param query
|
||||||
|
*/
|
||||||
|
search(query: DownloadQuery): Promise<DownloadItem[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pause the download. If the request was successful the download is in a paused state. Otherwise <a href='extension.
|
||||||
|
* html#property-lastError'>chrome.extension.lastError</a> contains an error message.
|
||||||
|
* The request will fail if the download is not active.
|
||||||
|
*
|
||||||
|
* @param downloadId The id of the download to pause.
|
||||||
|
*/
|
||||||
|
pause(downloadId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resume a paused download. If the request was successful the download is in progress and unpaused.
|
||||||
|
* Otherwise <a href='extension.html#property-lastError'>chrome.extension.lastError</a> contains an error message.
|
||||||
|
* The request will fail if the download is not active.
|
||||||
|
*
|
||||||
|
* @param downloadId The id of the download to resume.
|
||||||
|
*/
|
||||||
|
resume(downloadId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cancel a download. When <code>callback</code> is run, the download is cancelled, completed,
|
||||||
|
* interrupted or doesn't exist anymore.
|
||||||
|
*
|
||||||
|
* @param downloadId The id of the download to cancel.
|
||||||
|
*/
|
||||||
|
cancel(downloadId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve an icon for the specified download. For new downloads, file icons are available after the <a
|
||||||
|
* href='#event-onCreated'>onCreated</a> event has been received. The image returned by this function while a download is
|
||||||
|
* in progress may be different from the image returned after the download is complete.
|
||||||
|
* Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform.
|
||||||
|
* The icon that is returned will therefore depend on a number of factors including state of the download, platform,
|
||||||
|
* registered file types and visual theme. If a file icon cannot be determined, <a href='extension.
|
||||||
|
* html#property-lastError'>chrome.extension.lastError</a> will contain an error message.
|
||||||
|
*
|
||||||
|
* @param downloadId The identifier for the download.
|
||||||
|
* @param options Optional.
|
||||||
|
*/
|
||||||
|
getFileIcon(downloadId: number, options?: GetFileIconOptionsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open the downloaded file.
|
||||||
|
*
|
||||||
|
* @param downloadId
|
||||||
|
*/
|
||||||
|
open(downloadId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the downloaded file in its folder in a file manager.
|
||||||
|
*
|
||||||
|
* @param downloadId
|
||||||
|
*/
|
||||||
|
show(downloadId: number): Promise<boolean>;
|
||||||
|
|
||||||
|
showDefaultFolder(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Erase matching <a href='#type-DownloadItem'>DownloadItems</a> from history
|
||||||
|
*
|
||||||
|
* @param query
|
||||||
|
*/
|
||||||
|
erase(query: DownloadQuery): Promise<number[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param downloadId
|
||||||
|
*/
|
||||||
|
removeFile(downloadId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This event fires with the <a href='#type-DownloadItem'>DownloadItem</a> object when a download begins.
|
||||||
|
*
|
||||||
|
* @param downloadItem
|
||||||
|
*/
|
||||||
|
onCreated: Events.Event<(downloadItem: DownloadItem) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fires with the <code>downloadId</code> when a download is erased from history.
|
||||||
|
*
|
||||||
|
* @param downloadId The <code>id</code> of the <a href='#type-DownloadItem'>DownloadItem</a> that was erased.
|
||||||
|
*/
|
||||||
|
onErased: Events.Event<(downloadId: number) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When any of a <a href='#type-DownloadItem'>DownloadItem</a>'s properties except <code>bytesReceived</code> changes,
|
||||||
|
* this event fires with the <code>downloadId</code> and an object containing the properties that changed.
|
||||||
|
*
|
||||||
|
* @param downloadDelta
|
||||||
|
*/
|
||||||
|
onChanged: Events.Event<(downloadDelta: OnChangedDownloadDeltaType) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,219 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.events
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The <code>chrome.events</code> namespace contains common types used by APIs dispatching events to notify you when
|
||||||
|
* something interesting happens.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
export namespace Events {
|
||||||
|
/**
|
||||||
|
* Description of a declarative rule for handling events.
|
||||||
|
*/
|
||||||
|
interface Rule {
|
||||||
|
/**
|
||||||
|
* Optional identifier that allows referencing this rule.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tags can be used to annotate rules and perform operations on sets of rules.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tags?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of conditions that can trigger the actions.
|
||||||
|
*/
|
||||||
|
conditions: any[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of actions that are triggered if one of the condtions is fulfilled.
|
||||||
|
*/
|
||||||
|
actions: any[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional priority of this rule. Defaults to 100.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
priority?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object which allows the addition and removal of listeners for a Chrome event.
|
||||||
|
*/
|
||||||
|
interface Event<T extends (...args: any[]) => any> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param ...params Further parameters, depending on the event.
|
||||||
|
*/
|
||||||
|
addListener(callback: T, ...params: any[]): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deregisters an event listener <em>callback</em> from an event.
|
||||||
|
*
|
||||||
|
* @param callback Listener that shall be unregistered.
|
||||||
|
*/
|
||||||
|
removeListener(callback: T): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param callback Listener whose registration status shall be tested.
|
||||||
|
* @returns True if <em>callback</em> is registered to the event.
|
||||||
|
*/
|
||||||
|
hasListener(callback: T): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns True if any event listeners are registered to the event.
|
||||||
|
*/
|
||||||
|
hasListeners(): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters URLs for various criteria. See <a href='events#filtered'>event filtering</a>. All criteria are case sensitive.
|
||||||
|
*/
|
||||||
|
interface UrlFilter {
|
||||||
|
/**
|
||||||
|
* Matches if the host name of the URL contains a specified string. To test whether a host name component has a prefix
|
||||||
|
* 'foo', use hostContains: '.foo'. This matches 'www.foobar.com' and 'foo.com', because an implicit dot is added at the
|
||||||
|
* beginning of the host name. Similarly, hostContains can be used to match against component suffix ('foo.')
|
||||||
|
* and to exactly match against components ('.foo.'). Suffix- and exact-matching for the last components need to be done
|
||||||
|
* separately using hostSuffix, because no implicit dot is added at the end of the host name.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostContains?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the host name of the URL is equal to a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostEquals?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the host name of the URL starts with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostPrefix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the host name of the URL ends with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostSuffix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the path segment of the URL contains a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pathContains?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the path segment of the URL is equal to a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pathEquals?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the path segment of the URL starts with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pathPrefix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the path segment of the URL ends with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pathSuffix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the query segment of the URL contains a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
queryContains?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the query segment of the URL is equal to a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
queryEquals?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the query segment of the URL starts with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
queryPrefix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the query segment of the URL ends with a specified string.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
querySuffix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if
|
||||||
|
* they match the default port number.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlContains?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL
|
||||||
|
* if they match the default port number.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlEquals?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL (without fragment identifier) matches a specified regular expression.
|
||||||
|
* Port numbers are stripped from the URL if they match the default port number. The regular expressions use the <a
|
||||||
|
* href="https://github.com/google/re2/blob/master/doc/syntax.txt">RE2 syntax</a>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlMatches?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL without query segment and fragment identifier matches a specified regular expression.
|
||||||
|
* Port numbers are stripped from the URL if they match the default port number. The regular expressions use the <a
|
||||||
|
* href="https://github.com/google/re2/blob/master/doc/syntax.txt">RE2 syntax</a>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
originAndPathMatches?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL
|
||||||
|
* if they match the default port number.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlPrefix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if
|
||||||
|
* they match the default port number.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
urlSuffix?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the scheme of the URL is equal to any of the schemes specified in the array.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
schemes?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Matches if the port of the URL is contained in any of the specified port lists. For example <code>[80, 443, [1000, 1200]]
|
||||||
|
* </code> matches all requests on port 80, 443 and in the range 1000-1200.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
ports?: Array<number | [number, number]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,64 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.experiments
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*/
|
||||||
|
export namespace Experiments {
|
||||||
|
interface ExperimentAPI {
|
||||||
|
schema: ExperimentURL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parent?: ExperimentAPIParentType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
child?: ExperimentAPIChildType;
|
||||||
|
}
|
||||||
|
|
||||||
|
type ExperimentURL = string;
|
||||||
|
|
||||||
|
type APIPaths = APIPath[];
|
||||||
|
|
||||||
|
type APIPath = string[];
|
||||||
|
|
||||||
|
type APIEvents = APIEvent[];
|
||||||
|
|
||||||
|
type APIEvent = "startup";
|
||||||
|
|
||||||
|
type APIParentScope = "addon_parent" | "content_parent" | "devtools_parent";
|
||||||
|
|
||||||
|
type APIChildScope = "addon_child" | "content_child" | "devtools_child";
|
||||||
|
|
||||||
|
interface ExperimentAPIParentType {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
events?: APIEvents;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
paths?: APIPaths;
|
||||||
|
|
||||||
|
script: ExperimentURL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
scopes?: APIParentScope[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ExperimentAPIChildType {
|
||||||
|
paths: APIPaths;
|
||||||
|
|
||||||
|
script: ExperimentURL;
|
||||||
|
|
||||||
|
scopes: APIChildScope[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,75 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.extension
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The <code>browser.extension</code> API has utilities that can be used by any extension page.
|
||||||
|
* It includes support for exchanging messages between an extension and its content scripts or between extensions,
|
||||||
|
* as described in detail in $(topic:messaging)[Message Passing].
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
export namespace Extension {
|
||||||
|
/**
|
||||||
|
* The type of extension view.
|
||||||
|
*/
|
||||||
|
type ViewType = "tab" | "popup" | "sidebar";
|
||||||
|
|
||||||
|
interface GetViewsFetchPropertiesType {
|
||||||
|
/**
|
||||||
|
* The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab',
|
||||||
|
* 'popup', 'sidebar'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: ViewType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The window to restrict the search to. If omitted, returns all views.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find a view according to a tab id. If this field is omitted, returns all views.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.
|
||||||
|
*
|
||||||
|
* @param fetchProperties Optional.
|
||||||
|
* @returns Array of global objects
|
||||||
|
*/
|
||||||
|
getViews(fetchProperties?: GetViewsFetchPropertiesType): Window[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the JavaScript 'window' object for the background page running inside the current extension.
|
||||||
|
* Returns null if the extension has no background page.
|
||||||
|
*/
|
||||||
|
getBackgroundPage(): Window;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in
|
||||||
|
* Incognito' checkbox.
|
||||||
|
*/
|
||||||
|
isAllowedIncognitoAccess(): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow
|
||||||
|
* access to File URLs' checkbox.
|
||||||
|
*/
|
||||||
|
isAllowedFileSchemeAccess(): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process.
|
||||||
|
* The latter only applies to extensions with 'split' incognito_behavior.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
inIncognitoContext?: boolean;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,154 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.extensionTypes
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The <code>browser.extensionTypes</code> API contains type declarations for WebExtensions.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright 2014 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
|
||||||
|
export namespace ExtensionTypes {
|
||||||
|
/**
|
||||||
|
* The format of an image.
|
||||||
|
*/
|
||||||
|
type ImageFormat = "jpeg" | "png";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details about the format, quality, area and scale of the capture.
|
||||||
|
*/
|
||||||
|
interface ImageDetails {
|
||||||
|
/**
|
||||||
|
* The format of the resulting image. Default is <code>"jpeg"</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
format?: ImageFormat;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When format is <code>"jpeg"</code>, controls the quality of the resulting image. This value is ignored for PNG images.
|
||||||
|
* As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store
|
||||||
|
* it will decrease.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
quality?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The area of the document to capture, in CSS pixels, relative to the page. If omitted, capture the visible viewport.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
rect?: ImageDetailsRectType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The scale of the resulting image. Defaults to <code>devicePixelRatio</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
scale?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If true, temporarily resets the scroll position of the document to 0. Only takes effect if rect is also specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
resetScrollPosition?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The soonest that the JavaScript or CSS will be injected into the tab.
|
||||||
|
*/
|
||||||
|
type RunAt = "document_start" | "document_end" | "document_idle";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The origin of the CSS to inject, this affects the cascading order (priority) of the stylesheet.
|
||||||
|
*/
|
||||||
|
type CSSOrigin = "user" | "author";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details of the script or CSS to inject. Either the code or the file property must be set,
|
||||||
|
* but both may not be set at the same time.
|
||||||
|
*/
|
||||||
|
interface InjectDetails {
|
||||||
|
/**
|
||||||
|
* JavaScript or CSS code to inject.<br><br><b>Warning:</b><br>Be careful using the <code>code</code> parameter.
|
||||||
|
* Incorrect use of it may open your extension to <a href="https://en.wikipedia.org/wiki/Cross-site_scripting">
|
||||||
|
* cross site scripting</a> attacks.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
code?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* JavaScript or CSS file to inject.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
file?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If allFrames is <code>true</code>, implies that the JavaScript or CSS should be injected into all frames of current page.
|
||||||
|
* By default, it's <code>false</code> and is only injected into the top frame.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has
|
||||||
|
* access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is <code>false</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
matchAboutBlank?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the frame to inject the script into. This may not be used in combination with <code>allFrames</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The soonest that the JavaScript or CSS will be injected into the tab. Defaults to "document_idle".
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
runAt?: RunAt;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The css origin of the stylesheet to inject. Defaults to "author".
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cssOrigin?: CSSOrigin;
|
||||||
|
}
|
||||||
|
|
||||||
|
type DateType = string | number | Date;
|
||||||
|
|
||||||
|
type ExtensionFileOrCode = ExtensionFileOrCodeC1Type | ExtensionFileOrCodeC2Type;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A plain JSON value
|
||||||
|
*/
|
||||||
|
interface PlainJSONValue {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The area of the document to capture, in CSS pixels, relative to the page. If omitted, capture the visible viewport.
|
||||||
|
*/
|
||||||
|
interface ImageDetailsRectType {
|
||||||
|
x: number;
|
||||||
|
|
||||||
|
y: number;
|
||||||
|
|
||||||
|
width: number;
|
||||||
|
|
||||||
|
height: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ExtensionFileOrCodeC1Type {
|
||||||
|
file: Manifest.ExtensionURL;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ExtensionFileOrCodeC2Type {
|
||||||
|
code: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,200 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.find
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.find</code> API to interact with the browser's <code>Find</code> interface.
|
||||||
|
* Permissions: "find"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
export namespace Find {
|
||||||
|
interface RangeData {
|
||||||
|
/**
|
||||||
|
* The index of the frame containing the match. 0 corresponds to the parent window. Note that the order of objects in the
|
||||||
|
* rangeData array will sequentially line up with the order of frame indexes: for example,
|
||||||
|
* framePos for the first sequence of rangeData objects will be 0, framePos for the next sequence will be 1, and so on.
|
||||||
|
*/
|
||||||
|
framePos: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ordinal position of the text node in which the match started.
|
||||||
|
*/
|
||||||
|
startTextNodePos: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ordinal position of the text node in which the match ended.
|
||||||
|
*/
|
||||||
|
endTextNodePos: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ordinal string position of the start of the matched word within start text node.
|
||||||
|
* If match word include in single text node, Extension can get match word between startOffset and endOffset string index
|
||||||
|
* in the single text node.
|
||||||
|
*/
|
||||||
|
startOffset: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ordinal string position of the end of the matched word within end text node.
|
||||||
|
*/
|
||||||
|
endOffset: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Rectangle {
|
||||||
|
/**
|
||||||
|
* Pixels from the top.
|
||||||
|
*/
|
||||||
|
top: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pixels from the left.
|
||||||
|
*/
|
||||||
|
left: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pixels from the bottom.
|
||||||
|
*/
|
||||||
|
bottom: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pixels from the right.
|
||||||
|
*/
|
||||||
|
right: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RectsAndTexts {
|
||||||
|
/**
|
||||||
|
* Rectangles relative to the top-left of the viewport.
|
||||||
|
*/
|
||||||
|
rectList: Rectangle[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* an array of strings, corresponding to the rectList array. The entry at textList[i]
|
||||||
|
* contains the part of the match bounded by the rectangle at rectList[i].
|
||||||
|
*/
|
||||||
|
textList: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface RectData {
|
||||||
|
/**
|
||||||
|
* The index of the frame containing the match. 0 corresponds to the parent window. Note that the order of objects in the
|
||||||
|
* rangeData array will sequentially line up with the order of frame indexes: for example,
|
||||||
|
* framePos for the first sequence of rangeData objects will be 0, framePos for the next sequence will be 1, and so on.
|
||||||
|
*/
|
||||||
|
rectsAndTexts: RectsAndTexts;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The complete text of the match.
|
||||||
|
*/
|
||||||
|
text: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface FindResult {
|
||||||
|
/**
|
||||||
|
* The number of results found.
|
||||||
|
*/
|
||||||
|
count: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If includeRangeData was given in the options parameter, then this property will be included.
|
||||||
|
* It is provided as an array of RangeData objects, one for each match. Each RangeData object describes where in the DOM
|
||||||
|
* tree the match was found. This would enable, for example, an extension to get the text surrounding each match,
|
||||||
|
* so as to display context for the matches. The items correspond to the items given in rectData, so rangeData[i]
|
||||||
|
* describes the same match as rectData[i].
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
rangeData?: RangeData[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If includeRectData was given in the options parameter, then this property will be included.
|
||||||
|
* It is an array of RectData objects. It contains client rectangles for all the text matched in the search,
|
||||||
|
* relative to the top-left of the viewport. Extensions can use this to provide custom highlighting of the results.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
rectData?: RectData[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search parameters.
|
||||||
|
*/
|
||||||
|
interface FindParamsType {
|
||||||
|
/**
|
||||||
|
* Tab to query. Defaults to the active tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find only ranges with case sensitive match.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
caseSensitive?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find only ranges that match entire word.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
entireWord?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return rectangle data which describes visual position of search results.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeRectData?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return range data which provides range data in a serializable form.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeRangeData?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlightResults parameters
|
||||||
|
*/
|
||||||
|
interface HighlightResultsParamsType {
|
||||||
|
/**
|
||||||
|
* Found range to be highlighted. Default highlights all ranges.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
rangeIndex?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tab to highlight. Defaults to the active tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Don't scroll to highlighted item.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
noScroll?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Search for text in document and store found ranges in array, in document order.
|
||||||
|
*
|
||||||
|
* @param queryphrase The string to search for.
|
||||||
|
* @param params Optional. Search parameters.
|
||||||
|
*/
|
||||||
|
find(queryphrase: string, params?: FindParamsType): Promise<FindResult>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Highlight a range
|
||||||
|
*
|
||||||
|
* @param params Optional. highlightResults parameters
|
||||||
|
*/
|
||||||
|
highlightResults(params?: HighlightResultsParamsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove all highlighting from previous searches.
|
||||||
|
*
|
||||||
|
* @param tabId Optional. Tab to highlight. Defaults to the active tab.
|
||||||
|
*/
|
||||||
|
removeHighlighting(tabId?: number): Promise<void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,134 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.geckoProfiler
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Exposes the browser's profiler.
|
||||||
|
* Permissions: "geckoProfiler"
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace GeckoProfiler {
|
||||||
|
type ProfilerFeature =
|
||||||
|
| "java"
|
||||||
|
| "js"
|
||||||
|
| "leaf"
|
||||||
|
| "mainthreadio"
|
||||||
|
| "fileio"
|
||||||
|
| "fileioall"
|
||||||
|
| "noiostacks"
|
||||||
|
| "screenshots"
|
||||||
|
| "seqstyle"
|
||||||
|
| "stackwalk"
|
||||||
|
| "threads"
|
||||||
|
| "jstracer"
|
||||||
|
| "jsallocations"
|
||||||
|
| "nostacksampling"
|
||||||
|
| "preferencereads"
|
||||||
|
| "nativeallocations"
|
||||||
|
| "ipcmessages"
|
||||||
|
| "audiocallbacktracing"
|
||||||
|
| "cpu"
|
||||||
|
| "notimerresolutionchange"
|
||||||
|
| "cpuallthreads"
|
||||||
|
| "samplingallthreads"
|
||||||
|
| "markersallthreads"
|
||||||
|
| "responsiveness";
|
||||||
|
|
||||||
|
type supports = "windowLength";
|
||||||
|
|
||||||
|
interface StartSettingsType {
|
||||||
|
/**
|
||||||
|
* The maximum size in bytes of the buffer used to store profiling data. A larger value allows capturing a profile that
|
||||||
|
* covers a greater amount of time.
|
||||||
|
*/
|
||||||
|
bufferSize: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The length of the window of time that's kept in the buffer. Any collected samples are discarded as soon as they are
|
||||||
|
* older than the number of seconds specified in this setting. Zero means no duration restriction.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowLength?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Interval in milliseconds between samples of profiling data. A smaller value will increase the detail of the profiles
|
||||||
|
* captured.
|
||||||
|
*/
|
||||||
|
interval: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of active features for the profiler.
|
||||||
|
*/
|
||||||
|
features: ProfilerFeature[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of thread names for which to capture profiles.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
threads?: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Starts the profiler with the specified settings.
|
||||||
|
*
|
||||||
|
* @param settings
|
||||||
|
*/
|
||||||
|
start(settings: StartSettingsType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stops the profiler and discards any captured profile data.
|
||||||
|
*/
|
||||||
|
stop(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pauses the profiler, keeping any profile data that is already written.
|
||||||
|
*/
|
||||||
|
pause(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resumes the profiler with the settings that were initially used to start it.
|
||||||
|
*/
|
||||||
|
resume(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gathers the profile data from the current profiling session, and writes it to disk.
|
||||||
|
* The returned promise resolves to a path that locates the created file.
|
||||||
|
*
|
||||||
|
* @param fileName The name of the file inside the profile/profiler directory
|
||||||
|
*/
|
||||||
|
dumpProfileToFile(fileName: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gathers the profile data from the current profiling session.
|
||||||
|
*/
|
||||||
|
getProfile(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gathers the profile data from the current profiling session. The returned promise resolves to an array buffer that
|
||||||
|
* contains a JSON string.
|
||||||
|
*/
|
||||||
|
getProfileAsArrayBuffer(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gathers the profile data from the current profiling session. The returned promise resolves to an array buffer that
|
||||||
|
* contains a gzipped JSON string.
|
||||||
|
*/
|
||||||
|
getProfileAsGzippedArrayBuffer(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the debug symbols for a particular library.
|
||||||
|
*
|
||||||
|
* @param debugName The name of the library's debug file. For example, 'xul.pdb
|
||||||
|
* @param breakpadId The Breakpad ID of the library
|
||||||
|
*/
|
||||||
|
getSymbols(debugName: string, breakpadId: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fires when the profiler starts/stops running.
|
||||||
|
*
|
||||||
|
* @param isRunning Whether the profiler is running or not. Pausing the profiler will not affect this value.
|
||||||
|
*/
|
||||||
|
onRunning: Events.Event<(isRunning: boolean) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,268 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.history
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.history</code> API to interact with the browser's record of visited pages. You can add, remove,
|
||||||
|
* and query for URLs in the browser's history. To override the history page with your own version, see $(topic:override)
|
||||||
|
* [Override Pages].
|
||||||
|
* Permissions: "history"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace History {
|
||||||
|
/**
|
||||||
|
* The $(topic:transition-types)[transition type] for this visit from its referrer.
|
||||||
|
*/
|
||||||
|
type TransitionType =
|
||||||
|
| "link"
|
||||||
|
| "typed"
|
||||||
|
| "auto_bookmark"
|
||||||
|
| "auto_subframe"
|
||||||
|
| "manual_subframe"
|
||||||
|
| "generated"
|
||||||
|
| "auto_toplevel"
|
||||||
|
| "form_submit"
|
||||||
|
| "reload"
|
||||||
|
| "keyword"
|
||||||
|
| "keyword_generated";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object encapsulating one result of a history query.
|
||||||
|
*/
|
||||||
|
interface HistoryItem {
|
||||||
|
/**
|
||||||
|
* The unique identifier for the item.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL navigated to by a user.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of the page when it was last loaded.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When this page was last loaded, represented in milliseconds since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
lastVisitTime?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The number of times the user has navigated to this page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
visitCount?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The number of times the user has navigated to this page by typing in the address.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
typedCount?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object encapsulating one visit to a URL.
|
||||||
|
*/
|
||||||
|
interface VisitItem {
|
||||||
|
/**
|
||||||
|
* The unique identifier for the item.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The unique identifier for this visit.
|
||||||
|
*/
|
||||||
|
visitId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When this visit occurred, represented in milliseconds since the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
visitTime?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The visit ID of the referrer.
|
||||||
|
*/
|
||||||
|
referringVisitId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The $(topic:transition-types)[transition type] for this visit from its referrer.
|
||||||
|
*/
|
||||||
|
transition: TransitionType;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SearchQueryType {
|
||||||
|
/**
|
||||||
|
* A free-text query to the history service. Leave empty to retrieve all pages.
|
||||||
|
*/
|
||||||
|
text: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limit results to those visited after this date. If not specified, this defaults to 24 hours in the past.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
startTime?: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limit results to those visited before this date.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
endTime?: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum number of results to retrieve. Defaults to 100.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
maxResults?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetVisitsDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AddUrlDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL to add. Must be a valid URL that can be added to history.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of the page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The $(topic:transition-types)[transition type] for this visit from its referrer.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
transition?: TransitionType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The date when this visit occurred.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
visitTime?: ExtensionTypes.DateType;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeleteUrlDetailsType {
|
||||||
|
/**
|
||||||
|
* The URL to remove.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface DeleteRangeRangeType {
|
||||||
|
/**
|
||||||
|
* Items added to history after this date.
|
||||||
|
*/
|
||||||
|
startTime: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Items added to history before this date.
|
||||||
|
*/
|
||||||
|
endTime: ExtensionTypes.DateType;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnVisitRemovedRemovedType {
|
||||||
|
/**
|
||||||
|
* True if all history was removed. If true, then urls will be empty.
|
||||||
|
*/
|
||||||
|
allHistory: boolean;
|
||||||
|
|
||||||
|
urls: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnTitleChangedChangedType {
|
||||||
|
/**
|
||||||
|
* The URL for which the title has changed
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new title for the URL.
|
||||||
|
*/
|
||||||
|
title: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Searches the history for the last visit time of each page matching the query.
|
||||||
|
*
|
||||||
|
* @param query
|
||||||
|
*/
|
||||||
|
search(query: SearchQueryType): Promise<HistoryItem[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves information about visits to a URL.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getVisits(details: GetVisitsDetailsType): Promise<VisitItem[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a URL to the history with a default visitTime of the current time and a default $(topic:transition-types)
|
||||||
|
* [transition type] of "link".
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
addUrl(details: AddUrlDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all occurrences of the given URL from the history.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
deleteUrl(details: DeleteUrlDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all items within the specified date range from the history. Pages will not be removed from the history unless
|
||||||
|
* all visits fall within the range.
|
||||||
|
*
|
||||||
|
* @param range
|
||||||
|
*/
|
||||||
|
deleteRange(range: DeleteRangeRangeType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes all items from the history.
|
||||||
|
*/
|
||||||
|
deleteAll(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a URL is visited, providing the HistoryItem data for that URL. This event fires before the page has loaded.
|
||||||
|
*
|
||||||
|
* @param result
|
||||||
|
*/
|
||||||
|
onVisited: Events.Event<(result: HistoryItem) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged
|
||||||
|
* from history.
|
||||||
|
*
|
||||||
|
* @param removed
|
||||||
|
*/
|
||||||
|
onVisitRemoved: Events.Event<(removed: OnVisitRemovedRemovedType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the title of a URL is changed in the browser history.
|
||||||
|
*
|
||||||
|
* @param changed
|
||||||
|
*/
|
||||||
|
onTitleChanged: Events.Event<(changed: OnTitleChangedChangedType) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,82 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.i18n
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.i18n</code> infrastructure to implement internationalization across your whole app or extension.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
export namespace I18n {
|
||||||
|
/**
|
||||||
|
* An ISO language code such as <code>en</code> or <code>fr</code>. For a complete list of languages supported by this
|
||||||
|
* method, see <a href='http://src.chromium.org/viewvc/chrome/trunk/src/third_party/cld/languages/internal/languages.cc'>
|
||||||
|
* kLanguageInfoTable</a>. For an unknown language, <code>und</code> will be returned, which means that [percentage]
|
||||||
|
* of the text is unknown to CLD
|
||||||
|
*/
|
||||||
|
type LanguageCode = string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* LanguageDetectionResult object that holds detected langugae reliability and array of DetectedLanguage
|
||||||
|
*/
|
||||||
|
interface DetectLanguageCallbackResultType {
|
||||||
|
/**
|
||||||
|
* CLD detected language reliability
|
||||||
|
*/
|
||||||
|
isReliable: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* array of detectedLanguage
|
||||||
|
*/
|
||||||
|
languages: DetectLanguageCallbackResultTypeLanguagesItemType[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* DetectedLanguage object that holds detected ISO language code and its percentage in the input string
|
||||||
|
*/
|
||||||
|
interface DetectLanguageCallbackResultTypeLanguagesItemType {
|
||||||
|
language: LanguageCode;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The percentage of the detected language
|
||||||
|
*/
|
||||||
|
percentage: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale,
|
||||||
|
* use $(ref:i18n.getUILanguage).
|
||||||
|
*/
|
||||||
|
getAcceptLanguages(): Promise<LanguageCode[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the localized string for the specified message. If the message is missing, this method returns an empty string ('').
|
||||||
|
* If the format of the <code>getMessage()</code> call is wrong — for example, <em>messageName</em>
|
||||||
|
* is not a string or the <em>substitutions</em> array has more than 9 elements — this method returns <code>
|
||||||
|
* undefined</code>.
|
||||||
|
*
|
||||||
|
* @param messageName The name of the message, as specified in the <code>$(topic:i18n-messages)[messages.json]</code> file.
|
||||||
|
* @param substitutions Optional. Substitution strings, if the message requires any.
|
||||||
|
* @returns Message localized for current locale.
|
||||||
|
*/
|
||||||
|
getMessage(messageName: string, substitutions?: any): string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the browser UI language of the browser. This is different from $(ref:i18n.getAcceptLanguages)
|
||||||
|
* which returns the preferred user languages.
|
||||||
|
*
|
||||||
|
* @returns The browser UI language code such as en-US or fr-FR.
|
||||||
|
*/
|
||||||
|
getUILanguage(): string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects the language of the provided text using CLD.
|
||||||
|
*
|
||||||
|
* @param text User input string to be translated.
|
||||||
|
*/
|
||||||
|
detectLanguage(text: string): Promise<DetectLanguageCallbackResultType>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,45 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.identity
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the chrome.identity API to get OAuth2 access tokens.
|
||||||
|
* Permissions: "identity"
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
|
||||||
|
export namespace Identity {
|
||||||
|
/**
|
||||||
|
* An object encapsulating an OAuth account id.
|
||||||
|
*/
|
||||||
|
interface AccountInfo {
|
||||||
|
/**
|
||||||
|
* A unique identifier for the account. This ID will not change for the lifetime of the account.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface LaunchWebAuthFlowDetailsType {
|
||||||
|
url: Manifest.HttpURL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
interactive?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Starts an auth flow at the specified URL.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
launchWebAuthFlow(details: LaunchWebAuthFlowDetailsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates a redirect URL to be used in |launchWebAuthFlow|.
|
||||||
|
*
|
||||||
|
* @param path Optional. The path appended to the end of the generated URL.
|
||||||
|
*/
|
||||||
|
getRedirectURL(path?: string): string;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,43 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.idle
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.idle</code> API to detect when the machine's idle state changes.
|
||||||
|
* Permissions: "idle"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Idle {
|
||||||
|
type IdleState = "active" | "idle" | "locked";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
|
||||||
|
*
|
||||||
|
* @param detectionIntervalInSeconds The system is considered idle if detectionIntervalInSeconds seconds have elapsed since
|
||||||
|
* the last user input detected.
|
||||||
|
*/
|
||||||
|
queryState(detectionIntervalInSeconds: number): Promise<IdleState>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the interval, in seconds, used to determine when the system is in an idle state for onStateChanged events.
|
||||||
|
* The default interval is 60 seconds.
|
||||||
|
*
|
||||||
|
* @param intervalInSeconds Threshold, in seconds, used to determine when the system is in an idle state.
|
||||||
|
*/
|
||||||
|
setDetectionInterval(intervalInSeconds: number): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the system changes to an active or idle state. The event fires with "idle" if the the user has not generated
|
||||||
|
* any input for a specified number of seconds, and "active" when the user generates input on an idle system.
|
||||||
|
*
|
||||||
|
* @param newState
|
||||||
|
*/
|
||||||
|
onStateChanged: Events.Event<(newState: IdleState) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,253 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.management
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The <code>browser.management</code> API provides ways to manage the list of extensions that are installed and running.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Management {
|
||||||
|
/**
|
||||||
|
* Information about an icon belonging to an extension.
|
||||||
|
*/
|
||||||
|
interface IconInfo {
|
||||||
|
/**
|
||||||
|
* A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24,
|
||||||
|
* and 16.
|
||||||
|
*/
|
||||||
|
size: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled,
|
||||||
|
* for example), append <code>?grayscale=true</code> to the URL.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A reason the item is disabled.
|
||||||
|
*/
|
||||||
|
type ExtensionDisabledReason = "unknown" | "permissions_increase";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of this extension, 'extension' or 'theme'.
|
||||||
|
*/
|
||||||
|
type ExtensionType = "extension" | "theme";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How the extension was installed. One of<br><var>development</var>: The extension was loaded unpacked in developer mode,
|
||||||
|
* <br><var>normal</var>: The extension was installed normally via an .xpi file,<br><var>sideload</var>
|
||||||
|
* : The extension was installed by other software on the machine,<br><var>other</var>
|
||||||
|
* : The extension was installed by other means.
|
||||||
|
*/
|
||||||
|
type ExtensionInstallType = "development" | "normal" | "sideload" | "other";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about an installed extension.
|
||||||
|
*/
|
||||||
|
interface ExtensionInfo {
|
||||||
|
/**
|
||||||
|
* The extension's unique identifier.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of this extension.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A short version of the name of this extension.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
shortName?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The description of this extension.
|
||||||
|
*/
|
||||||
|
description: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The <a href='manifest/version'>version</a> of this extension.
|
||||||
|
*/
|
||||||
|
version: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The <a href='manifest/version#version_name'>version name</a> of this extension if the manifest specified one.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
versionName?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether this extension can be disabled or uninstalled by the user.
|
||||||
|
*/
|
||||||
|
mayDisable: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether it is currently enabled or disabled.
|
||||||
|
*/
|
||||||
|
enabled: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A reason the item is disabled.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
disabledReason?: ExtensionDisabledReason;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of this extension, 'extension' or 'theme'.
|
||||||
|
*/
|
||||||
|
type: ExtensionType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the homepage of this extension.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
homepageUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The update URL of this extension.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
updateUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The url for the item's options page, if it has one.
|
||||||
|
*/
|
||||||
|
optionsUrl: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of icon information. Note that this just reflects what was declared in the manifest,
|
||||||
|
* and the actual image at that url may be larger or smaller than what was declared,
|
||||||
|
* so you might consider using explicit width and height attributes on img tags referencing these images.
|
||||||
|
* See the <a href='manifest/icons'>manifest documentation on icons</a> for more details.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
icons?: IconInfo[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list of API based permissions.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
permissions?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list of host based permissions.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hostPermissions?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How the extension was installed.
|
||||||
|
*/
|
||||||
|
installType: ExtensionInstallType;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface InstallOptionsType {
|
||||||
|
/**
|
||||||
|
* URL pointing to the XPI file on addons.mozilla.org or similar.
|
||||||
|
*/
|
||||||
|
url: Manifest.HttpURL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A hash of the XPI file, using sha256 or stronger.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
hash?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface InstallCallbackResultType {
|
||||||
|
id: Manifest.ExtensionID;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UninstallSelfOptionsType {
|
||||||
|
/**
|
||||||
|
* Whether or not a confirm-uninstall dialog should prompt the user. Defaults to false.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
showConfirmDialog?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The message to display to a user when being asked to confirm removal of the extension.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
dialogMessage?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns a list of information about installed extensions.
|
||||||
|
*/
|
||||||
|
getAll(): Promise<ExtensionInfo[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns information about the installed extension that has the given ID.
|
||||||
|
*
|
||||||
|
* @param id The ID from an item of $(ref:management.ExtensionInfo).
|
||||||
|
*/
|
||||||
|
get(id: Manifest.ExtensionID): Promise<ExtensionInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Installs and enables a theme extension from the given url.
|
||||||
|
*
|
||||||
|
* @param options
|
||||||
|
*/
|
||||||
|
install(options: InstallOptionsType): Promise<InstallCallbackResultType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns information about the calling extension. Note: This function can be used without requesting the 'management'
|
||||||
|
* permission in the manifest.
|
||||||
|
*/
|
||||||
|
getSelf(): Promise<ExtensionInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Uninstalls the calling extension. Note: This function can be used without requesting the 'management' permission in the
|
||||||
|
* manifest.
|
||||||
|
*
|
||||||
|
* @param options Optional.
|
||||||
|
*/
|
||||||
|
uninstallSelf(options?: UninstallSelfOptionsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables or disables the given add-on.
|
||||||
|
*
|
||||||
|
* @param id ID of the add-on to enable/disable.
|
||||||
|
* @param enabled Whether to enable or disable the add-on.
|
||||||
|
*/
|
||||||
|
setEnabled(id: string, enabled: boolean): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an addon has been disabled.
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
*/
|
||||||
|
onDisabled: Events.Event<(info: ExtensionInfo) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an addon has been enabled.
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
*/
|
||||||
|
onEnabled: Events.Event<(info: ExtensionInfo) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an addon has been installed.
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
*/
|
||||||
|
onInstalled: Events.Event<(info: ExtensionInfo) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an addon has been uninstalled.
|
||||||
|
*
|
||||||
|
* @param info
|
||||||
|
*/
|
||||||
|
onUninstalled: Events.Event<(info: ExtensionInfo) => void>;
|
||||||
|
}
|
||||||
|
}
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,515 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.menus
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the browser.menus API to add items to the browser's menus. You can choose what types of objects your context menu
|
||||||
|
* additions apply to, such as images, hyperlinks, and pages.
|
||||||
|
* Permissions: "menus"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Extension } from "./extension";
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Menus {
|
||||||
|
/**
|
||||||
|
* The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts
|
||||||
|
* except for 'tab' and 'tools_menu'.
|
||||||
|
*/
|
||||||
|
type ContextType =
|
||||||
|
| "all"
|
||||||
|
| "page"
|
||||||
|
| "frame"
|
||||||
|
| "selection"
|
||||||
|
| "link"
|
||||||
|
| "editable"
|
||||||
|
| "password"
|
||||||
|
| "image"
|
||||||
|
| "video"
|
||||||
|
| "audio"
|
||||||
|
| "launcher"
|
||||||
|
| "bookmark"
|
||||||
|
| "tab"
|
||||||
|
| "tools_menu"
|
||||||
|
| "browser_action"
|
||||||
|
| "page_action"
|
||||||
|
| "action";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of menu item.
|
||||||
|
*/
|
||||||
|
type ItemType = "normal" | "checkbox" | "radio" | "separator";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information sent when a context menu item is clicked.
|
||||||
|
*/
|
||||||
|
interface OnClickData {
|
||||||
|
/**
|
||||||
|
* The ID of the menu item that was clicked.
|
||||||
|
*/
|
||||||
|
menuItemId: number | string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The parent ID, if any, for the item clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentMenuItemId?: number | string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of view where the menu is clicked. May be unset if the menu is not associated with a view.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
viewType?: Extension.ViewType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
mediaType?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the element is a link, the text of that link.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
linkText?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the element is a link, the URL it points to.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
linkUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Will be present for elements with a 'src' URL.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
srcUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the page where the menu item was clicked. This property is not set if the click occured in a context where
|
||||||
|
* there is no current page, such as in a launcher context menu.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pageUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The id of the frame of the element where the context menu was clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the frame of the element where the context menu was clicked, if it was in a frame.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The text for the context selection, if any.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
selectionText?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A flag indicating whether the element is editable (text input, textarea, etc.).
|
||||||
|
*/
|
||||||
|
editable: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A flag indicating the state of a checkbox or radio item before it was clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
wasChecked?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A flag indicating the state of a checkbox or radio item after it is clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
checked?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The id of the bookmark where the context menu was clicked, if it was on a bookmark.
|
||||||
|
*/
|
||||||
|
bookmarkId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An array of keyboard modifiers that were held while the menu item was clicked.
|
||||||
|
*/
|
||||||
|
modifiers: OnClickDataModifiersItemEnum[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An integer value of button by which menu item was clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
button?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An identifier of the clicked element, if any. Use menus.getTargetElement in the page to find the corresponding element.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
targetElementId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CreateCreatePropertiesType {
|
||||||
|
/**
|
||||||
|
* The type of menu item. Defaults to 'normal' if not specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: ItemType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
icons?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The text to be displayed in the item; this is <em>required</em> unless <code>type</code> is 'separator'.
|
||||||
|
* When the context is 'selection', you can use <code>%s</code> within the string to show the selected text. For example,
|
||||||
|
* if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool",
|
||||||
|
* the context menu item for the selection is "Translate 'cool' to Pig Latin".
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The initial state of a checkbox or radio item: true for selected and false for unselected.
|
||||||
|
* Only one radio item can be selected at a time in a given group of radio items.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
checked?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of contexts this menu item will appear in. Defaults to ['page'] if not specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
contexts?: ContextType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of view types where the menu item will be shown. Defaults to any view, including those without a viewType.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
viewTypes?: Extension.ViewType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the item is visible in the menu.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
visible?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A function that will be called back when the menu item is clicked. Event pages cannot use this; instead,
|
||||||
|
* they should register a listener for $(ref:contextMenus.onClicked).
|
||||||
|
*
|
||||||
|
* @param info Information about the item clicked and the context where the click happened.
|
||||||
|
* @param tab The details of the tab where the click took place. Note: this parameter only present for extensions.
|
||||||
|
*/
|
||||||
|
onclick?(info: OnClickData, tab: Tabs.Tab): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of a parent menu item; this makes the item a child of a previously added item.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentId?: number | string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lets you restrict the item to apply only to documents whose URL matches one of the given patterns.
|
||||||
|
* (This applies to frames as well.) For details on the format of a pattern, see $(topic:match_patterns)[Match Patterns].
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
documentUrlPatterns?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of
|
||||||
|
* anchor tags.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
targetUrlPatterns?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether this context menu item is enabled or disabled. Defaults to true.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
enabled?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies a command to issue for the context click.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
command?:
|
||||||
|
| string
|
||||||
|
| "_execute_browser_action"
|
||||||
|
| "_execute_page_action"
|
||||||
|
| "_execute_sidebar_action"
|
||||||
|
| "_execute_action"
|
||||||
|
| "_execute_page_action"
|
||||||
|
| "_execute_sidebar_action";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The properties to update. Accepts the same values as the create function.
|
||||||
|
*/
|
||||||
|
interface UpdateUpdatePropertiesType {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: ItemType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
icons?: Record<string, string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
checked?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
contexts?: ContextType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
viewTypes?: Extension.ViewType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the item is visible in the menu.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
visible?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param info
|
||||||
|
* @param tab The details of the tab where the click took place. Note: this parameter only present for extensions.
|
||||||
|
*/
|
||||||
|
onclick?(info: OnClickData, tab: Tabs.Tab): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Note: You cannot change an item to be a child of one of its own descendants.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
parentId?: number | string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
documentUrlPatterns?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
targetUrlPatterns?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
enabled?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OverrideContextContextOptionsType {
|
||||||
|
/**
|
||||||
|
* Whether to also include default menu items in the menu.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
showDefaults?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ContextType to override, to allow menu items from other extensions in the menu. Currently only 'bookmark' and 'tab' are
|
||||||
|
* supported. showDefaults cannot be used with this option.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
context?: OverrideContextContextOptionsTypeContextEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Required when context is 'bookmark'. Requires 'bookmark' permission.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
bookmarkId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Required when context is 'tab'. Requires 'tabs' permission.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about the context of the menu action and the created menu items. For more information about each property,
|
||||||
|
* see OnClickData. The following properties are only set if the extension has host permissions for the given context:
|
||||||
|
* linkUrl, linkText, srcUrl, pageUrl, frameUrl, selectionText.
|
||||||
|
*/
|
||||||
|
interface OnShownInfoType {
|
||||||
|
/**
|
||||||
|
* A list of IDs of the menu items that were shown.
|
||||||
|
*/
|
||||||
|
menuIds: Array<number | string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of all contexts that apply to the menu.
|
||||||
|
*/
|
||||||
|
contexts: ContextType[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
viewType?: Extension.ViewType;
|
||||||
|
|
||||||
|
editable: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
mediaType?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
linkUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
linkText?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
srcUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
pageUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
selectionText?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
targetElementId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
type OnClickDataModifiersItemEnum = "Shift" | "Alt" | "Command" | "Ctrl" | "MacCtrl";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ContextType to override, to allow menu items from other extensions in the menu. Currently only 'bookmark' and 'tab' are
|
||||||
|
* supported. showDefaults cannot be used with this option.
|
||||||
|
*/
|
||||||
|
type OverrideContextContextOptionsTypeContextEnum = "bookmark" | "tab";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation
|
||||||
|
* callback fires (the details will be in $(ref:runtime.lastError)).
|
||||||
|
*
|
||||||
|
* @param createProperties
|
||||||
|
* @param callback Optional. Called when the item has been created in the browser. If there were any problems creating the
|
||||||
|
* item, details will be available in $(ref:runtime.lastError).
|
||||||
|
* @returns The ID of the newly created item.
|
||||||
|
*/
|
||||||
|
create(createProperties: CreateCreatePropertiesType, callback?: () => void): number | string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates a previously created context menu item.
|
||||||
|
*
|
||||||
|
* @param id The ID of the item to update.
|
||||||
|
* @param updateProperties The properties to update. Accepts the same values as the create function.
|
||||||
|
* @returns Called when the context menu has been updated.
|
||||||
|
*/
|
||||||
|
update(id: number | string, updateProperties: UpdateUpdatePropertiesType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a context menu item.
|
||||||
|
*
|
||||||
|
* @param menuItemId The ID of the context menu item to remove.
|
||||||
|
* @returns Called when the context menu has been removed.
|
||||||
|
*/
|
||||||
|
remove(menuItemId: number | string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all context menu items added by this extension.
|
||||||
|
*
|
||||||
|
* @returns Called when removal is complete.
|
||||||
|
*/
|
||||||
|
removeAll(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the matching menu items from this extension instead of the default menu. This should be called during a
|
||||||
|
* 'contextmenu' DOM event handler, and only applies to the menu that opens after this event.
|
||||||
|
*
|
||||||
|
* @param contextOptions
|
||||||
|
*/
|
||||||
|
overrideContext(contextOptions: OverrideContextContextOptionsType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the extension items in the shown menu, including changes that have been made since the menu was shown.
|
||||||
|
* Has no effect if the menu is hidden. Rebuilding a shown menu is an expensive operation,
|
||||||
|
* only invoke this method when necessary.
|
||||||
|
*/
|
||||||
|
refresh(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the element that was associated with a recent contextmenu event.
|
||||||
|
*
|
||||||
|
* @param targetElementId The identifier of the clicked element, available as info.targetElementId in the menus.onShown,
|
||||||
|
* onClicked or onclick event.
|
||||||
|
*/
|
||||||
|
getTargetElement(targetElementId: number): Element;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a context menu item is clicked.
|
||||||
|
*
|
||||||
|
* @param info Information about the item clicked and the context where the click happened.
|
||||||
|
* @param tab Optional. The details of the tab where the click took place. If the click did not take place in a tab,
|
||||||
|
* this parameter will be missing.
|
||||||
|
*/
|
||||||
|
onClicked: Events.Event<(info: OnClickData, tab: Tabs.Tab | undefined) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a menu is shown. The extension can add, modify or remove menu items and call menus.refresh()
|
||||||
|
* to update the menu.
|
||||||
|
*
|
||||||
|
* @param info Information about the context of the menu action and the created menu items.
|
||||||
|
* For more information about each property, see OnClickData. The following properties are only set if the extension has
|
||||||
|
* host permissions for the given context: linkUrl, linkText, srcUrl, pageUrl, frameUrl, selectionText.
|
||||||
|
* @param tab The details of the tab where the menu was opened.
|
||||||
|
*/
|
||||||
|
onShown: Events.Event<(info: OnShownInfoType, tab: Tabs.Tab) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a menu is hidden. This event is only fired if onShown has fired before.
|
||||||
|
*/
|
||||||
|
onHidden: Events.Event<() => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum number of top level extension items that can be added to an extension action context menu.
|
||||||
|
* Any items beyond this limit will be ignored.
|
||||||
|
*/
|
||||||
|
ACTION_MENU_TOP_LEVEL_LIMIT: 6;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,53 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.networkStatus
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* This API provides the ability to determine the status of and detect changes in the network connection.
|
||||||
|
* This API can only be used in privileged extensions.
|
||||||
|
* Permissions: "networkStatus"
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace NetworkStatus {
|
||||||
|
interface NetworkLinkInfo {
|
||||||
|
/**
|
||||||
|
* Status of the network link, if "unknown" then link is usually assumed to be "up"
|
||||||
|
*/
|
||||||
|
status: NetworkLinkInfoStatusEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If known, the type of network connection that is avialable.
|
||||||
|
*/
|
||||||
|
type: NetworkLinkInfoTypeEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If known, the network id or name.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Status of the network link, if "unknown" then link is usually assumed to be "up"
|
||||||
|
*/
|
||||||
|
type NetworkLinkInfoStatusEnum = "unknown" | "up" | "down";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If known, the type of network connection that is avialable.
|
||||||
|
*/
|
||||||
|
type NetworkLinkInfoTypeEnum = "unknown" | "ethernet" | "usb" | "wifi" | "wimax" | "mobile";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns the $(ref:NetworkLinkInfo} of the current network connection.
|
||||||
|
*/
|
||||||
|
getLinkInfo(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the network connection state changes.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
onConnectionChanged: Events.Event<(details: NetworkLinkInfo) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,109 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.normandyAddonStudy
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Normandy Study API
|
||||||
|
* Permissions: "normandyAddonStudy"
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace NormandyAddonStudy {
|
||||||
|
interface Study {
|
||||||
|
/**
|
||||||
|
* The ID of the recipe for the study.
|
||||||
|
*/
|
||||||
|
recipeId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A slug to identify the study.
|
||||||
|
*/
|
||||||
|
slug: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name presented on about:studies.
|
||||||
|
*/
|
||||||
|
userFacingName: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The description presented on about:studies.
|
||||||
|
*/
|
||||||
|
userFacingDescription: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The study branch in which the user is enrolled.
|
||||||
|
*/
|
||||||
|
branch: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The state of the study.
|
||||||
|
*/
|
||||||
|
active: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the extension installed by the study.
|
||||||
|
*/
|
||||||
|
addonId: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the XPI that was downloaded and installed by the study.
|
||||||
|
*/
|
||||||
|
addonUrl: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The version of the extension installed by the study.
|
||||||
|
*/
|
||||||
|
addonVersion: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The start date for the study.
|
||||||
|
*/
|
||||||
|
studyStartDate: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The end date for the study.
|
||||||
|
*/
|
||||||
|
studyEndDate: ExtensionTypes.DateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The record ID for the extension in Normandy server's database.
|
||||||
|
*/
|
||||||
|
extensionApiId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A hash of the extension XPI file.
|
||||||
|
*/
|
||||||
|
extensionHash: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The algorithm used to hash the extension XPI file.
|
||||||
|
*/
|
||||||
|
extensionHashAlgorithm: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns a study object for the current study.
|
||||||
|
*/
|
||||||
|
getStudy(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Marks the study as ended and then uninstalls the addon.
|
||||||
|
*
|
||||||
|
* @param reason The reason why the study is ending.
|
||||||
|
*/
|
||||||
|
endStudy(reason: string): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an object with metadata about the client which may be required for constructing survey URLs.
|
||||||
|
*/
|
||||||
|
getClientMetadata(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a user unenrolls from a study but before the addon is uninstalled.
|
||||||
|
*
|
||||||
|
* @param reason The reason why the study is ending.
|
||||||
|
*/
|
||||||
|
onUnenroll: Events.Event<(reason: string) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,236 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.notifications
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "notifications"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Notifications {
|
||||||
|
type TemplateType = "basic" | "image" | "list" | "progress";
|
||||||
|
|
||||||
|
type PermissionLevel = "granted" | "denied";
|
||||||
|
|
||||||
|
interface NotificationItem {
|
||||||
|
/**
|
||||||
|
* Title of one item of a list notification.
|
||||||
|
*/
|
||||||
|
title: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Additional details about this item.
|
||||||
|
*/
|
||||||
|
message: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CreateNotificationOptions {
|
||||||
|
/**
|
||||||
|
* Which type of notification to display.
|
||||||
|
*/
|
||||||
|
type: TemplateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the sender's avatar, app icon, or a thumbnail for image notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
iconUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the app icon mask.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
appIconMaskUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Title of the notification (e.g. sender name for email).
|
||||||
|
*/
|
||||||
|
title: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main notification content.
|
||||||
|
*/
|
||||||
|
message: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Alternate notification content with a lower-weight font.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
contextMessage?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
priority?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A timestamp associated with the notification, in milliseconds past the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
eventTime?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the image thumbnail for image-type notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Items for multi-item notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
items?: NotificationItem[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Current progress ranges from 0 to 100.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
progress?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to show UI indicating that the app will visibly respond to clicks on the body of a notification.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
isClickable?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UpdateNotificationOptions {
|
||||||
|
/**
|
||||||
|
* Which type of notification to display.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: TemplateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the sender's avatar, app icon, or a thumbnail for image notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
iconUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the app icon mask.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
appIconMaskUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Title of the notification (e.g. sender name for email).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main notification content.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
message?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Alternate notification content with a lower-weight font.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
contextMessage?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Priority ranges from -2 to 2. -2 is lowest priority. 2 is highest. Zero is default.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
priority?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A timestamp associated with the notification, in milliseconds past the epoch.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
eventTime?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to the image thumbnail for image-type notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Items for multi-item notifications.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
items?: NotificationItem[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Current progress ranges from 0 to 100.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
progress?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to show UI indicating that the app will visibly respond to clicks on the body of a notification.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
isClickable?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Creates and displays a notification.
|
||||||
|
*
|
||||||
|
* @param notificationId Optional. Identifier of the notification. If it is empty, this method generates an id.
|
||||||
|
* If it matches an existing notification, this method first clears that notification before proceeding with the create
|
||||||
|
* operation.
|
||||||
|
* @param options Contents of the notification.
|
||||||
|
*/
|
||||||
|
create(notificationId: string | undefined, options: CreateNotificationOptions): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and displays a notification.
|
||||||
|
*
|
||||||
|
* @param options Contents of the notification.
|
||||||
|
*/
|
||||||
|
create(options: CreateNotificationOptions): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears an existing notification.
|
||||||
|
*
|
||||||
|
* @param notificationId The id of the notification to be updated.
|
||||||
|
*/
|
||||||
|
clear(notificationId: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves all the notifications.
|
||||||
|
*/
|
||||||
|
getAll(): Promise<Record<string, CreateNotificationOptions>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the notification closed, either by the system or by user action.
|
||||||
|
*
|
||||||
|
* @param notificationId The notificationId of the closed notification.
|
||||||
|
* @param byUser True if the notification was closed by the user.
|
||||||
|
*/
|
||||||
|
onClosed: Events.Event<(notificationId: string, byUser: boolean) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the user clicked in a non-button area of the notification.
|
||||||
|
*
|
||||||
|
* @param notificationId The notificationId of the clicked notification.
|
||||||
|
*/
|
||||||
|
onClicked: Events.Event<(notificationId: string) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the user pressed a button in the notification.
|
||||||
|
*
|
||||||
|
* @param notificationId The notificationId of the clicked notification.
|
||||||
|
* @param buttonIndex The index of the button clicked by the user.
|
||||||
|
*/
|
||||||
|
onButtonClicked: Events.Event<(notificationId: string, buttonIndex: number) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the notification is shown.
|
||||||
|
*
|
||||||
|
* @param notificationId The notificationId of the shown notification.
|
||||||
|
*/
|
||||||
|
onShown: Events.Event<(notificationId: string) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,92 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.omnibox
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The omnibox API allows you to register a keyword with Firefox's address bar.
|
||||||
|
* Permissions: "manifest:omnibox"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Omnibox {
|
||||||
|
/**
|
||||||
|
* The style type.
|
||||||
|
*/
|
||||||
|
type DescriptionStyleType = "url" | "match" | "dim";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The window disposition for the omnibox query. This is the recommended context to display results. For example,
|
||||||
|
* if the omnibox command is to navigate to a certain URL, a disposition of 'newForegroundTab' means the navigation should
|
||||||
|
* take place in a new selected tab.
|
||||||
|
*/
|
||||||
|
type OnInputEnteredDisposition = "currentTab" | "newForegroundTab" | "newBackgroundTab";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A suggest result.
|
||||||
|
*/
|
||||||
|
interface SuggestResult {
|
||||||
|
/**
|
||||||
|
* The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry.
|
||||||
|
*/
|
||||||
|
content: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The text that is displayed in the URL dropdown. Can contain XML-style markup for styling.
|
||||||
|
* The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query),
|
||||||
|
* and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>.
|
||||||
|
* You must escape the five predefined entities to display them as text: stackoverflow.com/a/1091953/89484
|
||||||
|
*/
|
||||||
|
description: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A suggest result.
|
||||||
|
*/
|
||||||
|
interface DefaultSuggestResult {
|
||||||
|
/**
|
||||||
|
* The text that is displayed in the URL dropdown.
|
||||||
|
*/
|
||||||
|
description: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the
|
||||||
|
* first suggestion row underneath the URL bar.
|
||||||
|
*
|
||||||
|
* @param suggestion A partial SuggestResult object, without the 'content' parameter.
|
||||||
|
*/
|
||||||
|
setDefaultSuggestion(suggestion: DefaultSuggestResult): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once
|
||||||
|
* per input session, and before any onInputChanged events.
|
||||||
|
*/
|
||||||
|
onInputStarted: Events.Event<() => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User has changed what is typed into the omnibox.
|
||||||
|
*
|
||||||
|
* @param text
|
||||||
|
* @param suggest A callback passed to the onInputChanged event used for sending suggestions back to the browser.
|
||||||
|
*/
|
||||||
|
onInputChanged: Events.Event<(text: string, suggest: (suggestResults: SuggestResult[]) => void) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User has accepted what is typed into the omnibox.
|
||||||
|
*
|
||||||
|
* @param text
|
||||||
|
* @param disposition
|
||||||
|
*/
|
||||||
|
onInputEntered: Events.Event<(text: string, disposition: OnInputEnteredDisposition) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User has ended the keyword input session without accepting the input.
|
||||||
|
*/
|
||||||
|
onInputCancelled: Events.Event<() => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,188 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.pageAction
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.pageAction</code> API to put icons inside the address bar. Page actions represent actions that can
|
||||||
|
* be taken on the current page, but that aren't applicable to all pages.
|
||||||
|
* Permissions: "manifest:page_action"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace PageAction {
|
||||||
|
/**
|
||||||
|
* Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).
|
||||||
|
*/
|
||||||
|
interface ImageDataType extends ImageData {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information sent when a page action is clicked.
|
||||||
|
*/
|
||||||
|
interface OnClickData {
|
||||||
|
/**
|
||||||
|
* An array of keyboard modifiers that were held while the menu item was clicked.
|
||||||
|
*/
|
||||||
|
modifiers: OnClickDataModifiersItemEnum[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An integer value of button by which menu item was clicked.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
button?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IsShownDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the tab to get the shownness from.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetTitleDetailsType {
|
||||||
|
/**
|
||||||
|
* The id of the tab for which you want to modify the page action.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The tooltip string.
|
||||||
|
*/
|
||||||
|
title: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetTitleDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the tab to get the title from.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetIconDetailsType {
|
||||||
|
/**
|
||||||
|
* The id of the tab for which you want to modify the page action.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.
|
||||||
|
* imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageData?: ImageDataType | Record<string, ImageDataType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
path?: string | Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetPopupDetailsType {
|
||||||
|
/**
|
||||||
|
* The id of the tab for which you want to modify the page action.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The html file to show in a popup. If set to the empty string (''), no popup is shown.
|
||||||
|
*/
|
||||||
|
popup: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetPopupDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the tab to get the popup from.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
type OnClickDataModifiersItemEnum = "Shift" | "Alt" | "Command" | "Ctrl" | "MacCtrl";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Shows the page action. The page action is shown whenever the tab is selected.
|
||||||
|
*
|
||||||
|
* @param tabId The id of the tab for which you want to modify the page action.
|
||||||
|
*/
|
||||||
|
show(tabId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hides the page action.
|
||||||
|
*
|
||||||
|
* @param tabId The id of the tab for which you want to modify the page action.
|
||||||
|
*/
|
||||||
|
hide(tabId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the page action is shown.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
isShown(details: IsShownDetailsType): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the title of the page action. This is displayed in a tooltip over the page action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setTitle(details: SetTitleDetailsType): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the title of the page action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getTitle(details: GetTitleDetailsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data
|
||||||
|
* from a canvas element, or as dictionary of either one of those. Either the <b>path</b> or the <b>imageData</b>
|
||||||
|
* property must be specified.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setIcon(details: SetIconDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the html document to be opened as a popup when the user clicks on the page action's icon.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setPopup(details: SetPopupDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the html document set as the popup for this page action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getPopup(details: GetPopupDetailsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the extension page action in the active window.
|
||||||
|
*/
|
||||||
|
openPopup(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a page action icon is clicked. This event will not fire if the page action has a popup.
|
||||||
|
*
|
||||||
|
* @param tab
|
||||||
|
* @param info Optional.
|
||||||
|
*/
|
||||||
|
onClicked: Events.Event<(tab: Tabs.Tab, info: OnClickData | undefined) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,76 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.permissions
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "manifest:optional_permissions"
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Permissions {
|
||||||
|
interface Permissions {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
permissions?: Manifest.OptionalPermission[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
origins?: Manifest.MatchPattern[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AnyPermissions {
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
permissions?: Manifest.Permission[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
origins?: Manifest.MatchPattern[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Get a list of all the extension's permissions.
|
||||||
|
*/
|
||||||
|
getAll(): Promise<AnyPermissions>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the extension has the given permissions.
|
||||||
|
*
|
||||||
|
* @param permissions
|
||||||
|
*/
|
||||||
|
contains(permissions: AnyPermissions): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Request the given permissions.
|
||||||
|
*
|
||||||
|
* @param permissions
|
||||||
|
*/
|
||||||
|
request(permissions: Permissions): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Relinquish the given permissions.
|
||||||
|
*
|
||||||
|
* @param permissions
|
||||||
|
*/
|
||||||
|
remove(permissions: Permissions): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the extension acquires new permissions.
|
||||||
|
*
|
||||||
|
* @param permissions
|
||||||
|
*/
|
||||||
|
onAdded: Events.Event<(permissions: Permissions) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when permissions are removed from the extension.
|
||||||
|
*
|
||||||
|
* @param permissions
|
||||||
|
*/
|
||||||
|
onRemoved: Events.Event<(permissions: Permissions) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,83 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.pkcs11
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* PKCS#11 module management API
|
||||||
|
* Permissions: "pkcs11"
|
||||||
|
*/
|
||||||
|
export namespace Pkcs11 {
|
||||||
|
interface Token {
|
||||||
|
/**
|
||||||
|
* Name of the token.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Name of the token's manufacturer.
|
||||||
|
*/
|
||||||
|
manufacturer: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hardware version, as a PKCS #11 version number (two 32-bit integers separated with a dot, like "1.0".
|
||||||
|
*/
|
||||||
|
HWVersion: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Firmware version, as a PKCS #11 version number (two 32-bit integers separated with a dot, like "1.0".
|
||||||
|
*/
|
||||||
|
FWVersion: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Serial number, whose format is defined by the token specification.
|
||||||
|
*/
|
||||||
|
serial: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* true if the token is logged on already, false otherwise.
|
||||||
|
*/
|
||||||
|
isLoggedIn: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ModuleSlot {
|
||||||
|
/**
|
||||||
|
* The name of the slot.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The token of the slot.
|
||||||
|
*/
|
||||||
|
token: Token | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* checks whether a PKCS#11 module, given by name, is installed
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
isModuleInstalled(name: string): Promise<boolean>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Install a PKCS#11 module with a given name
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
* @param flags Optional.
|
||||||
|
*/
|
||||||
|
installModule(name: string, flags?: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove an installed PKCS#11 module from firefox
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
uninstallModule(name: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumerate a module's slots, each with their name and whether a token is present
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
getModuleSlots(name: string): Promise<undefined>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,22 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.privacy
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "privacy"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { PrivacyNetwork } from "./privacy_network";
|
||||||
|
import { PrivacyServices } from "./privacy_services";
|
||||||
|
import { PrivacyWebsites } from "./privacy_websites";
|
||||||
|
|
||||||
|
export namespace Privacy {
|
||||||
|
interface Static {
|
||||||
|
network: PrivacyNetwork.Static;
|
||||||
|
services: PrivacyServices.Static;
|
||||||
|
websites: PrivacyWebsites.Static;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,97 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.privacy.network
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.privacy</code> API to control usage of the features in the browser that can affect a user's
|
||||||
|
* privacy.
|
||||||
|
* Permissions: "privacy"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace PrivacyNetwork {
|
||||||
|
/**
|
||||||
|
* The IP handling policy of WebRTC.
|
||||||
|
*/
|
||||||
|
type IPHandlingPolicy =
|
||||||
|
| "default"
|
||||||
|
| "default_public_and_private_interfaces"
|
||||||
|
| "default_public_interface_only"
|
||||||
|
| "disable_non_proxied_udp"
|
||||||
|
| "proxy_only";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object which describes TLS minimum and maximum versions.
|
||||||
|
*/
|
||||||
|
interface tlsVersionRestrictionConfig {
|
||||||
|
/**
|
||||||
|
* The minimum TLS version supported.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
minimum?: TlsVersionRestrictionConfigMinimumEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum TLS version supported.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
maximum?: TlsVersionRestrictionConfigMaximumEnum;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The mode for https-only mode.
|
||||||
|
*/
|
||||||
|
type HTTPSOnlyModeOption = "always" | "private_browsing" | "never";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The minimum TLS version supported.
|
||||||
|
*/
|
||||||
|
type TlsVersionRestrictionConfigMinimumEnum = "TLSv1" | "TLSv1.1" | "TLSv1.2" | "TLSv1.3" | "unknown";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum TLS version supported.
|
||||||
|
*/
|
||||||
|
type TlsVersionRestrictionConfigMaximumEnum = "TLSv1" | "TLSv1.1" | "TLSv1.2" | "TLSv1.3" | "unknown";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* If enabled, the browser attempts to speed up your web browsing experience by pre-resolving DNS entries,
|
||||||
|
* prerendering sites (<code><link rel='prefetch' ...></code>), and preemptively opening TCP and SSL connections to
|
||||||
|
* servers. This preference's value is a boolean, defaulting to <code>true</code>.
|
||||||
|
*/
|
||||||
|
networkPredictionEnabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to enable and disable RTCPeerConnections (aka WebRTC).
|
||||||
|
*/
|
||||||
|
peerConnectionEnabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to specify the media performance/privacy tradeoffs which impacts how WebRTC traffic will be routed and how
|
||||||
|
* much local address information is exposed. This preference's value is of type IPHandlingPolicy, defaulting to <code>
|
||||||
|
* default</code>.
|
||||||
|
*/
|
||||||
|
webRTCIPHandlingPolicy: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This property controls the minimum and maximum TLS versions. This setting's value is an object of
|
||||||
|
* $(ref:tlsVersionRestrictionConfig).
|
||||||
|
*/
|
||||||
|
tlsVersionRestriction: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to query the mode for 'HTTPS-Only Mode'. This setting's value is of type HTTPSOnlyModeOption,
|
||||||
|
* defaulting to <code>never</code>.
|
||||||
|
*/
|
||||||
|
httpsOnlyMode: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to query the status of 'Global Privacy Control'. This setting's value is of type boolean,
|
||||||
|
* defaulting to <code>false</code>.
|
||||||
|
*/
|
||||||
|
globalPrivacyControl: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,24 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.privacy.services
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.privacy</code> API to control usage of the features in the browser that can affect a user's
|
||||||
|
* privacy.
|
||||||
|
* Permissions: "privacy"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace PrivacyServices {
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* If enabled, the password manager will ask if you want to save passwords. This preference's value is a boolean,
|
||||||
|
* defaulting to <code>true</code>.
|
||||||
|
*/
|
||||||
|
passwordSavingEnabled: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,94 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.privacy.websites
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.privacy</code> API to control usage of the features in the browser that can affect a user's
|
||||||
|
* privacy.
|
||||||
|
* Permissions: "privacy"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace PrivacyWebsites {
|
||||||
|
/**
|
||||||
|
* The mode for tracking protection.
|
||||||
|
*/
|
||||||
|
type TrackingProtectionModeOption = "always" | "never" | "private_browsing";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The settings for cookies.
|
||||||
|
*/
|
||||||
|
interface CookieConfig {
|
||||||
|
/**
|
||||||
|
* The type of cookies to allow.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
behavior?: CookieConfigBehaviorEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether to create all cookies as nonPersistent (i.e., session) cookies.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
nonPersistentCookies?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of cookies to allow.
|
||||||
|
*/
|
||||||
|
type CookieConfigBehaviorEnum =
|
||||||
|
| "allow_all"
|
||||||
|
| "reject_all"
|
||||||
|
| "reject_third_party"
|
||||||
|
| "allow_visited"
|
||||||
|
| "reject_trackers"
|
||||||
|
| "reject_trackers_and_partition_foreign";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* If enabled, the browser sends auditing pings when requested by a website (<code><a ping></code>).
|
||||||
|
* The value of this preference is of type boolean, and the default value is <code>true</code>.
|
||||||
|
*/
|
||||||
|
hyperlinkAuditingEnabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, the browser sends <code>referer</code> headers with your requests. Yes,
|
||||||
|
* the name of this preference doesn't match the misspelled header. No, we're not going to change it.
|
||||||
|
* The value of this preference is of type boolean, and the default value is <code>true</code>.
|
||||||
|
*/
|
||||||
|
referrersEnabled: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, the browser attempts to appear similar to other users by reporting generic information to websites.
|
||||||
|
* This can prevent websites from uniquely identifying users. Examples of data that is spoofed include number of CPU cores,
|
||||||
|
* precision of JavaScript timers, the local timezone, and disabling features such as GamePad support,
|
||||||
|
* and the WebSpeech and Navigator APIs. The value of this preference is of type boolean, and the default value is <code>
|
||||||
|
* false</code>.
|
||||||
|
*/
|
||||||
|
resistFingerprinting: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If enabled, the browser will associate all data (including cookies, HSTS data, cached images, and more)
|
||||||
|
* for any third party domains with the domain in the address bar. This prevents third party trackers from using directly
|
||||||
|
* stored information to identify you across different websites, but may break websites where you login with a third party
|
||||||
|
* account (such as a Facebook or Google login.) The value of this preference is of type boolean,
|
||||||
|
* and the default value is <code>false</code>.
|
||||||
|
*/
|
||||||
|
firstPartyIsolate: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to specify the mode for tracking protection. This setting's value is of type TrackingProtectionModeOption,
|
||||||
|
* defaulting to <code>private_browsing_only</code>.
|
||||||
|
*/
|
||||||
|
trackingProtectionMode: Types.Setting;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow users to specify the default settings for allowing cookies, as well as whether all cookies should be created as
|
||||||
|
* non-persistent cookies. This setting's value is of type CookieConfig.
|
||||||
|
*/
|
||||||
|
cookieConfig: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,219 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.proxy
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Provides access to global proxy settings for Firefox and proxy event listeners to handle dynamic proxy implementations.
|
||||||
|
* Permissions: "proxy"
|
||||||
|
*/
|
||||||
|
import { WebRequest } from "./webRequest";
|
||||||
|
import { Events } from "./events";
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace Proxy {
|
||||||
|
/**
|
||||||
|
* An object which describes proxy settings.
|
||||||
|
*/
|
||||||
|
interface ProxyConfig {
|
||||||
|
/**
|
||||||
|
* The type of proxy to use.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
proxyType?: ProxyConfigProxyTypeEnum;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The address of the http proxy, can include a port.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
http?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Use the http proxy server for all protocols.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
httpProxyAll?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The address of the ssl proxy, can include a port.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
ssl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The address of the socks proxy, can include a port.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
socks?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The version of the socks proxy.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
socksVersion?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of hosts which should not be proxied.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
passthrough?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A URL to use to configure the proxy.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
autoConfigUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Do not prompt for authentication if password is saved.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
autoLogin?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Proxy DNS when using SOCKS v5.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
proxyDNS?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If true (the default value), do not use newer TLS protocol features that might have interoperability problems on the
|
||||||
|
* Internet. This is intended only for use with critical infrastructure like the updates,
|
||||||
|
* and is only available to privileged addons.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
respectBeConservative?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnRequestDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the request. Request IDs are unique within a browser session. As a result,
|
||||||
|
* they could be used to relate different events of the same request.
|
||||||
|
*/
|
||||||
|
requestId: string;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Standard HTTP method.
|
||||||
|
*/
|
||||||
|
method: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in
|
||||||
|
* which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code>
|
||||||
|
* or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.
|
||||||
|
*/
|
||||||
|
parentFrameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* True for private browsing requests.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognito?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cookie store ID of the contextual identity.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* URL of the resource that triggered this request.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
originUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* URL of the page into which the requested resource will be loaded.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
documentUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* How the requested resource will be used.
|
||||||
|
*/
|
||||||
|
type: WebRequest.ResourceType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when this signal is triggered, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates if this response was fetched from disk cache.
|
||||||
|
*/
|
||||||
|
fromCache: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The HTTP request headers that are going to be sent out with this request.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
requestHeaders?: WebRequest.HttpHeaders;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Url classification if the request has been classified.
|
||||||
|
*/
|
||||||
|
urlClassification: WebRequest.UrlClassification;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates if this request and its content window hierarchy is third party.
|
||||||
|
*/
|
||||||
|
thirdParty: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnErrorErrorType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of proxy to use.
|
||||||
|
*/
|
||||||
|
type ProxyConfigProxyTypeEnum = "none" | "autoDetect" | "system" | "manual" | "autoConfig";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when proxy data is needed for a request.
|
||||||
|
*/
|
||||||
|
interface onRequestEvent extends Events.Event<(details: OnRequestDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filter A set of filters that restricts the events that will be sent to this listener.
|
||||||
|
* @param extraInfoSpec Optional. Array of extra information that should be passed to the listener function.
|
||||||
|
*/
|
||||||
|
addListener(
|
||||||
|
callback: (details: OnRequestDetailsType) => void,
|
||||||
|
filter: WebRequest.RequestFilter,
|
||||||
|
extraInfoSpec?: string[]
|
||||||
|
): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Fired when proxy data is needed for a request.
|
||||||
|
*/
|
||||||
|
onRequest: onRequestEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Notifies about errors caused by the invalid use of the proxy API.
|
||||||
|
*
|
||||||
|
* @param error
|
||||||
|
*/
|
||||||
|
onError: Events.Event<(error: OnErrorErrorType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configures proxy settings. This setting's value is an object of type ProxyConfig.
|
||||||
|
*/
|
||||||
|
settings: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,442 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.runtime
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.runtime</code> API to retrieve the background page, return details about the manifest,
|
||||||
|
* and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the
|
||||||
|
* relative path of URLs to fully-qualified URLs.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright 2014 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Runtime {
|
||||||
|
/**
|
||||||
|
* An object which allows two way communication with other pages.
|
||||||
|
*/
|
||||||
|
interface Port {
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
disconnect(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param port
|
||||||
|
*/
|
||||||
|
onDisconnect: Events.Event<(port: Port) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param message
|
||||||
|
* @param port
|
||||||
|
*/
|
||||||
|
onMessage: Events.Event<(message: any, port: Port) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a message to the other end. This takes one argument, which is a JSON object representing the message to send.
|
||||||
|
* It will be delivered to any script listening to the port's onMessage event, or to the native application if this port
|
||||||
|
* is connected to a native application.
|
||||||
|
*
|
||||||
|
* @param message
|
||||||
|
*/
|
||||||
|
postMessage(message: any): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This property will <b>only</b> be present on ports passed to onConnect/onConnectExternal listeners.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
sender?: MessageSender;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the port was disconnected due to an error, this will be set to an object with a string property message,
|
||||||
|
* giving you more information about the error. See onDisconnect.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
error?: PortErrorType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object containing information about the script context that sent a message or request.
|
||||||
|
*/
|
||||||
|
interface MessageSender {
|
||||||
|
/**
|
||||||
|
* The $(ref:tabs.Tab) which opened the connection, if any. This property will <strong>only</strong>
|
||||||
|
* be present when the connection was opened from a tab (including content scripts), and <strong>only</strong>
|
||||||
|
* if the receiver is an extension, not an app.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tab?: Tabs.Tab;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The $(topic:frame_ids)[frame] that opened the connection. 0 for top-level frames, positive for child frames.
|
||||||
|
* This will only be set when <code>tab</code> is set.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the extension or app that opened the connection, if any.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL of the page or frame that opened the connection. If the sender is in an iframe,
|
||||||
|
* it will be iframe's URL not the URL of the page which hosts it.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The operating system the browser is running on.
|
||||||
|
*/
|
||||||
|
type PlatformOs = "mac" | "win" | "android" | "cros" | "linux" | "openbsd";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The machine's processor architecture.
|
||||||
|
*/
|
||||||
|
type PlatformArch = "aarch64" | "arm" | "ppc64" | "s390x" | "sparc64" | "x86-32" | "x86-64";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object containing information about the current platform.
|
||||||
|
*/
|
||||||
|
interface PlatformInfo {
|
||||||
|
/**
|
||||||
|
* The operating system the browser is running on.
|
||||||
|
*/
|
||||||
|
os: PlatformOs;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The machine's processor architecture.
|
||||||
|
*/
|
||||||
|
arch: PlatformArch;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object containing information about the current browser.
|
||||||
|
*/
|
||||||
|
interface BrowserInfo {
|
||||||
|
/**
|
||||||
|
* The name of the browser, for example 'Firefox'.
|
||||||
|
*/
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the browser vendor, for example 'Mozilla'.
|
||||||
|
*/
|
||||||
|
vendor: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's version, for example '42.0.0' or '0.8.1pre'.
|
||||||
|
*/
|
||||||
|
version: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The browser's build ID/date, for example '20160101'.
|
||||||
|
*/
|
||||||
|
buildID: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result of the update check.
|
||||||
|
*/
|
||||||
|
type RequestUpdateCheckStatus = "throttled" | "no_update" | "update_available";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The reason that this event is being dispatched.
|
||||||
|
*/
|
||||||
|
type OnInstalledReason = "install" | "update" | "browser_update";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The reason that the event is being dispatched. 'app_update' is used when the restart is needed because the application
|
||||||
|
* is updated to a newer version. 'os_update' is used when the restart is needed because the browser/OS is updated to a
|
||||||
|
* newer version. 'periodic' is used when the system runs for more than the permitted uptime set in the enterprise policy.
|
||||||
|
*/
|
||||||
|
type OnRestartRequiredReason = "app_update" | "os_update" | "periodic";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If an update is available, this contains more information about the available update.
|
||||||
|
*/
|
||||||
|
interface RequestUpdateCheckCallbackDetailsType {
|
||||||
|
/**
|
||||||
|
* The version of the available update.
|
||||||
|
*/
|
||||||
|
version: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ConnectConnectInfoType {
|
||||||
|
/**
|
||||||
|
* Will be passed into onConnect for processes that are listening for the connection event.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
name?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the TLS channel ID will be passed into onConnectExternal for processes that are listening for the connection
|
||||||
|
* event.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeTlsChannelId?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SendMessageOptionsType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnInstalledDetailsType {
|
||||||
|
/**
|
||||||
|
* The reason that this event is being dispatched.
|
||||||
|
*/
|
||||||
|
reason: OnInstalledReason;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates the previous version of the extension, which has just been updated. This is present only if 'reason' is
|
||||||
|
* 'update'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
previousVersion?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Indicates whether the addon is installed as a temporary extension.
|
||||||
|
*/
|
||||||
|
temporary: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The manifest details of the available update.
|
||||||
|
*/
|
||||||
|
interface OnUpdateAvailableDetailsType {
|
||||||
|
/**
|
||||||
|
* The version number of the available update.
|
||||||
|
*/
|
||||||
|
version: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This will be defined during an API method callback if there was an error
|
||||||
|
*/
|
||||||
|
interface PropertyLastErrorType {
|
||||||
|
/**
|
||||||
|
* Details about the error which occurred.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
message?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the port was disconnected due to an error, this will be set to an object with a string property message,
|
||||||
|
* giving you more information about the error. See onDisconnect.
|
||||||
|
*/
|
||||||
|
interface PortErrorType {
|
||||||
|
message: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Retrieves the JavaScript 'window' object for the background page running inside the current extension/app.
|
||||||
|
* If the background page is an event page, the system will ensure it is loaded before calling the callback.
|
||||||
|
* If there is no background page, an error is set.
|
||||||
|
*/
|
||||||
|
getBackgroundPage(): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <p>Open your Extension's options page, if possible.</p><p>The precise behavior may depend on your manifest's <code>
|
||||||
|
* $(topic:optionsV2)[options_ui]</code> or <code>$(topic:options)[options_page]</code> key,
|
||||||
|
* or what the browser happens to support at the time.</p><p>If your Extension does not declare an options page,
|
||||||
|
* or the browser failed to create one for some other reason, the callback will set $(ref:lastError).</p>
|
||||||
|
*/
|
||||||
|
openOptionsPage(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns details about the app or extension from the manifest. The object returned is a serialization of the full
|
||||||
|
* $(topic:manifest)[manifest file].
|
||||||
|
*
|
||||||
|
* @returns The manifest details.
|
||||||
|
*/
|
||||||
|
getManifest(): Manifest.WebExtensionManifest;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts a relative path within an app/extension install directory to a fully-qualified URL.
|
||||||
|
*
|
||||||
|
* @param path A path to a resource within an app/extension expressed relative to its install directory.
|
||||||
|
* @returns The fully-qualified URL to the resource.
|
||||||
|
*/
|
||||||
|
getURL(path: string): string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics,
|
||||||
|
* and implement surveys. Maximum 255 characters.
|
||||||
|
*
|
||||||
|
* @param url Optional. URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme.
|
||||||
|
* Set an empty string to not open a new tab upon uninstallation.
|
||||||
|
* @returns Called when the uninstall URL is set. If the given URL is invalid, $(ref:runtime.lastError) will be set.
|
||||||
|
*/
|
||||||
|
setUninstallURL(url?: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reloads the app or extension.
|
||||||
|
*/
|
||||||
|
reload(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Requests an update check for this app/extension.
|
||||||
|
*/
|
||||||
|
requestUpdateCheck(): Promise<[RequestUpdateCheckStatus, RequestUpdateCheckCallbackDetailsType]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempts to connect to connect listeners within an extension/app (such as the background page), or other extensions/apps.
|
||||||
|
* This is useful for content scripts connecting to their extension processes, inter-app/extension communication,
|
||||||
|
* and $(topic:manifest/externally_connectable)[web messaging]. Note that this does not connect to any listeners in a
|
||||||
|
* content script. Extensions may connect to content scripts embedded in tabs via $(ref:tabs.connect).
|
||||||
|
*
|
||||||
|
* @param extensionId Optional. The ID of the extension or app to connect to. If omitted,
|
||||||
|
* a connection will be attempted with your own extension. Required if sending messages from a web page for
|
||||||
|
* $(topic:manifest/externally_connectable)[web messaging].
|
||||||
|
* @param connectInfo Optional.
|
||||||
|
* @returns Port through which messages can be sent and received. The port's $(ref:runtime.Port onDisconnect)
|
||||||
|
* event is fired if the extension/app does not exist.
|
||||||
|
*/
|
||||||
|
connect(extensionId?: string, connectInfo?: ConnectConnectInfoType): Port;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempts to connect to connect listeners within an extension/app (such as the background page), or other extensions/apps.
|
||||||
|
* This is useful for content scripts connecting to their extension processes, inter-app/extension communication,
|
||||||
|
* and $(topic:manifest/externally_connectable)[web messaging]. Note that this does not connect to any listeners in a
|
||||||
|
* content script. Extensions may connect to content scripts embedded in tabs via $(ref:tabs.connect).
|
||||||
|
*
|
||||||
|
* @param connectInfo Optional.
|
||||||
|
* @returns Port through which messages can be sent and received. The port's $(ref:runtime.Port onDisconnect)
|
||||||
|
* event is fired if the extension/app does not exist.
|
||||||
|
*/
|
||||||
|
connect(connectInfo?: ConnectConnectInfoType): Port;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Connects to a native application in the host machine.
|
||||||
|
*
|
||||||
|
* @param application The name of the registered application to connect to.
|
||||||
|
* @returns Port through which messages can be sent and received with the application
|
||||||
|
*/
|
||||||
|
connectNative(application: string): Port;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a single message to event listeners within your extension/app or a different extension/app.
|
||||||
|
* Similar to $(ref:runtime.connect) but only sends a single message, with an optional response.
|
||||||
|
* If sending to your extension, the $(ref:runtime.onMessage) event will be fired in each page, or $(ref:runtime.
|
||||||
|
* onMessageExternal), if a different extension. Note that extensions cannot send messages to content scripts using this
|
||||||
|
* method. To send messages to content scripts, use $(ref:tabs.sendMessage).
|
||||||
|
*
|
||||||
|
* @param extensionId Optional. The ID of the extension/app to send the message to. If omitted,
|
||||||
|
* the message will be sent to your own extension/app. Required if sending messages from a web page for
|
||||||
|
* $(topic:manifest/externally_connectable)[web messaging].
|
||||||
|
* @param message
|
||||||
|
* @param options Optional.
|
||||||
|
*/
|
||||||
|
sendMessage(extensionId: string | undefined, message: any, options?: SendMessageOptionsType): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a single message to event listeners within your extension/app or a different extension/app.
|
||||||
|
* Similar to $(ref:runtime.connect) but only sends a single message, with an optional response.
|
||||||
|
* If sending to your extension, the $(ref:runtime.onMessage) event will be fired in each page, or $(ref:runtime.
|
||||||
|
* onMessageExternal), if a different extension. Note that extensions cannot send messages to content scripts using this
|
||||||
|
* method. To send messages to content scripts, use $(ref:tabs.sendMessage).
|
||||||
|
*
|
||||||
|
* @param message
|
||||||
|
* @param options Optional.
|
||||||
|
*/
|
||||||
|
sendMessage(message: any, options?: SendMessageOptionsType): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a single message to a native application.
|
||||||
|
*
|
||||||
|
* @param application The name of the native messaging host.
|
||||||
|
* @param message The message that will be passed to the native messaging host.
|
||||||
|
*/
|
||||||
|
sendNativeMessage(application: string, message: any): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns information about the current browser.
|
||||||
|
*
|
||||||
|
* @returns Called with results
|
||||||
|
*/
|
||||||
|
getBrowserInfo(): Promise<BrowserInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns information about the current platform.
|
||||||
|
*
|
||||||
|
* @returns Called with results
|
||||||
|
*/
|
||||||
|
getPlatformInfo(): Promise<PlatformInfo>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a profile that has this extension installed first starts up. This event is not fired for incognito profiles.
|
||||||
|
*/
|
||||||
|
onStartup: Events.Event<() => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the extension is first installed, when the extension is updated to a new version,
|
||||||
|
* and when the browser is updated to a new version.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
onInstalled: Events.Event<(details: OnInstalledDetailsType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an update is available, but isn't installed immediately because the app is currently running.
|
||||||
|
* If you do nothing, the update will be installed the next time the background page gets unloaded,
|
||||||
|
* if you want it to be installed sooner you can explicitly call $(ref:runtime.reload).
|
||||||
|
* If your extension is using a persistent background page, the background page of course never gets unloaded,
|
||||||
|
* so unless you call $(ref:runtime.reload) manually in response to this event the update will not get installed until the
|
||||||
|
* next time the browser itself restarts. If no handlers are listening for this event,
|
||||||
|
* and your extension has a persistent background page, it behaves as if $(ref:runtime.reload)
|
||||||
|
* is called in response to this event.
|
||||||
|
*
|
||||||
|
* @param details The manifest details of the available update.
|
||||||
|
*/
|
||||||
|
onUpdateAvailable: Events.Event<(details: OnUpdateAvailableDetailsType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a connection is made from either an extension process or a content script.
|
||||||
|
*
|
||||||
|
* @param port
|
||||||
|
*/
|
||||||
|
onConnect: Events.Event<(port: Port) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a connection is made from another extension.
|
||||||
|
*
|
||||||
|
* @param port
|
||||||
|
*/
|
||||||
|
onConnectExternal: Events.Event<(port: Port) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a message is sent from either an extension process or a content script.
|
||||||
|
*
|
||||||
|
* @param message Optional. The message sent by the calling script.
|
||||||
|
* @param sender
|
||||||
|
*/
|
||||||
|
onMessage: Events.Event<(message: any, sender: MessageSender) => Promise<any> | void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a message is sent from another extension/app. Cannot be used in a content script.
|
||||||
|
*
|
||||||
|
* @param message Optional. The message sent by the calling script.
|
||||||
|
* @param sender
|
||||||
|
*/
|
||||||
|
onMessageExternal: Events.Event<(message: any, sender: MessageSender) => Promise<any> | void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This will be defined during an API method callback if there was an error
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
lastError?: PropertyLastErrorType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the extension/app.
|
||||||
|
*/
|
||||||
|
id: string;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,162 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.scripting
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the scripting API to execute script in different contexts.
|
||||||
|
* Permissions: "scripting"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
export namespace Scripting {
|
||||||
|
/**
|
||||||
|
* Details of a script injection
|
||||||
|
*/
|
||||||
|
interface ScriptInjection {
|
||||||
|
/**
|
||||||
|
* The arguments to curry into a provided function. This is only valid if the <code>func</code> parameter is specified.
|
||||||
|
* These arguments must be JSON-serializable.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
args?: any[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path of the JS or CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code>
|
||||||
|
* and <code>func</code> must be specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
files?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A JavaScript function to inject. This function will be serialized, and then deserialized for injection.
|
||||||
|
* This means that any bound parameters and execution context will be lost. Exactly one of <code>files</code> and <code>
|
||||||
|
* func</code> must be specified.
|
||||||
|
*
|
||||||
|
* @param ...args The arguments
|
||||||
|
* @returns The return value
|
||||||
|
*/
|
||||||
|
func?(...args: any[]): any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details specifying the target into which to inject the script.
|
||||||
|
*/
|
||||||
|
target: InjectionTarget;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Result of a script injection.
|
||||||
|
*/
|
||||||
|
interface InjectionResult {
|
||||||
|
/**
|
||||||
|
* The frame ID associated with the injection.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The result of the script execution.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
result?: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the script should inject into all frames within the tab. Defaults to false.
|
||||||
|
* This must not be true if frameIds is specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details of the script to insert.
|
||||||
|
*/
|
||||||
|
interface InjectionTarget {
|
||||||
|
/**
|
||||||
|
* The IDs of specific frames to inject into.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
frameIds?: number[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab into which to inject.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the script should inject into all frames within the tab. Defaults to false.
|
||||||
|
* This must not be true if frameIds is specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The origin for a style change. See style origins for more info.
|
||||||
|
*
|
||||||
|
* "AUTHOR": The author origin is the style origin which contains all of the styles which are part of the document,
|
||||||
|
* whether embedded within the HTML or loaded from an external stylesheet file.
|
||||||
|
* "USER": The user origin is the style origin containing any CSS that the user of the web browser has added.
|
||||||
|
* These may be from adding styles using a developer tool or from a browser extension that automatically applies custom
|
||||||
|
* styles to content, such as Stylus or Stylish.
|
||||||
|
*/
|
||||||
|
type StyleOrigin = "AUTHOR" | "USER";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details of the css to insert.
|
||||||
|
*/
|
||||||
|
interface CSSInjection {
|
||||||
|
/**
|
||||||
|
* A string containing the CSS to inject. Exactly one of files and css must be specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
css?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path of the CSS files to inject, relative to the extension's root directory. NOTE: Currently a maximum of one file
|
||||||
|
* is supported. Exactly one of files and css must be specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
files?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The style origin for the injection. Defaults to 'AUTHOR'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
origin?: StyleOrigin;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details specifying the target into which to insert the CSS.
|
||||||
|
*/
|
||||||
|
target: InjectionTarget;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Injects a script into a target context. The script will be run at <code>document_idle</code>.
|
||||||
|
*
|
||||||
|
* @param injection The details of the script which to inject.
|
||||||
|
* @returns Invoked upon completion of the injection. The resulting array contains the result of execution for each frame
|
||||||
|
* where the injection succeeded.
|
||||||
|
*/
|
||||||
|
executeScript(injection: ScriptInjection): Promise<InjectionResult[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Injects CSS into a page. For details, see the $(topic:content_scripts)[programmatic injection]
|
||||||
|
* section of the content scripts doc.
|
||||||
|
*
|
||||||
|
* @param injection Details of the CSS text to insert.
|
||||||
|
* @returns Called when all the CSS has been inserted.
|
||||||
|
*/
|
||||||
|
insertCSS(injection: CSSInjection): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes injected CSS from a page. For details, see the $(topic:content_scripts)[programmatic injection]
|
||||||
|
* section of the content scripts doc.
|
||||||
|
*
|
||||||
|
* @param injection Details of the CSS text to insert.
|
||||||
|
* @returns Called when all the CSS has been removed.
|
||||||
|
*/
|
||||||
|
removeCSS(injection: CSSInjection): Promise<void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,67 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.search
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use browser.search to interact with search engines.
|
||||||
|
* Permissions: "search"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
export namespace Search {
|
||||||
|
/**
|
||||||
|
* An object encapsulating a search engine
|
||||||
|
*/
|
||||||
|
interface SearchEngine {
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
isDefault: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
alias?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
favIconUrl?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SearchSearchPropertiesType {
|
||||||
|
/**
|
||||||
|
* Terms to search for.
|
||||||
|
*/
|
||||||
|
query: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search engine to use. Uses the default if not specified.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
engine?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab for the search results. If not specified, a new tab is created.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Gets a list of search engines.
|
||||||
|
*
|
||||||
|
* @returns A Promise that will be fulfilled with an array of search engine objects.
|
||||||
|
*/
|
||||||
|
get(): Promise<SearchEngine[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Perform a search.
|
||||||
|
*
|
||||||
|
* @param searchProperties
|
||||||
|
*/
|
||||||
|
search(searchProperties: SearchSearchPropertiesType): void;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,151 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.sessions
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>chrome.sessions</code> API to query and restore tabs and windows from a browsing session.
|
||||||
|
* Permissions: "sessions"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright 2013 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Windows } from "./windows";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Sessions {
|
||||||
|
interface Filter {
|
||||||
|
/**
|
||||||
|
* The maximum number of entries to be fetched in the requested list. Omit this parameter to fetch the maximum number of
|
||||||
|
* entries ($(ref:sessions.MAX_SESSION_RESULTS)).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
maxResults?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Session {
|
||||||
|
/**
|
||||||
|
* The time when the window or tab was closed or modified, represented in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
lastModified: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The $(ref:tabs.Tab), if this entry describes a tab. Either this or $(ref:sessions.Session.window) will be set.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tab?: Tabs.Tab;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The $(ref:windows.Window), if this entry describes a window. Either this or $(ref:sessions.Session.tab) will be set.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
window?: Windows.Window;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Device {
|
||||||
|
info: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of the foreign device.
|
||||||
|
*/
|
||||||
|
deviceName: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A list of open window sessions for the foreign device, sorted from most recently to least recently modified session.
|
||||||
|
*/
|
||||||
|
sessions: Session[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Forget a recently closed tab.
|
||||||
|
*
|
||||||
|
* @param windowId The windowId of the window to which the recently closed tab to be forgotten belongs.
|
||||||
|
* @param sessionId The sessionId (closedId) of the recently closed tab to be forgotten.
|
||||||
|
*/
|
||||||
|
forgetClosedTab(windowId: number, sessionId: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Forget a recently closed window.
|
||||||
|
*
|
||||||
|
* @param sessionId The sessionId (closedId) of the recently closed window to be forgotten.
|
||||||
|
*/
|
||||||
|
forgetClosedWindow(sessionId: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the list of recently closed tabs and/or windows.
|
||||||
|
*
|
||||||
|
* @param filter Optional.
|
||||||
|
*/
|
||||||
|
getRecentlyClosed(filter?: Filter): Promise<Session[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reopens a $(ref:windows.Window) or $(ref:tabs.Tab), with an optional callback to run when the entry has been restored.
|
||||||
|
*
|
||||||
|
* @param sessionId Optional. The $(ref:windows.Window.sessionId), or $(ref:tabs.Tab.sessionId) to restore.
|
||||||
|
* If this parameter is not specified, the most recently closed session is restored.
|
||||||
|
*/
|
||||||
|
restore(sessionId?: string): Promise<Session>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set a key/value pair on a given tab.
|
||||||
|
*
|
||||||
|
* @param tabId The id of the tab that the key/value pair is being set on.
|
||||||
|
* @param key The key which corresponds to the value being set.
|
||||||
|
* @param value The value being set.
|
||||||
|
*/
|
||||||
|
setTabValue(tabId: number, key: string, value: any): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve a value that was set for a given key on a given tab.
|
||||||
|
*
|
||||||
|
* @param tabId The id of the tab whose value is being retrieved from.
|
||||||
|
* @param key The key which corresponds to the value.
|
||||||
|
*/
|
||||||
|
getTabValue(tabId: number, key: string): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove a key/value pair that was set on a given tab.
|
||||||
|
*
|
||||||
|
* @param tabId The id of the tab whose key/value pair is being removed.
|
||||||
|
* @param key The key which corresponds to the value.
|
||||||
|
*/
|
||||||
|
removeTabValue(tabId: number, key: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set a key/value pair on a given window.
|
||||||
|
*
|
||||||
|
* @param windowId The id of the window that the key/value pair is being set on.
|
||||||
|
* @param key The key which corresponds to the value being set.
|
||||||
|
* @param value The value being set.
|
||||||
|
*/
|
||||||
|
setWindowValue(windowId: number, key: string, value: any): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve a value that was set for a given key on a given window.
|
||||||
|
*
|
||||||
|
* @param windowId The id of the window whose value is being retrieved from.
|
||||||
|
* @param key The key which corresponds to the value.
|
||||||
|
*/
|
||||||
|
getWindowValue(windowId: number, key: string): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove a key/value pair that was set on a given window.
|
||||||
|
*
|
||||||
|
* @param windowId The id of the window whose key/value pair is being removed.
|
||||||
|
* @param key The key which corresponds to the value.
|
||||||
|
*/
|
||||||
|
removeWindowValue(windowId: number, key: string): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when recently closed tabs and/or windows are changed. This event does not monitor synced sessions changes.
|
||||||
|
*/
|
||||||
|
onChanged: Events.Event<() => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum number of $(ref:sessions.Session) that will be included in a requested list.
|
||||||
|
*/
|
||||||
|
MAX_SESSION_RESULTS: 25;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,194 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.sidebarAction
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use sidebar actions to add a sidebar to Firefox.
|
||||||
|
* Permissions: "manifest:sidebar_action"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
export namespace SidebarAction {
|
||||||
|
/**
|
||||||
|
* Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).
|
||||||
|
*/
|
||||||
|
interface ImageDataType extends ImageData {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetTitleDetailsType {
|
||||||
|
/**
|
||||||
|
* The string the sidebar action should display when moused over.
|
||||||
|
*/
|
||||||
|
title: string | null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the sidebar title for the tab specified by tabId. Automatically resets when the tab is closed.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the sidebar title for the window specified by windowId.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetTitleDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the tab to get the title from. If no tab nor window is specified, the global title is returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the window to get the title from. If no tab nor window is specified, the global title is returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetIconDetailsType {
|
||||||
|
/**
|
||||||
|
* Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.
|
||||||
|
* imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
imageData?: ImageDataType | Record<string, ImageDataType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set.
|
||||||
|
* If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density.
|
||||||
|
* If the number of image pixels that fit into one screen space unit equals <code>scale</code>, then image with size <code>
|
||||||
|
* scale</code> * 19 will be selected. Initially only scales 1 and 2 will be supported.
|
||||||
|
* At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
path?: string | SetIconDetailsTypePathC2Type;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the sidebar icon for the tab specified by tabId. Automatically resets when the tab is closed.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the sidebar icon for the window specified by windowId.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetPanelDetailsType {
|
||||||
|
/**
|
||||||
|
* Sets the sidebar url for the tab specified by tabId. Automatically resets when the tab is closed.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the sidebar url for the window specified by windowId.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The url to the html file to show in a sidebar. If set to the empty string (''), no sidebar is shown.
|
||||||
|
*/
|
||||||
|
panel: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetPanelDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the tab to get the panel from. If no tab nor window is specified, the global panel is returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the window to get the panel from. If no tab nor window is specified, the global panel is returned.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface IsOpenDetailsType {
|
||||||
|
/**
|
||||||
|
* Specify the window to get the openness from.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SetIconDetailsTypePathC2Type {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Sets the title of the sidebar action. This shows up in the tooltip.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setTitle(details: SetTitleDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the title of the sidebar action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getTitle(details: GetTitleDetailsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the icon for the sidebar action. The icon can be specified either as the path to an image file or as the pixel data
|
||||||
|
* from a canvas element, or as dictionary of either one of those. Either the <strong>path</strong> or the <strong>
|
||||||
|
* imageData</strong> property must be specified.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setIcon(details: SetIconDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the url to the html document to be opened in the sidebar when the user clicks on the sidebar action's icon.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
setPanel(details: SetPanelDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the url to the html document set as the panel for this sidebar action.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
getPanel(details: GetPanelDetailsType): Promise<string>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the extension sidebar in the active window.
|
||||||
|
*/
|
||||||
|
open(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Closes the extension sidebar in the active window if the sidebar belongs to the extension.
|
||||||
|
*/
|
||||||
|
close(): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Toggles the extension sidebar in the active window.
|
||||||
|
*/
|
||||||
|
toggle(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the sidebar action is open.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
isOpen(details: IsOpenDetailsType): Promise<boolean>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,188 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.storage
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.storage</code> API to store, retrieve, and track changes to user data.
|
||||||
|
* Permissions: "storage"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright 2014 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Storage {
|
||||||
|
interface StorageChange {
|
||||||
|
/**
|
||||||
|
* The old value of the item, if there was an old value.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
oldValue?: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new value of the item, if there is a new value.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
newValue?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface StorageArea {
|
||||||
|
/**
|
||||||
|
* Gets one or more items from storage.
|
||||||
|
*
|
||||||
|
* @param keys Optional. A single key to get, list of keys to get, or a dictionary specifying default values (see
|
||||||
|
* description of the object). An empty list or object will return an empty result object. Pass in <code>null</code>
|
||||||
|
* to get the entire contents of storage.
|
||||||
|
* @returns Callback with storage items, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
get(keys?: null | string | string[] | Record<string, any>): Promise<Record<string, any>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets multiple items.
|
||||||
|
*
|
||||||
|
* @param items <p>An object which gives each key/value pair to update storage with. Any other key/value pairs in storage
|
||||||
|
* will not be affected.</p><p>Primitive values such as numbers will serialize as expected. Values with a <code>
|
||||||
|
* typeof</code> <code>"object"</code> and <code>"function"</code> will typically serialize to <code>{}</code>,
|
||||||
|
* with the exception of <code>Array</code> (serializes as expected), <code>Date</code>, and <code>Regex</code>
|
||||||
|
* (serialize using their <code>String</code> representation).</p>
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
set(items: Record<string, any>): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes one or more items from storage.
|
||||||
|
*
|
||||||
|
* @param keys A single key or a list of keys for items to remove.
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
remove(keys: string | string[]): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all items from storage.
|
||||||
|
*
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
clear(): Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface StorageAreaSync {
|
||||||
|
/**
|
||||||
|
* Gets one or more items from storage.
|
||||||
|
*
|
||||||
|
* @param keys Optional. A single key to get, list of keys to get, or a dictionary specifying default values (see
|
||||||
|
* description of the object). An empty list or object will return an empty result object. Pass in <code>null</code>
|
||||||
|
* to get the entire contents of storage.
|
||||||
|
* @returns Callback with storage items, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
get(keys?: null | string | string[] | Record<string, any>): Promise<Record<string, any>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the amount of space (in bytes) being used by one or more items.
|
||||||
|
*
|
||||||
|
* @param keys Optional. A single key or list of keys to get the total usage for. An empty list will return 0.
|
||||||
|
* Pass in <code>null</code> to get the total usage of all of storage.
|
||||||
|
* @returns Callback with the amount of space being used by storage, or on failure (in which case $(ref:runtime.lastError)
|
||||||
|
* will be set).
|
||||||
|
*/
|
||||||
|
getBytesInUse(keys?: null | string | string[]): Promise<number>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets multiple items.
|
||||||
|
*
|
||||||
|
* @param items <p>An object which gives each key/value pair to update storage with. Any other key/value pairs in storage
|
||||||
|
* will not be affected.</p><p>Primitive values such as numbers will serialize as expected. Values with a <code>
|
||||||
|
* typeof</code> <code>"object"</code> and <code>"function"</code> will typically serialize to <code>{}</code>,
|
||||||
|
* with the exception of <code>Array</code> (serializes as expected), <code>Date</code>, and <code>Regex</code>
|
||||||
|
* (serialize using their <code>String</code> representation).</p>
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
set(items: Record<string, any>): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes one or more items from storage.
|
||||||
|
*
|
||||||
|
* @param keys A single key or a list of keys for items to remove.
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
remove(keys: string | string[]): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all items from storage.
|
||||||
|
*
|
||||||
|
* @returns Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).
|
||||||
|
*/
|
||||||
|
clear(): Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SyncStorageAreaSync extends StorageAreaSync {
|
||||||
|
/**
|
||||||
|
* The maximum total amount (in bytes) of data that can be stored in sync storage, as measured by the JSON stringification
|
||||||
|
* of every value plus every key's length. Updates that would cause this limit to be exceeded fail immediately and set
|
||||||
|
* $(ref:runtime.lastError).
|
||||||
|
*/
|
||||||
|
QUOTA_BYTES: 102400;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum size (in bytes) of each individual item in sync storage, as measured by the JSON stringification of its
|
||||||
|
* value plus its key length. Updates containing items larger than this limit will fail immediately and set $(ref:runtime.
|
||||||
|
* lastError).
|
||||||
|
*/
|
||||||
|
QUOTA_BYTES_PER_ITEM: 8192;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum number of items that can be stored in sync storage. Updates that would cause this limit to be exceeded will
|
||||||
|
* fail immediately and set $(ref:runtime.lastError).
|
||||||
|
*/
|
||||||
|
MAX_ITEMS: 512;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <p>The maximum number of <code>set</code>, <code>remove</code>, or <code>clear</code>
|
||||||
|
* operations that can be performed each hour. This is 1 every 2 seconds, a lower ceiling than the short term higher
|
||||||
|
* writes-per-minute limit.</p><p>Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.
|
||||||
|
* lastError).</p>
|
||||||
|
*/
|
||||||
|
MAX_WRITE_OPERATIONS_PER_HOUR: 1800;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <p>The maximum number of <code>set</code>, <code>remove</code>, or <code>clear</code>
|
||||||
|
* operations that can be performed each minute. This is 2 per second, providing higher throughput than writes-per-hour
|
||||||
|
* over a shorter period of time.</p><p>Updates that would cause this limit to be exceeded fail immediately and set
|
||||||
|
* $(ref:runtime.lastError).</p>
|
||||||
|
*/
|
||||||
|
MAX_WRITE_OPERATIONS_PER_MINUTE: 120;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface LocalStorageArea extends StorageArea {
|
||||||
|
/**
|
||||||
|
* The maximum amount (in bytes) of data that can be stored in local storage, as measured by the JSON stringification of
|
||||||
|
* every value plus every key's length. This value will be ignored if the extension has the <code>unlimitedStorage</code>
|
||||||
|
* permission. Updates that would cause this limit to be exceeded fail immediately and set $(ref:runtime.lastError).
|
||||||
|
*/
|
||||||
|
QUOTA_BYTES: 5242880;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ManagedStorageArea extends StorageArea {
|
||||||
|
/**
|
||||||
|
* The maximum size (in bytes) of the managed storage JSON manifest file. Files larger than this limit will fail to load.
|
||||||
|
*/
|
||||||
|
QUOTA_BYTES: 5242880;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Fired when one or more items change.
|
||||||
|
*
|
||||||
|
* @param changes Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item.
|
||||||
|
* @param areaName The name of the storage area (<code>"sync"</code>, <code>"local"</code> or <code>"managed"</code>)
|
||||||
|
* the changes are for.
|
||||||
|
*/
|
||||||
|
onChanged: Events.Event<(changes: Record<string, StorageChange>, areaName: string) => void>;
|
||||||
|
|
||||||
|
sync: SyncStorageAreaSync;
|
||||||
|
|
||||||
|
local: LocalStorageArea;
|
||||||
|
|
||||||
|
managed: ManagedStorageArea;
|
||||||
|
}
|
||||||
|
}
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,76 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.theme
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* The theme API allows customizing of visual elements of the browser.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Theme {
|
||||||
|
/**
|
||||||
|
* Info provided in the onUpdated listener.
|
||||||
|
*/
|
||||||
|
interface ThemeUpdateInfo {
|
||||||
|
/**
|
||||||
|
* The new theme after update
|
||||||
|
*/
|
||||||
|
theme: ThemeUpdateInfoThemeType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The id of the window the theme has been applied to
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowId?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new theme after update
|
||||||
|
*/
|
||||||
|
interface ThemeUpdateInfoThemeType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Returns the current theme for the specified window or the last focused window.
|
||||||
|
*
|
||||||
|
* @param windowId Optional. The window for which we want the theme.
|
||||||
|
*/
|
||||||
|
getCurrent(windowId?: number): Promise<any>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make complete updates to the theme. Resolves when the update has completed.
|
||||||
|
*
|
||||||
|
* @param windowId Optional. The id of the window to update. No id updates all windows.
|
||||||
|
* @param details The properties of the theme to update.
|
||||||
|
*/
|
||||||
|
update(windowId: number | undefined, details: Manifest.ThemeType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Make complete updates to the theme. Resolves when the update has completed.
|
||||||
|
*
|
||||||
|
* @param details The properties of the theme to update.
|
||||||
|
*/
|
||||||
|
update(details: Manifest.ThemeType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes the updates made to the theme.
|
||||||
|
*
|
||||||
|
* @param windowId Optional. The id of the window to reset. No id resets all windows.
|
||||||
|
*/
|
||||||
|
reset(windowId?: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a new theme has been applied
|
||||||
|
*
|
||||||
|
* @param updateInfo Details of the theme update
|
||||||
|
*/
|
||||||
|
onUpdated: Events.Event<(updateInfo: ThemeUpdateInfo) => void>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,100 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.topSites
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the chrome.topSites API to access the top sites that are displayed on the new tab page.
|
||||||
|
* Permissions: "topSites"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
export namespace TopSites {
|
||||||
|
/**
|
||||||
|
* An object encapsulating a most visited URL, such as the URLs on the new tab page.
|
||||||
|
*/
|
||||||
|
interface MostVisitedURL {
|
||||||
|
/**
|
||||||
|
* The most visited URL.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of the page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data URL for the favicon, if available.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
favicon?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The entry type, either <code>url</code> for a normal page link, or <code>search</code> for a search shortcut.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: MostVisitedURLTypeEnum;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetOptionsType {
|
||||||
|
/**
|
||||||
|
* The number of top sites to return, defaults to the value used by Firefox
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
limit?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Limit the result to a single top site link per domain
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
onePerDomain?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Include sites that the user has blocked from appearing on the Firefox new tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeBlocked?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Include sites favicon if available.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeFavicon?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Include sites that the user has pinned on the Firefox new tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includePinned?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Include search shortcuts appearing on the Firefox new tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeSearchShortcuts?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the sites that exactly appear on the user's new-tab page. When true, all other options are ignored except limit
|
||||||
|
* and includeFavicon. If the user disabled newtab Top Sites, the newtab parameter will be ignored.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
newtab?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The entry type, either <code>url</code> for a normal page link, or <code>search</code> for a search shortcut.
|
||||||
|
*/
|
||||||
|
type MostVisitedURLTypeEnum = "url" | "search";
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Gets a list of top sites.
|
||||||
|
*
|
||||||
|
* @param options Optional.
|
||||||
|
*/
|
||||||
|
get(options?: GetOptionsType): Promise<MostVisitedURL[]>;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,153 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.types
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Contains types used by other schemas.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Types {
|
||||||
|
/**
|
||||||
|
* The scope of the Setting. One of<ul><li><var>regular</var>: setting for the regular profile (which is inherited by the
|
||||||
|
* incognito profile if not overridden elsewhere),</li><li><var>regular_only</var>: setting for the regular profile only
|
||||||
|
* (not inherited by the incognito profile),</li><li><var>incognito_persistent</var>: setting for the incognito profile
|
||||||
|
* that survives browser restarts (overrides regular preferences),</li><li><var>incognito_session_only</var>
|
||||||
|
* : setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito
|
||||||
|
* session ends (overrides regular and incognito_persistent preferences).</li></ul> Only <var>regular</var>
|
||||||
|
* is supported by Firefox at this time.
|
||||||
|
*/
|
||||||
|
type SettingScope = "regular" | "regular_only" | "incognito_persistent" | "incognito_session_only";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* One of<ul><li><var>not_controllable</var>: cannot be controlled by any extension</li><li><var>
|
||||||
|
* controlled_by_other_extensions</var>: controlled by extensions with higher precedence</li><li><var>
|
||||||
|
* controllable_by_this_extension</var>: can be controlled by this extension</li><li><var>controlled_by_this_extension</var>
|
||||||
|
* : controlled by this extension</li></ul>
|
||||||
|
*/
|
||||||
|
type LevelOfControl =
|
||||||
|
| "not_controllable"
|
||||||
|
| "controlled_by_other_extensions"
|
||||||
|
| "controllable_by_this_extension"
|
||||||
|
| "controlled_by_this_extension";
|
||||||
|
|
||||||
|
interface Setting {
|
||||||
|
/**
|
||||||
|
* Gets the value of a setting.
|
||||||
|
*
|
||||||
|
* @param details Which setting to consider.
|
||||||
|
*/
|
||||||
|
get(details: SettingGetDetailsType): Promise<SettingGetCallbackDetailsType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the value of a setting.
|
||||||
|
*
|
||||||
|
* @param details Which setting to change.
|
||||||
|
* @returns Called at the completion of the set operation.
|
||||||
|
*/
|
||||||
|
set(details: SettingSetDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the setting, restoring any default value.
|
||||||
|
*
|
||||||
|
* @param details Which setting to clear.
|
||||||
|
* @returns Called at the completion of the clear operation.
|
||||||
|
*/
|
||||||
|
clear(details: SettingClearDetailsType): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired after the setting changes.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
onChange: Events.Event<(details: SettingOnChangeDetailsType) => void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SettingOnChangeDetailsType {
|
||||||
|
/**
|
||||||
|
* The value of the setting after the change.
|
||||||
|
*/
|
||||||
|
value: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The level of control of the setting.
|
||||||
|
*/
|
||||||
|
levelOfControl: LevelOfControl;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the value that has changed is specific to the incognito session.<br/>This property will <em>only</em>
|
||||||
|
* be present if the user has enabled the extension in incognito mode.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognitoSpecific?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which setting to consider.
|
||||||
|
*/
|
||||||
|
interface SettingGetDetailsType {
|
||||||
|
/**
|
||||||
|
* Whether to return the value that applies to the incognito session (default false).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognito?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Details of the currently effective value.
|
||||||
|
*/
|
||||||
|
interface SettingGetCallbackDetailsType {
|
||||||
|
/**
|
||||||
|
* The value of the setting.
|
||||||
|
*/
|
||||||
|
value: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The level of control of the setting.
|
||||||
|
*/
|
||||||
|
levelOfControl: LevelOfControl;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the effective value is specific to the incognito session.<br/>This property will <em>only</em>
|
||||||
|
* be present if the <var>incognito</var> property in the <var>details</var> parameter of <code>get()</code> was true.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognitoSpecific?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which setting to change.
|
||||||
|
*/
|
||||||
|
interface SettingSetDetailsType {
|
||||||
|
/**
|
||||||
|
* The value of the setting. <br/>Note that every setting has a specific value type, which is described together with the
|
||||||
|
* setting. An extension should <em>not</em> set a value of a different type.
|
||||||
|
*/
|
||||||
|
value: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Where to set the setting (default: regular).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
scope?: SettingScope;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Which setting to clear.
|
||||||
|
*/
|
||||||
|
interface SettingClearDetailsType {
|
||||||
|
/**
|
||||||
|
* Where to clear the setting (default: regular).
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
scope?: SettingScope;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,260 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.urlbar
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.urlbar</code> API to experiment with new features in the URLBar.
|
||||||
|
* Restricted to Mozilla privileged WebExtensions.
|
||||||
|
* Permissions: "urlbar"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
import { Types } from "./types";
|
||||||
|
|
||||||
|
export namespace Urlbar {
|
||||||
|
/**
|
||||||
|
* The state of an engagement made with the urlbar by the user. <code>start</code>: The user has started an engagement.
|
||||||
|
* <code>engagement</code>: The user has completed an engagement by picking a result. <code>abandonment</code>
|
||||||
|
* : The user has abandoned their engagement, for example by blurring the urlbar. <code>discard</code>
|
||||||
|
* : The engagement ended in a way that should be ignored by listeners.
|
||||||
|
*/
|
||||||
|
type EngagementState = "start" | "engagement" | "abandonment" | "discard";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A query performed in the urlbar.
|
||||||
|
*/
|
||||||
|
interface Query {
|
||||||
|
/**
|
||||||
|
* Whether the query's browser context is private.
|
||||||
|
*/
|
||||||
|
isPrivate: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The maximum number of results shown to the user.
|
||||||
|
*/
|
||||||
|
maxResults: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The query's search string.
|
||||||
|
*/
|
||||||
|
searchString: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of acceptable source types to return.
|
||||||
|
*/
|
||||||
|
sources: SourceType[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A result of a query. Queries can have many results. Each result is created by a provider.
|
||||||
|
*/
|
||||||
|
interface Result {
|
||||||
|
/**
|
||||||
|
* An object with arbitrary properties depending on the result's type.
|
||||||
|
*/
|
||||||
|
payload: ResultPayloadType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The result's source.
|
||||||
|
*/
|
||||||
|
source: SourceType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The result's type.
|
||||||
|
*/
|
||||||
|
type: ResultType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Suggest a preferred position for this result within the result set.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
suggestedIndex?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Possible types of results. <code>dynamic</code>: A result whose view and payload are specified by the extension. <code>
|
||||||
|
* remote_tab</code>: A synced tab from another device. <code>search</code>: A search suggestion from a search engine.
|
||||||
|
* <code>tab</code>: An open tab in the browser. <code>tip</code>: An actionable message to help the user with their query.
|
||||||
|
* <code>url</code>: A URL that's not one of the other types.
|
||||||
|
*/
|
||||||
|
type ResultType = "dynamic" | "remote_tab" | "search" | "tab" | "tip" | "url";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Options to the <code>search</code> function.
|
||||||
|
*/
|
||||||
|
interface SearchOptions {
|
||||||
|
/**
|
||||||
|
* Whether to focus the input field and select its contents.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
focus?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Possible sources of results. <code>bookmarks</code>: The result comes from the user's bookmarks. <code>history</code>
|
||||||
|
* : The result comes from the user's history. <code>local</code>: The result comes from some local source not covered by
|
||||||
|
* another source type. <code>network</code>: The result comes from some network source not covered by another source type.
|
||||||
|
* <code>search</code>: The result comes from a search engine. <code>tabs</code>: The result is an open tab in the browser
|
||||||
|
* or a synced tab from another device.
|
||||||
|
*/
|
||||||
|
type SourceType = "bookmarks" | "history" | "local" | "network" | "search" | "tabs";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The behavior of the provider for the query.
|
||||||
|
*/
|
||||||
|
type OnBehaviorRequestedReturnEnum = "active" | "inactive" | "restricting";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The payload of the result that was picked.
|
||||||
|
*/
|
||||||
|
interface OnResultPickedPayloadType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object with arbitrary properties depending on the result's type.
|
||||||
|
*/
|
||||||
|
interface ResultPayloadType {
|
||||||
|
[s: string]: unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Before a query starts, this event is fired for the given provider. Its purpose is to request the provider's behavior for
|
||||||
|
* the query. The listener should return a behavior in response. By default, providers are inactive,
|
||||||
|
* so if your provider should always be inactive, you don't need to listen for this event.
|
||||||
|
*/
|
||||||
|
interface onBehaviorRequestedEvent extends Events.Event<(query: Query) => OnBehaviorRequestedReturnEnum> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param providerName The name of the provider whose behavior the listener returns.
|
||||||
|
*/
|
||||||
|
addListener(callback: (query: Query) => OnBehaviorRequestedReturnEnum, providerName: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This event is fired when the user starts and ends an engagement with the urlbar.
|
||||||
|
*/
|
||||||
|
interface onEngagementEvent extends Events.Event<(state: EngagementState) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param providerName The name of the provider that will listen for engagement events.
|
||||||
|
*/
|
||||||
|
addListener(callback: (state: EngagementState) => void, providerName: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This event is fired for the given provider when a query is canceled. The listener should stop any ongoing fetch or
|
||||||
|
* creation of results and clean up its resources.
|
||||||
|
*/
|
||||||
|
interface onQueryCanceledEvent extends Events.Event<(query: Query) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param providerName The name of the provider that is creating results for the query.
|
||||||
|
*/
|
||||||
|
addListener(callback: (query: Query) => void, providerName: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When a query starts, this event is fired for the given provider if the provider is active for the query and there are no
|
||||||
|
* other providers that are restricting. Its purpose is to request the provider's results for the query.
|
||||||
|
* The listener should return a list of results in response.
|
||||||
|
*/
|
||||||
|
interface onResultsRequestedEvent extends Events.Event<(query: Query) => Result[]> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param providerName The name of the provider whose results the listener returns.
|
||||||
|
*/
|
||||||
|
addListener(callback: (query: Query) => Result[], providerName: string): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Typically, a provider includes a <code>url</code> property in its results' payloads.
|
||||||
|
* When the user picks a result with a URL, Firefox automatically loads the URL. URLs don't make sense for every result
|
||||||
|
* type, however. When the user picks a result without a URL, this event is fired. The provider should take an appropriate
|
||||||
|
* action in response. Currently the only applicable <code>ResultTypes</code> are <code>dynamic</code> and <code>tip</code>.
|
||||||
|
*/
|
||||||
|
interface onResultPickedEvent
|
||||||
|
extends Events.Event<(payload: OnResultPickedPayloadType, elementName: string) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param providerName The listener will be called for the results of the provider with this name.
|
||||||
|
*/
|
||||||
|
addListener(
|
||||||
|
callback: (payload: OnResultPickedPayloadType, elementName: string) => void,
|
||||||
|
providerName: string
|
||||||
|
): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Closes the urlbar view in the current window.
|
||||||
|
*/
|
||||||
|
closeView(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Focuses the urlbar in the current window.
|
||||||
|
*
|
||||||
|
* @param select Optional. If true, the text in the urlbar will also be selected.
|
||||||
|
*/
|
||||||
|
focus(select?: boolean): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts a search in the urlbar in the current window.
|
||||||
|
*
|
||||||
|
* @param searchString The search string.
|
||||||
|
* @param options Optional. Options for the search.
|
||||||
|
*/
|
||||||
|
search(searchString: string, options?: SearchOptions): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Before a query starts, this event is fired for the given provider. Its purpose is to request the provider's behavior for
|
||||||
|
* the query. The listener should return a behavior in response. By default, providers are inactive,
|
||||||
|
* so if your provider should always be inactive, you don't need to listen for this event.
|
||||||
|
*/
|
||||||
|
onBehaviorRequested: onBehaviorRequestedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This event is fired when the user starts and ends an engagement with the urlbar.
|
||||||
|
*/
|
||||||
|
onEngagement: onEngagementEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This event is fired for the given provider when a query is canceled. The listener should stop any ongoing fetch or
|
||||||
|
* creation of results and clean up its resources.
|
||||||
|
*/
|
||||||
|
onQueryCanceled: onQueryCanceledEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* When a query starts, this event is fired for the given provider if the provider is active for the query and there are no
|
||||||
|
* other providers that are restricting. Its purpose is to request the provider's results for the query.
|
||||||
|
* The listener should return a list of results in response.
|
||||||
|
*/
|
||||||
|
onResultsRequested: onResultsRequestedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Typically, a provider includes a <code>url</code> property in its results' payloads.
|
||||||
|
* When the user picks a result with a URL, Firefox automatically loads the URL. URLs don't make sense for every result
|
||||||
|
* type, however. When the user picks a result without a URL, this event is fired. The provider should take an appropriate
|
||||||
|
* action in response. Currently the only applicable <code>ResultTypes</code> are <code>dynamic</code> and <code>tip</code>.
|
||||||
|
*/
|
||||||
|
onResultPicked: onResultPickedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enables or disables the engagement telemetry.
|
||||||
|
*/
|
||||||
|
engagementTelemetry: Types.Setting;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,88 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.userScripts
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Permissions: "manifest:user_scripts"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
*/
|
||||||
|
import { ExtensionTypes } from "./extensionTypes";
|
||||||
|
import { Manifest } from "./manifest";
|
||||||
|
|
||||||
|
export namespace UserScripts {
|
||||||
|
/**
|
||||||
|
* Details of a user script
|
||||||
|
*/
|
||||||
|
interface UserScriptOptions {
|
||||||
|
/**
|
||||||
|
* The list of JS files to inject
|
||||||
|
*/
|
||||||
|
js: ExtensionTypes.ExtensionFileOrCode[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An opaque user script metadata value
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
scriptMetadata?: ExtensionTypes.PlainJSONValue;
|
||||||
|
|
||||||
|
matches: Manifest.MatchPattern[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
excludeMatches?: Manifest.MatchPattern[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
includeGlobs?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
excludeGlobs?: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If allFrames is <code>true</code>, implies that the JavaScript should be injected into all frames of current page.
|
||||||
|
* By default, it's <code>false</code> and is only injected into the top frame.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allFrames?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If matchAboutBlank is true, then the code is also injected in about:blank and about:srcdoc frames if your extension has
|
||||||
|
* access to its parent document. Code cannot be inserted in top-level about:-frames. By default it is <code>false</code>.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
matchAboutBlank?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The soonest that the JavaScript will be injected into the tab. Defaults to "document_idle".
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
runAt?: ExtensionTypes.RunAt;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An object that represents a user script registered programmatically
|
||||||
|
*/
|
||||||
|
interface RegisteredUserScript {
|
||||||
|
/**
|
||||||
|
* Unregister a user script registered programmatically
|
||||||
|
*/
|
||||||
|
unregister(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Register a user script programmatically given its $(ref:userScripts.UserScriptOptions),
|
||||||
|
* and resolves to a $(ref:userScripts.RegisteredUserScript) instance
|
||||||
|
*
|
||||||
|
* @param userScriptOptions
|
||||||
|
*/
|
||||||
|
register(userScriptOptions: UserScriptOptions): void;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,512 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.webNavigation
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.webNavigation</code> API to receive notifications about the status of navigation requests
|
||||||
|
* in-flight.
|
||||||
|
* Permissions: "webNavigation"
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace WebNavigation {
|
||||||
|
/**
|
||||||
|
* Cause of the navigation. The same transition types as defined in the history API are used.
|
||||||
|
* These are the same transition types as defined in the $(topic:transition_types)[history API] except with <code>
|
||||||
|
* "start_page"</code> in place of <code>"auto_toplevel"</code> (for backwards compatibility).
|
||||||
|
*/
|
||||||
|
type TransitionType =
|
||||||
|
| "link"
|
||||||
|
| "typed"
|
||||||
|
| "auto_bookmark"
|
||||||
|
| "auto_subframe"
|
||||||
|
| "manual_subframe"
|
||||||
|
| "generated"
|
||||||
|
| "start_page"
|
||||||
|
| "form_submit"
|
||||||
|
| "reload"
|
||||||
|
| "keyword"
|
||||||
|
| "keyword_generated";
|
||||||
|
|
||||||
|
type TransitionQualifier = "client_redirect" | "server_redirect" | "forward_back" | "from_address_bar";
|
||||||
|
|
||||||
|
interface EventUrlFilters {
|
||||||
|
url: Events.UrlFilter[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about the frame to retrieve information about.
|
||||||
|
*/
|
||||||
|
interface GetFrameDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the frame is.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the process runs the renderer for this tab.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
processId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the frame in the given tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about the requested frame, null if the specified frame ID and/or tab ID are invalid.
|
||||||
|
*/
|
||||||
|
interface GetFrameCallbackDetailsType {
|
||||||
|
/**
|
||||||
|
* True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
errorOccurred?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL currently associated with this frame, if the frame identified by the frameId existed at one point in the given
|
||||||
|
* tab. The fact that an URL is associated with a given frameId does not imply that the corresponding frame still exists.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the frame is.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ID of frame that wraps the frame. Set to -1 of no parent frame exists.
|
||||||
|
*/
|
||||||
|
parentFrameId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Information about the tab to retrieve all frames from.
|
||||||
|
*/
|
||||||
|
interface GetAllFramesDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GetAllFramesCallbackDetailsItemType {
|
||||||
|
/**
|
||||||
|
* True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
errorOccurred?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the frame is.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the frame. 0 indicates that this is the main frame; a positive value indicates the ID of a subframe.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ID of frame that wraps the frame. Set to -1 of no parent frame exists.
|
||||||
|
*/
|
||||||
|
parentFrameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL currently associated with this frame.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnBeforeNavigateDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation is about to occur.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique for a given tab and process.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ID of frame that wraps the frame. Set to -1 of no parent frame exists.
|
||||||
|
*/
|
||||||
|
parentFrameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the browser was about to start the navigation, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnCommittedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the navigation was committed, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnDOMContentLoadedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the page's DOM was fully constructed, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnCompletedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the document finished loading, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnErrorOccurredDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the error occurred, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnCreatedNavigationTargetDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation is triggered.
|
||||||
|
*/
|
||||||
|
sourceTabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the process runs the renderer for the source tab.
|
||||||
|
*/
|
||||||
|
sourceProcessId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the frame with sourceTabId in which the navigation is triggered. 0 indicates the main frame.
|
||||||
|
*/
|
||||||
|
sourceFrameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The URL to be opened in the new window.
|
||||||
|
*/
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the url is opened
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the browser was about to create a new view, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnReferenceFragmentUpdatedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the navigation was committed, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnTabReplacedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab that was replaced.
|
||||||
|
*/
|
||||||
|
replacedTabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The ID of the tab that replaced the old tab.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the replacement happened, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface OnHistoryStateUpdatedDetailsType {
|
||||||
|
/**
|
||||||
|
* The ID of the tab in which the navigation occurs.
|
||||||
|
*/
|
||||||
|
tabId: number;
|
||||||
|
|
||||||
|
url: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe.
|
||||||
|
* Frame IDs are unique within a tab.
|
||||||
|
*/
|
||||||
|
frameId: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The time when the navigation was committed, in milliseconds since the epoch.
|
||||||
|
*/
|
||||||
|
timeStamp: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a navigation is about to occur.
|
||||||
|
*/
|
||||||
|
interface onBeforeNavigateEvent extends Events.Event<(details: OnBeforeNavigateDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnBeforeNavigateDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes)
|
||||||
|
* might still be downloading, but at least part of the document has been received from the server and the browser has
|
||||||
|
* decided to switch to the new document.
|
||||||
|
*/
|
||||||
|
interface onCommittedEvent extends Events.Event<(details: OnCommittedDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnCommittedDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.
|
||||||
|
*/
|
||||||
|
interface onDOMContentLoadedEvent extends Events.Event<(details: OnDOMContentLoadedDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnDOMContentLoadedDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a document, including the resources it refers to, is completely loaded and initialized.
|
||||||
|
*/
|
||||||
|
interface onCompletedEvent extends Events.Event<(details: OnCompletedDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnCompletedDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred,
|
||||||
|
* or the user aborted the navigation.
|
||||||
|
*/
|
||||||
|
interface onErrorOccurredEvent extends Events.Event<(details: OnErrorOccurredDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnErrorOccurredDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a new window, or a new tab in an existing window, is created to host a navigation.
|
||||||
|
*/
|
||||||
|
interface onCreatedNavigationTargetEvent
|
||||||
|
extends Events.Event<(details: OnCreatedNavigationTargetDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnCreatedNavigationTargetDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.
|
||||||
|
*/
|
||||||
|
interface onReferenceFragmentUpdatedEvent
|
||||||
|
extends Events.Event<(details: OnReferenceFragmentUpdatedDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(
|
||||||
|
callback: (details: OnReferenceFragmentUpdatedDetailsType) => void,
|
||||||
|
filters?: EventUrlFilters
|
||||||
|
): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.
|
||||||
|
*/
|
||||||
|
interface onHistoryStateUpdatedEvent extends Events.Event<(details: OnHistoryStateUpdatedDetailsType) => void> {
|
||||||
|
/**
|
||||||
|
* Registers an event listener <em>callback</em> to an event.
|
||||||
|
*
|
||||||
|
* @param callback Called when an event occurs. The parameters of this function depend on the type of event.
|
||||||
|
* @param filters Optional. Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of
|
||||||
|
* UrlFilter are ignored for this event.
|
||||||
|
*/
|
||||||
|
addListener(callback: (details: OnHistoryStateUpdatedDetailsType) => void, filters?: EventUrlFilters): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Retrieves information about the given frame. A frame refers to an <iframe> or a <frame> of a web page and is
|
||||||
|
* identified by a tab ID and a frame ID.
|
||||||
|
*
|
||||||
|
* @param details Information about the frame to retrieve information about.
|
||||||
|
*/
|
||||||
|
getFrame(details: GetFrameDetailsType): Promise<GetFrameCallbackDetailsType>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves information about all frames of a given tab.
|
||||||
|
*
|
||||||
|
* @param details Information about the tab to retrieve all frames from.
|
||||||
|
*/
|
||||||
|
getAllFrames(details: GetAllFramesDetailsType): Promise<GetAllFramesCallbackDetailsItemType[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a navigation is about to occur.
|
||||||
|
*/
|
||||||
|
onBeforeNavigate: onBeforeNavigateEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes)
|
||||||
|
* might still be downloading, but at least part of the document has been received from the server and the browser has
|
||||||
|
* decided to switch to the new document.
|
||||||
|
*/
|
||||||
|
onCommitted: onCommittedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.
|
||||||
|
*/
|
||||||
|
onDOMContentLoaded: onDOMContentLoadedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a document, including the resources it refers to, is completely loaded and initialized.
|
||||||
|
*/
|
||||||
|
onCompleted: onCompletedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred,
|
||||||
|
* or the user aborted the navigation.
|
||||||
|
*/
|
||||||
|
onErrorOccurred: onErrorOccurredEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a new window, or a new tab in an existing window, is created to host a navigation.
|
||||||
|
*/
|
||||||
|
onCreatedNavigationTarget: onCreatedNavigationTargetEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.
|
||||||
|
*/
|
||||||
|
onReferenceFragmentUpdated: onReferenceFragmentUpdatedEvent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.
|
||||||
|
*
|
||||||
|
* @param details
|
||||||
|
*/
|
||||||
|
onTabReplaced: Events.Event<(details: OnTabReplacedDetailsType) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.
|
||||||
|
*/
|
||||||
|
onHistoryStateUpdated: onHistoryStateUpdatedEvent;
|
||||||
|
}
|
||||||
|
}
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,372 @@
|
||||||
|
/**
|
||||||
|
* Namespace: browser.windows
|
||||||
|
* Generated from Mozilla sources. Do not manually edit!
|
||||||
|
*
|
||||||
|
* Use the <code>browser.windows</code> API to interact with browser windows. You can use this API to create, modify,
|
||||||
|
* and rearrange windows in the browser.
|
||||||
|
*
|
||||||
|
* Comments found in source JSON schema files:
|
||||||
|
* Copyright (c) 2012 The Chromium Authors. All rights reserved.
|
||||||
|
* Use of this source code is governed by a BSD-style license that can be
|
||||||
|
* found in the LICENSE file.
|
||||||
|
*/
|
||||||
|
import { Tabs } from "./tabs";
|
||||||
|
import { Events } from "./events";
|
||||||
|
|
||||||
|
export namespace Windows {
|
||||||
|
/**
|
||||||
|
* The type of browser window this is. Under some circumstances a Window may not be assigned type property,
|
||||||
|
* for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
*/
|
||||||
|
type WindowType = "normal" | "popup" | "panel" | "app" | "devtools";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The state of this browser window. Under some circumstances a Window may not be assigned state property,
|
||||||
|
* for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
*/
|
||||||
|
type WindowState = "normal" | "minimized" | "maximized" | "fullscreen" | "docked";
|
||||||
|
|
||||||
|
interface Window {
|
||||||
|
/**
|
||||||
|
* The ID of the window. Window IDs are unique within a browser session. Under some circumstances a Window may not be
|
||||||
|
* assigned an ID, for example when querying windows using the $(ref:sessions) API, in which case a session ID may be
|
||||||
|
* present.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
id?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the window is currently the focused window.
|
||||||
|
*/
|
||||||
|
focused: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The offset of the window from the top edge of the screen in pixels. Under some circumstances a Window may not be
|
||||||
|
* assigned top property, for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
top?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The offset of the window from the left edge of the screen in pixels. Under some circumstances a Window may not be
|
||||||
|
* assigned left property, for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
left?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The width of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned width
|
||||||
|
* property, for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
width?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The height of the window, including the frame, in pixels. Under some circumstances a Window may not be assigned height
|
||||||
|
* property, for example when querying closed windows from the $(ref:sessions) API.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
height?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of $(ref:tabs.Tab) objects representing the current tabs in the window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabs?: Tabs.Tab[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the window is incognito.
|
||||||
|
*/
|
||||||
|
incognito: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The type of browser window this is.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: WindowType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The state of this browser window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
state?: WindowState;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the window is set to be always on top.
|
||||||
|
*/
|
||||||
|
alwaysOnTop: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The session ID used to uniquely identify a Window obtained from the $(ref:sessions) API.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
sessionId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of the window. Read-only.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the
|
||||||
|
* '--enable-panels' flag is set.
|
||||||
|
*/
|
||||||
|
type CreateType = "normal" | "popup" | "panel" | "detached_panel";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies whether the $(ref:windows.Window) returned should contain a list of the $(ref:tabs.Tab) objects.
|
||||||
|
*/
|
||||||
|
interface GetInfo {
|
||||||
|
/**
|
||||||
|
* If true, the $(ref:windows.Window) returned will have a <var>tabs</var> property that contains a list of the $(ref:tabs.
|
||||||
|
* Tab) objects. The <code>Tab</code> objects only contain the <code>url</code>, <code>title</code> and <code>
|
||||||
|
* favIconUrl</code> properties if the extension's manifest file includes the <code>"tabs"</code> permission.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
populate?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies properties used to filter the $(ref:windows.Window) returned and to determine whether they should contain a
|
||||||
|
* list of the $(ref:tabs.Tab) objects.
|
||||||
|
*/
|
||||||
|
interface GetAllGetInfoType extends GetInfo {
|
||||||
|
/**
|
||||||
|
* If set, the $(ref:windows.Window) returned will be filtered based on its type. If unset the default filter is set to
|
||||||
|
* <code>['app', 'normal', 'panel', 'popup']</code>, with <code>'app'</code> and <code>'panel'</code>
|
||||||
|
* window types limited to the extension's own windows.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
windowTypes?: WindowType[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CreateCreateDataType {
|
||||||
|
/**
|
||||||
|
* A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. 'http://www.
|
||||||
|
* google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension.
|
||||||
|
* Defaults to the New Tab Page.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
url?: string | string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The id of the tab for which you want to adopt to the new window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
tabId?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The number of pixels to position the new window from the left edge of the screen. If not specified,
|
||||||
|
* the new window is offset naturally from the last focused window. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
left?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The number of pixels to position the new window from the top edge of the screen. If not specified,
|
||||||
|
* the new window is offset naturally from the last focused window. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
top?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The width in pixels of the new window, including the frame. If not specified defaults to a natural width.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
width?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The height in pixels of the new window, including the frame. If not specified defaults to a natural height.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
height?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If true, the new window will be focused. If false, the new window will be opened in the background and the currently
|
||||||
|
* focused window will stay focused. Defaults to true.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
focused?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether the new window should be an incognito window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
incognito?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specifies what type of browser window to create. The 'panel' and 'detached_panel' types create a popup unless the
|
||||||
|
* '--enable-panels' flag is set.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
type?: CreateType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The initial state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left',
|
||||||
|
* 'top', 'width' or 'height'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
state?: WindowState;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Allow scripts to close the window.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
allowScriptsToClose?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The CookieStoreId to use for all tabs that were created when the window is opened.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
cookieStoreId?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A string to add to the beginning of the window title.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
titlePreface?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UpdateUpdateInfoType {
|
||||||
|
/**
|
||||||
|
* The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
left?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
top?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The width to resize the window to in pixels. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
width?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The height to resize the window to in pixels. This value is ignored for panels.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
height?: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If true, brings the window to the front. If false, brings the next window in the z-order to the front.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
focused?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If true, causes the window to be displayed in a manner that draws the user's attention to the window,
|
||||||
|
* without changing the focused window. The effect lasts until the user changes focus to the window.
|
||||||
|
* This option has no effect if the window already has focus. Set to false to cancel a previous draw attention request.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
drawAttention?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The new state of the window. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined with 'left', 'top',
|
||||||
|
* 'width' or 'height'.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
state?: WindowState;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A string to add to the beginning of the window title.
|
||||||
|
* Optional.
|
||||||
|
*/
|
||||||
|
titlePreface?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Static {
|
||||||
|
/**
|
||||||
|
* Gets details about a window.
|
||||||
|
*
|
||||||
|
* @param windowId
|
||||||
|
* @param getInfo Optional.
|
||||||
|
*/
|
||||||
|
get(windowId: number, getInfo?: GetInfo): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the $(topic:current-window)[current window].
|
||||||
|
*
|
||||||
|
* @param getInfo Optional.
|
||||||
|
*/
|
||||||
|
getCurrent(getInfo?: GetInfo): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the window that was most recently focused — typically the window 'on top'.
|
||||||
|
*
|
||||||
|
* @param getInfo Optional.
|
||||||
|
*/
|
||||||
|
getLastFocused(getInfo?: GetInfo): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets all windows.
|
||||||
|
*
|
||||||
|
* @param getInfo Optional. Specifies properties used to filter the $(ref:windows.Window)
|
||||||
|
* returned and to determine whether they should contain a list of the $(ref:tabs.Tab) objects.
|
||||||
|
*/
|
||||||
|
getAll(getInfo?: GetAllGetInfoType): Promise<Window[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates (opens) a new browser with any optional sizing, position or default URL provided.
|
||||||
|
*
|
||||||
|
* @param createData Optional.
|
||||||
|
*/
|
||||||
|
create(createData?: CreateCreateDataType): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be
|
||||||
|
* left unchanged.
|
||||||
|
*
|
||||||
|
* @param windowId
|
||||||
|
* @param updateInfo
|
||||||
|
*/
|
||||||
|
update(windowId: number, updateInfo: UpdateUpdateInfoType): Promise<Window>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes (closes) a window, and all the tabs inside it.
|
||||||
|
*
|
||||||
|
* @param windowId
|
||||||
|
*/
|
||||||
|
remove(windowId: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a window is created.
|
||||||
|
*
|
||||||
|
* @param window Details of the window that was created.
|
||||||
|
*/
|
||||||
|
onCreated: Events.Event<(window: Window) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when a window is removed (closed).
|
||||||
|
*
|
||||||
|
* @param windowId ID of the removed window.
|
||||||
|
*/
|
||||||
|
onRemoved: Events.Event<(windowId: number) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the currently focused window changes. Will be $(ref:windows.WINDOW_ID_NONE)
|
||||||
|
* if all browser windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent
|
||||||
|
* immediately preceding a switch from one browser window to another.
|
||||||
|
*
|
||||||
|
* @param windowId ID of the newly focused window.
|
||||||
|
*/
|
||||||
|
onFocusChanged: Events.Event<(windowId: number) => void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The windowId value that represents the absence of a browser window.
|
||||||
|
*/
|
||||||
|
WINDOW_ID_NONE: -1;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The windowId value that represents the $(topic:current-window)[current window].
|
||||||
|
*/
|
||||||
|
WINDOW_ID_CURRENT: -2;
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue