webext-schema 5.6.1 → 7.0.0

package/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: ['https://paypal.me/asamuzakjp'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: build
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        node-version: [ 20.x, lts/*, latest ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          check-latest: true
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run testall

package/eslint.config.mjs

@@ -0,0 +1,52 @@
+import jsdoc from 'eslint-plugin-jsdoc';
+import regexp from 'eslint-plugin-regexp';
+import unicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
+import neostandard, { plugins as neostdplugins } from 'neostandard';
+
+export default [
+  ...neostandard({
+    semi: true
+  }),
+  jsdoc.configs['flat/recommended'],
+  regexp.configs['flat/recommended'],
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.webextensions
+      }
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: true
+    },
+    plugins: {
+      '@stylistic': neostdplugins['@stylistic'],
+      regexp,
+      unicorn
+    },
+    rules: {
+      '@stylistic/space-before-function-paren': ['error', {
+        anonymous: 'always',
+        asyncArrow: 'always',
+        named: 'never'
+      }],
+      'import-x/order': ['error', {
+        alphabetize: {
+          order: 'ignore',
+          caseInsensitive: false
+        }
+      }],
+      'no-await-in-loop': 'error',
+      'no-use-before-define': ['error', {
+        allowNamedExports: false,
+        classes: true,
+        functions: true,
+        variables: true
+      }],
+      'prefer-object-has-own': 'error',
+      'unicorn/prefer-node-protocol': 'error'
+    }
+  }
+];

package/modules/browser.js

@@ -428,7 +428,7 @@ export const makeConnection = async (id, info) => {
 /**
  * send message
  * @param {number|string} id - tab ID / extension ID
- * @param {*} msg - message
+ * @param {string|Array|object} msg - message
  * @param {object} opt - options
  * @returns {Promise.<object>} - tabs.sendMessage() | runtime.sendMessage()
  */
@@ -679,7 +679,7 @@ export const getAllStorage = async (area = 'local') => {
 
 /**
  * get storage
- * @param {*} key - key
+ * @param {string|Array|object} key - key
  * @param {string} area - storage area
  * @returns {Promise.<object>} - stored data
  */
@@ -698,7 +698,7 @@ export const getStorage = async (key, area = 'local') => {
 
 /**
  * remove storage
- * @param {*} key - key
+ * @param {string|Array|object} key - key
  * @param {string} area - storage area
  * @returns {Promise.<void>} - void
  */
@@ -814,7 +814,7 @@ export const execScriptToTabs = async (opt = {}) => {
  * execute scripts to tab in order
  * @param {number|Array} tabId - tabId or array of options
  * @param {Array} opts - array of options
- * @returns {Promise.<*>} - result of the last executed script
+ * @returns {Promise.<?Array|boolean>} - result of the last executed script
  */
 export const execScriptsToTabInOrder = async (tabId, opts = []) => {
   const func = [];
@@ -1058,7 +1058,7 @@ export const captureVisibleTab = async (windowId, opt) => {
 
 /**
  * is tab
- * @param {*} tabId - tab ID
+ * @param {number} tabId - tab ID
  * @returns {Promise.<boolean>} - result
  */
 export const isTab = async tabId => {

package/modules/common.js

@@ -9,7 +9,7 @@ const TYPE_TO = -1;
 /**
  * throw error
  * @param {!object} e - Error
- * @throws - Error
+ * @throws {Error} - Error
  */
 export const throwErr = e => {
   throw e;
@@ -27,7 +27,7 @@ export const logErr = e => {
 
 /**
  * log warn
- * @param {*} msg - message
+ * @param {string|object} msg - message
  * @returns {boolean} - false
  */
 export const logWarn = msg => {
@@ -37,8 +37,8 @@ export const logWarn = msg => {
 
 /**
  * log message
- * @param {*} msg - message
- * @returns {*} - message
+ * @param {string|object} msg - message
+ * @returns {string|object} - message
  */
 export const logMsg = msg => {
   msg && console.log(msg);
@@ -47,7 +47,7 @@ export const logMsg = msg => {
 
 /**
  * get type
- * @param {*} o - object to check
+ * @param {object} o - object to check
  * @returns {string} - type of object
  */
 export const getType = o =>
@@ -55,7 +55,7 @@ export const getType = o =>
 
 /**
  * is object, and not an empty object
- * @param {*} o - object to check;
+ * @param {object} o - object to check;
  * @returns {boolean} - result
  */
 export const isObjectNotEmpty = o => {
@@ -65,7 +65,7 @@ export const isObjectNotEmpty = o => {
 
 /**
  * is string
- * @param {*} o - object to check
+ * @param {object} o - object to check
  * @returns {boolean} - result
  */
 export const isString = o => typeof o === 'string' || o instanceof String;

package/modules/schema.js

@@ -22,14 +22,13 @@ export class Schema {
    * construct
    * @param {...(string|object)} [args] - optional arguments
    *                                      {string} - release channel.
-   *                                                 one of "beta", "central",
-   *                                                 "release", "esr", "mail".
+   *                                                 "beta", "central", "mail".
    *                                      {object} - sinon config
    */
   constructor(...args) {
     const [arg1, arg2] = args;
     this.#channel =
-      isString(arg1) && /(?:centra|mai)l|beta|esr|release/.test(arg1)
+      isString(arg1) && /^(?:central|mail)$/.test(arg1)
         ? arg1
         : 'beta';
     this._sandbox =
@@ -48,7 +47,7 @@ export class Schema {
   }
 
   set channel(ch) {
-    if (isString(ch) && /(?:centra|mai)l|beta|esr|release/.test(ch)) {
+    if (isString(ch) && /^(?:central|mail|beta)$/.test(ch)) {
       this.#channel = ch;
     }
   }

package/modules/update.js

@@ -14,7 +14,6 @@ import { createFile } from './file-util.js';
 import { CHAR, INDENT } from './constant.js';
 const DIR_CWD = process.cwd();
 const PERM_FILE = 0o644;
-export const ESR_VER = 115;
 
 /**
  * fetch text
@@ -45,15 +44,9 @@ export const getChannelUrl = channel => {
     case 'central':
       dir = 'mozilla-central/';
       break;
-    case 'esr':
-      dir = `releases/mozilla-esr${ESR_VER}/`;
-      break;
     case 'mail':
       dir = 'comm-central/';
       break;
-    case 'release':
-      dir = 'releases/mozilla-release/';
-      break;
     default:
       dir = 'releases/mozilla-beta/';
   }
@@ -277,8 +270,6 @@ export const updateSchemas = async (cmdOpts = {}) => {
     func.push(
       saveSchemaFile('beta', info),
       saveSchemaFile('central', info),
-      saveSchemaFile('esr', info),
-      saveSchemaFile('release', info),
       saveSchemaFile('mail', info)
     );
   }

package/package.json

@@ -19,26 +19,26 @@
   "types": "types/index.d.ts",
   "dependencies": {
     "camelize": "^1.0.1",
-    "commander": "^14.0.0",
-    "decamelize": "^6.0.0",
+    "commander": "^14.0.2",
+    "decamelize": "^6.0.1",
     "json5": "^2.2.3",
-    "sinon": "^21.0.0"
+    "sinon": "^21.0.1"
   },
   "devDependencies": {
-    "@types/firefox-webext-browser": "^120.0.4",
-    "@types/node": "^24.1.0",
-    "@types/sinon": "^17.0.4",
+    "@types/firefox-webext-browser": "^143.0.0",
+    "@types/node": "^25.0.9",
+    "@types/sinon": "^21.0.0",
     "c8": "^10.1.3",
-    "eslint": "^9.32.0",
-    "eslint-plugin-jsdoc": "^52.0.2",
-    "eslint-plugin-regexp": "^2.9.1",
-    "eslint-plugin-unicorn": "^60.0.0",
-    "globals": "^16.3.0",
-    "mocha": "^11.7.1",
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^62.1.0",
+    "eslint-plugin-regexp": "^2.10.0",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "globals": "^17.0.0",
+    "mocha": "^11.7.5",
     "neostandard": "^0.12.2",
     "npm-run-all2": "^8.0.4",
-    "typescript": "^5.9.2",
-    "undici": "^7.13.0"
+    "typescript": "^5.9.3",
+    "undici": "^7.18.2"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -51,12 +51,10 @@
     "test:release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
     "testall": "npm-run-all -s test:*",
     "tsc": "node index clean --dir=types -i && npx tsc",
-    "update": "node index update -i",
+    "update": "npm-run-all -s update:*",
     "update:beta": "node index update --channel=beta -i",
     "update:central": "node index update --channel=central -i",
-    "update:esr": "node index update --channel=esr -i",
-    "update:mail": "node index update --channel=mail -i",
-    "update:release": "node index update --channel=release -i"
+    "update:mail": "node index update --channel=mail -i"
   },
-  "version": "5.6.1"
+  "version": "7.0.0"
 }

package/schemas/beta/webext.json

@@ -6447,6 +6447,12 @@
                   ],
                   "description": "The tab's new favicon URL. This property is only present if the extension's manifest includes the <code>\"tabs\"</code> permission."
                 },
+                "groupId": {
+                  "type": "integer",
+                  "optional": true,
+                  "minimum": -1,
+                  "description": "The tab's new group ID. $(ref:tabGroups.TAB_GROUP_ID_NONE) (-1) if the tab no longer belongs to a tab group."
+                },
                 "hidden": {
                   "type": "boolean",
                   "optional": true,
@@ -9116,6 +9122,11 @@
               "optional": true,
               "description": "The JavaScript world for a script to execute within. Defaults to \"ISOLATED\"."
             },
+            "cssOrigin": {
+              "$ref": "extensionTypes.CSSOrigin",
+              "optional": true,
+              "description": "The css origin of the stylesheet to inject. Defaults to \"author\"."
+            },
             "cookieStoreId": {
               "choices": [
                 {
@@ -12564,7 +12575,8 @@
             "user",
             "author"
           ],
-          "description": "The origin of the CSS to inject, this affects the cascading order (priority) of the stylesheet."
+          "description": "The origin of the CSS to inject, this affects the cascading order (priority) of the stylesheet.",
+          "preprocess": "stringToLowerCase"
         },
         {
           "id": "InjectDetails",
@@ -12606,6 +12618,7 @@
             "cssOrigin": {
               "$ref": "CSSOrigin",
               "optional": true,
+              "default": "author",
               "description": "The css origin of the stylesheet to inject. Defaults to \"author\"."
             }
           }
@@ -12824,7 +12837,8 @@
             "memory",
             "tracing",
             "sandbox",
-            "flows"
+            "flows",
+            "jssources"
           ]
         },
         {
@@ -13503,7 +13517,7 @@
         },
         {
           "id": "ExtensionInstallType",
-          "description": "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>admin</var>: The extension was installed by policy,<br><var>other</var>: The extension was installed by other means.",
+          "description": "How the extension was installed.<dl><dt>development</dt><dd>The extension was loaded unpacked in developer mode,</dd><dt>normal</dt><dd>The extension was installed normally via an .xpi file</dd><dt>sideload</dt><dd>The extension was installed by other software on the machine</dd><dt>admin</dt><dd>The extension was installed by policy</dd><dt>other</dt><dd>The extension was installed by other means.</dd></dl>",
           "type": "string",
           "enum": [
             "development",
@@ -13854,8 +13868,7 @@
             "manifest_version": {
               "type": "integer",
               "minimum": 2,
-              "maximum": 3,
-              "postprocess": "manifestVersionCheck"
+              "maximum": 3
             },
             "applications": {
               "$ref": "DeprecatedApplications",
@@ -14552,6 +14565,9 @@
                   "optional": true,
                   "default": false
                 }
+              },
+              "additionalProperties": {
+                "$ref": "UnrecognizedProperty"
               }
             }
           },
@@ -14698,6 +14714,11 @@
                 "$ref": "ExtensionURL"
               }
             },
+            "css_origin": {
+              "$ref": "extensionTypes.CSSOrigin",
+              "default": "author",
+              "optional": true
+            },
             "js": {
               "type": "array",
               "optional": true,
@@ -16600,6 +16621,7 @@
             "aarch64",
             "arm",
             "ppc64",
+            "riscv64",
             "s390x",
             "sparc64",
             "x86-32",
@@ -16976,7 +16998,7 @@
           ],
           "returns": {
             "$ref": "Port",
-            "description": "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. "
+            "description": "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. "
           }
         },
         {
@@ -17632,6 +17654,10 @@
               "items": {
                 "$ref": "manifest.ExtensionURL"
               }
+            },
+            "cssOrigin": {
+              "$ref": "extensionTypes.CSSOrigin",
+              "optional": true
             }
           }
         }
@@ -17889,7 +17915,6 @@
             },
             {
               "name": "getBytesInUse",
-              "unsupported": true,
               "type": "function",
               "description": "Gets the amount of space (in bytes) being used by one or more items.",
               "async": "callback",
@@ -17925,173 +17950,23 @@
               ]
             },
             {
-              "name": "set",
-              "type": "function",
-              "description": "Sets multiple items.",
-              "async": "callback",
-              "parameters": [
-                {
-                  "name": "items",
-                  "type": "object",
-                  "additionalProperties": {
-                    "type": "any"
-                  },
-                  "description": "<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>"
-                },
-                {
-                  "name": "callback",
-                  "type": "function",
-                  "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).",
-                  "parameters": [],
-                  "optional": true
-                }
-              ]
-            },
-            {
-              "name": "remove",
-              "type": "function",
-              "description": "Removes one or more items from storage.",
-              "async": "callback",
-              "parameters": [
-                {
-                  "name": "keys",
-                  "choices": [
-                    {
-                      "type": "string"
-                    },
-                    {
-                      "type": "array",
-                      "items": {
-                        "type": "string"
-                      }
-                    }
-                  ],
-                  "description": "A single key or a list of keys for items to remove."
-                },
-                {
-                  "name": "callback",
-                  "type": "function",
-                  "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).",
-                  "parameters": [],
-                  "optional": true
-                }
-              ]
-            },
-            {
-              "name": "clear",
-              "type": "function",
-              "description": "Removes all items from storage.",
-              "async": "callback",
-              "parameters": [
-                {
-                  "name": "callback",
-                  "type": "function",
-                  "description": "Callback on success, or on failure (in which case $(ref:runtime.lastError) will be set).",
-                  "parameters": [],
-                  "optional": true
-                }
-              ]
-            }
-          ],
-          "events": [
-            {
-              "name": "onChanged",
-              "type": "function",
-              "description": "Fired when one or more items change.",
-              "parameters": [
-                {
-                  "name": "changes",
-                  "type": "object",
-                  "additionalProperties": {
-                    "$ref": "StorageChange"
-                  },
-                  "description": "Object mapping each key that changed to its corresponding $(ref:storage.StorageChange) for that item."
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "id": "StorageAreaWithUsage",
-          "type": "object",
-          "functions": [
-            {
-              "name": "get",
+              "name": "getKeys",
               "type": "function",
-              "description": "Gets one or more items from storage.",
+              "description": "Gets the keys of all items in storage.",
               "async": "callback",
               "parameters": [
-                {
-                  "name": "keys",
-                  "choices": [
-                    {
-                      "type": "string"
-                    },
-                    {
-                      "type": "array",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    {
-                      "type": "object",
-                      "description": "Storage items to return in the callback, where the values are replaced with those from storage if they exist.",
-                      "additionalProperties": {
-                        "type": "any"
-                      }
-                    }
-                  ],
-                  "description": "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.",
-                  "optional": true
-                },
                 {
                   "name": "callback",
                   "type": "function",
-                  "description": "Callback with storage items, or on failure (in which case $(ref:runtime.lastError) will be set).",
+                  "description": "Callback with the keys of all items in storage, or on failure (in which case $(ref:runtime.lastError) will be set).",
                   "parameters": [
                     {
-                      "name": "items",
-                      "type": "object",
-                      "additionalProperties": {
-                        "type": "any"
-                      },
-                      "description": "Object with items in their key-value mappings."
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              "name": "getBytesInUse",
-              "type": "function",
-              "description": "Gets the amount of space (in bytes) being used by one or more items.",
-              "async": "callback",
-              "parameters": [
-                {
-                  "name": "keys",
-                  "choices": [
-                    {
-                      "type": "string"
-                    },
-                    {
+                      "name": "keys",
                       "type": "array",
                       "items": {
                         "type": "string"
-                      }
-                    }
-                  ],
-                  "description": "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.",
-                  "optional": true
-                },
-                {
-                  "name": "callback",
-                  "type": "function",
-                  "description": "Callback with the amount of space being used by storage, or on failure (in which case $(ref:runtime.lastError) will be set).",
-                  "parameters": [
-                    {
-                      "name": "bytesInUse",
-                      "type": "integer",
-                      "description": "Amount of space being used in storage, in bytes."
+                      },
+                      "description": "The keys of all items in storage."
                     }
                   ]
                 }
@@ -18202,14 +18077,14 @@
             {
               "name": "areaName",
               "type": "string",
-              "description": "The name of the storage area (<code>\"sync\"</code>, <code>\"local\"</code> or <code>\"managed\"</code>) the changes are for."
+              "description": "The name of the storage area (<code>\"session\"</code>, <code>\"sync\"</code>, <code>\"local\"</code> or <code>\"managed\"</code>) the changes are for."
             }
           ]
         }
       ],
       "properties": {
         "sync": {
-          "$ref": "StorageAreaWithUsage",
+          "$ref": "StorageArea",
           "description": "Items in the <code>sync</code> storage area are synced by the browser.",
           "properties": {
             "QUOTA_BYTES": {
@@ -18263,7 +18138,7 @@
           "allowedContexts": [
             "devtools"
           ],
-          "$ref": "StorageAreaWithUsage",
+          "$ref": "StorageArea",
           "description": "Items in the <code>session</code> storage area are kept in memory, and only until the either browser or extension is closed or reloaded.",
           "properties": {
             "QUOTA_BYTES": {