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

Comparing version 4.35.2 to 4.36.0

dist/index.js

@@ -1,1 +0,1 @@
-export{e as API_COMMANDS,as as BUTTON_ALIGNMENT,aA as CLOSE_OPTION,aQ as CONSENT_ACTION,aR as CONSENT_TYPE,aB as Core,ar as DPS_DISPLAY_FORMAT,aT as FIRST_LAYER_VARIANT,aW as SECOND_LAYER_SIDE,aw as SECOND_LAYER_TRIGGER,aU as SECOND_LAYER_VARIANT,aX as TCF_DECISION_UI_LAYER,aV as THEME,aS as TRACKING_EVENT_TYPE,aC as UI_LAYER,aD as UI_VARIANT,az as default,aE as isCcpaData,aF as isCcpaLabels,aG as isCcpaUI,aH as isDefaultData,aI as isDefaultLabels,aJ as isDefaultUI,aM as isNotPrivacyButtonLabels,aL as isPrivacyButtonLabels,aK as isPrivacyButtonUI,aN as isTcfData,aO as isTcfLabels,aP as isTcfUI}from"./index-8f7f28bd.js";
+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";

dist/src/modules/helpers/tcf.d.ts

@@ -1,6 +0,5 @@
-import { CoreTcf, LegacyTCF2ChangedPurposes } from '../../services/Api/interfaces';
+import { ACMVendor, IdAndName, TCFFeature, TCFPurpose, TCFSpecialFeature, TCFSpecialPurpose, TCFStack, TCFVendor, TCFVendorRestriction } from '../..';
+import { CoreTcf, LegacyTCF2AtpPurposes, LegacyTCF2ChangedPurposes } from '../../services/Api/interfaces';
 import { Feature, GVL, IntMap, Purpose, PurposeRestrictionVector, Stack, TCModel } from '../../../libs/@iabtcf/core';
-import { TCFFeature, TCFPurpose, TCFSpecialFeature, TCFSpecialPurpose, TCFStack, TCFVendor, TCFVendorRestriction } from '../..';
 import { ResurfaceOptions, TCFChangedPurposes } from '../../services/SettingsV2/interfaces';
-import { AcmVendor } from '../../services/SettingsV2/Data/interfaces';
 import { Maybe } from '../../services/SettingsV2/interfaces/interfaces';
@@ -10,2 +9,3 @@ import { StorageTCF } from '../../services/Storage/interfaces';
 export declare const getChangePurposes: (changedPurposes: Maybe<LegacyTCF2ChangedPurposes>) => TCFChangedPurposes;
+export declare const getAtpPurposes: (atpPurposes: LegacyTCF2AtpPurposes) => IdAndName[];
 export declare const getConsensuScriptPath: (consensuScriptPath: Maybe<string>) => string;
@@ -28,3 +28,3 @@ export declare const getConsensuSubdomain: (consensuDomain: Maybe<string>) => string;
 export declare const isTcfVersionChanged: (previousStorage: Maybe<StorageTCF>, tcModel: Maybe<Pick<TCModel, 'policyVersion' | 'version'>>) => boolean;
-export declare const isATPListChanged: (previousStorage: Maybe<StorageTCF>, acmVendors: AcmVendor[]) => boolean;
+export declare const isATPListChanged: (previousStorage: Maybe<StorageTCF>, acmVendors: ACMVendor[]) => boolean;
 export declare const isVendorAdded: (previousStorage: Maybe<StorageTCF>, vendors: TCFVendor[]) => boolean;
@@ -31,0 +31,0 @@ export declare const isVendorPurposeChanged: (previousStorage: Maybe<StorageTCF>, vendors: TCFVendor[]) => boolean;

dist/src/services/Api/__mocks__/Api.d.ts

@@ -6,2 +6,3 @@ import { LegacyHashService, LegacySettings, Ruleset } from '../interfaces';
 import { UserCountryResponse } from '../../Location/interfaces';
