feat(qualtrics methods): displayQualtricsIntercept, setQualtricsPrope…

…rties, isQualtricsInterceptAvailableForUser (#185)

https://jira.tid.es/browse/WEB-2119

closes #178 
closes #179 
closes #184

README.md

@@ -1396,7 +1396,7 @@ in `localStorage`.
 
 ### requestDatamobDeviceAdmin
 
-<kbd>App version >=25.x</kbd>
+<kbd>App version >=25.0</kbd>
 
 Datamob is a native library that offer developers a way to integrate security
 and remote device control features into their applications.
@@ -1421,7 +1421,7 @@ https://github.com/user-attachments/assets/28095f42-76db-4ac2-9586-e350acef7e1d
 
 ### registerDatamobUser
 
-<kbd>App version >=25.x</kbd>
+<kbd>App version >=25.0</kbd>
 
 The application that implements the Datamob should have an user registered. This
 method is used to register one.
@@ -1449,7 +1449,7 @@ with the following type:
 
 ### validateDatamobRequirements
 
-<kbd>App version >=25.x</kbd>
+<kbd>App version >=25.0</kbd>
 
 Datamob sdk allows to send remote commands to the user device. These remote
 commands include actions such as locking the device screen (lock screen) or even
@@ -1479,6 +1479,93 @@ validateDatamobRequirements: ({phoneNumber: string, tokenPassword: string}) => P
 
 -   `requirements`: A map with the requirements.
 
+### displayQualtricsIntercept
+
+<kbd>App version >=24.12 (iOS only)</kbd>
+
+Uses the Qualtrics SDK to display a survey intercept to the user if possible.
+
+The native app will try to show the survey related to the provided `interceptId`
+
+It will return a boolean (`displayed`) indicating if the survey has been
+displayed or not.
+
+```ts
+displayQualtricsIntercept: ({interceptId: string}) => Promise<{displayed: boolean}>;
+```
+
+#### Error cases
+
+```ts
+{
+    code: 500;
+    reason: 'Internal Error'; // If an error occurred invoking the SDK;
+}
+```
+
+```ts
+{
+    code: 501;
+    reason: 'SDK not initialized';
+}
+```
+
+### setQualtricsProperties
+
+<kbd>App version >=24.12 (iOS only)</kbd>
+
+Method to set properties in Qualtrics SDK before displaying a survey.
+
+```ts
+setQualtricsProperties: ({
+    stringProperties: Array<QualtricsProperty<string>>;
+    numberProperties: Array<QualtricsProperty<number>>;
+    dateTimePropertyKeys: Array<string>;
+}) => Promise<void>;
+```
+
+#### Error cases
+
+```ts
+{
+    code: 500;
+    reason: 'Internal Error'; // If an error occurred invoking the SDK;
+}
+```
+
+```ts
+{
+    code: 501;
+    reason: 'SDK not initialized';
+}
+```
+
+### isQualtricsInterceptAvailableForUser
+
+<kbd>App version >=24.12 (iOS only)</kbd>
+
+Check if a Qualtrics intercept is available for the user.
+
+```ts
+isQualtricsInterceptAvailableForUser: ({interceptId: string}) => Promise<{isAvailable: boolean}>;
+```
+
+#### Error cases
+
+```ts
+{
+    code: 500;
+    reason: 'Internal Error'; // If an error occurred invoking the SDK;
+}
+```
+
+```ts
+{
+    code: 501;
+    reason: 'SDK not initialized';
+}
+```
+
 ## Error handling
 
 If an uncontrolled error occurs, promise will be rejected with an error object:

index.ts

@@ -109,3 +109,9 @@ export {
     requestDatamobDeviceAdmin,
     validateDatamobRequirements,
 } from './src/datamob';
+
+export {
+    displayQualtricsIntercept,
+    setQualtricsProperties,
+    isQualtricsInterceptAvailableForUser,
+} from './src/qualtrics';

src/__tests__/qualtrics-test.ts

@@ -0,0 +1,73 @@
+import {
+    displayQualtricsIntercept,
+    isQualtricsInterceptAvailableForUser,
+    setQualtricsProperties,
+} from '../qualtrics';
+import {createFakeAndroidPostMessage} from './fake-post-message';
+
+test('displayQualtricsIntercept', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('DISPLAY_QUALTRICS_INTERCEPT');
+            expect(msg.payload).toEqual({interceptId: 'anyInterceptId'});
+        },
+        getResponse: (msg) => ({
+            type: 'DISPLAY_QUALTRICS_INTERCEPT',
+            id: msg.id,
+            payload: {
+                displayed: true,
+            },
+        }),
+    });
+
+    const res = await displayQualtricsIntercept({
+        interceptId: 'anyInterceptId',
+    });
+    expect(res).toEqual({displayed: true});
+});
+
+test('setQualtricsProperties', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('SET_QUALTRICS_PROPERTIES');
+            expect(msg.payload).toEqual({
+                stringProperties: [{key: 'stringKey', value: 'stringValue'}],
+                numberProperties: [{key: 'numberKey', value: 42}],
+                dateTimePropertyKeys: ['dateTimeKey'],
+            });
+        },
+        getResponse: (msg) => ({
+            type: 'SET_QUALTRICS_PROPERTIES',
+            id: msg.id,
+        }),
+    });
+
+    const res = await setQualtricsProperties({
+        stringProperties: [{key: 'stringKey', value: 'stringValue'}],
+        numberProperties: [{key: 'numberKey', value: 42}],
+        dateTimePropertyKeys: ['dateTimeKey'],
+    });
+
+    expect(res).toBeUndefined();
+});
+
+test('isQualtricsInterceptAvailableForUser', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('IS_QUALTRICS_INTERCEPT_AVAILABLE_FOR_USER');
+            expect(msg.payload).toEqual({interceptId: 'anyInterceptId'});
+        },
+        getResponse: (msg) => ({
+            type: 'IS_QUALTRICS_INTERCEPT_AVAILABLE_FOR_USER',
+            id: msg.id,
+            payload: {
+                isAvailable: true,
+            },
+        }),
+    });
+
+    const res = await isQualtricsInterceptAvailableForUser({
+        interceptId: 'anyInterceptId',
+    });
+    expect(res).toEqual({isAvailable: true});
+});

