@situm/react-native 3.15.0-beta.1 → 3.15.0-beta.2

package/src/sdk/index.ts

@@ -38,6 +38,7 @@ import {
   locationStatusAdapter,
   promiseWrapper,
 } from "./utils";
+import { DelegatedStateManager } from "./internaDelegatedState";
 
 export * from "./types";
 export * from "./types/constants";
@@ -56,7 +57,7 @@ const RNCSitumPlugin =
       get() {
         throw new Error(LINKING_ERROR);
       },
-    }
+    },
   ) as SitumPluginInterface);
 
 const SitumPluginEventEmitter = new NativeEventEmitter(RNCSitumPlugin);
@@ -66,6 +67,7 @@ let positioningRunning = false;
 let navigationRunning = false;
 let realtimeSubscriptions = [];
 
+// Internal method call (MapView) delegate:
 let internalMethodCallMapDelegate = (_: InternalCall) => {
   // internalMethodCallMapDelegate is an empty function by default.
 };
@@ -101,9 +103,10 @@ let exitGeofencesCallback = (_: any) => {};
 // internal callback.
 
 const _internalLocationCallback = (loc: Location) => {
+  DelegatedStateManager.getInstance().updateLocation(loc);
   // MapView internal callback:
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.LOCATION, loc)
+    new InternalCall(InternalCallType.LOCATION, loc),
   );
   // Navigation internal callback: TODO review this, seems to be different to other plugins and candidate for refactoring.
   locationCallbackForNavigation(loc);
@@ -113,8 +116,9 @@ const _internalLocationCallback = (loc: Location) => {
 
 const _internalLocationStatusCallback = (status: LocationStatus) => {
   const mapViewStatusName = locationStatusAdapter(status.statusName);
+  DelegatedStateManager.getInstance().updateStatus(mapViewStatusName);
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.LOCATION_STATUS, mapViewStatusName)
+    new InternalCall(InternalCallType.LOCATION_STATUS, mapViewStatusName),
   );
   // TODO: we are delegating different values to the internal and client callbacks. The viewer only understands
   // the states defined in LocationStatusName, but the integrator might be interested in any state from the SDK.
@@ -123,7 +127,7 @@ const _internalLocationStatusCallback = (status: LocationStatus) => {
 
 const _internalLocationStoppedCallback = () => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.LOCATION_STOPPED, undefined)
+    new InternalCall(InternalCallType.LOCATION_STOPPED, undefined),
   );
   // TODO: this callback is used only in RN, delete!
   locationStoppedCallback?.();
@@ -131,38 +135,37 @@ const _internalLocationStoppedCallback = () => {
 
 const _internalLocationErrorCallback = (error: Error) => {
   const adaptedError = locationErrorAdapter(error);
-  if (adaptedError.type === ErrorType.CRITICAL)
-    SitumPlugin.removeLocationUpdates();
+  DelegatedStateManager.getInstance().updateError(adaptedError);
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.LOCATION_ERROR, adaptedError)
+    new InternalCall(InternalCallType.LOCATION_ERROR, adaptedError),
   );
   locationErrorCallback?.(adaptedError);
 };
 
 const _internalNavigationStartedCallback = (route: Route) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_START, route)
+    new InternalCall(InternalCallType.NAVIGATION_START, route),
   );
   navigationStartedCallback?.(route);
 };
 
 const _internalNavigationProgressCallback = (progress: NavigationProgress) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_PROGRESS, progress)
+    new InternalCall(InternalCallType.NAVIGATION_PROGRESS, progress),
   );
   navigationProgressCallback?.(progress);
 };
 
 const _internalNavigationDestinationReachedCallback = (route: Route) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_DESTINATION_REACHED, route)
+    new InternalCall(InternalCallType.NAVIGATION_DESTINATION_REACHED, route),
   );
   navigationDestinationReachedCallback?.(route);
 };
 
 const _internalNavigationOutOfRouteCallback = () => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_OUT_OF_ROUTE, undefined)
+    new InternalCall(InternalCallType.NAVIGATION_OUT_OF_ROUTE, undefined),
   );
   navigationOutOfRouteCallback?.();
 };
