@situm/react-native 3.4.0 → 3.4.2

package/src/sdk/types/index.ts

@@ -496,17 +496,45 @@ export type RealTimeData = {
   locations: Location[];
 };
 
+/**
+ * @name SdkVersion
+ * @description Represents the version information of the SDK and its compatibility with different platforms.
+ *
+ * @type
+ * @property {string} react_native - The version of React Native used in the SDK.
+ * @property {string} [ios] - Optional. The specific version of the Situm SDK for the iOS platform.
+ * @property {string} [android] - Optional. The specific version of the Situm SDK for the Android platform.
+ */
 export type SdkVersion = {
   react_native: string;
   ios?: string;
   android?: string;
 };
 
+/**
+ * @name ConfigurationOptions
+ * @description Configuration options for initializing the SDK or other modules.
+ *
+ * @type
+ * @property {boolean} [useRemoteConfig] - Optional. Determines whether to use Remote Configuration settings.
+ * @property {number} [cacheMaxAge] - Optional. The maximum age of the cache in seconds.
+ */
 export type ConfigurationOptions = {
   useRemoteConfig?: boolean;
   cacheMaxAge?: number;
 };
 
+/**
+ * @name Location
+ * @description Represents a location with various attributes including position, accuracy, and bearing.
+ *
+ * @interface
+ * @property {Position} [position] - Optional. The position information of the location.
+ * @property {number} [accuracy] - Optional. The accuracy of the location information in meters.
+ * @property {Object} [bearing] - Optional. Bearing information including degrees and degreesClockwise.
+ * @property {boolean} [hasBearing] - Optional. Indicates if bearing information is available.
+ * @property {LocationStatusName} status - The status of the location update.
+ */
 export interface Location {
   position?: Position;
   accuracy?: number;
@@ -532,14 +560,67 @@ export interface Position {
   buildingIdentifier?: string;
   floorIdentifier?: string;
 }
+
+/**
+ * @name LocationStatus
+ * @description Represents the status of a location, including a name and a numeric code.
+ *
+ * @interface
+ * @property {LocationStatusName} statusName - The name of the location status.
+ * @property {number} statusCode - The numeric code representing the location status.
+ */
 export interface LocationStatus {
   statusName: LocationStatusName;
   statusCode: number;
 }
 
+/**
+ * @name ErrorType
+ * @description Enumeration of error types to categorize the severity of errors.
+ *
+ * @enum {string}
+ * @property {string} CRITICAL - Represents critical errors that will cause the system not to work (e.g. positioning will be stopped).
+ * @property {string} NON_CRITICAL - Represents non-critical errors that are less severe.
+ */
+export enum ErrorType {
+  CRITICAL = "CRITICAL",
+  NON_CRITICAL = "NON_CRITICAL",
+}
+
+/**
+ * @name ErrorCode
+ * @description Enumeration of error codes provided by Situm SDK.
+ *
+ * @enum {string}
+ * @property {string} LOCATION_PERMISSION_DENIED - Indicates that location permissions were not granted by the user.
+ * @property {string} BLUETOOTH_PERMISSION_DENIED - Indicates that Bluetooth permissions were not granted.
+ * @property {string} BLUETOOTH_DISABLED - Indicates that Bluetooth is disabled on the device.
+ * @property {string} LOCATION_DISABLED - Indicates that the location services are disabled on the device.
+ * @property {string} REDUCED_ACCURACY - Indicates that the precise location has been turned off on the device.
+ * @property {string} UNKNOWN - Represents an unknown error or an error that does not fit other categories.
+ */
+export enum ErrorCode {
+  LOCATION_PERMISSION_DENIED = "LOCATION_PERMISSION_DENIED",
+  BLUETOOTH_PERMISSION_DENIED = "BLUETOOTH_PERMISSION_DENIED",
+  BLUETOOTH_DISABLED = "BLUETOOTH_DISABLED",
+  LOCATION_DISABLED = "LOCATION_DISABLED",
+  REDUCED_ACCURACY = "REDUCED_ACCURACY",
+  UNKNOWN = "UNKNOWN",
+}
+
+/**
+ * @name Error
+ * @description Represents an error with a specific code, message, and type.
+ *
+ * @interface
+ * @property {ErrorCode} code - The specific error code associated with this error.
+ * @property {string} message - A descriptive message providing more details about the error.
+ * @property {ErrorType} type - The type of the error indicating its severity (critical or non-critical).
+ */
 export interface Error {
-  code?: number;
+  code: ErrorCode;
   message: string;
+  type: ErrorType;
 }
 
 // TODO: add types

package/src/sdk/utils.ts

@@ -1,5 +1,6 @@
 import { logError } from "..";
 import type { Error } from "./types";
+import { ErrorCode, ErrorType } from "./types";
 
 type PromiseResolve<T> = (response: T) => void;
 type PromiseReject = (error?: Error) => void;
@@ -23,8 +24,9 @@ export const handleAsyncCallback = (
     resolve();
   } else {
     reject({
-      code: -1,
+      code: ErrorCode.UNKNOWN,
       message: errorMessage || "Unknown error.",
+      type: ErrorType.NON_CRITICAL,
     });
   }
 };
