react-native-radar 3.10.0-beta.2 → 3.10.0-beta.4

package/src/@types/types.ts

@@ -1,9 +1,50 @@
+export type RadarMetadata = Record<string, string | number | boolean>;
+
 export interface RadarTrackOnceOptions {
   location?: Location;
   desiredAccuracy?: RadarTrackingOptionsDesiredAccuracy;
   beacons?: boolean;
 }
 
+/**
+ * Options for tracking the user's location.
+ * @see {@link https://radar.com/documentation/sdk/tracking}
+ */
+export interface RadarTrackingOptions {
+  desiredStoppedUpdateInterval: number;
+  fastestStoppedUpdateInterval?: number;
+  desiredMovingUpdateInterval: number;
+  fastestMovingUpdateInterval?: number;
+  desiredSyncInterval: number;
+  desiredAccuracy: String;
+  stopDuration: number;
+  stopDistance: number;
+  sync: String;
+  replay: String;
+  useStoppedGeofence: boolean;
+  showBlueBar?: boolean;
+  startTrackingAfter?: number;
+  stopTrackingAfter?: number;
+  syncLocations?: String;
+  stoppedGeofenceRadius: number;
+  useMovingGeofence: boolean;
+  movingGeofenceRadius: number;
+  syncGeofences: boolean;
+  useVisits?: boolean;
+  useSignificantLocationChanges?: boolean;
+  beacons: boolean;
+  syncGeofencesLimit?: number;
+  foregroundServiceEnabled?: boolean;
+}
+
+export interface RadarMockTrackingOptions {
+  origin: Location;
+  destination: Location;
+  mode: RadarRouteMode;
+  steps: number;
+  interval: number;
+}
+
 export interface RadarGetDistanceOptions {
   origin?: Location;
   destination?: Location;
@@ -28,10 +69,70 @@ export interface RadarStartTripOptions {
   trackingOptions?: RadarTrackingOptions;
 }
 
-export interface RadarLocationCallback {
-  status: string;
-  location?: Location;
-  stopped: boolean;
+export interface RadarSearchGeofencesOptions {
+  near?: Location;
+  radius?: number;
+  metadata?: RadarMetadata;
+  tags?: string[];
+  limit?: number;
+}
+
+export interface RadarTrackingOptionsForegroundServiceOptions {
+  text?: string;
+  title?: string;
+  updatesOnly: boolean;
+  activity?: string;
+  importance?: number;
+  id?: number;
+  channelName?: string;
+  iconString?: string;
+  iconColor?: string;
+}
+
+export interface RadarSearchPlacesOptions {
+  near?: Location;
+  radius?: number;
+  chains?: string[];
+  chainMetadata?: RadarMetadata;
+  categories?: string[];
+  groups?: string[];
+  limit?: number;
+}
+
+export interface RadarAutocompleteOptions {
+  query: string;
+  near?: Location;
+  layers?: string[];
+  limit: number;
+  country?: string;
+  /** @deprecated this is always true, regardless of the value passed here */
+  expandUnits?: boolean;
+  mailable?: boolean;
+}
+
+export interface RadarNotificationOptions {
+  iconString?: string;
+  iconColor?: string;
+  foregroundServiceIconString?: string;
+  foregroundServiceIconColor?: string;
+  eventIconString?: string;
+  eventIconColor?: string;
+}
+
+export interface RadarLogConversionOptions {
+  name: string;
+  revenue?: number;
+  metadata?: RadarMetadata;
+}
+
+export interface RadarTripOptions {
+  externalId: string;
+  metadata?: RadarMetadata;
+  destinationGeofenceTag?: string;
+  destinationGeofenceExternalId?: string;
+  mode?: RadarRouteMode;
+  scheduledArrivalAt?: Date;
+  approachingThreshold?: number;
 }
 
 export interface RadarTrackCallback {
@@ -41,20 +142,10 @@ export interface RadarTrackCallback {
   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 {
+export interface RadarLocationCallback {
   status: string;
-  token?: String;
+  location?: Location;
+  stopped: boolean;
 }
 
 export interface RadarTripCallback {
@@ -81,23 +172,21 @@ export interface RadarSearchGeofencesCallback {
   geofences?: RadarGeofence[];
 }
 
-export interface RadarSearchGeofencesOptions {
-  near?: Location;
-  radius?: number;
-  metadata?: object;
-  tags?: string[];
-  limit?: number;
+export interface RadarAddressCallback {
+  status: string;
+  addresses?: RadarAddress[];
 }
 
-export interface RadarGeocodeCallback {
+export interface RadarIPGeocodeCallback {
   status: string;
-  addresses?: RadarAddress[];
+  address?: RadarAddress;
+  proxy?: boolean;
 }
 
 export interface RadarValidateAddressCallback {
   status: string;
   address?: RadarAddress;
-  verificationStatus?: RadarAddressVerificationStatus;
+  verificationStatus?: RadarVerificationStatus;
 }
 
 export interface RadarIPGeocodeCallback {
@@ -106,19 +195,6 @@ export interface RadarIPGeocodeCallback {
   proxy?: boolean;
 }
 
-
-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;
@@ -126,22 +202,71 @@ export interface RadarRouteCallback {
 
 export interface RadarLogConversionCallback {
   status: string;
-  event: RadarEvent;
+  event?: RadarEvent;
 }
 
-export interface RadarRouteMatrix {
+export interface RadarTrackTokenCallback {
   status: string;
-  matrix?: object[];
+  token?: String;
 }
 
-export interface RadarSearchPlacesOptions {
-  near?: Location;
-  radius?: number;
-  chains?: string[];
-  chainMetadata?: object;
-  categories?: string[];
-  groups?: string[];
-  limit?: number;
+export interface RadarEventUpdate {
+  user?: RadarUser;
+  events: RadarEvent[];
+}
+
+export interface RadarEventUpdateCallback {
+  (args: RadarEventUpdate): void;
+}
+
+export interface RadarLocationUpdate {
+  location: Location;
+  user: RadarUser;
+}
+
+export interface RadarLocationUpdateCallback {
+  (args: RadarLocationUpdate): void;
+}
+
+export interface RadarClientLocationUpdate {
+  location: Location;
+  stopped: boolean;
+  source: string;
+}
+
+export interface RadarClientLocationUpdateCallback {
+  (args: RadarClientLocationUpdate): void;
+}
+
+export interface RadarErrorCallback {
+  (status: string): void;
+}
+
+export interface RadarLogUpdateCallback {
+  (status: string): void;
+}
+
+export type RadarListenerCallback =
+  | RadarEventUpdateCallback
+  | RadarLocationUpdateCallback
+  | RadarClientLocationUpdateCallback
+  | RadarErrorCallback
+  | RadarLogUpdateCallback;
+
+export type RadarPermissionsStatus =
+  | "GRANTED_FOREGROUND"
+  | "GRANTED_FOREGROUND"
+  | "DENIED"
+  | "NOT_DETERMINED"
+  | "UNKNOWN";
+
+export type Event = "clientLocation" | "location" | "error" | "events" | "log";
+
+export type RadarLogLevel = "info" | "debug" | "warning" | "error" | "none";
+
+export interface RadarRouteMatrix {
+  status: string;
+  matrix?: RadarRoute[][];
 }
 
 export interface Location {
@@ -162,7 +287,7 @@ export interface RadarUser {
   userId?: string;
   deviceId?: string;
   description?: string;
-  metadata?: object;
+  metadata?: RadarMetadata;
   location?: RadarCoordinate;
   geofences?: RadarGeofence[];
   place?: RadarPlace;
@@ -173,22 +298,14 @@ export interface RadarUser {
   state?: RadarRegion;
   dma?: RadarRegion;
   postalCode?: RadarRegion;
-  nearbyPlaceChains?: RadarPlace[];
+  nearbyPlaceChains?: RadarChain[];
   segments?: RadarSegment[];
-  topChains?: RadarPlace[];
+  topChains?: RadarChain[];
   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;
@@ -211,13 +328,14 @@ export type LocationSource =
 export interface RadarTrip {
   _id: string;
   externalId: string;
-  metadata?: object;
+  metadata?: RadarMetadata;
   destinationGeofenceTag?: string;
   destinationGeofenceExternalId?: string;
   mode?: string;
   eta?: RadarTripEta;
   status: string;
   scheduledArrivalAt?: Date;
+  destinationLocation: Location;
 }
 
 export interface RadarSegment {
@@ -247,7 +365,10 @@ export interface RadarEvent {
   trip?: RadarTrip;
   alternatePlaces?: RadarPlace[];
   location?: RadarCoordinate;
-  metadata?: object;
+  metadata?: RadarMetadata;
+  replayed?: boolean;
+  createdAt: string;
+  actualCreatedAt: string;
 }
 
 export enum RadarEventConfidence {
@@ -300,17 +421,17 @@ export interface RadarGeofence {
   description: string;
   tag?: string;
   externalId?: string;
-  metadata?: object;
-  type?: string;
+  metadata?: RadarMetadata;
+  type?: "Circle" | "Polygon";
   geometryRadius?: number;
   geometryCenter?: RadarCoordinate;
+  // only available for geofences of type "Polygon"
   coordinates?: number[][];
-
 }
 
 export interface RadarBeacon {
   _id: string;
-  metadata?: object;
+  metadata?: RadarMetadata;
   type: RadarBeaconType;
   uuid?: string;
   instance?: string;
@@ -325,13 +446,16 @@ export interface RadarPlace {
   name: string;
   categories: string[];
   chain?: RadarChain;
+  location: Location;
+  metadata?: RadarMetadata;
+  group?: string;
 }
 
 export interface RadarChain {
   name: string;
   slug: string;
   externalId?: string;
-  metadata?: object;
+  metadata?: RadarMetadata;
 }
 
 export interface RadarRegion {
@@ -340,55 +464,61 @@ export interface RadarRegion {
   code: string;
   name: string;
   allowed?: boolean;
-  flag?:string;
-}
-
-export interface RadarLocationPermissionsCallback {
-  status: string;
+  flag?: string;
 }
 
 export interface RadarAddress {
-  latitude: number;
-  longitude: number;
-  placeLabel?: string;
   addressLabel?: string;
-  formattedAddress?: string;
+  borough?: string;
+  city?: string;
+  confidence?: string;
   country?: string;
   countryCode?: string;
   countryFlag?: string;
-  state?: string;
-  stateCode?: string;
-  postalCode?: string;
-  city?: string;
-  borough?: string;
   county?: string;
+  distance?: number;
+  dma?: string;
+  dmaCode?: string;
+  formattedAddress?: string;
+  latitude: number;
+  layer?: string;
+  longitude: number;
+  metadata?: RadarMetadata;
   neighborhood?: string;
   number?: string;
+  placeLabel?: string;
+  plus4?: string;
+  postalCode?: string;
+  state?: string;
+  stateCode?: string;
   street?: string;
   unit?: string;
-  distance?: number;
-  confidence?: string;
-  layer?: string;
-  plus4?: string;
-  dmaCode?: string;
-  dma?: string;
-  metadata?: object;
 }
 
-export interface RadarAddressVerificationStatus {
-  status: string;
-}
+export type RadarVerificationStatus =
+  | "verified"
+  | "partially verified"
+  | "ambiguous"
+  | "unverified";
 
 export interface RadarRoutes {
   geodesic?: RadarRouteDistance;
   foot?: RadarRoute;
   bike?: RadarRoute;
   car?: RadarRoute;
+  truck?: RadarRoute;
+  motorbike?: RadarRoute;
+}
+
+export interface RadarRouteGeometry {
+  type: string;
+  coordinates: number[][];
 }
 
 export interface RadarRoute {
   distance?: RadarRouteDistance;
   duration?: RadarRouteDuration;
+  geometry?: RadarRouteGeometry;
 }
 
 export interface RadarRouteDistance {
@@ -396,15 +526,6 @@ export interface RadarRouteDistance {
   text: string;
 }
 
-export interface RadarNotificationOptions {
-  iconString?: string;
-  iconColor?: string;
-  foregroundServiceIconString?: string;
-  foregroundServiceIconColor?: string;
-  eventIconString?: string;
-  eventIconColor?: string;
-}
-
 export interface RadarRouteDuration {
   value: number;
   text: string;
@@ -425,57 +546,12 @@ export interface RadarFraud {
   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: String;
-  stopDuration: number;
-  stopDistance: number;
-  sync: String;
-  replay: String;
-  useStoppedGeofence: boolean;
-  showBlueBar?: boolean;
-  foregroundServiceEnabled?: boolean;
-  startTrackingAfter?: number | undefined;
-  stopTrackingAfter?: number | undefined;
-  syncLocations?: String;
-  stoppedGeofenceRadius: number;
-  useMovingGeofence: boolean;
-  movingGeofenceRadius: number;
-  syncGeofences: boolean;
-  useVisits?: boolean;
-  useSignificantLocationChanges?: boolean;
-  beacons: boolean;
-  syncGeofencesLimit?: number;
-}
-
-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;
@@ -487,16 +563,6 @@ export interface RadarTrackingOptionsForegroundService {
   channelName?: string;
 }
 
-export interface RadarTripOptions {
-  externalId: string;
-  metadata?: object;
-  destinationGeofenceTag?: string;
-  destinationGeofenceExternalId?: string;
-  mode?: RadarRouteMode;
-  scheduledArrivalAt?: Date;
-  approachingThreshold?: number;
-}
-
 export type RadarTripStatus =
   | "unknown"
   | "started"
@@ -505,43 +571,3 @@ export type RadarTripStatus =
   | "expired"
   | "completed"
   | "canceled";
-
-interface RadarEventUpdate {
-  user: RadarUser;
-  events: RadarEvent[];
-}
-
-interface RadarEventUpdateCallback {
-  (args: RadarEventUpdate): void;
-}
-
-
-
-interface RadarLocationUpdate{
-  location: Location;
-  user: RadarUser;
-}
-
-interface RadarLocationUpdateCallback{
-  (args: RadarLocationUpdate): void;
-}
-
-interface RadarClientLocationUpdate {
-  location: Location;
-  stopped: boolean;
-  source: string;
-}
-
-interface RadarClientLocationUpdateCallback{
-  (args: RadarClientLocationUpdate): void;
-}
-
-interface RadarErrorCallback{
-  (status: string): void;
-}
-
-interface RadarLogUpdateCallback{
-  (status: string): void;
-}
-
-export type RadarListenerCallback = RadarEventUpdateCallback | RadarLocationUpdateCallback | RadarClientLocationUpdateCallback | RadarErrorCallback | RadarLogUpdateCallback;

package/src/index.native.ts

@@ -5,7 +5,7 @@ import {
   Location,
   RadarAutocompleteOptions,
   RadarContextCallback,
-  RadarGeocodeCallback,
+  RadarAddressCallback,
   RadarGetDistanceOptions,
   RadarLocationCallback,
   RadarLogConversionCallback,
@@ -33,6 +33,8 @@ import {
   Event,
   RadarListenerCallback,
   RadarGetMatrixOptions,
+  RadarMetadata,
+  RadarIPGeocodeCallback,
 } from "./@types/types";
 
 if (
@@ -64,11 +66,12 @@ const setDescription = (description: string): void => {
 const getDescription = (): Promise<string> =>
   NativeModules.RNRadar.getDescription();
 
-const setMetadata = (metadata: object): void => {
+const setMetadata = (metadata: RadarMetadata): void => {
   NativeModules.RNRadar.setMetadata(metadata);
 };
 
-const getMetadata = (): Promise<object> => NativeModules.RNRadar.getMetadata();
+const getMetadata = (): Promise<RadarMetadata> =>
+  NativeModules.RNRadar.getMetadata();
 
 const setAnonymousTrackingEnabled = (enabled: boolean): void =>
   NativeModules.RNRadar.setAnonymousTrackingEnabled(enabled);
@@ -138,8 +141,7 @@ const setForegroundServiceOptions = (
 const setNotificationOptions = (options: RadarNotificationOptions): void =>
   NativeModules.RNRadar.setNotificationOptions(options);
 
-// Take a closer look?
-  const getTripOptions = (): Promise<RadarTripOptions> =>
+const getTripOptions = (): Promise<RadarTripOptions> =>
   NativeModules.RNRadar.getTripOptions();
 
 const startTrip = (
@@ -177,37 +179,36 @@ const searchGeofences = (
 
 const autocomplete = (
   options: RadarAutocompleteOptions
-): Promise<RadarGeocodeCallback> => NativeModules.RNRadar.autocomplete(options);
+): Promise<RadarAddressCallback> => NativeModules.RNRadar.autocomplete(options);
 
-const geocode = (address: string): Promise<RadarGeocodeCallback> =>
+const geocode = (address: string): Promise<RadarAddressCallback> =>
   NativeModules.RNRadar.geocode(address);
 
-const reverseGeocode = (location: Location): Promise<RadarGeocodeCallback> =>
+const reverseGeocode = (location: Location): Promise<RadarAddressCallback> =>
   NativeModules.RNRadar.reverseGeocode(location);
 
-const ipGeocode = (): Promise<RadarGeocodeCallback> =>
+const ipGeocode = (): Promise<RadarIPGeocodeCallback> =>
   NativeModules.RNRadar.ipGeocode();
 
 const getDistance = (
   options: RadarGetDistanceOptions
 ): Promise<RadarRouteCallback> => NativeModules.RNRadar.getDistance(options);
 
-const getMatrix = (
-  options: RadarGetMatrixOptions
-): Promise<RadarRouteMatrix> => NativeModules.RNRadar.getMatrix(options);
+const getMatrix = (options: RadarGetMatrixOptions): Promise<RadarRouteMatrix> =>
+  NativeModules.RNRadar.getMatrix(options);
 
 const logConversion = (
   options: RadarLogConversionOptions
 ): Promise<RadarLogConversionCallback> =>
   NativeModules.RNRadar.logConversion(options);
 
-const sendEvent = (name: string, metadata: object): void =>
+const sendEvent = (name: string, metadata: RadarMetadata): void =>
   NativeModules.RNRadar.sendEvent(name, metadata);
 
 const on = (event: Event, callback: RadarListenerCallback): void =>
   eventEmitter.addListener(event, callback);
 
-const off = (event: Event, callback: Function | undefined): void => {
+const off = (event: Event, callback?: Function | undefined): void => {
   if (callback) {
     // @ts-ignore
     eventEmitter.removeListener(event, callback);

package/src/index.ts

@@ -1,15 +1,9 @@
-//import { Platform } from "react-native";
 import { RadarNativeInterface } from "./@types/RadarNativeInterface";
 
-//type RadarInterface = Platform["OS"] extends "web" ? RadarNativeInterface : any;
-//type RadarInterface = RadarNativeInterface;
-
 let module: RadarNativeInterface;
-// if (Platform.OS === "web") {
-//   module = require("./index.web").default;
-// } else {
-  module = require("./index.native").default;
-//}
+
+module = require("./index.native").default;
+
 export default module;
 
 export { default as RadarRNWeb } from "./index.web";