+import { VendorList } from '../../../../libs/@iabtcf/core';
 export default class Api {
@@ -38,2 +39,3 @@ private static instance;
     fetchSettingsJson(): Promise<LegacySettings>;
+    fetchVendorsList(): Promise<VendorList>;
     fetchUserCountry(): Promise<UserCountryResponse>;
@@ -40,0 +42,0 @@ fetchUserTcfData(): Promise<StorageTCF>;

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

@@ -10,2 +10,3 @@ import { AcmVendors, Consents, GraphQLQuery, LegacyHashService, LegacySettings, Ruleset, Translations, UserConsentResponse, UserConsentResponseV2 } from './interfaces';
 import { UcDomains } from '../../interfaces';
+import { VendorList } from '../../../libs/@iabtcf/core';
 declare global {
@@ -102,2 +103,3 @@ interface Window {
     fetchUserTcfDataV2(): Promise<StorageTCF>;
+    fetchVendorsList(url: string, notAllowedPurposes?: number[]): Promise<VendorList>;
     saveTCFConsents(dataTransferSettings: DataTransferSettings, storageTCF: StorageTCF, consentAction: CONSENT_ACTION, consentType: CONSENT_TYPE, apiV2: {
@@ -104,0 +106,0 @@ isAnalyticsEnabled: boolean;

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

@@ -22,3 +22,8 @@ import { BUTTON_ALIGNMENT, DPS_DISPLAY_FORMAT, FIRST_LAYER_VARIANT, SECOND_LAYER_SIDE, SECOND_LAYER_TRIGGER, SECOND_LAYER_VARIANT } from '../../SettingsV2/enums';
     legIntPurposes: number[];
+    notAllowedPurposes: number[];
 }
+export interface LegacyTCF2AtpPurposes {
+    p1: string;
+    p2: string;
+}
 export interface LegacyBackgroundOverlay {
@@ -479,2 +484,3 @@ darken: number;
     atpListTitle: string;
+    atpPurposes?: LegacyTCF2AtpPurposes;
     buttonsAcceptAllLabel: string;
@@ -481,0 +487,0 @@ buttonsDenyAllLabel: string;

dist/src/services/SettingsV2/__fixtures__/tcf.data.d.ts

@@ -1,3 +0,2 @@
-import { TCFPurpose, TCFVendor } from '../interfaces/TCF';
-import { AcmVendor } from '../Data/interfaces';
+import { ACMVendor, TCFPurpose, TCFVendor } from '../interfaces/TCF';
 import { StorageTCF } from '../../Storage/interfaces';
@@ -24,5 +23,5 @@ export declare const purposes: TCFPurpose[];
 export declare const previousStorageAcm: StorageTCF;
-export declare const acVendors: AcmVendor[];
-export declare const acVendorsChanged: AcmVendor[];
-export declare const acVendorsRemoved: AcmVendor[];
-export declare const acVendorsAdded: AcmVendor[];
+export declare const acVendors: ACMVendor[];
+export declare const acVendorsChanged: ACMVendor[];
+export declare const acVendorsRemoved: ACMVendor[];
+export declare const acVendorsAdded: ACMVendor[];

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

@@ -0,4 +1,4 @@
+import { ACMVendor, IdAndName, TCFData, TCFUserDecisions } from '../interfaces/TCF';
 import { Consent, DataDistribution, Language, ProcessingCompany, ResurfaceOptions, TCFChangedPurposes, URLs } from '../interfaces';
-import { TCFData, TCFUserDecisions } from '../interfaces/TCF';
-import { DeviceStorage } from '../../Api/interfaces';
+import { DeviceStorage, LegacyTCF2 } from '../../Api/interfaces';
 import { LEGACY_CCPA_REGION } from '../../Api/enums';
@@ -73,2 +73,3 @@ import { STRING_CHARACTER } from '../enums/Ccpa/enums';
 export interface TcfData extends DefaultData {
+    acmData: AcmData;
     acceptAllDisclosed: (fromLayer: TCF_DECISION_UI_LAYER) => Promise<void>;
@@ -78,3 +79,3 @@ areAllPurposesAccepted: () => boolean;
     changedPurposes: TCFChangedPurposes;
-    changeLanguage: (language: string) => Promise<void>;
+    changeLanguage: (language: string, tcfSettings?: LegacyTCF2) => Promise<void>;
     cmpId: number;
@@ -112,9 +113,7 @@ cmpVersion: number;
 export type Data = DefaultData | CcpaData | TcfData;
-export interface AcmVendor {
-    id: number;
-    name: string;
-    privacyPolicyUrl: string;
-    consent: {
-        status: boolean;
-    };
+export interface AcmData {
+    isEnabled: boolean;
+    vendorIds: number[];
+    vendors?: ACMVendor[];
+    vendorsPurposes: IdAndName[];
 }

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

@@ -1,14 +0,12 @@
-import { AcmVendor, TcfData as TcfSettingsData } from './interfaces';
-import { CoreTcf, DpsJsonResponse, LegacySettings } from '../../Api/interfaces';
+import { ACMVendor, TCFData, TCFUserDecisions } from '../interfaces/TCF';
+import { AcmData, TcfData as TcfSettingsData } from './interfaces';
+import { CoreTcf, DpsJsonResponse, LegacySettings, LegacyTCF2 } from '../../Api/interfaces';
 import { DataTransferSettings } from '../../../modules/helpers';
 import { EncodingOptions, TCModel } from '../../../../libs/@iabtcf/core';
 import { ResurfaceOptions, TCFChangedPurposes } from '../interfaces';
-import { TCFData, TCFUserDecisions } from '../interfaces/TCF';
 import { TCF_DECISION_UI_LAYER } from '../enums/TCF';
 import DefaultData from './DefaultData';
 declare class Tcf extends DefaultData implements TcfSettingsData {
+    acmData: AcmData;
     gcmEnabled: boolean;
-    acmEnabled: boolean;
-    acmVendorIds: number[];
-    acmVendors?: AcmVendor[];
     changedPurposes: TCFChangedPurposes;
@@ -51,3 +49,3 @@ cmpId: number;
     areAllVendorsAccepted(): boolean;
-    changeLanguage(language: string): Promise<void>;
+    changeLanguage(language: string, newTcfSettings?: LegacyTCF2): Promise<void>;
     denyAllDisclosed(fromLayer: TCF_DECISION_UI_LAYER): Promise<void>;
@@ -94,7 +92,7 @@ getSelectedVendorsIncludeNonDisclosed(): boolean;
     private updateTCString;
-    constructor(legacySettings: LegacySettings, coreTcf: CoreTcf, dpsJson: DpsJsonResponse, dataTransferSettings: DataTransferSettings, controllerId: string, language: string, excludeAcceptAllVendors: number[], enableDeprecatedV1ConsentSaving?: boolean);
     getVendorsCount(): number;
-    getAcmVendors(): AcmVendor[];
+    getAcmVendors(): ACMVendor[];
     getAcmVendorsCount(): number;
+    constructor(legacySettings: LegacySettings, coreTcf: CoreTcf, dpsJson: DpsJsonResponse, dataTransferSettings: DataTransferSettings, controllerId: string, language: string, excludeAcceptAllVendors: number[], enableDeprecatedV1ConsentSaving?: boolean);
 }
 export default Tcf;

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

@@ -16,2 +16,3 @@ import { BaseCategoryData, BaseServiceData, CategoryData, ServiceBasic, ServiceData } from '../Data/interfaces';
     legitimateInterestPurposes: number[];
+    notAllowedPurposes: number[];
 }
@@ -18,0 +19,0 @@ export interface ResurfaceOptions {

dist/src/services/SettingsV2/interfaces/TCF/interfaces.public.d.ts

@@ -1,6 +0,2 @@
-import { ResurfaceOptions, TCFChangedPurposes } from '../interfaces';
-import { AcmVendor } from '../../Data/interfaces';
 import { DeviceStorage } from '../../../Api/interfaces';
-import { TCFUserDecisions } from '.';
-import { TCF_DECISION_UI_LAYER } from '../../enums/TCF';
 export declare enum RestrictionType {
@@ -20,38 +16,2 @@ /**
 }
-export type ACMVendor = AcmVendor;
-export interface TCFOptions {
-    changedPurposes: TCFChangedPurposes;
-    cmpId: number;
-    cmpVersion: number;
-    consensuScriptPath: string;
-    consensuSubdomain: string;
-    disabledSpecialFeatures: number[];
-    gdprApplies: boolean;
-    hideLegitimateInterestToggles: boolean;
-    publisherCountryCode: string;
-    purposeOneTreatment: boolean;
-    resurfaceOptions: ResurfaceOptions;
-    stackIds: number[];
-    tcfv2HistoryDisabled: boolean;
-    useGranularChoice: boolean;
-    vendorIds: number[];
-    acceptAllDisclosed: (fromLayer: TCF_DECISION_UI_LAYER) => Promise<void>;
-    areAllPurposesAccepted: () => boolean;
-    areAllVendorsAccepted: () => boolean;
-    changeLanguage: (language: string) => Promise<void>;
-    denyAllDisclosed: (fromLayer: TCF_DECISION_UI_LAYER) => Promise<void>;
-    getGdprApplies: () => Promise<boolean>;
-    getSelectedVendorsIncludeNonDisclosed: () => boolean;
-    getTCFData: () => TCFData;
-    getTCString: () => string;
-    getTCFDisclosedVendorsSegmentString: () => string;
-    init: () => Promise<void>;
-    injectTCString: (tcString: string) => Promise<boolean>;
-    resetTcf: () => void;
-    setUIAsClosed: () => Promise<void>;
-    setUIAsOpen: () => Promise<void>;
-    shouldResurfaceUI: () => boolean;
-    updateChoices: (decisions: TCFUserDecisions, fromLayer: TCF_DECISION_UI_LAYER) => Promise<void>;
-    updateControllerId: (value: string) => void;
-}
 export type TCFVendorRestrictionType = RestrictionType;
@@ -137,3 +97,3 @@ /** A TCF feature that needs to be disclosed to the end-user. */
     /** A list of all Additional Consent Mode vendors that need to be disclosed to the end-user if ACM is enabled */
-    acmVendors: AcmVendor[];
+    acmVendors: ACMVendor[];
 }
@@ -219,1 +179,11 @@ /**
 }
+/** Google Additional Consent Mode Vendor */
+export interface ACMVendor {
+    consent: {
+        status: boolean;
+    };
+    id: number;
+    name: string;
+    privacyPolicyUrl: string;
+    purposes: IdAndName[];
+}

package.json

 {
   "name": "@usercentrics/cmp-browser-sdk",
-  "version": "4.35.2",
+  "version": "4.36.0",
   "tcfCmpVersion": "3",
   "author": "Usercentrics GmbH",
   "description": "Usercentrics CMP Browser SDK",
-  "homepage": "https://docs.usercentrics.com/cmp_browser_sdk/4.35.2/index.html",
+  "homepage": "https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/index.html",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -9,0 +9,0 @@ "main": "dist/index.js",

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.35.2/interfaces/InitOptions.html) parameter.
+The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.36.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.35.2/interfaces/InitOptions.html) parameter.
+The constructor also supports an optional [Options](https://docs.usercentrics.com/cmp_browser_sdk/4.36.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.35.2/interfaces/BaseService.html)[]
+  - Returns [BaseService](https://docs.usercentrics.com/cmp_browser_sdk/4.36.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.35.2/modules.html#service)[]>
+  - Returns Promise<[Service](https://docs.usercentrics.com/cmp_browser_sdk/4.36.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.35.2/interfaces/BaseCategory.html)[]
+  - Returns [BaseCategory](https://docs.usercentrics.com/cmp_browser_sdk/4.36.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.35.2/interfaces/Category.html)[]>
+  - Returns Promise<[Category](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/interfaces/Category.html)[]>
 
@@ -328,3 +328,3 @@ ```js
 ```html
-<script src="https://app.usercentrics.eu/browser-sdk/4.35.2/bundle.js"></script>
+<script src="https://app.usercentrics.eu/browser-sdk/4.36.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.35.2/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.36.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.35.2/index.html).
+Documentation can be found on our [documentation website](https://docs.usercentrics.com/cmp_browser_sdk/4.36.0/index.html).

No alert changes

Improved metrics

Total package byte prevSize

2369663

increased by30.95%

Number of package files

204

increased by0.49%

Lines of code

40606

increased by72.1%

Worsened metrics

Number of medium supply chain risk alerts

13

increased by44.44%

No dependency changes