@adguard/dnr-converter 1.0.0-alpha.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/README.md +476 -0
- package/dist/cli.cjs +58912 -0
- package/dist/constants.js +23 -0
- package/dist/declarative-rule/declarative-rule.js +15 -0
- package/dist/declarative-rule/header-info.js +12 -0
- package/dist/declarative-rule/modify-header-info.js +31 -0
- package/dist/declarative-rule/query-key-value.js +12 -0
- package/dist/declarative-rule/query-transform.js +12 -0
- package/dist/declarative-rule/redirect.js +14 -0
- package/dist/declarative-rule/rule-action.js +44 -0
- package/dist/declarative-rule/rule-condition.js +77 -0
- package/dist/declarative-rule/url-transform.js +30 -0
- package/dist/errors/conversion-errors/empty-domains-error.js +24 -0
- package/dist/errors/conversion-errors/empty-resources-error.js +24 -0
- package/dist/errors/conversion-errors/index.js +17 -0
- package/dist/errors/conversion-errors/invalid-declarative-rule-error.js +22 -0
- package/dist/errors/conversion-errors/unsupported-modifier-error.js +20 -0
- package/dist/errors/conversion-errors/unsupported-regexp-error.js +27 -0
- package/dist/errors/converter-options-errors/empty-or-negative-number-of-rules-error.js +18 -0
- package/dist/errors/converter-options-errors/index.js +15 -0
- package/dist/errors/converter-options-errors/negative-number-of-rules-error.js +18 -0
- package/dist/errors/converter-options-errors/resources-path-error.js +18 -0
- package/dist/errors/limitation-errors/index.js +17 -0
- package/dist/errors/limitation-errors/max-scanned-rules-error.js +20 -0
- package/dist/errors/limitation-errors/too-many-error.js +28 -0
- package/dist/errors/limitation-errors/too-many-regexp-rules-error.js +25 -0
- package/dist/errors/limitation-errors/too-many-rules-error.js +25 -0
- package/dist/errors/limitation-errors/too-many-unsafe-rules-error.js +25 -0
- package/dist/errors/unavailable-sources-errors/unavailable-filter-source-error.js +21 -0
- package/dist/errors/unavailable-sources-errors/unavailable-ruleset-source-error.js +21 -0
- package/dist/filter/filter.js +92 -0
- package/dist/filter-converter/filter-converter.js +385 -0
- package/dist/grouped-rules-converters/url-transform-converter.js +340 -0
- package/dist/index.js +30 -0
- package/dist/package.json.js +3 -0
- package/dist/re2-regexp/re2-validator.js +37 -0
- package/dist/re2-regexp/regex-validator-extension.js +30 -0
- package/dist/re2.wasm +0 -0
- package/dist/rule/option-names.js +65 -0
- package/dist/rule/rule-badfilter.js +81 -0
- package/dist/rule/rule-priority.js +88 -0
- package/dist/rule/rule-validator.js +455 -0
- package/dist/rule/rule.js +853 -0
- package/dist/rule/string-utils.js +49 -0
- package/dist/rule-converters/csp-converter.js +105 -0
- package/dist/rule-converters/regular-rule-converter.js +789 -0
- package/dist/rule-converters/remove-header-converter.js +97 -0
- package/dist/rule-converters/rules-converter.js +365 -0
- package/dist/rule-converters/rules-grouper.js +75 -0
- package/dist/rules-scanner/rules-scanner.js +136 -0
- package/dist/ruleset/metadata-rule.js +35 -0
- package/dist/ruleset/metadata-ruleset.js +162 -0
- package/dist/ruleset/rules-hash-map.js +71 -0
- package/dist/ruleset/ruleset-with-source-map.js +406 -0
- package/dist/ruleset/ruleset.js +54 -0
- package/dist/ruleset/source-map.js +283 -0
- package/dist/types/cli/convert-filters.d.ts +32 -0
- package/dist/types/cli/index.d.ts +7 -0
- package/dist/types/cli/utils.d.ts +19 -0
- package/dist/types/src/declarative-rule/declarative-rule.d.ts +32 -0
- package/dist/types/src/declarative-rule/header-info.d.ts +31 -0
- package/dist/types/src/declarative-rule/modify-header-info.d.ts +46 -0
- package/dist/types/src/declarative-rule/query-key-value.d.ts +24 -0
- package/dist/types/src/declarative-rule/query-transform.d.ts +21 -0
- package/dist/types/src/declarative-rule/redirect.d.ts +32 -0
- package/dist/types/src/declarative-rule/rule-action.d.ts +68 -0
- package/dist/types/src/declarative-rule/rule-condition.d.ts +262 -0
- package/dist/types/src/declarative-rule/url-transform.d.ts +69 -0
- package/dist/types/src/errors/conversion-errors/empty-domains-error.d.ts +21 -0
- package/dist/types/src/errors/conversion-errors/empty-resources-error.d.ts +21 -0
- package/dist/types/src/errors/conversion-errors/index.d.ts +27 -0
- package/dist/types/src/errors/conversion-errors/invalid-declarative-rule-error.d.ts +30 -0
- package/dist/types/src/errors/conversion-errors/unsupported-modifier-error.d.ts +20 -0
- package/dist/types/src/errors/conversion-errors/unsupported-regexp-error.d.ts +23 -0
- package/dist/types/src/errors/converter-options-errors/empty-or-negative-number-of-rules-error.d.ts +13 -0
- package/dist/types/src/errors/converter-options-errors/index.d.ts +23 -0
- package/dist/types/src/errors/converter-options-errors/negative-number-of-rules-error.d.ts +13 -0
- package/dist/types/src/errors/converter-options-errors/resources-path-error.d.ts +13 -0
- package/dist/types/src/errors/limitation-errors/index.d.ts +27 -0
- package/dist/types/src/errors/limitation-errors/max-scanned-rules-error.d.ts +18 -0
- package/dist/types/src/errors/limitation-errors/too-many-error.d.ts +33 -0
- package/dist/types/src/errors/limitation-errors/too-many-regexp-rules-error.d.ts +21 -0
- package/dist/types/src/errors/limitation-errors/too-many-rules-error.d.ts +21 -0
- package/dist/types/src/errors/limitation-errors/too-many-unsafe-rules-error.d.ts +21 -0
- package/dist/types/src/errors/unavailable-sources-errors/unavailable-filter-source-error.d.ts +19 -0
- package/dist/types/src/errors/unavailable-sources-errors/unavailable-ruleset-source-error.d.ts +19 -0
- package/dist/types/src/filter/filter.d.ts +74 -0
- package/dist/types/src/filter/types.d.ts +45 -0
- package/dist/types/src/filter-converter/conversion-result.d.ts +35 -0
- package/dist/types/src/filter-converter/filter-converter-options.d.ts +81 -0
- package/dist/types/src/filter-converter/filter-converter.d.ts +197 -0
- package/dist/types/src/index.d.ts +37 -0
- package/dist/types/src/rule/rule-types.d.ts +33 -0
- package/dist/types/src/rule/rule-validator.d.ts +185 -0
- package/dist/types/src/rule/rule.d.ts +269 -0
- package/dist/types/src/ruleset/metadata-ruleset.d.ts +128 -0
- package/dist/types/src/ruleset/rules-hash-map.d.ts +70 -0
- package/dist/types/src/ruleset/ruleset-with-source-map.d.ts +318 -0
- package/dist/types/src/ruleset/ruleset.d.ts +86 -0
- package/dist/types/src/ruleset/source-map.d.ts +45 -0
- package/dist/types/src/ruleset/types.d.ts +68 -0
- package/dist/types/src/utils/is-safe-rule.d.ts +20 -0
- package/dist/types/src/utils/ruleset-utils.d.ts +45 -0
- package/dist/types/src/version.d.ts +6 -0
- package/dist/url-transform-converter.js +338 -0
- package/dist/utils/error.js +22 -0
- package/dist/utils/is-safe-rule.js +25 -0
- package/dist/utils/lazy-loader.js +116 -0
- package/dist/utils/lazy.js +50 -0
- package/dist/utils/ruleset-utils.js +76 -0
- package/dist/utils/string.js +180 -0
- package/dist/utils/valibot.js +74 -0
- package/dist/version.js +7 -0
- package/package.json +122 -0
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
import { DeclarativeRule } from '../declarative-rule/declarative-rule.js';
|
|
2
|
+
import { IFilter } from '../filter/types.js';
|
|
3
|
+
import { Rule } from '../rule/rule.js';
|
|
4
|
+
import { IRulesHashMap } from './rules-hash-map.js';
|
|
5
|
+
import { SourceRuleIdxAndFilterId, ISourceMap } from './source-map.js';
|
|
6
|
+
import { IBaseRuleset, SourceRuleAndFilterId } from './types.js';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* @file Contains the RulesetWithSourceMap class and IRulesetWithSourceMap
|
|
10
|
+
* interface for managing converted declarative rules with source maps,
|
|
11
|
+
* hash maps, lazy loading, and full serialization.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Extended rule set interface for the advanced conversion flow
|
|
16
|
+
* ({@link FilterConverter} with `withSourceMap: true`) with source-map support,
|
|
17
|
+
* hash maps, lazy loading, and full serialization.
|
|
18
|
+
*/
|
|
19
|
+
interface IRulesetWithSourceMap extends IBaseRuleset {
|
|
20
|
+
/**
|
|
21
|
+
* Returns a list of pairs of source text rules and their filter identifiers
|
|
22
|
+
* for a given declarative rule identifier.
|
|
23
|
+
*
|
|
24
|
+
* @param declarativeRuleId {@link DeclarativeRule|declarative rule} Id.
|
|
25
|
+
*
|
|
26
|
+
* @returns Promise with list of source rules.
|
|
27
|
+
*
|
|
28
|
+
* @throws Error {@link UnavailableRulesetSourceError} if rule set source
|
|
29
|
+
* is not available.
|
|
30
|
+
*/
|
|
31
|
+
getRulesById(declarativeRuleId: number): Promise<SourceRuleAndFilterId[]>;
|
|
32
|
+
/**
|
|
33
|
+
* Returns list of network rules with `$badfilter` option.
|
|
34
|
+
*
|
|
35
|
+
* @returns List of network rules with `$badfilter` option.
|
|
36
|
+
*/
|
|
37
|
+
getBadFilterRules(): Rule[];
|
|
38
|
+
/**
|
|
39
|
+
* Returns dictionary with hashes of all ruleset's source rules.
|
|
40
|
+
*
|
|
41
|
+
* @returns Dictionary with hashes of all ruleset's source rules.
|
|
42
|
+
*/
|
|
43
|
+
getRulesHashMap(): IRulesHashMap;
|
|
44
|
+
/**
|
|
45
|
+
* For provided source returns list of ids of converted declarative rule.
|
|
46
|
+
*
|
|
47
|
+
* @param source Source rule index and filter id.
|
|
48
|
+
*
|
|
49
|
+
* @returns List of ids of converted declarative rule.
|
|
50
|
+
*/
|
|
51
|
+
getDeclarativeRulesIdsBySourceRuleIndex(source: SourceRuleIdxAndFilterId): Promise<number[]>;
|
|
52
|
+
/**
|
|
53
|
+
* Returns list of ruleset's declarative rules (async, lazy loaded).
|
|
54
|
+
*
|
|
55
|
+
* @returns List of ruleset's declarative rules.
|
|
56
|
+
*/
|
|
57
|
+
getDeclarativeRules(): Promise<DeclarativeRule[]>;
|
|
58
|
+
/**
|
|
59
|
+
* Contains unsafe declarative rules which is separate from ruleset
|
|
60
|
+
* (async, lazy loaded).
|
|
61
|
+
*
|
|
62
|
+
* @returns List of unsafe declarative rules.
|
|
63
|
+
*/
|
|
64
|
+
getUnsafeRules(): Promise<DeclarativeRule[]>;
|
|
65
|
+
/**
|
|
66
|
+
* Unload ruleset content.
|
|
67
|
+
* This method can be used to free memory until the content is needed again.
|
|
68
|
+
*/
|
|
69
|
+
unloadContent(): void;
|
|
70
|
+
/**
|
|
71
|
+
* Serializes rule set to a single file.
|
|
72
|
+
*
|
|
73
|
+
* @param unsafeRules List of unsafe rules to add to the serialized output.
|
|
74
|
+
* Number of unsafe rules will be excluded from the counter of declarative
|
|
75
|
+
* rules in the serialized metadata.
|
|
76
|
+
* IMPORTANT: currently multiple filters in a single ruleset are not supported.
|
|
77
|
+
* @param prettyPrint Whether to pretty print the output. Default is `true`.
|
|
78
|
+
*
|
|
79
|
+
* @returns Serialized rule set.
|
|
80
|
+
*
|
|
81
|
+
* @throws Error {@link UnavailableRulesetSourceError} if rule set source is not available.
|
|
82
|
+
* @throws Error if counter of unsafe rules is not equal to the length of
|
|
83
|
+
* the provided `unsafeRules` array.
|
|
84
|
+
*/
|
|
85
|
+
serializeCompact(unsafeRules: DeclarativeRule[], prettyPrint?: boolean): Promise<string>;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Rule set content's provider for lazy load data.
|
|
89
|
+
*/
|
|
90
|
+
type RulesetContentProvider = {
|
|
91
|
+
loadSourceMap: () => Promise<ISourceMap>;
|
|
92
|
+
loadFilterList: () => Promise<IFilter[]>;
|
|
93
|
+
loadDeclarativeRules: () => Promise<DeclarativeRule[]>;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Serialized lazy data for a rule set.
|
|
97
|
+
*/
|
|
98
|
+
type SerializedRulesetLazyData = {
|
|
99
|
+
sourceMapRaw: string;
|
|
100
|
+
filterIds: number[];
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* Serialized data for a rule set.
|
|
104
|
+
*/
|
|
105
|
+
type SerializedRulesetData = {
|
|
106
|
+
regexpRulesCount: number;
|
|
107
|
+
unsafeRulesCount: number;
|
|
108
|
+
safeRulesCount: number;
|
|
109
|
+
rulesetHashMapRaw: string;
|
|
110
|
+
badFilterRulesRaw: string[];
|
|
111
|
+
unsafeRules: DeclarativeRule[];
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* A serialized rule set with primitive values separated into two parts: one is
|
|
115
|
+
* needed for instant creating ruleset, while the other is needed only when
|
|
116
|
+
* declarative filtering log is enabled - to find and display source rules from
|
|
117
|
+
* raw filters.
|
|
118
|
+
*/
|
|
119
|
+
type SerializedRuleset = {
|
|
120
|
+
id: string;
|
|
121
|
+
/**
|
|
122
|
+
* Metadata needed for instant creating ruleset.
|
|
123
|
+
*/
|
|
124
|
+
data: string;
|
|
125
|
+
/**
|
|
126
|
+
* Metadata needed for lazy load some data to ruleset to find and show
|
|
127
|
+
* source rules when declarative filtering log is enabled.
|
|
128
|
+
*/
|
|
129
|
+
lazyData: string;
|
|
130
|
+
};
|
|
131
|
+
/**
|
|
132
|
+
* A deserialized rule set with loaded data and provider for lazy loading data.
|
|
133
|
+
*/
|
|
134
|
+
type DeserializedRuleset = {
|
|
135
|
+
id: string;
|
|
136
|
+
/**
|
|
137
|
+
* Metadata needed for instant creating ruleset.
|
|
138
|
+
*/
|
|
139
|
+
data: SerializedRulesetData;
|
|
140
|
+
/**
|
|
141
|
+
* Metadata needed for lazy load some data to ruleset to find and show
|
|
142
|
+
* source rules when declarative filtering log is enabled.
|
|
143
|
+
*/
|
|
144
|
+
rulesetContentProvider: RulesetContentProvider;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Keeps converted declarative rules, counters of rules and source map for them.
|
|
148
|
+
*/
|
|
149
|
+
declare class RulesetWithSourceMap implements IRulesetWithSourceMap {
|
|
150
|
+
/**
|
|
151
|
+
* Id of rule set.
|
|
152
|
+
*/
|
|
153
|
+
private readonly id;
|
|
154
|
+
/**
|
|
155
|
+
* Array of converted declarative rules.
|
|
156
|
+
*/
|
|
157
|
+
private declarativeRules;
|
|
158
|
+
/**
|
|
159
|
+
* Number of safe declarative rules (unsafe rules are stored separately
|
|
160
|
+
* and not counted here).
|
|
161
|
+
*
|
|
162
|
+
* This is needed for the lazy version of the rule set,
|
|
163
|
+
* when content not loaded.
|
|
164
|
+
*/
|
|
165
|
+
private readonly safeRulesCount;
|
|
166
|
+
/**
|
|
167
|
+
* Converted declarative unsafe rules.
|
|
168
|
+
*/
|
|
169
|
+
private readonly unsafeRulesCount;
|
|
170
|
+
/**
|
|
171
|
+
* Array with unsafe declarative rules stored in the serialized metadata.
|
|
172
|
+
*
|
|
173
|
+
* This can be used to store unsafe rules inside metadata rule to use
|
|
174
|
+
* "skip review" feature in CWS.
|
|
175
|
+
*
|
|
176
|
+
* {@link https://developer.chrome.com/docs/webstore/skip-review/}.
|
|
177
|
+
*/
|
|
178
|
+
private readonly unsafeRules;
|
|
179
|
+
/**
|
|
180
|
+
* Converted declarative regexp rules.
|
|
181
|
+
*/
|
|
182
|
+
private readonly regexpRulesCount;
|
|
183
|
+
/**
|
|
184
|
+
* Source map for declarative rules.
|
|
185
|
+
*/
|
|
186
|
+
private sourceMap;
|
|
187
|
+
/**
|
|
188
|
+
* Dictionary which helps to fast find rule by its hash.
|
|
189
|
+
*/
|
|
190
|
+
private rulesHashMap;
|
|
191
|
+
/**
|
|
192
|
+
* List of network rules with $badfilter option.
|
|
193
|
+
*/
|
|
194
|
+
private badFilterRules;
|
|
195
|
+
/**
|
|
196
|
+
* Keeps array of source filter lists.
|
|
197
|
+
*/
|
|
198
|
+
private filterList;
|
|
199
|
+
/**
|
|
200
|
+
* The content provider of a rule set, is needed for lazy initialization.
|
|
201
|
+
* If request the source rules from rule set, the content provider will be
|
|
202
|
+
* called to load the source map, filter list and declarative rules list.
|
|
203
|
+
*/
|
|
204
|
+
private readonly rulesetContentProvider;
|
|
205
|
+
/**
|
|
206
|
+
* Lazy loader wrapping the content-provider call. Handles caching,
|
|
207
|
+
* concurrent-call coalescing, and safe unload-during-load.
|
|
208
|
+
*/
|
|
209
|
+
private readonly contentLoader;
|
|
210
|
+
/**
|
|
211
|
+
* Constructor of RulesetWithSourceMap.
|
|
212
|
+
*
|
|
213
|
+
* @param id Id of rule set.
|
|
214
|
+
* @param safeRulesCount Number of safe declarative rules
|
|
215
|
+
* (unsafe rules are tracked separately via {@link unsafeRulesCount}).
|
|
216
|
+
* @param unsafeRulesCount Number of unsafe rules.
|
|
217
|
+
* @param regexpRulesCount Number of regexp rules.
|
|
218
|
+
* @param rulesetContentProvider Rule set content provider.
|
|
219
|
+
* @param badFilterRules List of rules with $badfilter modifier.
|
|
220
|
+
* @param rulesHashMap Dictionary with hashes for all source rules.
|
|
221
|
+
* @param unsafeRules List of unsafe DNR rules.
|
|
222
|
+
*/
|
|
223
|
+
constructor(id: string, safeRulesCount: number, unsafeRulesCount: number, regexpRulesCount: number, rulesetContentProvider: RulesetContentProvider, badFilterRules: Rule[], rulesHashMap: IRulesHashMap, unsafeRules: DeclarativeRule[]);
|
|
224
|
+
/** @inheritdoc */
|
|
225
|
+
getUnsafeRules(): Promise<DeclarativeRule[]>;
|
|
226
|
+
/** @inheritdoc */
|
|
227
|
+
getSafeRulesCount(): number;
|
|
228
|
+
/** @inheritdoc */
|
|
229
|
+
getUnsafeRulesCount(): number;
|
|
230
|
+
/** @inheritdoc */
|
|
231
|
+
getRegexpRulesCount(): number;
|
|
232
|
+
/** @inheritdoc */
|
|
233
|
+
getId(): string;
|
|
234
|
+
/**
|
|
235
|
+
* Returns a list of pairs of source text rules and their filter identifiers
|
|
236
|
+
* for a given declarative rule identifier.
|
|
237
|
+
*
|
|
238
|
+
* @param declarativeRuleId {@link DeclarativeRule|declarative rule} Id.
|
|
239
|
+
*
|
|
240
|
+
* @returns Promise with list of source rules.
|
|
241
|
+
*
|
|
242
|
+
* @throws An error when filter is not found or filter content is unavailable.
|
|
243
|
+
*/
|
|
244
|
+
private findSourceRules;
|
|
245
|
+
/**
|
|
246
|
+
* Run inner lazy deserialization from rule set content provider to load
|
|
247
|
+
* data which is not needed on the creation of rule set:
|
|
248
|
+
* the source map, filter list and declarative rules list.
|
|
249
|
+
*
|
|
250
|
+
* @returns Promise resolving when the content has been loaded.
|
|
251
|
+
*/
|
|
252
|
+
private loadContent;
|
|
253
|
+
/** @inheritdoc */
|
|
254
|
+
unloadContent(): void;
|
|
255
|
+
/** @inheritdoc */
|
|
256
|
+
getRulesById(declarativeRuleId: number): Promise<SourceRuleAndFilterId[]>;
|
|
257
|
+
/** @inheritdoc */
|
|
258
|
+
getBadFilterRules(): Rule[];
|
|
259
|
+
/** @inheritdoc */
|
|
260
|
+
getRulesHashMap(): IRulesHashMap;
|
|
261
|
+
/** @inheritdoc */
|
|
262
|
+
getDeclarativeRulesIdsBySourceRuleIndex(source: SourceRuleIdxAndFilterId): Promise<number[]>;
|
|
263
|
+
/** @inheritdoc */
|
|
264
|
+
getDeclarativeRules(): Promise<DeclarativeRule[]>;
|
|
265
|
+
/**
|
|
266
|
+
* For provided source rule and filter id return network rule.
|
|
267
|
+
* This method is needed for checking the applicability of $badfilter after
|
|
268
|
+
* a fast-check of rules by comparing only hashes. Afterward, we should
|
|
269
|
+
* build the 'full' Network rule from provided source, not just the hash,
|
|
270
|
+
* to determine the applicability of $badfilter.
|
|
271
|
+
*
|
|
272
|
+
* @param source Source rule and filter id.
|
|
273
|
+
*
|
|
274
|
+
* @returns List of {@link Rule | network rules}.
|
|
275
|
+
*/
|
|
276
|
+
static getRuleBySourceRule(source: SourceRuleAndFilterId): Rule[];
|
|
277
|
+
/**
|
|
278
|
+
* Deserializes rule set to primitives values with lazy load.
|
|
279
|
+
*
|
|
280
|
+
* @param id Id of rule set.
|
|
281
|
+
* @param rawData An item of {@link SerializedRulesetData} for instant
|
|
282
|
+
* creating ruleset. It contains counters for regular declarative and regexp
|
|
283
|
+
* declarative rules, a map of hashes for all rules, and a list of rules
|
|
284
|
+
* with the `$badfilter` modifier.
|
|
285
|
+
* @param loadLazyData An item of {@link SerializedRulesetLazyData} for lazy
|
|
286
|
+
* loading ruleset data to find and display source rules when declarative
|
|
287
|
+
* filtering log is enabled. It includes a map of sources for all rules,
|
|
288
|
+
* a list of declarative rules, and a list of source filter IDs.
|
|
289
|
+
* @param loadDeclarativeRules Loader for ruleset's declarative rules from
|
|
290
|
+
* raw file as a string.
|
|
291
|
+
* @param filterList List of {@link IFilter}.
|
|
292
|
+
*
|
|
293
|
+
* @returns Deserialized rule set.
|
|
294
|
+
*
|
|
295
|
+
* @throws Error {@link UnavailableRulesetSourceError} if rule set source
|
|
296
|
+
* is not available.
|
|
297
|
+
*/
|
|
298
|
+
static deserialize(id: string, rawData: string, loadLazyData: () => Promise<string>, loadDeclarativeRules: () => Promise<string>, filterList: IFilter[]): Promise<DeserializedRuleset>;
|
|
299
|
+
/**
|
|
300
|
+
* Helper method to get serialized rule set data.
|
|
301
|
+
*
|
|
302
|
+
* @param unsafeRules List of unsafe rules to add to the serialized output.
|
|
303
|
+
*
|
|
304
|
+
* @returns Serialized rule set data.
|
|
305
|
+
*/
|
|
306
|
+
private getSerializedRulesetData;
|
|
307
|
+
/**
|
|
308
|
+
* Helper method to get serialized rule set lazy data.
|
|
309
|
+
*
|
|
310
|
+
* @returns Serialized rule set lazy data.
|
|
311
|
+
*/
|
|
312
|
+
private getSerializedRulesetLazyData;
|
|
313
|
+
/** @inheritdoc */
|
|
314
|
+
serializeCompact(unsafeRules: DeclarativeRule[], prettyPrint?: boolean): Promise<string>;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
export { RulesetWithSourceMap };
|
|
318
|
+
export type { DeserializedRuleset, IRulesetWithSourceMap, RulesetContentProvider, SerializedRuleset, SerializedRulesetData, SerializedRulesetLazyData };
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { DeclarativeRule } from '../declarative-rule/declarative-rule.js';
|
|
2
|
+
import { IBaseRuleset } from './types.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* @file Contains the {@link IRuleset} interface and the {@link Ruleset} class
|
|
6
|
+
* for the simple conversion flow ({@link FilterConverter}).
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Extended rule set interface for the simple conversion flow
|
|
11
|
+
* ({@link FilterConverter}). Adds synchronous access to declarative rules and
|
|
12
|
+
* serialization on top of the base {@link IBaseRuleset}.
|
|
13
|
+
*/
|
|
14
|
+
interface IRuleset extends IBaseRuleset {
|
|
15
|
+
/**
|
|
16
|
+
* Returns list of ruleset's declarative rules.
|
|
17
|
+
*
|
|
18
|
+
* @returns List of ruleset's declarative rules.
|
|
19
|
+
*/
|
|
20
|
+
getDeclarativeRules(): DeclarativeRule[];
|
|
21
|
+
/**
|
|
22
|
+
* Serializes the rule set to a plain JSON string of declarative rules.
|
|
23
|
+
*
|
|
24
|
+
* @returns Serialized declarative rules as a JSON string.
|
|
25
|
+
*/
|
|
26
|
+
serialize(): string;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Rule set that holds converted declarative rules in memory without
|
|
30
|
+
* source maps, hash maps, or lazy loading. Implements {@link IRuleset}
|
|
31
|
+
* and is returned by the simple conversion flow ({@link FilterConverter}).
|
|
32
|
+
*/
|
|
33
|
+
declare class Ruleset implements IRuleset {
|
|
34
|
+
/**
|
|
35
|
+
* Id of rule set.
|
|
36
|
+
*/
|
|
37
|
+
private readonly id;
|
|
38
|
+
/**
|
|
39
|
+
* Array of converted declarative rules.
|
|
40
|
+
*/
|
|
41
|
+
private readonly declarativeRules;
|
|
42
|
+
/**
|
|
43
|
+
* Number of safe declarative rules (excludes unsafe rules).
|
|
44
|
+
*/
|
|
45
|
+
private readonly safeRulesCount;
|
|
46
|
+
/**
|
|
47
|
+
* Number of converted declarative unsafe rules.
|
|
48
|
+
*/
|
|
49
|
+
private readonly unsafeRulesCount;
|
|
50
|
+
/**
|
|
51
|
+
* Number of converted declarative regexp rules.
|
|
52
|
+
*/
|
|
53
|
+
private readonly regexpRulesCount;
|
|
54
|
+
/**
|
|
55
|
+
* Creates a new {@link Ruleset}.
|
|
56
|
+
*
|
|
57
|
+
* @param id Rule set identifier.
|
|
58
|
+
* @param declarativeRules All converted declarative rules.
|
|
59
|
+
*/
|
|
60
|
+
constructor(id: string, declarativeRules: DeclarativeRule[]);
|
|
61
|
+
/** @inheritdoc */
|
|
62
|
+
getId(): string;
|
|
63
|
+
/** @inheritdoc */
|
|
64
|
+
getSafeRulesCount(): number;
|
|
65
|
+
/** @inheritdoc */
|
|
66
|
+
getUnsafeRulesCount(): number;
|
|
67
|
+
/** @inheritdoc */
|
|
68
|
+
getRegexpRulesCount(): number;
|
|
69
|
+
/** @inheritdoc */
|
|
70
|
+
getDeclarativeRules(): DeclarativeRule[];
|
|
71
|
+
/** @inheritdoc */
|
|
72
|
+
serialize(): string;
|
|
73
|
+
/**
|
|
74
|
+
* Reconstructs a {@link Ruleset} from a JSON string produced by
|
|
75
|
+
* {@link serialize}.
|
|
76
|
+
*
|
|
77
|
+
* @param id Rule set identifier.
|
|
78
|
+
* @param json JSON string produced by {@link serialize}.
|
|
79
|
+
*
|
|
80
|
+
* @returns Reconstructed {@link Ruleset}.
|
|
81
|
+
*/
|
|
82
|
+
static deserialize(id: string, json: string): Ruleset;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export { Ruleset };
|
|
86
|
+
export type { IRuleset };
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface that contains the index number of
|
|
3
|
+
* the source rule and the filter id of the rule.
|
|
4
|
+
*/
|
|
5
|
+
interface SourceRuleIdxAndFilterId {
|
|
6
|
+
/**
|
|
7
|
+
* Index number of the source rule in the original filter list.
|
|
8
|
+
*/
|
|
9
|
+
sourceRuleIndex: number;
|
|
10
|
+
/**
|
|
11
|
+
* Filter ID of the source rule.
|
|
12
|
+
*/
|
|
13
|
+
filterId: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Interface for source map operations.
|
|
17
|
+
*/
|
|
18
|
+
interface ISourceMap {
|
|
19
|
+
/**
|
|
20
|
+
* Returns source filter id and source text rule id
|
|
21
|
+
* for provided declarative rule id.
|
|
22
|
+
*
|
|
23
|
+
* @param ruleId Converted rule id.
|
|
24
|
+
*
|
|
25
|
+
* @returns List of pairs: source filter id and source rule id.
|
|
26
|
+
*/
|
|
27
|
+
getByDeclarativeRuleId(ruleId: number): SourceRuleIdxAndFilterId[];
|
|
28
|
+
/**
|
|
29
|
+
* Returns ids of converted declarative rules for provided pairs of source
|
|
30
|
+
* filter id and source text rule.
|
|
31
|
+
*
|
|
32
|
+
* @param source Pair of source rule and filter id.
|
|
33
|
+
*
|
|
34
|
+
* @returns List of ids of converted declarative rules.
|
|
35
|
+
*/
|
|
36
|
+
getBySourceRuleIndex(source: SourceRuleIdxAndFilterId): number[];
|
|
37
|
+
/**
|
|
38
|
+
* Serializes source map to JSON string.
|
|
39
|
+
*
|
|
40
|
+
* @returns JSON string.
|
|
41
|
+
*/
|
|
42
|
+
serialize(): string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export type { ISourceMap, SourceRuleIdxAndFilterId };
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file Shared types and the base ruleset interface used across both the
|
|
3
|
+
* simple ({@link IRuleset}) and source-map ({@link IRulesetWithSourceMap})
|
|
4
|
+
* conversion flows.
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* The OriginalSource contains the text of the original rule and the filter
|
|
8
|
+
* identifier of that rule.
|
|
9
|
+
*/
|
|
10
|
+
type SourceRuleAndFilterId = {
|
|
11
|
+
/**
|
|
12
|
+
* Text of the original source rule.
|
|
13
|
+
*/
|
|
14
|
+
sourceRule: string;
|
|
15
|
+
/**
|
|
16
|
+
* Identifier of the filter list that contains this rule.
|
|
17
|
+
*/
|
|
18
|
+
filterId: number;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Describes object of ruleset id with list of ids of declarative rules. Needs
|
|
22
|
+
* to disable declarative rules from static ruleset by applying $badfilter rules
|
|
23
|
+
* from dynamic rulesets.
|
|
24
|
+
*/
|
|
25
|
+
type UpdateStaticRulesOptions = {
|
|
26
|
+
/**
|
|
27
|
+
* Identifier of the static ruleset.
|
|
28
|
+
*/
|
|
29
|
+
rulesetId: string;
|
|
30
|
+
/**
|
|
31
|
+
* List of declarative rule IDs to disable in the static ruleset.
|
|
32
|
+
*/
|
|
33
|
+
disableRuleIds: number[];
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Shared base interface for any rule set holding converted declarative rules.
|
|
37
|
+
* Contains only the counters and identifier common to both the simple and
|
|
38
|
+
* source-map conversion flows. Use {@link IRuleset} or
|
|
39
|
+
* {@link IRulesetWithSourceMap} for flow-specific methods.
|
|
40
|
+
*/
|
|
41
|
+
interface IBaseRuleset {
|
|
42
|
+
/**
|
|
43
|
+
* Number of safe declarative rules (excludes unsafe rules).
|
|
44
|
+
*
|
|
45
|
+
* @returns Number of safe declarative rules.
|
|
46
|
+
*/
|
|
47
|
+
getSafeRulesCount(): number;
|
|
48
|
+
/**
|
|
49
|
+
* Number of converted declarative unsafe rules.
|
|
50
|
+
*
|
|
51
|
+
* @returns Number of converted declarative unsafe rules.
|
|
52
|
+
*/
|
|
53
|
+
getUnsafeRulesCount(): number;
|
|
54
|
+
/**
|
|
55
|
+
* Number of converted declarative regexp rules.
|
|
56
|
+
*
|
|
57
|
+
* @returns Number of converted declarative regexp rules.
|
|
58
|
+
*/
|
|
59
|
+
getRegexpRulesCount(): number;
|
|
60
|
+
/**
|
|
61
|
+
* Returns rule set id.
|
|
62
|
+
*
|
|
63
|
+
* @returns Rule set id.
|
|
64
|
+
*/
|
|
65
|
+
getId(): string;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export type { IBaseRuleset, SourceRuleAndFilterId, UpdateStaticRulesOptions };
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { DeclarativeRule } from '../declarative-rule/declarative-rule.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @file Separate file for the `isSafeRule` function, because it can be used
|
|
5
|
+
* outside of the declarative converter to check if a rule is safe, e.g. for
|
|
6
|
+
* passing rules to "skip review" in CWS.
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Checks whether the declarative rule is safe.
|
|
11
|
+
*
|
|
12
|
+
* @see {@link https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest#safe_rules}
|
|
13
|
+
*
|
|
14
|
+
* @param rule Declarative rule to check.
|
|
15
|
+
*
|
|
16
|
+
* @returns True if the rule is safe, otherwise false.
|
|
17
|
+
*/
|
|
18
|
+
declare function isSafeRule(rule: DeclarativeRule): boolean;
|
|
19
|
+
|
|
20
|
+
export { isSafeRule };
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @file Utility functions for constructing and parsing rule set IDs and paths.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Prefix used for ruleset names and IDs.
|
|
6
|
+
*/
|
|
7
|
+
declare const RULESET_NAME_PREFIX = "ruleset_";
|
|
8
|
+
/**
|
|
9
|
+
* Extension for ruleset files.
|
|
10
|
+
*/
|
|
11
|
+
declare const RULESET_FILE_EXT = ".json";
|
|
12
|
+
/**
|
|
13
|
+
* Ensures a rule set ID has the `ruleset_` prefix.
|
|
14
|
+
*
|
|
15
|
+
* @param rulesetId Rule set ID (number or string).
|
|
16
|
+
*
|
|
17
|
+
* @returns Rule set ID with the prefix.
|
|
18
|
+
*/
|
|
19
|
+
declare function getRulesetId(rulesetId: string | number): string;
|
|
20
|
+
/**
|
|
21
|
+
* Returns the file path for a rule set.
|
|
22
|
+
*
|
|
23
|
+
* Uses forward slashes as path separator (browser-safe).
|
|
24
|
+
*
|
|
25
|
+
* @param rulesetId Rule set ID (number or string).
|
|
26
|
+
* @param baseDir Optional base directory.
|
|
27
|
+
*
|
|
28
|
+
* @returns Path to the rule set JSON file.
|
|
29
|
+
*/
|
|
30
|
+
declare function getRulesetPath(rulesetId: string | number, baseDir?: string): string;
|
|
31
|
+
/**
|
|
32
|
+
* Extracts the numeric filter ID from a rule set ID or path.
|
|
33
|
+
*
|
|
34
|
+
* Accepted formats:
|
|
35
|
+
* - `ruleset_<id>`
|
|
36
|
+
* - `ruleset_<id>.json`
|
|
37
|
+
* - `<path>/ruleset_<id>.json`.
|
|
38
|
+
*
|
|
39
|
+
* @param rulesetId The rule set ID or path to parse.
|
|
40
|
+
*
|
|
41
|
+
* @returns The numeric filter ID, or `null` if it cannot be extracted.
|
|
42
|
+
*/
|
|
43
|
+
declare function extractRulesetId(rulesetId: string): number | null;
|
|
44
|
+
|
|
45
|
+
export { RULESET_FILE_EXT, RULESET_NAME_PREFIX, extractRulesetId, getRulesetId, getRulesetPath };
|