webext-schema 2.0.5 → 2.0.9

package/modules/update.js

@@ -8,7 +8,7 @@ import { URL } from 'url';
 import JSON5 from 'json5';
 import { createFile } from './file-util.js';
 import { getType, isString } from './common.js';
-import commander from 'commander';
+import { program as commander } from 'commander';
 import fetch from 'node-fetch';
 import path from 'path';
 import process from 'process';

package/package.json

@@ -24,23 +24,23 @@
   },
   "dependencies": {
     "camelize": "^1.0.0",
-    "commander": "^8.3.0",
+    "commander": "^9.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.0",
-    "node-fetch": "^3.1.0",
-    "sinon": "^12.0.1"
+    "node-fetch": "^3.2.0",
+    "sinon": "^13.0.1"
   },
   "devDependencies": {
-    "c8": "^7.10.0",
-    "chai": "^4.3.4",
+    "c8": "^7.11.0",
+    "chai": "^4.3.6",
     "eslint": "^7.32.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jsdoc": "^37.1.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^37.8.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "mocha": "^9.1.3",
-    "nock": "^13.2.1"
+    "mocha": "^9.2.0",
+    "nock": "^13.2.4"
   },
-  "version": "2.0.5"
+  "version": "2.0.9"
 }

package/schemas/beta/webext.json

@@ -5165,7 +5165,17 @@
                   "description": "The position of the tabs within their windows."
                 },
                 "cookieStoreId": {
-                  "type": "string",
+                  "choices": [
+                    {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    {
+                      "type": "string"
+                    }
+                  ],
                   "optional": true,
                   "description": "The CookieStoreId used for the tab."
                 },
@@ -9033,6 +9043,22 @@
               "$ref": "extensionTypes.RunAt",
               "optional": true,
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "cookieStoreId": {
+              "choices": [
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "optional": true,
+              "description": "limit the set of matched tabs to those that belong to the given cookie store id"
             }
           }
         },
@@ -11737,7 +11763,6 @@
             "screenshots",
             "seqstyle",
             "stackwalk",
-            "threads",
             "jstracer",
             "jsallocations",
             "nostacksampling",
@@ -11751,6 +11776,7 @@
             "samplingallthreads",
             "markersallthreads",
             "unregisteredthreads",
+            "processcpu",
             "responsiveness"
           ]
         },
@@ -12870,7 +12896,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -12888,7 +12916,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -13147,6 +13177,30 @@
             }
           }
         },
+        {
+          "id": "WebExtensionSitePermissionsManifest",
+          "type": "object",
+          "description": "Represents a WebExtension site permissions manifest.json file",
+          "$import": "ManifestBase",
+          "properties": {
+            "site_permissions": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "$ref": "SitePermission"
+              }
+            },
+            "install_origins": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 1,
+              "items": {
+                "type": "string",
+                "format": "origin"
+              }
+            }
+          }
+        },
         {
           "id": "ThemeIcons",
           "type": "object",
@@ -13246,6 +13300,18 @@
             }
           ]
         },
+        {
+          "id": "SitePermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "midi",
+                "midi-sysex"
+              ]
+            }
+          ]
+        },
         {
           "id": "HttpURL",
           "type": "string",
@@ -13475,24 +13541,6 @@
           "id": "UnrecognizedProperty",
           "type": "any",
           "deprecated": "An unexpected property was found in the WebExtension manifest."
-        },
-        {
-          "id": "PersistentBackgroundProperty",
-          "choices": [
-            {
-              "type": "boolean",
-              "enum": [
-                true
-              ]
-            },
-            {
-              "type": "boolean",
-              "enum": [
-                false
-              ],
-              "deprecated": "Event pages are not currently supported. This will run as a persistent background page."
-            }
-          ]
         }
       ]
     }
