@situm/react-native 3.0.10 → 3.1.0

package/lib/typescript/src/sdk/index.d.ts

@@ -1,26 +1,40 @@
+import type { Building, BuildingInfo, ConfigurationOptions, DirectionsOptions, Error, Floor, Geofence, Location, LocationRequest, LocationStatus, NavigationProgress, NavigationRequest, Poi, PoiCategory, PoiIcon, Point, SdkVersion } from "./types";
 export type * from "./types";
 export * from "./types/constants";
-import type { Building, DirectionPoint, DirectionsOptions, Floor, LocationRequestOptions, NavigationRequest } from "./types";
-declare const _default: {
+export default class SitumPlugin {
     /**
-     * Initializes SDK.
+     * Whether the positioning is currently in execution.
+     * @returns boolean
+     */
+    static positioningIsRunning: () => boolean;
+    /**
+     * Whether the navigation is currently in execution.
+     * @returns boolean
+     */
+    static navigationIsRunning: () => boolean;
+    /**
+     * Initializes {@link SitumPlugin}.
      *
-     * You have to call this function prior any call to other method.
+     * This method must be called before invoking any other methods.
      * This method can be safely called many times as it will only initialise the SDK
      * if it is not already initialised.
+     *
+     * @returns void
+     * @throw Exception
      */
-    initSitumSDK: () => void;
+    static init: () => void;
     /**
      * Provides your API key to the Situm SDK.
      *
      * This key is generated for your application in the Dashboard.
      * Old credentials will be removed.
      *
-     * @param email user's email.
      * @param apiKey user's apikey.
-     * @param onSuccess callback to use when the function returns successfully
+     *
+     * @returns void
+     * @throw Exception
      */
-    setApiKey: (email: string, apiKey: string, onSuccess?: Function) => void;
+    static setApiKey: (apiKey: string) => void;
     /**
      * Provides user's email and password. This credentials will be used to obtain a
      * valid user token to authenticate the server request, when necessary. Token
@@ -29,212 +43,176 @@ declare const _default: {
      *
      * @param email user's email.
      * @param password user's password.
-     * @param onSuccess callback to use when the function returns successfully
+     *
+     * @returns void
+     * @throw Exception
      */
-    setUserPass: (email: string, password: string, onSuccess?: Function) => void;
-    setDashboardURL: (url: string, success: Function) => void;
+    static setUserPass: (email: string, password: string) => void;
+    /**
+     * Sets the API's base URL to retrieve the data.
+     *
+     * @param url user's email.
+     *
+     * @returns void
+     * @throw Exception
+     */
+    static setDashboardURL: (url: string) => void;
     /**
      * Set to true if you want the SDK to download the configuration from the Situm API
-     * and use it by default. Right now it only affects the LocationRequest.
+     * and use it by default. Right now it only affects the {@link LocationRequest}.
      * Default value is true from SDK version 2.83.5
      *
-     * @param useRemoteConfig boolean
-     * @param success function called on sucess
+     * @param useRemoteConfig
+     *
+     * @returns void
+     * @throw Exception
      */
-    setUseRemoteConfig(useRemoteConfig: string, onSuccess?: Function): void;
+    static setUseRemoteConfig: (useRemoteConfig: boolean) => void;
     /**
-     * Sets the maximum age of a cached response. If the cache response's age exceeds
-     * maxAge, it will not be used and a network request will be made.
+     * Sets the max seconds the cache is valid
      *
-     * @param cacheAge a non-negative integer
-     * @param success function called on success
+     * @returns void
+     * @throw Exception
      */
-    setCacheMaxAge: (cacheAge: number, success?: Function) => void;
+    private static setMaxCacheAge;
+    /**
+     * Sets the SDK {@link ConfigurationOptions}.
+     *
+     * @param options {@link ConfigurationOptions}
+     *
+     * @returns void
+     * @throw Exception
+     */
+    static setConfiguration: (options: ConfigurationOptions) => void;
     /**
      * Invalidate all the resources in the cache
+     *
+     * @returns void
+     * @throw Exception
      */
-    invalidateCache: () => void;
+    static invalidateCache: () => void;
     /**
      * Gets the list of versions for the current plugin and environment
      *
-     * @param callback callback to use on success
+     * @returns void
+     * @throw Exception
      */
-    sdkVersions: (callback: (event: {
-        ios?: string;
-        android?: string;
-        react_native: string;
-    }) => void) => void;
+    static sdkVersion: () => SdkVersion;
     /**
      * Returns the device identifier that has generated the location
      *
-     * @param callback function called on sucess, returns the id of the current device
+     * @returns void
+     * @throw Exception
      */
-    getDeviceId: (callback: Function) => void;
+    static getDeviceId: () => string;
     /**
-     * Request authorization for the provided authentication
-     * and stores it internally for subsequent requests
-     */
-    requestAuthorization: () => void;
-    /**
-     * Download all the buildings for the current user
-     *
-     * @param success function called on sucess, returns a list of Building objects
-     * @param error function called on failure, returns an error string
+     * Downloads all the {@link Building}s for the current user.
      */
-    fetchBuildings: (success: Function, error?: Function) => void;
+    static fetchBuildings: () => Promise<Building[]>;
     /**
-     * Download all the building data for the selected building. This info includes
-     * floors, indoor and outdoor POIs, events and paths. Also it download floor
-     * maps and POI category icons to local storage.
+     * Downloads all the building data for the selected building. This info includes
+     * {@link Floor}, indoor and outdoor {@link Poi}s, events and paths. Also it download floor
+     * maps and {@link PoiCategory} icons to local storage.
      *
-     * @param building
-     * @param success function called on sucess, returns a list of Building objects
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
      */
-    fetchBuildingInfo: (building: Building, success: Function, error?: Function) => void;
-    fetchTilesFromBuilding: (building: Building, success: Function, error?: Function) => void;
+    static fetchBuildingInfo: (building: Building) => Promise<BuildingInfo>;
     /**
-     * Download all the floors of a building
+     * (Experimental) Downloads the tiled-map of a certain building
      *
-     * @param building
-     * @param success function called on sucess, returns a list of Floor objects
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building} whose tiles will be downloaded
      */
-    fetchFloorsFromBuilding: (building: Building, success: Function, error?: Function) => void;
+    static fetchTilesFromBuilding: (building: Building) => Promise<any>;
     /**
-     * Download the map image of a floor
+     * Downloads all the floors of a building
      *
-     * @param floor the floor object. Not null.
-     * @param success function called on sucess, returns a list of Map url objects
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
      */
-    fetchMapFromFloor: (floor: Floor, success: Function, error?: Function) => void;
+    static fetchFloorsFromBuilding: (building: Building) => Promise<Floor[]>;
     /**
-     * Get the geofences of a building
+     * Downloads the map image of a {@link Floor}
      *
-     * @param building
-     * @param success function called on sucess, returns a list of Building objects
-     * @param error function called on failure, returns an error string
+     * @param floor {@link Floor}
      */
-    fetchGeofencesFromBuilding: (building: Building, success: Function, error?: Function) => void;
+    static fetchMapFromFloor: (floor: Floor) => Promise<string>;
     /**
-     * Get all POI categories, download and cache their icons asynchronously.
+     * Get the geofences of a {@link Building}
      *
-     * @param success function called on sucess, returns a list of POI categories
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
      */
-    fetchPoiCategories: (success: Function, error?: Function) => void;
+    static fetchGeofencesFromBuilding: (building: Building) => Promise<Geofence[]>;
     /**
-     * Get the normal category icon for a category
-     *
-     * @param category the category. Not null.
-     * @param success function called on sucess, returns the icon in normal state.
-     * @param error function called on failure, returns an error string
+     * Get all {@link PoiCategory}, download and cache their icons asynchronously.
      */
-    fetchPoiCategoryIconNormal: (category: any, success: Function, error?: Function) => void;
+    static fetchPoiCategories: () => Promise<PoiCategory[]>;
     /**
-     * Get the selected category icon for a category
+     * Get the normal {@link PoiIcon} for a category
      *
-     * @param category the category. Not null.
-     * @param success function called on sucess, returns the icon in selected state.
-     * @param error function called on failure, returns an error string
+     * @param category {@link PoiCategory}. Not null.
      */
-    fetchPoiCategoryIconSelected: (category: any, success: Function, error?: Function) => void;
+    static fetchPoiCategoryIconNormal: (category: PoiCategory) => Promise<PoiIcon>;
     /**
-     * Download the indoor POIs of a building
+     * Get the selected {@link PoiIcon} for a {@link PoiCategory}
      *
-     * @param building
-     * @param success function called on sucess, returns a list of POI objects
-     * @param error function called on failure, returns an error string
+     * @param category {@link PoiCategory}. Not null.
      */
-    fetchIndoorPOIsFromBuilding: (building: any, success: Function, error?: Function) => void;
+    static fetchPoiCategoryIconSelected: (category: PoiCategory) => Promise<PoiIcon>;
     /**
-     * Download the outdoor POIs of a building
+     * Download the indoor {@link Poi}s of a {@link Building}
      *
-     * @param building
-     * @param success function called on sucess, returns a list of POI objects
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
      */
-    fetchOutdoorPOIsFromBuilding: (building: any, success: Function, error?: Function) => void;
+    static fetchIndoorPOIsFromBuilding: (building: Building) => Promise<Poi[]>;
     /**
-     * Download the events of a building
+     * Download the outdoor {@link Poi}s of a {@link Building}
      *
-     * @param building
-     * @param success Callback to asynchronously receive the events of a building. Not null.
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
      */
-    fetchEventsFromBuilding: (building: any, success: Function, error?: Function) => void;
+    static fetchOutdoorPOIsFromBuilding: (building: Building) => Promise<Poi[]>;
     /**
-     * Starts positioning with the configuration specified by the LocationRequest;
-     * computed geolocations, status codes and errors will be received through the LocationListener callbacks.
-     * You may call this method more than once, with the following effect:
-     *
-     *  - If you provide a new LocationRequest instance, positioning will be re-started
-     *    with the new positioning options specified by this new instance.
-     *  - If you provide a new LocationListener, the former LocationListener will be
-     *    replaced, therefore geolocations will be communicated to the new one.
-     *  - If neither LocationRequest nor LocationListener change, nothing will happen.
-     *    You may stop positioning at any time by calling the LocationManager.removeUpdates() method.
+     * Starts positioning.
      *
-     * @param location callback to use when location is udpated
-     * @param status callback to use when the positioning status changes
-     * @param error callback to use when error is raised
-     * @param locationOptions hashmap with options
-     *
-     * @returns the id of the subscription
+     * @param {LocationRequest} locationRequest Positioning options to configure how positioning will behave
      */
-    startPositioning: (location: (event: any) => void, status: Function, error?: Function, options?: LocationRequestOptions) => void;
-    startPositioningUpdates: (location: (event: any) => void, status: (event: any) => void, error?: (event: any) => void, options?: LocationRequestOptions) => void;
+    static requestLocationUpdates: (locationRequest?: LocationRequest) => void;
     /**
      * Stops positioning, removing all location updates
-     *
-     * @param callback the callback to use when the function successfully ends
-     * @returns
      */
-    stopPositioning: (callback?: Function) => void;
+    static removeLocationUpdates: () => void;
     /**
      * Calculates a route between two points. The result is provided
      * asynchronously using the callback.
      *
-     * @param directionParams
-     * @param success function called on sucess, returns a Route object
-     * @param error function called on failure, returns an error string
+     * @param building {@link Building}
+     * @param from {@link Point} route origin
+     * @param to {@link Point} route destination
+     * @param directionOptions {@link DirectionsOptions}
      */
-    requestDirections: (directionParams: [
-        Building,
-        DirectionPoint,
-        DirectionPoint,
-        DirectionsOptions
-    ], success: Function, error?: Function) => void;
+    static requestDirections: (building: Building, from: Point | Location, to: Point | Poi, directionOptions?: DirectionsOptions) => Promise<any>;
     /**
      * Set the navigation params, and the listener that receives the updated
      * navigation progress.
      *
      * Can only exist one navigation with one listener at a time. If this method was
-     * previously invoked, but removeUpdates() wasn't, removeUpdates() is called internally.
+     * previously invoked, but removeLocationUpdates() wasn't, removeLocationUpdates()
+     * is called internally.
      *
-     * @param navigationUpdates
-     * @param error function called on failure, returns an error string
-     * @param options
+     * @param options {@link NavigationRequest}
      */
-    requestNavigationUpdates: (navigationUpdates: (event: any) => void, error?: (event: any) => void, options?: NavigationRequest) => void;
+    static requestNavigationUpdates: (options?: NavigationRequest) => void;
     /**
      * Informs NavigationManager object the change of the user's location
      *
-     * @param location new Location of the user. If null, nothing is done
-     * @param success callback to use when the navigation updates
-     * @param error callback to use when an error on navigation udpates raises
+     * @param location new {@link Location} of the user. If null, nothing is done
      */
-    updateNavigationWithLocation: (location: any, success: Function, error?: Function) => void;
+    static updateNavigationWithLocation: (location: Location) => void;
     /**
      * Removes all location updates. This removes the internal state of the manager,
      * including the listener provided in requestNavigationUpdates(NavigationRequest,
      * NavigationListener), so it won't receive more progress updates.
      *
-     * @param callback
      */
-    removeNavigationUpdates: (callback?: Function) => void;
-    requestRealTimeUpdates: (navigationUpdates: (event: any) => void, error?: (event: any) => void, options?: any) => void;
+    static removeNavigationUpdates: () => void;
     /**
      * Requests a real time devices positions
      *
@@ -242,30 +220,90 @@ declare const _default: {
      * @param error callback to use when an error on navigation udpates raises
      * @param options Represents the configuration for getting realtime devices positions in
      */
-    removeRealTimeUpdates: (_callback?: Function) => void;
-    checkIfPointInsideGeofence: (request: any, callback?: Function) => void;
+    static requestRealTimeUpdates: (realtimeUpdates: (event: any) => void, error?: (event: any) => void, options?: any) => void;
+    /**
+     * Removes all real time updates listners.
+     *
+     * @param _callback
+     */
+    static removeRealTimeUpdates: (_callback?: Function) => void;
+    /**
+     * Checks if a point is inside a {@link Geofence}
+     *
+     */
+    static checkIfPointInsideGeofence: (request: any, callback?: (response: {
+        isInsideGeofence: boolean;
+        geofence: any;
+    }) => void) => void;
     /**
-     * Callback that notifies when the user enters a geofence.
+     * Callback that notifies when the user enters a {@link Geofence}.
      *
      * In order to use correctly these callbacks you must know the following:
      *  - Positioning geofences (with trainer_metadata custom field) won't be notified.
      *  - These callbacks only work with indoor locations. Any outdoor location will
      *    produce a call to onExitedGeofences with the last positioned geofences as argument.
      *
-     * @param callback the function called when the user enters a geofence
+     * @param callback the function called when the user enters a {@link Geofence}
      */
-    onEnterGeofences: (callback: (event: any) => void) => void;
+    static onEnterGeofences: (callback: (event: Geofence) => void) => void;
     /**
-     * Callback that notifies when the user exits a geofence.
+     * Callback that notifies when the user exits a {@link Geofence}.
      *
      * In order to use correctly these callbacks you must know the following:
      *  - Positioning geofences (with trainer_metadata custom field) won't be notified.
      *  - These callbacks only work with indoor locations. Any outdoor location will
      *    produce a call to onExitedGeofences with the last positioned geofences as argument.
      *
-     * @param callback the function called when the user exits a geofence
+     * @param callback the function called when the user exits a {@link Geofence}
+     */
+    static onExitGeofences: (callback: (event: Geofence) => void) => void;
+    /**
+     * Callback that notifies when the user {@link Location} changes.
+     *
+     * @param callback the function called when the user {@link Location} changes
+     */
+    static onLocationUpdate: (callback: (location: Location) => void) => void;
+    /**
+     * Callback that notifies when the user {@link LocationStatus} changes.
+     *
+     * @param callback the function called when the user {@link LocationStatus} changes
+     */
+    static onLocationStatus: (callback: (status: LocationStatus) => void) => void;
+    /**
+     * Callback that notifies when there is an error while the user is positioining.
+     *
+     * @param callback the function called when there is an error
+     */
+    static onLocationError: (callback: (status: Error) => void) => void;
+    /**
+     * Callback that notifies when the user stops positioning.
+     *
+     * @param callback the function called when the user stops positioning.
+     */
+    static onLocationStopped: (callback: () => void) => void;
+    /**
+     * Callback that notifies every navigation progress.
+     *
+     * @param callback the function called when there is a navigation progress.
+     */
+    static onNavigationProgress: (callback: (progress: NavigationProgress) => void) => void;
+    /**
+     * Callback that notifies when the user gets out of the current route
+     *
+     * @param callback the function called when the user gets out of the current route.
+     */
+    static onNavigationOutOfRoute: (callback: () => void) => void;
+    /**
+     * Callback that notifies when the user finishes the route.
+     *
+     * @param callback the function called when the user finishes the route.
+     */
+    static onNavigationFinished: (callback: () => void) => void;
+    /**
+     * Callback that notifies when there is an error during navigation.
+     *
+     * @param callback the function called when there is an error during navigation.
      */
-    onExitGeofences: (callback: (event: any) => void) => void;
-};
-export default _default;
+    static onNavigationError: (callback: (error: any) => void) => void;
+}
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/sdk/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/sdk/index.ts"],"names":[],"mappings":"AAKA,mBAAmB,SAAS,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAIlC,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,iBAAiB,EACjB,KAAK,EACL,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,SAAS,CAAC;;IA0Bf;;;;;;OAMG;wBACwB,IAAI;IAI/B;;;;;;;;;OASG;uBAEM,MAAM,UACL,MAAM,cACF,QAAQ,KACnB,IAAI;IAIP;;;;;;;;;OASG;yBAEM,MAAM,YACH,MAAM,cACJ,QAAQ,KACnB,IAAI;2BAIyB,MAAM,WAAW,QAAQ,KAAG,IAAI;IAIhE;;;;;;;OAOG;wCACiC,MAAM,cAAc,QAAQ,GAAG,IAAI;IAIvE;;;;;;OAMG;+BACiC,MAAM,YAAY,QAAQ,KAAG,IAAI;IAIrE;;OAEG;2BAC2B,IAAI;IAIlC;;;;OAIG;oCAEiB;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;KACtB,KAAK,IAAI,KACT,IAAI;IAcP;;;;OAIG;4BAC8B,QAAQ,KAAG,IAAI;IAIhD;;;OAGG;gCACgC,IAAI;IAIvC;;;;;OAKG;8BACgC,QAAQ,UAAU,QAAQ,KAAG,IAAI;IASpE;;;;;;;;OAQG;kCAES,QAAQ,WACT,QAAQ,UACT,QAAQ,KACf,IAAI;uCAUK,QAAQ,WACT,QAAQ,UACT,QAAQ;IASlB;;;;;;OAMG;wCAES,QAAQ,WACT,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;OAMG;+BAEM,KAAK,WACH,QAAQ,UACT,QAAQ,KACf,IAAI;IASP;;;;;;OAMG;2CAES,QAAQ,WACT,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;OAKG;kCACoC,QAAQ,UAAU,QAAQ;IASjE;;;;;;OAMG;2CAES,GAAG,WACJ,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;OAMG;6CAES,GAAG,WACJ,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;OAMG;4CAES,GAAG,WACJ,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;OAMG;6CAES,GAAG,WACJ,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;OAMG;wCAES,GAAG,WACJ,QAAQ,UACT,QAAQ,KACf,IAAI;IAaP;;;;;;;;;;;;;;;;;;OAkBG;yCAEiB,GAAG,KAAK,IAAI,UACtB,QAAQ,UACR,QAAQ,YACN,sBAAsB,KAC/B,IAAI;gDAWa,GAAG,KAAK,IAAI,kBACd,GAAG,KAAK,IAAI,kBACZ,GAAG,KAAK,IAAI,YAClB,sBAAsB,KAC/B,IAAI;IAmBP;;;;;OAKG;iCACmC,QAAQ,KAAG,IAAI;IAIrD;;;;;;;OAOG;yCAEgB;QACf,QAAQ;QACR,cAAc;QACd,cAAc;QACd,iBAAiB;KAClB,WACQ,QAAQ,UACT,QAAQ;IAclB;;;;;;;;;;OAUG;0DAE0B,GAAG,KAAK,IAAI,kBACvB,GAAG,KAAK,IAAI,YAClB,iBAAiB;IAmB7B;;;;;;OAMG;2DAGQ,QAAQ,UACT,QAAQ;IAclB;;;;;;OAMG;yCAC2C,QAAQ;wDAUzB,GAAG,KAAK,IAAI,kBACvB,GAAG,KAAK,IAAI,YAClB,GAAG;IAcf;;;;;;OAMG;wCAC0C,QAAQ;0CAKN,GAAG,aAAa,QAAQ;IASvE;;;;;;;;;OASG;yCAC2C,GAAG,KAAK,IAAI;IAO1D;;;;;;;;;OASG;wCAC0C,GAAG,KAAK,IAAI;;AApmB3D,wBAymBE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/sdk/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EACZ,oBAAoB,EAEpB,iBAAiB,EACjB,KAAK,EACL,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EACjB,GAAG,EACH,WAAW,EACX,OAAO,EACP,KAAK,EACL,UAAU,EACX,MAAM,SAAS,CAAC;AAIjB,mBAAmB,SAAS,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AA0BlC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B;;;OAGG;IACH,MAAM,CAAC,oBAAoB,EAAE,MAAM,OAAO,CAA4B;IAEtE;;;OAGG;IACH,MAAM,CAAC,mBAAmB,EAAE,MAAM,OAAO,CAA2B;IAEpE;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,aAIT;IAEF;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,WAAY,MAAM,UAMhC;IAEF;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,WAAW,UAAW,MAAM,YAAY,MAAM,UAMnD;IAEF;;;;;;;OAOG;IAEH,MAAM,CAAC,eAAe,QAAS,MAAM,UAMnC;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,kBAAkB,oBAAqB,OAAO,UASnD;IAEF;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc,CAM3B;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,YAAa,oBAAoB,UAWtD;IAEF;;;;;OAKG;IACH,MAAM,CAAC,eAAe,aAIpB;IAEF;;;;;OAKG;IACH,MAAM,CAAC,UAAU,mBAcf;IAEF;;;;;OAKG;IACH,MAAM,CAAC,WAAW,eAIhB;IAEF;;OAEG;IACH,MAAM,CAAC,cAAc,4BAInB;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,aAAc,QAAQ,2BAI5C;IAEF;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,aAAc,QAAQ,kBAIjD;IAEF;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,aAAc,QAAQ,sBAIlD;IAEF;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,UAAW,KAAK,qBAItC;IAEF;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,aAAc,QAAQ,yBAIrD;IAEF;;OAEG;IACH,MAAM,CAAC,kBAAkB,+BAIvB;IAEF;;;;OAIG;IACH,MAAM,CAAC,0BAA0B,aAAc,WAAW,sBAIxD;IAEF;;;;OAIG;IACH,MAAM,CAAC,4BAA4B,aAAc,WAAW,sBAI1D;IAEF;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,aAAc,QAAQ,oBAItD;IAEF;;;;OAIG;IACH,MAAM,CAAC,4BAA4B,aAAc,QAAQ,oBAIvD;IAEF;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,qBAAsB,eAAe,UAchE;IAEF;;OAEG;IACH,MAAM,CAAC,qBAAqB,aAY1B;IAEF;;;;;;;;OAQG;IACH,MAAM,CAAC,iBAAiB,aACZ,QAAQ,QACZ,KAAK,GAAG,QAAQ,MAClB,KAAK,GAAG,GAAG,qBACI,iBAAiB,kBAMpC;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,wBAAwB,aAAc,iBAAiB,UAK5D;IAEF;;;;OAIG;IACH,MAAM,CAAC,4BAA4B,aAAc,QAAQ,UAQvD;IAEF;;;;;OAKG;IACH,MAAM,CAAC,uBAAuB,aAW5B;IAEF;;;;;;OAMG;IAEH,MAAM,CAAC,sBAAsB,4BACF,GAAG,KAAK,IAAI,kBACrB,GAAG,KAAK,IAAI,YAClB,GAAG,UAcb;IAEF;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,eAAgB,QAAQ,UAKlD;IAEF;;;OAGG;IACH,MAAM,CAAC,0BAA0B,YACtB,GAAG,wBACU;QAAE,gBAAgB,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI,UAG3E;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,qBAAsB,QAAQ,KAAK,IAAI,UAI5D;IAEF;;;;;;;;;OASG;IACH,MAAM,CAAC,eAAe,qBAAsB,QAAQ,KAAK,IAAI,UAG3D;IAEF;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,wBAAyB,QAAQ,KAAK,IAAI,UAE/D;IAEF;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,sBAAuB,cAAc,KAAK,IAAI,UAEnE;IAEF;;;;OAIG;IACH,MAAM,CAAC,eAAe,sBAAuB,KAAK,KAAK,IAAI,UAEzD;IAEF;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,aAAc,MAAM,IAAI,UAE9C;IAEF;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,wBACJ,kBAAkB,KAAK,IAAI,UAUhD;IAEF;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,aAAc,MAAM,IAAI,UAUnD;IAEF;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,aAAc,MAAM,IAAI,UASjD;IAEF;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,qBAAsB,GAAG,KAAK,IAAI,UAExD;CACH"}

