Skip to content

Commit a4341d4

Browse files
committed
docs: bump major version to sync with Usercentrics Web CMP v2 version
BREAKING CHANGE: There are no functional changes. This version is only released to sync the package version with the supported Usercentrics Web CMP v2 version.
1 parent 3f0f3bc commit a4341d4

3 files changed

Lines changed: 24 additions & 12 deletions

File tree

MIGRATION.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## 2.0.0
2+
3+
- No functional changes. This version is only released to sync the package version with the supported Usercentrics Web CMP v2 version.
4+
5+
## 1.0.0
6+
7+
- Initial release

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,21 @@
22

33
# `@s-group/react-usercentrics`
44

5-
React utils for interacting with the [Usercentrics Browser CMP](https://docs.usercentrics.com/#/browser-cmp).
5+
React utils for interacting with the [Usercentrics Web CMP](https://usercentrics.com/docs/web/intro/).
66

77
```
88
npm install --save @s-group/react-usercentrics
99
```
1010

1111
## Motivation
1212

13-
While the official `@usercentrics/cmp-browser-sdk` npm module is very useful, it is unnecessarily large and would still require some utility functions built around it to be really useful when working in a React application. It has 10 dependencies and an unpacked filesize size of 1.7 MB.
13+
While the official `@usercentrics/cmp-browser-sdk` npm module is very useful, it is unnecessarily large and would still require some utility functions built around it to be really useful when working in a React application. This package aims to be tiny and simple, and have zero dependencies.
1414

15-
This package aims to be tiny and simple, and has 0 dependencies and an unpacked filesize of 47.2 kB KB.
15+
## Usercentrics Web CMP Version Support
16+
17+
The current major version `@s-group/react-usercentrics@2` (and previous v1) only supports the [Usercentrics Web CMP v2 (legacy)](https://usercentrics.com/docs/web/v2/).
18+
19+
The next major version `@s-group/react-usercentrics@3` will only support [Usercentrics Web CMP v3](https://usercentrics.com/docs/web/v3/).
1620

1721
## Setup
1822

@@ -304,9 +308,9 @@ Returns basic info for specific Usercentrics service, or null if not found.
304308

305309
The typing is _not complete_ and contains only the info used internally:
306310

307-
- `id` of the service, autogenerated by Usercentrics
308-
- `name` of the service, configured in the admin interface
309-
- `consent.status` of the service
311+
- `id` of the service, autogenerated by Usercentrics
312+
- `name` of the service, configured in the admin interface
313+
- `consent.status` of the service
310314

311315
See also https://docs.usercentrics.com/#/cmp-v2-ui-api?id=getservicesbaseinfo
312316

@@ -331,10 +335,10 @@ This triggers an extra API call and also returns `null` while loading.
331335

332336
The typing is _not complete_ and contains only the info used internally:
333337

334-
- `id` of the service, autogenerated by Usercentrics
335-
- `name` of the service, configured in the admin interface
336-
- `consent.status` of the service
337-
- `description` text of the service
338+
- `id` of the service, autogenerated by Usercentrics
339+
- `name` of the service, configured in the admin interface
340+
- `consent.status` of the service
341+
- `description` text of the service
338342

339343
See also https://docs.usercentrics.com/#/cmp-v2-ui-api?id=getservicesfullinfo
340344

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
},
1616
"types": "./dist/index.d.ts",
1717
"files": [
18-
"dist",
19-
"augmented.d.ts"
18+
"dist/",
19+
"augmented.d.ts",
20+
"MIGRATION.md"
2021
],
2122
"sideEffects": false,
2223
"scripts": {

0 commit comments

Comments
 (0)