@@ -15880,7 +15928,7 @@
             "files": {
               "type": "array",
               "optional": true,
-              "description": "The path of the JS or CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
+              "description": "The path of the JS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
               "minItems": 1,
               "items": {
                 "type": "string"
@@ -15903,13 +15951,24 @@
           "description": "Result of a script injection.",
           "properties": {
             "frameId": {
-              "type": "number",
+              "type": "integer",
               "description": "The frame ID associated with the injection."
             },
             "result": {
               "type": "any",
               "optional": true,
               "description": "The result of the script execution."
+            },
+            "error": {
+              "type": "object",
+              "optional": true,
+              "description": "When the injection has failed, the error is exposed to the caller with this property.",
+              "properties": {
+                "message": {
+                  "type": "string",
+                  "description": "A message explaining why the injection has failed."
+                }
+              }
             }
           }
         },
@@ -15925,11 +15984,50 @@
                 "type": "number"
               }
             },
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the script should inject into all frames within the tab. Defaults to false. This must not be true if <code>frameIds</code> is specified."
+            },
             "tabId": {
               "type": "number",
               "description": "The ID of the tab into which to inject."
             }
           }
+        },
+        {
+          "id": "CSSInjection",
+          "type": "object",
+          "properties": {
+            "css": {
+              "type": "string",
+              "optional": true,
+              "description": "A string containing the CSS to inject. Exactly one of <code>files</code> and <code>css</code> must be specified."
+            },
+            "files": {
+              "type": "array",
+              "optional": true,
+              "description": "The path of the CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>css</code> must be specified.",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            },
+            "origin": {
+              "type": "string",
+              "optional": true,
+              "enum": [
+                "USER",
+                "AUTHOR"
+              ],
+              "default": "AUTHOR",
+              "description": "The style origin for the injection. Defaults to <code>'AUTHOR'</code>."
+            },
+            "target": {
+              "$ref": "InjectionTarget",
+              "description": "Details specifying the target into which to inject the CSS."
+            }
+          }
         }
       ],
       "functions": [
@@ -15959,6 +16057,44 @@
               ]
             }
           ]
+        },
+        {
+          "name": "insertCSS",
+          "type": "function",
+          "description": "Inserts a CSS stylesheet into a target context. If multiple frames are specified, unsuccessful injections are ignored.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to insert."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "removeCSS",
+          "type": "function",
+          "description": "Removes a CSS stylesheet that was previously inserted by this extension from a target context.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to remove. Note that the <code>css</code>, <code>files</code>, and <code>origin</code> properties must exactly match the stylesheet inserted through <code>insertCSS</code>. Attempting to remove a non-existent stylesheet is a no-op."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }
@@ -17948,6 +18084,22 @@
               "default": "document_idle",
               "optional": true,
               "description": "The soonest that the JavaScript will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "cookieStoreId": {
+              "choices": [
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "optional": true,
+              "description": "limit the set of matched tabs to those that belong to the given cookie store id"
             }
           }
         },

package/schemas/central/webext.json

@@ -5165,7 +5165,17 @@
                   "description": "The position of the tabs within their windows."
                 },
                 "cookieStoreId": {
-                  "type": "string",
+                  "choices": [
+                    {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    {
+                      "type": "string"
+                    }
+                  ],
                   "optional": true,
                   "description": "The CookieStoreId used for the tab."
                 },
@@ -9033,6 +9043,22 @@
               "$ref": "extensionTypes.RunAt",
               "optional": true,
               "description": "The soonest that the JavaScript or CSS will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "cookieStoreId": {
+              "choices": [
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "optional": true,
+              "description": "limit the set of matched tabs to those that belong to the given cookie store id"
             }
           }
         },
@@ -11737,7 +11763,6 @@
             "screenshots",
             "seqstyle",
             "stackwalk",
-            "threads",
             "jstracer",
             "jsallocations",
             "nostacksampling",
@@ -11751,6 +11776,7 @@
             "samplingallthreads",
             "markersallthreads",
             "unregisteredthreads",
+            "processcpu",
             "responsiveness"
           ]
         },
@@ -12870,7 +12896,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -12888,7 +12916,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -13147,6 +13177,30 @@
             }
           }
         },
+        {
+          "id": "WebExtensionSitePermissionsManifest",
+          "type": "object",
+          "description": "Represents a WebExtension site permissions manifest.json file",
+          "$import": "ManifestBase",
+          "properties": {
+            "site_permissions": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "$ref": "SitePermission"
+              }
+            },
+            "install_origins": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 1,
+              "items": {
+                "type": "string",
+                "format": "origin"
+              }
+            }
+          }
+        },
         {
           "id": "ThemeIcons",
           "type": "object",
@@ -13246,6 +13300,18 @@
             }
           ]
         },