package/lib/typescript/src/sdk/nativeInterface.d.ts

@@ -1,2 +1,61 @@
+import { type NativeModule } from "react-native";
+import type { Building, BuildingInfo, Directions, DirectionsOptions, Error, Floor, Geofence, Location, LocationRequest, NavigationRequest, Poi, PoiCategory, PoiIcon, Point } from "./types";
+interface CartographyAPI {
+    fetchBuildings: (onSuccess: (response: Building[]) => void, onError: (error: Error) => void) => void;
+    fetchBuildingInfo: (bluilding: Building, onSuccess: (response: BuildingInfo) => void, onError: (error: Error) => void) => void;
+    fetchTilesFromBuilding: (building: Building, onSuccess: (response: string) => void, onError: (error: Error) => void) => void;
+    fetchFloorsFromBuilding: (building: Building, onSuccess: (response: Floor[]) => void, onError: (error: Error) => void) => void;
+    fetchMapFromFloor: (floor: Floor, onSuccess: (response: string) => void, onError: (error: Error) => void) => void;
+    fetchGeofencesFromBuilding: (building: Building, onSuccess: (response: Geofence[]) => void, onError: (error: Error) => void) => void;
+    fetchPoiCategories: (onSuccess: (response: PoiCategory[]) => void, onError: (error: Error) => void) => void;
+    fetchPoiCategoryIconNormal: (category: PoiCategory, onSuccess: (response: PoiIcon) => void, onError: (error: Error) => void) => void;
+    fetchPoiCategoryIconSelected: (category: PoiCategory, onSuccess: (response: PoiIcon) => void, onError: (error: Error) => void) => void;
+    fetchIndoorPOIsFromBuilding: (building: Building, onSuccess: (response: Poi[]) => void, onError: (error: Error) => void) => void;
+    fetchOutdoorPOIsFromBuilding: (building: Building, onSuccess: (response: Poi[]) => void, onError: (error: Error) => void) => void;
+    checkIfPointInsideGeofence: (request: any, callback: (response: {
+        isInsideGeofence: boolean;
+        geofence: any;
+    }) => void) => void;
+    onEnterGeofences: () => void;
+    onExitGeofences: () => void;
+}
+interface LocationAPI {
+    startPositioning: (locationRequest?: LocationRequest) => void;
+    stopPositioning: (callback: (response: {
+        success: boolean;
+    }) => void) => void;
+}
+interface NavigationAPI {
+    updateNavigationWithLocation: (location: Location, onSuccess: (response: void) => void, onError: (error: Error) => void) => void;
+}
+interface DirectionsAPI {
+    requestDirections: (directionsParameters: (Building | (Point | Location | Poi) | DirectionsOptions)[], onSuccess: (response: Directions) => void, onError: (error: Error) => void) => void;
+    requestNavigationUpdates: (navigationOptions: NavigationRequest) => void;
+    removeNavigationUpdates: (callback: (response: {
+        success: boolean;
+    }) => void) => void;
+}
+export interface SitumPluginInterface extends NativeModule, CartographyAPI, LocationAPI, NavigationAPI, DirectionsAPI {
+    initSitumSDK: () => void;
+    setApiKey: (email: string, apiKey: string, callback: (response: {
+        success: boolean;
+    }) => void) => void;
+    setUserPass: (email: string, password: string, callback: (response: {
+        success: boolean;
+    }) => void) => void;
+    setDashboardURL: (url: string, callback: (response: {
+        success: boolean;
+    }) => void) => void;
+    setUseRemoteConfig: (useRemoteConfig: string, callback: (response: {
+        success: boolean;
+    }) => void) => void;
+    setCacheMaxAge: (cacheAge: number, callback: (response: {
+        success: boolean;
+    }) => void) => void;
+    invalidateCache: () => void;
+    getDeviceId: (callback: (response: string) => void) => void;
+    requestRealTimeUpdates: (options: any) => void;
+    removeRealTimeUpdates: () => void;
+}
 export {};
 //# sourceMappingURL=nativeInterface.d.ts.map

