@situm/react-native 3.15.0 → 3.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,230 +3,75 @@
3
3
  /* eslint-disable @typescript-eslint/no-explicit-any */
4
4
 
5
5
  /**
6
- * @name Building
7
- * @description A Building object definition
8
- *
9
- * @property {string} buildingIdentifier - The unique identifier of the resource
10
- * @property {string} name - The building name that is appropriate for display to the user.
11
- * @property {string} address - Te building address.
12
- * @property {Bounds} bounds - Compute corners of this building, without rotation, in earth coordinates.
13
- * @property {Bounds} boundsRotated - Compute corners of this building, with rotation, in earth coordinates.
14
- * @property {Coordinate} center - Center of the building's base, as geographical coordinate.
15
- * @property {Dimensions} Dimensions - Dimensions of building's base (height and width) in meters.
16
- * @property {string} infoHtml - Additional information about building, formatted with HTML
17
- * @property {string} pictureThumbUrl - The URL of building thumbnail image
18
- * @property {string} pictureUrl - The URL of building image
19
- * @property {number} rotation - Rotation angle of the building's base, relative to the west-east axis, increasing in counter-clockwise, being 0 the west-east axis.
20
- * @property {string} userIdentifier - Unique identifier of the owner user of the building
21
- * @property {object} customFields - Map of custom fields, indexed by their name.
22
- */
23
-
24
- /**
25
- * @name BuildingInfo
26
- * @description Full information of a building
27
- *
28
- * @property {Building} building - Building basic information
29
- * @property {Floor[]} floors - Array with the information of each floor
30
- * @property {Poi[]} indoorPOIs - Array with the information of each indoor POI
31
- * @property {Poi[]} outdoorPOIs - Array with the information of each outdoor POI
32
- * @property {Geofence} geofences - Array with the information of each geofence
33
- */
34
-
35
- /** @name Bounds
36
- * @description Represents a rectangle bounds in a greographic 2D space.
37
- *
38
- * @property {Coordinate} northEast - The coordinate of the north-east corner of the bound.
39
- * @property {Coordinate} northWest - The coordinate of the north-west corner of the bound.
40
- * @property {Coordinate} southEast - The coordinate of the south-east corner of the bound.
41
- * @property {Coordinate} southWest - The coordinate of the south-east corner of the bound.
6
+ * A Building object definition.
42
7
  */
43
8
 
44
- /** @name Dimensions
45
- * @description Define 2D dimensions of a rectangular area.
46
- *
47
- * @property {number} width - Width of rectangle in meters
48
- * @property {number} height - Height of rectangle in meters.
49
- */
50
-
51
- /**
52
- * @name Coordinate
53
- * @description A structure that contains geographical coordinate.
54
- *
55
- * @property {number} latitude - Latitude in degrees
56
- * @property {number} longitude - Longitude in degrees
57
- */
58
-
59
- /**
60
- * @name CartesianCoordinate
61
- * @description A structure that contains cartesian coordinate.
62
- *
63
- * @property {number} x - Value of coordinate at x-axis
64
- * @property {number} y - Value of coordinate at y-axis
65
- */
66
-
67
- /**
68
- * @name Floor
69
- * @description Floor of a building.
70
- *
71
- * @property {number} altitude - Altitude of the floor above ground level, in meters.
72
- * @property {string} buildingIdentifier - The identifier of building which this floor belongs.
73
- * @property {number} level - The number of the floor.
74
- * @property {string} name - The name of the floor
75
- * @property {string} mapUrl - The floor map image url
76
- * @property {number} scale - The scale of the floor image, in px/meters
77
- * @property {string} floorIdentifier - The unique identifier of the resource
78
- */
9
+ /**
10
+ * Full information of a building
11
+ */
12
+
13
+ /**
14
+ * Represents a rectangle bounds in a greographic 2D space.
15
+ */
16
+
17
+ /**
18
+ * Define 2D dimensions of a rectangular area.
19
+ */
20
+
21
+ /**
22
+ * A structure that contains geographical coordinate.
23
+ */
24
+
25
+ /**
26
+ * A structure that contains cartesian coordinate.
27
+ */
28
+
29
+ /**
30
+ * Floor of a building.
31
+ */
32
+
33
+ /**
34
+ * Point of Interest, associated to a building, regardless of whether it's placed inside or outside the building.
35
+ */
36
+
37
+ /**
38
+ * Point of Interest, associated to a building, regardless of whether it's placed inside or outside the building.
39
+ */
40
+
41
+ /**
42
+ * Category of Point of Interest.
43
+ */
44
+
45
+ /**
46
+ * Category of Point of Interest.
47
+ */
48
+
49
+ /**
50
+ * Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
51
+ */
52
+
53
+ /**
54
+ * Route between two points.
55
+ */
56
+
57
+ /**
58
+ * 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.
59
+ */
60
+
61
+ /**
62
+ * A fragment of a route, described by a floor identifier and a list of consecutive points from the same floor
63
+ */
64
+
65
+ /**
66
+ * Represents the instruction that a user should follow when on a RouteStep to continue the route.
67
+ */
68
+
69
+ /**
70
+ * Provides information of the progress of a user while following a route.
71
+ */
79
72
 
