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

package/lib/module/sdk/types/index.d.js

@@ -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.
@@ -20,47 +20,42 @@
  * @property {object} customFields - Map of custom fields, indexed by their name.
  */
 
-/** @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.
  */
 
-/** @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.
  */
 
 /**
- * @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
  */
 
 /**
- * @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
  */
 
 /**
- * @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.
@@ -71,10 +66,9 @@
  */
 
 /**
- * @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}.
@@ -90,10 +84,9 @@
  */
 
 /**
- * @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.
@@ -104,10 +97,9 @@
  */
 
 /**
- * @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
@@ -116,10 +108,9 @@
  */
 
 /**
- * @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.
@@ -129,10 +120,9 @@
  */
 
 /**
- * @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.
@@ -146,10 +136,9 @@
  */
 
 /**
- * @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.
@@ -160,19 +149,17 @@
  */
 
 /**
- * @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
  */
 
 /**
- * @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
@@ -184,10 +171,9 @@
  */
 
 /**
- * @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.
@@ -204,10 +190,9 @@
  */
 
 /**
- * @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
@@ -223,10 +208,9 @@
  */
 
 /**
- * @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
@@ -235,19 +219,17 @@
  */
 
 /**
- * @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
  */
 
 /**
- * @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
@@ -266,20 +248,17 @@
  */
 
 /**
- * @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.
  */
 
 /**
- * @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.
@@ -293,10 +272,9 @@
  */
 
 /**
- * @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.
@@ -304,10 +282,9 @@
  */
 
 /**
- * @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).
@@ -316,10 +293,9 @@
  */
 
 /**
- * @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).
@@ -327,27 +303,24 @@
  */
 
 /**
- * @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
  */
 
 /**
- * @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).
  */
 
 /**
- * @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
  */
 

package/lib/module/sdk/types/index.d.js.map

@@ -1 +1 @@
-{"version":3,"names":["LocationStatusName","NavigationStatus","NavigationUpdateType"],"sourceRoot":"../../../../src","sources":["sdk/types/index.d.ts"],"mappings":"AAAA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAkBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoCA,WAAYA,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAgC9B,WAAYC,gBAAgB,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAM5B,WAAYC,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA"}
+{"version":3,"names":["LocationStatusName","NavigationStatus","NavigationUpdateType"],"sourceRoot":"../../../../src","sources":["sdk/types/index.d.ts"],"mappings":"AAAA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAmCA,WAAYA,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAgC9B,WAAYC,gBAAgB,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAM5B,WAAYC,oBAAoB,0BAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAApBA,oBAAoB;EAAA,OAApBA,oBAAoB;AAAA"}

package/lib/module/wayfinding/index.js

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

package/lib/module/wayfinding/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["default","useSitum","SitumProvider","MapView"],"sourceRoot":"../../../src","sources":["wayfinding/index.ts"],"mappings":"AAAA;;AAGA;AACA,SAASA,OAAO,IAAIC,QAAQ,QAAQ,SAAS;;AAE7C;AACA,SAASD,OAAO,IAAIE,aAAa,QAAQ,SAAS;;AAElD;AACA,SAASF,OAAO,IAAIG,OAAO,QAAQ,sBAAsB"}
+{"version":3,"names":["default","useSitum","SitumProvider","MapView"],"sourceRoot":"../../../src","sources":["wayfinding/index.ts"],"mappings":"AAAA;AACA,cAAc,SAAS;;AAEvB;AACA,SAASA,OAAO,IAAIC,QAAQ,QAAQ,SAAS;;AAE7C;AACA,SAASD,OAAO,IAAIE,aAAa,QAAQ,SAAS;;AAElD;AACA,SAASF,OAAO,IAAIG,OAAO,QAAQ,sBAAsB"}

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

@@ -1,4 +1,4 @@
-export type * from "./types";
+export * from "./types";
 export { default as useSitum } from "./hooks";
 export { default as SitumProvider } from "./store";
 export { default as MapView } from "./components/MapView";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/wayfinding/index.ts"],"names":[],"mappings":"AACA,mBAAmB,SAAS,CAAC;AAG7B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,SAAS,CAAC;AAG9C,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/wayfinding/index.ts"],"names":[],"mappings":"AACA,cAAc,SAAS,CAAC;AAGxB,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,SAAS,CAAC;AAG9C,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@situm/react-native",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0",
   "description": "Set of utilities that allow any developer to build React Native location based apps using Situm's indoor positioning system.",
   "private": false,
   "repository": "https://github.com/situmtech/react-native",