@didomi/react-native 2.9.0 → 2.10.0

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.18.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.9.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
    */
@@ -473,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,
@@ -512,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,
@@ -550,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,
@@ -585,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,
@@ -617,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,
@@ -628,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)
    */

package/src/DidomiTypes.ts

@@ -178,8 +178,11 @@ export interface SyncReadyEvent {
   syncAcknowledged: () => Promise<boolean>;
 }
 
-export interface UserAuthParams {
+export interface UserAuth {
   id: string;
+}
+
+export interface UserAuthParams extends UserAuth {
   algorithm: string;
   secretId: string;
   expiration?: number;
@@ -193,3 +196,120 @@ 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[];
+}

package/src/index.tsx

@@ -12,5 +12,6 @@ export {
     PurposeStatus,
     VendorStatus,
     UserAuthWithEncryptionParams,
-    UserAuthWithHashParams
+    UserAuthWithHashParams,
+    DidomiInitializeParameters
 } from './DidomiTypes';