@usercentrics/react-native-sdk 2.23.2 → 2.24.0

package/src/models/ConsentDisclosureObject.tsx

@@ -0,0 +1,47 @@
+export class ConsentDisclosureObject {
+
+    disclosures: [ConsentDisclosure]
+
+    constructor(disclosures: [ConsentDisclosure]) {
+        this.disclosures = disclosures
+    }
+}
+
+export class ConsentDisclosure {
+
+    identifier?: string
+    type?: ConsentDisclosureType
+    name?: string
+    maxAgeSeconds?: number
+    cookieRefresh: boolean
+    purposes: [number]
+    domain?: string
+    description?: string
+
+    constructor(
+        cookieRefresh: boolean,
+        purposes: [number],
+        identifier?: string,
+        type?: ConsentDisclosureType,
+        name?: string,
+        maxAgeSeconds?: number,
+        domain?: string,
+        description?: string,
+    ) {
+        this.identifier = identifier
+        this.type = type
+        this.name = name
+        this.maxAgeSeconds = maxAgeSeconds
+        this.cookieRefresh = cookieRefresh
+        this.purposes = purposes
+        this.domain = domain
+        this.description = description
+    }
+}
+
+export enum ConsentDisclosureType {
+
+    cookie = 0,
+    web = 1,
+    app = 2
+}

package/src/models/FirstLayerSettings.tsx

@@ -0,0 +1,185 @@
+import {BannerLogo} from ".";
+
+export class FirstLayerStyleSettings {
+
+    layout?: UsercentricsLayout;
+    headerImage?: HeaderImageSettings;
+    title?: TitleSettings;
+    message?: MessageSettings;
+    buttonLayout?: ButtonLayout;
+    backgroundColorHex?: String;
+    cornerRadius?: Number;
+    overlayColorHex?: String;
+
+    constructor(layout?: UsercentricsLayout,
+                headerImage?: HeaderImageSettings,
+                title?: TitleSettings,
+                message?: MessageSettings,
+                buttonLayout?: ButtonLayout,
+                backgroundColorHex?: String,
+                cornerRadius?: Number,
+                overlayColorHex?: String
+    ) {
+        this.layout = layout
+        this.headerImage = headerImage;
+        this.title = title;
+        this.message = message;
+        this.buttonLayout = buttonLayout;
+        this.backgroundColorHex = backgroundColorHex;
+        this.cornerRadius = cornerRadius;
+        this.overlayColorHex = overlayColorHex;
+    }
+}
+
+export class HeaderImageSettings {
+
+    isExtended: Boolean;
+    isHidden: Boolean;
+    image?: BannerLogo;
+    height?: Number;
+    alignment?: SectionAlignment
+
+    private constructor(isExtended: Boolean,
+                        isHidden: Boolean,
+                        image?: BannerLogo,
+                        height?: Number,
+                        alignment?: SectionAlignment) {
+        this.isExtended = isExtended;
+        this.isHidden = isHidden;
+        this.image = image;
+        this.height = height;
+        this.alignment = alignment;
+    }
+
+    static extended(image: BannerLogo): HeaderImageSettings {
+        return new HeaderImageSettings(true, false, image)
+    }
+
+    static logo(image: BannerLogo, height?: Number, alignment?: SectionAlignment): HeaderImageSettings {
+        return new HeaderImageSettings(false, false, image, height, alignment)
+    }
+
+    static hidden(): HeaderImageSettings {
+        return new HeaderImageSettings(false, true)
+    }
+}
+
+export class TitleSettings {
+
+    fontName?: string;
+    textSize?: number;
+    textColorHex?: String;
+    textAlignment?: SectionAlignment;
+
+    constructor(fontName?: string, textSize?: number, textColorHex?: String, textAlignment?: SectionAlignment) {
+        this.fontName = fontName;
+        this.textSize = textSize;
+        this.textColorHex = textColorHex;
+        this.textAlignment = textAlignment;
+    }
+}
+
+export class MessageSettings {
+
+    fontName?: string;
+    textSize?: number;
+    textColorHex?: String;
+    textAlignment?: SectionAlignment;
+    linkTextColorHex?: String;
+    linkTextUnderline?: Boolean;
+
+    constructor(fontName?: string,
+                textSize?: number,
+                textColorHex?: String,
+                textAlignment?: SectionAlignment,
+                linkTextColorHex?: String,
+                linkTextUnderline?: Boolean) {
+        this.fontName = fontName;
+        this.textSize = textSize;
+        this.textColorHex = textColorHex;
+        this.textAlignment = textAlignment;
+        this.linkTextColorHex = linkTextColorHex;
+        this.linkTextUnderline = linkTextUnderline;
+    }
+}
+
+export class ButtonLayout {
+
+    buttons: ButtonSettings[][]
+    layout: InternalButtonLayout
+
+    private constructor(buttons: ButtonSettings[][], layout: InternalButtonLayout) {
+        this.buttons = buttons;
+        this.layout = layout;
+    }
+
+    static row(buttons: ButtonSettings[]): ButtonLayout {
+        return new ButtonLayout([buttons], InternalButtonLayout.row)
+    }
+
+    static column(buttons: ButtonSettings[]): ButtonLayout {
+        return new ButtonLayout([buttons], InternalButtonLayout.column)
+    }
+
+    static grid(buttons: ButtonSettings[][]): ButtonLayout {
+        return new ButtonLayout(buttons, InternalButtonLayout.grid)
+    }
+}
+
+enum InternalButtonLayout {
+    row = "ROW",
+    grid = "GRID",
+    column = "COLUMN"
+}
+
+export class ButtonSettings {
+
+    buttonType: ButtonType;
+    fontName?: string;
+    textSize?: number;
+    textColorHex?: String;
+    backgroundColorHex?: String;
+    cornerRadius?: number;
+
+    // Affects only Android
+    isAllCaps?: Boolean
+
+    constructor(buttonType: ButtonType,
+                fontName?: string,
+                textSize?: number,
+                textColorHex?: String,
+                backgroundColorHex?: String,
+                cornerRadius?: number,
+                isAllCaps?: Boolean) {
+        this.buttonType = buttonType
+        this.fontName = fontName
+        this.textSize = textSize
+        this.textColorHex = textColorHex
+        this.backgroundColorHex = backgroundColorHex
+        this.cornerRadius = cornerRadius
+        this.isAllCaps = isAllCaps
+    }
+}
+
+export enum ButtonType {
+
+    acceptAll = "ACCEPT_ALL",
+    denyAll = "DENY_ALL",
+    more = "MORE",
+    save = "SAVE"
+}
+
+export enum SectionAlignment {
+
+    left = "START",
+    right = "END",
+    center = "CENTER"
+}
+
+export enum UsercentricsLayout {
+
+    full = "FULL",
+    sheet = "SHEET",
+    popupCenter = "POPUP_CENTER",
+    popupBottom = "POPUP_BOTTOM"
+}

