@didomi/react-native 2.3.0 → 2.5.0

package/lib/typescript/Didomi.d.ts

@@ -1,4 +1,4 @@
-import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus } from './DidomiTypes';
+import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus, UserAuthParams } from './DidomiTypes';
 import { CurrentUserStatusTransaction } from './CurrentUserStatusTransaction';
 export declare const Didomi: {
     /**
@@ -13,8 +13,10 @@ export declare const Didomi: {
      *  @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".
+     *  @param countryCode: Override user country code when determining the privacy regulation to apply. Keep undefined to let the Didomi SDK determine the user country.
+     *  @param regionCode: Override user region code when determining the privacy regulation to apply. Keep undefined to let the Didomi SDK determine the user region. Ignored if countryCode is not set.
      */
-    initialize: (apiKey: string, localConfigurationPath?: string, remoteConfigurationUrl?: string, providerId?: string, disableDidomiRemoteConfig?: boolean, languageCode?: string, noticeId?: string, androidTvNoticeId?: string, androidTvEnabled?: boolean) => Promise<void>;
+    initialize: (apiKey: string, localConfigurationPath?: string, remoteConfigurationUrl?: string, providerId?: string, disableDidomiRemoteConfig?: boolean, languageCode?: string, noticeId?: string, androidTvNoticeId?: string, androidTvEnabled?: boolean, countryCode?: string, regionCode?: string) => Promise<void>;
     /**
      * Listen to SDK ready state
      */
@@ -80,57 +82,49 @@ export declare 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().purposes.consent.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getDisabledPurposes: () => Promise<Purpose[]>;
     /**
      *  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().purposes.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getDisabledPurposeIds: () => Promise<string[]>;
     /**
      *  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().vendors.consent.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getDisabledVendors: () => Promise<Vendor[]>;
     /**
      *  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().vendors.consent.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getDisabledVendorIds: () => Promise<string[]>;
     /**
      *  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().purposes.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getEnabledPurposes: () => Promise<Purpose[]>;
     /**
      *  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().purposes.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getEnabledPurposeIds: () => Promise<string[]>;
     /**
      *  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().vendors.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getEnabledVendors: () => Promise<Vendor[]>;
     /**
      *  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().vendors.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getEnabledVendorIds: () => Promise<string[]>;
     /**
@@ -157,6 +151,7 @@ export declare const Didomi: {
     /**
      *  Get the configured purpose IDs
      *  @returns: set of purpose IDs.
+     *  @deprecated use {@link #getRequiredPurposes()} instead.
      */
     getRequiredPurposeIds: () => Promise<string[]>;
     /**
@@ -167,6 +162,7 @@ export declare const Didomi: {
     /**
      *  Get the configured vendor IDs
      *  @returns: set of vendor IDs.
+     *  @deprecated use {@link #getRequiredVendors()} instead.
      */
     getRequiredVendorIds: () => Promise<string[]>;
     /**
@@ -202,54 +198,42 @@ export declare const Didomi: {
      *  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().purposes.consent.enabled or
-     *  getUserStatus().purposes.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserConsentStatusForPurpose: (purposeId: string) => Promise<boolean>;
     /**
      *  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().vendors.consent.enabled or
-     *  getUserStatus().vendors.consent.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserConsentStatusForVendor: (vendorId: string) => Promise<boolean>;
     /**
      *  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().vendors.global_consent.enabled or
-     *  getUserStatus().vendors.global_consent.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserConsentStatusForVendorAndRequiredPurposes: (vendorId: string) => Promise<boolean>;
     /**
      *  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().purposes.consent.enabled or
-     *  getUserStatus().purposes.consent.enabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserLegitimateInterestStatusForPurpose: (purposeId: string) => Promise<boolean>;
     /**
      *  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().vendors.legitimate_interest.enabled or
-     *  getUserStatus().vendors.legitimate_interest.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserLegitimateInterestForVendor: (vendorId: string) => Promise<boolean>;
     /**
      *  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().vendors.global_legitimate_interest.enabled or
-     *  getUserStatus().vendors.global_legitimate_interest.disabled.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserLegitimateInterestStatusForVendorAndRequiredPurposes: (vendorId: string) => boolean;
     /**
@@ -260,6 +244,7 @@ export declare const Didomi: {
     /**
      *  Get the user consent status.
      *  @returns: status that represents user consent.
+     *  @deprecated use {@link #getCurrentUserStatus()} instead.
      */
     getUserStatus: () => Promise<UserStatus>;
     /**
@@ -291,6 +276,7 @@ export declare const Didomi: {
      *  - The company is from the EU.
      *  - The user country is unknown and the app has chosen to collect consent when unknown.
      *  @returns: **true** if consent is required, **false** if it is not required.
+     *  @deprecated use {@link #shouldUserStatusBeCollected()} instead.
      */
     isConsentRequired: () => Promise<boolean>;
     /**
@@ -304,6 +290,7 @@ export declare 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.
+     *  @deprecated use {@link #isUserStatusPartial()} instead.
      */
     isUserConsentStatusPartial: () => Promise<boolean>;
     /**
@@ -351,6 +338,7 @@ export declare const Didomi: {
      *  @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)
+     *  @deprecated use {@link #setUserWithAuthParams()} instead.
      */
     setUserWithHashAuth: (id: string, algorithm: string, secretId: string, digest: string, salt?: string, expiration?: BigInt) => void;
     /**
@@ -362,6 +350,7 @@ export declare const Didomi: {
      *  @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)
+     *  @deprecated use {@link #setUserWithAuthParamsAndSetupUI()} instead.
      */
     setUserWithHashAuthAndSetupUI: (id: string, algorithm: string, secretId: string, digest: string, salt?: string, expiration?: BigInt) => void;
     /**
@@ -372,6 +361,7 @@ export declare const Didomi: {
      *  @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)
+     *  @deprecated use {@link #setUserWithAuthParams()} instead.
      */
     setUserWithEncryptionAuth: (id: string, algorithm: string, secretId: string, initializationVector: string, expiration?: BigInt) => void;
     /**
@@ -382,8 +372,23 @@ export declare const Didomi: {
      *  @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)
+     *  @deprecated use {@link #setUserWithAuthParamsAndSetupUI()} instead.
      */
     setUserWithEncryptionAuthAndSetupUI: (id: string, algorithm: string, secretId: string, initializationVector: string, expiration?: BigInt) => void;
+    /**
+     *  Set user information with authentication (Hash or Encryption)
+     *
+     *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
+     *  @param synchronizedUsers as UserAuthParams[] (optional)
+     */
+    setUserWithAuthParams: (userAuthParams: UserAuthParams, synchronizedUsers?: UserAuthParams[] | undefined) => void;
+    /**
+     *  Set user information with authentication (Hash or Encryption) and check for missing consent
+     *
+     *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
+     *  @param synchronizedUsers as UserAuthParams[] (optional)
+     */
+    setUserWithAuthParamsAndSetupUI: (userAuthParams: UserAuthParams, synchronizedUsers?: UserAuthParams[] | undefined) => void;
     /**
      * Show the consent notice (if required, not disabled in the config and not already displayed)
      */
@@ -409,6 +414,7 @@ export declare const Didomi: {
      *  @param enabledVendorIds: set containing **enabled vendor ids**
      *  @param disabledVendorIds: set containing **disabled purpose ids**
      *  @returns: **true** if consent status has been updated, **false** otherwise.
+     *  @deprecated use {@link #setCurrentUserStatus()} instead.
      */
     setUserConsentStatus: (enabledPurposeIds: string[], disabledPurposeIds: string[], enabledVendorIds: string[], disabledVendorIds: string[]) => Promise<boolean>;
     /**
@@ -441,6 +447,7 @@ export declare const Didomi: {
      *  @param disabledConsentVendorIds: List of vendor IDs to disable for consent.
      *  @param enabledLIVendorIds: List of vendor IDs to enable for LI.
      *  @param disabledLIVendorIds: List of vendor IDs to disable for LI.
+     *  @deprecated use {@link #setCurrentUserStatus()} instead.
      */
     setUserStatusSets: (enabledConsentPurposeIds: string[], disabledConsentPurposeIds: string[], enabledLIPurposeIds: string[], disabledLIPurposeIds: string[], enabledConsentVendorIds: string[], disabledConsentVendorIds: string[], enabledLIVendorIds: string[], disabledLIVendorIds: string[]) => Promise<boolean>;
     /**

package/lib/typescript/DidomiTypes.d.ts

@@ -127,3 +127,16 @@ export interface SyncReadyEvent {
     statusApplied: boolean;
     syncAcknowledged: () => Promise<boolean>;
 }
+export interface UserAuthParams {
+    id: string;
+    algorithm: string;
+    secretId: string;
+    expiration?: number;
+}
+export interface UserAuthWithEncryptionParams extends UserAuthParams {
+    initializationVector: string;
+}
+export interface UserAuthWithHashParams extends UserAuthParams {
+    digest: string;
+    salt?: string;
+}

package/lib/typescript/index.d.ts

@@ -1,2 +1,2 @@
 export { Didomi } from './Didomi';
-export { DidomiEventType, Vendor, VendorNamespaces, Purpose, UserStatus, UserStatusPurposes, UserStatusVendors, UserStatusIds, CurrentUserStatus, PurposeStatus, VendorStatus } from './DidomiTypes';
+export { DidomiEventType, Vendor, VendorNamespaces, Purpose, UserStatus, UserStatusPurposes, UserStatusVendors, UserStatusIds, CurrentUserStatus, PurposeStatus, VendorStatus, UserAuthWithEncryptionParams, UserAuthWithHashParams } from './DidomiTypes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@didomi/react-native",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "description": "Didomi React Native SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

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", "2.6.0"
+  s.dependency "Didomi-XCFramework", "2.9.2"
 end

package/src/Constants.ts

@@ -1,4 +1,4 @@
 // User agent name
 export const DIDOMI_USER_AGENT_NAME = "Didomi React-Native SDK"
 // User agent version
-export const DIDOMI_VERSION = "2.3.0"
+export const DIDOMI_VERSION = "2.5.0"

package/src/Didomi.ts

@@ -1,6 +1,6 @@
 import { NativeModules } from 'react-native';
 import { DidomiListener } from './DidomiListener';
-import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus } from './DidomiTypes';
+import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus, UserAuthParams } from './DidomiTypes';
 import { DIDOMI_USER_AGENT_NAME, DIDOMI_VERSION } from './Constants';
 import { CurrentUserStatusTransaction, createCurrentUserStatusTransaction } from './CurrentUserStatusTransaction';
 
@@ -19,6 +19,8 @@ export const Didomi = {
    *  @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".
+   *  @param countryCode: Override user country code when determining the privacy regulation to apply. Keep undefined to let the Didomi SDK determine the user country.
+   *  @param regionCode: Override user region code when determining the privacy regulation to apply. Keep undefined to let the Didomi SDK determine the user region. Ignored if countryCode is not set.
    */
   initialize: (
     apiKey: string,
@@ -29,7 +31,9 @@ export const Didomi = {
     languageCode?: string,
     noticeId?: string,
     androidTvNoticeId?: string,
-    androidTvEnabled: boolean = false
+    androidTvEnabled: boolean = false,
+    countryCode?: string,
+    regionCode?: string,
   ): Promise<void> => {
     // Init listener
     DidomiListener.init();
@@ -46,7 +50,9 @@ export const Didomi = {
       languageCode,
       noticeId,
       androidTvNoticeId,
-      androidTvEnabled
+      androidTvEnabled,
+      countryCode,
+      regionCode
     );
   },
 
@@ -147,64 +153,56 @@ 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().purposes.consent.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getDisabledPurposes: (): Promise<Purpose[]> => 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().purposes.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getDisabledPurposeIds: (): Promise<string[]> => 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().vendors.consent.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getDisabledVendors: (): Promise<Vendor[]> => 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().vendors.consent.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getDisabledVendorIds: (): Promise<string[]> => 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().purposes.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getEnabledPurposes: (): Promise<Purpose[]> => 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().purposes.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getEnabledPurposeIds: (): Promise<string[]> => 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().vendors.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getEnabledVendors: (): Promise<Vendor[]> => 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().vendors.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getEnabledVendorIds: (): Promise<string[]> => RNDidomi.getEnabledVendorIds(),
 
@@ -236,6 +234,7 @@ export const Didomi = {
   /**
    *  Get the configured purpose IDs
    *  @returns: set of purpose IDs.
+   *  @deprecated use {@link #getRequiredPurposes()} instead.
    */
   getRequiredPurposeIds: (): Promise<string[]> => RNDidomi.getRequiredPurposeIds(),
 
@@ -248,6 +247,7 @@ export const Didomi = {
   /**
    *  Get the configured vendor IDs
    *  @returns: set of vendor IDs.
+   *  @deprecated use {@link #getRequiredVendors()} instead.
    */
   getRequiredVendorIds: (): Promise<string[]> => RNDidomi.getRequiredVendorIds(),
 
@@ -286,9 +286,7 @@ export const Didomi = {
    *  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().purposes.consent.enabled or
-   *  getUserStatus().purposes.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserConsentStatusForPurpose: (purposeId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForPurpose(purposeId),
 
@@ -296,9 +294,7 @@ export const Didomi = {
    *  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().vendors.consent.enabled or
-   *  getUserStatus().vendors.consent.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserConsentStatusForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForVendor(vendorId),
 
@@ -306,9 +302,7 @@ export const Didomi = {
    *  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().vendors.global_consent.enabled or
-   *  getUserStatus().vendors.global_consent.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserConsentStatusForVendorAndRequiredPurposes: (vendorId: string): Promise<boolean> => RNDidomi.getUserConsentStatusForVendorAndRequiredPurposes(vendorId),
 
@@ -316,9 +310,7 @@ export const Didomi = {
    *  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().purposes.consent.enabled or
-   *  getUserStatus().purposes.consent.enabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserLegitimateInterestStatusForPurpose: (purposeId: string): Promise<boolean> => RNDidomi.getUserLegitimateInterestStatusForPurpose(purposeId),
 
@@ -326,9 +318,7 @@ export const Didomi = {
    *  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().vendors.legitimate_interest.enabled or
-   *  getUserStatus().vendors.legitimate_interest.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserLegitimateInterestForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserLegitimateInterestStatusForVendor(vendorId),
 
@@ -336,9 +326,7 @@ export const Didomi = {
    *  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().vendors.global_legitimate_interest.enabled or
-   *  getUserStatus().vendors.global_legitimate_interest.disabled.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserLegitimateInterestStatusForVendorAndRequiredPurposes: (vendorId: string): boolean => RNDidomi.getUserLegitimateInterestStatusForVendorAndRequiredPurposes(vendorId),
 
@@ -351,6 +339,7 @@ export const Didomi = {
   /**
    *  Get the user consent status.
    *  @returns: status that represents user consent.
+   *  @deprecated use {@link #getCurrentUserStatus()} instead.
    */
   getUserStatus: (): Promise<UserStatus> => RNDidomi.getUserStatus(),
 
@@ -387,6 +376,7 @@ export const Didomi = {
    *  - The company is from the EU.
    *  - The user country is unknown and the app has chosen to collect consent when unknown.
    *  @returns: **true** if consent is required, **false** if it is not required.
+   *  @deprecated use {@link #shouldUserStatusBeCollected()} instead.
    */
   isConsentRequired: (): Promise<boolean> => RNDidomi.isConsentRequired(),
 
@@ -402,6 +392,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.
+   *  @deprecated use {@link #isUserStatusPartial()} instead.
    */
   isUserConsentStatusPartial: (): Promise<boolean> => RNDidomi.isUserConsentStatusPartial(),
 
@@ -458,6 +449,7 @@ export const Didomi = {
    *  @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)
+   *  @deprecated use {@link #setUserWithAuthParams()} instead.
    */
   setUserWithHashAuth: (
     id: string,
@@ -496,6 +488,7 @@ export const Didomi = {
    *  @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)
+   *  @deprecated use {@link #setUserWithAuthParamsAndSetupUI()} instead.
    */
   setUserWithHashAuthAndSetupUI: (
     id: string,
@@ -533,6 +526,7 @@ export const Didomi = {
    *  @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)
+   *  @deprecated use {@link #setUserWithAuthParams()} instead.
    */
   setUserWithEncryptionAuth: (
     id: string,
@@ -567,6 +561,7 @@ export const Didomi = {
    *  @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)
+   *  @deprecated use {@link #setUserWithAuthParamsAndSetupUI()} instead.
    */
   setUserWithEncryptionAuthAndSetupUI: (
     id: string,
@@ -593,6 +588,28 @@ export const Didomi = {
     }
   },
 
+  /**
+   *  Set user information with authentication (Hash or Encryption)
+   *
+   *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
+   *  @param synchronizedUsers as UserAuthParams[] (optional)
+   */
+  setUserWithAuthParams: (
+    userAuthParams: UserAuthParams,
+    synchronizedUsers?: UserAuthParams[] | undefined
+  ): void => RNDidomi.setUserWithAuthParams(JSON.stringify(userAuthParams), JSON.stringify(synchronizedUsers)),
+
+  /**
+   *  Set user information with authentication (Hash or Encryption) and check for missing consent
+   *
+   *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
+   *  @param synchronizedUsers as UserAuthParams[] (optional)
+   */
+  setUserWithAuthParamsAndSetupUI: (
+    userAuthParams: UserAuthParams,
+    synchronizedUsers?: UserAuthParams[] | undefined
+  ): void => RNDidomi.setUserWithAuthParamsAndSetupUI(JSON.stringify(userAuthParams), JSON.stringify(synchronizedUsers)),
+
   /**
    * Show the consent notice (if required, not disabled in the config and not already displayed)
    */
@@ -622,6 +639,7 @@ export const Didomi = {
    *  @param enabledVendorIds: set containing **enabled vendor ids**
    *  @param disabledVendorIds: set containing **disabled purpose ids**
    *  @returns: **true** if consent status has been updated, **false** otherwise.
+   *  @deprecated use {@link #setCurrentUserStatus()} instead.
    */
   setUserConsentStatus: (
     enabledPurposeIds: string[],
@@ -685,6 +703,7 @@ export const Didomi = {
    *  @param disabledConsentVendorIds: List of vendor IDs to disable for consent.
    *  @param enabledLIVendorIds: List of vendor IDs to enable for LI.
    *  @param disabledLIVendorIds: List of vendor IDs to disable for LI.
+   *  @deprecated use {@link #setCurrentUserStatus()} instead.
    */
   setUserStatusSets: (
     enabledConsentPurposeIds: string[],

package/src/DidomiTypes.ts

@@ -153,3 +153,19 @@ export interface SyncReadyEvent {
   statusApplied: boolean;
   syncAcknowledged: () => Promise<boolean>;
 }
+
+export interface UserAuthParams {
+  id: string;
+  algorithm: string;
+  secretId: string;
+  expiration?: number;
+}
+
+export interface UserAuthWithEncryptionParams extends UserAuthParams {
+  initializationVector: string;
+}
+
+export interface UserAuthWithHashParams extends UserAuthParams {
+  digest: string;
+  salt?: string;
+}

package/src/index.tsx

@@ -1,2 +1,16 @@
 export { Didomi } from './Didomi';
-export { DidomiEventType, Vendor, VendorNamespaces, Purpose, UserStatus, UserStatusPurposes, UserStatusVendors, UserStatusIds, CurrentUserStatus, PurposeStatus, VendorStatus } from './DidomiTypes';
+export {
+    DidomiEventType,
+    Vendor,
+    VendorNamespaces,
+    Purpose,
+    UserStatus,
+    UserStatusPurposes,
+    UserStatusVendors,
+    UserStatusIds,
+    CurrentUserStatus,
+    PurposeStatus,
+    VendorStatus,
+    UserAuthWithEncryptionParams,
+    UserAuthWithHashParams
+} from './DidomiTypes';