package/lib/typescript/src/sdk/nativeInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nativeInterface.d.ts","sourceRoot":"","sources":["../../../../src/sdk/nativeInterface.ts"],"names":[],"mappings":""}
+{"version":3,"file":"nativeInterface.d.ts","sourceRoot":"","sources":["../../../../src/sdk/nativeInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EAElB,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,KAAK,EACL,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,eAAe,EACf,iBAAiB,EACjB,GAAG,EACH,WAAW,EACX,OAAO,EACP,KAAK,EACN,MAAM,SAAS,CAAC;AAEjB,UAAU,cAAc;IACtB,cAAc,EAAE,CACd,SAAS,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,IAAI,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,iBAAiB,EAAE,CACjB,SAAS,EAAE,QAAQ,EACnB,SAAS,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,EAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,sBAAsB,EAAE,CACtB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,EACrC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,uBAAuB,EAAE,CACvB,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,IAAI,EACtC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,iBAAiB,EAAE,CACjB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,EACrC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,0BAA0B,EAAE,CAC1B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,IAAI,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,kBAAkB,EAAE,CAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,IAAI,EAC5C,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,0BAA0B,EAAE,CAC1B,QAAQ,EAAE,WAAW,EACrB,SAAS,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,EACtC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,4BAA4B,EAAE,CAC5B,QAAQ,EAAE,WAAW,EACrB,SAAS,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,EACtC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,2BAA2B,EAAE,CAC3B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,IAAI,EACpC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,4BAA4B,EAAE,CAC5B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,IAAI,EACpC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,0BAA0B,EAAE,CAC1B,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,gBAAgB,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,KAAK,IAAI,KACvE,IAAI,CAAC;IACV,gBAAgB,EAAE,MAAM,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,IAAI,CAAC;CAC7B;AAED,UAAU,WAAW;IACnB,gBAAgB,EAAE,CAAC,eAAe,CAAC,EAAE,eAAe,KAAK,IAAI,CAAC;IAC9D,eAAe,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAAK,IAAI,CAAC;CAC/E;AAED,UAAU,aAAa;IACrB,4BAA4B,EAAE,CAC5B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,CAAC,QAAQ,EAAE,IAAI,KAAK,IAAI,EACnC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;CACX;AAED,UAAU,aAAa;IACrB,iBAAiB,EAAE,CACjB,oBAAoB,EAAE,CAClB,QAAQ,GACR,CAAC,KAAK,GAAG,QAAQ,GAAG,GAAG,CAAC,GACxB,iBAAiB,CACpB,EAAE,EACH,SAAS,EAAE,CAAC,QAAQ,EAAE,UAAU,KAAK,IAAI,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAC5B,IAAI,CAAC;IACV,wBAAwB,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACzE,uBAAuB,EAAE,CACvB,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;CACX;AAED,MAAM,WAAW,oBACf,SAAQ,YAAY,EAClB,cAAc,EACd,WAAW,EACX,aAAa,EACb,aAAa;IACf,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,SAAS,EAAE,CACT,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;IACV,WAAW,EAAE,CACX,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;IACV,eAAe,EAAE,CACf,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;IACV,kBAAkB,EAAE,CAClB,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;IACV,cAAc,EAAE,CACd,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,KAC/C,IAAI,CAAC;IACV,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,KAAK,IAAI,CAAC;IAC5D,sBAAsB,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;IAC/C,qBAAqB,EAAE,MAAM,IAAI,CAAC;CACnC"}

package/lib/typescript/src/sdk/types/constants.d.ts

@@ -1,12 +1,18 @@
 export declare enum NavigationStatus {
     START = "start",
     STOP = "stop",
+    OUT_OF_ROUTE = "outOfRoute",
     UPDATE = "update"
 }
 export declare enum NavigationUpdateType {
-    progress = "PROGRESS",
-    userOutsideRoute = "OUT_OF_ROUTE",
-    destinationReached = "DESTINATION_REACHED"
+    PROGRESS = "PROGRESS",
+    OUT_OF_ROUTE = "OUT_OF_ROUTE",
+    FINISHED = "DESTINATION_REACHED"
+}
+export declare enum SdkNavigationUpdateType {
+    PROGRESS = "progress",
+    OUT_OF_ROUTE = "userOutsideRoute",
+    FINISHED = "destinationReached"
 }
 export declare enum LocationStatusName {
     STARTING = "STARTING",
@@ -15,4 +21,19 @@ export declare enum LocationStatusName {
     USER_NOT_IN_BUILDING = "USER_NOT_IN_BUILDING",
     STOPPED = "STOPPED"
 }
+/**
+ * Available accessibility modes used in the {@link DirectionsRequest}.
+ *
+ * @property CHOOSE_SHORTEST The route should choose the best route, without taking into account if it is accessible or not
+ * This option is the default so you don't have to do anything in order to use it
+ * @property ONLY_ACCESSIBLE The route should always use accessible nodes.
+ * @property ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES The route should never use accessible floor changes (use this to force routes not to use lifts).
+ */
+export declare enum AccessibilityMode {
+    CHOOSE_SHORTEST = "CHOOSE_SHORTEST",
+    ONLY_ACCESSIBLE = "ONLY_ACCESSIBLE",
+    ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES = "ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES"
+}
+export declare const CURRENT_USER_LOCATION_ID = -1;
+export declare const CUSTOM_DESTINATION_LOCATION_ID = -2;
 //# sourceMappingURL=constants.d.ts.map

package/lib/typescript/src/sdk/types/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/types/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,oBAAY,oBAAoB;IAC9B,QAAQ,aAAa;IACrB,gBAAgB,iBAAiB;IACjC,kBAAkB,wBAAwB;CAC3C;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAG3B,WAAW,gBAAgB;IAC3B,oBAAoB,yBAAyB;IAC7C,OAAO,YAAY;CACpB"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/types/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,gBAAgB;IAC1B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,YAAY,eAAe;IAC3B,MAAM,WAAW;CAClB;AAED,oBAAY,oBAAoB;IAC9B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,QAAQ,wBAAwB;CACjC;AAED,oBAAY,uBAAuB;IACjC,QAAQ,aAAa;IACrB,YAAY,qBAAqB;IACjC,QAAQ,uBAAuB;CAChC;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAG3B,WAAW,gBAAgB;IAC3B,oBAAoB,yBAAyB;IAC7C,OAAO,YAAY;CACpB;AAED;;;;;;;GAOG;AACH,oBAAY,iBAAiB;IAC3B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,iCAAiC,sCAAsC;CACxE;AAED,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAC3C,eAAO,MAAM,8BAA8B,KAAK,CAAC"}