@didomi/react-native 1.1.0 → 1.5.0

package/src/Didomi.ts

@@ -1,6 +1,7 @@
 import { NativeModules } from 'react-native';
 import { DidomiListener } from './DidomiListener';
 import { DidomiEventType } from './DidomiTypes';
+import { DIDOMI_USER_AGENT_NAME, DIDOMI_VERSION } from './Constants';
 
 const { Didomi: RNDidomi } = NativeModules;
 
@@ -30,6 +31,8 @@ export const Didomi = {
 
     // Trigger native SDK init
     RNDidomi.initialize(
+      DIDOMI_USER_AGENT_NAME,
+      DIDOMI_VERSION,
       apiKey,
       localConfigurationPath,
       remoteConfigurationUrl,
@@ -42,17 +45,17 @@ export const Didomi = {
 
   /**
    * Listen to SDK ready state
-   * */
+   */
   onReady: (): Promise<void> => DidomiListener.onReady(),
 
   /**
    * Listen to SDK errors
-   * */
+   */
   onError: (): Promise<any> => DidomiListener.onError(),
 
   /**
-    Provide the objects required to display UI elements
-  */
+   * Provide the objects required to display UI elements
+   */
   setupUI: (): Promise<void> => RNDidomi.setupUI(),
 
   /**
@@ -158,19 +161,16 @@ export const Didomi = {
    *  @param extra: Extra JavaScript to inject in the returned code
    *  @returns: JavaScript code to inject in a WebView
    */
-  getJavaScriptForWebView: (): Promise<string> =>
-    RNDidomi.getJavaScriptForWebView(),
+  getJavaScriptForWebView: (extra?: string | null): Promise<string> => RNDidomi.getJavaScriptForWebView(extra),
 
-  getQueryStringForWebView: (): Promise<string> =>
-    RNDidomi.getQueryStringForWebView(),
+  getQueryStringForWebView: (): Promise<string> => RNDidomi.getQueryStringForWebView(),
 
   /**
    *  Method used to get a Purpose based on its ID.
    *  @param purposeId: purpose ID used in the search.
    *  @returns: purpose found in the array.
    */
-  getPurpose: (purposeId: string): Promise<any> =>
-    RNDidomi.getPurpose(purposeId),
+  getPurpose: (purposeId: string): Promise<any> => RNDidomi.getPurpose(purposeId),
 
   /**
    *  Method used to get an array of required purposes.
@@ -226,72 +226,83 @@ export const Didomi = {
    *  @param key: used to find its corresponding value in one of the different sources.
    *  @returns: a translated string if a translation was found, the same key that was passed otherwise.
    */
-  getTranslatedText: (key: string): Promise<string> =>
-    RNDidomi.getTranslatedText(key),
+  getTranslatedText: (key: string): Promise<string> => RNDidomi.getTranslatedText(key),
 
   /**
    *  Get the user consent status for a specific purpose
    *  @param purposeId: The purpose ID to check consent for
    *  @returns: The user consent status for the specified purpose
+   *  @deprecated use {@link #getUserStatus()} instead. Search the purposeId in
+     * getUserStatus().getPurposes().getConsent().getEnabled() or
+   *  getUserStatus().getPurposes().getConsent().getDisabled().
    */
-  getUserConsentStatusForPurpose: (purposeId: string): Promise<boolean> =>
-    RNDidomi.getUserConsentStatusForPurpose(purposeId),
+  getUserConsentStatusForPurpose: (purposeId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForPurpose(purposeId),
 
   /**
    *  Get the user consent status for a specific vendor
    *  @param vendorId: The vendor ID to check consent for
    *  @returns: The user consent status for the specified vendor
+   *  @deprecated use {@link #getUserStatus()} instead. Search the vendorId in
+   *  getUserStatus().getVendors().getConsent().getEnabled() or
+   *  getUserStatus().getVendors().getConsent().getDisabled().
    */
-  getUserConsentStatusForVendor: (vendorId: string): Promise<boolean> =>
-    RNDidomi.getUserConsentStatusForVendor(vendorId),
+  getUserConsentStatusForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForVendor(vendorId),
 
   /**
    *  Get the user consent status for a specific vendor and all its purposes
    *  @param vendorId: The ID of the vendor
    *  @returns: The user consent status corresponding to the specified vendor and all its required purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method has been replaced
+   *  by getUserStatus().getVendors().getGlobalConsent().getEnabled() or
+   *  getUserStatus().getVendors().getGlobalConsent().getDisabled().
    */
-  getUserConsentStatusForVendorAndRequiredPurposes: (
-    vendorId: string
-  ): Promise<boolean> =>
-    RNDidomi.getUserConsentStatusForVendorAndRequiredPurposes(vendorId),
+  getUserConsentStatusForVendorAndRequiredPurposes: (vendorId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForVendorAndRequiredPurposes(vendorId),
 
   /**
    *  Get the user legitimate interest status for a specific purpose.
    *  @param purposeId: purpose ID.
    *  @returns: LI status of a purpose.
+   *  @deprecated use {@link #getUserStatus()} instead. Search the purposeId in
+   *  getUserStatus().getPurposes().getLegitimateInterest().getEnabled() or
+   *  getUserStatus().getPurposes().getLegitimateInterest().getDisabled().
    */
-  getUserLegitimateInterestStatusForPurpose: (
-    purposeId: string
-  ): Promise<boolean> =>
-    RNDidomi.getUserLegitimateInterestStatusForPurpose(purposeId),
+  getUserLegitimateInterestStatusForPurpose: (purposeId: string): Promise<boolean> => RNDidomi.getUserLegitimateInterestStatusForPurpose(purposeId),
 
   /**
    *  Get the user legitimate interest status for a specific vendor.
    *  @param vendorId: vendor ID.
    *  @returns: LI status of a vendor.
+   *  @deprecated use {@link #getUserStatus()} instead. Search the vendorId in
+   *  getUserStatus().getVendors().getLegitimateInterest().getEnabled() or
+   *  getUserStatus().getVendors().getLegitimateInterest().getDisabled().
    */
-  getUserLegitimateInterestForVendor: (vendorId: string): Promise<boolean> =>
-    RNDidomi.getUserLegitimateInterestStatusForVendor(vendorId),
+  getUserLegitimateInterestForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserLegitimateInterestStatusForVendor(vendorId),
 
   /**
    *  Get the user LI status for a specific vendor and all its purposes.
    *  @param vendorId: vendor ID.
    *  @returns: The user LI status corresponding to the specified vendor and all its required purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. Search the purposeId in
+   *  getUserStatus().getVendors().getGlobalLegitimateInterest().getEnabled() or
+   *  getUserStatus().getVendors().getGlobalLegitimateInterest().getDisabled().
    */
-  getUserLegitimateInterestStatusForVendorAndRequiredPurposes: (
-    vendorId: string
-  ): boolean =>
-    RNDidomi.getUserLegitimateInterestStatusForVendorAndRequiredPurposes(
-      vendorId
-    ),
+  getUserLegitimateInterestStatusForVendorAndRequiredPurposes: (vendorId: string): boolean => RNDidomi.getUserLegitimateInterestStatusForVendorAndRequiredPurposes(vendorId),
+
+  /**
+   *  Get the user consent status.
+   *  @returns: status that represents user consent.
+   */
+  getUserStatus: (): Promise<any> => RNDidomi.getUserStatus(),
 
   /**
    *  Get the user consent and legitimate interest status for a specific vendor.
    *  @param vendorId: vendor ID.
    *  @returns: status that represents both consent and legitimate interest status of a vendor.
+   *  @deprecated use {@link #getUserStatus()} instead. Search the vendorId in
+   *  getUserStatus().getVendors().getGlobal().getEnabled() or
+   *  getUserStatus().getVendors().getGlobal().getDisabled().
    */
-  getUserStatusForVendor: (vendorId: string): Promise<boolean> =>
-    RNDidomi.getUserStatusForVendor(vendorId),
+  getUserStatusForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserStatusForVendor(vendorId),
 
   /**
    *  Method used to get a Vendor based on its ID.
@@ -323,8 +334,7 @@ export const Didomi = {
    *  Determine if consent information is available for all purposes and vendors that are required
    *  @returns: **true** if consent is required and consent information is available, **false** otherwise.
    */
-  isUserConsentStatusPartial: (): Promise<boolean> =>
-    RNDidomi.isUserConsentStatusPartial(),
+  isUserConsentStatusPartial: (): Promise<boolean> => RNDidomi.isUserConsentStatusPartial(),
 
   /**
    *  Check if the consent notice is currently displayed
@@ -378,8 +388,7 @@ export const Didomi = {
    *  Show the preferences screen when/if the SDK is ready. By default the purposes list will be displayed.
    *  @param view: It can be `purposes` or `vendors`
    */
-  showPreferences: (view?: string): Promise<void> =>
-    RNDidomi.showPreferences(view),
+  showPreferences: (view?: string): Promise<void> => RNDidomi.showPreferences(view),
 
   /**
    *  Remove all consents for the user

package/src/DidomiTypes.ts

@@ -10,6 +10,8 @@ export enum DidomiEventType {
   NOTICE_CLICK_MORE_INFO = 'on_notice_click_more_info',
   NOTICE_CLICK_VIEW_VENDORS = 'on_notice_click_view_vendors',
   NOTICE_CLICK_PRIVACY_POLICY = 'on_notice_click_privacy_policy',
+  HIDE_PREFERENCES = 'on_hide_preferences',
+  SHOW_PREFERENCES = 'on_show_preferences',
   PREFERENCES_CLICK_AGREE_TO_ALL = 'on_preferences_click_agree_to_all',
   PREFERENCES_CLICK_DISAGREE_TO_ALL = 'on_preferences_click_disagree_to_all',
   PREFERENCES_CLICK_PURPOSE_AGREE = 'on_preferences_click_purpose_agree',
@@ -74,3 +76,33 @@ export interface Map<T> {
   [index: string]: T;
   [index: number]: T;
 }
+
+export interface UserStatus {
+  purposes: UserStatusPurposes;
+  vendors: UserStatusVendors;
+  userId: string;
+  created: string;
+  updated: string;
+  consentString: string;
+  additionalConsent: string;
+}
+
+export interface UserStatusPurposes {
+  global: UserStatusIds;
+  consent: UserStatusIds;
+  legitimateInterest: UserStatusIds;
+  essential: UserStatusIds;
+}
+
+export interface UserStatusVendors {
+  global: UserStatusIds;
+  globalConsent: UserStatusIds;
+  globalLegitimateInterest: UserStatusIds;
+  consent: UserStatusIds;
+  legitimateInterest: UserStatusIds;
+}
+
+export interface UserStatusIds {
+  disabled: string[];
+  enabled: string[];
+}