80
73
  /**
81
- * @name POI
82
- * @description Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
83
- *
84
- * @property {string} identifier - The unique identifier of the resource
85
- * @property {string} buildingIdentifier - Identifier of building to which the POI belongs.
86
- * @property {CartesianCoordinate} cartesianCoordinate - Cartesian coordinate of this position, relative to building {@link Bounds}.
87
- * @property {Coordinate} coordinate - Geographical coordinate of this position
88
- * @property {string} floorIdentifier - If this POI is outside the building (isOutdoor == true), this field has no meaning.
89
- * @property {string} poiName - A name for the POI, appropriate for display to the user.
90
- * @property {Point} position - {@link Point} where the point is located.
91
- * @property {boolean} isIndoor - Whether the POI is placed outside the building or not.
92
- * @property {boolean} isOutdoor - Whether the POI is placed outside the building or not.
93
- * @property {PoiCategory} category - Category of the POI
94
- * @property {string} infoHtml - Additional information about POI, in HTML
95
- * @property {object} customFields - Map of custom fields, indexed by their name.
96
- */
97
-
98
- /**
99
- * @name Geofence
100
- * @description Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
101
- *
102
- * @property {string} identifier - The unique identifier of the resource
103
- * @property {string} buildingIdentifier - Identifier of building to which the POI belongs.
104
- * @property {string} floorIdentifier - If this POI is outside the building (isOutdoor == true), this field has no meaning.
105
- * @property {string} name - A name for the geofence, appropriate for display to the user.
106
- * @property {string} infoHtml - Additional information about POI, in HTML
107
- * @property {Point[]} polygonPoints - List of points of that define the area of the geofence
108
- * @property {object} customFields - Map of custom fields, indexed by their name.
109
- */
110
-
111
- /**
112
- * @name PoiCategory
113
- * @description Category of Point of Interest.
114
- *
115
- * @property {string} poiCategoryCode - Unique code of the category
116
- * @property {string} poiCategoryName - The category name appropriate for display to the user
117
- * @property {string} icon_selected - The selected icon url
118
- * @property {string} icon_unselected - The unselected icon url
119
- * @property {boolean} public - Whether the category is public or not
120
- */
121
-
122
- /**
123
- * @name PoiIcon
124
- * @description Category of Point of Interest.
125
- *
126
- * @property {string} data - Base64 POI icon image
127
- */
128
-
129
- /**
130
- * @name Point
131
- * @description Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
132
- *
133
- * @property {string} buildingIdentifier - Unique identifier for the building to which this point belongs
134
- * @property {CartesianCoordinate} cartesianCoordinate - Cartesian coordinate (in meters) relative to the Bounds of building's base.
135
- * @property {Coordinate} coordinate - Geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building.
136
- * @property {string} floorIdentifier - Floor identifier (inside the building) where this point is placed.
137
- * @property {boolean} isIndoor - If the POI is inside the building.
138
- * @property {boolean} idOutdoor - If the POI is outside the building.
139
- */
140
-
141
- /**
142
- * @name Route
143
- * @description Route between two points.
144
- *
145
- * @property {Poi} poiTo - The destination Poi the user is currently navigating to.
146
- * @property {RouteStep[]} edges - Ordered list of steps to go to the goal point
147
- * @property {RouteStep} firstStep - First step
148
- * @property {Point} from - Point where the route starts.
149
- * @property {Indication} indications - Ordered list of instructions to go to the destination
150
- * @property {RouteStep} lastStep - Last step
151
- * @property {Point[]} nodes - A collection of points of the route (not ordered)
152
- * @property {Point[]} points - List of ordered points of the route
153
- * @property {Point} to - Last point and goal of the route.
154
- * @property {RouteStep[]} steps - Ordered list of steps to go to the goal point
155
- * @property {RouteSegment[]} segments - List of segments formed by consecutive points and a floor identifier
156
- */
157
-
158
- /**
159
- * @name RouteStep
160
- * @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.
161
- *
162
- * @property {number} distance - Distance between from and to in meters.
163
- * @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).
164
- * @property {Point} from - Start point of this step.
165
- * @property {number} id - Position of this RouteStep in the list of steps (Route.steps) of the route to which it belongs.
166
- * @property {Point} to - End point of this step.
167
- * @property {boolean} isFirst - Returns true if this is the first step in the route.
168
- * @property {boolean} isLast - Returns true if this is the last step in the route.
169
- */
170
-
171
- /**
172
- * @name RouteSegment
173
- * @description A fragment of a route, described by a floor identifier and a list of consecutive points from the same floor
174
- *
175
- * @property {string} floorIdentifier - Identifier of the floor containing the points in this segment
176
- * @property {Point[]} points - Consecutive points in the same floor forming a path
177
- */
178
-
179
- /**
180
- * @name Indication
181
- * @description Represents the instruction that a user should follow when on a RouteStep to continue the route.
182
- *
183
- * @property {number} distance - The distance between the origin and destination
184
- * @property {number} distanceToNextLevel - The number of levels between the origin and destination
185
- * @property {string} indicationType - The Indication.Action of the instruction as String
186
- * @property {number} orientation - The angle a user should change his direction in order to go from the origin to the destination.
187
- * @property {string} orientationType - The Indication.Orientation of the instruction as String
188
- * @property {number} stepIdxDestination - The index of the indication's step of destination.
189
- * @property {number} stepIdxOrigin - The index of the indication's step of origin
190
- * @property {boolean} neededLevelChange - If the user should change the level in order to arrive at the destination.
191
- */
192
-
193
- /**
194
- * @name NavigationProgress
195
- * @description Provides information of the progress of a user while following a route.
196
- *
197
- * @property {Location} closestLocationInRoute - Closest location in the route from the user location provided .
198
- * @property {number} distanceToClosestPointInRoute - Distance between the real user location (provided to updateWithLocation(Location)) and the closest route location.
199
- * @property {Indication} currentIndication - The current indication.
200
- * @property {Indication} nextIndication - The next indication.
201
- * @property {number} currentStepIndex - The index of the closest route step to the user, where closestLocationInRoute is.
202
- * @property {number} distanceToGoal - The distance in meters from closestLocationInRoute to route's goal point.
203
- * @property {number} distanceToEndStep - The distance in meters to go from closestLocationInRoute to the end of the current step.
204
- * @property {number} timeToEndStep - The estimated time to go from closestLocationInRoute to the end of the current route step, considering a speed of 1 meter/second.
205
- * @property {number} timeToGoal - The estimated time to go from closestLocationInRoute to the goal/end of route, considering a speed of 1 meter/second.
206
- * @property {RouteStep} routeStep - The closest route step to the user, where closestLocationInRoute is.
207
- * @property {Point[]} points - List of ordered points of the remaining route
208
- * @property {RouteSegment[]} segments - List of segments formed by consecutive points and a floor identifier
209
- */
210
-
211
- /**
212
- * @name LocationRequest
213
- * @description A data object that contains parameters for the location service, LocationManager.
214
- *
215
- * @property {number} buildingIdentifier - Identifier of the building on which the positioning will be started
216
- * @property {number} interval - Default interval (in milliseconds) to notify location updates
217
- * @property {string} indoorProvider - Default indoor provider. Possible values are INPHONE and SUPPORT
218
- * @property {boolean} useBle - Defines whether or not to use BLE for positioning
219
- * @property {boolean} useWifi - Defines whether or not to use Wi-Fi for positioning
220
- * @property {boolean} useGps - Defines whether or not to use GPS for indoor positioning
221
- * @property {boolean} useBarometer - Defines whether or not to use the barometer for indoor positioning
222
- * @property {string} motionMode - Default motion mode. Possible values are BY_CAR, BY_FOOT, and RADIOMAX
223
- * @property {boolean} useForegroundService - Defines whether or not to activate the {@link http://developers.situm.es/pages/android/using_situm_sdk_background.html foreground service}
224
- * @property {boolean} useDeadReckoning - Defines whether or not to use dead reckoning to get fast position updates using only the inertial sensors, between the server position updates.
225
- * @property {OutdoorLocationOptions} outdoorLocationOptions - Outdoor location options. Only used in an indoor/outdoor request
226
- * @property {BeaconFilter[]} beaconFilters - Deprecated - Beacon filters to be handled during scan time, otherwise only Situm beacons will be scanned. Can be invoked multiple times to add as much beacon filters as you want. The SitumSDK now does it automatically
227
- * @property {number} smallestDisplacement - Default smallest displacement to notify location updates
228
- * @property {string} realtimeUpdateInterval - Default interval to send locations to the Realtime. Possible values are REALTIME, FAST, NORMAL, SLOW, and BATTERY_SAVER
229
- * @property {ForegroundServiceNotificationOptions} foregroundServiceNotificationOptions - Used to configure the notification options for a foreground service, allowing the definition of the title, message, stop button, button text, and the {@link ForegroundServiceNotificationsTapAction}.
74
+ * A data object that contains parameters for the location service, LocationManager.
230
75
  */
