CHANGELOG.md

Scriptlets and Redirect Resources Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.11.27 - 2024-08-29

Added

• reload option for trusted-click-element scriptlet #301
• support for matching line number in abort-on-stack-trace scriptlet when inlineScript or injectedScript option is used #439
• new values to set-cookie and set-cookie-reload scriptlets: checked, unchecked #444
• new values to set-local-storage-item and set-session-storage-item scriptlets: allowed, denied #445
• UBO aliases noop-vast2.xml, noop-vast3.xml, and noop-vast4.xml for correspondent AdGuard redirects
• new field uniqueId to scriptlet configuration, allowing scriptlets to be executed only once per context

Changed

• UBO alias noop-vmap1.0.xml for noopvmap-1.0 redirect is replaced by noop-vmap1.xml

Fixed

• issue with modifying RegExp.$1, …, RegExp.$9 values in log-on-stack-trace and abort-on-stack-trace scriptlets #384

v1.11.16 - 2024-08-01

Added

• trusted-set-session-storage-item scriptlet #426
• new values to set-cookie and set-cookie-reload scriptlets: essential, nonessential #436
• $currentISODate$ as a new possible value to set-cookie, set-cookie-reload, set-local-storage-item and set-session-storage-item scriptlets #435

Fixed

• issue with re-adding element after removing it in trusted-create-element scriptlet #434
• trusted-click-element scriptlet does not click on an element that is already in the DOM #437

v1.11.6 - 2024-07-08

Added

• new values to set-cookie and set-cookie-reload scriptlets: hide, hidden #433
• new values to set-local-storage-item and set-session-storage-item scriptlets: accept, accepted, reject, rejected #429
• ability to log original and modified content in trusted-replace-node-text, xml-prune, m3u-prune, trusted-replace-fetch-response and trusted-replace-xhr-response scriptlets #411

Changed

• Log message format CoreLibs#180

v1.11.1 - 2024-06-13

Added

• trusted-dispatch-event scriptlet #382
• trusted-replace-outbound-text scriptlet #410
• ability to click on the element with specified text in trusted-click-element scriptlet #409
• ability to click element in closed shadow root in trusted-click-element scriptlet #423
• isRedirectResourceCompatibleWithAdg() method to check compatibility of redirect resources with AdGuard without needing the full rule text #420

Deprecated

• ruleText option in the IConfiguration

Fixed

• set-attr value cannot be set to minimum 0 and maximum 32767 possible value #425

v1.10.25 - 2024-03-28

Added

• trusted-suppress-native-method scriptlet #383
• json-prune-fetch-response scriptlet #361
• json-prune-xhr-response scriptlet #360
• href-sanitizer scriptlet #327
• no-protected-audience scriptlet #395
• The ability for prevent-fetch scriptlet to set cors as a response type #394
• The ability for trusted-click-element scriptlet to click inside open shadow doms #323
• Domain value for setting cookie scriptlets #389
• Multiple redirects can now be used as scriptlets #300:
  • amazon-apstag
  • didomi-loader
  • fingerprintjs2
  • fingerprintjs3
  • gemius
  • google-analytics
  • google-analytics-ga
  • google-ima3
  • googlesyndication-adsbygoogle
  • googletagservices-gpt
  • matomo
  • metrika-yandex-tag
  • metrika-yandex-watch
  • naver-wcslog
  • pardot-1.0
  • prebid
  • scorecardresearch-beacon

Changed

• Validation of scriptlet rules with no name and args for multiple scriptlet exception rules #377
• Cookie name is not encoded by cookie setting scriptlets #408
• Increased the possible numeric value up to 32767 for set-cookie and set-cookie-reload scriptlets #388

Fixed

• UBO→ADG conversion of $remove$ scriptlet param #404
• set-constant scriptlet not setting a constant over falsy values #403

v1.10.1 - 2024-02-12

Added

