Skip to content

Commit

Permalink
Pull request #615: AG-24755 replace node api related deps with isomor…
Browse files Browse the repository at this point in the history
…phic alternative, remove node polyfills from dist

Merge in ADGUARD-FILTERS/tsurlfilter from feature/AG-24755 to master

Squashed commit of the following:

commit 525ce02
Merge: 6013f4c 8fc2083
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 17:00:09 2023 +0300

    resolve merge conflicts

commit 6013f4c
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 16:25:56 2023 +0300

    update tsurlfilter build

commit 7ce95de
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 16:25:06 2023 +0300

    update examples

commit bb7f16a
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 12:34:12 2023 +0300

    update deps

commit ceb391b
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 11:57:34 2023 +0300

    update adguard api example

commit 85d4e4c
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 10:55:39 2023 +0300

    update adguard-api dist

commit a7be797
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 10:54:44 2023 +0300

    update changelogs

commit a7f6a30
Author: Vladimir Zhelvis <[email protected]>
Date:   Thu Aug 10 10:53:53 2023 +0300

    update adguard-api build

commit 1eba59e
Author: Vladimir Zhelvis <[email protected]>
Date:   Wed Aug 9 20:07:16 2023 +0300

    update tswebextension build

commit f198d6d
Author: Vladimir Zhelvis <[email protected]>
Date:   Wed Aug 9 19:34:16 2023 +0300

    update tsurlfilter test configuration

commit 17d5ce6
Author: Vladimir Zhelvis <[email protected]>
Date:   Wed Aug 9 19:29:24 2023 +0300

    replace node api related deps with isomorphic alternative, remove node polyfills from dist
  • Loading branch information
zhelvis committed Aug 10, 2023
1 parent 8fc2083 commit 76ab11e
Show file tree
Hide file tree
Showing 36 changed files with 56,695 additions and 56,555 deletions.
5 changes: 3 additions & 2 deletions packages/adguard-api/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ 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]
## [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.0.62`
- Update `@adguard/tswebextension` to `v0.3.9`
- Update `@adguard/assistant` to `v4.3.70`


## [1.2.2] - 2022-12-02
Expand Down
20 changes: 13 additions & 7 deletions packages/adguard-api/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AdGuard API
**Version: 1.2.0**
**Version: 1.3.0**

AdGuard API is filtering library, provided following features:

Expand Down Expand Up @@ -33,13 +33,13 @@ AdGuard API is filtering library, provided following features:
The library code can be loaded either via `script` tag or as an `npm` module.
### Installation via `script` tag

1. Copy `adguard-api.js` and `adguard-content.js` scripts from `dist` to the directory near `manifest.json`
1. Copy `adguard-api.js`, `adguard-content.js` and `adguard-assistant.js` scripts from `dist` to the directory near `manifest.json`

2. Create `adguard` directory near `manifest.json`

3. Place [web accessible resources](#required-web-accessible-resources) into `adguard` directory

4. Add AdGuard's content script to the manifest:
4. Add AdGuard's content scripts to the manifest:
```
{
"all_frames": true,
Expand Down Expand Up @@ -73,20 +73,26 @@ or
yarn add @adguard/api
```

1. Import `AdguardApi` class to background script
2. Import `AdguardApi` class to background script
```
import { AdguardApi } from "@adguard/api";
```

1. Import `adguard-contents` in top of you content script entry
3. Import `adguard-contents` in top of you content script entry

```
import '@adguard/api/content-script';
```

4. Add [web accessible resources](#required-web-accessible-resources) downloading in you build pipeline or load it manually
4. Import `adguard-assistant` in top of you assistant script entry

5. Setup manifest content-script with imported `adguard-contents` as follow
```
import '@adguard/api/assistant';
```

5. Add [web accessible resources](#required-web-accessible-resources) downloading in you build pipeline or load it manually

6. Setup manifest content-script with imported `adguard-contents` as follow

```
{
Expand Down
Loading

0 comments on commit 76ab11e

Please sign in to comment.