webext-schema 2.0.9 → 2.1.2

package/modules/schema.js

@@ -35,6 +35,7 @@ export class Schema {
     this._importMap = new Map();
     this._refMap = new Map();
     this._browser = null;
+    this._schema = null;
   }
 
   /* getter / setter */
@@ -272,8 +273,8 @@ export class Schema {
       encoding: CHAR,
       flag: 'r'
     });
-    const schema = JSON.parse(content);
-    return schema;
+    this._schema = JSON.parse(content);
+    return this._schema;
   }
 
   /**
@@ -286,7 +287,7 @@ export class Schema {
     if (!isString(name)) {
       throw new TypeError(`Expected String but got ${getType(name)}.`);
     }
-    const schemas = this._parseSchemaContent();
+    const schemas = this._schema || this._parseSchemaContent();
     const items = Object.entries(schemas);
     const label = decamelize(name.replace(/\.json$/, ''));
     let schema;
@@ -305,7 +306,7 @@ export class Schema {
    * @returns {object} - schemas
    */
   getAll() {
-    const schemas = this._parseSchemaContent();
+    const schemas = this._schema || this._parseSchemaContent();
     return schemas;
   }
 
@@ -315,7 +316,7 @@ export class Schema {
    * @returns {Array} - file list
    */
   list() {
-    const schemas = this._parseSchemaContent();
+    const schemas = this._schema || this._parseSchemaContent();
     const items = Object.keys(schemas);
     const arr = [];
     for (const item of items) {
@@ -330,7 +331,7 @@ export class Schema {
    * @returns {object} - stubbed browser api
    */
   mock() {
-    const schemas = this._parseSchemaContent();
+    const schemas = this._schema || this._parseSchemaContent();
     const schemaItems = Object.entries(schemas);
     const aliasKeys = ['action', 'menus'];
     this._browser = {

package/package.json

@@ -14,20 +14,25 @@
   "scripts": {
     "lint": "eslint --fix .",
     "start": "node index",
-    "test": "c8 --reporter=text mocha test/*.test.js --exit",
+    "test": "npm run test:central",
+    "test:beta": "c8 mocha --require=test/mocha/setup.js --channel=beta --exit test/*.test.js",
+    "test:central": "c8 mocha --require=test/mocha/setup.js --channel=central --exit test/*.test.js",
+    "test:esr": "c8 mocha --require=test/mocha/setup.js --channel=esr --exit test/*.test.js",
+    "test:release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
+    "test_all": "npm-run-all -s test:*",
     "update": "node index update -i",
-    "update:beta": "node index update -c beta -i",
-    "update:central": "node index update -c central -i",
-    "update:esr": "node index update -c esr -i",
-    "update:mail": "node index update -c mail -i",
-    "update:release": "node index update -c release -i"
+    "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"
   },
   "dependencies": {
     "camelize": "^1.0.0",
     "commander": "^9.0.0",
     "decamelize": "^6.0.0",
     "json5": "^2.2.0",
-    "node-fetch": "^3.2.0",
+    "node-fetch": "^3.2.2",
     "sinon": "^13.0.1"
   },
   "devDependencies": {
@@ -36,11 +41,12 @@
     "eslint": "^7.32.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-jsdoc": "^37.8.2",
+    "eslint-plugin-jsdoc": "^37.9.7",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.2.0",
-    "mocha": "^9.2.0",
-    "nock": "^13.2.4"
+    "mocha": "^9.2.1",
+    "nock": "^13.2.4",
+    "npm-run-all": "^4.1.5"
   },
-  "version": "2.0.9"
+  "version": "2.1.2"
 }

package/schemas/beta/webext.json

@@ -15206,7 +15206,8 @@
             "s390x",
             "sparc64",
             "x86-32",
-            "x86-64"
+            "x86-64",
+            "noarch"
           ],
           "allowedContexts": [
             "content",
@@ -16028,6 +16029,65 @@
               "description": "Details specifying the target into which to inject the CSS."
             }
           }
+        },
+        {
+          "id": "ContentScriptFilter",
+          "type": "object",
+          "properties": {
+            "ids": {
+              "type": "array",
+              "optional": true,
+              "description": "The IDs of specific scripts to retrieve with <code>getRegisteredContentScripts()</code> or to unregister with <code>unregisterContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        {
+          "id": "RegisteredContentScript",
+          "type": "object",
+          "properties": {
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If specified true, it will inject into all frames, even if the frame is not the top-most frame in the tab. Each frame is checked independently for URL requirements; it will not inject into child frames if the URL requirements are not met. Defaults to false, meaning that only the top frame is matched."
+            },
+            "excludeMatches": {
+              "type": "array",
+              "optional": true,
+              "description": "Excludes pages that this content script would otherwise be injected into.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "id": {
+              "type": "string",
+              "description": "The id of the content script, specified in the API call."
+            },
+            "js": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.",
+              "items": {
+                "$ref": "manifest.ExtensionURL"
+              }
+            },
+            "matches": {
+              "type": "array",
+              "optional": true,
+              "description": "Specifies which pages this content script will be injected into. Must be specified for <code>registerContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "runAt": {
+              "$ref": "extensionTypes.RunAt",
+              "optional": true,
+              "default": "document_idle",
+              "description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
+            }
+          }
         }
       ],
       "functions": [
@@ -16095,6 +16155,76 @@
               "parameters": []
             }
           ]