src/post-message.ts

@@ -413,6 +413,21 @@ export type ResponsesFromNativeApp = {
             };
         };
     };
+    DISPLAY_QUALTRICS_INTERCEPT: {
+        type: 'DISPLAY_QUALTRICS_INTERCEPT';
+        id: string;
+        payload: {displayed: true};
+    };
+    SET_QUALTRICS_PROPERTIES: {
+        type: 'SET_QUALTRICS_PROPERTIES';
+        id: string;
+        payload: void;
+    };
+    IS_QUALTRICS_INTERCEPT_AVAILABLE_FOR_USER: {
+        type: 'IS_QUALTRICS_INTERCEPT_AVAILABLE_FOR_USER';
+        id: string;
+        payload: {isAvailable: boolean};
+    };
 };
 
 export type NativeAppResponsePayload<

src/qualtrics.ts

@@ -0,0 +1,40 @@
+import {postMessageToNativeApp} from './post-message';
+
+export const displayQualtricsIntercept = ({
+    interceptId,
+}: {
+    interceptId: string;
+}): Promise<{displayed: true}> =>
+    postMessageToNativeApp({
+        type: 'DISPLAY_QUALTRICS_INTERCEPT',
+        payload: {interceptId},
+    });
+
+type QualtricsProperty<T> = {
+    key: string;
+    value: T;
+};
+
+export const setQualtricsProperties = ({
+    stringProperties = [],
+    numberProperties = [],
+    dateTimePropertyKeys = [],
+}: {
+    stringProperties?: Array<QualtricsProperty<string>>;
+    numberProperties?: Array<QualtricsProperty<number>>;
+    dateTimePropertyKeys?: Array<string>;
+}): Promise<void> =>
+    postMessageToNativeApp({
+        type: 'SET_QUALTRICS_PROPERTIES',
+        payload: {stringProperties, numberProperties, dateTimePropertyKeys},
+    });
+
+export const isQualtricsInterceptAvailableForUser = ({
+    interceptId,
+}: {
+    interceptId: string;
+}): Promise<{isAvailable: boolean}> =>
+    postMessageToNativeApp({
+        type: 'IS_QUALTRICS_INTERCEPT_AVAILABLE_FOR_USER',
+        payload: {interceptId},
+    });