• call-nothrow scriptlet #333
• spoof-css scriptlet #317
• trusted-create-element scriptlet #278
• trusted-set-attr scriptlet #281
• Ability of set-attr to set an attribute value as a copy of another attribute value of the same element.
• UBO alias for set-cookie-reload scriptlet #332
• New values t, f, necessary, required for set-cookie and set-cookie-reload #379

v1.9.105 - 2023-12-25

Added

• OmidVerificationVendor object to google-ima3 redirect #353
• ga.q (queued commands) to google-analytics redirect #355

Fixed

• addEventListener in EventHandler in google-ima3 redirect, now it binds context to callback #353
• AdDisplayContainer constructor in google-ima3 redirect, now it adds div element to container #353
• getInnerError method in google-ima3 redirect, now it returns null #353

v1.9.101 - 2023-11-30

Added

• emptyStr value for responseBody in prevent-fetch scriptlet #364
• setPrivacySettings() method to googletagservices-gpt redirect #344
• UBO alias noop.json for noopjson redirect
• library version number to the exports #2237.

Changed

• prevent-fetch scriptlet, if responseType is set to opaque then now response body is set to null, status is set to 0 and statusText is set to '' #364

v1.9.96 - 2023-11-15

Added

• regular expression support for removing items in set-local-storage-item and set-session-storage-item scriptlets #256
• ability to set proxy trap in set-constant scriptlet #330

v1.9.91 - 2023-11-13

Added

• new trusted-prune-inbound-object scriptlet #372
• new values to set-cookie scriptlet: on, off, accepted, notaccepted, rejected, allowed, disallow, enable, enabled, disable, disabled #375
• new values to set-local-storage-item and set-session-storage-item scriptlets: on, off #366

Fixed

• issue with setting proxy trap every time when property is accessed in set-constant scriptlet #380
• issue with stack in evaldata-prune scriptlet #378
• issue with setting values to wrong properties in set-constant scriptlet #373

v1.9.83 - 2023-10-13

Added

• ABP alias for the log scriptlet

Fixed

• issue with trusted-replace-fetch-response scriptlet in case if data URL was used and properties was set by Object.defineProperty to deceive scriptlet #367
• issue with adding the same header value in trusted-replace-xhr-response scriptlet when it is used multiple times for the same request #359
• issue with not pruning in m3u-prune scriptlet if file contains carriage return #354
• issue with not overriding value in set-constant (only partially, for cases where single scriptlet is used) #330

v1.9.72 - 2023-08-25

Added

• conversion for scriptlets:
  • set-attr
  • set-cookie
  • set-local-storage-item
  • set-session-storage-item

v1.9.70 - 2023-08-21

Added

• support for XPath in xml-prune scriptlet #325
• conversion of UBO's $redirect priority to the converter

Fixed

• issue with stack in json-prune scriptlet #348
• issue with obligatoryProps in json-prune scriptlet #345

v1.9.62 - 2023-08-04

Fixed

• prevent-xhr closure bug on multiple requests #347

v1.9.61 - 2023-08-01

Added

• add convertRedirectNameToAdg() method to convert redirect names to ADG #346

v1.9.58 - 2023-07-27

Fixed

• escape commas in the params during conversion to ubo rules #343

v1.9.57 - 2023-07-21

Added

• ability to remove an item from storage in set-local-storage-item and set-session-storage-item scriptlets #338
• new values to set-cookie and set-cookie-reload scriptlets: Accept, Reject, y, n, N, No, allow, deny #336
• ability to use flags in regular expression scriptlet parameters #303

Changed

• predefined values of set-cookie and set-cookie-reload are now case-insensitive #342

Fixed

• issue with overwriting google.ima value if it was already set #331
• issue with printing unnecessary logs to the console in log-addEventListener scriptlet #335
• error throwing in prevent-fetch and prevent-xhr scriptlets when a request is blocked #334

v1.9.37 - 2023-06-06

Added

