webext-schema 4.2.1 → 5.0.2

package/modules/browser.js

@@ -35,14 +35,14 @@ export const createBookmark = async opt => {
     const { bookmarks } = browser;
     node = await bookmarks.create(opt);
   }
-  return node || null;
+  return node ?? null;
 };
 
 /**
  * get bookmark tree node
  *
  * @param {string|Array} id - bookmark ID or array of bookmark IDs
- * @returns {Array} - array of bookmarks.BookmarkTreeNode
+ * @returns {?Array} - array of bookmarks.BookmarkTreeNode
  */
 export const getBookmarkTreeNode = async id => {
   const isGranted = await isPermissionGranted({
@@ -59,7 +59,7 @@ export const getBookmarkTreeNode = async id => {
       res = await bookmarks.getTree();
     }
   }
-  return res || null;
+  return res ?? null;
 };
 
 /* browserSettings */
@@ -77,7 +77,7 @@ export const getCloseTabsByDoubleClickValue = async () => {
     const { browserSettings: { closeTabsByDoubleClick } } = browser;
     userValue = await closeTabsByDoubleClick.get({});
   }
-  return userValue || null;
+  return userValue ?? null;
 };
 
 /**
@@ -135,7 +135,7 @@ export const getNewTabPositionValue = async () => {
     const { browserSettings: { newTabPosition } } = browser;
     res = await newTabPosition.get({});
   }
-  return res || null;
+  return res ?? null;
 };
 
 /* commands */
@@ -185,7 +185,7 @@ export const updateCommand = async (id, value = '') => {
       });
     }
   }
-  return func || null;
+  return func ?? null;
 };
 
 /* contextualIdentities */
@@ -201,13 +201,9 @@ export const getAllContextualIdentities = async () => {
   let arr;
   if (isGranted) {
     const { contextualIdentities } = browser;
-    try {
-      arr = await contextualIdentities.query({});
-    } catch (e) {
-      logErr(e);
-    }
+    arr = await contextualIdentities.query({});
   }
-  return arr || null;
+  return arr ?? null;
 };
 
 /**
@@ -226,13 +222,9 @@ export const getContextualId = async cookieStoreId => {
   let id;
   if (isGranted) {
     const { contextualIdentities } = browser;
-    try {
-      id = await contextualIdentities.get(cookieStoreId);
-    } catch (e) {
-      logErr(e);
-    }
+    id = await contextualIdentities.get(cookieStoreId);
   }
-  return id || null;
+  return id ?? null;
 };
 
 /* management */
@@ -248,17 +240,12 @@ export const getEnabledTheme = async () => {
   let res;
   if (isGranted) {
     const { management } = browser;
-    try {
-      const arr = await management.getAll();
-      if (Array.isArray(arr) && arr.length) {
-        res =
-          arr.filter(info => info?.type === 'theme' && info?.enabled && info);
-      }
-    } catch (e) {
-      logErr(e);
+    const arr = await management.getAll();
+    if (Array.isArray(arr) && arr.length) {
+      res = arr.filter(info => info?.type === 'theme' && info?.enabled && info);
     }
   }
-  return res || null;
+  return res ?? null;
 };
 
 /**
@@ -279,13 +266,13 @@ export const getExtensionInfo = async id => {
     const { management } = browser;
     ext = await management.get(id);
   }
-  return ext || null;
+  return ext ?? null;
 };
 
 /**
  * get external extensions
  *
- * @returns {?Array} -array of management.extensionInfo
+ * @returns {?Array|boolean} -array of management.extensionInfo
  */
 export const getExternalExtensions = async () => {
   const isGranted = await isPermissionGranted({
@@ -294,17 +281,12 @@ export const getExternalExtensions = async () => {
   let res;
   if (isGranted) {
     const { management } = browser;
-    try {
-      const arr = await management.getAll();
-      if (Array.isArray(arr) && arr.length) {
-        res =
-          arr.filter(info => info?.type === 'extension' && info);
-      }
-    } catch (e) {
-      logErr(e);
+    const arr = await management.getAll();
+    if (Array.isArray(arr) && arr.length) {
+      res = arr.filter(info => info?.type === 'extension' && info);
     }
   }
-  return res || null;
+  return res ?? null;
 };
 
 /* notifications */
@@ -326,7 +308,7 @@ export const clearNotification = async id => {
     const { notifications } = browser;
     func = notifications.clear(id);
   }
-  return func || null;
+  return func ?? null;
 };
 
 /**
@@ -351,7 +333,7 @@ export const createNotification = async (id, opt) => {
     }
     func = notifications.create(id, opt);
   }
-  return func || null;
+  return func ?? null;
 };
 
 /* permissions */
@@ -487,7 +469,55 @@ export const sendMessage = async (id, msg, opt) => {
       func = runtime.sendMessage(msg, opt);
     }
   }
-  return func || null;
+  return func ?? null;
+};
+
+/* scripting */
+/**
+ * is scripting available
+ *
+ * @returns {boolean} - result
+ */
+export const isScriptingAvailable = async () => {
+  const isGranted = await isPermissionGranted({
+    permissions: ['scripting']
+  });
+  let res;
+  if (isGranted) {
+    const { scripting } = browser;
+    res = typeof scripting?.executeScript === 'function';
+  }
+  return !!res;
+};
+
+/**
+ * execute script to tab
+ *
+ * @param {object} opt - options
+ * @returns {?Array|boolean} - array of InjectionResult object
+ */
+export const executeScriptToTab = async (opt = {}) => {
+  const { args, injectImmediately, files, func, target } = opt;
+  const isGranted = await isScriptingAvailable();
+  let fn;
+  if (isGranted && Number.isInteger(target?.tabId)) {
+    const { scripting } = browser;
+    if (Array.isArray(files) && files.length) {
+      fn = scripting.executeScript({
+        files,
+        target,
+        injectImmediately: !!injectImmediately
+      });
+    } else if (typeof func === 'function') {
+      fn = scripting.executeScript({
+        func,
+        target,
+        args: Array.isArray(args) ? args : null,
+        injectImmediately: !!injectImmediately
+      });
+    }
+  }
+  return fn ?? null;
 };
 
 /* search */
@@ -543,7 +573,7 @@ export const getRecentlyClosedTab = async windowId => {
       }
     }
   }
