feat(Bridge): add method to bridge for obtaining metadata about netwo… (

#121)

* feat(Bridge): add method to bridge for obtaining metadata about network data connection

* ACCOUNT-23612 rename and add documentation

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v.3.30.0 - 2023-12-16
+
+-   New `getNetworkConnectionInfo` function
+
 ## v.3.29.0 - 2023-10-26
 
 -   New `openOnboarding` function

README.md

@@ -985,6 +985,28 @@ available
 getAttStatus: () => Promise<{status:'granted' | 'denied' | 'unknown'} | null>;
 ```
 
+### getNetworkConnectionInfo
+
+<kbd>App version >=14.11</kbd>
+
+Obtain metainformation about the current device data network connectivity
+
+```ts
+getNetworkConnectionInfo: () => Promise<{
+    connectionType: 'MOBILE' | 'WIFI ' | 'OTHER' | 'NONE';
+    mobileConnectionType?: '2G' | '3G' | '4G' | '5G' | 'OTHER' | null;
+    mobileCarrier?: string | null;
+    mobileSignalStrength?: 'NONE' | 'POOR' | 'MODERATE' | 'GOOD' | 'GREAT' | null;
+}>;
+```
+
+-   `connectionType`: describes the network technology used currently for data
+-   `mobileConnectionType`: in case connectionType is 'MOBILE' gives further
+    details about the network technology used.
+-   `mobileCarrier`: identifies the carrier used for 'MOBILE' connectionType
+-   `mobileSignalStrength`: gives a measure of the current signal strength for
+    'MOBILE' connectionType.
+
 ## Error handling
 
 If an uncontrolled error occurs, promise will be rejected with an error object:

index.ts

@@ -35,6 +35,7 @@ export {
     fetch,
     checkPermissionStatus,
     getAppMetadata,
+    getNetworkConnectionInfo,
     setActionBehavior,
     getTopazToken,
     onNavigationBarIconClicked,

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tef-novum/webview-bridge",
-    "version": "3.29.0",
+    "version": "3.30.0",
     "description": "JavaScript library to access to native functionality. Requires a webview with a postMessage bridge.",
     "main": "./dist/webview-bridge-cjs.js",
     "module": "./dist/webview-bridge.mjs",

src/__tests__/utils-test.ts

@@ -15,7 +15,7 @@ import {
     createFakeAndroidPostMessage,
     removeFakeAndroidPostMessage,
 } from './fake-post-message';
-import {getAppMetadata} from '../utils';
+import {getAppMetadata, getNetworkConnectionInfo} from '../utils';
 
 const ANY_STRING = 'any-string';
 const ANY_OTHER_STRING = 'any-other-string';
@@ -561,6 +561,40 @@ test('get app metadata of installed application', async () => {
     });
 });
 
+test('get data connection info', async () => {
+    const connectionType = 'MOBILE';
+    const mobileConnectionType = '4G';
+    const mobileCarrier = 'Telefonica';
+    const mobileSignalStrength = 'POOR';
+
+    createFakeAndroidPostMessage({
+        checkMessage: (msg) => {
+            expect(msg.type).toBe('DATA_CONNECTION_INFO');
+            expect(msg.payload).toMatchObject({});
+        },
+        getResponse: (msg) => ({
+            type: 'DATA_CONNECTION_INFO',
+            id: msg.id,
+            payload: {
+                connectionType,
+                mobileConnectionType,
+                mobileCarrier,
+                mobileSignalStrength,
+            },
+        }),
+    });
+
+    await getNetworkConnectionInfo().then((res) => {
+        expect(res).toMatchObject({
+            connectionType,
+            mobileConnectionType,
+            mobileCarrier,
+            mobileSignalStrength,
+        });
+        removeFakeAndroidPostMessage();
+    });
+});
+
 test('set confirm action behavior', (done) => {
     const actions = {
         webviewClose: {

src/post-message.ts

@@ -36,6 +36,19 @@ export type SnackbarResponse = {
     action: 'DISMISS' | 'BUTTON' | 'TIMEOUT' | 'CONSECUTIVE';
 };
 
+type DataConnectionResponse = {
+    connectionType: 'MOBILE' | 'WIFI ' | 'OTHER' | 'NONE';
+    mobileConnectionType?: '2G' | '3G' | '4G' | '5G' | 'OTHER' | null;
+    mobileCarrier?: string | null;
+    mobileSignalStrength?:
+        | 'NONE'
+        | 'POOR'
+        | 'MODERATE'
+        | 'GOOD'
+        | 'GREAT'
+        | null;
+};
+
 export type ResponsesFromNativeApp = {
     SIM_ICC: {
         id: string;
@@ -269,6 +282,11 @@ export type ResponsesFromNativeApp = {
         id: string;
         payload: void;
     };
+    DATA_CONNECTION_INFO: {
+        type: 'DATA_CONNECTION_INFO';
+        id: string;
+        payload: DataConnectionResponse;
+    };
 };
 
 export type NativeAppResponsePayload<

src/utils.ts

@@ -251,6 +251,14 @@ export const getAppMetadata = (
         },
     });
 
+export const getNetworkConnectionInfo = (): Promise<
+    NativeAppResponsePayload<'DATA_CONNECTION_INFO'>
+> =>
+    postMessageToNativeApp({
+        type: 'DATA_CONNECTION_INFO',
+        payload: {},
+    });
+
 type ActionBehavior =
     | {
           behavior: 'confirm';