@usercentrics/react-native-sdk 2.23.2 → 2.24.0

package/src/models/TCFData.tsx

@@ -0,0 +1,297 @@
+export class TCFData {
+    /// A list of all the TCF features that need to be disclosed to the end-user if TCF is enabled.
+    features: TCFFeature[]
+
+    /// A list of all the TCF purposes that need to be disclosed to the end-user if TCF is enabled.
+    purposes: TCFPurpose[]
+
+    /// A list of all the TCF special features that need to be disclosed to the end-user if TCF is enabled
+    specialFeatures: TCFSpecialFeature[]
+
+    /// A list of all the TCF special purposes that need to be disclosed to the end-user if TCF is enabled
+    specialPurposes: TCFSpecialPurpose[]
+
+    /// A list of all TCF stacks that need to be disclosed to the end-user if TCF is enabled. On the first layer of a
+    /// TCF UI, stacks may be shown as alternative its comprising purposes and special features. However, on the second
+    /// layer, this is not allowed according to the IAB TCF v.2.0 guidelines. Also on the first layer, a purpose or special
+    /// feature may not be shown if a stack containing this purpose or special feature is already displayed. Note, that all
+    /// purposes and special features that are part of stacks will still be listed in the TCFData purposes and special
+    /// features fields, but they will be flagged with isPartOfASelectedStack = true and include a non-null stackId.
+    stacks: TCFStack[]
+
+    /// A list of all TCF vendors that need to be disclosed to the end-user if TCF is enabled */
+    vendors: TCFVendor[]
+
+    /// The TCF string
+    tcString: String
+
+    /// The total of vendors and services
+    thirdPartyCount: number
+
+    constructor(
+        features: TCFFeature[],
+        purposes: TCFPurpose[],
+        specialFeatures: TCFSpecialFeature[],
+        specialPurposes: TCFSpecialPurpose[],
+        stacks: TCFStack[],
+        vendors: TCFVendor[],
+        tcString: String,
+        thirdPartyCount: number
+    ) {
+        this.features = features
+        this.purposes = purposes
+        this.specialFeatures = specialFeatures
+        this.specialPurposes = specialPurposes
+        this.stacks = stacks
+        this.vendors = vendors
+        this.tcString = tcString
+        this.thirdPartyCount = thirdPartyCount
+    }
+}
+
+export class TCFFeature {
+    purposeDescription: string
+    illustrations: [string]
+    id: number
+    name: string
+
+
+    constructor(
+        purposeDescription: string,
+        illustrations: [string],
+        id: number,
+        name: string
+    ) {
+        this.purposeDescription = purposeDescription
+        this.illustrations = illustrations
+        this.id = id
+        this.name = name
+    }
+}
+
+export class TCFPurpose {
+    purposeDescription: string
+    illustrations: [string]
+    id: number
+    name: string
+    consent?: boolean
+    isPartOfASelectedStack: boolean
+    legitimateInterestConsent?: boolean
+    showConsentToggle: boolean
+    showLegitimateInterestToggle: boolean
+    stackId?: number
+    numberOfVendors?: number
+
+    constructor(
+        purposeDescription: string,
+        illustrations: [string],
+        id: number,
+        name: string,
+        isPartOfASelectedStack: boolean,
+        showConsentToggle: boolean,
+        showLegitimateInterestToggle: boolean,
+        legitimateInterestConsent?: boolean,
+        consent?: boolean,
+        stackId?: number,
+        numberOfVendors?: number,
+    ) {
+        this.purposeDescription = purposeDescription
+        this.illustrations = illustrations
+        this.id = id
+        this.name = name
+        this.consent = consent
+        this.isPartOfASelectedStack = isPartOfASelectedStack
+        this.legitimateInterestConsent = legitimateInterestConsent
+        this.showConsentToggle = showConsentToggle
+        this.showLegitimateInterestToggle = showLegitimateInterestToggle
+        this.stackId = stackId
+        this.numberOfVendors = numberOfVendors
+    }
+}
+
+export class TCFSpecialFeature {
+    purposeDescription: string
+    illustrations: [string]
+    id: number
+    name: string
+    consent?: boolean
+    isPartOfASelectedStack: boolean
+    stackId?: number
+    showConsentToggle: boolean
+
+
+    constructor(
+        purposeDescription: string,
+        illustrations: [string],
+        id: number,
+        isPartOfASelectedStack: boolean,
+        showConsentToggle: boolean,
+        name: string,
+        consent?: boolean,
+        stackId?: number
+    ) {
+        this.purposeDescription = purposeDescription
+        this.illustrations = illustrations
+        this.id = id
+        this.name = name
+        this.consent = consent
+        this.isPartOfASelectedStack = isPartOfASelectedStack
+        this.stackId = stackId
+        this.showConsentToggle = showConsentToggle
+    }
+
+}
+
+export class TCFSpecialPurpose {
+    purposeDescription: string
+    illustrations: [string]
+    id: number
+    name: string
+
+
+    constructor(
+        purposeDescription: string,
+        illustrations: [string],
+        id: number,
+        name: string
+    ) {
+        this.purposeDescription = purposeDescription
+        this.illustrations = illustrations
+        this.id = id
+        this.name = name
+    }
+}
+
+export class TCFStack {
+    description: string
+    id: number
+    name: string
+    purposeIds: [number]
+    specialFeatureIds: [number]
+
+
+    constructor(
+        description: string,
+        id: number,
+        name: string,
+        purposeIds: [number],
+        specialFeatureIds: [number]
+    ) {
+        this.description = description
+        this.id = id
+        this.name = name
+        this.purposeIds = purposeIds
+        this.specialFeatureIds = specialFeatureIds
+    }
+
+}
+
+export class TCFVendor {
+    consent?: boolean
+    features: [number]
+    flexiblePurposes: [number]
+    id: number
+    legitimateInterestConsent?: boolean
+    legitimateInterestPurposes: [number]
+    name: string
+    policyUrl: string
+    purposes: [number]
+    specialFeatures: [number]
+    specialPurposes: [number]
+    showConsentToggle: boolean
+    showLegitimateInterestToggle: boolean
+    cookieMaxAgeSeconds: number
+    usesNonCookieAccess: boolean
+    deviceStorageDisclosureUrl?: string
+    usesCookies: boolean
+    cookieRefresh?: boolean
+    dataSharedOutsideEU: boolean
+    dataCategories: [number]
+    vendorUrls: VendorUrl[]
+    restrictions: TCFVendorRestriction[]
+
+    constructor(
+        features: [number],
+        flexiblePurposes: [number],
+        id: number,
+        legitimateInterestPurposes: [number],
+        name: string,
+        policyUrl: string,
+        purposes: [number],
+        specialFeatures: [number],
+        specialPurposes: [number],
+        showConsentToggle: boolean,
+        showLegitimateInterestToggle: boolean,
+        cookieMaxAgeSeconds: number,
+        usesNonCookieAccess: boolean,
+        usesCookies: boolean,
+        dataSharedOutsideEU: boolean,
+        dataCategories: [number],
+        vendorUrls: VendorUrl[],
+        restrictions: TCFVendorRestriction[],
+        deviceStorageDisclosureUrl?: string,
+        legitimateInterestConsent?: boolean,
+        consent?: boolean,
+        cookieRefresh?: boolean,
+    ) {
+        this.consent = consent
+        this.features = features
+        this.flexiblePurposes = flexiblePurposes
+        this.id = id
+        this.legitimateInterestConsent = legitimateInterestConsent
+        this.legitimateInterestPurposes = legitimateInterestPurposes
+        this.name = name
+        this.policyUrl = policyUrl
+        this.purposes = purposes
+        this.specialFeatures = specialFeatures
+        this.specialPurposes = specialPurposes
+        this.showConsentToggle = showConsentToggle
+        this.showLegitimateInterestToggle = showLegitimateInterestToggle
+        this.cookieMaxAgeSeconds = cookieMaxAgeSeconds
+        this.usesNonCookieAccess = usesNonCookieAccess
+        this.deviceStorageDisclosureUrl = deviceStorageDisclosureUrl
+        this.usesCookies = usesCookies
+        this.cookieRefresh = cookieRefresh
+        this.dataSharedOutsideEU = dataSharedOutsideEU
+        this.dataCategories = dataCategories
+        this.vendorUrls = vendorUrls
+        this.restrictions = restrictions
+    }
+}
+
+export class VendorUrl {
+    langId?: string
+    privacy?: string
+    legIntClaim?: string
+
+    constructor(
+        langId: string,
+        privacy: string,
+        legIntClaim: string
+    ) {
+        this.langId = langId
+        this.privacy = privacy
+        this.legIntClaim = legIntClaim
+    }
+
+}
+
+export class TCFVendorRestriction {
+
+    purposeId: number
+    restrictionType: RestrictionType
+
+    constructor(
+        purposeId: number,
+        restrictionType: RestrictionType
+    ) {
+        this.purposeId = purposeId
+        this.restrictionType = restrictionType
+    }
+}
+
+export enum RestrictionType {
+    notAllowed = 0,
+    requireConsent = 1,
+    requireLi = 2,
+}

