@sentiance-react-native/user-context 6.1.2 → 6.2.0-rc.2

package/android/src/main/java/com/sentiance/react/bridge/usercontext/SentianceUserContextConverter.java

@@ -5,13 +5,12 @@ import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
 import com.sentiance.sdk.ondevice.api.Attribute;
 import com.sentiance.sdk.ondevice.api.GeoLocation;
+import com.sentiance.sdk.ondevice.api.Waypoint;
 import com.sentiance.sdk.ondevice.api.event.Event;
 import com.sentiance.sdk.ondevice.api.event.StationaryEvent;
 import com.sentiance.sdk.ondevice.api.event.TransportEvent;
 import com.sentiance.sdk.ondevice.api.segment.Segment;
 import com.sentiance.sdk.ondevice.api.venue.Venue;
-import com.sentiance.sdk.ondevice.api.venue.VenueCandidate;
-import com.sentiance.sdk.ondevice.api.venue.Visit;
 import com.sentiance.sdk.usercontext.api.RequestUserContextError;
 import com.sentiance.sdk.usercontext.api.RequestUserContextFailureReason;
 import com.sentiance.sdk.usercontext.api.UserContext;
@@ -19,16 +18,15 @@ import com.sentiance.sdk.usercontext.api.UserContextUpdateCriteria;
 import com.sentiance.sdk.util.DateTime;
 
 import java.util.List;