+        },
+        {
+          "name": "registerContentScripts",
+          "type": "function",
+          "description": "Registers one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "description": "Contains a list of scripts to be registered. If there are errors during script parsing/file validation, or if the IDs specified already exist, then no scripts are registered.",
+              "items": {
+                "$ref": "RegisteredContentScript"
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the registration.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "getRegisteredContentScripts",
+          "type": "function",
+          "description": "Returns all dynamically registered content scripts for this extension that match the given filter.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "An object to filter the extension's dynamically registered scripts."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "The resulting array contains the registered content scripts.",
+              "parameters": [
+                {
+                  "name": "scripts",
+                  "type": "array",
+                  "items": {
+                    "$ref": "RegisteredContentScript"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "unregisterContentScripts",
+          "type": "function",
+          "description": "Unregisters one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "If specified, only unregisters dynamic content scripts which match the filter. Otherwise, all of the extension's dynamic content scripts are unregistered."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the unregistration.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }

package/schemas/central/webext.json

@@ -15206,7 +15206,8 @@
             "s390x",
             "sparc64",
             "x86-32",
-            "x86-64"
+            "x86-64",
+            "noarch"
           ],
           "allowedContexts": [
             "content",
@@ -16028,6 +16029,65 @@
               "description": "Details specifying the target into which to inject the CSS."
             }
           }
+        },
+        {
+          "id": "ContentScriptFilter",
+          "type": "object",
+          "properties": {
+            "ids": {
+              "type": "array",
+              "optional": true,
+              "description": "The IDs of specific scripts to retrieve with <code>getRegisteredContentScripts()</code> or to unregister with <code>unregisterContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        {
+          "id": "RegisteredContentScript",
+          "type": "object",
+          "properties": {
+            "allFrames": {
+              "type": "boolean",
+              "optional": true,
+              "description": "If specified true, it will inject into all frames, even if the frame is not the top-most frame in the tab. Each frame is checked independently for URL requirements; it will not inject into child frames if the URL requirements are not met. Defaults to false, meaning that only the top frame is matched."
+            },
+            "excludeMatches": {
+              "type": "array",
+              "optional": true,
+              "description": "Excludes pages that this content script would otherwise be injected into.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "id": {
+              "type": "string",
+              "description": "The id of the content script, specified in the API call."
+            },
+            "js": {
+              "type": "array",
+              "optional": true,
+              "description": "The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.",
+              "items": {
+                "$ref": "manifest.ExtensionURL"
+              }
+            },
+            "matches": {
+              "type": "array",
+              "optional": true,
+              "description": "Specifies which pages this content script will be injected into. Must be specified for <code>registerContentScripts()</code>.",
+              "items": {
+                "type": "string"
+              }
+            },
+            "runAt": {
+              "$ref": "extensionTypes.RunAt",
+              "optional": true,
+              "default": "document_idle",
+              "description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
+            }
+          }
         }
       ],
       "functions": [
@@ -16095,6 +16155,76 @@
               "parameters": []
             }
           ]
+        },
+        {
+          "name": "registerContentScripts",
+          "type": "function",
+          "description": "Registers one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "scripts",
+              "type": "array",
+              "description": "Contains a list of scripts to be registered. If there are errors during script parsing/file validation, or if the IDs specified already exist, then no scripts are registered.",
+              "items": {
+                "$ref": "RegisteredContentScript"
+              }
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the registration.",
+              "parameters": []
+            }
+          ]
+        },
+        {
+          "name": "getRegisteredContentScripts",
+          "type": "function",
+          "description": "Returns all dynamically registered content scripts for this extension that match the given filter.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "An object to filter the extension's dynamically registered scripts."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "The resulting array contains the registered content scripts.",
+              "parameters": [
+                {
+                  "name": "scripts",
+                  "type": "array",
+                  "items": {
+                    "$ref": "RegisteredContentScript"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "unregisterContentScripts",
+          "type": "function",
+          "description": "Unregisters one or more content scripts for this extension.",
+          "async": "callback",
+          "parameters": [
+            {
+              "name": "filter",
+              "$ref": "ContentScriptFilter",
+              "optional": true,
+              "description": "If specified, only unregisters dynamic content scripts which match the filter. Otherwise, all of the extension's dynamic content scripts are unregistered."
+            },
+            {
+              "name": "callback",
+              "type": "function",
+              "description": "Invoked upon completion of the unregistration.",
+              "parameters": []
+            }
+          ]
         }
       ]
     }

package/schemas/mail/mailext.json

@@ -1583,7 +1583,8 @@
             "s390x",
             "sparc64",
             "x86-32",
-            "x86-64"
+            "x86-64",
+            "noarch"
           ],
           "allowedContexts": [
             "content",

package/schemas/release/webext.json

@@ -11776,6 +11776,7 @@
             "samplingallthreads",
             "markersallthreads",
             "unregisteredthreads",
+            "processcpu",
             "responsiveness"
           ]
         },
@@ -12895,7 +12896,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -12913,7 +12916,9 @@
                     },
                     "persistent": {
                       "optional": true,
-                      "$ref": "PersistentBackgroundProperty"
+                      "type": "boolean",
+                      "max_manifest_version": 2,
+                      "default": true
                     }
                   },
                   "additionalProperties": {
@@ -13536,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."
-            }
-          ]
         }
       ]
     }
@@ -15941,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"
@@ -15964,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."
+                }
+              }
             }
           }
         },
@@ -15986,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": [
@@ -16020,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": []
+            }
+          ]
         }
       ]
     }
@@ -18009,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"
             }
           }
         },