@@ -170,35 +173,35 @@ const _internalNavigationOutOfRouteCallback = () => {
 const _internalNavigationFinishedCallback = () => {
   // Deprecated!
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined)
+    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined),
   );
   navigationFinishedCallback?.();
 };
 
 const _internalNavigationCancellationCallback = () => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined)
+    new InternalCall(InternalCallType.NAVIGATION_CANCELLATION, undefined),
   );
   navigationCancellationCallback?.();
 };
 
 const _internalNavigationErrorCallback = (error: any) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.NAVIGATION_ERROR, error)
+    new InternalCall(InternalCallType.NAVIGATION_ERROR, error),
   );
   navigationErrorCallback?.(error);
 };
 
 const _internalEnterGeofencesCallback = (data: any) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.GEOFENCES_ENTER, data)
+    new InternalCall(InternalCallType.GEOFENCES_ENTER, data),
   );
   enterGeofencesCallback?.(data);
 };
 
 const _internalExitGeofencesCallback = (data: any) => {
   internalMethodCallMapDelegate(
-    new InternalCall(InternalCallType.GEOFENCES_EXIT, data)
+    new InternalCall(InternalCallType.GEOFENCES_EXIT, data),
   );
   exitGeofencesCallback?.(data);
 };
@@ -224,8 +227,10 @@ const _registerCallbacks = () => {
   };
 
   Object.entries(callbacksMap).forEach(([eventName, callback]) => {
+    console.log("Event emitter add listener: ", eventName);
     SitumPluginEventEmitter.removeAllListeners(eventName);
     SitumPluginEventEmitter.addListener(eventName, callback);
+    console.log("Event emitter add listener finished: ", eventName);
   });
 };
 
@@ -333,7 +338,7 @@ export default class SitumPlugin {
         useRemoteConfig ? "true" : "false",
         (response) => {
           onCallback(response, "Failed to set remote config");
-        }
+        },
       );
     });
   };
