Implement request permission methods for Family Locator SDK (#250)

https://jira.tid.es/browse/WEB-2406
closes #249

Author: atabel

README.md

@@ -1872,6 +1872,103 @@ Get current SDK config. Wrapper for `getConfig`.
 getLocatorSdkConfig: () => Promise<{config: LocatorSdkConfig | null}>;
 ```
 
+### requestPermissionLocation
+
+<kbd>App version >= TBD</kbd>
+
+Request location permission from the user.
+
+```ts
+requestPermissionLocation: () => Promise<{status: 'granted' | 'denied'}>;
+```
+
+#### Error cases
+
+-   500: Internal Error
+
+### requestPermissionBackgroundLocation
+
+<kbd>App version >= TBD</kbd>
+
+Request background location permission from the user.
+
+```ts
+requestPermissionBackgroundLocation: () => Promise<{
+    status: 'granted' | 'denied' | 'settings_change_required';
+}>;
+```
+
+#### Notes
+
+-   Android: show a custom alert and navigate to OS settings on accept.
+-   iOS: upgrade to Always happens via OS escalation after background usage.
+
+#### Error cases
+
+-   500: Internal Error
+
+### requestPermissionMicrophone
+
+<kbd>App version >= TBD</kbd>
+
+Request microphone permission from the user.
+
+```ts
+requestPermissionMicrophone: () => Promise<{status: 'granted' | 'denied'}>;
+```
+
+#### Error cases
+
+-   500: Internal Error
+
+### requestPermissionNotifications
+
+<kbd>App version >= TBD</kbd>
+
+Request standard notifications permission from the user.
+
+```ts
+requestPermissionNotifications: () => Promise<{status: 'granted' | 'denied'}>;
+```
+
+#### Error cases
+
+-   500: Internal Error
+
+### requestPermissionCriticalAlerts
+
+<kbd>App version >= TBD</kbd>
+
+Request critical alerts permission from the user (iOS only).
+
+```ts
+requestPermissionCriticalAlerts: () => Promise<{status: 'granted' | 'denied'}>;
+```
+
+#### Error cases
+
+-   500: Internal Error
+
+### requestPermissionBatteryOptimization
+
+<kbd>App version >= TBD</kbd>
+
+Request permission to disable battery optimization (Android only).
+
+```ts
+requestPermissionBatteryOptimization: () => Promise<{
+    status: 'denied' | 'settings_change_required';
+}>;
+```
+
+#### Notes
+
+-   Android: show a custom alert and navigate to OS settings on accept.
+
+#### Error cases
+
+-   500: Internal Error
+
 ### openOcrScanner
 
 <kbd>App version >=26.1</kbd>

index.ts

@@ -156,4 +156,10 @@ export {
     getLocatorSdkSession,
     getLocatorSdkMode,
     getLocatorSdkConfig,
+    requestPermissionLocation,
+    requestPermissionBackgroundLocation,
+    requestPermissionMicrophone,
+    requestPermissionNotifications,
+    requestPermissionCriticalAlerts,
+    requestPermissionBatteryOptimization,
 } from './src/family-locator';

package.json

@@ -44,5 +44,6 @@
         "ts-jest": "^27.1.1",
         "typescript": "^4.5.3",
         "uglify-es": "^3.3.9"
-    }
+    },
+    "dependencies": {}
 }

src/__tests__/family-locator-test.ts

@@ -8,6 +8,12 @@ import {
     getLocatorSdkSession,
     getLocatorSdkMode,
     getLocatorSdkConfig,
+    requestPermissionLocation,
+    requestPermissionBackgroundLocation,
+    requestPermissionMicrophone,
+    requestPermissionNotifications,
+    requestPermissionCriticalAlerts,
+    requestPermissionBatteryOptimization,
 } from '../family-locator';
 import {
     createFakeAndroidPostMessage,
@@ -225,3 +231,99 @@ test('getLocatorSdkConfig', async () => {
     const res = await getLocatorSdkConfig();
     expect(res).toEqual({config});
 });
+
+test('requestPermissionLocation', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_LOCATION');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_LOCATION',
+            id: msg.id,
+            payload: {status: 'granted'},
+        }),
+    });
+
+    const res = await requestPermissionLocation();
+    expect(res).toEqual({status: 'granted'});
+});
+
+test('requestPermissionBackgroundLocation', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_BACKGROUND_LOCATION');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_BACKGROUND_LOCATION',
+            id: msg.id,
+            payload: {status: 'settings_change_required'},
+        }),
+    });
+
+    const res = await requestPermissionBackgroundLocation();
+    expect(res).toEqual({status: 'settings_change_required'});
+});
+
+test('requestPermissionMicrophone', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_MICROPHONE');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_MICROPHONE',
+            id: msg.id,
+            payload: {status: 'denied'},
+        }),
+    });
+
+    const res = await requestPermissionMicrophone();
+    expect(res).toEqual({status: 'denied'});
+});
+
+test('requestPermissionNotifications', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_NOTIFICATIONS');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_NOTIFICATIONS',
+            id: msg.id,
+            payload: {status: 'granted'},
+        }),
+    });
+
+    const res = await requestPermissionNotifications();
+    expect(res).toEqual({status: 'granted'});
+});
+
+test('requestPermissionCriticalAlerts', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_CRITICAL_ALERTS');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_CRITICAL_ALERTS',
+            id: msg.id,
+            payload: {status: 'denied'},
+        }),
+    });
+
+    const res = await requestPermissionCriticalAlerts();
+    expect(res).toEqual({status: 'denied'});
+});
+
+test('requestPermissionBatteryOptimization', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('REQUEST_PERMISSION_BATTERY_OPTIMIZATION');
+        },
+        getResponse: (msg) => ({
+            type: 'REQUEST_PERMISSION_BATTERY_OPTIMIZATION',
+            id: msg.id,
+            payload: {status: 'settings_change_required'},
+        }),
+    });
+
+    const res = await requestPermissionBatteryOptimization();
+    expect(res).toEqual({status: 'settings_change_required'});
+});

src/family-locator.ts

@@ -121,3 +121,29 @@ export const getLocatorSdkConfig = (): Promise<{
     postMessageToNativeApp({
         type: 'GET_LOCATOR_SDK_CONFIG',
     });
+
+type PermissionStatus = 'granted' | 'denied';
+
+export const requestPermissionLocation = (): Promise<{
+    status: PermissionStatus;
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_LOCATION'});
+
+export const requestPermissionBackgroundLocation = (): Promise<{
+    status: PermissionStatus | 'settings_change_required';
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_BACKGROUND_LOCATION'});
+
+export const requestPermissionMicrophone = (): Promise<{
+    status: PermissionStatus;
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_MICROPHONE'});
+
+export const requestPermissionNotifications = (): Promise<{
+    status: PermissionStatus;
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_NOTIFICATIONS'});
+
+export const requestPermissionCriticalAlerts = (): Promise<{
+    status: PermissionStatus;
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_CRITICAL_ALERTS'});
+
+export const requestPermissionBatteryOptimization = (): Promise<{
+    status: 'denied' | 'settings_change_required';
+}> => postMessageToNativeApp({type: 'REQUEST_PERMISSION_BATTERY_OPTIMIZATION'});

src/post-message.ts

@@ -169,6 +169,48 @@ export type ResponsesFromNativeApp = {
             granted: boolean;
         };
     };
+    REQUEST_PERMISSION_LOCATION: {
+        id: string;
+        type: 'REQUEST_PERMISSION_LOCATION';
+        payload: {
+            status: 'granted' | 'denied';
+        };
+    };
+    REQUEST_PERMISSION_BACKGROUND_LOCATION: {
+        id: string;
+        type: 'REQUEST_PERMISSION_BACKGROUND_LOCATION';
+        payload: {
+            status: 'granted' | 'denied' | 'settings_change_required';
+        };
+    };
+    REQUEST_PERMISSION_MICROPHONE: {
+        id: string;
+        type: 'REQUEST_PERMISSION_MICROPHONE';
+        payload: {
+            status: 'granted' | 'denied';
+        };
+    };
+    REQUEST_PERMISSION_NOTIFICATIONS: {
+        id: string;
+        type: 'REQUEST_PERMISSION_NOTIFICATIONS';
+        payload: {
+            status: 'granted' | 'denied';
+        };
+    };
+    REQUEST_PERMISSION_CRITICAL_ALERTS: {
+        id: string;
+        type: 'REQUEST_PERMISSION_CRITICAL_ALERTS';
+        payload: {
+            status: 'granted' | 'denied';
+        };
+    };
+    REQUEST_PERMISSION_BATTERY_OPTIMIZATION: {
+        id: string;
+        type: 'REQUEST_PERMISSION_BATTERY_OPTIMIZATION';
+        payload: {
+            status: 'denied' | 'settings_change_required';
+        };
+    };
     INTERNAL_NAVIGATION: {
         type: 'INTERNAL_NAVIGATION';
         id: string;

yarn.lock

@@ -1032,9 +1032,9 @@ camelcase@^6.2.0:
   integrity sha512-tVI4q5jjFV5CavAU8DXfza/TJcZutVKo/5Foskmsqcm0MsL91moHvwiGNnqaa2o6PF/7yT5ikDRcVcl8Rj6LCA==
 
 caniuse-lite@^1.0.30001286:
-  version "1.0.30001641"
-  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001641.tgz"
-  integrity sha512-Phv5thgl67bHYo1TtMY/MurjkHhV4EDaCosezRXgZ8jzA/Ub+wjxAvbGvjoFENStinwi5kCyOYV3mi5tOGykwA==
+  version "1.0.30001774"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001774.tgz"
+  integrity sha512-DDdwPGz99nmIEv216hKSgLD+D4ikHQHjBC/seF98N9CPqRX4M5mSxT9eTV6oyisnJcuzxtZy4n17yKKQYmYQOA==
 
 chalk@^2.0.0:
   version "2.4.2"