package/src/models/TCFDecisionUILayer.tsx

@@ -0,0 +1,5 @@
+export enum TCFDecisionUILayer {
+
+    firstLayer = 0,
+    secondLayer = 1
+}

package/src/models/TCFUserDecisions.tsx

@@ -0,0 +1,73 @@
+export class TCFUserDecisions {
+
+    /// A user's consent decision on TCF purposes.
+    purposes: TCFUserDecisionOnPurpose[]
+
+    /// A user's consent decision on TCF special features.
+    specialFeatures: TCFUserDecisionOnSpecialFeature[]
+
+    /// A user's consent decision on TCF vendors.
+    vendors: TCFUserDecisionOnVendor[]
+
+    /// A user's consent decision on Google Ad Tech Providers
+    adTechProviders: AdTechProviderDecision[]
+
+    constructor(purposes: TCFUserDecisionOnPurpose[],
+                specialFeatures: TCFUserDecisionOnSpecialFeature[],
+                vendors: TCFUserDecisionOnVendor[],
+                adTechProviders: AdTechProviderDecision[]) {
+        this.purposes = purposes
+        this.specialFeatures = specialFeatures
+        this.vendors = vendors
+        this.adTechProviders = adTechProviders
+    }
+}
+
+export class TCFUserDecisionOnPurpose {
+
+    id: number
+    consent?: boolean
+    legitimateInterestConsent?: boolean
+
+
+    constructor(id: number, consent?: boolean, legitimateInterestConsent?: boolean) {
+        this.id = id
+        this.consent = consent
+        this.legitimateInterestConsent = legitimateInterestConsent
+    }
+}
+
+export class TCFUserDecisionOnSpecialFeature {
+
+    id: number
+    consent?: boolean
+
+    constructor(id: number, consent?: boolean) {
+        this.id = id
+        this.consent = consent
+    }
+}
+
+export class TCFUserDecisionOnVendor {
+
+    id: number
+    consent?: boolean
+    legitimateInterestConsent?: boolean
+
+    constructor(id: number, consent?: boolean, legitimateInterestConsent?: boolean) {
+        this.id = id
+        this.consent = consent
+        this.legitimateInterestConsent = legitimateInterestConsent
+    }
+}
+
+export class AdTechProviderDecision {
+
+    id: number
+    consent: boolean
+
+    constructor(id: number, consent: boolean) {
+        this.id = id
+        this.consent = consent
+    }
+}