package/src/models/GeolocationRuleset.tsx

@@ -0,0 +1,10 @@
+export class GeolocationRuleset {
+
+    activeSettingsId: string;
+    bannerRequiredAtLocation: boolean;
+
+    constructor(activeSettingsId: string, bannerRequiredAtLocation: boolean) {
+        this.activeSettingsId = activeSettingsId
+        this.bannerRequiredAtLocation = bannerRequiredAtLocation
+    }
+}

package/src/models/LegalBasisLocalization.tsx

@@ -0,0 +1,100 @@
+export class LegalBasisLocalization {
+    labelsAria?: TranslationAriaLabels
+    data: Map<string, string>
+
+    constructor(
+        data: Map<string, string>,
+        labelsAria?: TranslationAriaLabels
+    ) {
+        this.data = data
+        this.labelsAria = labelsAria
+    }
+}
+
+export class TranslationAriaLabels {
+    acceptAllButton?: string
+    ccpaButton?: string
+    ccpaMoreInformation?: string
+    closeButton?: string
+    collapse?: string
+    cookiePolicyButton?: string
+    copyControllerId?: string
+    denyAllButton?: string
+    expand?: string
+    fullscreenButton?: string
+    imprintButton?: string
+    languageSelector?: string
+    privacyButton?: string
+    privacyPolicyButton?: string
+    saveButton?: string
+    serviceInCategoryDetails?: string
+    servicesInCategory?: string
+    tabButton?: string
+    usercentricsCMPButtons?: string
+    usercentricsCMPContent?: string
+    usercentricsCMPHeader?: string
+    usercentricsCMPUI?: string
+    usercentricsCard?: string
+    usercentricsList?: string
+    vendorConsentToggle?: string
+    vendorDetailedStorageInformation?: string
+    vendorLegIntToggle?: string
+
+    constructor(
+        acceptAllButton?: string,
+        ccpaButton?: string,
+        ccpaMoreInformation?: string,
+        closeButton?: string,
+        collapse?: string,
+        cookiePolicyButton?: string,
+        copyControllerId?: string,
+        denyAllButton?: string,
+        expand?: string,
+        fullscreenButton?: string,
+        imprintButton?: string,
+        languageSelector?: string,
+        privacyButton?: string,
+        privacyPolicyButton?: string,
+        saveButton?: string,
+        serviceInCategoryDetails?: string,
+        servicesInCategory?: string,
+        tabButton?: string,
+        usercentricsCMPButtons?: string,
+        usercentricsCMPContent?: string,
+        usercentricsCMPHeader?: string,
+        usercentricsCMPUI?: string,
+        usercentricsCard?: string,
+        usercentricsList?: string,
+        vendorConsentToggle?: string,
+        vendorDetailedStorageInformation?: string,
+        vendorLegIntToggle?: string
+    ) {
+        this.acceptAllButton = acceptAllButton
+        this.ccpaButton = ccpaButton
+        this.ccpaMoreInformation = ccpaMoreInformation;
+        this.closeButton = closeButton
+        this.collapse = collapse
+        this.cookiePolicyButton = cookiePolicyButton
+        this.copyControllerId = copyControllerId
+        this.denyAllButton = denyAllButton
+        this.expand = expand
+        this.fullscreenButton = fullscreenButton
+        this.imprintButton = imprintButton
+        this.languageSelector = languageSelector
+        this.privacyButton = privacyButton
+        this.privacyPolicyButton = privacyPolicyButton
+        this.saveButton = saveButton
+        this.serviceInCategoryDetails = serviceInCategoryDetails
+        this.servicesInCategory = servicesInCategory
+        this.tabButton = tabButton
+        this.usercentricsCMPButtons = usercentricsCMPButtons
+        this.usercentricsCMPContent = usercentricsCMPContent
+        this.usercentricsCMPHeader = usercentricsCMPHeader
+        this.usercentricsCMPUI = usercentricsCMPUI
+        this.usercentricsCard = usercentricsCard
+        this.usercentricsList = usercentricsList
+        this.vendorConsentToggle = vendorConsentToggle
+        this.vendorDetailedStorageInformation = vendorDetailedStorageInformation
+        this.vendorLegIntToggle = vendorLegIntToggle
+    }
+}

