@didomi/react-native 2.8.0 → 2.10.0

package/lib/typescript/Didomi.d.ts

@@ -1,4 +1,4 @@
-import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus, UserAuthParams } from './DidomiTypes';
+import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus, UserAuthParams, DidomiInitializeParameters, DidomiUserParameters } from './DidomiTypes';
 import { CurrentUserStatusTransaction } from './CurrentUserStatusTransaction';
 export declare const Didomi: {
     /**
@@ -15,8 +15,15 @@ export declare const Didomi: {
      *  @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.
+     *  @deprecated Use {@link #initializeWithParameters} instead
      */
     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>;
+    /**
+     * Initialize the Didomi SDK with parameters
+     * @param parameters: Parameters to initialize the Didomi SDK
+     * @returns: Promise that resolves we have called the native initialize method
+     */
+    initializeWithParameters: (parameters: DidomiInitializeParameters) => Promise<void>;
     /**
      * Listen to SDK ready state
      */
@@ -256,6 +263,11 @@ export declare const Didomi: {
      *  getUserStatus().vendors.global.disabled.
      */
     getUserStatusForVendor: (vendorId: string) => Promise<boolean>;
+    /**
+     * Determine the regulation applicable for the user.
+     * @returns: the regulation applicable for the current user. If no regulation is applicable, will return "none".
+     */
+    getApplicableRegulation: () => Promise<string>;
     /**
      *  Method used to get a Vendor based on its ID.
      *  @param vendorId: vendor ID used in the search.
@@ -353,7 +365,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.
+     *  @deprecated Use {@link setUserWithParameters} instead
      */
     setUserWithHashAuth: (id: string, algorithm: string, secretId: string, digest: string, salt?: string, expiration?: BigInt) => void;
     /**
@@ -365,7 +377,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.
+     *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
      */
     setUserWithHashAuthAndSetupUI: (id: string, algorithm: string, secretId: string, digest: string, salt?: string, expiration?: BigInt) => void;
     /**
@@ -376,7 +388,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.
+     *  @deprecated Use {@link setUserWithParameters} instead
      */
     setUserWithEncryptionAuth: (id: string, algorithm: string, secretId: string, initializationVector: string, expiration?: BigInt) => void;
     /**
@@ -387,7 +399,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 #setUserWithAuthParamsAndSetupUI()} instead.
+     *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
      */
     setUserWithEncryptionAuthAndSetupUI: (id: string, algorithm: string, secretId: string, initializationVector: string, expiration?: BigInt) => void;
     /**
@@ -395,6 +407,7 @@ export declare const Didomi: {
      *
      *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
      *  @param synchronizedUsers as UserAuthParams[] (optional)
+     *  @deprecated Use {@link setUserWithParameters} instead
      */
     setUserWithAuthParams: (userAuthParams: UserAuthParams, synchronizedUsers?: UserAuthParams[] | undefined) => void;
     /**
@@ -402,15 +415,28 @@ export declare const Didomi: {
      *
      *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
      *  @param synchronizedUsers as UserAuthParams[] (optional)
+     *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
      */
     setUserWithAuthParamsAndSetupUI: (userAuthParams: UserAuthParams, synchronizedUsers?: UserAuthParams[] | undefined) => void;
+    /**
+     *  Set user information with parameters
+     *
+     *  @param parameters as DidomiUserParameters
+     */
+    setUserWithParameters: (parameters: DidomiUserParameters) => void;
+    /**
+     *  Set user information with parameters and check for missing consent
+     *
+     *  @param parameters as DidomiUserParameters
+     */
+    setUserWithParametersAndSetupUI: (parameters: DidomiUserParameters) => void;
     /**
      * Show the consent notice (if required, not disabled in the config and not already displayed)
      */
     showNotice: () => Promise<void>;
     /**
      *  Show the preferences screen when/if the SDK is ready. By default the purposes list will be displayed.
-     *  @param view: It can be `purposes`, `vendors` or `senstive-personal-information`.
+     *  @param view: It can be `purposes` or `vendors`. Note: `sensitive-personal-information` is deprecated and should not be used, as SPI purposes are now displayed in the `purposes` screen.
      */
     showPreferences: (view?: string) => Promise<void>;
     /**

package/lib/typescript/Didomi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Didomi.d.ts","sourceRoot":"","sources":["../../src/Didomi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE9H,OAAO,EAAE,4BAA4B,EAAsC,MAAM,gCAAgC,CAAC;AAIlH,eAAO,MAAM,MAAM;IACjB;;;;;;;;;;;;;;OAcG;yBAEO,MAAM,2BACW,MAAM,2BACN,MAAM,eAClB,MAAM,8BACQ,OAAO,iBACnB,MAAM,aACV,MAAM,sBACG,MAAM,qBACR,OAAO,gBACX,MAAM,eACP,MAAM,KAClB,OAAO,CAAC,IAAI,CAAC;IAsBhB;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAM1B;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAM1B;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;OAsBG;yBACkB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE3C;;;OAGG;kCAEU,eAAe,YAChB,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAG/B;;;;;OAKG;wCAES,MAAM,YACN,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI;IAMhD;;;OAGG;2CACoC,MAAM;IAK7C;;;OAGG;qCAEU,eAAe,YAChB,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAG/B;;OAEG;;IAGH;;;;OAIG;+BACsB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE3C;;;;OAIG;iCACwB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE5C;;;;OAIG;8BACqB,OAAO,CAAC,MAAM,EAAE,CAAC;IAEzC;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;OAIG;8BACqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE1C;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;OAIG;6BACoB,OAAO,CAAC,MAAM,EAAE,CAAC;IAExC;;;;OAIG;+BACsB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE1C;;;;;;OAMG;sCAC+B,MAAM,GAAG,IAAI,KAAG,OAAO,CAAC,MAAM,CAAC;oCAEnC,OAAO,CAAC,MAAM,CAAC;IAE7C;;;;OAIG;4BACqB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEjD;;;;OAIG;+BACsB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE3C;;;;OAIG;iCACwB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE5C;;;OAGG;8BACqB,OAAO,CAAC,MAAM,EAAE,CAAC;IAEzC;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;;OAKG;mBACY,MAAM,KAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAEtC;;;;;;;;;;;;;;;;;;;;OAoBG;6BACsB,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC;IAEjD;;;;;OAKG;gDACyC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAErE;;;;;OAKG;8CACuC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEnE;;;;;OAKG;iEAC0D,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEtF;;;;;OAKG;2DACoD,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEhF;;;;;OAKG;mDAC4C,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;OAKG;4EACqE,MAAM,KAAG,OAAO;IAExF;;;OAGG;gCACuB,OAAO,CAAC,iBAAiB,CAAC;IAEpD;;;;OAIG;yBACgB,OAAO,CAAC,UAAU,CAAC;IAEtC;;;;;;;OAOG;uCACgC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAE5D;;;;OAIG;0BACmB,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC;IAE9C;;;OAGG;+BACsB,OAAO,CAAC,MAAM,CAAC;IAExC;;;OAGG;6BACoB,OAAO,CAAC,MAAM,CAAC;IAEtC;;;OAGG;gCACuB,OAAO,CAAC,MAAM,CAAC;IAEzC;;OAEG;sBACa,OAAO,CAAC,IAAI,CAAC;IAE7B;;OAEG;2BACkB,OAAO,CAAC,IAAI,CAAC;IAElC;;;;;;;OAOG;6BACoB,OAAO,CAAC,OAAO,CAAC;IAEvC;;;;;;OAMG;uCAC8B,OAAO,CAAC,OAAO,CAAC;IAEjD;;;;OAIG;sCAC6B,OAAO,CAAC,OAAO,CAAC;IAEhD;;;OAGG;+BACsB,OAAO,CAAC,OAAO,CAAC;IAEzC;;;OAGG;2BACkB,OAAO,CAAC,OAAO,CAAC;IAErC;;;OAGG;gCACuB,OAAO,CAAC,OAAO,CAAC;mBAE7B,OAAO,CAAC,OAAO,CAAC;IAE7B;;OAEG;mBACU,OAAO,CAAC,OAAO,CAAC;IAE7B;;OAEG;qBACY,OAAO,CAAC,IAAI,CAAC;IAE5B;;;;OAIG;kBACW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAEpC;;;;OAIG;4BACqB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;8BAEG,MAAM,aACC,MAAM,YACP,MAAM,UACR,MAAM,SACP,MAAM,eACA,MAAM,KAClB,IAAI;IAqBP;;;;;;;;;;OAUG;wCAEG,MAAM,aACC,MAAM,YACP,MAAM,UACR,MAAM,SACP,MAAM,eACA,MAAM,KAClB,IAAI;IAqBP;;;;;;;;;OASG;oCAEG,MAAM,aACC,MAAM,YACP,MAAM,wBACM,MAAM,eACf,MAAM,KAClB,IAAI;IAmBP;;;;;;;;;OASG;8CAEG,MAAM,aACC,MAAM,YACP,MAAM,wBACM,MAAM,eACf,MAAM,KAClB,IAAI;IAmBP;;;;;OAKG;4CAEe,cAAc,sBACV,cAAc,EAAE,GAAG,SAAS,KAC/C,IAAI;IAEP;;;;;OAKG;sDAEe,cAAc,sBACV,cAAc,EAAE,GAAG,SAAS,KAC/C,IAAI;IAEP;;OAEG;sBACa,OAAO,CAAC,IAAI,CAAC;IAE7B;;;OAGG;6BACsB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;iBACQ,OAAO,CAAC,IAAI,CAAC;IAExB;;;OAGG;6BACoB,OAAO,CAAC,OAAO,CAAC;IAEvC;;;;;;;;OAQG;8CAEkB,MAAM,EAAE,sBACP,MAAM,EAAE,oBACV,MAAM,EAAE,qBACP,MAAM,EAAE,KAC1B,OAAO,CAAC,OAAO,CAAC;IAQnB;;;OAGG;gCACuB,OAAO,CAAC,OAAO,CAAC;IAE1C;;;;OAIG;8CAEkB,iBAAiB,KACnC,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;;;;OAOG;2CAEsB,OAAO,oBACZ,OAAO,wBACH,OAAO,mBACZ,OAAO,KACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;OAWG;kDAEyB,MAAM,EAAE,6BACP,MAAM,EAAE,uBACd,MAAM,EAAE,wBACP,MAAM,EAAE,2BACL,MAAM,EAAE,4BACP,MAAM,EAAE,sBACd,MAAM,EAAE,uBACP,MAAM,EAAE,KAC5B,OAAO,CAAC,OAAO,CAAC;IAYnB;;;;OAIG;oCAC2B,OAAO,CAAC,OAAO,CAAC;IAG9C;;;;;OAKG;2CACoC,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAG7D;;;;;OAKG;4CACmC,4BAA4B;CACnE,CAAC"}
+{"version":3,"file":"Didomi.d.ts","sourceRoot":"","sources":["../../src/Didomi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,iBAAiB,EAAE,YAAY,EAAE,cAAc,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAEhL,OAAO,EAAE,4BAA4B,EAAsC,MAAM,gCAAgC,CAAC;AAIlH,eAAO,MAAM,MAAM;IACjB;;;;;;;;;;;;;;;OAeG;yBAEO,MAAM,2BACW,MAAM,2BACN,MAAM,eAClB,MAAM,8BACQ,OAAO,iBACnB,MAAM,aACV,MAAM,sBACG,MAAM,qBACR,OAAO,gBACX,MAAM,eACP,MAAM,KAClB,OAAO,CAAC,IAAI,CAAC;IAsBhB;;;;OAIG;2CACoC,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAAC;IAYjF;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAM1B;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAM1B;;OAEG;mBACU,OAAO,CAAC,IAAI,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;OAsBG;yBACkB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE3C;;;OAGG;kCAEU,eAAe,YAChB,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAG/B;;;;;OAKG;wCAES,MAAM,YACN,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI;IAMhD;;;OAGG;2CACoC,MAAM;IAK7C;;;OAGG;qCAEU,eAAe,YAChB,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAG/B;;OAEG;;IAGH;;;;OAIG;+BACsB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE3C;;;;OAIG;iCACwB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE5C;;;;OAIG;8BACqB,OAAO,CAAC,MAAM,EAAE,CAAC;IAEzC;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;OAIG;8BACqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE1C;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;OAIG;6BACoB,OAAO,CAAC,MAAM,EAAE,CAAC;IAExC;;;;OAIG;+BACsB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE1C;;;;;;OAMG;sCAC+B,MAAM,GAAG,IAAI,KAAG,OAAO,CAAC,MAAM,CAAC;oCAEnC,OAAO,CAAC,MAAM,CAAC;IAE7C;;;;OAIG;4BACqB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEjD;;;;OAIG;+BACsB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE3C;;;;OAIG;iCACwB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE5C;;;OAGG;8BACqB,OAAO,CAAC,MAAM,EAAE,CAAC;IAEzC;;;;OAIG;gCACuB,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C;;;;;OAKG;mBACY,MAAM,KAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAEtC;;;;;;;;;;;;;;;;;;;;OAoBG;6BACsB,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC;IAEjD;;;;;OAKG;gDACyC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAErE;;;;;OAKG;8CACuC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEnE;;;;;OAKG;iEAC0D,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEtF;;;;;OAKG;2DACoD,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAEhF;;;;;OAKG;mDAC4C,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;OAKG;4EACqE,MAAM,KAAG,OAAO;IAExF;;;OAGG;gCACuB,OAAO,CAAC,iBAAiB,CAAC;IAEpD;;;;OAIG;yBACgB,OAAO,CAAC,UAAU,CAAC;IAEtC;;;;;;;OAOG;uCACgC,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;IAE5D;;;OAGG;mCAC0B,OAAO,CAAC,MAAM,CAAC;IAE5C;;;;OAIG;0BACmB,MAAM,KAAG,OAAO,CAAC,MAAM,CAAC;IAE9C;;;OAGG;+BACsB,OAAO,CAAC,MAAM,CAAC;IAExC;;;OAGG;6BACoB,OAAO,CAAC,MAAM,CAAC;IAEtC;;;OAGG;gCACuB,OAAO,CAAC,MAAM,CAAC;IAEzC;;OAEG;sBACa,OAAO,CAAC,IAAI,CAAC;IAE7B;;OAEG;2BACkB,OAAO,CAAC,IAAI,CAAC;IAElC;;;;;;;OAOG;6BACoB,OAAO,CAAC,OAAO,CAAC;IAEvC;;;;;;OAMG;uCAC8B,OAAO,CAAC,OAAO,CAAC;IAEjD;;;;OAIG;sCAC6B,OAAO,CAAC,OAAO,CAAC;IAEhD;;;OAGG;+BACsB,OAAO,CAAC,OAAO,CAAC;IAEzC;;;OAGG;2BACkB,OAAO,CAAC,OAAO,CAAC;IAErC;;;OAGG;gCACuB,OAAO,CAAC,OAAO,CAAC;mBAE7B,OAAO,CAAC,OAAO,CAAC;IAE7B;;OAEG;mBACU,OAAO,CAAC,OAAO,CAAC;IAE7B;;OAEG;qBACY,OAAO,CAAC,IAAI,CAAC;IAE5B;;;;OAIG;kBACW,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAEpC;;;;OAIG;4BACqB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE9C;;;;;;;;;;OAUG;8BAEG,MAAM,aACC,MAAM,YACP,MAAM,UACR,MAAM,SACP,MAAM,eACA,MAAM,KAClB,IAAI;IAqBP;;;;;;;;;;OAUG;wCAEG,MAAM,aACC,MAAM,YACP,MAAM,UACR,MAAM,SACP,MAAM,eACA,MAAM,KAClB,IAAI;IAqBP;;;;;;;;;OASG;oCAEG,MAAM,aACC,MAAM,YACP,MAAM,wBACM,MAAM,eACf,MAAM,KAClB,IAAI;IAmBP;;;;;;;;;OASG;8CAEG,MAAM,aACC,MAAM,YACP,MAAM,wBACM,MAAM,eACf,MAAM,KAClB,IAAI;IAmBP;;;;;;OAMG;4CAEe,cAAc,sBACV,cAAc,EAAE,GAAG,SAAS,KAC/C,IAAI;IAEP;;;;;;OAMG;sDAEe,cAAc,sBACV,cAAc,EAAE,GAAG,SAAS,KAC/C,IAAI;IAEP;;;;OAIG;wCACiC,oBAAoB,KAAG,IAAI;IAE/D;;;;OAIG;kDAC2C,oBAAoB,KAAG,IAAI;IAEzE;;OAEG;sBACa,OAAO,CAAC,IAAI,CAAC;IAE7B;;;OAGG;6BACsB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;iBACQ,OAAO,CAAC,IAAI,CAAC;IAExB;;;OAGG;6BACoB,OAAO,CAAC,OAAO,CAAC;IAEvC;;;;;;;;OAQG;8CAEkB,MAAM,EAAE,sBACP,MAAM,EAAE,oBACV,MAAM,EAAE,qBACP,MAAM,EAAE,KAC1B,OAAO,CAAC,OAAO,CAAC;IAQnB;;;OAGG;gCACuB,OAAO,CAAC,OAAO,CAAC;IAE1C;;;;OAIG;8CAEkB,iBAAiB,KACnC,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;;;;OAOG;2CAEsB,OAAO,oBACZ,OAAO,wBACH,OAAO,mBACZ,OAAO,KACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;OAWG;kDAEyB,MAAM,EAAE,6BACP,MAAM,EAAE,uBACd,MAAM,EAAE,wBACP,MAAM,EAAE,2BACL,MAAM,EAAE,4BACP,MAAM,EAAE,sBACd,MAAM,EAAE,uBACP,MAAM,EAAE,KAC5B,OAAO,CAAC,OAAO,CAAC;IAYnB;;;;OAIG;oCAC2B,OAAO,CAAC,OAAO,CAAC;IAG9C;;;;;OAKG;2CACoC,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;IAG7D;;;;;OAKG;4CACmC,4BAA4B;CACnE,CAAC"}

package/lib/typescript/DidomiTypes.d.ts

@@ -7,6 +7,9 @@ export declare enum DidomiEventType {
     NOTICE_CLICK_AGREE = "on_notice_click_agree",
     NOTICE_CLICK_DISAGREE = "on_notice_click_disagree",
     NOTICE_CLICK_VIEW_VENDORS = "on_notice_click_view_vendors",
+    /**
+     * @deprecated SPI purposes are now displayed in preferences screen, use {@link #NOTICE_CLICK_MORE_INFO} instead.
+     */
     NOTICE_CLICK_VIEW_SPI_PURPOSES = "on_notice_click_view_spi_purposes",
     NOTICE_CLICK_MORE_INFO = "on_notice_click_more_info",
     NOTICE_CLICK_PRIVACY_POLICY = "on_notice_click_privacy_policy",
@@ -14,6 +17,9 @@ export declare enum DidomiEventType {
     SHOW_PREFERENCES = "on_show_preferences",
     PREFERENCES_CLICK_VIEW_PURPOSES = "on_preferences_click_view_purposes",
     PREFERENCES_CLICK_VIEW_VENDORS = "on_preferences_click_view_vendors",
+    /**
+     *  @deprecated SPI purposes are now displayed in preferences screen.
+     */
     PREFERENCES_CLICK_VIEW_SPI_PURPOSES = "on_preferences_click_view_spi_purposes",
     PREFERENCES_CLICK_AGREE_TO_ALL = "on_preferences_click_agree_to_all",
     PREFERENCES_CLICK_DISAGREE_TO_ALL = "on_preferences_click_disagree_to_all",
@@ -30,13 +36,31 @@ export declare enum DidomiEventType {
     PREFERENCES_CLICK_VENDOR_AGREE = "on_preferences_click_vendor_agree",
     PREFERENCES_CLICK_VENDOR_DISAGREE = "on_preferences_click_vendor_disagree",
     PREFERENCES_CLICK_VENDOR_SAVE_CHOICES = "on_preferences_click_vendor_save_choices",
+    /**
+     * @deprecated SPI purposes are now treated as other purposes, use {@link #PREFERENCES_CLICK_PURPOSE_AGREE} instead.
+     */
     PREFERENCES_CLICK_SPI_PURPOSE_AGREE = "on_preferences_click_spi_purpose_agree",
+    /**
+     * @deprecated SPI purposes are now treated as other purposes, use {@link #PREFERENCES_CLICK_PURPOSE_DISAGREE} instead.
+     */
     PREFERENCES_CLICK_SPI_PURPOSE_DISAGREE = "on_preferences_click_spi_purpose_disagree",
+    /**
+     * @deprecated SPI purposes are now treated as other purposes, use {@link #PREFERENCES_CLICK_CATEGORY_AGREE} instead.
+     */
     PREFERENCES_CLICK_SPI_CATEGORY_AGREE = "on_preferences_click_spi_category_agree",
+    /**
+     * @deprecated SPI purposes are now treated as other purposes, use {@link #PREFERENCES_CLICK_CATEGORY_DISAGREE} instead.
+     */
     PREFERENCES_CLICK_SPI_CATEGORY_DISAGREE = "on_preferences_click_spi_category_disagree",
+    /**
+     * @deprecated SPI purposes are now displayed in preferences screen, use {@link #PREFERENCES_CLICK_SAVE_CHOICES} instead.
+     */
     PREFERENCES_CLICK_SPI_PURPOSE_SAVE_CHOICES = "on_preferences_click_spi_purpose_save_choices",
     SYNC_READY = "on_sync_ready",
     SYNC_ERROR = "on_sync_error",
+    /**
+     * @deprecated use {@link #SYNC_READY} instead.
+     */
     SYNC_DONE = "on_sync_done",
     LANGUAGE_UPDATED = "on_language_updated",
     LANGUAGE_UPDATE_FAILED = "on_language_update_failed"
@@ -128,8 +152,10 @@ export interface SyncReadyEvent {
     statusApplied: boolean;
     syncAcknowledged: () => Promise<boolean>;
 }
-export interface UserAuthParams {
+export interface UserAuth {
     id: string;
+}
+export interface UserAuthParams extends UserAuth {
     algorithm: string;
     secretId: string;
     expiration?: number;
@@ -141,4 +167,118 @@ export interface UserAuthWithHashParams extends UserAuthParams {
     digest: string;
     salt?: string;
 }
+/**
+ * Initialization parameters for Didomi SDK
+ * @interface
+ */
+export interface DidomiInitializeParameters {
+    /**
+     * Public API key of the organization from the Didomi Console.
+     * @property
+     */
+    apiKey: string;
+    /**
+     * Path to your local config file. Defaults to didomi_config.json if nil.
+     * @property
+     */
+    localConfigurationPath?: string;
+    /**
+     * URL to a remote configuration file to load during initialization. This parameter is not used yet. Set it to nil for now.
+     * @property
+     */
+    remoteConfigurationUrl?: string;
+    /**
+     * The provider ID (if any).
+     * @property
+     */
+    providerId?: string;
+    /**
+     * Whether to disable loading the remove configuration from the Didomi config. Keep this to `false` for loading configuration from the Didomi Console.
+     * @property
+     * @deprecated In the future, it will be mandatory to create your notice from the console (see https://developers.didomi.io/cmp/mobile-sdk/android/setup#from-the-console-recommended for more information).
+     */
+    disableDidomiRemoteConfig?: boolean;
+    /**
+     * 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.
+     * @property
+     */
+    languageCode?: string;
+    /**
+     * ID of the notice configuration to load from the Didomi Console.
+     * @property
+     */
+    noticeId?: string;
+    /**
+     * ID of the notice to display on Android TV
+     * @property
+     */
+    androidTvNoticeId?: string;
+    /**
+     * Enable/disable Android TV specific features
+     * @property
+     */
+    androidTvEnabled?: boolean;
+    /**
+     * Override user country code when determining the privacy regulation to apply.
+     * Keep `undefined` to let the Didomi SDK determine the user country.
+     * @property
+     */
+    countryCode?: string;
+    /**
+     * 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.
+     * @property
+     */
+    regionCode?: string;
+    /**
+     * If set to `true`, the SDK will only display the underage notice (`false` by default).
+     * @property
+     */
+    isUnderage?: boolean;
+}
+/**
+ * Object that contains the parameters for the setUser method.
+ * @interface
+ */
+export interface DidomiUserParameters {
+    /**
+     * @property
+     */
+    userId?: string;
+    /**
+     * Main user authentication
+     * - [UserAuthWithEncryptionParams] (encryption)
+     * - [UserAuthWithHashParams] (hash)
+     * - [UserAuthWithoutParams] (ID only)
+     * @property
+     */
+    userAuth?: UserAuth;
+    /**
+     * User authentication for Didomi Consent String
+     * - [UserAuthWithEncryptionParams] (encryption)
+     * - [UserAuthWithHashParams] (hash)
+     * @property
+     */
+    dcsUserAuth?: UserAuthParams;
+    /**
+     * If the user is underage (undefined will keep the previous setting)
+     * @property
+     */
+    isUnderage?: boolean;
+}
+/**
+ * Object that contains the parameters for the setUser method including synchronized users.
+ * @interface
+ */
+export interface DidomiMultiUserParameters extends DidomiUserParameters {
+    /**
+     * Synchronized user list
+     * - [UserAuthWithEncryptionParams] (encryption)
+     * - [UserAuthWithHashParams] (hash)
+     * @property
+     */
+    synchronizedUsers?: UserAuthParams[];
+}
 //# sourceMappingURL=DidomiTypes.d.ts.map

package/lib/typescript/DidomiTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DidomiTypes.d.ts","sourceRoot":"","sources":["../../src/DidomiTypes.ts"],"names":[],"mappings":"AACA,oBAAY,eAAe;IAEvB,eAAe,uBAAuB;IAEtC,KAAK,aAAa;IAClB,KAAK,aAAa;IAElB,WAAW,mBAAmB;IAC9B,WAAW,mBAAmB;IAC9B,kBAAkB,0BAA0B;IAC5C,qBAAqB,6BAA6B;IAClD,yBAAyB,iCAAiC;IAC1D,8BAA8B,sCAAsC;IACpE,sBAAsB,8BAA8B;IACpD,2BAA2B,mCAAmC;IAE9D,gBAAgB,wBAAwB;IACxC,gBAAgB,wBAAwB;IAExC,+BAA+B,uCAAuC;IACtE,8BAA8B,sCAAsC;IACpE,mCAAmC,2CAA2C;IAE9E,8BAA8B,sCAAsC;IACpE,iCAAiC,yCAAyC;IAC1E,uCAAuC,+CAA+C;IACtF,0CAA0C,kDAAkD;IAC5F,oCAAoC,4CAA4C;IAChF,+BAA+B,uCAAuC;IACtE,kCAAkC,0CAA0C;IAC5E,gCAAgC,wCAAwC;IACxE,mCAAmC,2CAA2C;IAC9E,8BAA8B,sCAAsC;IAEpE,sCAAsC,8CAA8C;IACpF,yCAAyC,iDAAiD;IAC1F,8BAA8B,sCAAsC;IACpE,iCAAiC,yCAAyC;IAC1E,qCAAqC,6CAA6C;IAElF,mCAAmC,2CAA2C;IAC9E,sCAAsC,8CAA8C;IACpF,oCAAoC,4CAA4C;IAChF,uCAAuC,+CAA+C;IACtF,0CAA0C,kDAAkD;IAE5F,UAAU,kBAAkB;IAC5B,UAAU,kBAAkB;IAE5B,SAAS,iBAAiB;IAE1B,gBAAgB,wBAAwB;IACxC,sBAAsB,8BAA8B;CACvD;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,GAAG,CAAC,CAAC;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;IACnB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,mBAAmB,EAAE,aAAa,CAAC;IACnC,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,cAAc,EAAE,aAAa,CAAC;IAC9B,0BAA0B,EAAE,aAAa,CAAC;IAC1C,OAAO,EAAE,aAAa,CAAC;IACvB,mBAAmB,EAAE,aAAa,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"DidomiTypes.d.ts","sourceRoot":"","sources":["../../src/DidomiTypes.ts"],"names":[],"mappings":"AACA,oBAAY,eAAe;IAEvB,eAAe,uBAAuB;IAEtC,KAAK,aAAa;IAClB,KAAK,aAAa;IAElB,WAAW,mBAAmB;IAC9B,WAAW,mBAAmB;IAC9B,kBAAkB,0BAA0B;IAC5C,qBAAqB,6BAA6B;IAClD,yBAAyB,iCAAiC;IAC1D;;OAEG;IACH,8BAA8B,sCAAsC;IACpE,sBAAsB,8BAA8B;IACpD,2BAA2B,mCAAmC;IAE9D,gBAAgB,wBAAwB;IACxC,gBAAgB,wBAAwB;IAExC,+BAA+B,uCAAuC;IACtE,8BAA8B,sCAAsC;IACpE;;OAEG;IACH,mCAAmC,2CAA2C;IAE9E,8BAA8B,sCAAsC;IACpE,iCAAiC,yCAAyC;IAC1E,uCAAuC,+CAA+C;IACtF,0CAA0C,kDAAkD;IAC5F,oCAAoC,4CAA4C;IAChF,+BAA+B,uCAAuC;IACtE,kCAAkC,0CAA0C;IAC5E,gCAAgC,wCAAwC;IACxE,mCAAmC,2CAA2C;IAC9E,8BAA8B,sCAAsC;IAEpE,sCAAsC,8CAA8C;IACpF,yCAAyC,iDAAiD;IAC1F,8BAA8B,sCAAsC;IACpE,iCAAiC,yCAAyC;IAC1E,qCAAqC,6CAA6C;IAElF;;OAEG;IACH,mCAAmC,2CAA2C;IAC9E;;OAEG;IACH,sCAAsC,8CAA8C;IACpF;;OAEG;IACH,oCAAoC,4CAA4C;IAChF;;OAEG;IACH,uCAAuC,+CAA+C;IACtF;;OAEG;IACH,0CAA0C,kDAAkD;IAE5F,UAAU,kBAAkB;IAC5B,UAAU,kBAAkB;IAC5B;;OAEG;IACH,SAAS,iBAAiB;IAE1B,gBAAgB,wBAAwB;IACxC,sBAAsB,8BAA8B;CACvD;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,GAAG,CAAC,CAAC;IACpB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;IACnB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,mBAAmB,EAAE,aAAa,CAAC;IACnC,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,cAAc,EAAE,aAAa,CAAC;IAC9B,0BAA0B,EAAE,aAAa,CAAC;IAC1C,OAAO,EAAE,aAAa,CAAC;IACvB,mBAAmB,EAAE,aAAa,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,cAAc,EAAE,CAAC;CACtC"}

package/lib/typescript/index.d.ts

@@ -1,3 +1,3 @@
 export { Didomi } from './Didomi';
-export { DidomiEventType, Vendor, VendorNamespaces, Purpose, UserStatus, UserStatusPurposes, UserStatusVendors, UserStatusIds, CurrentUserStatus, PurposeStatus, VendorStatus, UserAuthWithEncryptionParams, UserAuthWithHashParams } from './DidomiTypes';
+export { DidomiEventType, Vendor, VendorNamespaces, Purpose, UserStatus, UserStatusPurposes, UserStatusVendors, UserStatusIds, CurrentUserStatus, PurposeStatus, VendorStatus, UserAuthWithEncryptionParams, UserAuthWithHashParams, DidomiInitializeParameters } from './DidomiTypes';
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EACH,eAAe,EACf,MAAM,EACN,gBAAgB,EAChB,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,4BAA4B,EAC5B,sBAAsB,EACzB,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EACH,eAAe,EACf,MAAM,EACN,gBAAgB,EAChB,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,YAAY,EACZ,4BAA4B,EAC5B,sBAAsB,EACtB,0BAA0B,EAC7B,MAAM,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@didomi/react-native",
-  "version": "2.8.0",
+  "version": "2.10.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.17.0"
+  s.dependency "Didomi-XCFramework", "2.19.0"
 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.8.0"
+export const DIDOMI_VERSION = "2.10.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, UserAuthParams } from './DidomiTypes';
+import { DidomiEventType, Purpose, Vendor, UserStatus, CurrentUserStatus, VendorStatus, UserAuthParams, DidomiInitializeParameters, DidomiUserParameters } from './DidomiTypes';
 import { DIDOMI_USER_AGENT_NAME, DIDOMI_VERSION } from './Constants';
 import { CurrentUserStatusTransaction, createCurrentUserStatusTransaction } from './CurrentUserStatusTransaction';
 
@@ -21,6 +21,7 @@ export const Didomi = {
    *  @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.
+   *  @deprecated Use {@link #initializeWithParameters} instead
    */
   initialize: (
     apiKey: string,
@@ -56,6 +57,23 @@ export const Didomi = {
     );
   },
 
+  /**
+   * Initialize the Didomi SDK with parameters
+   * @param parameters: Parameters to initialize the Didomi SDK
+   * @returns: Promise that resolves we have called the native initialize method
+   */
+  initializeWithParameters: (parameters: DidomiInitializeParameters): Promise<void> => {
+    // Init listener
+    DidomiListener.init();
+
+    // Trigger native SDK init
+    return RNDidomi.initializeWithParameters(
+      DIDOMI_USER_AGENT_NAME,
+      DIDOMI_VERSION,
+      JSON.stringify(parameters)
+    );
+  },
+
   /**
    * Listen to SDK ready state
    */
@@ -353,6 +371,12 @@ export const Didomi = {
    */
   getUserStatusForVendor: (vendorId: string): Promise<boolean> => RNDidomi.getUserStatusForVendor(vendorId),
 
+  /**
+   * Determine the regulation applicable for the user.
+   * @returns: the regulation applicable for the current user. If no regulation is applicable, will return "none".
+   */
+  getApplicableRegulation: (): Promise<string> => RNDidomi.getApplicableRegulation(),
+
   /**
    *  Method used to get a Vendor based on its ID.
    *  @param vendorId: vendor ID used in the search.
@@ -467,7 +491,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.
+   *  @deprecated Use {@link setUserWithParameters} instead
    */
   setUserWithHashAuth: (
     id: string,
@@ -506,7 +530,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.
+   *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
    */
   setUserWithHashAuthAndSetupUI: (
     id: string,
@@ -544,7 +568,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.
+   *  @deprecated Use {@link setUserWithParameters} instead
    */
   setUserWithEncryptionAuth: (
     id: string,
@@ -579,7 +603,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.
+   *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
    */
   setUserWithEncryptionAuthAndSetupUI: (
     id: string,
@@ -611,6 +635,7 @@ export const Didomi = {
    *
    *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
    *  @param synchronizedUsers as UserAuthParams[] (optional)
+   *  @deprecated Use {@link setUserWithParameters} instead
    */
   setUserWithAuthParams: (
     userAuthParams: UserAuthParams,
@@ -622,12 +647,27 @@ export const Didomi = {
    *
    *  @param userAuthParams as UserAuthParams (use UserAuthWithEncryptionParams or UserAuthWithHashParams)
    *  @param synchronizedUsers as UserAuthParams[] (optional)
+   *  @deprecated Use {@link setUserWithParametersAndSetupUI} instead
    */
   setUserWithAuthParamsAndSetupUI: (
     userAuthParams: UserAuthParams,
     synchronizedUsers?: UserAuthParams[] | undefined
   ): void => RNDidomi.setUserWithAuthParamsAndSetupUI(JSON.stringify(userAuthParams), JSON.stringify(synchronizedUsers)),
 
+  /**
+   *  Set user information with parameters
+   *
+   *  @param parameters as DidomiUserParameters
+   */
+  setUserWithParameters: (parameters: DidomiUserParameters): void => RNDidomi.setUserWithParameters(JSON.stringify(parameters)),
+
+  /**
+   *  Set user information with parameters and check for missing consent
+   *
+   *  @param parameters as DidomiUserParameters
+   */
+  setUserWithParametersAndSetupUI: (parameters: DidomiUserParameters): void => RNDidomi.setUserWithParametersAndSetupUI(JSON.stringify(parameters)),
+
   /**
    * Show the consent notice (if required, not disabled in the config and not already displayed)
    */
@@ -635,7 +675,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`, `vendors` or `senstive-personal-information`.
+   *  @param view: It can be `purposes` or `vendors`. Note: `sensitive-personal-information` is deprecated and should not be used, as SPI purposes are now displayed in the `purposes` screen.
    */
   showPreferences: (view?: string): Promise<void> => RNDidomi.showPreferences(view),