@@ -594,7 +599,7 @@ export default class SitumPlugin {
     building: Building,
     from: Point | Location,
     to: Point | Poi,
-    directionOptions?: DirectionsOptions
+    directionOptions?: DirectionsOptions,
   ) => {
     return promiseWrapper<Directions>(({ onSuccess, onError }) => {
       const params = [building, from, to, directionOptions || {}];
@@ -662,7 +667,7 @@ export default class SitumPlugin {
   static requestRealTimeUpdates = (
     realtimeUpdates: (event: any) => void,
     error?: (event: any) => void,
-    options?: any
+    options?: any,
   ) => {
     return exceptionWrapper<void>(() => {
       RNCSitumPlugin.requestRealTimeUpdates(options || {});
@@ -671,7 +676,7 @@ export default class SitumPlugin {
         error
           ? SitumPluginEventEmitter.addListener(
               "realtimeError",
-              error || logError
+              error || logError,
             )
           : null,
       ]);
@@ -696,31 +701,16 @@ export default class SitumPlugin {
    */
   static checkIfPointInsideGeofence = (
     request: any,
-    callback?: (response: { isInsideGeofence: boolean; geofence: any }) => void
+    callback?: (response: { isInsideGeofence: boolean; geofence: any }) => void,
   ) => {
-    RNCSitumPlugin.checkIfPointInsideGeofence(request, callback);
-  };
-
-  /**
-   * INTERNAL METHOD.
-   *
-   * Update SDK with the viewer navigation states.
-   * Do not use this method as it is intended for internal use
-   * by the map viewer module.
-   *
-   * @param externalNavigation
-   */
-  static updateNavigationState = (externalNavigation: Map<string, any>) => {
-    return exceptionWrapper<void>(() => {
-      RNCSitumPlugin.updateNavigationState(externalNavigation);
-    });
+    RNCSitumPlugin.checkIfPointInsideGeofence(request, callback || (() => {}));
   };
 
   /**
    * Automatically assists users in resolving app-related permission and sensor issues.
    *
-   * This method tells the native SDKs to present a user interface that explains detected 
-   * configuration issues and guides users through the required steps to resolve them, 
+   * This method tells the native SDKs to present a user interface that explains detected
+   * configuration issues and guides users through the required steps to resolve them,
    * following best practices for runtime permission requests.
    *
    * Issues addressed include:
@@ -732,12 +722,10 @@ export default class SitumPlugin {
    * Call {@link disableUserHelper} as a shortcut to disable the user helper.
    *
    * @param {UserHelperOptions} userHelperOptions - Options for the user helper.
-   * @param {function} cb - Cordova native callback to receive data.
-   * @param {function} error - Cordova native callback to receive errors.
    */
   static configureUserHelper = (userHelperOptions: UserHelperOptions) => {
     _registerCallbacks();
-    return exceptionWrapper<void>(({onSuccess, onError}) => {
+    return exceptionWrapper<void>(({ onSuccess, onError }) => {
       RNCSitumPlugin.configureUserHelper(userHelperOptions, onSuccess, onError);
     });
   };
@@ -746,12 +734,9 @@ export default class SitumPlugin {
    * Enables the user helper.
    *
    * Shortcut for {@link configureUserHelper} with <code>{enabled: true}</code>.
-   *
-   * @param {function} cb - Cordova native callback to receive data.
-   * @param {function} error - Cordova native callback to receive errors.
    */
   static enableUserHelper = () => {
-    SitumPlugin.configureUserHelper({enabled: true, colorScheme: undefined});
+    SitumPlugin.configureUserHelper({ enabled: true, colorScheme: undefined });
   };
 
   /**
@@ -759,11 +744,24 @@ export default class SitumPlugin {
    *
    * Shortcut for {@link configureUserHelper} with <code>{enabled: false}</code>.
    *
-   * @param {function} cb - Cordova native callback to receive data.
-   * @param {function} error - Cordova native callback to receive errors.
    */
   static disableUserHelper = () => {
-    SitumPlugin.configureUserHelper({enabled: false, colorScheme: undefined});
+    SitumPlugin.configureUserHelper({ enabled: false, colorScheme: undefined });
+  };
+
+  /**
+   * INTERNAL METHOD.
+   *
+   * Update SDK with the viewer navigation states.
+   * Do not use this method as it is intended for internal use
+   * by the map viewer module.
+   *
+   * @param externalNavigation
+   */
+  static updateNavigationState = (externalNavigation: Map<string, any>) => {
+    return exceptionWrapper<void>(() => {
+      RNCSitumPlugin.updateNavigationState(externalNavigation);
+    });
   };
 
   /**
@@ -790,9 +788,26 @@ export default class SitumPlugin {
    * @param callback
    */
   static internalSetMethodCallMapDelegate = (
-    callback: (internalCall: InternalCall) => void
+    callback: (internalCall: InternalCall) => void,
   ) => {
     internalMethodCallMapDelegate = callback;
+    const lastValues = DelegatedStateManager.getInstance().getValues();
+    // Forward last received values as soon as possible:
+    if (lastValues.location) {
+      internalMethodCallMapDelegate(
+        new InternalCall(InternalCallType.LOCATION, lastValues.location),
+      );
+    }
+    if (lastValues.status) {
+      internalMethodCallMapDelegate(
+        new InternalCall(InternalCallType.LOCATION_STATUS, lastValues.status),
+      );
+    }
+    if (lastValues.error) {
+      internalMethodCallMapDelegate(
+        new InternalCall(InternalCallType.LOCATION_ERROR, lastValues.error),
+      );
+    }
   };
 
   //-----------------------------------------------------------------------------//
@@ -889,7 +904,7 @@ export default class SitumPlugin {
    * @param callback a function that returns the {@link NavigationProgress} by parameters.
    */
   static onNavigationProgress = (
-    callback: (progress: NavigationProgress) => void
+    callback: (progress: NavigationProgress) => void,
   ) => {
     navigationProgressCallback = callback;
   };
@@ -900,7 +915,7 @@ export default class SitumPlugin {
    * @param callback a function that returns the completed {@link Route} by parameters.
    */
   static onNavigationDestinationReached = (
-    callback: (route: Route) => void
+    callback: (route: Route) => void,
   ) => {
     navigationDestinationReachedCallback = callback;
   };

package/src/sdk/internaDelegatedState.ts

@@ -0,0 +1,54 @@
+import { Location, Error } from "./types";
+
+// Internal state forwarded to the MapView as soon as possible.
+export type DelegatedState = {
+  location: Location | null;
+  status: string | null;
+  error: Error | null;
+};
+
+export class DelegatedStateManager {
+  private static instance: DelegatedStateManager;
+  private state: DelegatedState = {
+    location: null,
+    status: null,
+    error: null,
+  };
+
+  private constructor() {}
+
+  static getInstance(): DelegatedStateManager {
+    if (!DelegatedStateManager.instance) {
+      DelegatedStateManager.instance = new DelegatedStateManager();
+    }
+    return DelegatedStateManager.instance;
+  }
+
+  updateLocation(location: Location): void {
+    this.state = {
+      location,
+      status: null,
+      error: null,
+    };
+  }
+
+  updateStatus(status: string): void {
+    this.state = {
+      location: null,
+      status,
+      error: null,
+    };
+  }
+
+  updateError(error: Error): void {
+    this.state = {
+      location: null,
+      status: null,
+      error,
+    };
+  }
+
+  getValues(): Readonly<DelegatedState> {
+    return this.state;
+  }
+}

package/src/sdk/nativeInterface.ts

@@ -25,60 +25,60 @@ import type {
 interface CartographyAPI {
   fetchBuildings: (
     onSuccess: (response: Building[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchBuildingInfo: (
     bluilding: Building,
     onSuccess: (response: BuildingInfo) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchTilesFromBuilding: (
     building: Building,
     onSuccess: (response: string) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchFloorsFromBuilding: (
     building: Building,
     onSuccess: (response: Floor[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchMapFromFloor: (
     floor: Floor,
     onSuccess: (response: string) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchGeofencesFromBuilding: (
     building: Building,
     onSuccess: (response: Geofence[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchPoiCategories: (
     onSuccess: (response: PoiCategory[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchPoiCategoryIconNormal: (
     category: PoiCategory,
     onSuccess: (response: PoiIcon) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchPoiCategoryIconSelected: (
     category: PoiCategory,
     onSuccess: (response: PoiIcon) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchIndoorPOIsFromBuilding: (
     building: Building,
     onSuccess: (response: Poi[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   fetchOutdoorPOIsFromBuilding: (
     building: Building,
     onSuccess: (response: Poi[]) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   checkIfPointInsideGeofence: (
     request: any,
-    callback: (response: { isInsideGeofence: boolean; geofence: any }) => void
+    callback: (response: { isInsideGeofence: boolean; geofence: any }) => void,
   ) => void;
   onEnterGeofences: () => void;
   onExitGeofences: () => void;
@@ -93,7 +93,7 @@ interface NavigationAPI {
   updateNavigationWithLocation: (
     location: Location,
     onSuccess: (response: void) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   updateNavigationState: (externalNavigation: Map<string, any>) => void;
 }
@@ -106,11 +106,19 @@ interface DirectionsAPI {
       | DirectionsOptions
     )[],
     onSuccess: (response: Directions) => void,
-    onError: (error: Error) => void
+    onError: (error: Error) => void,
   ) => void;
   requestNavigationUpdates: (navigationOptions: NavigationRequest) => void;
   removeNavigationUpdates: (
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
+  ) => void;
+}
+
+interface UserHelperManagerAPI {
+  configureUserHelper: (
+    userHelperOptions: UserHelperOptions,
+    success: (response: any) => void,
+    error: (response: any) => void,
   ) => void;
 }
 
@@ -119,40 +127,36 @@ export interface SitumPluginInterface
     CartographyAPI,
     LocationAPI,
     NavigationAPI,
-    DirectionsAPI {
+    DirectionsAPI,
+    UserHelperManagerAPI {
   initSitumSDK: () => void;
   setApiKey: (
     email: string,
     apiKey: string,
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
   ) => void;
   setUserPass: (
     email: string,
     password: string,
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
   ) => void;
   setDashboardURL: (
     url: string,
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
   ) => void;
   setUseRemoteConfig: (
     useRemoteConfig: string,
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
   ) => void;
   setCacheMaxAge: (
     cacheAge: number,
-    callback: (response: { success: boolean }) => void
+    callback: (response: { success: boolean }) => void,
   ) => void;
   invalidateCache: () => void;
   getDeviceId: (callback: (response: string) => void) => void;
   requestRealTimeUpdates: (options: any) => void;
   removeRealTimeUpdates: () => void;
   validateMapViewProjectSettings: () => void;
-  configureUserHelper: (
-    userHelperOptions: UserHelperOptions,
-    success: (response: any) => void,
-    error: (response: any) => void
-  ) => void;
 }
 
 const { RNCSitumPlugin } = NativeModules;
@@ -161,7 +165,7 @@ if (!RNCSitumPlugin) {
   throw new Error("react-native-situm-plugin: NativeModule is null");
 }
 
-let nativeEventEmitter = null;
+let nativeEventEmitter: NativeEventEmitter | null = null;
 
 module.exports = {
   RNCSitumPlugin,

package/src/sdk/types/index.ts

@@ -5,7 +5,7 @@ import type {
   InternalCallType,
   LocationStatusName,
   SdkNavigationUpdateType,
-} from "src/sdk";
+} from "./constants";
 
 /**
  * @name Building
@@ -183,6 +183,7 @@ export type Geofence = {
   infoHtml: string;
   polygonPoints: Point[];
   customFields: object;
+  name: string;
 };
 
 /**
@@ -694,8 +695,8 @@ export class InternalCall<T = any> {
  */
 
 export type UserHelperColorScheme = {
-  primaryColor: string,
-  secondaryColor: string,
+  primaryColor: string;
+  secondaryColor: string;
 };
 
 /**
@@ -708,6 +709,6 @@ export type UserHelperColorScheme = {
  */
 
 export type UserHelperOptions = {
-  enabled: boolean,
-  colorScheme: UserHelperColorScheme | undefined,
-};
+  enabled: boolean;
+  colorScheme: UserHelperColorScheme | undefined;
+};

package/src/sdk/utils.ts

@@ -18,7 +18,7 @@ export const handleAsyncCallback = (
   response: { success: boolean },
   resolve: PromiseResolve<void>,
   reject: PromiseReject,
-  errorMessage: string
+  errorMessage: string,
 ) => {
   if (response?.success) {
     resolve();
@@ -40,7 +40,7 @@ export const handleAsyncCallback = (
 
 export const handleSyncCallback = (
   r: { success: boolean },
-  errorMessage: string
+  errorMessage: string,
 ) => {
   if (r?.success) {
     return;
@@ -65,9 +65,9 @@ export const exceptionWrapper = <T>(
     onCallback: (r: { success: boolean }, errorMessage: string) => void;
     onSuccess: PromiseResolve<T>;
     onError: PromiseReject;
-  }) => void
-): T => {
-  let returnValue: T;
+  }) => void,
+) => {
+  let returnValue: T | undefined;
   try {
     fn({
       onCallback: handleSyncCallback,
@@ -105,7 +105,7 @@ export const promiseWrapper = <T>(
     onCallback: (r: { success: boolean }, errorMessage: string) => void;
     onSuccess: PromiseResolve<T>;
     onError: PromiseReject;
-  }) => void
+  }) => void,
 ) => {
   return new Promise<T>((resolve, reject) => {
     try {
@@ -124,14 +124,17 @@ export const promiseWrapper = <T>(
       logError(error);
       reject({
         code: ErrorCode.UNKNOWN,
-        message: error?.message || "Unknown error.",
+        message:
+          typeof error === "object" && error !== null && "message" in error
+            ? error?.message
+            : "Unknown error.",
         type: ErrorType.NON_CRITICAL,
       });
     }
   });
 };
 
-export function locationStatusAdapter(statusName): string {
+export function locationStatusAdapter(statusName: any): string {
   // The MapView will only understand status names declared at LocationStatusName and CALCULATING
   // is not one of them.
   // TODO: implement status & error adapter on native SDKs.
@@ -141,7 +144,7 @@ export function locationStatusAdapter(statusName): string {
   return statusName;
 }
 
-export function locationErrorAdapter(error): Error {
+export function locationErrorAdapter(error: any): Error {
   let adaptedCode = ErrorCode.UNKNOWN;
   const adaptedMessage = error.message;
   const adaptedType = ErrorType.CRITICAL;

package/src/utils/logError.ts

@@ -11,6 +11,6 @@ export const logError = __DEV__
         console.log(JSON.stringify(response));
       }
     }
-  : function (_response) {
+  : function (_response: any) {
       // do nothing
     };