-  return tab || null;
+  return tab ?? null;
 };
 
 /**
@@ -568,7 +598,7 @@ export const getSessionWindowValue = async (key, windowId) => {
     const { sessions } = browser;
     value = await sessions.getWindowValue(windowId, key);
   }
-  return value || null;
+  return value ?? null;
 };
 
 /**
@@ -589,7 +619,7 @@ export const restoreSession = async sessionId => {
     const { sessions } = browser;
     ses = await sessions.restore(sessionId);
   }
-  return ses || null;
+  return ses ?? null;
 };
 
 /**
@@ -650,7 +680,7 @@ export const getAllStorage = async (area = 'local') => {
     const { storage } = browser;
     data = await storage[area]?.get();
   }
-  return data || null;
+  return data ?? null;
 };
 
 /**
@@ -670,7 +700,7 @@ export const getStorage = async (key, area = 'local') => {
     const { storage } = browser;
     data = await storage[area]?.get(key);
   }
-  return data || null;
+  return data ?? null;
 };
 
 /**
@@ -823,7 +853,7 @@ export const execScriptsToTabInOrder = async (tabId, opts = []) => {
     const { value } = await Promise.allSettled(func).then(a => a.pop());
     res = value;
   }
-  return res || null;
+  return res ?? null;
 };
 
 /**
@@ -948,7 +978,7 @@ export const moveTab = async (tabId, opt) => {
   if (arr && !Array.isArray(arr)) {
     arr = [arr];
   }
-  return arr || null;
+  return arr ?? null;
 };
 
 /**
@@ -1047,7 +1077,7 @@ export const getCurrentTheme = async () => {
     const { theme } = browser;
     currentTheme = await theme.getCurrent();
   }
-  return currentTheme || null;
+  return currentTheme ?? null;
 };
 
 /* windows */

package/package.json

@@ -38,15 +38,15 @@
   "devDependencies": {
     "c8": "^7.12.0",
     "chai": "^4.3.6",
-    "eslint": "^8.22.0",
+    "eslint": "^8.23.1",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-promise": "^6.0.1",
     "mocha": "^10.0.0",
     "nock": "^13.2.9",
     "npm-run-all": "^4.1.5"
   },
-  "version": "4.2.1"
+  "version": "5.0.2"
 }

package/schemas/beta/webext.json

@@ -7000,14 +7000,12 @@
                   "optional": true,
                   "choices": [
                     {
-                      "type": "string",
-                      "format": "relativeUrl"
+                      "type": "string"
                     },
                     {
                       "type": "array",
                       "items": {
-                        "type": "string",
-                        "format": "relativeUrl"
+                        "type": "string"
                       }
                     }
                   ]
@@ -9622,6 +9620,154 @@
       ]
     }
   ],
