@usercentrics/cmp-browser-sdk - npm Package Compare versions

Comparing version 4.36.0 to 4.37.0

dist/index.js

@@ -1,1 +0,1 @@
-export{e as API_COMMANDS,at as BUTTON_ALIGNMENT,aB as CLOSE_OPTION,aR as CONSENT_ACTION,aS as CONSENT_TYPE,aC as Core,as as DPS_DISPLAY_FORMAT,aU as FIRST_LAYER_VARIANT,aX as SECOND_LAYER_SIDE,ax as SECOND_LAYER_TRIGGER,aV as SECOND_LAYER_VARIANT,aY as TCF_DECISION_UI_LAYER,aW as THEME,aT as TRACKING_EVENT_TYPE,aD as UI_LAYER,aE as UI_VARIANT,aA as default,aF as isCcpaData,aG as isCcpaLabels,aH as isCcpaUI,aI as isDefaultData,aJ as isDefaultLabels,aK as isDefaultUI,aN as isNotPrivacyButtonLabels,aM as isPrivacyButtonLabels,aL as isPrivacyButtonUI,aO as isTcfData,aP as isTcfLabels,aQ as isTcfUI}from"./index-632c84e3.js";
+export{e as API_COMMANDS,au as BUTTON_ALIGNMENT,aC as CLOSE_OPTION,aS as CONSENT_ACTION,aT as CONSENT_TYPE,aD as Core,at as DPS_DISPLAY_FORMAT,aV as FIRST_LAYER_VARIANT,aY as SECOND_LAYER_SIDE,ay as SECOND_LAYER_TRIGGER,aW as SECOND_LAYER_VARIANT,aZ as TCF_DECISION_UI_LAYER,aX as THEME,aU as TRACKING_EVENT_TYPE,aE as UI_LAYER,aF as UI_VARIANT,aB as default,aG as isCcpaData,aH as isCcpaLabels,aI as isCcpaUI,aJ as isDefaultData,aK as isDefaultLabels,aL as isDefaultUI,aO as isNotPrivacyButtonLabels,aN as isPrivacyButtonLabels,aM as isPrivacyButtonUI,aP as isTcfData,aQ as isTcfLabels,aR as isTcfUI}from"./index-c7a005db.js";

dist/src/index.d.ts

@@ -65,2 +65,3 @@ import { AMP_CONSENT_ACTION, AMP_CONSENT_TYPE } from './services/AMP/enums/enums';
     private rulesetRule;
+    private gppData;
     /**
@@ -234,2 +235,12 @@ * @param ucId - Your unique Usercentrics Id - settingsId or rulesetId
     /**
+     * Mark the GPP Display as being hidden
+     * @category GPP
+     */
+    setGppDisplayHidden(): Promise<void>;
+    /**
+     * Mark the GPP Display as being visible
+     * @category GPP
+     */
+    setGppDisplayVisible(): Promise<void>;
+    /**
      * Mark the TCF UI as being open and trigger related TCF events.
@@ -236,0 +247,0 @@ * NOTE: Remember to call this ALWAYS when an end-user opens up your TCF UI!

dist/src/interfaces.d.ts

@@ -64,2 +64,7 @@ import { UserCountryData, UserSessionData } from './index.legacy';
     createTcfApiStub?: boolean;
+    /**
+     * Indicate if the GPP stub will be enabled on load time. We can not wait for this information to come from the
+     * settings, as by the GPP guidelines the __gpp needs to be exposed from the very start.
+     */
+    createGppStub?: boolean;
     /** When disabled, analytics will not track ui events */
@@ -66,0 +71,0 @@ disableTracking?: boolean;

dist/src/services/Api/interfaces/interfaces.legacy.d.ts

@@ -296,2 +296,3 @@ import { BUTTON_ALIGNMENT, DPS_DISPLAY_FORMAT, FIRST_LAYER_VARIANT, SECOND_LAYER_SIDE, SECOND_LAYER_TRIGGER, SECOND_LAYER_VARIANT } from '../../SettingsV2/enums';
     enablePoweredBy: boolean;
+    framework: string | null;
     googleConsentMode: boolean;
@@ -355,2 +356,3 @@ interactionAnalytics: boolean;
     };
+    framework: string | null;
     imprintUrl: string;
@@ -357,0 +359,0 @@ interactionAnalytics: boolean;

dist/src/services/SettingsV2/Data/CcpaData.d.ts

@@ -0,3 +1,3 @@
+import { CcpaData, LegalFramework } from './interfaces';
 import { CoreJsonResponse, DpsJsonResponse } from '../../Api/interfaces';
-import { CcpaData } from './interfaces';
 import DefaultData from './DefaultData';
@@ -16,3 +16,6 @@ import { LEGACY_CCPA_REGION } from '../../Api/enums';
     showOnPageLoad: boolean;