@@ -121,9 +123,47 @@ export const promiseWrapper = <T>(
     } catch (error) {
       logError(error);
       reject({
-        code: error?.code || -1,
+        code: ErrorCode.UNKNOWN,
         message: error?.message || "Unknown error.",
+        type: ErrorType.NON_CRITICAL,
       });
     }
   });
 };
+
+export function locationErrorAdapter(error): Error {
+  let adaptedCode = ErrorCode.UNKNOWN;
+  const adaptedMessage = error.message;
+  const adaptedType = ErrorType.CRITICAL;
+
+  switch (error.code.toString()) {
+    case "8001": // MISSING_LOCATION_PERMISSION
+    case "8": // kSITLocationErrorLocationDisabled
+    case "9": // kSITLocationErrorLocationRestricted
+    case "10": // kSITLocationErrorLocationAuthStatusNotDetermined
+      adaptedCode = ErrorCode.LOCATION_PERMISSION_DENIED;
+      break;
+    case "8002": // LOCATION_DISABLED
+      adaptedCode = ErrorCode.LOCATION_DISABLED;
+      break;
+    case "8012": // MISSING_BLUETOOTH_PERMISSION
+      adaptedCode = ErrorCode.BLUETOOTH_PERMISSION_DENIED;
+      break;
+    case "8100": //BLUETOOTH_DISABLED. 8100 ->This number does not exist in Situm SDK. We made it up in SitumMapper.java (RN adapter)
+    case "6": // kSITLocationErrorBluetoothisOff
+      adaptedCode = ErrorCode.BLUETOOTH_DISABLED;
+      break;
+    case "11": //kSITLocationErrorLocationAccuracyAuthorizationStatusReducedAccuracy
+      adaptedCode = ErrorCode.REDUCED_ACCURACY;
+      break;
+    // Add more cases as needed
+  }
+
+  const returnError: Error = {
+    code: adaptedCode,
+    message: adaptedMessage,
+    type: adaptedType,
+  };
+
+  return returnError;
+}

package/src/utils/requestPermission.ts

@@ -8,7 +8,7 @@ import {
 
 // TODO: can requestMultiple be used ?
 const checkIOSPermissions = async () => {
-  let granted = await request(PERMISSIONS.IOS.LOCATION_WHEN_IN_USE);
+  const granted = await request(PERMISSIONS.IOS.LOCATION_WHEN_IN_USE);
 
   // Check if already denied
   if (granted !== RESULTS.GRANTED) {
@@ -19,24 +19,7 @@ const checkIOSPermissions = async () => {
     "Situm > permissions > LOCATION_WHEN_IN_USE permission granted"
   );
 
-  //@ts-ignore
-  if (parseInt(Platform.Version, 10) > 12) {
-    granted = await request(PERMISSIONS.IOS.BLUETOOTH_PERIPHERAL);
-
-    if (granted === RESULTS.GRANTED) {
-      console.debug(
-        "Situm > permissions > BLUETOOTH_PERIPHERAL permission granted"
-      );
-      return true;
-    } else {
-      throw "Situm > permissions > BLUETOOTH_PERIPHERAL permission not granted";
-    }
-  } else {
-    console.debug(
-      "Situm > permissions > BLUETOOTH_PERIPHERAL permissions not required"
-    );
-    return true;
-  }
+  return true;
 };
 
 const checkAndroidPermissions = async () => {

package/src/wayfinding/hooks/index.ts

@@ -5,6 +5,8 @@ import SitumPlugin from "../../sdk";
 import {
   type Building,
   type Error,
+  ErrorCode,
+  ErrorType,
   type Location,
   type LocationStatus,
   type NavigationProgress,
@@ -77,8 +79,6 @@ export const useSitumInternal = () => {
 
     SitumPlugin.onLocationError((err: Error) => {
       console.error(`Situm > hook > Error while positioning: ${err}}`);
-      //@ts-ignore
-      dispatch(setError({ message: err, code: 3001 } as SDKError));
     });
 
     SitumPlugin.onLocationStopped(() => {
@@ -207,7 +207,14 @@ export const useSitumInternal = () => {
           });
         } catch (e) {
           console.error(`Situm > hook > Could not update navigation ${e}`);
-          dispatch(setError({ message: "error", code: 3051 } as Error));
+          //TODO: Remove this and emit these errors in SitumPlugin.onNavigationError
+          dispatch(
+            setError({
+              message: "Could not update navigation",
+              code: ErrorCode.UNKNOWN,
+              type: ErrorType.NON_CRITICAL,
+            } as Error)
+          );
           stopNavigation();
         }
       })
@@ -219,11 +226,11 @@ export const useSitumInternal = () => {
   };
 
   const stopNavigation = () => {
-    console.debug("Situm > hook > Stopping navigation");
     // TODO: we should delegate this to the sdk plugin
     if (!navigation || navigation?.status === NavigationStatus.STOP) {
       return;
     }
+    console.debug("Situm > hook > Stopping navigation");
 
     SitumPlugin.removeNavigationUpdates()
       .then(() => {