feat: subscribeTo and subscribeFrom push notifications (#276)

Implementation of
#275

Author: yamal-alm

.prettierignore

@@ -1,2 +1,3 @@
 /dist
-/coverage
+/coverage
+CHANGELOG.md

README.md

@@ -2029,6 +2029,38 @@ verifyIdentity({orderId: '123456789AAA'})
 -   `505`: Identity verification flow is not supported on this device (Android
     < 9)
 
+### subscribeToPushNotifications
+
+<kbd>App version >= TBD</kbd>
+
+Tells the native app to start the push notification subscription flow. The app
+first verifies that notifications permission is granted; if so, it starts the
+corresponding SDK and executes the push subscription through it.
+
+```ts
+subscribeToPushNotifications: () => Promise<void>;
+```
+
+#### Error cases
+
+-   `401`: Push notifications permission is not granted
+-   `500`: Any other error that prevented the operation from completing
+
+### unsubscribeFromPushNotifications
+
+<kbd>App version >= TBD</kbd>
+
+Tells the native app to unsubscribe from pushes through the corresponding SDK.
+No permission is required.
+
+```ts
+unsubscribeFromPushNotifications: () => Promise<void>;
+```
+
+#### Error cases
+
+-   `500`: Any other error that prevented the operation from completing
+
 ## Error handling
 
 If an uncontrolled error occurs, promise will be rejected with an error object:

index.ts

@@ -147,6 +147,11 @@ export {
 
 export {verifyIdentity} from './src/identity-verification';
 
+export {
+    subscribeToPushNotifications,
+    unsubscribeFromPushNotifications,
+} from './src/push-notifications';
+
 export {
     type LocatorSdkMode,
     setupLocatorSdkConfig,

src/__tests__/push-notifications-test.ts

@@ -0,0 +1,85 @@
+import {
+    subscribeToPushNotifications,
+    unsubscribeFromPushNotifications,
+} from '../push-notifications';
+import {createFakeAndroidPostMessage} from './fake-post-message';
+
+test('subscribeToPushNotifications - success', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('SUBSCRIBE_TO_PUSH_NOTIFICATIONS');
+            expect(msg.payload).toBeUndefined();
+        },
+        getResponse: (msg) => ({
+            type: 'SUBSCRIBE_TO_PUSH_NOTIFICATIONS',
+            id: msg.id,
+        }),
+    });
+
+    const res = await subscribeToPushNotifications();
+    expect(res).toBeUndefined();
+});
+
+test('subscribeToPushNotifications - missing permission error', async () => {
+    createFakeAndroidPostMessage({
+        getResponse: (msg) => ({
+            type: 'ERROR',
+            id: msg.id,
+            payload: {
+                code: 401,
+                reason: 'Missing Push notifications permission',
+            },
+        }),
+    });
+
+    await expect(subscribeToPushNotifications()).rejects.toEqual({
+        code: 401,
+        reason: 'Missing Push notifications permission',
+    });
+});
+
+test('subscribeToPushNotifications - generic error', async () => {
+    createFakeAndroidPostMessage({
+        getResponse: (msg) => ({
+            type: 'ERROR',
+            id: msg.id,
+            payload: {code: 500, reason: 'Internal error'},
+        }),
+    });
+
+    await expect(subscribeToPushNotifications()).rejects.toEqual({
+        code: 500,
+        reason: 'Internal error',
+    });
+});
+
+test('unsubscribeFromPushNotifications - success', async () => {
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('UNSUBSCRIBE_FROM_PUSH_NOTIFICATIONS');
+            expect(msg.payload).toBeUndefined();
+        },
+        getResponse: (msg) => ({
+            type: 'UNSUBSCRIBE_FROM_PUSH_NOTIFICATIONS',
+            id: msg.id,
+        }),
+    });
+
+    const res = await unsubscribeFromPushNotifications();
+    expect(res).toBeUndefined();
+});
+
+test('unsubscribeFromPushNotifications - generic error', async () => {
+    createFakeAndroidPostMessage({
+        getResponse: (msg) => ({
+            type: 'ERROR',
+            id: msg.id,
+            payload: {code: 500, reason: 'Internal error'},
+        }),
+    });
+
+    await expect(unsubscribeFromPushNotifications()).rejects.toEqual({
+        code: 500,
+        reason: 'Internal error',
+    });
+});

src/post-message.ts

@@ -597,6 +597,16 @@ export type ResponsesFromNativeApp = {
         id: string;
         payload: void;
     };
+    SUBSCRIBE_TO_PUSH_NOTIFICATIONS: {
+        type: 'SUBSCRIBE_TO_PUSH_NOTIFICATIONS';
+        id: string;
+        payload: void;
+    };
+    UNSUBSCRIBE_FROM_PUSH_NOTIFICATIONS: {
+        type: 'UNSUBSCRIBE_FROM_PUSH_NOTIFICATIONS';
+        id: string;
+        payload: void;
+    };
 };
 
 export type NativeAppResponsePayload<

src/push-notifications.ts

@@ -0,0 +1,23 @@
+import {postMessageToNativeApp} from './post-message';
+
+/**
+ * Tells the native app to start the push notification subscription flow.
+ * The native app verifies the notifications permission first; if granted, it
+ * starts the corresponding SDK and executes the push subscription.
+ *
+ * Error cases:
+ * - 401: Push notifications permission is not granted
+ * - 500: Any other error that prevented the operation from completing
+ */
+export const subscribeToPushNotifications = (): Promise<void> =>
+    postMessageToNativeApp({type: 'SUBSCRIBE_TO_PUSH_NOTIFICATIONS'});
+
+/**
+ * Tells the native app to unsubscribe from pushes through the corresponding SDK.
+ * No permission is required.
+ *
+ * Error cases:
+ * - 500: Any other error that prevented the operation from completing
+ */
+export const unsubscribeFromPushNotifications = (): Promise<void> =>
+    postMessageToNativeApp({type: 'UNSUBSCRIBE_FROM_PUSH_NOTIFICATIONS'});