@situm/react-native 3.0.0-beta.5 → 3.0.0

package/src/sdk/types/index.d.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/ban-types */
 
-/** @name
- * Building
- * @description
- * A Building object definition
+/**
+ * @name Building
+ * @description A Building object definition
+ *
  * @property {string} buildingIdentifier - The unique identifier of the resource
  * @property {string} name - The building name that is appropriate for display to the user.
  * @property {string} address - Te building address.
@@ -19,7 +19,6 @@
  * @property {string} userIdentifier - Unique identifier of the owner user of the building
  * @property {object} customFields - Map of custom fields, indexed by their name.
  */
-
 export type Building = {
   buildingIdentifier: string;
   name: string;
@@ -36,16 +35,14 @@ export type Building = {
   customFields: object;
 };
 
-/** @name
- * Bounds
- * @description
- * Represents a rectangle bounds in a greographic 2D space.
+/** @name Bounds
+ * @description Represents a rectangle bounds in a greographic 2D space.
+ *
  * @property {Coordinate} northEast - The coordinate of the north-east corner of the bound.
  * @property {Coordinate} northWest - The coordinate of the north-west corner of the bound.
  * @property {Coordinate} southEast - The coordinate of the south-east corner of the bound.
  * @property {Coordinate} southWest - The coordinate of the south-east corner of the bound.
  */
-
 export type Bounds = {
   northEast: Coordinate;
   northWest: Coordinate;
@@ -53,52 +50,45 @@ export type Bounds = {
   southWest: Coordinate;
 };
 
-/** @name
- * Dimensions
- * @description
- * Define 2D dimensions of a rectangular area.
+/** @name Dimensions
+ * @description Define 2D dimensions of a rectangular area.
+ *
  * @property {number} width - Width of rectangle in meters
  * @property {number} height - Height of rectangle in meters.
  */
-
 export type Dimensions = {
   width: number;
   height: number;
 };
 
 /**
- * @name
- * Coordinate
- * @description
- * A structure that contains geographical coordinate.
+ * @name Coordinate
+ * @description A structure that contains geographical coordinate.
+ *
  * @property {number} latitude - Latitude in degrees
  * @property {number} longitude - Longitude in degrees
  */
-
 export type Coordinate = {
   latitude: number;
   longitude: number;
 };
 
 /**
- * @name
- * CartesianCoordinate
- * @description
- * A structure that contains cartesian coordinate.
+ * @name CartesianCoordinate
+ * @description A structure that contains cartesian coordinate.
+ *
  * @property {number} x - Value of coordinate at x-axis
  * @property {number} y - Value of coordinate at y-axis
  */
-
 export type CartesianCoordinate = {
   x: number;
   y: number;
 };
 
 /**
- * @name
- * Floor
- * @description
- * Floor of a building.
+ * @name Floor
+ * @description Floor of a building.
+ *
  * @property {number} altitude - Altitude of the floor above ground level, in meters.
  * @property {string} buildingIdentifier - The identifier of building which this floor belongs.
  * @property {number} level - The number of the floor.
@@ -107,7 +97,6 @@ export type CartesianCoordinate = {
  * @property {number} scale - The scale of the floor image, in px/meters
  * @property {string} floorIdentifier - The unique identifier of the resource
  */
-
 export type Floor = {
   altitude: number;
   buildingIdentifier: string;
@@ -119,10 +108,9 @@ export type Floor = {
 };
 
 /**
- * @name
- * POI
- * @description
- * Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
+ * @name POI
+ * @description Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
+ *
  * @property {string} identifier - The unique identifier of the resource
  * @property {string} buildingIdentifier - Identifier of building to which the POI belongs.
  * @property {CartesianCoordinate} cartesianCoordinate - Cartesian coordinate of this position, relative to building {@link Bounds}.
@@ -136,7 +124,6 @@ export type Floor = {
  * @property {string} infoHtml - Additional information about POI, in HTML
  * @property {object} customFields - Map of custom fields, indexed by their name.
  */
-
 export type Poi = {
   identifier: string;
   buildingIdentifier: string;
@@ -153,10 +140,9 @@ export type Poi = {
 };
 
 /**
- * @name
- * Geofence
- * @description
- * Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
+ * @name Geofence
+ * @description Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
+ *
  * @property {string} identifier - The unique identifier of the resource
  * @property {string} buildingIdentifier - Identifier of building to which the POI belongs.
  * @property {string} floorIdentifier - If this POI is outside the building (isOutdoor == true), this field has no meaning.
@@ -165,7 +151,6 @@ export type Poi = {
  * @property {Point[]} polygonPoints - List of points of that define the area of the geofence
  * @property {object} customFields - Map of custom fields, indexed by their name.
  */
-
 export type Geofence = {
   identifier: string;
   buildingIdentifier: string;
@@ -176,17 +161,15 @@ export type Geofence = {
 };
 
 /**
- * @name
- * PoiCategory
- * @description
- * Category of Point of Interest.
+ * @name PoiCategory
+ * @description Category of Point of Interest.
+ *
  * @property {string} poiCategoryCode - Unique code of the category
  * @property {string} poiCategoryName - The category name appropriate for display to the user
  * @property {string} icon_selected - The selected icon url
  * @property {string} icon_unselected - The unselected icon url
  * @property {boolean} public - Whether the category is public or not
  */
-
 export type PoiCategory = {
   poiCategoryCode: string;
   poiCategoryName: string;
@@ -196,10 +179,9 @@ export type PoiCategory = {
 };
 
 /**
- * @name
- * Point
- * @description
- * Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
+ * @name Point
+ * @description Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
+ *
  * @property {string} buildingIdentifier - Unique identifier for the building to which this point belongs
  * @property {CartesianCoordinate} cartesianCoordinate - Cartesian coordinate (in meters) relative to the Bounds of building's base.
  * @property {Coordinate} coordinate - Geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building.
@@ -207,7 +189,6 @@ export type PoiCategory = {
  * @property {boolean} isIndoor - If the POI is inside the building.
  * @property {boolean} idOutdoor - If the POI is outside the building.
  */
-
 export type Point = {
   buildingIdentifier: string;
   cartesianCoordinate: CartesianCoordinate;
@@ -216,17 +197,16 @@ export type Point = {
   isIndoor: boolean;
   isOutdoor: boolean;
 };
-
 export type DirectionPoint = {
   floorIdentifier: Floor["floorIdentifier"];
   buildingIdentifier: Building["buildingIdentifier"];
   coordinate: Coordinate;
 };
+
 /**
- * @name
- * Route
- * @description
- * Route between two points.
+ * @name Route
+ * @description Route between two points.
+ *
  * @property {RouteStep[]} edges - Ordered list of steps to go to the goal point
  * @property {RouteStep} firstStep - First step
  * @property {Point} from - Point where the route starts.
@@ -238,7 +218,6 @@ export type DirectionPoint = {
  * @property {RouteStep[]} steps - Ordered list of steps to go to the goal point
  * @property {RouteSegment[]} segments - List of segments formed by consecutive points and a floor identifier
  */
-
 export type Route = {
   edges: RouteStep[];
   firstStep: RouteStep;
@@ -253,10 +232,9 @@ export type Route = {
 };
 
 /**
- * @name
- * RouteStep
- * @description
- * A fragment of a route, described by the initial point from and the last point to of the fragment, and some information about the step within the route.
+ * @name RouteStep
+ * @description A fragment of a route, described by the initial point from and the last point to of the fragment, and some information about the step within the route.
+ *
  * @property {number} distance - Distance between from and to in meters.
  * @property {number} distanceToGoal - Distance in meters between the start point of this step (from) and the last point in the route ('to' of the last step).
  * @property {Point} from - Start point of this step.
@@ -265,7 +243,6 @@ export type Route = {
  * @property {boolean} isFirst - Returns true if this is the first step in the route.
  * @property {boolean} isLast - Returns true if this is the last step in the route.
  */
-
 export type RouteStep = {
   distance: number;
   distanceToGoal: number;
@@ -277,24 +254,21 @@ export type RouteStep = {
 };
 
 /**
- * @name
- * RouteSegment
- * @description
- * A fragment of a route, described by a floor identifier and a list of consecutive points from the same floor
+ * @name RouteSegment
+ * @description A fragment of a route, described by a floor identifier and a list of consecutive points from the same floor
+ *
  * @property {string} floorIdentifier - Identifier of the floor containing the points in this segment
  * @property {Point[]} points - Consecutive points in the same floor forming a path
  */
-
 export type RouteSegment = {
   floorIdentifier: string;
   points: Point[];
 };
 
 /**
- * @name
- * Indication
- * @description
- * Represents the instruction that a user should follow when on a RouteStep to continue the route.
+ * @name Indication
+ * @description Represents the instruction that a user should follow when on a RouteStep to continue the route.
+ *
  * @property {number} distance - The distance between the origin and destination
  * @property {number} distanceToNextLevel - The number of levels between the origin and destination
  * @property {string} indicationType - The Indication.Action of the instruction as String
@@ -304,7 +278,6 @@ export type RouteSegment = {
  * @property {number} stepIdxOrigin - The index of the indication's step of origin
  * @property {boolean} neededLevelChange - If the user should change the level in order to arrive to destination
  */
-
 export type Indication = {
   distance: number;
   distanceToNextLevel: number;
@@ -317,10 +290,9 @@ export type Indication = {
 };
 
 /**
- * @name
- * NavigationProgress
- * @description
- * Provides information of the progress of a user while following a route.
+ * @name NavigationProgress
+ * @description Provides information of the progress of a user while following a route.
+ *
  * @property {Point} closestPointInRoute - Closest point in the route from the user location provided . @deprecated Use closestLocationInRoute instead.
  * @property {Location} closestLocationInRoute - Closest location in the route from the user location provided .
  * @property {number} distanceToClosestPointInRoute - Distance between the real user location (provided to updateWithLocation(Location)) and the closest route location.
@@ -335,7 +307,6 @@ export type Indication = {
  * @property {Point[]} points - List of ordered points of the remaining route
  * @property {RouteSegment[]} segments - List of segments formed by consecutive points and a floor identifier
  */
-
 export type NavigationProgress = {
   closestPointInRoute: Point;
   closestLocationInRoute: Location;
@@ -353,10 +324,9 @@ export type NavigationProgress = {
 };
 
 /**
- * @name
- * SitumEvent
- * @description
- * An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps.
+ * @name SitumEvent
+ * @description An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps.
+ *
  * @property {number} buildingIdentifier - The identifier of the building this floor belongs to. Deprecated, use trigger.center.buildingIdentifier instead
  * @property {number} identifier - Unique identifier of the SitumEvent.
  * @property {number} floorIdentifier - The identifier of the floor this event is located at. @deprecated, use trigger.center.floorIdentifier instead
@@ -370,7 +340,6 @@ export type NavigationProgress = {
  * @property {number} x - Center of the event in the x-axis. @deprecated, use trigger.center.cartesianCoordinate.x instead
  * @property {number} y - Center of the event in the y-axis. @deprecated, use trigger.center.cartesianCoordinate.y instead
  */
-
 export type SitumEvent = {
   buildingIdentifier: number;
   identifier: number;
@@ -387,17 +356,15 @@ export type SitumEvent = {
 };
 
 /**
- * @name
- * SitumConversionArea
- * @description
- * A rectangular area of a floor defining the conversion area of an event
+ * @name SitumConversionArea
+ * @description A rectangular area of a floor defining the conversion area of an event
+ *
  * @property {number} floorIdentifier - The identifier of the floor the SitumConversionArea is located at.
  * @property {object} topLeft - Top-left corner
  * @property {object} topRight - Top-right corner
  * @property {object} bottomLeft - Bottom-left corner
  * @property {object} bottomRight - Bottom-right corner
  */
-
 export type SitumConversionArea = {
   floorIdentifier: number;
   topLeft: object;
@@ -407,24 +374,21 @@ export type SitumConversionArea = {
 };
 
 /**
- * @name
- * Circle
- * @description
- * A circular area
+ * @name Circle
+ * @description A circular area
+ *
  * @property {Point} center - The center of the circle
  * @property {number} radius - The radius of the circle
  */
-
 export type Circle = {
   center: Point;
   radius: number;
 };
 
 /**
- * @name
- * LocationOptions
- * @description
- * A data object that contains parameters for the location service, LocationManager.
+ * @name LocationOptions
+ * @description A data object that contains parameters for the location service, LocationManager.
+ *
  * @property {number} buildingIdentifier - Identifier of the building on which the positioning will be started
  * @property {number} interval - Default interval (in milliseconds) to notify location updates
  * @property {string} indoorProvider - Default indoor provider. Possible values are INPHONE and SUPPORT
@@ -441,7 +405,6 @@ export type Circle = {
  * @property {string} realtimeUpdateInterval - Default interval to send locations to the Realtime. Possible values are REALTIME, FAST, NORMAL, SLOW and BATTERY_SAVER
  * @property {boolean} autoEnableBleDuringPositioning - Set if the BLE should be re-enabled during positioning if the ble is used. Android only
  */
-
 export type LocationRequestOptions = {
   buildingIdentifier: number;
   interval?: number;
@@ -461,25 +424,21 @@ export type LocationRequestOptions = {
 };
 
 /**
- * @name
- * LocationRequest
- * @description
- * A data object that contains parameters for the location service, LocationManager.
- * @type {array}
+ * @name LocationRequest
+ * @description A data object that contains parameters for the location service, LocationManager.
+ *
  * @property {Building} building 0 - Building on which the positioning will be started
  * @property {LocationOptions} locationOptions 1 - Location options.
  */
-
 export type LocationRequest = {
   building: Building;
   locationOptions: LocationRequestOptions;
 };
 
 /**
- * @name
- * NavigationRequest
- * @description
- * A data object that contains parameters for the navigation service, NavigationManager.
+ * @name NavigationRequest
+ * @description A data object that contains parameters for the navigation service, NavigationManager.
+ *
  * @property {number} distanceToChangeIndicationThreshold - Distance threshold from when the next indication is considered reached.
  * @property {number} distanceToFloorChangeThreshold - Distance threshold from when a floor change is considered reached.
  * @property {number} distanceToGoalThreshold - Distance threshold from when the goal is considered reached.
@@ -491,7 +450,6 @@ export type LocationRequest = {
  * @property {number} timeToFirstIndication - Time to wait until the first indication is returned.
  * @property {number} timeToIgnoreUnexpectedFloorChanges - Time (in millis) to ignore the locations received during navigation, when the next indication is a floor change, if the locations are in a wrong floor (not in origin or destination floors).
  */
-
 export type NavigationRequest = {
   distanceToIgnoreFirstIndication: number;
   ignoreLowQualityLocations: number;
@@ -506,16 +464,14 @@ export type NavigationRequest = {
 };
 
 /**
- * @name
- * DirectionsRequest
- * @description
- * A data object that contains the request for directions.
+ * @name DirectionsRequest
+ * @description A data object that contains the request for directions.
+ *
  * @property {Building} positioningBuilding
  * @property {Point|Location} from - Current user's position as the starting point of the route.
  * @property {Point|POI} to - Point to, where the route should end.
  * @property {DirectionsOptions} options - Options that can be added to the request.
  */
-
 export type DirectionsRequest = {
   positioningBuilding: Building;
   from: Point | Location;
@@ -524,17 +480,15 @@ export type DirectionsRequest = {
 };
 
 /**
- * @name
- * DirectionsOptions
- * @description
- * A data object that contains the directions options.
+ * @name DirectionsOptions
+ * @description A data object that contains the directions options.
+ *
  * @property {boolean} minimizeFloorChanges - Defines wheter or not the route should be calculated minimizing the floor changes even if the result is longer.
  * @property {boolean} accessibleRoute - Deprecated, use accessibilityMode. Defines wheter or not the route has to be suitable for wheel chairs (true) or not (false).
  * @property {boolean} accessible - Deprecated, use accessibilityMode. Defines wheter or not the route has to be suitable for wheel chairs (true) or not (false).
  * @property {string} accessibilityMode - Defines the accessibility mode of the route. Possible values are: CHOOSE_SHORTEST, ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES, ONLY_ACCESSIBLE
  * @property {number} startingAngle - Current user's orientation in degrees.
  */
-
 export type DirectionsOptions = {
   minimizeFloorChanges: boolean;
   accessibleRoute: boolean;
@@ -544,16 +498,14 @@ export type DirectionsOptions = {
 };
 
 /**
- * @name
- * OutdoorLocationOptions
- * @description
- * Outdoor location options are only used in indoor-outdoor mode (Only available for Android)
+ * @name OutdoorLocationOptions
+ * @description Outdoor location options are only used in indoor-outdoor mode (Only available for Android)
+ *
  * @property {boolean} continuousMode - Environment detection continuous mode (true) or burst mode (false).
  * @property {boolean} userDefinedThreshold
  * @property {number} burstInterval - Interval to scan for GPS and detect the environment (in seconds).
  * @property {number} averageSnrThreshold
  */
-
 export type OutdoorLocationOptions = {
   continuousMode?: boolean;
   userDefinedThreshold?: boolean;
@@ -562,39 +514,33 @@ export type OutdoorLocationOptions = {
 };
 
 /**
- * @name
- * BeaconFilter
- * @description
- * Represents a BLE filter. Now the only field is the BLE proximity UUID
+ * @name BeaconFilter
+ * @description Represents a BLE filter. Now the only field is the BLE proximity UUID
+ *
  * @property {string} uuid - Assigns the proximity UUID
  */
-
 export type BeaconFilter = {
   uuid: string;
 };
 
 /**
- * @name
- * RealTimeRequest
- * @description
- * A data object that contains the parameters to process realtime data of the users.
+ * @name RealTimeRequest
+ * @description A data object that contains the parameters to process realtime data of the users.
+ *
  * @property {Building} building object
  * @property {int} pollTime - Interval in milliseconds (minimum is 3000ms).
  */
-
 export type RealTimeRequest = {
   building: Building;
   pollTime: number;
 };
 
 /**
- * @name
- * RealTimeData
- * @description
- * A data object that contains information of the location of users in realtime.
+ * @name RealTimeData
+ * @description A data object that contains information of the location of users in realtime.
+ *
  * @property {Array<Location>} locations object
  */
-
 export type RealTimeData = {
   locations: Location[];
 };

package/src/wayfinding/index.ts

@@ -1,5 +1,5 @@
 // Definitions
-export type * from "./types";
+export * from "./types";
 
 // Hook
 export { default as useSitum } from "./hooks";

package/src/wayfinding/types/index.d.ts

@@ -1,9 +1,8 @@
-//@ts-ignore
-import { DirectionPoint } from "src/sdk/types";
+import { DirectionPoint, Poi } from "src/sdk/types";
 
 import { ErrorName } from "../components/MapView";
 
-interface MapViewError {
+export interface MapViewError {
   name: ErrorName;
   description: string;
 }
@@ -18,6 +17,7 @@ export interface WayfindingResult {
   status: string;
   message: string;
 }
+
 export interface OnPoiSelectedResult {
   buildingId: string;
   buildingName: string;
@@ -26,10 +26,12 @@ export interface OnPoiSelectedResult {
   poiId: string;
   poiName: string;
 }
+
 export interface OnPoiDeselectedResult {
   buildingId: string;
   buildingName: string;
 }
+
 export interface OnFloorChangedResult {
   buildingId: string;
   buildingName: string;
@@ -45,10 +47,12 @@ export interface Destination {
   name?: string;
   point: DirectionPoint;
 }
+
 export interface Navigation {
   status: string;
   destination?: Destination;
 }
+
 export interface OnNavigationResult {
   navigation: Navigation;
   error?: Error;