Merge pull request #37 from s-group-dev/beta

Migrate to Usercentrics Web CMP v3

Author: iiroj

.github/workflows/release.yml

@@ -3,8 +3,10 @@ name: Release
 on:
     push:
         tags:
-            # Semver-like tags "v1.0.0"
+            # Latest release tags, e.g. "v2.0.0"
             - 'v[0-9]+.[0-9]+.[0-9]+'
+            # Beta release tags, e.g. "v3.0.0-beta.1"
+            - 'v[0-9]+.[0-9]+.[0-9]+-beta.[0-9]+'
 
 jobs:
     Install:

.gitlab-ci.yml

@@ -2,19 +2,29 @@
 ## This package is mirrored to an internal NPM registry
 #
 
-image: node:18-alpine
+image: node:22-alpine
 
 stages:
     - release
 
-workflow:
+release-latest:
+    stage: release
     rules:
+        - if: '$CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-beta\.\d+/'
+          when: never
         - if: '$CI_COMMIT_TAG =~ /^v\d+.\d+.\d+/'
         - if: '$CI_MANUAL_TRIGGER'
+    script:
+        - npm ci
+        - npm run build
+        - npm publish
 
-release:
+release-beta:
     stage: release
+    rules:
+        - if: '$CI_COMMIT_TAG =~ /^v\d+.\d+.\d+-beta\.\d+/'
+        - if: '$CI_MANUAL_TRIGGER'
     script:
         - npm ci
         - npm run build
-        - npm publish
+        - npm publish --tag beta

CHANGELOG.md

@@ -1,3 +1,37 @@
+## [3.0.0-beta.4](https://github.com/s-group-dev/react-usercentrics/compare/v3.0.0-beta.3...v3.0.0-beta.4) (2025-04-03)
+
+### Features
+
+* export USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL constant ([0ce4253](https://github.com/s-group-dev/react-usercentrics/commit/0ce42538470e120c5cda4eab7a7e8566d251aac8))
+
+## [3.0.0-beta.3](https://github.com/s-group-dev/react-usercentrics/compare/v3.0.0-beta.2...v3.0.0-beta.3) (2025-03-31)
+
+### Features
+
+* add `getServiceInfo()` method ([df5383f](https://github.com/s-group-dev/react-usercentrics/commit/df5383fcaddef92b1ebd2dfe3e42608810e1672b))
+* add missing method `saveConsents()` to use with `updateServicesConsents()` ([20347c7](https://github.com/s-group-dev/react-usercentrics/commit/20347c7f325548b745651fe743e4500910652c24))
+
+### Bug Fixes
+
+* only throw in strict mode when service id missing ([8f03b2b](https://github.com/s-group-dev/react-usercentrics/commit/8f03b2b22c28d863ae8fc80481424b71af8c3e9a))
+
+## [3.0.0-beta.2](https://github.com/s-group-dev/react-usercentrics/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2025-03-31)
+
+### Bug Fixes
+
+* allow npm publish of beta tags ([9fba6ce](https://github.com/s-group-dev/react-usercentrics/commit/9fba6cecf8f7b8efa853838e8d37e7b4c409cbbb))
+
+## [3.0.0-beta.1](https://github.com/s-group-dev/react-usercentrics/compare/v2.0.0...v3.0.0-beta.1) (2025-03-31)
+
+### ⚠ BREAKING CHANGES
+
+* This package has migrated to Usercentrics Web CMP v3.
+Please read the provided migration guide in `MIGRATION.md`.
+
+### Features
+
+* migrate to Usercentrics Web CMP v3 ([e352e21](https://github.com/s-group-dev/react-usercentrics/commit/e352e212b824f2b2bddc229467a6f1fafcfef313))
+
 ## [2.0.0](https://github.com/s-group-dev/react-usercentrics/compare/v1.7.4...v2.0.0) (2025-03-28)
 
 ### ⚠ BREAKING CHANGES

MIGRATION.md

@@ -1,3 +1,24 @@
+## 3.0.0
+
+- The Usercentrics Web CMP has been updated to v3 and includes a lot of changes.
+    - Read more about the CMP v3 here: https://usercentrics.com/docs/web/v3/
+    - Read the Usercentrics Migration guide here for more context, although it shouldn't be relevant when using this package: https://usercentrics.com/docs/web/migration/migration-from-v2/
+- The `windowEvent` prop for `<UsercentricsProvider />` is no longer supported and should be removed. The CMP v3 handles this automatically with a new event internally.
+- The `uiVersion` prop for `<UsercentricsScript />` is no longer supported and should be removed. The CMP v3 loader script currently supports only the "latest" version.
+    - This also means that hard-coding a version number and its [Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) hash is no longer supported. Instead, use a random `nonce` value when implementing a [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP): https://usercentrics.com/docs/web/implementation/ui/optional-steps/#adding-a-nonce-to-the-script-tag
+- The `showSecondLayer()` util no longer supports passing a service id argument to directly open to the service info. Instead, use the new `showServiceDetails(serviceId: ServiceId)` util.
+- The `acceptService()` util has been replaced with `updateServicesConsents()` with a signature supporting multiple consents at a time.
+    - You will also need to call `saveConsents()` after updating them.
+- The `getServicesFromLocalStorage()` util has been replaced with `getConsentsFromLocalStorage()` with a different format.
+- Some utils and hooks have been removed because CMP v3 no longer supports them:
+    - Removed:
+        - `getServicesBaseInfo()`
+        - `useServiceInfo()`
+        - `getServicesFullInfo()`
+        - `useServiceFullInfo()`
+    - Added new `getServiceInfo()` util for getting service names and descriptions
+- All the utils are now `async` to match the CMP v3 implementations
+
 ## 2.0.0
 
 - No functional changes. This version is only released to sync the package version with the supported Usercentrics Web CMP v2 version.