WebExtensions module: Get any optional permissions that users have granted you + other utilities.
npm install webext-permissions> WebExtensions module: Get any optional permissions that users have granted you + other utilities
- Browsers: Chrome, Firefox, and Safari
- Manifest: v2 and v3
- Context: Any context that has access to the chrome.permissions API
_This package was recently renamed from webext-additional-permissions to webext-permissions_
You can download the standalone bundle and include it in your manifest.json._
Or use npm:
``sh`
npm install webext-permissionsIf you're using TypeScript, also run
npm install -D @types/chrome
`js`
// This module is only offered as a ES Module
import {
queryAdditionalPermissions,
normalizeManifestPermissions,
} from 'webext-permissions';
chrome.permissions.getAll() will report all permissions, whether they're part of the manifest’s permissions field or if they've been granted later via chrome.permissions.request.
webext-permissions will return the same Permissions object but it will only include any permissions that the user might have granted to the extension.
`json`
// example manifest.json
{
"permissions": [
"https://google.com/*",
"storage"
],
"optional_permissions": [
"https:///"
]
}
Simple example with the above manifest:
`js
(async () => {
const newPermissions = await queryAdditionalPermissions();
// => {origins: [], permissions: []}
const manifestPermissions = normalizeManifestPermissions();
// => {origins: ['https://google.com/*'], permissions: ['storage']}
})();
`
Example showing how the result changes when you add further permissions (for example via webext-permission-toggle)
`js
async function onGrantPermissionButtonClick() {
await browser.permissions.request({origins: ['https://facebook.com/*']});
// Regular browser API: returns manifest permissions and new permissions
const allPermissions = await browser.permissions.getAll();
// => {origins: ['https://google.com/', 'https://facebook.com/'], permissions: ['storage']}
// This module: only the new permission is returned
const newPermissions = await queryAdditionalPermissions();
// => {origins: ['https://facebook.com/*'], permissions: []}
// This module: the manifest permissions are unchanged
const manifestPermissions = normalizeManifestPermissions();
// => {origins: ['https://google.com/*'], permissions: ['storage']}
}
`
Returns a promise that resolves with a Permissions object like chrome.permissions.getAll and browser.permissions.getAll, but only includes the optional permissions that the user granted you.
#### options
Type: object
##### strictOrigins
Type: boolean\true
Default:
If the manifest contains the permission https://github.com/ and then you request ://.github.com/ (like Safari does), the latter will be considered an _additional permission_ because technically it's broader.
If this distinction doesn't matter for you (for example if the protocol is always https and there are no subdomains), you can use strictOrigins: false, so that the requested permission will not be reported as _additional_.
Like queryAdditionalPermissions, but instead of querying the current permissions, you can pass a Permissions object.
This function returns synchronously.
#### permissions
Type: Permissions object.
#### options
Type: object
##### strictOrigins
Type: boolean\true
Default:
See strictOrigins above
##### manifest
Type: object
Default:
The whole manifest.json object to be parsed. By default it asks the browser to provide it.
Returns a Permissions object listing the permissions inferred from the manifest file.
Differences from chrome.runtime.getManifest().permissions:
- this function always returns a {origin, permissions} object rather than a flat permissions array, even in MV3devtools
- this function also includes host permissions inferred from all the content scripts
- this function also includes the permission inferred from the devtools_page, if present
Difference from chrome.permissions.getAll:
- this function only includes the permissions you declared in manifest.json.
#### manifest
Type: object
Default:
The whole manifest.json object to be parsed. By default it asks the browser to provide it.
:/// includes every URL also matched by https://fregante.com/, so the latter is overlapping.
This function accepts a Permissions object and it drops any permissions that are overlapping. Currently this only applies to origin permissions.
You can alternatively use the underlying excludeDuplicatePatterns in webext-patterns if you want to use raw arrays of origins.
Check whether a specific URL is statically permitted by the manifest, whether in the permissions array or in a content script. Like chrome.permissions.contains except:
- it's synchronous
- it's only true if the URL is in the manifest (additional permissions are not taken into consideration)
#### manifest
Type: object
Default:
The whole manifest.json` object to be parsed. By default it asks the browser to provide it.
- webext-patterns - Convert the patterns of your WebExtension manifest to regex
- webext-permission-toggle - Browser-action context menu to request permission for the current tab.
- webext-detect - Detects where the current browser extension code is being run. Chrome and Firefox.
- Awesome-WebExtensions - A curated list of awesome resources for WebExtensions development.
- More…
MIT © Federico Brigante