@didomi/react-native 1.3.0 → 1.6.0

package/lib/typescript/Didomi.d.ts

@@ -14,15 +14,15 @@ export declare const Didomi: {
     initialize: (apiKey: string, localConfigurationPath?: string | undefined, remoteConfigurationUrl?: string | undefined, providerId?: string | undefined, disableDidomiRemoteConfig?: boolean, languageCode?: string | undefined, noticeId?: string | undefined) => void;
     /**
      * Listen to SDK ready state
-     * */
+     */
     onReady: () => Promise<void>;
     /**
      * Listen to SDK errors
-     * */
+     */
     onError: () => Promise<any>;
     /**
-      Provide the objects required to display UI elements
-    */
+     * Provide the objects required to display UI elements
+     */
     setupUI: () => Promise<void>;
     /**
      * Set the minimum level of messages to log
@@ -278,15 +278,36 @@ export declare const Didomi: {
      */
     isReady: () => Promise<boolean>;
     /**
-     *  Set user information with authentication
+     *  Set user information without authentication
+     *
+     *  @param id Organization user ID
+     *  @param algorithm Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+     *  @param secretId Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+     *  @param salt Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+     *  @param digest Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+     */
+    setUser: (organizationUserId: string, organizationUserIdAuthAlgorithm?: string | undefined, organizationUserIdAuthSid?: string | undefined, organizationUserIdAuthSalt?: string | undefined, organizationUserIdAuthDigest?: string | undefined) => Promise<void>;
+    /**
+     *  Set user information with Hash 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 salt Salt used for computing the digest (optional)
      *  @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)
+     */
+    setUserWithHashAuth: (organizationUserId: string, algorithm: string, secretId: string, digest: string, salt?: string | undefined, expiration?: BigInt | undefined) => void;
+    /**
+     *  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)
      */
-    setUser: (organizationUserId: string, organizationUserIdAuthAlgorithm: string, organizationUserIdAuthSid: string, organizationUserIdAuthSalt: string, organizationUserIdAuthDigest: string) => Promise<void>;
+    setUserWithEncryptionAuth: (organizationUserId: string, algorithm: string, secretId: string, initializationVector: string, expiration?: BigInt | undefined) => void;
     /**
      * Show the consent notice (if required, not disabled in the config and not already displayed)
      */

package/lib/typescript/DidomiTypes.d.ts

@@ -28,7 +28,8 @@ export declare enum DidomiEventType {
     PREFERENCES_CLICK_AGREE_TO_ALL_PURPOSES = "on_preferences_click_agree_to_all_purposes",
     PREFERENCES_CLICK_DISAGREE_TO_ALL_PURPOSES = "on_preferences_click_disagree_to_all_purposes",
     PREFERENCES_CLICK_RESET_ALL_PURPOSES = "on_preferences_click_reset_all_purposes",
-    SYNC_DONE = "on_sync_done"
+    SYNC_DONE = "on_sync_done",
+    SYNC_ERROR = "on_sync_error"
 }
 export interface Vendor {
     id: string;
@@ -46,7 +47,7 @@ export interface VendorNamespaces {
 }
 export interface Purpose {
     id: string;
-    iAbId: string;
+    iabId: string;
     name: string;
     description: string;
     descriptionLegal: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@didomi/react-native",
-  "version": "1.3.0",
-  "description": "React Native Didomi SDK",
+  "version": "1.6.0",
+  "description": "Didomi React Native SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
   "types": "lib/typescript/index.d.ts",

package/react-native-didomi.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "Didomi-XCFramework", "1.62.0"
+  s.dependency "Didomi-XCFramework", "1.67.1"
 end

package/src/Constants.ts

@@ -0,0 +1,4 @@
+// User agent name
+export const DIDOMI_USER_AGENT_NAME = "Didomi React-Native SDK"
+// User agent version
+export const DIDOMI_VERSION = "1.6.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: (extra?: string | null): Promise<string> =>
-    RNDidomi.getJavaScriptForWebView(extra),
+  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,8 +226,7 @@ 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
@@ -237,8 +236,7 @@ export const Didomi = {
      * 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
@@ -248,8 +246,7 @@ export const Didomi = {
    *  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
@@ -259,10 +256,7 @@ export const Didomi = {
    *  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.
@@ -272,10 +266,7 @@ export const Didomi = {
    *  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.
@@ -285,8 +276,7 @@ export const Didomi = {
    *  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.
@@ -296,12 +286,7 @@ export const Didomi = {
    *  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.
@@ -317,8 +302,7 @@ export const Didomi = {
    *  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.
@@ -350,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
@@ -373,20 +356,20 @@ export const Didomi = {
   isReady: (): Promise<boolean> => RNDidomi.isReady(),
 
   /**
-   *  Set user information with authentication
+   *  Set user information without 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 salt Salt used for computing the digest (optional)
-   *  @param digest Digest of the organization user ID and secret
+   *  @param algorithm Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+   *  @param secretId Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+   *  @param salt Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
+   *  @param digest Deprecated. To set user with authentication, use setUserWithHashAuth or setUserWithEncryptionAuth.
    */
   setUser: (
     organizationUserId: string,
-    organizationUserIdAuthAlgorithm: string,
-    organizationUserIdAuthSid: string,
-    organizationUserIdAuthSalt: string,
-    organizationUserIdAuthDigest: string
+    organizationUserIdAuthAlgorithm?: string,
+    organizationUserIdAuthSid?: string,
+    organizationUserIdAuthSalt?: string,
+    organizationUserIdAuthDigest?: string
   ): Promise<void> =>
     RNDidomi.setUser(
       organizationUserId,
@@ -396,6 +379,78 @@ export const Didomi = {
       organizationUserIdAuthDigest
     ),
 
+  /**
+   *  Set user information with Hash 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 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)
+   */
+  setUserWithHashAuth: (
+    organizationUserId: string,
+    algorithm: string,
+    secretId: string,
+    digest: string,
+    salt?: string,
+    expiration?: BigInt
+  ): void => {
+    if (expiration === undefined) {
+      RNDidomi.setUserWithHashAuth(
+        organizationUserId,
+        algorithm,
+        secretId,
+        digest,
+        salt
+      );
+    } else {
+      RNDidomi.setUserWithHashAuthWithExpiration(
+        organizationUserId,
+        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: (
+      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
+        );
+      }
+    },
+
   /**
    * Show the consent notice (if required, not disabled in the config and not already displayed)
    */
@@ -405,8 +460,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/DidomiListener.ts

@@ -15,6 +15,8 @@ export const DidomiListener = {
   init: () => {
     // Register all native event listeners
     Object.values(DidomiEventType).forEach((eventTypeValue) => {
+      // Remove previous listeners, as init() can be called several times in some configs
+      DidomiListener.eventEmitter.removeAllListeners(eventTypeValue);
       DidomiListener.eventEmitter.addListener(eventTypeValue, (_event: any) => {
         let events = DidomiListener.listeners.get(eventTypeValue);
         if (events) {

package/src/DidomiTypes.ts

@@ -30,6 +30,7 @@ export enum DidomiEventType {
   PREFERENCES_CLICK_DISAGREE_TO_ALL_PURPOSES = 'on_preferences_click_disagree_to_all_purposes',
   PREFERENCES_CLICK_RESET_ALL_PURPOSES = 'on_preferences_click_reset_all_purposes',
   SYNC_DONE = 'on_sync_done',
+  SYNC_ERROR = 'on_sync_error',
 }
 
 export interface Vendor {
@@ -50,7 +51,7 @@ export interface VendorNamespaces {
 
 export interface Purpose {
   id: string;
-  iAbId: string;
+  iabId: string;
   name: string;
   description: string;
   descriptionLegal: string;