-
-
Notifications
You must be signed in to change notification settings - Fork 463
feat: add support for Firefox data collection permissions #1976
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
suveshmoza
wants to merge
2
commits into
wxt-dev:main
Choose a base branch
from
suveshmoza:feat/firefox-data-collection-permissions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+77
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -131,6 +131,22 @@ export interface InlineConfig { | |||||||||||
| * object or promise. | ||||||||||||
| */ | ||||||||||||
| manifest?: UserManifest | Promise<UserManifest> | UserManifestFn; | ||||||||||||
| /** | ||||||||||||
| * Suppress specific warnings during the build process. | ||||||||||||
| * | ||||||||||||
| * @example | ||||||||||||
| * ```ts | ||||||||||||
| * export default defineConfig({ | ||||||||||||
| * suppressWarnings: { | ||||||||||||
| * firefoxDataCollection: true, | ||||||||||||
| * }, | ||||||||||||
| * }) | ||||||||||||
| * ``` | ||||||||||||
| */ | ||||||||||||
| suppressWarnings?: { firefoxDataCollection?: boolean } & Record< | ||||||||||||
| string, | ||||||||||||
| boolean | ||||||||||||
| >; | ||||||||||||
|
Comment on lines
+146
to
+149
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why make this a union with a record? We should show a type error if there's a typo, right?
Suggested change
|
||||||||||||
| /** | ||||||||||||
| * Configure browser startup. Options set here can be overridden in a `web-ext.config.ts` file. | ||||||||||||
| */ | ||||||||||||
|
|
@@ -838,6 +854,39 @@ export type ResolvedPerBrowserOptions<T, TOmitted extends keyof T = never> = { | |||||||||||
| : T[key]; | ||||||||||||
| } & { [key in TOmitted]: T[key] }; | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * Firefox data collection permission types for personal data. | ||||||||||||
| * See: https://extensionworkshop.com/documentation/develop/firefox-builtin-data-consent/#specifying-data-types | ||||||||||||
| */ | ||||||||||||
| export type FirefoxDataCollectionType = | ||||||||||||
| | 'locationInfo' | ||||||||||||
| | 'browsingActivity' | ||||||||||||
| | 'websiteContent' | ||||||||||||
| | 'websiteActivity' | ||||||||||||
| | 'searchTerms' | ||||||||||||
| | 'bookmarksInfo' | ||||||||||||
| | 'healthInfo' | ||||||||||||
| | 'contactInfo' | ||||||||||||
| | 'socialInfo' | ||||||||||||
| | (string & {}); | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * Firefox data collection permissions configuration. | ||||||||||||
| * See: https://extensionworkshop.com/documentation/develop/firefox-builtin-data-consent/#specifying-data-types | ||||||||||||
| */ | ||||||||||||
| export interface FirefoxDataCollectionPermissions { | ||||||||||||
| /** | ||||||||||||
| * Required data collection permissions. Users must opt in to use the extension. | ||||||||||||
| * Can include personal data types or "none" to explicitly indicate no data collection. | ||||||||||||
| */ | ||||||||||||
| required?: Array<FirefoxDataCollectionType | 'none'>; | ||||||||||||
| /** | ||||||||||||
| * Optional data collection permissions. Users can opt in after installation. | ||||||||||||
| * Can include personal data types or "technicalAndInteraction" (which can only be optional). | ||||||||||||
| */ | ||||||||||||
| optional?: Array<FirefoxDataCollectionType | 'technicalAndInteraction'>; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * Manifest customization available in the `wxt.config.ts` file. You cannot configure entrypoints | ||||||||||||
| * here, they are configured inline. | ||||||||||||
|
|
@@ -873,6 +922,11 @@ export type UserManifest = { | |||||||||||
| strict_min_version?: string; | ||||||||||||
| strict_max_version?: string; | ||||||||||||
| update_url?: string; | ||||||||||||
| /** | ||||||||||||
| * Firefox data collection permissions configuration. | ||||||||||||
| * See: https://extensionworkshop.com/documentation/develop/firefox-builtin-data-consent/#specifying-data-types | ||||||||||||
| */ | ||||||||||||
| data_collection_permissions?: FirefoxDataCollectionPermissions; | ||||||||||||
| }; | ||||||||||||
| gecko_android?: { | ||||||||||||
| strict_min_version?: string; | ||||||||||||
|
|
@@ -1355,6 +1409,13 @@ export interface ResolvedConfig { | |||||||||||
| */ | ||||||||||||
| alias: Record<string, string>; | ||||||||||||
| experimental: {}; | ||||||||||||
| /** | ||||||||||||
| * List of warning identifiers to suppress during the build process. | ||||||||||||
| */ | ||||||||||||
| suppressWarnings: { firefoxDataCollection?: boolean } & Record< | ||||||||||||
| string, | ||||||||||||
| boolean | ||||||||||||
| >; | ||||||||||||
|
Comment on lines
+1415
to
+1418
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If we don't need the record, it can be removed here as well.
Suggested change
|
||||||||||||
| dev: { | ||||||||||||
| /** Only defined during dev command */ | ||||||||||||
| server?: { | ||||||||||||
|
|
||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.