react-native-radar 3.9.0 → 3.10.0-beta.1

package/src/@types/types.ts

@@ -0,0 +1,489 @@
+export interface RadarTrackOnceOptions {
+  location?: Location;
+  desiredAccuracy?: RadarTrackingOptionsDesiredAccuracy;
+  beacons?: boolean;
+}
+
+export interface RadarGetDistanceOptions {
+  origin?: Location;
+  destination?: Location;
+  modes: string[];
+  units: string;
+}
+
+export interface RadarUpdateTripOptions {
+  options: RadarTripOptions;
+  status: RadarTripStatus;
+}
+
+export interface RadarStartTripOptions {
+  tripOptions: RadarTripOptions;
+  trackingOptions: RadarTrackingOptions;
+}
+
+export interface RadarLocationCallback {
+  status: string;
+  location?: Location;
+  stopped?: boolean;
+}
+
+export interface RadarTrackCallback {
+  status: string;
+  location?: Location;
+  user?: RadarUser;
+  events?: RadarEvent[];
+}
+
+export type RadarPermissionsStatus =
+  | "GRANTED_FOREGROUND"
+  | "GRANTED_FOREGROUND"
+  | "DENIED"
+  | "NOT_DETERMINED"
+  | "UNKNOWN";
+
+export type Event = "clientLocation" | "location" | "error" | "events";
+
+export type RadarLogLevel = "info" | "debug" | "warning" | "error" | "none";
+
+export interface RadarTrackTokenCallback {
+  status: string;
+  token?: String;
+}
+
+export interface RadarTripCallback {
+  status: string;
+  trip?: RadarTrip;
+  events?: RadarEvent[];
+}
+
+export interface RadarContextCallback {
+  status: string;
+  location?: Location;
+  context?: RadarContext;
+}
+
+export interface RadarSearchPlacesCallback {
+  status: string;
+  location?: Location;
+  places?: RadarPlace[];
+}
+
+export interface RadarSearchGeofencesCallback {
+  status: string;
+  location?: Location;
+  geofences?: RadarGeofence[];
+}
+
+export interface RadarSearchGeofencesOptions {
+  near?: Location;
+  radius: number;
+  metadata?: object;
+  tags?: string[];
+  limit: number;
+}
+
+export interface RadarGeocodeCallback {
+  status: string;
+  addresses?: RadarAddress[];
+}
+
+export interface RadarValidateAddressCallback {
+  status: string;
+  address?: RadarAddress;
+  verificationStatus?: RadarAddressVerificationStatus;
+}
+
+export interface RadarIPGeocodeCallback {
+  status: string;
+  address?: RadarAddress;
+}
+
+export interface RadarTrackingOptionsForegroundServiceOptions {
+  text?: string;
+  title?: string;
+  updatesOnly: boolean;
+  activity?: string;
+  importance?: number;
+  id?: number;
+  channelName?: string;
+  iconString?: string;
+  iconColor?: string;
+}
+
+export interface RadarRouteCallback {
+  status: string;
+  routes?: RadarRoutes;
+}
+
+export interface RadarLogConversionCallback {
+  status: string;
+  event: RadarEvent;
+}
+
+export interface RadarRouteMatrix {
+  status: string;
+  matrix?: object;
+}
+
+export interface RadarSearchPlacesOptions {
+  near?: Location;
+  radius: number;
+  chains?: string[];
+  chainMetadata?: object;
+  categories?: string[];
+  groups?: string[];
+  limit: number;
+}
+
+export interface Location {
+  latitude: number;
+  longitude: number;
+  accuracy?: number;
+  speed?: number;
+  altitude?: number;
+  course?: number;
+  verticalAccuracy?: number;
+  speedAccuracy?: number;
+  courseAccuracy?: number;
+}
+
+export interface RadarUser {
+  _id: string;
+  userId?: string;
+  deviceId?: string;
+  description?: string;
+  metadata?: object;
+  location?: RadarCoordinate;
+  geofences?: RadarGeofence[];
+  place?: RadarPlace;
+  beacons?: RadarBeacon[];
+  stopped?: boolean;
+  foreground?: boolean;
+  country?: RadarRegion;
+  state?: RadarRegion;
+  dma?: RadarRegion;
+  postalCode?: RadarRegion;
+  nearbyPlaceChains?: RadarPlace[];
+  segments?: RadarSegment[];
+  topChains?: RadarPlace[];
+  source?: LocationSource;
+  trip?: RadarTrip;
+  debug?: boolean;
+  fraud?: RadarFraud;
+}
+export interface RadarAutocompleteOptions {
+  query: string;
+  near?: Location;
+  layers?: string[];
+  limit: number;
+  country?: string;
+  expandUnits?: boolean;
+}
+
+export interface RadarCoordinate {
+  type: string;
+  coordinates: [number, number];
+}
+
+export type LocationSource =
+  | "FOREGROUND_LOCATION"
+  | "BACKGROUND_LOCATION"
+  | "MANUAL_LOCATION"
+  | "VISIT_ARRIVAL"
+  | "VISIT_DEPARTURE"
+  | "GEOFENCE_ENTER"
+  | "GEOFENCE_EXIT"
+  | "MOCK_LOCATION"
+  | "BEACON_ENTER"
+  | "BEACON_EXIT"
+  | "UNKNOWN";
+
+export interface RadarTrip {
+  _id: string;
+  externalId: string;
+  metadata?: object;
+  destinationGeofenceTag?: string;
+  destinationGeofenceExternalId?: string;
+  mode?: string;
+  eta?: RadarTripEta;
+  status: string;
+  scheduledArrivalAt?: Date;
+}
+
+export interface RadarSegment {
+  description: string;
+  externalId: string;
+}
+
+export interface RadarContext {
+  geofences?: RadarGeofence[];
+  place?: RadarPlace;
+  country?: RadarRegion;
+  state?: RadarRegion;
+  dma?: RadarRegion;
+  postalCode?: RadarRegion;
+}
+
+export interface RadarEvent {
+  _id: string;
+  live: boolean;
+  type: RadarEventType;
+  geofence?: RadarGeofence;
+  place?: RadarPlace;
+  region?: RadarRegion;
+  confidence: RadarEventConfidence;
+  duration?: number;
+  beacon?: RadarBeacon;
+  trip?: RadarTrip;
+  alternatePlaces?: RadarPlace[];
+  location?: RadarCoordinate;
+  metadata?: object;
+}
+
+export enum RadarEventConfidence {
+  none = 0,
+  low = 1,
+  medium = 2,
+  high = 3,
+}
+
+export type RadarEventType =
+  | "unknown"
+  | "user.entered_geofence"
+  | "user.entered_beacon"
+  | "user.dwelled_in_geofence"
+  | "user.entered_place"
+  | "user.entered_region_country"
+  | "user.entered_region_dma"
+  | "user.entered_region_state"
+  | "user.entered_region_postal_code"
+  | "user.exited_geofence"
+  | "user.exited_beacon"
+  | "user.exited_place"
+  | "user.exited_region_country"
+  | "user.exited_region_dma"
+  | "user.exited_region_state"
+  | "user.exited_region_postal_code"
+  | "user.nearby_place_chain"
+  | "user.started_trip"
+  | "user.updated_trip"
+  | "user.approaching_trip_destination"
+  | "user.arrived_at_trip_destination"
+  | "user.stopped_trip";
+
+export type RadarTrackingOptionsDesiredAccuracy =
+  | "high"
+  | "medium"
+  | "low"
+  | "none";
+
+export enum RadarEventVerification {
+  accept = 1,
+  unverify = 0,
+  reject = -1,
+}
+
+export type RadarBeaconType = "eddystone" | "ibeacon";
+
+export interface RadarGeofence {
+  _id: string;
+  description: string;
+  tag?: string;
+  externalId?: string;
+  metadata?: object;
+  type?: string;
+  geometryRadius?: number;
+  geometryCenter?: RadarCoordinate;
+  coordinates?: number[][];
+
+}
+
+export interface RadarBeacon {
+  _id: string;
+  metadata?: object;
+  type: RadarBeaconType;
+  uuid?: string;
+  instance?: string;
+  major?: string;
+  minor?: string;
+  geometry?: RadarCoordinate;
+  rss?: number;
+}
+
+export interface RadarPlace {
+  _id: string;
+  name: string;
+  categories: string[];
+  chain?: RadarChain;
+}
+
+export interface RadarChain {
+  name: string;
+  slug: string;
+  externalId?: string;
+  metadata?: object;
+}
+
+export interface RadarRegion {
+  _id: string;
+  type: string;
+  code: string;
+  name: string;
+  allowed?: boolean;
+  flag?:string;
+}
+
+export interface RadarLocationPermissionsCallback {
+  status: string;
+}
+
+export interface RadarAddress {
+  latitude: number;
+  longitude: number;
+  placeLabel?: string;
+  addressLabel?: string;
+  formattedAddress?: string;
+  country?: string;
+  countryCode?: string;
+  countryFlag?: string;
+  state?: string;
+  stateCode?: string;
+  postalCode?: string;
+  city?: string;
+  borough?: string;
+  county?: string;
+  neighborhood?: string;
+  number?: string;
+  distance?: number;
+  confidence?: string;
+  layer?: string;
+  plus4?: string;
+}
+
+export interface RadarAddressVerificationStatus {
+  status: string;
+}
+
+export interface RadarRoutes {
+  geodesic: RadarRoute;
+  foot?: RadarRoute;
+  bike?: RadarRoute;
+  car?: RadarRoute;
+}
+
+export interface RadarRoute {
+  distance?: RadarRouteDistance;
+  duration?: RadarRouteDuration;
+}
+
+export interface RadarRouteDistance {
+  value: number;
+  text: string;
+}
+
+export interface RadarNotificationOptions {
+  iconString?: string;
+  iconColor?: string;
+  foregroundServiceIconString?: string;
+  foregroundServiceIconColor?: string;
+  eventIconString?: string;
+  eventIconColor?: string;
+}
+
+export interface RadarRouteDuration {
+  value: number;
+  text: string;
+}
+
+export interface RadarTripEta {
+  distance?: number;
+  duration?: number;
+}
+
+export interface RadarFraud {
+  passed: boolean;
+  bypassed: boolean;
+  verified: boolean;
+  proxy: boolean;
+  mocked: boolean;
+  compromised: boolean;
+  jumped: boolean;
+}
+
+export interface RadarMockTrackingOptions {
+  origin: Location;
+  destination: Location;
+  mode: RadarRouteMode;
+  steps: number;
+  interval: number;
+}
+
+export type RadarTrackingOptionsReplay = "all" | "stops" | "none";
+
+export type RadarTrackingOptionsSync = "none" | "stopsAndExits" | "all";
+
+export interface RadarTrackingOptions {
+  desiredStoppedUpdateInterval: number;
+  fastestStoppedUpdateInterval: number;
+  desiredMovingUpdateInterval: number;
+  fastestMovingUpdateInterval: number;
+  desiredSyncInterval: number;
+  desiredAccuracy: RadarTrackingOptionsDesiredAccuracy;
+  stopDuration: number;
+  stopDistance: number;
+  startTrackingAfter?: Date;
+  stopTrackingAfter?: Date;
+  replay: RadarTrackingOptionsReplay;
+  sync: RadarTrackingOptionsSync;
+  showBlueBar: boolean;
+  useStoppedGeofence: boolean;
+  stoppedGeofenceRadius: number;
+  useMovingGeofence: boolean;
+  movingGeofenceRadius: number;
+  syncGeofences: boolean;
+  syncGeofencesLimit: number;
+  foregroundServiceEnabled: boolean;
+  beacons: boolean;
+}
+
+export interface RadarLogConversionOptions {
+  name: string;
+  revenue?: number;
+  metadata?: object;
+}
+
+export type RadarRouteMode = "foot" | "bike" | "car";
+
+export interface RadarTrackingStatus {
+  isTracking: string;
+}
+
+export interface RadarTrackingOptionsForegroundService {
+  text?: string;
+  title?: string;
+  icon?: number;
+  updatesOnly?: boolean;
+  activity?: string;
+  importance?: number;
+  id?: number;
+  channelName?: string;
+}
+
+export interface RadarTripOptions {
+  externalId: string;
+  metadata?: object;
+  destinationGeofenceTag?: string;
+  destinationGeofenceExternalId?: string;
+  mode?: RadarRouteMode;
+  scheduledArrivalAt?: Date;
+  approachingThreshold?: number;
+}
+
+export type RadarTripStatus =
+  | "unknown"
+  | "started"
+  | "approaching"
+  | "arrived"
+  | "expired"
+  | "completed"
+  | "canceled";