-import java.util.Map;
 
 public class SentianceUserContextConverter {
 
   public static WritableMap convertGeoLocation(GeoLocation location) {
     WritableMap locationMap = Arguments.createMap();
 
-    locationMap.putString("latitude", String.valueOf(location.getLatitude()));
-    locationMap.putString("longitude", String.valueOf(location.getLongitude()));
-    locationMap.putString("accuracy", String.valueOf(location.getAccuracyInMeters()));
+    locationMap.putDouble("latitude", location.getLatitude());
+    locationMap.putDouble("longitude", location.getLongitude());
+    locationMap.putInt("accuracy", location.getAccuracyInMeters());
 
     return locationMap;
   }
@@ -41,12 +39,12 @@ public class SentianceUserContextConverter {
     map.putString("type", segment.getType().name());
     map.putInt("id", segment.getType().getUniqueId());
     map.putString("startTime", segment.getStartTime().toString());
-    map.putString("startTimeEpoch", "" + segment.getStartTime().getEpochTime() / 1000);
+    map.putDouble("startTimeEpoch", segment.getStartTime().getEpochTime());
 
     DateTime endTime = segment.getEndTime();
     if (endTime != null) {
       map.putString("endTime", endTime.toString());
-      map.putString("endTimeEpoch", "" + segment.getEndTime().getEpochTime() / 1000);
+      map.putDouble("endTimeEpoch", segment.getEndTime().getEpochTime());
     }
 
     WritableArray attributes = Arguments.createArray();
@@ -65,8 +63,10 @@ public class SentianceUserContextConverter {
     WritableMap map = Arguments.createMap();
 
     map.putString("startTime", event.getStartTime().toString());
+    map.putDouble("startTimeEpoch", event.getStartTime().getEpochTime());
     if (event.getEndTime() != null) {
       map.putString("endTime", event.getEndTime().toString());
+      map.putDouble("endTimeEpoch", event.getEndTime().getEpochTime());
 
       Long durationInSeconds = event.getDurationInSeconds();
       if (durationInSeconds != null) {
@@ -125,6 +125,9 @@ public class SentianceUserContextConverter {
       userContextMap.putMap("work", convertVenue(userContext.getWork()));
     }
 
+    // Semantic time
+    userContextMap.putString("semanticTime", userContext.getSemanticTime().name());
+
     return userContextMap;
   }
 
@@ -149,62 +152,47 @@ public class SentianceUserContextConverter {
     if (event.getLocation() != null) {
       map.putMap("location", convertGeoLocation(event.getLocation()));
     }
-
-    map.putString("venueSignificance", event.getVenueSignificance().toString());
-
-    WritableArray venueCandidatesArray = Arguments.createArray();
-    for (VenueCandidate candidate : event.getVenueCandidates()) {
-      venueCandidatesArray.pushMap(convertVenueCandidate(candidate));
-    }
-
-    map.putArray("venueCandidates", venueCandidatesArray);
-  }
-
-  private static WritableMap convertVenueCandidate(VenueCandidate candidate) {
-    WritableMap venueCandidateMap = Arguments.createMap();
-    venueCandidateMap.putMap("venue", convertVenue(candidate.getVenue()));
-    venueCandidateMap.putDouble("likelihood", candidate.getLikelihood());
-
-    WritableArray visitsArray = Arguments.createArray();
-    for (Visit visit : candidate.getVisits()) {
-      visitsArray.pushMap(convertVisit(visit));
-    }
-    venueCandidateMap.putArray("visits", visitsArray);
-    return venueCandidateMap;
+    map.putMap("venue", convertVenue(event.getVenue()));
   }
 
   private static WritableMap convertVenue(Venue venue) {
     WritableMap venueMap = Arguments.createMap();
 
-    if (venue.getName() != null) {
-      venueMap.putString("name", venue.getName());
-    }
-
-    venueMap.putMap("location", convertGeoLocation(venue.getLocation()));
-
-    WritableMap venueLabelsMap = Arguments.createMap();
-    for (Map.Entry<String, String> entry : venue.getLabels().entrySet()) {
-      venueLabelsMap.putString(entry.getKey(), entry.getValue());
+    if (venue.getLocation() != null) {
+      venueMap.putMap("location", convertGeoLocation(venue.getLocation()));
     }
-    venueMap.putMap("venueLabels", venueLabelsMap);
+    venueMap.putString("significance", venue.getSignificance().name());
+    venueMap.putString("type", venue.getType().name());
 
     return venueMap;
   }
 
-  private static WritableMap convertVisit(Visit visit) {
-    WritableMap visitMap = Arguments.createMap();
-    visitMap.putString("startTime", visit.getStartTime().toString());
-    visitMap.putString("startTimeEpoch", "" + visit.getStartTime().getEpochTime());
+  private static void addTransportEventInfo(WritableMap map, TransportEvent event) {
+    map.putString("transportMode", event.getTransportMode().toString());
+    map.putArray("waypoints", convertWaypointList(event.getWaypoints()));
+
+    if (event.getDistanceInMeters() != null) {
+      map.putInt("distance", event.getDistanceInMeters());
+    }
+  }
 
-    visitMap.putString("endTime", visit.getEndTime().toString());
-    visitMap.putString("endTimeEpoch", "" + visit.getEndTime().getEpochTime());
+  public static WritableMap convertWaypoint(Waypoint waypoint) {
+    WritableMap waypointMap = Arguments.createMap();
 
-    visitMap.putInt("durationInSeconds", (int) visit.getDurationInSeconds());
+    waypointMap.putDouble("latitude", waypoint.getLatitude());
+    waypointMap.putDouble("longitude", waypoint.getLongitude());
+    waypointMap.putInt("accuracy", waypoint.getAccuracyInMeters());
+    waypointMap.putDouble("timestamp", waypoint.getTimestamp());
 
-    return visitMap;
+    return waypointMap;
   }
 
-  private static void addTransportEventInfo(WritableMap map, TransportEvent event) {
-    map.putString("transportMode", event.getTransportMode().toString());
+  private static WritableArray convertWaypointList(List<Waypoint> waypointList) {
+    WritableArray array = Arguments.createArray();
+    for (Waypoint waypoint : waypointList) {
+      array.pushMap(convertWaypoint(waypoint));
+    }
+    return array;
   }
+
 }

package/lib/index.d.ts

@@ -108,9 +108,9 @@ declare module "@sentiance-react-native/user-context" {
     | "WORK_TRAVELLER"
     | "WORKAHOLIC";
 
-  type TransportMode =
+  export type TransportMode =
     | "UNKNOWN"
-    | "BYCICLE"
+    | "BICYCLE"
     | "WALKING"
     | "RUNNING"
     | "TRAM"
@@ -119,45 +119,118 @@ declare module "@sentiance-react-native/user-context" {
     | "BUS"
     | "MOTORCYCLE";
 
+  export type VenueSignificance =
+    | "UNKNOWN"
+    | "HOME"
+    | "WORK"
+    | "POINT_OF_INTEREST"
+
+  /**
+   * The list of venue types that are currently supported by the venue-type mapping model:
+   *
+   * <ul>
+   *   <li><b>DRINK_DAY</b> - Cafes, coffee bars, tea rooms, etc</li>
+   *   <li><b>DRINK_EVENING</b> - Bars, pubs and in general places where one goes for drinks in evenings.</li>
+   *   <li><b>EDUCATION_INDEPENDENT</b> - Educational institutions visited by the user on his own for their own studies. High schools, universities, colleges, etc.</li>
+   *   <li><b>EDUCATION_PARENTS</b> - Schools and kindergartens visited by parents.</li>
+   *   <li><b>HEALTH</b> - Hospitals, clinics, emergency rooms.</li>
+   *   <li><b>INDUSTRIAL</b> - Buildings tagged as “industrial” on OSM, built for some manufacturing process.</li>
+   *   <li><b>LEISURE_BEACH</b> - Beaches, resorts and swimming areas.</li>
+   *   <li><b>LEISURE_DAY</b> - Bowling, billiards and other entertainment places.</li>
+   *   <li><b>LEISURE_EVENING</b> - Cinemas, theatres and music halls.</li>
+   *   <li><b>LEISURE_MUSEUM</b> - Museums.</li>
+   *   <li><b>LEISURE_NATURE</b> - Forests, lakes, national parks, etc.</li>
+   *   <li><b>LEISURE_PARK</b> - City parks, gardens, zoos.</li>
+   *   <li><b>OFFICE</b> - Office buildings. For example, of private lawyers, notaries or company representatives.</li>
+   *   <li><b>RELIGION</b> - Churches, mosques and other religion related buildings.</li>
+   *   <li><b>RESIDENTIAL</b> - Apartment blocks, houses.</li>
+   *   <li><b>RESTO_MID</b> - Food courts, restaurants, snack bars.</li>
+   *   <li><b>RESTO_SHORT</b> - Ice cream, fast food, donut stores.</li>
+   *   <li><b>SHOP_LONG</b> - Supermarkets, malls, wholesales, shopping centres.</li>
+   *   <li><b>SHOP_SHORT</b> - Small grocery stores, butchers, bakers.</li>
+   *   <li><b>SPORT</b> - Gyms, sport centres. Venues visited to exercise.</li>
+   *   <li><b>SPORT_ATTEND</b> - Stadiums. Venues visited to attend a sport event.</li>
+   *   <li><b>TRAVEL_BUS</b> - Bus stops.</li>
+   *   <li><b>TRAVEL_CONFERENCE</b> - Conference, convention, exhibition centres.</li>
+   *   <li><b>TRAVEL_FILL</b> - Gas stations.</li>
+   *   <li><b>TRAVEL_HOTEL</b> - Hotels, motels, guest rooms, etc.</li>
+   *   <li><b>TRAVEL_LONG</b> - Airports</li>
+   *   <li><b>TRAVEL_SHORT</b> - Public transport stations, railway stations.</li>
+   * </ul>
+   */
+  export type VenueType =
+    | "UNKNOWN"
+    | "DRINK_DAY"
+    | "DRINK_EVENING"
+    | "EDUCATION_INDEPENDENT"
+    | "EDUCATION_PARENTS"
+    | "HEALTH"
+    | "INDUSTRIAL"
+    | "LEISURE_BEACH"
+    | "LEISURE_DAY"
+    | "LEISURE_EVENING"
+    | "LEISURE_MUSEUM"
+    | "LEISURE_NATURE"
+    | "LEISURE_PARK"
+    | "OFFICE"
+    | "RELIGION"
+    | "RESIDENTIAL"
+    | "RESTO_MID"
+    | "RESTO_SHORT"
+    | "SHOP_LONG"
+    | "SHOP_SHORT"
+    | "SPORT"
+    | "SPORT_ATTEND"
+    | "TRAVEL_BUS"
+    | "TRAVEL_CONFERENCE"
+    | "TRAVEL_FILL"
+    | "TRAVEL_HOTEL"
+    | "TRAVEL_LONG"
+    | "TRAVEL_SHORT"
+
+  export type SemanticTime =
+    | "UNKNOWN"
+    | "MORNING"
+    | "LATE_MORNING"
+    | "LUNCH"
+    | "AFTERNOON"
+    | "EARLY_EVENING"
+    | "EVENING"
+    | "NIGHT";
+
   export interface Event {
     startTime: string;
+    startTimeEpoch: number; // in milliseconds
     endTime: string | null;
+    endTimeEpoch: number | null; // in milliseconds
     durationInSeconds: number | null;
     type: string;
     // stationary event fields
-    location: EventLocation | null;
-    venueSignificance: string | null;
-    venueCandidates: VenueCandidate[] | null;
+    location: GeoLocation | null;
+    venue: Venue | null;
     // transport event fields
     transportMode: TransportMode | null;
+    waypoints: Waypoint[];
+    distance?: number; // in meters
   }
 
-  export interface EventLocation {
-    latitude: string;
-    longitude: string;
-    accuracy: string;
+  export interface GeoLocation {
+    latitude: number;
+    longitude: number;
+    accuracy: number;
   }
 
-  export interface VenueCandidate {
-    venue: Venue;
-    likelihood: number;
-    visits: Visit[];
+  export interface Waypoint {
+    latitude: number;
+    longitude: number;
+    accuracy: number;   // in meters
+    timestamp: number;  // UTC epoch time in milliseconds
   }
 
   export interface Venue {
-    name: string | null;
-    location: EventLocation | null;
-    venueLabels: VenueLabels;
-  }
-
-  export interface VenueLabels {
-    [label: string]: string;
-  }
-
-  export interface Visit {
-    startTime: string;
-    endTime: string;
-    durationInSeconds: number;
+    location: GeoLocation | null;
+    significance: VenueSignificance;
+    type: VenueType;
   }
 
   export interface Segment {
@@ -166,7 +239,9 @@ declare module "@sentiance-react-native/user-context" {
     type: SegmentType;
     id: number;
     startTime: string;
+    startTimeEpoch: number; // in milliseconds
     endTime: string | null;
+    endTimeEpoch: number | null; // in milliseconds
     attributes: SegmentAttribute[];
   }
 
@@ -178,9 +253,10 @@ declare module "@sentiance-react-native/user-context" {
   export interface UserContext {
     events: Event[];
     activeSegments: Segment[];
-    lastKnownLocation: EventLocation | null;
+    lastKnownLocation: GeoLocation | null;
     home: Venue | null;
     work: Venue | null;
+    semanticTime: SemanticTime;
   }
 
   export interface SentianceUserContext {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentiance-react-native/user-context",
-  "version": "6.1.2",
+  "version": "6.2.0-rc.2",
   "description": "React Native Sentiance - This module provides an easy API to add user context awareness into your apps.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -14,7 +14,7 @@
     "sentiance"
   ],
   "peerDependencies": {
-    "@sentiance-react-native/core": "6.1.2"
+    "@sentiance-react-native/core": "6.2.0-rc.2"
   },
   "author": "",
   "license": "",