+        {
+          "id": "SitePermission",
+          "choices": [
+            {
+              "type": "string",
+              "enum": [
+                "midi",
+                "midi-sysex"
+              ]
+            }
+          ]
+        },
         {
           "id": "HttpURL",
           "type": "string",
@@ -13475,24 +13541,6 @@
           "id": "UnrecognizedProperty",
           "type": "any",
           "deprecated": "An unexpected property was found in the WebExtension manifest."
-        },
-        {
-          "id": "PersistentBackgroundProperty",
-          "choices": [
-            {
-              "type": "boolean",
-              "enum": [
-                true
-              ]
-            },
-            {
-              "type": "boolean",
-              "enum": [
-                false
-              ],
-              "deprecated": "Event pages are not currently supported. This will run as a persistent background page."
-            }
-          ]
         }
       ]
     }
@@ -15880,7 +15928,7 @@
             "files": {
               "type": "array",
               "optional": true,
-              "description": "The path of the JS or CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
+              "description": "The path of the JS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>func</code> must be specified.",
               "minItems": 1,
               "items": {
                 "type": "string"
@@ -15903,13 +15951,24 @@
           "description": "Result of a script injection.",
           "properties": {
             "frameId": {
-              "type": "number",
+              "type": "integer",
               "description": "The frame ID associated with the injection."
             },
             "result": {
               "type": "any",
               "optional": true,
               "description": "The result of the script execution."
+            },
+            "error": {
+              "type": "object",
+              "optional": true,
+              "description": "When the injection has failed, the error is exposed to the caller with this property.",
+              "properties": {
+                "message": {
+                  "type": "string",
+                  "description": "A message explaining why the injection has failed."
+                }
+              }
             }
           }
         },
@@ -15925,11 +15984,50 @@
                 "type": "number"
               }
             },
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "Whether the script should inject into all frames within the tab. Defaults to false. This must not be true if <code>frameIds</code> is specified."
+            },
             "tabId": {
               "type": "number",
               "description": "The ID of the tab into which to inject."
             }
           }
+        },
+        {
+          "id": "CSSInjection",
+          "type": "object",
+          "properties": {
+            "css": {
+              "type": "string",
+              "optional": true,
+              "description": "A string containing the CSS to inject. Exactly one of <code>files</code> and <code>css</code> must be specified."
+            },
+            "files": {
+              "type": "array",
+              "optional": true,
+              "description": "The path of the CSS files to inject, relative to the extension's root directory. Exactly one of <code>files</code> and <code>css</code> must be specified.",
+              "minItems": 1,
+              "items": {
+                "type": "string"
+              }
+            },
+            "origin": {
+              "type": "string",
+              "optional": true,
+              "enum": [
+                "USER",
+                "AUTHOR"
+              ],
+              "default": "AUTHOR",
+              "description": "The style origin for the injection. Defaults to <code>'AUTHOR'</code>."
+            },
+            "target": {
+              "$ref": "InjectionTarget",
+              "description": "Details specifying the target into which to inject the CSS."
+            }
+          }
         }
       ],
       "functions": [
@@ -15959,6 +16057,44 @@
               ]
             }
           ]
+        },
+        {
+          "name": "insertCSS",
+          "type": "function",
+          "description": "Inserts a CSS stylesheet into a target context. If multiple frames are specified, unsuccessful injections are ignored.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to insert."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "removeCSS",
+          "type": "function",
+          "description": "Removes a CSS stylesheet that was previously inserted by this extension from a target context.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "injection",
+              "$ref": "CSSInjection",
+              "description": "The details of the styles to remove. Note that the <code>css</code>, <code>files</code>, and <code>origin</code> properties must exactly match the stylesheet inserted through <code>insertCSS</code>. Attempting to remove a non-existent stylesheet is a no-op."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the injection.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }
@@ -17948,6 +18084,22 @@
               "default": "document_idle",
               "optional": true,
               "description": "The soonest that the JavaScript will be injected into the tab. Defaults to \"document_idle\"."
+            },
+            "cookieStoreId": {
+              "choices": [
+                {
+                  "type": "array",
+                  "minItems": 1,
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string"
+                }
+              ],
+              "optional": true,
+              "description": "limit the set of matched tabs to those that belong to the given cookie store id"
             }
           }
         },