package/src/models/UserDecision.tsx

@@ -0,0 +1,10 @@
+export class UserDecision {
+
+    serviceId: string
+    consent: boolean
+
+    constructor(serviceId: string, consent: boolean) {
+        this.serviceId = serviceId
+        this.consent = consent
+    }
+}

package/src/models/UsercentricsAnalyticsEventType.tsx

@@ -0,0 +1,15 @@
+export enum UsercentricsAnalyticsEventType {
+
+    cmpShown = 0,
+    acceptAllFirstLayer = 1,
+    denyAllFirstLayer = 2,
+    saveFirstLayer = 3,
+    acceptAllSecondLayer = 4,
+    denyAllSecondLayer = 5,
+    saveSecondLayer = 6,
+    imprintLink = 7,
+    moreInformationLink = 8,
+    privacyPolicyLink = 9,
+    ccpaTogglesOn = 10,
+    ccpaTogglesOff = 11,
+}

package/src/models/UsercentricsCMPData.tsx

@@ -0,0 +1,38 @@
+import {UsercentricsCategory} from "./UsercentricsCategory";
+import {UsercentricsLocation} from "./UsercentricsLocation";
+import {UsercentricsService} from "./UsercentricsService";
+import {UsercentricsSettings} from "./UsercentricsSettings";
+import {UsercentricsVariant} from "./UsercentricsVariant";
+import { LegalBasisLocalization } from "./LegalBasisLocalization";
+
+export class UsercentricsCMPData {
+
+    /// The general settings defined for the settingsId.
+    settings: UsercentricsSettings
+    /// The services defined for the settingsId.
+    services: [UsercentricsService]
+    /// The categories defined for the settingsId.
+    categories: [UsercentricsCategory]
+    /// The active variant.
+    activeVariant: UsercentricsVariant
+    /// The current user location.
+    userLocation: UsercentricsLocation
+    // The current legal basis localization
+    legalBasis: LegalBasisLocalization
+
+    constructor(
+        settings: UsercentricsSettings,
+        services: [UsercentricsService],
+        categories: [UsercentricsCategory],
+        activeVariant: UsercentricsVariant,
+        userLocation: UsercentricsLocation,
+        legalBasis: LegalBasisLocalization
+    ) {
+        this.settings = settings
+        this.services = services
+        this.categories = categories
+        this.activeVariant = activeVariant
+        this.userLocation = userLocation
+        this.legalBasis = legalBasis
+    }
+}

