Gathering detailed insights and metrics for webext-options-sync-per-domain
Gathering detailed insights and metrics for webext-options-sync-per-domain
Helps you manage and autosave your extension's options, separately for each additional permission
Installations
npm install webext-options-sync-per-domainDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=18
Node Version
23.1.0
NPM Version
10.9.0
Releases
11
Languages
1
TypeScript
TypeScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
17 Stars
35 Commits
1 Forks
2 Watchers
1 Branches
1 Contributors
Updated on Jan 08, 2025
Sponsor this package
Maintainers
1
Package Meta Information
Latest Version
4.3.1
Package Id
webext-options-sync-per-domain@4.3.1
Unpacked Size
16.01 kB
Size
5.52 kB
File Count
5
NPM Version
10.9.0
Node Version
23.1.0
Published on
Jan 08, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
webext-options-sync-per-domain 
Helps you manage and autosave your extension's options, separately for each additional permission.
Prerequisites
- Your WebExtension’s options are managed by webext-options-sync
- Your WebExtension can be enabled on multiple optional domains, maybe via webext-dynamic-content-scripts
- Your users want to customize your extension’s options for each domain, independently.
In that case, webext-options-sync-per-domain extends webext-options-sync with these feature:
- Automatically detects new
originpermissions - Prepares a fresh set of options for each new origin
- Transparently serves the right set of options based on the current domain
- Adds a domain switcher on the options page — only if the user adds multiple origins
Install
You can download the standalone bundle and include it in your manifest.json.
Or use npm:
1npm install webext-options-sync-per-domain 2npm remove webext-options-sync # This is now included
Usage
If you're following the suggested setup for webext-options-sync, here are the changes you should make:
| Before | After |
|---|---|
|
|
Now options-storage.js will export the same old OptionsSync instance, but it will very depending on the current domain.
You'll also need to change 2 lines on the options page:
| Before | After |
|---|---|
|
|
That's all! A domain switcher will only appear if the user adds new additional domains via chrome.permissions.request() or webext-permission-toggle.
Concepts
Origins
Origins are what the browser calls each "website" permission; they look like https://example.com or https://*.example.com/*
Domains
Domains are the same as origins, except it's a less ambiguous word and it's generally shown protocol-less: example.com or *.example.com
Default
webext-options-sync-per-domain differentiates between origins that are part of manifest.json and origins added later via chrome.permission.request(). All manifest.json origins share the same options and these are considered the "default".
API
const perDomainOptions = new OptionsSyncPerDomain(setup?)
setup
This is identical to the setup in webext-options-sync
perDomainOptions.syncForm(form)
This is identical to syncForm() in webext-options-sync, but it will also:
- add a domain selector dropdown if the user enabled the extension on more origins
- switch the data of the form depending on the selected domain
If you want to customize the switcher or listen to its change, await this call and perform the changes after it runs. Example:
1// options.js 2import {perDomainOptions} from './options-storage'; 3 4async initOptions() { 5 await perDomainOptions.syncForm('form'); 6 7 // Update domain-dependent page content when the domain is changed 8 const dropdown = document.querySelector('.OptionsSyncPerDomain-picker select'); 9 if (dropdown) { 10 dropdown.addEventListener('change', () => { 11 select('#personal-token-link')!.host = dropdown.value === 'default' ? 'github.com' : dropdown.value; 12 }); 13 } 14} 15 16initOptions();
perDomainOptions.getOptionsForOrigin(origin?)
Returns an origin-specific instance of OptionsSync. If called from an extension page (background.js, options.html, etc) and without the parameter, it will use the default origin.
origin
Type: string
Default: location.origin
Example: http://example.com
perDomainOptions.getAdditionalOrigins()
Returns a list of all the origins that have been added via chrome.permissions.request(). This is useful if you want to display a list of domains that the user can choose from. This method does not include the default origins.
1const origins = await perDomainOptions.getAdditionalOrigins(); 2 3console.log('The user enabled the extension on:', ...origins);
perDomainOptions.getAllOrigins()
Returns a Map of the OptionsSync instances, one for each origin. The default origins are on the key default and the other ones are on keys that look like domain.ext
1const instances = perDomainOptions.getAllOrigins(); 2 3// Print the options of these 2 instances 4console.log(await instances.get('default').getAll()); 5console.log(await instances.get('example.com').getAll());
Related
- webext-options-sync - Helps you manage and autosave your extension's options. Chrome and Firefox.
- webext-storage-cache - Map-like promised cache storage with expiration.
- webext-dynamic-content-scripts - Automatically registers your content_scripts on domains added via permission.request.
- Awesome-WebExtensions - A curated list of awesome resources for WebExtensions development.
- More…
License
MIT © Federico Brigante
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/esm-lint.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/fregante/webext-options-sync-per-domain/esm-lint.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:13
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:20
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:41
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:50
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:62
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:73
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:81
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:97
- Warn: npmCommand not pinned by hash: .github/workflows/esm-lint.yml:23
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 9 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/esm-lint.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 10 are checked with a SAST tool
Score
3.4
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More