webext-schema 4.2.1 → 5.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/modules/browser.js +79 -49
- package/package.json +3 -3
- package/schemas/beta/webext.json +183 -15
- package/schemas/central/webext.json +313 -8
- package/schemas/mail/mailext.json +158 -27
- package/schemas/release/webext.json +183 -15
|
@@ -9699,9 +9699,297 @@
|
|
|
9699
9699
|
"description": "ID of the Ruleset this rule belongs to."
|
|
9700
9700
|
}
|
|
9701
9701
|
}
|
|
9702
|
+
},
|
|
9703
|
+
{
|
|
9704
|
+
"id": "Rule",
|
|
9705
|
+
"type": "object",
|
|
9706
|
+
"properties": {
|
|
9707
|
+
"id": {
|
|
9708
|
+
"type": "integer",
|
|
9709
|
+
"description": "An id which uniquely identifies a rule. Mandatory and should be >= 1.",
|
|
9710
|
+
"minimum": 1
|
|
9711
|
+
},
|
|
9712
|
+
"priority": {
|
|
9713
|
+
"type": "integer",
|
|
9714
|
+
"optional": true,
|
|
9715
|
+
"description": "Rule priority. Defaults to 1. When specified, should be >= 1",
|
|
9716
|
+
"minimum": 1,
|
|
9717
|
+
"default": 1
|
|
9718
|
+
},
|
|
9719
|
+
"condition": {
|
|
9720
|
+
"type": "object",
|
|
9721
|
+
"description": "The condition under which this rule is triggered.",
|
|
9722
|
+
"properties": {
|
|
9723
|
+
"urlFilter": {
|
|
9724
|
+
"type": "string",
|
|
9725
|
+
"optional": true,
|
|
9726
|
+
"description": "TODO: link to doc explaining supported pattern. The pattern which is matched against the network request url. Only one of 'urlFilter' or 'regexFilter' can be specified."
|
|
9727
|
+
},
|
|
9728
|
+
"regexFilter": {
|
|
9729
|
+
"type": "string",
|
|
9730
|
+
"optional": true,
|
|
9731
|
+
"description": "Regular expression to match against the network request url. Only one of 'urlFilter' or 'regexFilter' can be specified."
|
|
9732
|
+
},
|
|
9733
|
+
"isUrlFilterCaseSensitive": {
|
|
9734
|
+
"type": "boolean",
|
|
9735
|
+
"optional": true,
|
|
9736
|
+
"description": "Whether 'urlFilter' or 'regexFilter' is case-sensitive. Defaults to true."
|
|
9737
|
+
},
|
|
9738
|
+
"initiatorDomains": {
|
|
9739
|
+
"type": "array",
|
|
9740
|
+
"optional": true,
|
|
9741
|
+
"description": "The rule will only match network requests originating from the list of 'initiatorDomains'. If the list is omitted, the rule is applied to requests from all domains.",
|
|
9742
|
+
"minItems": 1,
|
|
9743
|
+
"items": {
|
|
9744
|
+
"type": "string",
|
|
9745
|
+
"description": "TODO: describe domain format."
|
|
9746
|
+
}
|
|
9747
|
+
},
|
|
9748
|
+
"excludedInitiatorDomains": {
|
|
9749
|
+
"type": "array",
|
|
9750
|
+
"optional": true,
|
|
9751
|
+
"description": "The rule will not match network requests originating from the list of 'initiatorDomains'. If the list is empty or omitted, no domains are excluded. This takes precedence over 'initiatorDomains'.",
|
|
9752
|
+
"items": {
|
|
9753
|
+
"type": "string",
|
|
9754
|
+
"description": "TODO: describe domain format."
|
|
9755
|
+
}
|
|
9756
|
+
},
|
|
9757
|
+
"requestDomains": {
|
|
9758
|
+
"type": "array",
|
|
9759
|
+
"optional": true,
|
|
9760
|
+
"description": "The rule will only match network requests when the domain matches one from the list of 'requestDomains'. If the list is omitted, the rule is applied to requests from all domains.",
|
|
9761
|
+
"minItems": 1,
|
|
9762
|
+
"items": {
|
|
9763
|
+
"type": "string",
|
|
9764
|
+
"description": "TODO: describe domain format."
|
|
9765
|
+
}
|
|
9766
|
+
},
|
|
9767
|
+
"excludedRequestDomains": {
|
|
9768
|
+
"type": "array",
|
|
9769
|
+
"optional": true,
|
|
9770
|
+
"description": "The rule will not match network requests when the domains matches one from the list of 'excludedRequestDomains'. If the list is empty or omitted, no domains are excluded. This takes precedence over 'requestDomains'.",
|
|
9771
|
+
"items": {
|
|
9772
|
+
"type": "string",
|
|
9773
|
+
"description": "TODO: describe domain format."
|
|
9774
|
+
}
|
|
9775
|
+
},
|
|
9776
|
+
"resourceTypes": {
|
|
9777
|
+
"type": "array",
|
|
9778
|
+
"optional": true,
|
|
9779
|
+
"description": "List of resource types which the rule can match. When the rule action is 'allowAllRequests', this must be specified and may only contain 'main_frame' or 'sub_frame'. Cannot be specified if 'excludedResourceTypes' is specified. If neither of them is specified, all resource types except 'main_frame' are matched.",
|
|
9780
|
+
"minItems": 1,
|
|
9781
|
+
"items": {
|
|
9782
|
+
"$ref": "ResourceType"
|
|
9783
|
+
}
|
|
9784
|
+
},
|
|
9785
|
+
"excludedResourceTypes": {
|
|
9786
|
+
"type": "array",
|
|
9787
|
+
"optional": true,
|
|
9788
|
+
"description": "List of resource types which the rule won't match. Cannot be specified if 'resourceTypes' is specified. If neither of them is specified, all resource types except 'main_frame' are matched.",
|
|
9789
|
+
"minItems": 1,
|
|
9790
|
+
"items": {
|
|
9791
|
+
"$ref": "ResourceType"
|
|
9792
|
+
}
|
|
9793
|
+
},
|
|
9794
|
+
"requestMethods": {
|
|
9795
|
+
"type": "array",
|
|
9796
|
+
"optional": true,
|
|
9797
|
+
"description": "List of HTTP request methods which the rule can match. Should be a lower-case method such as 'connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put'.'",
|
|
9798
|
+
"minItems": 1,
|
|
9799
|
+
"items": {
|
|
9800
|
+
"type": "string"
|
|
9801
|
+
}
|
|
9802
|
+
},
|
|
9803
|
+
"excludedRequestMethods": {
|
|
9804
|
+
"type": "array",
|
|
9805
|
+
"optional": true,
|
|
9806
|
+
"description": "List of request methods which the rule won't match. Cannot be specified if 'requestMethods' is specified. If neither of them is specified, all request methods are matched.",
|
|
9807
|
+
"minItems": 1,
|
|
9808
|
+
"items": {
|
|
9809
|
+
"type": "string"
|
|
9810
|
+
}
|
|
9811
|
+
},
|
|
9812
|
+
"domainType": {
|
|
9813
|
+
"type": "string",
|
|
9814
|
+
"optional": true,
|
|
9815
|
+
"description": "Specifies whether the network request is first-party or third-party to the domain from which it originated. If omitted, all requests are matched.",
|
|
9816
|
+
"enum": [
|
|
9817
|
+
"firstParty",
|
|
9818
|
+
"thirdParty"
|
|
9819
|
+
]
|
|
9820
|
+
},
|
|
9821
|
+
"tabIds": {
|
|
9822
|
+
"type": "array",
|
|
9823
|
+
"optional": true,
|
|
9824
|
+
"description": "List of tabIds which the rule should match. An ID of -1 matches requests which don't originate from a tab. Only supported for session-scoped rules.",
|
|
9825
|
+
"minItems": 1,
|
|
9826
|
+
"items": {
|
|
9827
|
+
"type": "integer"
|
|
9828
|
+
}
|
|
9829
|
+
},
|
|
9830
|
+
"excludedTabIds": {
|
|
9831
|
+
"type": "array",
|
|
9832
|
+
"optional": true,
|
|
9833
|
+
"description": "List of tabIds which the rule should not match. An ID of -1 excludes requests which don't originate from a tab. Only supported for session-scoped rules.",
|
|
9834
|
+
"items": {
|
|
9835
|
+
"type": "integer"
|
|
9836
|
+
}
|
|
9837
|
+
}
|
|
9838
|
+
}
|
|
9839
|
+
},
|
|
9840
|
+
"action": {
|
|
9841
|
+
"type": "object",
|
|
9842
|
+
"description": "The action to take if this rule is matched.",
|
|
9843
|
+
"properties": {
|
|
9844
|
+
"type": {
|
|
9845
|
+
"type": "string",
|
|
9846
|
+
"enum": [
|
|
9847
|
+
"block",
|
|
9848
|
+
"redirect",
|
|
9849
|
+
"allow",
|
|
9850
|
+
"upgradeScheme",
|
|
9851
|
+
"modifyHeaders",
|
|
9852
|
+
"allowAllRequests"
|
|
9853
|
+
]
|
|
9854
|
+
},
|
|
9855
|
+
"redirect": {
|
|
9856
|
+
"type": "object",
|
|
9857
|
+
"optional": true,
|
|
9858
|
+
"description": "Describes how the redirect should be performed. Only valid when type is 'redirect'.",
|
|
9859
|
+
"properties": {
|
|
9860
|
+
"extensionPath": {
|
|
9861
|
+
"type": "string",
|
|
9862
|
+
"optional": true,
|
|
9863
|
+
"description": "Path relative to the extension directory. Should start with '/'."
|
|
9864
|
+
},
|
|
9865
|
+
"transform": {
|
|
9866
|
+
"type": "object",
|
|
9867
|
+
"optional": true,
|
|
9868
|
+
"description": "TODO: URLTransform - Url transformations to perform."
|
|
9869
|
+
},
|
|
9870
|
+
"url": {
|
|
9871
|
+
"type": "string",
|
|
9872
|
+
"optional": true,
|
|
9873
|
+
"description": "The redirect url. Redirects to JavaScript urls are not allowed."
|
|
9874
|
+
},
|
|
9875
|
+
"regexSubstitution": {
|
|
9876
|
+
"type": "string",
|
|
9877
|
+
"optional": true,
|
|
9878
|
+
"description": "TODO with regexFilter + Substitution pattern for rules which specify a 'regexFilter'."
|
|
9879
|
+
}
|
|
9880
|
+
}
|
|
9881
|
+
},
|
|
9882
|
+
"requestHeaders": {
|
|
9883
|
+
"type": "object",
|
|
9884
|
+
"optional": true,
|
|
9885
|
+
"description": "The request headers to modify for the request. Only valid when type is 'modifyHeaders'.",
|
|
9886
|
+
"properties": {
|
|
9887
|
+
"header": {
|
|
9888
|
+
"type": "string",
|
|
9889
|
+
"description": "The name of the request header to be modified."
|
|
9890
|
+
},
|
|
9891
|
+
"operation": {
|
|
9892
|
+
"type": "string",
|
|
9893
|
+
"description": "The operation to be performed on a header. The 'append' operation is not supported for request headers.",
|
|
9894
|
+
"enum": [
|
|
9895
|
+
"set",
|
|
9896
|
+
"remove"
|
|
9897
|
+
]
|
|
9898
|
+
},
|
|
9899
|
+
"value": {
|
|
9900
|
+
"type": "string",
|
|
9901
|
+
"optional": true,
|
|
9902
|
+
"description": "The new value for the header. Must be specified for the 'set' operation."
|
|
9903
|
+
}
|
|
9904
|
+
}
|
|
9905
|
+
},
|
|
9906
|
+
"responseHeaders": {
|
|
9907
|
+
"type": "object",
|
|
9908
|
+
"optional": true,
|
|
9909
|
+
"description": "The response headers to modify for the request. Only valid when type is 'modifyHeaders'.",
|
|
9910
|
+
"properties": {
|
|
9911
|
+
"header": {
|
|
9912
|
+
"type": "string",
|
|
9913
|
+
"description": "The name of the response header to be modified."
|
|
9914
|
+
},
|
|
9915
|
+
"operation": {
|
|
9916
|
+
"type": "string",
|
|
9917
|
+
"description": "The operation to be performed on a header.",
|
|
9918
|
+
"enum": [
|
|
9919
|
+
"append",
|
|
9920
|
+
"set",
|
|
9921
|
+
"remove"
|
|
9922
|
+
]
|
|
9923
|
+
},
|
|
9924
|
+
"value": {
|
|
9925
|
+
"type": "string",
|
|
9926
|
+
"optional": true,
|
|
9927
|
+
"description": "The new value for the header. Must be specified for the 'append' and 'set' operations."
|
|
9928
|
+
}
|
|
9929
|
+
}
|
|
9930
|
+
}
|
|
9931
|
+
}
|
|
9932
|
+
}
|
|
9933
|
+
}
|
|
9702
9934
|
}
|
|
9703
9935
|
],
|
|
9704
9936
|
"functions": [
|
|
9937
|
+
{
|
|
9938
|
+
"name": "updateSessionRules",
|
|
9939
|
+
"type": "function",
|
|
9940
|
+
"description": "Modifies the current set of session scoped rules for the extension. The rules with IDs listed in options.removeRuleIds are first removed, and then the rules given in options.addRules are added. These rules are not persisted across sessions and are backed in memory.",
|
|
9941
|
+
"async": "callback",
|
|
9942
|
+
"parameters": [
|
|
9943
|
+
{
|
|
9944
|
+
"name": "options",
|
|
9945
|
+
"type": "object",
|
|
9946
|
+
"properties": {
|
|
9947
|
+
"removeRuleIds": {
|
|
9948
|
+
"type": "array",
|
|
9949
|
+
"optional": true,
|
|
9950
|
+
"description": "IDs of the rules to remove. Any invalid IDs will be ignored.",
|
|
9951
|
+
"items": {
|
|
9952
|
+
"type": "integer"
|
|
9953
|
+
}
|
|
9954
|
+
},
|
|
9955
|
+
"addRules": {
|
|
9956
|
+
"type": "array",
|
|
9957
|
+
"optional": true,
|
|
9958
|
+
"description": "Rules to add.",
|
|
9959
|
+
"items": {
|
|
9960
|
+
"$ref": "Rule"
|
|
9961
|
+
}
|
|
9962
|
+
}
|
|
9963
|
+
}
|
|
9964
|
+
},
|
|
9965
|
+
{
|
|
9966
|
+
"name": "callback",
|
|
9967
|
+
"type": "function",
|
|
9968
|
+
"description": "Called when the session rules have been updated",
|
|
9969
|
+
"parameters": []
|
|
9970
|
+
}
|
|
9971
|
+
]
|
|
9972
|
+
},
|
|
9973
|
+
{
|
|
9974
|
+
"name": "getSessionRules",
|
|
9975
|
+
"type": "function",
|
|
9976
|
+
"description": "Returns the current set of session scoped rules for the extension.",
|
|
9977
|
+
"async": "callback",
|
|
9978
|
+
"parameters": [
|
|
9979
|
+
{
|
|
9980
|
+
"name": "callback",
|
|
9981
|
+
"type": "function",
|
|
9982
|
+
"parameters": [
|
|
9983
|
+
{
|
|
9984
|
+
"type": "array",
|
|
9985
|
+
"items": {
|
|
9986
|
+
"$ref": "Rule"
|
|
9987
|
+
}
|
|
9988
|
+
}
|
|
9989
|
+
]
|
|
9990
|
+
}
|
|
9991
|
+
]
|
|
9992
|
+
},
|
|
9705
9993
|
{
|
|
9706
9994
|
"name": "testMatchOutcome",
|
|
9707
9995
|
"type": "function",
|
|
@@ -17428,9 +17716,8 @@
|
|
|
17428
17716
|
]
|
|
17429
17717
|
},
|
|
17430
17718
|
{
|
|
17431
|
-
"name": "
|
|
17719
|
+
"name": "assertDeepEq",
|
|
17432
17720
|
"type": "function",
|
|
17433
|
-
"unsupported": true,
|
|
17434
17721
|
"allowAmbiguousOptionalArguments": true,
|
|
17435
17722
|
"parameters": [
|
|
17436
17723
|
{
|
|
@@ -17440,6 +17727,11 @@
|
|
|
17440
17727
|
{
|
|
17441
17728
|
"type": "any",
|
|
17442
17729
|
"name": "actual"
|
|
17730
|
+
},
|
|
17731
|
+
{
|
|
17732
|
+
"type": "string",
|
|
17733
|
+
"name": "message",
|
|
17734
|
+
"optional": true
|
|
17443
17735
|
}
|
|
17444
17736
|
]
|
|
17445
17737
|
},
|
|
@@ -19416,21 +19708,34 @@
|
|
|
19416
19708
|
"$ref": "CertificateInfo"
|
|
19417
19709
|
}
|
|
19418
19710
|
},
|
|
19419
|
-
"
|
|
19420
|
-
"description": "The
|
|
19421
|
-
"type": "
|
|
19711
|
+
"overridableErrorCategory": {
|
|
19712
|
+
"description": "The type of certificate error that was overridden for this connection, if any.",
|
|
19713
|
+
"type": "string",
|
|
19714
|
+
"enum": [
|
|
19715
|
+
"trust_error",
|
|
19716
|
+
"domain_mismatch",
|
|
19717
|
+
"expired_or_not_yet_valid"
|
|
19718
|
+
],
|
|
19422
19719
|
"optional": true
|
|
19423
19720
|
},
|
|
19424
|
-
"
|
|
19721
|
+
"isDomainMismatch": {
|
|
19722
|
+
"description": "The domain name does not match the certificate domain.",
|
|
19425
19723
|
"type": "boolean",
|
|
19426
|
-
"optional": true
|
|
19724
|
+
"optional": true,
|
|
19725
|
+
"deprecated": "Please use $(ref:SecurityInfo.overridableErrorCategory)."
|
|
19427
19726
|
},
|
|
19428
19727
|
"isNotValidAtThisTime": {
|
|
19429
19728
|
"description": "The certificate is either expired or is not yet valid. See <code>CertificateInfo.validity</code> for start and end dates.",
|
|
19430
19729
|
"type": "boolean",
|
|
19431
|
-
"optional": true
|
|
19730
|
+
"optional": true,
|
|
19731
|
+
"deprecated": "Please use $(ref:SecurityInfo.overridableErrorCategory)."
|
|
19432
19732
|
},
|
|
19433
19733
|
"isUntrusted": {
|
|
19734
|
+
"type": "boolean",
|
|
19735
|
+
"optional": true,
|
|
19736
|
+
"deprecated": "Please use $(ref:SecurityInfo.overridableErrorCategory)."
|
|
19737
|
+
},
|
|
19738
|
+
"isExtendedValidation": {
|
|
19434
19739
|
"type": "boolean",
|
|
19435
19740
|
"optional": true
|
|
19436
19741
|
},
|