LumeWeb
/
webextension-polyfill
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
webextension-polyfill/api-metadata.json

662 lines
10 KiB
JSON
Raw Normal View History

Initial checkin.
2016-10-07 01:20:37 +00:00
{
"alarms": {
"clear": {
"minArgs": 0,
"maxArgs": 1
},
"clearAll": {
"minArgs": 0,
"maxArgs": 0
},
"get": {
"minArgs": 0,
"maxArgs": 1
},
"getAll": {
"minArgs": 0,
"maxArgs": 0
}
},
"bookmarks": {
"create": {
"minArgs": 1,
"maxArgs": 1
},
"get": {
"minArgs": 1,
"maxArgs": 1
},
"getChildren": {
"minArgs": 1,
"maxArgs": 1
},
"getRecent": {
"minArgs": 1,
"maxArgs": 1
},
"getSubTree": {
"minArgs": 1,
"maxArgs": 1
},
fix: Remove non-existing bookmarks.{export,import} These APIs are not supported by Firefox: https://searchfox.org/mozilla-central/rev/292d295d6b084b43b70de26a42e68513bb7b36a3/browser/components/extensions/schemas/bookmarks.json#436-465 In Chrome the APIs are not available either, except to some internal components: https://chromium.googlesource.com/chromium/src/+/b7963dca6a9903ab439c89d102463b0268c5997e/chrome/common/extensions/api/_api_features.json#138 Also moved "getTree" to ensure that the keys are alphabetically sorted.
2018-06-05 13:06:07 +00:00
"getTree": {
Initial checkin.
2016-10-07 01:20:37 +00:00
"minArgs": 0,
"maxArgs": 0
},
"move": {
"minArgs": 2,
"maxArgs": 2
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"removeTree": {
"minArgs": 1,
"maxArgs": 1
},
"search": {
"minArgs": 1,
"maxArgs": 1
},
"update": {
"minArgs": 2,
"maxArgs": 2
}
},
"browserAction": {
fix: Add missing browserAction APIs (#99) Note that the "openPopup" method is only available to the dev channel: https://chromium.googlesource.com/chromium/src/+/c2b078825ab52c22d0b473682b8eb214836ede25/chrome/common/extensions/api/_api_features.json#178 https://crbug.com/436489
2018-06-05 13:13:48 +00:00
"disable": {
"minArgs": 0,
"maxArgs": 1,
"fallbackToNoCallback": true
},
"enable": {
"minArgs": 0,
"maxArgs": 1,
"fallbackToNoCallback": true
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"getBadgeBackgroundColor": {
"minArgs": 1,
"maxArgs": 1
},
"getBadgeText": {
"minArgs": 1,
"maxArgs": 1
},
"getPopup": {
"minArgs": 1,
"maxArgs": 1
},
"getTitle": {
"minArgs": 1,
"maxArgs": 1
},
fix: Add missing browserAction APIs (#99) Note that the "openPopup" method is only available to the dev channel: https://chromium.googlesource.com/chromium/src/+/c2b078825ab52c22d0b473682b8eb214836ede25/chrome/common/extensions/api/_api_features.json#178 https://crbug.com/436489
2018-06-05 13:13:48 +00:00
"openPopup": {
"minArgs": 0,
"maxArgs": 0
},
"setBadgeBackgroundColor": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
},
"setBadgeText": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"setIcon": {
"minArgs": 1,
"maxArgs": 1
fix: Add missing browserAction APIs (#99) Note that the "openPopup" method is only available to the dev channel: https://chromium.googlesource.com/chromium/src/+/c2b078825ab52c22d0b473682b8eb214836ede25/chrome/common/extensions/api/_api_features.json#178 https://crbug.com/436489
2018-06-05 13:13:48 +00:00
},
"setPopup": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
},
"setTitle": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
Initial checkin.
2016-10-07 01:20:37 +00:00
}
},
feat: Add browsingData namespace to metadata The auto-generated output from the metadata generator also includes the following methods from Chrome. Firefox does not support them, so they were not included in the metadata: ``` "removeAppcache": { "minArgs": 1, "maxArgs": 1 }, "removeFileSystems": { "minArgs": 1, "maxArgs": 1 }, "removeIndexedDB": { "minArgs": 1, "maxArgs": 1 }, "removeWebSQL": { "minArgs": 1, "maxArgs": 1 }, ``` Also see: https://searchfox.org/mozilla-central/rev/292d295d6b084b43b70de26a42e68513bb7b36a3/browser/components/extensions/schemas/browsing_data.json https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/browsingData#Browser_compatibility
2018-06-05 14:37:55 +00:00
"browsingData": {
"remove": {
"minArgs": 2,
"maxArgs": 2
},
"removeCache": {
"minArgs": 1,
"maxArgs": 1
},
"removeCookies": {
"minArgs": 1,
"maxArgs": 1
},
"removeDownloads": {
"minArgs": 1,
"maxArgs": 1
},
"removeFormData": {
"minArgs": 1,
"maxArgs": 1
},
"removeHistory": {
"minArgs": 1,
"maxArgs": 1
},
"removeLocalStorage": {
"minArgs": 1,
"maxArgs": 1
},
"removePasswords": {
"minArgs": 1,
"maxArgs": 1
},
"removePluginData": {
"minArgs": 1,
"maxArgs": 1
},
"settings": {
"minArgs": 0,
"maxArgs": 0
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"commands": {
"getAll": {
"minArgs": 0,
"maxArgs": 0
}
},
"contextMenus": {
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"removeAll": {
"minArgs": 0,
"maxArgs": 0
style: Alphabetically sort keys in contextMenus
2018-06-05 13:19:34 +00:00
},
"update": {
"minArgs": 2,
"maxArgs": 2
Initial checkin.
2016-10-07 01:20:37 +00:00
}
},
"cookies": {
"get": {
"minArgs": 1,
"maxArgs": 1
},
"getAll": {
"minArgs": 1,
"maxArgs": 1
},
"getAllCookieStores": {
"minArgs": 0,
"maxArgs": 0
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"set": {
"minArgs": 1,
"maxArgs": 1
}
},
feat: Added devtools.inspectedWindow.eval and devtools.panels.create to wrapped APIs. To be able to wrap the devtools API namespaces, this patch applies the following changes: - fix: Prevent Proxy violation exception on the read-only/non-configurable devtools property by using an empty object with the `chrome` API object as its prototype as the root Proxy target (the Proxy instances returned for the `chrome` API object) and add a related test case. - fix: Added support for a new `singleCallbackArg` metadata property, which prevents devtools.panels.create to resolve an array of parameters (See the related Chromium issue at https://bugs.chromium.org/p/chromium/issues/detail?id=768159) and add the related test cases. - test: Changes to the test case related to proxy getter/setter behavior on non wrapped properties: in the "deletes proxy getter/setter that are not wrapped" test case from the "test-proxied-properties.js" test file, we ensure that when a getter/setter is called for a "non-wrapped" property, the getter/setter is going to affect the original target object, unfortunately this in not true anymore for the root object (the `chrome` API object) because we are using an empty object (which has the `chrome` API object as its prototype and it is not exposed outside of the polyfill sources) as the target of the Proxy instance related to it, this change to the target of the Proxy has been needed to prevent the TypeError exception raised by the Proxy instance when we try to access the "devtools" property (which is non-configurable and read-only on the `chrome` API object).
2017-09-22 21:38:44 +00:00
"devtools": {
"inspectedWindow": {
"eval": {
"minArgs": 1,
"maxArgs": 2
}
},
"panels": {
"create": {
"minArgs": 3,
"maxArgs": 3,
"singleCallbackArg": true
}
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"downloads": {
fix: Fix downloads schemas - Alphabetically sort keys - Add `"fallbackToNoCallback": true` to `open` and `show` because these methods do currently not take any callbacks in Chrome: https://developer.chrome.com/extensions/downloads#method-open https://developer.chrome.com/extensions/downloads#method-show - Chrome has a `downloads.acceptDanger` method, but Firefox does not, so this is not included in the schema.
2018-06-05 13:34:56 +00:00
"cancel": {
Initial checkin.
2016-10-07 01:20:37 +00:00
"minArgs": 1,
"maxArgs": 1
},
fix: Fix downloads schemas - Alphabetically sort keys - Add `"fallbackToNoCallback": true` to `open` and `show` because these methods do currently not take any callbacks in Chrome: https://developer.chrome.com/extensions/downloads#method-open https://developer.chrome.com/extensions/downloads#method-show - Chrome has a `downloads.acceptDanger` method, but Firefox does not, so this is not included in the schema.
2018-06-05 13:34:56 +00:00
"download": {
Initial checkin.
2016-10-07 01:20:37 +00:00
"minArgs": 1,
"maxArgs": 1
},
"erase": {
"minArgs": 1,
"maxArgs": 1
},
"getFileIcon": {
"minArgs": 1,
"maxArgs": 2
},
"open": {
"minArgs": 1,
fix: Fix downloads schemas - Alphabetically sort keys - Add `"fallbackToNoCallback": true` to `open` and `show` because these methods do currently not take any callbacks in Chrome: https://developer.chrome.com/extensions/downloads#method-open https://developer.chrome.com/extensions/downloads#method-show - Chrome has a `downloads.acceptDanger` method, but Firefox does not, so this is not included in the schema.
2018-06-05 13:34:56 +00:00
"maxArgs": 1,
"fallbackToNoCallback": true
Initial checkin.
2016-10-07 01:20:37 +00:00
},
"pause": {
"minArgs": 1,
"maxArgs": 1
},
"removeFile": {
"minArgs": 1,
"maxArgs": 1
},
"resume": {
"minArgs": 1,
"maxArgs": 1
},
"search": {
"minArgs": 1,
"maxArgs": 1
},
"show": {
"minArgs": 1,
fix: Fix downloads schemas - Alphabetically sort keys - Add `"fallbackToNoCallback": true` to `open` and `show` because these methods do currently not take any callbacks in Chrome: https://developer.chrome.com/extensions/downloads#method-open https://developer.chrome.com/extensions/downloads#method-show - Chrome has a `downloads.acceptDanger` method, but Firefox does not, so this is not included in the schema.
2018-06-05 13:34:56 +00:00
"maxArgs": 1,
"fallbackToNoCallback": true
Initial checkin.
2016-10-07 01:20:37 +00:00
}
},
"extension": {
"isAllowedFileSchemeAccess": {
"minArgs": 0,
"maxArgs": 0
},
"isAllowedIncognitoAccess": {
"minArgs": 0,
"maxArgs": 0
}
},
"history": {
"addUrl": {
"minArgs": 1,
"maxArgs": 1
},
"deleteAll": {
"minArgs": 0,
"maxArgs": 0
},
"deleteRange": {
"minArgs": 1,
"maxArgs": 1
},
"deleteUrl": {
"minArgs": 1,
"maxArgs": 1
},
style: alphabetically sort history keys
2018-06-05 13:38:34 +00:00
"getVisits": {
"minArgs": 1,
"maxArgs": 1
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"search": {
"minArgs": 1,
"maxArgs": 1
}
},
"i18n": {
"detectLanguage": {
"minArgs": 1,
"maxArgs": 1
},
"getAcceptLanguages": {
"minArgs": 0,
"maxArgs": 0
}
},
feat: add identity.launchWebAuthFlow() in metadata. (#39) Provides the api metadata for the identity.launchWebAuthFlow API method (which fixes #80)
2018-01-09 15:27:33 +00:00
"identity": {
"launchWebAuthFlow": {
"minArgs": 1,
"maxArgs": 1
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"idle": {
"queryState": {
"minArgs": 1,
"maxArgs": 1
}
},
"management": {
"get": {
"minArgs": 1,
"maxArgs": 1
},
"getAll": {
"minArgs": 0,
"maxArgs": 0
},
"getSelf": {
"minArgs": 0,
"maxArgs": 0
},
fix: Add missing management.setEnabled setEnabled is partially implemented in Firefox: - https://bugzil.la/1282982 - https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/management/setEnabled The management API has many more methods in Chrome, Firefox does not support them: - createAppShortcut - generateAppForLink - getPermissionWarningsById - getPermissionWarningsByManifest - launchApp - setLaunchType - uninstall
2018-06-05 13:50:17 +00:00
"setEnabled": {
"minArgs": 2,
"maxArgs": 2
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"uninstallSelf": {
"minArgs": 0,
"maxArgs": 1
}
},
"notifications": {
"clear": {
"minArgs": 1,
"maxArgs": 1
},
"create": {
"minArgs": 1,
"maxArgs": 2
},
"getAll": {
"minArgs": 0,
"maxArgs": 0
},
"getPermissionLevel": {
"minArgs": 0,
"maxArgs": 0
},
"update": {
"minArgs": 2,
"maxArgs": 2
}
},
"pageAction": {
"getPopup": {
"minArgs": 1,
"maxArgs": 1
},
fix: Add a new fallbackToNoCallback metadata property to customize the pageAction.show/hide wrappers behavior
2017-09-26 12:32:06 +00:00
"setPopup": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"getTitle": {
"minArgs": 1,
"maxArgs": 1
},
fix: Add a new fallbackToNoCallback metadata property to customize the pageAction.show/hide wrappers behavior
2017-09-26 12:32:06 +00:00
"setTitle": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"hide": {
fix: pageAction.show/hide should have 1 non-optional parameter in their metadata
2017-09-26 12:30:21 +00:00
"minArgs": 1,
fix: Add a new fallbackToNoCallback metadata property to customize the pageAction.show/hide wrappers behavior
2017-09-26 12:32:06 +00:00
"maxArgs": 1,
"fallbackToNoCallback": true
Initial checkin.
2016-10-07 01:20:37 +00:00
},
"setIcon": {
"minArgs": 1,
"maxArgs": 1
},
fix: Add a new fallbackToNoCallback metadata property to customize the pageAction.show/hide wrappers behavior
2017-09-26 12:32:06 +00:00
"getIcon": {
fix: pageAction.show/hide should have 1 non-optional parameter in their metadata
2017-09-26 12:30:21 +00:00
"minArgs": 1,
"maxArgs": 1
fix: Add a new fallbackToNoCallback metadata property to customize the pageAction.show/hide wrappers behavior
2017-09-26 12:32:06 +00:00
},
"show": {
"minArgs": 1,
"maxArgs": 1,
"fallbackToNoCallback": true
Initial checkin.
2016-10-07 01:20:37 +00:00
}
},
feat: Add permissions namespace to metadata https://searchfox.org/mozilla-central/rev/292d295d6b084b43b70de26a42e68513bb7b36a3/toolkit/components/extensions/schemas/permissions.json https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/permissions#Browser_compatibility
2018-06-05 14:43:03 +00:00
"permissions": {
"contains": {
"minArgs": 1,
"maxArgs": 1
},
"getAll": {
"minArgs": 0,
"maxArgs": 0
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"request": {
"minArgs": 1,
"maxArgs": 1
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"runtime": {
"getBackgroundPage": {
"minArgs": 0,
"maxArgs": 0
},
"getBrowserInfo": {
"minArgs": 0,
"maxArgs": 0
},
"getPlatformInfo": {
"minArgs": 0,
"maxArgs": 0
},
"openOptionsPage": {
"minArgs": 0,
"maxArgs": 0
},
"requestUpdateCheck": {
"minArgs": 0,
"maxArgs": 0
},
"sendMessage": {
"minArgs": 1,
"maxArgs": 3
},
"sendNativeMessage": {
"minArgs": 2,
"maxArgs": 2
},
"setUninstallURL": {
"minArgs": 1,
"maxArgs": 1
}
},
feat: Add sessions namespace to metadata https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/sessions#Browser_compatibility Only `sessions.getRecentlyClosed` and `sessions.restore` are currently supported by Firefox. `sessions.getDevices` is included anyway since this method may be added to Firefox in the future: https://bugzil.la/1308059
2018-06-05 14:46:40 +00:00
"sessions": {
"getDevices": {
"minArgs": 0,
"maxArgs": 1
},
"getRecentlyClosed": {
"minArgs": 0,
"maxArgs": 1
},
"restore": {
"minArgs": 0,
"maxArgs": 1
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"storage": {
"local": {
"clear": {
"minArgs": 0,
"maxArgs": 0
},
"get": {
"minArgs": 0,
"maxArgs": 1
},
"getBytesInUse": {
"minArgs": 0,
"maxArgs": 1
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"set": {
"minArgs": 1,
"maxArgs": 1
}
},
"managed": {
"get": {
"minArgs": 0,
"maxArgs": 1
},
"getBytesInUse": {
"minArgs": 0,
"maxArgs": 1
}
},
"sync": {
"clear": {
"minArgs": 0,
"maxArgs": 0
},
"get": {
"minArgs": 0,
"maxArgs": 1
},
"getBytesInUse": {
"minArgs": 0,
"maxArgs": 1
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"set": {
"minArgs": 1,
"maxArgs": 1
}
}
},
"tabs": {
"create": {
"minArgs": 1,
"maxArgs": 1
},
"captureVisibleTab": {
"minArgs": 0,
"maxArgs": 2
},
"detectLanguage": {
"minArgs": 0,
"maxArgs": 1
},
"duplicate": {
"minArgs": 1,
"maxArgs": 1
},
"executeScript": {
"minArgs": 1,
"maxArgs": 2
},
"get": {
"minArgs": 1,
"maxArgs": 1
},
"getCurrent": {
"minArgs": 0,
"maxArgs": 0
},
"getZoom": {
"minArgs": 0,
"maxArgs": 1
},
"getZoomSettings": {
"minArgs": 0,
"maxArgs": 1
},
"highlight": {
"minArgs": 1,
"maxArgs": 1
},
"insertCSS": {
"minArgs": 1,
"maxArgs": 2
},
"move": {
"minArgs": 2,
"maxArgs": 2
},
"reload": {
"minArgs": 0,
"maxArgs": 2
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"query": {
"minArgs": 1,
"maxArgs": 1
},
"removeCSS": {
"minArgs": 1,
"maxArgs": 2
},
"sendMessage": {
"minArgs": 2,
"maxArgs": 3
},
"setZoom": {
"minArgs": 1,
"maxArgs": 2
},
"setZoomSettings": {
"minArgs": 1,
"maxArgs": 2
},
"update": {
"minArgs": 1,
"maxArgs": 2
}
},
feat: Add topSites namespace to metadata https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/topSites#Browser_compatibility
2018-06-05 14:49:43 +00:00
"topSites": {
"get": {
"minArgs": 0,
"maxArgs": 0
}
},
Initial checkin.
2016-10-07 01:20:37 +00:00
"webNavigation": {
"getAllFrames": {
"minArgs": 1,
"maxArgs": 1
},
"getFrame": {
"minArgs": 1,
"maxArgs": 1
}
},
"webRequest": {
"handlerBehaviorChanged": {
"minArgs": 0,
"maxArgs": 0
}
},
"windows": {
"create": {
"minArgs": 0,
"maxArgs": 1
},
"get": {
"minArgs": 1,
"maxArgs": 2
},
"getAll": {
"minArgs": 0,
"maxArgs": 1
},
"getCurrent": {
"minArgs": 0,
"maxArgs": 1
},
"getLastFocused": {
"minArgs": 0,
"maxArgs": 1
},
"remove": {
"minArgs": 1,
"maxArgs": 1
},
"update": {
"minArgs": 2,
"maxArgs": 2
}
}
}