+    framework: string;
+    legalFramework: LegalFramework;
     getIsOptedOut(): boolean;
+    private getLegalFramework;
     getExplicitNotice(): boolean;
@@ -19,0 +22,0 @@ setCcpaStorage(isOptedOut: boolean, isNoticeGiven?: STRING_CHARACTER): void;

dist/src/services/SettingsV2/Data/interfaces.d.ts

@@ -67,2 +67,3 @@ import { ACMVendor, IdAndName, TCFData, TCFUserDecisions } from '../interfaces/TCF';
     showOnPageLoad: boolean;
+    legalFramework: LegalFramework;
     getIsOptedOut: () => boolean;
@@ -118,1 +119,8 @@ getExplicitNotice: () => boolean;
 }
+export interface GppDataInterface {
+    setCmpSignalReady: () => Promise<void>;
+    setCmpStatusLoaded: () => Promise<void>;
+    setCmpDisplayHidden: () => Promise<void>;
+    setCmpDisplayVisible: () => Promise<void>;
+}
+export type LegalFramework = 'tcfeuv2' | 'tcfcav1' | 'uspv1' | 'usnat' | 'usca' | 'usva' | 'usco' | 'usut' | 'usct';

package.json

 {
   "name": "@usercentrics/cmp-browser-sdk",
-  "version": "4.36.0",
+  "version": "4.37.0",
   "tcfCmpVersion": "3",
   "author": "Usercentrics GmbH",
   "description": "Usercentrics CMP Browser SDK",
-  "homepage": "https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/index.html",
+  "homepage": "https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/index.html",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -39,2 +39,3 @@ "main": "dist/index.js",
   "dependencies": {
+    "@iabgpp/cmpapi": "5.0.0",
     "@types/crypto-js": "^4.0.2",
@@ -41,0 +42,0 @@ "@types/lz-string": "^1.3.34",

README.md

@@ -43,3 +43,3 @@ # Usercentrics CMP Browser SDK
 
-The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/InitOptions.html) parameter.
+The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/interfaces/InitOptions.html) parameter.
 
@@ -131,3 +131,3 @@ ## Geolocation initialization
 
-The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/InitOptions.html) parameter.
+The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/interfaces/InitOptions.html) parameter.
 
@@ -233,3 +233,3 @@ For TCF, the `createTcfApiStub` option needs to be set to true in order for the \_\_tcfapi queue to initialize right away (we cannot wait for the settings request to finish).
 - `getServicesBaseInfo` retrieve all services with their base information, without fetching the aggregator.
-  - Returns [BaseService](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/BaseService.html)[]
+  - Returns [BaseService](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/interfaces/BaseService.html)[]
 
@@ -244,3 +244,3 @@ ```js
 - `getServicesFullInfo` retrieves all services with their complete information, fetching the aggregator if necessary.
-  - Returns Promise<[Service](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/modules.html#service)[]>
+  - Returns Promise<[Service](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/modules.html#service)[]>
 
@@ -261,3 +261,3 @@ ```js
 - `getCategoriesBaseInfo` retrieves the categories and their base services info to display this information in your UI.
-  - Returns [BaseCategory](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/BaseCategory.html)[]
+  - Returns [BaseCategory](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/interfaces/BaseCategory.html)[]
 
@@ -272,3 +272,3 @@ ```js
 - `getCategoriesFullInfo` retrieves the categories and their full services info to display this information in your UI.
-  - Returns Promise<[Category](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/Category.html)[]>
+  - Returns Promise<[Category](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/interfaces/Category.html)[]>
 
@@ -328,3 +328,3 @@ ```js
 ```html
-<script src="https://app.usercentrics.eu/browser-sdk/4.36.0/bundle.js"></script>
+<script src="https://app.usercentrics.eu/browser-sdk/4.37.0/bundle.js"></script>
 ```
@@ -360,3 +360,3 @@
 
-**NOTE**: If you need Internet Explorer 11 support, you can point the `src` attribute to `https://app.usercentrics.eu/browser-sdk/4.36.0/bundle_legacy.js`.
+**NOTE**: If you need Internet Explorer 11 support, you can point the `src` attribute to `https://app.usercentrics.eu/browser-sdk/4.37.0/bundle_legacy.js`.
 
@@ -371,2 +371,2 @@ ## Considerations for building your custom TCF v2.0 UI
 
-Documentation can be found on our [documentation website](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/index.html).
+Documentation can be found on our [documentation website](https://docs.usercentrics.com/cmp_browser_sdk/4.37.0/index.html).

No alert changes

Improved metrics

Total package byte prevSize

2677561

increased by12.99%

Number of package files

209

increased by2.45%

Lines of code

41837

increased by3.03%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Added@iabgpp/cmpapi@5.0.0