• new evaldata-prune scriptlet #322
• new trusted-replace-node-text scriptlet #319
• new remove-node-text scriptlet #318
• ability for prevent-element-src-loading scriptlet to prevent inline onerror and match link tag #276
• new special value modifiers for set-constant #316

Changed

• trusted-set-cookie and trusted-set-cookie-reload scriptlets to not encode cookie name and value #311
• improved prevent-fetch: if responseType is not specified, original response type is returned instead of default #297

Fixed

• issue with pruning when addEventListener was used before calling send() method in m3u-prune and xml-prune scriptlets #315
• issue with updateTargetingFromMap() method in googletagservices-gpt redirect #293
• website reloading if $now$/$currentDate$ value is used in trusted-set-cookie-reload scriptlet #291
• getResponseHeader() and getAllResponseHeaders() methods mock in prevent-xhr scriptlet #295

v1.9.7 - 2023-03-14

Added

• ability for trusted-click-element scriptlet to click element if cookie/localStorage item doesn't exist #298
• static delay between multiple clicks in trusted-click-element #284

Changed

• improved the convertScriptletToAdg() method — now it validates the input rule syntax if it is an ADG rule

Fixed

• issue with MutationObserver.disconnect() in trusted-click-element #284

v1.9.1 - 2023-03-07

Added

• new m3u-prune scriptlet #277
• true and false values for set-attr scriptlet #283
• UBO alias noop.css for noopcss redirect

Changed

• decreased the minimal value for the boost parameter to 0.001 for adjust-setTimeout and adjust-setInterval #262

Fixed

• prevent-element-src-loading throwing error if thisArg is undefined #270
• logging null in json-prune #282
• xml-prune: no pruning a request if new Request() is used, throwing an error while logging some requests #289
• improve performance of the isValidScriptletName() method

v1.8.2 - 2023-01-19

Added

• new trusted-set-constant scriptlet #137
• new inject-css-in-shadow-dom scriptlet #267
• throwFunc and noopCallbackFunc prop values for set-constant scriptlet
• recreateIframeForSlot method mock to googletagservices-gpt redirect #259

Changed

• add decimal delay matching for prevent-setInterval and prevent-setTimeout #247
• debug logging to include rule text when available
• getScriptletFunction calls to throw error on unknown scriptlet names

Fixed

• prevent-xhr and trusted-replace-xhr-response closure bug on multiple requests #261
• missing googletagmanager-gtm in compatibility table

v1.7.20 - 2022-12-26

Added

• isBlocking() method for Redirects class
• file field for redirect type

Fixed

• Redirects types.

v1.7.19 - 2022-12-22

Fixed

• prevent-addEventListener and log-addEventListener loosing context when encountering already bound .addEventListener
• google-ima3 conversion

v1.7.14 - 2022-12-16

Added

• set-constant ADG→UBO conversion for emptyArr and emptyObj

v1.7.13 - 2022-12-13

Fixed

• isEmptyObject helper not counting prototype as an object property

v1.7.10 - 2022-12-07

Added

• new scriptlet trusted-set-cookie-reload

Fixed

• set-cookie-reload infinite page reloading #265
• breakage of prevent-element-src-loading due to window getting into apply wrapper #264
• spread of args bug at getXhrData call for trusted-replace-xhr-response
• request properties array not being served to getRequestData and parseMatchProps helpers

v1.7.3 - 2022-11-21

Added

• Trusted scriptlets with extended capabilities:

  • trusted-click-element #23
  • trusted-replace-xhr-response #202
  • trusted-replace-fetch-response
  • trusted-set-local-storage-item
  • trusted-set-cookie

• Scriptlets:

  • xml-prune #249

Changed

• Scriptlets:
  • prevent-element-src-loading #228
  • prevent-fetch #216
  • abort-on-stack-trace #201
  • abort-current-inline-script #251
  • set-cookie & set-cookie-reload
• Redirects:
  • google-ima3 #255
  • metrika-yandex-tag #254
  • googlesyndication-adsbygoogle #252