231
76
 
232
77
  /**
@@ -235,12 +80,10 @@
235
80
  * Foreground Service.
236
81
  * To be used with {@link LocationRequest}.
237
82
  * Only applies for Android.
238
- * @property {ForegroundServiceNotificationOptions} foregroundServiceNotificationOptions
239
83
  */
240
84
 
241
85
  /**
242
- * @name ForegroundServiceNotificationsTapAction
243
- * @description Predefined actions performed when tapping the Situm Foreground Service Notification.
86
+ * Predefined actions performed when tapping the Situm Foreground Service Notification.
244
87
  */
245
88
  export let ForegroundServiceNotificationsTapAction = /*#__PURE__*/function (ForegroundServiceNotificationsTapAction) {
246
89
  /**
@@ -248,7 +91,7 @@ export let ForegroundServiceNotificationsTapAction = /*#__PURE__*/function (Fore
248
91
  */
249
92
  ForegroundServiceNotificationsTapAction["LaunchApp"] = "LAUNCH_APP";
250
93
  /**
251
- * Launch the operating system settings screen for the current app.
94
+ * Launch the operating system settings screen for the current app.
252
95
  */
253
96
  ForegroundServiceNotificationsTapAction["LaunchSettings"] = "LAUNCH_SETTINGS";
254
97
  /**
@@ -259,158 +102,82 @@ export let ForegroundServiceNotificationsTapAction = /*#__PURE__*/function (Fore
259
102
  }({});
260
103
 
261
104
  /**
262
- * @name NavigationRequest
263
- * @description A data object that contains the request for navigation.
264
- *
265
- * @property {number} distanceToGoalThreshold - Distance threshold to consider reaching the goal (meters).
266
- * @property {number} distanceToIgnoreFirstIndication - Maximum distance to ignore the first indication when navigating (meters).
267
- * @property {number} distanceToFloorChangeThreshold - Distance threshold from when a floor change is considered reached (meters).
268
- * @property {number} distanceToChangeIndicationThreshold - Distance threshold to change the indication (meters).
269
- * @property {boolean} ignoreLowQualityLocations - Ignore low-quality locations.
270
- * @property {number} indicationsInterval - Interval between indications (milliseconds).
271
- * @property {number} outsideRouteThreshold - Distance threshold to consider being outside the route (meters).
272
- * @property {number} roundIndicationsStep - Step to round indications (meters).
273
- * @property {number} timeToFirstIndication - Time to wait until the first indication is returned (milliseconds).
274
- * @property {number} timeToIgnoreUnexpectedFloorChanges - Time to ignore the locations received during navigation, when the next indication is a floor change,
275
- * if the locations are on a wrong floor (not in origin or destination floors) (milliseconds).
105
+ * A data object that contains the request for navigation.
276
106
  */
277
107
 
278
108
  /**
279
- * @name DirectionsRequest
280
- * @description A data object that contains the request for directions.
281
- *
282
- * @property {Building} positioningBuilding
283
- * @property {Point|Location} from - Current user's position as the starting point of the route.
284
- * @property {Point|Poi} to - Point to, where the route should end.
285
- * @property {DirectionsOptions} options - Options that can be added to the request.
109
+ * A data object that contains the request for directions.
286
110
  */
287
111
 
288
112
  /**
289
- * @name DirectionsOptions
290
- * @description A data object that contains the directions options.
291
- *
292
- * @property {boolean} minimizeFloorChanges - Defines wheter or not the route should be calculated minimizing the floor changes even if the result is longer.
293
- * @property {string} accessibilityMode - Defines the accessibility mode of the route. Possible values are: CHOOSE_SHORTEST, ONLY_NOT_ACCESSIBLE_FLOOR_CHANGES, ONLY_ACCESSIBLE
294
- * @property {number} startingAngle - Current user's orientation in degrees.
295
- * @property {String[]} includedTags List of tags that you want to use when calculating a route. Only the tags added here will be used. If there are other tags in the graph they won't be used. The edges without a tag will be used. If you don't set nothing all the graph will be used to calculate the route. You can learn more about this topic on https://situm.com/docs/cartography-management/#tags
296
- * @property {String[]} excludedTags List of tags that you want your route to avoid. If you exclude a tag the route will never pass through an edge that have this tag. If the route can only be generated passing through an edge with this tag the route calculation will fail. You can learn more about this topic on https://situm.com/docs/cartography-management/#tags.
113
+ * A data object that contains the directions options.
297
114
  */
298
115
 
299
116
  /**
300
- * @name OutdoorLocationOptions
301
- * @description Outdoor location options are only used in indoor-outdoor mode (Only available for Android)
302
- *
303
- * @property {boolean} continuousMode - Environment detection continuous mode (true) or burst mode (false).
304
- * @property {boolean} userDefinedThreshold
305
- * @property {number} burstInterval - Interval to scan for GPS and detect the environment (in seconds).
306
- * @property {number} averageSnrThreshold
117
+ * Outdoor location options are only used in indoor-outdoor mode (Only available for Android)
307
118
  */
308
119
 
309
120
  /**
310
- * @name BeaconFilter
311
- * @description Represents a BLE filter. Now the only field is the BLE proximity UUID
312
- *
313
- * @property {string} uuid - Assigns the proximity UUID
121
+ * Represents a BLE filter. Now the only field is the BLE proximity UUID
314
122
  */
315
123
 
316
124
  /**
317
- * @name RealTimeRequest
318
- * @description A data object that contains the parameters to process realtime data of the users.
319
- *
320
- * @property {Building} building object
321
- * @property {int} pollTime - Interval in milliseconds (minimum is 3000ms).
125
+ * A data object that contains the parameters to process realtime data of the users.
322
126
  */
323
127
 
324
128
  /**
325
- * @name RealTimeData
326
- * @description A data object that contains information of the location of users in realtime.
327
- *
328
- * @property {Array<Location>} locations object
129
+ * A data object that contains information of the location of users in realtime.
329
130
  */
330
131
 
331
132
  /**
332
- * @name SdkVersion
333
- * @description Represents the version information of the SDK and its compatibility with different platforms.
334
- *
335
- * @type
336
- * @property {string} react_native - The version of React Native used in the SDK.
337
- * @property {string} [ios] - Optional. The specific version of the Situm SDK for the iOS platform.
338
- * @property {string} [android] - Optional. The specific version of the Situm SDK for the Android platform.
133
+ * Represents the version information of the SDK and its compatibility with different platforms.
134
+ * @deprecated This type will be removed in future versions.
339
135
  */
340
136
 
341
137
  /**
342
- * @name ConfigurationOptions
343
- * @description Configuration options for initializing the SDK or other modules.
344
- *
345
- * @type
346
- * @property {boolean} [useRemoteConfig] - Optional. Determines whether to use Remote Configuration settings.
347
- * @property {number} [cacheMaxAge] - Optional. The maximum age of the cache in seconds.
138
+ * Configuration options for initializing the SDK or other modules.
348
139
  */
349
140
 
350
141
  /**
351
- * @name Location
352
- * @description Represents a location with various attributes including position, accuracy, and bearing.
353
- *
354
- * @interface
355
- * @property {Position} [position] - Optional. The position information of the location.
356
- * @property {number} [accuracy] - Optional. The accuracy of the location information in meters.
357
- * @property {Object} [bearing] - Optional. Bearing information including degrees and degreesClockwise.
358
- * @property {boolean} [hasBearing] - Optional. Indicates if bearing information is available.
142
+ * Represents a location with various attributes including position, accuracy, and bearing.
359
143
  */
360
144
 
361
145
  /**
362
- * @name LocationStatus
363
- * @description Represents the status of a location, including a name and a numeric code.
364
- *
365
- * @interface
366
- * @property {LocationStatusName} statusName - The name of the location status.
367
- * @property {number} statusCode - The numeric code representing the location status.
146
+ * Represents the status of a location, including a name and a numeric code.
368
147
  */
369
148
 
370
149
  /**
371
- * @name ErrorType
372
- * @description Enumeration of error types to categorize the severity of errors.
373
- *
374
- * @enum {string}
375
- * @property {string} CRITICAL - Represents critical errors that will cause the system not to work (e.g. positioning will be stopped).
376
- * @property {string} NON_CRITICAL - Represents non-critical errors that are less severe.
150
+ * Enumeration of error types to categorize the severity of errors.
377
151
  */
378
152
  export let ErrorType = /*#__PURE__*/function (ErrorType) {
153
+ /** Represents critical errors that will cause the system not to work (e.g. positioning will be stopped) */
379
154
  ErrorType["CRITICAL"] = "CRITICAL";
155
+ /** Represents non-critical errors that are less severe */
380
156
  ErrorType["NON_CRITICAL"] = "NON_CRITICAL";
381
157
  return ErrorType;
382
158
  }({});
383
159
 
384
160
  /**
385
- * @name ErrorCode
386
- * @description Enumeration of error codes provided by Situm SDK.
387
- *
388
- * @enum {string}
389
- * @property {string} LOCATION_PERMISSION_DENIED - Indicates that location permissions were not granted by the user.
390
- * @property {string} BLUETOOTH_PERMISSION_DENIED - Indicates that Bluetooth permissions were not granted.
391
- * @property {string} BLUETOOTH_DISABLED - Indicates that Bluetooth is disabled on the device.
392
- * @property {string} LOCATION_DISABLED - Indicates that the location services are disabled on the device.
393
- * @property {string} REDUCED_ACCURACY - Indicates that the precise location has been turned off on the device.
394
- * @property {string} UNKNOWN - Represents an unknown error or an error that does not fit other categories.
161
+ * Enumeration of error codes provided by Situm SDK.
395
162
  */
396
163
  export let ErrorCode = /*#__PURE__*/function (ErrorCode) {
164
+ /** Indicates that location permissions were not granted by the user */
397
165
  ErrorCode["LOCATION_PERMISSION_DENIED"] = "LOCATION_PERMISSION_DENIED";
166
+ /** Indicates that Bluetooth permissions were not granted */
398
167
  ErrorCode["BLUETOOTH_PERMISSION_DENIED"] = "BLUETOOTH_PERMISSION_DENIED";
168
+ /** Indicates that Bluetooth is disabled on the device */
399
169
  ErrorCode["BLUETOOTH_DISABLED"] = "BLUETOOTH_DISABLED";
170
+ /** Indicates that the location services are disabled on the device */
400
171
  ErrorCode["LOCATION_DISABLED"] = "LOCATION_DISABLED";
172
+ /** Indicates that the precise location has been turned off on the device */
401
173
  ErrorCode["REDUCED_ACCURACY"] = "REDUCED_ACCURACY";
174
+ /** Represents an unknown error or an error that does not fit other categories */
402
175
  ErrorCode["UNKNOWN"] = "UNKNOWN";
403
176
  return ErrorCode;
404
177
  }({});
405
178
 
406
179
  /**
407
- * @name Error
408
- * @description Represents an error with a specific code, message, and type.
409
- *
410
- * @interface
411
- * @property {ErrorCode} code - The specific error code associated with this error.
412
- * @property {string} message - A descriptive message providing more details about the error.
413
- * @property {ErrorType} type - The type of the error indicating its severity (critical or non-critical).
180
+ * Represents an error with a specific code, message, and type.
414
181
  */
415
182
 
416
183
  // TODO: add types
@@ -426,20 +193,10 @@ export class InternalCall {
426
193
  }
427
194
 
428
195
  /**
429
- * @name
430
- * UserHelperColorScheme
431
- * @description
432
196
  * Color scheme for the user helper UI.
433
- * @property {string} primaryColor - Primary color for the user helper UI. Use HEX color code (e.g. "#ff5733").
434
- * @property {string} secondaryColor - Secondary color for the user helper UI. Use HEX color code (e.g. "#ff5733").
435
197
  */
436
198
 
437
199
  /**
438
- * @name
439
- * UserHelperOptions
440
- * @description
441
200
  * Configuration options for the user helper.
442
- * @property {boolean} enabled - Whether the user helper is enabled. Equivalent to the underlying native SitumSdk.userHelperManager#autoManage(true).
443
- * @property {UserHelperColorScheme} colorScheme - Color scheme for the user helper UI.
444
201
  */
445
202
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"names":["ForegroundServiceNotificationsTapAction","ErrorType","ErrorCode","InternalCall","constructor","type","data","get"],"sourceRoot":"../../../../src","sources":["sdk/types/index.ts"],"mappings":";;AAAA;;AASA;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;;AAUA;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;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;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;;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;;AAiBA;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;;AASA;AACA;AACA;AACA;AACA,WAAYA,uCAAuC,0BAAvCA,uCAAuC;EACjD;AACF;AACA;EAHYA,uCAAuC;EAMjD;AACF;AACA;EARYA,uCAAuC;EAWjD;AACF;AACA;EAbYA,uCAAuC;EAAA,OAAvCA,uCAAuC;AAAA;;AAiBnD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;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;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAKrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AASrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;;AAGA,OAAO,MAAMC,YAAY,CAAU;EAIjCC,WAAWA,CAACC,IAAsB,EAAEC,IAAO,EAAE;IAC3C,IAAI,CAACD,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,IAAI,GAAGA,IAAI;EAClB;EAEAC,GAAGA,CAAA,EAAS;IACV,OAAO,IAAI,CAACD,IAAI;EAClB;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
1
+ {"version":3,"names":["ForegroundServiceNotificationsTapAction","ErrorType","ErrorCode","InternalCall","constructor","type","data","get"],"sourceRoot":"../../../../src","sources":["sdk/types/index.ts"],"mappings":";;AAAA;;AASA;AACA;AACA;;AA8BA;AACA;AACA;;AAcA;AACA;AACA;;AAYA;AACA;AACA;;AAQA;AACA;AACA;;AAQA;AACA;AACA;;AAQA;AACA;AACA;;AAkBA;AACA;AACA;;AA4BA;AACA;AACA;;AAkBA;AACA;AACA;;AAcA;AACA;AACA;;AAMA;AACA;AACA;;AAgBA;AACA;AACA;;AA0BA;AACA;AACA;;AAkBA;AACA;AACA;;AAQA;AACA;AACA;;AAoBA;AACA;AACA;;AA6BA;AACA;AACA;;AAoCA;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA,WAAYA,uCAAuC,0BAAvCA,uCAAuC;EACjD;AACF;AACA;EAHYA,uCAAuC;EAKjD;AACF;AACA;EAPYA,uCAAuC;EASjD;AACF;AACA;EAXYA,uCAAuC;EAAA,OAAvCA,uCAAuC;AAAA;;AAenD;AACA;AACA;;AAyBA;AACA;AACA;;AASA;AACA;AACA;;AAwBA;AACA;AACA;;AAUA;AACA;AACA;;AAMA;AACA;AACA;;AAQA;AACA;AACA;;AAMA;AACA;AACA;AACA;;AAUA;AACA;AACA;;AAQA;AACA;AACA;;AA8BA;AACA;AACA;;AAQA;AACA;AACA;AACA,WAAYC,SAAS,0BAATA,SAAS;EACnB;EADUA,SAAS;EAGnB;EAHUA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAOrB;AACA;AACA;AACA,WAAYC,SAAS,0BAATA,SAAS;EACnB;EADUA,SAAS;EAGnB;EAHUA,SAAS;EAKnB;EALUA,SAAS;EAOnB;EAPUA,SAAS;EASnB;EATUA,SAAS;EAWnB;EAXUA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAerB;AACA;AACA;;AAUA;;AAGA,OAAO,MAAMC,YAAY,CAAU;EAIjCC,WAAWA,CAACC,IAAsB,EAAEC,IAAO,EAAE;IAC3C,IAAI,CAACD,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACC,IAAI,GAAGA,IAAI;EAClB;EAEAC,GAAGA,CAAA,EAAS;IACV,OAAO,IAAI,CAACD,IAAI;EAClB;AACF;;AAEA;AACA;AACA;;AAQA;AACA;AACA","ignoreList":[]}
@@ -20,7 +20,7 @@ export default class SitumPlugin {
20
20
  * if it is not already initialised.
21
21
  *
22
22
  * @returns void
23
- * @throw Exception
23
+ * @throws Exception
24
24
  */
25
25
  static init: () => void | undefined;
26
26
  /**
@@ -32,7 +32,7 @@ export default class SitumPlugin {
32
32
  * @param apiKey user's apikey.
33
33
  *
34
34
  * @returns void
35
- * @throw Exception
35
+ * @throws Exception
36
36
  */
37
37
  static setApiKey: (apiKey: string) => void | undefined;
38
38
  /**
@@ -45,7 +45,7 @@ export default class SitumPlugin {
45
45
  * @param password user's password.
46
46
  *
47
47
  * @returns void
48
- * @throw Exception
48
+ * @throws Exception
49
49
  */
50
50
  static setUserPass: (email: string, password: string) => void | undefined;
51
51
  /**
@@ -54,7 +54,7 @@ export default class SitumPlugin {
54
54
  * @param url user's email.
55
55
  *
56
56
  * @returns void
57
- * @throw Exception
57
+ * @throws Exception
58
58
  */
59
59
  static setDashboardURL: (url: string) => void | undefined;
60
60
  /**
@@ -65,14 +65,14 @@ export default class SitumPlugin {
65
65
  * @param useRemoteConfig
66
66
  *
67
67
  * @returns void
68
- * @throw Exception
68
+ * @throws Exception
69
69
  */
70
70
  static setUseRemoteConfig: (useRemoteConfig: boolean) => void | undefined;
71
71
  /**
72
72
  * Sets the max seconds the cache is valid
73
73
  *
74
74
  * @returns void
75
- * @throw Exception
75
+ * @throws Exception
76
76
  */
77
77
  private static setMaxCacheAge;
78
78
  /**
@@ -81,14 +81,14 @@ export default class SitumPlugin {
81
81
  * @param options {@link ConfigurationOptions}
82
82
  *
83
83
  * @returns void
84
- * @throw Exception
84
+ * @throws Exception
85
85
  */
86
86
  static setConfiguration: (options: ConfigurationOptions) => void | undefined;
87
87
  /**
88
88
  * Invalidate all the resources in the cache
89
89
  *
90
90
  * @returns void
91
- * @throw Exception
91
+ * @throws Exception
92
92
  */
93
93
  static invalidateCache: () => void | undefined;
94
94
  /**
@@ -98,7 +98,7 @@ export default class SitumPlugin {
98
98
  * Gets the list of versions for the current plugin and environment
99
99
  *
100
100
  * @returns void
101
- * @throw Exception
101
+ * @throws Exception
102
102
  */
103
103
  static sdkVersion: () => SdkVersion | undefined;
104
104
  /**