webext-schema 5.1.15 → 5.2.0

package/modules/update.js

@@ -13,7 +13,7 @@ import { CHAR, INDENT } from './constant.js';
 /* constants */
 const DIR_CWD = process.cwd();
 const PERM_FILE = 0o644;
-export const ESR_VER = 102;
+export const ESR_VER = 115;
 
 /**
  * fetch text

package/package.json

@@ -13,30 +13,33 @@
   "main": "index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@types/firefox-webext-browser": "^111.0.1",
-    "@types/node": "^20.1.1",
-    "@types/sinon": "^10.0.14",
     "camelize": "^1.0.1",
-    "commander": "^10.0.1",
+    "commander": "^11.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.3",
-    "sinon": "^15.0.4"
+    "sinon": "^15.2.0"
   },
   "devDependencies": {
-    "c8": "^7.13.0",
+    "@types/firefox-webext-browser": "^111.0.1",
+    "@types/node": "^20.3.3",
+    "@types/sinon": "^10.0.15",
+    "c8": "^8.0.0",
     "chai": "^4.3.7",
-    "eslint": "^8.40.0",
-    "eslint-config-standard": "^17.0.0",
+    "eslint": "^8.44.0",
+    "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^44.0.2",
+    "eslint-plugin-jsdoc": "^46.4.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-regexp": "^1.15.0",
     "eslint-plugin-unicorn": "^47.0.0",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.0.4",
-    "undici": "^5.22.0"
+    "typescript": "^5.1.6",
+    "undici": "^5.22.1"
+  },
+  "overrides": {
+    "semver": "^7.5.2"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -56,5 +59,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.1.15"
+  "version": "5.2.0"
 }

package/schemas/beta/webext.json

@@ -916,6 +916,31 @@
               "type": "string"
             }
           ]
+        },
+        {
+          "name": "onChanged",
+          "description": "Fired when a registered command's shortcut is changed.",
+          "type": "function",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "changeInfo",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The name of the shortcut."
+                },
+                "newShortcut": {
+                  "type": "string",
+                  "description": "The new shortcut active for this command, or blank if not active."
+                },
+                "oldShortcut": {
+                  "type": "string",
+                  "description": "The old shortcut which is no longer active for this command, or blank if the shortcut was previously inactive."
+                }
+              }
+            }
+          ]
         }
       ],
       "functions": [
@@ -4438,6 +4463,11 @@
               "optional": true,
               "description": "Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing."
             },
+            "autoDiscardable": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+            },
             "mutedInfo": {
               "$ref": "MutedInfo",
               "optional": true,
@@ -4739,6 +4769,7 @@
           "enum": [
             "attention",
             "audible",
+            "autoDiscardable",
             "discarded",
             "favIconUrl",
             "hidden",
@@ -5070,6 +5101,11 @@
                   "optional": true,
                   "description": "Whether the tabs are audible."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "muted": {
                   "type": "boolean",
                   "optional": true,
@@ -5287,6 +5323,11 @@
                   "optional": true,
                   "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update))."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "highlighted": {
                   "type": "boolean",
                   "optional": true,
@@ -6033,6 +6074,11 @@
                   "optional": true,
                   "description": "The tab's new audible state."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "The tab's new autoDiscardable state."
+                },
                 "discarded": {
                   "type": "boolean",
                   "optional": true,
@@ -7835,6 +7881,32 @@
             }
           ]
         },
+        {
+          "name": "getUserSettings",
+          "type": "function",
+          "description": "Returns the user-specified settings relating to an extension's action.",
+          "async": "callback",
+          "parameters": [
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "userSettings",
+                  "type": "object",
+                  "properties": {
+                    "isOnToolbar": {
+                      "type": "boolean",
+                      "optional": true,
+                      "description": "Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user)."
+                    }
+                  },
+                  "description": "The collection of user-specified settings relating to an extension's action."
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "setIcon",
           "type": "function",
@@ -16238,14 +16310,14 @@
         {
           "name": "setUninstallURL",
           "type": "function",
-          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.",
+          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 1023 characters.",
           "async": "callback",
           "parameters": [
             {
               "type": "string",
               "name": "url",
               "optional": true,
-              "maxLength": 255,
+              "maxLength": 1023,
               "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation."
             },
             {
@@ -17534,6 +17606,13 @@
               "description": "The maximum size (in bytes) of the managed storage JSON manifest file. Files larger than this limit will fail to load."
             }
           }
+        },
+        "session": {
+          "allowedContexts": [
+            "devtools"
+          ],
+          "$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."
         }
       }
     }
@@ -19511,12 +19590,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19738,12 +19815,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19817,12 +19892,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {

package/schemas/central/webext.json

@@ -916,6 +916,31 @@
               "type": "string"
             }
           ]
+        },
+        {
+          "name": "onChanged",
+          "description": "Fired when a registered command's shortcut is changed.",
+          "type": "function",
+          "parameters": [
+            {
+              "type": "object",
+              "name": "changeInfo",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The name of the shortcut."
+                },
+                "newShortcut": {
+                  "type": "string",
+                  "description": "The new shortcut active for this command, or blank if not active."
+                },
+                "oldShortcut": {
+                  "type": "string",
+                  "description": "The old shortcut which is no longer active for this command, or blank if the shortcut was previously inactive."
+                }
+              }
+            }
+          ]
         }
       ],
       "functions": [
@@ -4438,6 +4463,11 @@
               "optional": true,
               "description": "Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the speaker audio indicator is showing."
             },
+            "autoDiscardable": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+            },
             "mutedInfo": {
               "$ref": "MutedInfo",
               "optional": true,
@@ -4739,6 +4769,7 @@
           "enum": [
             "attention",
             "audible",
+            "autoDiscardable",
             "discarded",
             "favIconUrl",
             "hidden",
@@ -5070,6 +5101,11 @@
                   "optional": true,
                   "description": "Whether the tabs are audible."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "muted": {
                   "type": "boolean",
                   "optional": true,
@@ -5287,6 +5323,11 @@
                   "optional": true,
                   "description": "Whether the tab should be active. Does not affect whether the window is focused (see $(ref:windows.update))."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "Whether the tab can be discarded automatically by the browser when resources are low."
+                },
                 "highlighted": {
                   "type": "boolean",
                   "optional": true,
@@ -6033,6 +6074,11 @@
                   "optional": true,
                   "description": "The tab's new audible state."
                 },
+                "autoDiscardable": {
+                  "type": "boolean",
+                  "optional": true,
+                  "description": "The tab's new autoDiscardable state."
+                },
                 "discarded": {
                   "type": "boolean",
                   "optional": true,
@@ -7835,6 +7881,32 @@
             }
           ]
         },
+        {
+          "name": "getUserSettings",
+          "type": "function",
+          "description": "Returns the user-specified settings relating to an extension's action.",
+          "async": "callback",
+          "parameters": [
+            {
+              "type": "function",
+              "name": "callback",
+              "parameters": [
+                {
+                  "name": "userSettings",
+                  "type": "object",
+                  "properties": {
+                    "isOnToolbar": {
+                      "type": "boolean",
+                      "optional": true,
+                      "description": "Whether the extension's action icon is visible on browser windows' top-level toolbar (i.e., whether the extension has been 'pinned' by the user)."
+                    }
+                  },
+                  "description": "The collection of user-specified settings relating to an extension's action."
+                }
+              ]
+            }
+          ]
+        },
         {
           "name": "setIcon",
           "type": "function",
@@ -16238,14 +16310,14 @@
         {
           "name": "setUninstallURL",
           "type": "function",
-          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 255 characters.",
+          "description": "Sets the URL to be visited upon uninstallation. This may be used to clean up server-side data, do analytics, and implement surveys. Maximum 1023 characters.",
           "async": "callback",
           "parameters": [
             {
               "type": "string",
               "name": "url",
               "optional": true,
-              "maxLength": 255,
+              "maxLength": 1023,
               "description": "URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation."
             },
             {
@@ -17534,6 +17606,13 @@
               "description": "The maximum size (in bytes) of the managed storage JSON manifest file. Files larger than this limit will fail to load."
             }
           }
+        },
+        "session": {
+          "allowedContexts": [
+            "devtools"
+          ],
+          "$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."
         }
       }
     }
@@ -19511,12 +19590,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19738,12 +19815,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {
@@ -19817,12 +19892,10 @@
                   "description": "0 indicates the navigation happens in the tab content window; a positive value indicates navigation in a subframe. Frame IDs are unique within a tab."
                 },
                 "transitionType": {
-                  "unsupported": true,
                   "$ref": "TransitionType",
                   "description": "Cause of the navigation."
                 },
                 "transitionQualifiers": {
-                  "unsupported": true,
                   "type": "array",
                   "description": "A list of transition qualifiers.",
                   "items": {