prepare api v3.0.1

Squashed commit of the following: commit 52732c4 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Aug 28 18:18:09 2024 +0300 update changelog commit 65b2cb2 Author: Slava Leleka <v.leleka@adguard.com> Date: Wed Aug 28 18:17:17 2024 +0300 bump api version
AdguardTeam · Aug 28, 2024 · 80b3307 · 80b3307
1 parent 7b92285
commit 80b3307
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 11 deletions.
diff --git a/packages/adguard-api/CHANGELOG.md b/packages/adguard-api/CHANGELOG.md
@@ -5,12 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [3.0.1] - 2024-08-28
+
+### Changed
+
+- Updated `@adguard/tswebextension` to `^2.0.1`.
+
+[3.0.1]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v3.0.1
+
+
+## [3.0.0] - 2024-08-15
+
+### Changed
 
 - Updated `@adguard/tswebextension` to `^2.0.0`.
 - Filter lists are now stored in a pre-processed format, which makes the engine start more efficiently,
   since the engine does not need to convert or parse the rules.
 
+[3.0.0]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v3.0.0
+
+
 ## [2.1.5] - 2024-07-17
 
 ### Fixed
@@ -21,51 +35,76 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Update `@adguard/tswebextension` to `^1.0.30`.
 
+[2.1.5]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.1.5
+
+
 ## [2.1.4] - 2024-04-02
 
 ### Changed
+
 - Update `@adguard/tswebextension` to `^1.0.22`.
 - Update `@adguard/filters-downloader` to `^2.2.0`.
 
+[2.1.4]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.1.4
+
+
 ## [2.1.3] - 2024-02-15
 
 ### Changed
+
 - Update `@adguard/tswebextension` to `v1.0.14`.
 
+[2.1.3]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.1.3
+
+
 ## [2.1.2] - 2024-02-08
 
 ### Added
+
 - New private method `removeObsoletedFilters` to prevent usage of obsoleted filters.
 - New public event channel `AdguardApi.onFiltersDeletion`.
 
 ### Changed
+
 - `adguardApi.start` returns Promise with applied configuration with already removed
 obsoleted filters ids.
 
+[2.1.2]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.1.2
+
+
 ## [2.1.1] - 2023-12-01
 
 ### Added
-- [BREAKING CHANGE] New mandatory `filteringEnabled` configuration option that allows you to enable/disable filtering engine.
-- New `setFilteringEnabled` method that allows you to enable/disable filtering engine without engine re-initialization. See [documentation](README.md#setfilteringenabled) for details.
+
+- [BREAKING CHANGE] New mandatory `filteringEnabled` configuration option
+  that allows you to enable/disable filtering engine.
+- New `setFilteringEnabled` method that allows you to enable/disable filtering engine without engine re-initialization.
+  See [documentation](README.md#setfilteringenabled) for details.
 
 ### Changed
+
 - [BREAKING CHANGE] `AdguardApi.create` returns Promise.
 
+[2.1.1]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.1.1
+
+
 ## [2.0.1] - 2023-11-29
 
 ## Added
 
 - New `adguardApi.getHandlerMessage` method that returns the API message handler.
-- New `documentBlockingPageUrl` configuration option that allows you to specify a URL to the document blocking page. See [documentation](README.md#configuration) for details.
+- New `documentBlockingPageUrl` configuration option that allows you to specify a URL to the document blocking page.
+  See [documentation](README.md#configuration) for details.
 
 ### Changed
 
-- [BREAKING CHANGE] The API message listener is no longer initialized on API startup. Now you can use the `adguardApi.getHandlerMessage` method to get it and manually route messages to both the API and your application. See example in the [documentation](README.md#adguardapigetmessagehandler).
+- [BREAKING CHANGE] The API message listener is no longer initialized on API startup.
+  Now you can use the `adguardApi.getHandlerMessage` method to get it and manually route messages to both the API
+  and your application. See example in the [documentation](README.md#adguardapigetmessagehandler).
 - [BREAKING CHANGE] Drop support for UMD modules. Now only ESM is provided.
 - Update `@adguard/tswebextension` to `v0.4.8`.
 - Update `@adguard/filters-downloader` to `v1.1.23`.
 
-
 ### Removed
 
 - [BREAKING CHANGE] Pre-build js bundles.
@@ -74,72 +113,100 @@ obsoleted filters ids.
 
 - Fix missing type declarations.
 
+[2.0.1]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v2.0.1
+
 
 ## [1.3.4] - 2023-09-27
 
 ### Changed
 
 - Update `@adguard/tswebextension` to `v0.3.21`
 
+[1.3.4]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.3.4
+
 
 ## [1.3.3] - 2023-09-13
 
 ### Changed
 
 - Update `@adguard/tswebextension` to `v0.3.17`
 
+[1.3.3]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.3.3
+
 
 ## [1.3.2] - 2023-09-08
 
 ### Changed
 - Update `@adguard/tswebextension` to `v0.3.16`
 
+[1.3.2]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.3.2
 
 ## [1.3.1] - 2023-08-18
 
 ### Changed
+
 - Update `@adguard/tswebextension` to `v0.3.10`
 
+[1.3.1]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.3.1
+
 
 ## [1.3.0] - 2023-08-10
+
 ### Changed
+
 - [BREAKING CHANGE] Assistant script is separated and dynamically injected. You need to provide it in your project.
 - Update `@adguard/tswebextension` to `v0.3.9`
 - Update `@adguard/assistant` to `v4.3.70`
 
+[1.3.0]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.3.0
+
 
 ## [1.2.2] - 2022-12-02
+
 ### Added
+
 - Add source maps for bundles
 
 ### Changed
+
 - Fix filter version comparison bug
 
+[1.2.2]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.2.2
+
 
 ## [1.2.0] - 2022-11-25
+
 ### Added
+
 - `AdguardApi.create` static method for creating new `AdguardApi` instance.
 
 ### Changed
 
-- [BREAKING CHANGE] Global `adguardApi` instance was deleted. Export `AdguardApi` class instead and create new instance by `AdguardApi.create` static method
+- [BREAKING CHANGE] Global `adguardApi` instance was deleted.
+  Export `AdguardApi` class instead and create new instance by `AdguardApi.create` static method
 
+[1.2.0]: https://github.com/AdguardTeam/tsurlfilter/releases/tag/adguard-api-v1.2.0
 
-## [1.1.0] - 2022-11-12
+## 1.1.0 - 2022-11-12
 
 ### Changed
+
 - Add js rules execution guard for firefox
 
 
-## [1.0.0] - 2022-11-03
+## 1.0.0 - 2022-11-03
+
 ### Added
+
 - `adguardApi.getRulesCount` method for getting the number of rules that are currently loaded into the filtering engine
 - `adguardApi.onAssistantCreateRule` API for tracking Assistant rule apply
 - Typescript support
 - Adguard Api can be imported as an npm module
 
 ### Changed
-- [BREAKING CHANGE] Optional callback param was removed from `adguardApi.start`, `adguardApi.stop` and `adguardApi.configure` in favor of promises usage
+
+- [BREAKING CHANGE] Optional callback param was removed from `adguardApi.start`, `adguardApi.stop`
+  and `adguardApi.configure` in favor of promises usage
 - [BREAKING CHANGE] rename API configuration fields:
   - whitelist -> allowlist
   - blacklist -> blocklist

diff --git a/packages/adguard-api/package.json b/packages/adguard-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@adguard/api",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "This is a TypeScript library that implements AdGuard's extension API",
   "main": "dist/adguard-api.js",
   "files": [