WEB-2394 family locator sdk bridge methods

README.md

@@ -1820,6 +1820,207 @@ setBiometricsAuthenticationStatus: ({enable: boolean}) => Promise<void>;
 -   `503`: The device has no biometrics available, or the user cancelled
     modifying biometric settings.
 
+### setupLocatorSdkConfig
+
+<kbd>App version >= TBD</kbd>
+
+Enable/configure Family Locator SDK. Wrapper for `sdk.setConfig(config)`.
+
+```ts
+setupLocatorSdkConfig: (config: LocatorSdkConfig) => Promise<void>;
+```
+
+#### Types
+
+```ts
+export type LocatorSdkConfig = {
+    license: string;
+    sdkVersion: string;
+    osPlatform: string;
+    api: {
+        token: string;
+        certUrl?: string;
+        scopesUrl?: string;
+        tokenUrl?: string;
+        configUrl?: string;
+        groupsUrl?: string;
+        featuresUrl?: string;
+        geofencesUrl?: string;
+    };
+    mqtt: {
+        clientId?: string;
+        broker?: string;
+        port?: string;
+        username?: string;
+    };
+    process: {
+        retryPolicy?: {
+            maxRetries?: number;
+            baseDelayMs?: number;
+            backoffFactor?: number;
+        };
+        offlineRetentionDays?: number;
+        foregroundServiceNotification?: {
+            title?: string;
+            message?: string;
+        };
+    };
+    battery?: {
+        events?: Array<{
+            name: string;
+            min: number;
+            max: number;
+            interval: number;
+            charging: boolean;
+            powerMode: Array<'normal' | 'power_saver' | 'super_saver'>;
+        }>;
+    };
+    motion?: {
+        sensitivity?: number;
+    };
+    collect?: {
+        collectIntervalMillis?: number;
+        sendIntervalMillis?: number;
+        minDisplacementMeters?: number;
+        maxTravelDistanceMeters?: number;
+        highAccuracy?: boolean;
+        maxBatchSize?: number;
+    };
+    audioRecord?: {
+        recordsCount: number;
+        durationSeconds: number;
+        retryCount: number;
+        intervalSeconds: number;
+        audioServiceNotification?: {
+            title?: string;
+            message?: string;
+        };
+    };
+    revision?: number;
+    createdAt?: number;
+    updatedAt?: number;
+};
+```
+
+#### Example
+
+```ts
+setupLocatorSdkConfig({license: 'xxx', sdkVersion: '2.0.1'});
+```
+
+#### Error cases
+
+-   401: `LocatorSDKMissingPermissionsException`
+-   402: `LocatorSDKNoConfigSetException`
+-   500: Internal Error
+
+### getLocatorSdkState
+
+<kbd>App version >= TBD</kbd>
+
+Check if the SDK is configured. Wrapper for `getState`.
+
+```ts
+getLocatorSdkState: () => Promise<{state: string}>;
+```
+
+### setLocatorSdkMode
+
+<kbd>App version >= TBD</kbd>
+
+Start real-time sharing or SOS. Wrapper for `setSdkMode`.
+
+```ts
+setLocatorSdkMode: (mode: 'default' | 'observed' | 'sos' | string) => Promise<void>;
+```
+
+### getLocatorJwtToken
+
+<kbd>App version >= TBD</kbd>
+
+Get JWT token for map backend auth. Wrapper for `getJwtToken`.
+
+```ts
+getLocatorJwtToken: () => Promise<{token: string}>;
+```
+
+### getLocatorPendingPermissions
+
+<kbd>App version >= TBD</kbd>
+
+Get pending permissions. Wrapper for `pendingPermissions`.
+
+```ts
+getLocatorPendingPermissions: () => Promise<{permissions: Array<string>}>;
+```
+
+#### Permission identifiers
+
+Android
+
+-   `location_fine`
+-   `location_coarse`
+-   `location_background`
+-   `activity_recognition`
+-   `body_sensors`
+-   `battery_optimization`
+-   `foreground_service`
+-   `foreground_service_location`
+-   `access_network_state`
+
+iOS
+
+-   `location_in_use`
+-   `location_background`
+-   `motion_usage`
+-   `fall_detection`
+
+### getLocatorSdkVersion
+
+<kbd>App version >= TBD</kbd>
+
+Get SDK version. Wrapper for `getVersion`.
+
+```ts
+getLocatorSdkVersion: () => Promise<{version: string}>;
+```
+
+### getLocatorSdkSession
+
+<kbd>App version >= TBD</kbd>
+
+Get SDK session. Wrapper for `getSession`.
+
+```ts
+getLocatorSdkSession: () => Promise<{
+    session: {
+        id: string;
+        startAt: number;
+        endAt: number | null;
+    };
+}>;
+```
+
+### getLocatorSdkMode
+
+<kbd>App version >= TBD</kbd>
+
+Get current SDK mode. Wrapper for `getSdkMode`.
+
+```ts
+getLocatorSdkMode: () => Promise<{mode: 'default' | 'observed' | 'sos' | string}>;
+```
+
+### getLocatorSdkConfig
+
+<kbd>App version >= TBD</kbd>
+
+Get current SDK config. Wrapper for `getConfig`.
+
+```ts
+getLocatorSdkConfig: () => Promise<{config: LocatorSdkConfig | null}>;
+```
+
 ### openOcrScanner
 
 <kbd>App version >=26.1</kbd>

index.ts

@@ -158,3 +158,17 @@ export {
     AllowMeCanNotSaveImageError,
     requestAllowMeBiometrics,
 } from './src/allow-me';
+
+export {
+    type LocatorSdkMode,
+    type LocatorSdkConfig,
+    setupLocatorSdkConfig,
+    getLocatorSdkState,
+    setLocatorSdkMode,
+    getLocatorJwtToken,
+    getLocatorPendingPermissions,
+    getLocatorSdkVersion,
+    getLocatorSdkSession,
+    getLocatorSdkMode,
+    getLocatorSdkConfig,
+} from './src/family-locator';