+  "declarative_net_request.json": [
+    {
+      "namespace": "manifest",
+      "types": [
+        {
+          "$extend": "Permission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequest"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        },
+        {
+          "$extend": "PermissionNoPrompt",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "declarativeNetRequestFeedback",
+                "declarativeNetRequestWithHostAccess"
+              ],
+              "min_manifest_version": 3
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "namespace": "declarativeNetRequest",
+      "description": "Use the declarativeNetRequest API to block or modify network requests by specifying declarative rules.",
+      "permissions": [
+        "declarativeNetRequest",
+        "declarativeNetRequestWithHostAccess"
+      ],
+      "types": [
+        {
+          "id": "ResourceType",
+          "type": "string",
+          "description": "How the requested resource will be used. Comparable to the webRequest.ResourceType type.",
+          "enum": [
+            "main_frame",
+            "sub_frame",
+            "stylesheet",
+            "script",
+            "image",
+            "object",
+            "object_subrequest",
+            "xmlhttprequest",
+            "xslt",
+            "ping",
+            "beacon",
+            "xml_dtd",
+            "font",
+            "media",
+            "websocket",
+            "csp_report",
+            "imageset",
+            "web_manifest",
+            "speculative",
+            "other"
+          ]
+        },
+        {
+          "id": "MatchedRule",
+          "type": "object",
+          "properties": {
+            "ruleId": {
+              "type": "integer",
+              "description": "A matching rule's ID."
+            },
+            "rulesetId": {
+              "type": "string",
+              "description": "ID of the Ruleset this rule belongs to."
+            }
+          }
+        }
+      ],
+      "functions": [
+        {
+          "name": "testMatchOutcome",
+          "type": "function",
+          "description": "Checks if any of the extension's declarativeNetRequest rules would match a hypothetical request.",
+          "permissions": [
+            "declarativeNetRequestFeedback"
+          ],
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "request",
+              "type": "object",
+              "description": "The details of the request to test.",
+              "properties": {
+                "url": {
+                  "type": "string",
+                  "description": "The URL of the hypothetical request."
+                },
+                "initiator": {
+                  "type": "string",
+                  "description": "The initiator URL (if any) for the hypothetical request.",
+                  "optional": true
+                },
+                "method": {
+                  "type": "string",
+                  "description": "Standard HTTP method of the hypothetical request.",
+                  "optional": true,
+                  "default": "get"
+                },
+                "type": {
+                  "$ref": "ResourceType",
+                  "description": "The resource type of the hypothetical request."
+                },
+                "tabId": {
+                  "type": "integer",
+                  "description": "The ID of the tab in which the hypothetical request takes place. Does not need to correspond to a real tab ID. Default is -1, meaning that the request isn't related to a tab.",
+                  "optional": true,
+                  "default": -1
+                }
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Called with the details of matched rules.",
+              "parameters": [
+                {
+                  "name": "result",
+                  "type": "object",
+                  "properties": {
+                    "matchedRules": {
+                      "type": "array",
+                      "description": "The rules (if any) that match the hypothetical request.",
+                      "items": {
+                        "$ref": "MatchedRule"
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
   "dns.json": [
     {
       "namespace": "manifest",
@@ -11579,7 +11725,6 @@
           "enum": [
             "java",
             "js",
-            "leaf",
             "mainthreadio",
             "fileio",
             "fileioall",
@@ -12880,20 +13025,43 @@
                 {
                   "min_manifest_version": 3,
                   "type": "array",
+                  "postprocess": "webAccessibleMatching",
+                  "minItems": 1,
                   "items": {
                     "type": "object",
                     "properties": {
                       "resources": {
                         "type": "array",
+                        "minItems": 1,
                         "items": {
                           "type": "string"
                         }
                       },
                       "matches": {
+                        "optional": true,
                         "type": "array",
+                        "minItems": 1,
                         "items": {
                           "$ref": "MatchPattern"
                         }
+                      },
+                      "extension_ids": {
+                        "optional": true,
+                        "type": "array",
+                        "minItems": 1,
+                        "items": {
+                          "choices": [
+                            {
+                              "$ref": "ExtensionID"
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "*"
+                              ]
+                            }
+                          ]
+                        }
                       }
                     }
                   }
@@ -15941,10 +16109,9 @@
             },
             "persistAcrossSessions": {
               "type": "boolean",
-              "enum": [
-                false
-              ],
-              "description": "Specifies if this content script will persist into future sessions. This is currently NOT supported."
+              "optional": true,
+              "default": true,
+              "description": "Specifies if this content script will persist into future sessions. Defaults to true."
             },
             "css": {
               "type": "array",
@@ -16110,10 +16277,7 @@
                   "persistAcrossSessions": {
                     "type": "boolean",
                     "optional": true,
-                    "enum": [
-                      false
-                    ],
-                    "description": "Specifies if this content script will persist into future sessions. This is currently NOT supported."
+                    "description": "Specifies if this content script will persist into future sessions."
                   }
                 }
               }
@@ -17264,9 +17428,8 @@
           ]
         },
         {
-          "name": "checkDeepEq",
+          "name": "assertDeepEq",
           "type": "function",
-          "unsupported": true,
           "allowAmbiguousOptionalArguments": true,
           "parameters": [
             {
@@ -17276,6 +17439,11 @@
             {
               "type": "any",
               "name": "actual"
+            },
+            {
+              "type": "string",
+              "name": "message",
+              "optional": true
             }
           ]
         },