@didomi/react-native 1.6.0 → 1.10.0

package/src/Didomi.ts

@@ -13,9 +13,11 @@ export const Didomi = {
    *  @param localConfigurationPath: Path to your local config file. Defaults to didomi_config.json if null.
    *  @param remoteConfigurationURL: URL to a remote configuration file to load during initialization. This parameter is not used yet. Set it to null for now.
    *  @param providerId: Your provider ID (if any).
-   *  @param disableDidomiRemoteConfig: Whether to disable loading the remove configuration from the Didomi config. Keep this to "false" for loading configuration from the Didomi Console.
+   *  @param disableDidomiRemoteConfig: Whether to disable loading the remote configuration from the Didomi config. Keep this to "false" for loading configuration from the Didomi Console.
    *  @param languageCode: Language in which the consent UI should be displayed. By default, the consent UI is displayed in the language configured in the device settings. This property allows you to override the default setting and specify a language to display the UI in. String containing the language code e.g.: "es", "fr", etc.
    *  @param noticeId: Notice id for the remote configuration.
+   *  @param androidTvNoticeId: Notice id for the remote configuration when running on Android TV device (ignored on iOS / tvOS). Note that using remote configuration is mandatory for TV devices.
+   *  @param androidTvEnabled: Whether to allow Didomi SDK to run on Android TV, default to "false".
    */
   initialize: (
     apiKey: string,
@@ -24,13 +26,15 @@ export const Didomi = {
     providerId?: string,
     disableDidomiRemoteConfig: boolean = false,
     languageCode?: string,
-    noticeId?: string
-  ) => {
+    noticeId?: string,
+    androidTvNoticeId?: string,
+    androidTvEnabled: boolean = false
+  ): Promise<void> => {
     // Init listener
     DidomiListener.init();
 
     // Trigger native SDK init
-    RNDidomi.initialize(
+    return RNDidomi.initialize(
       DIDOMI_USER_AGENT_NAME,
       DIDOMI_VERSION,
       apiKey,
@@ -39,7 +43,9 @@ export const Didomi = {
       providerId,
       disableDidomiRemoteConfig,
       languageCode,
-      noticeId
+      noticeId,
+      androidTvNoticeId,
+      androidTvEnabled
     );
   },
 
@@ -81,7 +87,7 @@ export const Didomi = {
    *
    * @param minLevel: Minimum level of messages to log
    */
-  setLogLevel: (level: number): Promise<number> => RNDidomi.setLogLevel(level),
+  setLogLevel: (level: number): Promise<void> => RNDidomi.setLogLevel(level),
 
   /**
    *  Add an event listener
@@ -109,48 +115,64 @@ export const Didomi = {
   /**
    *  Method used to get an array of disabled purposes.
    *  @returns: array of disabled purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getPurposes().getConsent().getDisabled().
    */
   getDisabledPurposes: (): Promise<any[]> => RNDidomi.getDisabledPurposes(),
 
   /**
    *  Method used to get a set of disabled purpose IDs.
    *  @returns: set that contains the IDs of disabled purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getPurposes().getConsent().getDisabled().
    */
   getDisabledPurposeIds: (): Promise<any[]> => RNDidomi.getDisabledPurposeIds(),
 
   /**
    *  Method used to get an array of disabled vendors.
    *  @returns: array of disabled vendors.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getVendors().getConsent().getDisabled().
    */
   getDisabledVendors: (): Promise<any[]> => RNDidomi.getDisabledVendors(),
 
   /**
    *  Method used to get a set of disabled vendor IDs.
    *  @returns: set that contains the IDs of disabled vendors.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getVendors().getConsent().getDisabled().
    */
   getDisabledVendorIds: (): Promise<any[]> => RNDidomi.getDisabledVendorIds(),
 
   /**
    *  Method used to get an array of enabled purposes.
    *  @returns: array of enabled purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getPurposes().getConsent().getEnabled().
    */
   getEnabledPurposes: (): Promise<any[]> => RNDidomi.getEnabledPurposes(),
 
   /**
    *  Method used to get a set of enabled purpose IDs.
    *  @returns: set that contains the IDs of enabled purposes.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getPurposes().getConsent().getEnabled().
    */
   getEnabledPurposeIds: (): Promise<any[]> => RNDidomi.getEnabledPurposeIds(),
 
   /**
    *  Method used to get an array of enabled vendors.
    *  @returns: array of enabled vendors.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getVendors().getConsent().getEnabled().
    */
   getEnabledVendors: (): Promise<any[]> => RNDidomi.getEnabledVendors(),
 
   /**
    *  Method used to get a set of enabled vendor IDs.
    *  @returns: set that contains the IDs of enabled vendors.
+   *  @deprecated use {@link #getUserStatus()} instead. The result of this method
+   *  has been replaced by getUserStatus().getVendors().getConsent().getEnabled().
    */
   getEnabledVendorIds: (): Promise<any[]> => RNDidomi.getEnabledVendorIds(),
 
@@ -355,6 +377,11 @@ export const Didomi = {
    */
   isReady: (): Promise<boolean> => RNDidomi.isReady(),
 
+  /**
+   *  Clear user information
+   */
+  clearUser: (): Promise<void> => RNDidomi.clearUser(),
+
   /**
    *  Set user information without authentication
    *
@@ -365,20 +392,27 @@ export const Didomi = {
    *  @param digest Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
    */
   setUser: (
-    organizationUserId: string,
-    organizationUserIdAuthAlgorithm?: string,
-    organizationUserIdAuthSid?: string,
-    organizationUserIdAuthSalt?: string,
-    organizationUserIdAuthDigest?: string
+    id: string,
+    algorithm?: string,
+    secretId?: string,
+    salt?: string,
+    digest?: string
   ): Promise<void> =>
     RNDidomi.setUser(
-      organizationUserId,
-      organizationUserIdAuthAlgorithm,
-      organizationUserIdAuthSid,
-      organizationUserIdAuthSalt,
-      organizationUserIdAuthDigest
+      id,
+      algorithm,
+      secretId,
+      salt,
+      digest
     ),
 
+  /**
+   *  Set user information without authentication and check for missing consent
+   *
+   *  @param id Organization user ID
+   */
+  setUserAndSetupUI: (id: string): Promise<void> => RNDidomi.setUserAndSetupUI(id),
+
   /**
    *  Set user information with Hash authentication
    *
@@ -390,7 +424,7 @@ export const Didomi = {
    *  @param expiration Expiration date as timestamp (to prevent replay attacks)
    */
   setUserWithHashAuth: (
-    organizationUserId: string,
+    id: string,
     algorithm: string,
     secretId: string,
     digest: string,
@@ -399,7 +433,7 @@ export const Didomi = {
   ): void => {
     if (expiration === undefined) {
       RNDidomi.setUserWithHashAuth(
-        organizationUserId,
+        id,
         algorithm,
         secretId,
         digest,
@@ -407,7 +441,7 @@ export const Didomi = {
       );
     } else {
       RNDidomi.setUserWithHashAuthWithExpiration(
-        organizationUserId,
+        id,
         algorithm,
         secretId,
         digest,
@@ -417,39 +451,111 @@ export const Didomi = {
     }
   },
 
-    /**
-     *  Set user information with Encryption authentication
-     *
-     *  @param id Organization user ID
-     *  @param algorithm Algorithm used for computing the digest
-     *  @param secretId ID of the secret used for computing the digest
-     *  @param initializationVector Initialization Vector used for computing the user ID
-     *  @param expiration Expiration date as timestamp (to prevent replay attacks)
-     */
-    setUserWithEncryptionAuth: (
-      organizationUserId: string,
-      algorithm: string,
-      secretId: string,
-      initializationVector: string,
-      expiration?: BigInt
-    ): void => {
-      if (expiration === undefined) {
-        RNDidomi.setUserWithEncryptionAuth(
-          organizationUserId,
-          algorithm,
-          secretId,
-          initializationVector
-        );
-      } else {
-        RNDidomi.setUserWithEncryptionAuthWithExpiration(
-          organizationUserId,
-          algorithm,
-          secretId,
-          initializationVector,
-          expiration
-        );
-      }
-    },
+  /**
+   *  Set user information with Hash authentication and check for missing consent
+   *
+   *  @param id Organization user ID
+   *  @param algorithm Algorithm used for computing the digest
+   *  @param secretId ID of the secret used for computing the digest
+   *  @param digest Digest of the organization user ID and secret
+   *  @param salt Salt used for computing the digest (optional)
+   *  @param expiration Expiration date as timestamp (to prevent replay attacks)
+   */
+  setUserWithHashAuthAndSetupUI: (
+    id: string,
+    algorithm: string,
+    secretId: string,
+    digest: string,
+    salt?: string,
+    expiration?: BigInt
+  ): void => {
+    if (expiration === undefined) {
+      RNDidomi.setUserWithHashAuthAndSetupUI(
+        id,
+        algorithm,
+        secretId,
+        digest,
+        salt
+      );
+    } else {
+      RNDidomi.setUserWithHashAuthWithExpirationAndSetupUI(
+        id,
+        algorithm,
+        secretId,
+        digest,
+        salt,
+        expiration
+      );
+    }
+  },
+
+  /**
+   *  Set user information with Encryption authentication
+   *
+   *  @param id Organization user ID
+   *  @param algorithm Algorithm used for computing the digest
+   *  @param secretId ID of the secret used for computing the digest
+   *  @param initializationVector Initialization Vector used for computing the user ID
+   *  @param expiration Expiration date as timestamp (to prevent replay attacks)
+   */
+  setUserWithEncryptionAuth: (
+    id: string,
+    algorithm: string,
+    secretId: string,
+    initializationVector: string,
+    expiration?: BigInt
+  ): void => {
+    if (expiration === undefined) {
+      RNDidomi.setUserWithEncryptionAuth(
+        id,
+        algorithm,
+        secretId,
+        initializationVector
+      );
+    } else {
+      RNDidomi.setUserWithEncryptionAuthWithExpiration(
+        id,
+        algorithm,
+        secretId,
+        initializationVector,
+        expiration
+      );
+    }
+  },
+
+  /**
+   *  Set user information with Encryption authentication and check for missing consent
+   *
+   *  @param id Organization user ID
+   *  @param algorithm Algorithm used for computing the digest
+   *  @param secretId ID of the secret used for computing the digest
+   *  @param initializationVector Initialization Vector used for computing the user ID
+   *  @param expiration Expiration date as timestamp (to prevent replay attacks)
+   */
+  setUserWithEncryptionAuthAndSetupUI: (
+    id: string,
+    algorithm: string,
+    secretId: string,
+    initializationVector: string,
+    expiration?: BigInt
+  ): void => {
+    if (expiration === undefined) {
+      RNDidomi.setUserWithEncryptionAuthAndSetupUI(
+        id,
+        algorithm,
+        secretId,
+        initializationVector
+      );
+    } else {
+      RNDidomi.setUserWithEncryptionAuthWithExpirationAndSetupUI(
+        id,
+        algorithm,
+        secretId,
+        initializationVector,
+        expiration
+      );
+    }
+  },
 
   /**
    * Show the consent notice (if required, not disabled in the config and not already displayed)

package/src/DidomiTypes.ts

@@ -31,6 +31,8 @@ export enum DidomiEventType {
   PREFERENCES_CLICK_RESET_ALL_PURPOSES = 'on_preferences_click_reset_all_purposes',
   SYNC_DONE = 'on_sync_done',
   SYNC_ERROR = 'on_sync_error',
+  LANGUAGE_UPDATED = "on_language_updated",
+  LANGUAGE_UPDATE_FAILED = "on_language_update_failed",
 }
 
 export interface Vendor {
@@ -86,6 +88,7 @@ export interface UserStatus {
   updated: string;
   consentString: string;
   additionalConsent: string;
+  regulation: string;
 }
 
 export interface UserStatusPurposes {