package/src/models/NetworkMode.tsx

@@ -0,0 +1,5 @@
+export enum NetworkMode {
+
+    world = 0,
+    eu = 1
+}

package/src/models/SecondLayerSettings.tsx

@@ -0,0 +1,12 @@
+import {ButtonLayout} from ".";
+
+export class SecondLayerStyleSettings {
+
+    buttonLayout?: ButtonLayout;
+    showCloseButton?: Boolean;
+
+    constructor(buttonLayout?: ButtonLayout, showCloseButton?: Boolean) {
+        this.buttonLayout = buttonLayout;
+        this.showCloseButton = showCloseButton;
+    }
+}

package/src/models/TCF2Settings.tsx

@@ -0,0 +1,209 @@
+export class TCF2Settings {
+    firstLayerTitle: string
+    secondLayerTitle: string
+    tabsPurposeLabel: string
+    tabsVendorsLabel: string
+    labelsFeatures: string
+    labelsIabVendors: string
+    labelsNonIabPurposes: string
+    labelsNonIabVendors: string
+    labelsPurposes: string
+    vendorFeatures: string
+    vendorLegitimateInterestPurposes: string
+    vendorPurpose: string
+    vendorSpecialFeatures: string
+    vendorSpecialPurposes: string
+    togglesConsentToggleLabel: string
+    togglesLegIntToggleLabel: string
+    buttonsAcceptAllLabel: string
+    buttonsDenyAllLabel: string
+    buttonsSaveLabel: string
+    linksManageSettingsLabel: string
+    linksVendorListLinkLabel: string
+    cmpId: number
+    cmpVersion: number
+    firstLayerHideToggles: boolean
+    secondLayerHideToggles: boolean
+    hideLegitimateInterestToggles: boolean
+    firstLayerHideButtonDeny?: boolean
+    secondLayerHideButtonDeny: boolean
+    publisherCountryCode: string
+    purposeOneTreatment: boolean
+    selectedVendorIds: [number]
+    gdprApplies: boolean
+    selectedStacks: [number]
+    disabledSpecialFeatures: [number]
+    firstLayerShowDescriptions: boolean
+    hideNonIabOnFirstLayer: boolean
+    resurfacePeriodEnded: boolean
+    resurfacePurposeChanged: boolean
+    resurfaceVendorAdded: boolean
+    firstLayerDescription: string
+    firstLayerAdditionalInfo: string
+    secondLayerDescription: string
+    togglesSpecialFeaturesToggleOn: string
+    togglesSpecialFeaturesToggleOff: string
+    appLayerNoteResurface: string
+    firstLayerNoteResurface: string
+    categoriesOfDataLabel: string
+    dataRetentionPeriodLabel: string
+    legitimateInterestLabel: string
+    version: string
+    examplesLabel: string
+    firstLayerMobileVariant?: FirstLayerMobileVariant
+    showDataSharedOutsideEUText: boolean
+    dataSharedOutsideEUText?: string
+    vendorIdsOutsideEUList: [number]
+    scope: TCF2Scope
+    changedPurposes: TCF2ChangedPurposes
+    acmV2Enabled: boolean
+    selectedATPIds: number[]
+
+    constructor(
+        firstLayerTitle: string,
+        secondLayerTitle: string,
+        tabsPurposeLabel: string,
+        tabsVendorsLabel: string,
+        labelsFeatures: string,
+        labelsIabVendors: string,
+        labelsNonIabPurposes: string,
+        labelsNonIabVendors: string,
+        labelsPurposes: string,
+        vendorFeatures: string,
+        vendorLegitimateInterestPurposes: string,
+        vendorPurpose: string,
+        vendorSpecialFeatures: string,
+        vendorSpecialPurposes: string,
+        togglesConsentToggleLabel: string,
+        togglesLegIntToggleLabel: string,
+        buttonsAcceptAllLabel: string,
+        buttonsDenyAllLabel: string,
+        buttonsSaveLabel: string,
+        linksManageSettingsLabel: string,
+        linksVendorListLinkLabel: string,
+        cmpId: number,
+        cmpVersion: number,
+        firstLayerHideToggles: boolean,
+        secondLayerHideToggles: boolean,
+        hideLegitimateInterestToggles: boolean,
+        secondLayerHideButtonDeny: boolean,
+        publisherCountryCode: string,
+        purposeOneTreatment: boolean,
+        selectedVendorIds: [number],
+        gdprApplies: boolean,
+        selectedStacks: [number],
+        disabledSpecialFeatures: [number],
+        firstLayerShowDescriptions: boolean,
+        hideNonIabOnFirstLayer: boolean,
+        resurfacePeriodEnded: boolean,
+        resurfacePurposeChanged: boolean,
+        resurfaceVendorAdded: boolean,
+        firstLayerDescription: string,
+        firstLayerAdditionalInfo: string,
+        secondLayerDescription: string,
+        togglesSpecialFeaturesToggleOn: string,
+        togglesSpecialFeaturesToggleOff: string,
+        appLayerNoteResurface: string,
+        firstLayerNoteResurface: string,
+        categoriesOfDataLabel: string,
+        dataRetentionPeriodLabel: string,
+        legitimateInterestLabel: string,
+        version: string,
+        examplesLabel: string,
+        showDataSharedOutsideEUText: boolean,
+        vendorIdsOutsideEUList: [number],
+        scope: TCF2Scope,
+        changedPurposes: TCF2ChangedPurposes,
+        acmV2Enabled: boolean,
+        selectedATPIds: number[],
+        firstLayerHideButtonDeny?: boolean,
+        firstLayerMobileVariant?: FirstLayerMobileVariant,
+        dataSharedOutsideEUText?: string,
+    ) {
+        this.firstLayerTitle = firstLayerTitle
+        this.secondLayerTitle = secondLayerTitle
+        this.tabsPurposeLabel = tabsPurposeLabel
+        this.tabsVendorsLabel = tabsVendorsLabel
+        this.labelsFeatures = labelsFeatures
+        this.labelsIabVendors = labelsIabVendors
+        this.labelsNonIabPurposes = labelsNonIabPurposes
+        this.labelsNonIabVendors = labelsNonIabVendors
+        this.labelsPurposes = labelsPurposes
+        this.vendorFeatures = vendorFeatures
+        this.vendorLegitimateInterestPurposes = vendorLegitimateInterestPurposes
+        this.vendorPurpose = vendorPurpose
+        this.vendorSpecialFeatures = vendorSpecialFeatures
+        this.vendorSpecialPurposes = vendorSpecialPurposes
+        this.togglesConsentToggleLabel = togglesConsentToggleLabel
+        this.togglesLegIntToggleLabel = togglesLegIntToggleLabel
+        this.buttonsAcceptAllLabel = buttonsAcceptAllLabel
+        this.buttonsDenyAllLabel = buttonsDenyAllLabel
+        this.buttonsSaveLabel = buttonsSaveLabel
+        this.linksManageSettingsLabel = linksManageSettingsLabel
+        this.linksVendorListLinkLabel = linksVendorListLinkLabel
+        this.cmpId = cmpId
+        this.cmpVersion = cmpVersion
+        this.firstLayerHideToggles = firstLayerHideToggles
+        this.secondLayerHideToggles = secondLayerHideToggles
+        this.hideLegitimateInterestToggles = hideLegitimateInterestToggles
+        this.firstLayerHideButtonDeny = firstLayerHideButtonDeny
+        this.secondLayerHideButtonDeny = secondLayerHideButtonDeny
+        this.publisherCountryCode = publisherCountryCode
+        this.purposeOneTreatment = purposeOneTreatment
+        this.selectedVendorIds = selectedVendorIds
+        this.gdprApplies = gdprApplies
+        this.selectedStacks = selectedStacks
+        this.disabledSpecialFeatures = disabledSpecialFeatures
+        this.firstLayerShowDescriptions = firstLayerShowDescriptions
+        this.hideNonIabOnFirstLayer = hideNonIabOnFirstLayer
+        this.resurfacePeriodEnded = resurfacePeriodEnded
+        this.resurfacePurposeChanged = resurfacePurposeChanged
+        this.resurfaceVendorAdded = resurfaceVendorAdded
+        this.firstLayerDescription = firstLayerDescription
+        this.firstLayerAdditionalInfo = firstLayerAdditionalInfo
+        this.secondLayerDescription = secondLayerDescription
+        this.togglesSpecialFeaturesToggleOn = togglesSpecialFeaturesToggleOn
+        this.togglesSpecialFeaturesToggleOff = togglesSpecialFeaturesToggleOff
+        this.appLayerNoteResurface = appLayerNoteResurface
+        this.firstLayerNoteResurface = firstLayerNoteResurface
+        this.categoriesOfDataLabel = categoriesOfDataLabel
+        this.dataRetentionPeriodLabel = dataRetentionPeriodLabel
+        this.legitimateInterestLabel = legitimateInterestLabel
+        this.version = version
+        this.examplesLabel = examplesLabel
+        this.firstLayerMobileVariant = firstLayerMobileVariant
+        this.showDataSharedOutsideEUText = showDataSharedOutsideEUText
+        this.dataSharedOutsideEUText = dataSharedOutsideEUText
+        this.vendorIdsOutsideEUList = vendorIdsOutsideEUList
+        this.scope = scope
+        this.changedPurposes = changedPurposes
+        this.acmV2Enabled = acmV2Enabled
+        this.selectedATPIds = selectedATPIds
+    }
+}
+
+export enum FirstLayerMobileVariant {
+    sheet = 0,
+    full = 1,
+    popupBottom = 2,
+    popupCenter = 3
+}
+
+export enum TCF2Scope {
+    global = 0,
+    service = 1
+}
+
+export class TCF2ChangedPurposes {
+
+    purposes: [number]
+    legIntPurposes: [number]
+
+    constructor(
+        purposes: [number],
+        legIntPurposes: [number],
+    ) {
+        this.purposes = purposes
+        this.legIntPurposes = legIntPurposes
+    }
+}