package/src/models/UsercentricsCategory.tsx

@@ -0,0 +1,26 @@
+export class UsercentricsCategory {
+
+    /// The category slug identifier.
+    categorySlug: string
+
+    /// The label of the category if any.
+    label: string
+
+    /// The description of the category if any.
+    description: string
+
+    /// True, if it is an essential category. False, if not.
+    isEssential: boolean
+
+    constructor(
+        categorySlug: string,
+        label: string,
+        description: string,
+        isEssential: boolean
+    ) {
+        this.categorySlug = categorySlug
+        this.label = label
+        this.description = description
+        this.isEssential = isEssential
+    }
+}

package/src/models/UsercentricsConsentType.tsx

@@ -0,0 +1,5 @@
+export enum UsercentricsConsentType {
+
+    explicit = 0,
+    implicit = 1
+}

package/src/models/UsercentricsConsentUserResponse.tsx

@@ -0,0 +1,14 @@
+import {UsercentricsServiceConsent, UsercentricsUserInteraction} from "."
+
+export class UsercentricsConsentUserResponse {
+
+    controllerId: string
+    userInteraction: UsercentricsUserInteraction
+    consents: [UsercentricsServiceConsent]
+
+    constructor(controllerId: string, userIntaction: UsercentricsUserInteraction, consents: [UsercentricsServiceConsent]) {
+        this.controllerId = controllerId;
+        this.userInteraction = userIntaction
+        this.consents = consents
+    }
+}