Merge pull request #33 from s-group-dev/v2-bump

Bump major version to sync with Usercentrics Web CMP v2 version

Author: iiroj

MIGRATION.md

@@ -0,0 +1,7 @@
+## 2.0.0
+
+- No functional changes. This version is only released to sync the package version with the supported Usercentrics Web CMP v2 version.
+
+## 1.0.0
+
+- Initial release

README.md

@@ -2,17 +2,21 @@
 
 # `@s-group/react-usercentrics`
 
-React utils for interacting with the [Usercentrics Browser CMP](https://docs.usercentrics.com/#/browser-cmp).
+React utils for interacting with the [Usercentrics Web CMP](https://usercentrics.com/docs/web/intro/).
 
 ```
 npm install --save @s-group/react-usercentrics
 ```
 
 ## Motivation
 
-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.
+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.
 
-This package aims to be tiny and simple, and has 0 dependencies and an unpacked filesize of 47.2 kB KB.
+## Usercentrics Web CMP Version Support
+
+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/).
+
+The next major version `@s-group/react-usercentrics@3` will only support [Usercentrics Web CMP v3](https://usercentrics.com/docs/web/v3/).
 
 ## Setup
 
@@ -304,9 +308,9 @@ Returns basic info for specific Usercentrics service, or null if not found.
 
 The typing is _not complete_ and contains only the info used internally:
 
--   `id` of the service, autogenerated by Usercentrics
--   `name` of the service, configured in the admin interface
--   `consent.status` of the service
+- `id` of the service, autogenerated by Usercentrics
+- `name` of the service, configured in the admin interface
+- `consent.status` of the service
 
 See also https://docs.usercentrics.com/#/cmp-v2-ui-api?id=getservicesbaseinfo
 
@@ -331,10 +335,10 @@ This triggers an extra API call and also returns `null` while loading.
 
 The typing is _not complete_ and contains only the info used internally:
 
--   `id` of the service, autogenerated by Usercentrics
--   `name` of the service, configured in the admin interface
--   `consent.status` of the service
--   `description` text of the service
+- `id` of the service, autogenerated by Usercentrics
+- `name` of the service, configured in the admin interface
+- `consent.status` of the service
+- `description` text of the service
 
 See also https://docs.usercentrics.com/#/cmp-v2-ui-api?id=getservicesfullinfo
 

eslint.config.mjs

@@ -36,16 +36,10 @@ export default tseslint.config(
     eslintPluginPrettierRecommended,
     {
         plugins: {
-            /** "eslint-plugin-react-hooks" doesn't work with TypeScript */
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             'react-hooks': hooksPlugin,
             'simple-import-sort': simpleImportSort,
         },
-        /** "eslint-plugin-react-hooks" doesn't work with TypeScript */
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         rules: {
-            /** "eslint-plugin-react-hooks" doesn't work with TypeScript */
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             ...hooksPlugin.configs.recommended.rules,
             '@typescript-eslint/consistent-type-definitions': 'off',
             '@typescript-eslint/consistent-type-imports': ['error', { fixStyle: 'inline-type-imports' }],