From 826190a0f842a61c205fb206ef11d8939d8023d0 Mon Sep 17 00:00:00 2001
From: Jack Greenlee <greenljk@mail.uc.edu>
Date: Wed, 3 Apr 2024 01:29:03 -0400
Subject: [PATCH] flesh out more types

Filled in more trip object types, and specifically some literal types that define unprocessed trips. (like "source" will always be 'unprocessed').

CompTripLocations changed from `number[]` for coordinates to geojson's `Position`, since that is more descriptive. Renamed CompTripLocations to CompositeTripLocation (this type represents only 1 location).

Used the CompositeTripLocation type in timelineHelper.
in locations2GeojsonTrajectory, the return type needed `properties` for it to be considered a Geojson `Feature`.

formattedSectionProperties types as the return type of the function
---
 www/js/diary/timelineHelper.ts | 12 ++++++++----
 www/js/types/diaryTypes.ts     | 26 +++++++++++++-------------
 2 files changed, 21 insertions(+), 17 deletions(-)

diff --git a/www/js/diary/timelineHelper.ts b/www/js/diary/timelineHelper.ts
index 006cc0788..6c87cd0b9 100644
--- a/www/js/diary/timelineHelper.ts
+++ b/www/js/diary/timelineHelper.ts
@@ -15,6 +15,7 @@ import {
   CompositeTrip,
   UnprocessedTrip,
   SectionData,
+  CompositeTripLocation,
 } from '../types/diaryTypes';
 import { getLabelInputDetails, getLabelInputs } from '../survey/multilabel/confirmHelper';
 import { LabelOptions } from '../types/labelTypes';
@@ -216,10 +217,10 @@ const location2GeojsonPoint = (locationPoint: Point, featureType: string): Featu
  */
 function locations2GeojsonTrajectory(
   trip: CompositeTrip,
-  locationList: Array<Point>,
+  locationList: CompositeTripLocation[],
   trajectoryColor?: string,
-) {
-  let sectionsPoints;
+): Feature[] {
+  let sectionsPoints: CompositeTripLocation[][];
   if (!trip.sections) {
     // this is a unimodal trip so we put all the locations in one section
     sectionsPoints = [locationList];
@@ -243,6 +244,9 @@ function locations2GeojsonTrajectory(
           color for the sensed mode of this section, and fall back to dark grey */
         color: trajectoryColor || getBaseModeByKey(section?.sensed_mode_str)?.color || '#333',
       },
+      properties: {
+        feature_type: 'section_trajectory',
+      },
     };
   });
 }
@@ -341,7 +345,7 @@ function points2UnprocessedTrip(locationPoints: Array<BEMData<FilteredLocation>>
     } as Point,
     start_local_dt: dateTime2localdate(startTime, startPoint.metadata.time_zone),
     start_ts: startPoint.data.ts,
-  };
+  } as const;
 
   // section: baseProps + some properties that are unique to the section
   const singleSection: SectionData = {
diff --git a/www/js/types/diaryTypes.ts b/www/js/types/diaryTypes.ts
index 12102477d..8b8de469c 100644
--- a/www/js/types/diaryTypes.ts
+++ b/www/js/types/diaryTypes.ts
@@ -5,7 +5,7 @@
 import { BaseModeKey, MotionTypeKey } from '../diary/diaryHelper';
 import { MultilabelKey } from './labelTypes';
 import { BEMData, LocalDt } from './serverData';
-import { FeatureCollection, Feature, Geometry, Point } from 'geojson';
+import { FeatureCollection, Feature, Geometry, Point, Position } from 'geojson';
 
 type ObjectId = { $oid: string };
 
@@ -45,9 +45,9 @@ export type TripTransition = {
   ts: number;
 };
 
-type CompTripLocations = {
+export type CompositeTripLocation = {
   loc: {
-    coordinates: number[]; // e.g. [1, 2.3]
+    coordinates: Position; // [lon, lat]
   };
   speed: number;
   ts: number;
@@ -56,7 +56,7 @@ type CompTripLocations = {
 //  Used for return type of readUnprocessedTrips
 export type UnprocessedTrip = {
   _id: ObjectId;
-  additions: UserInputEntry[];
+  additions: []; // unprocessed trips won't have any matched processed inputs, so this is always empty
   confidence_threshold: number;
   distance: number;
   duration: number;
@@ -64,19 +64,19 @@ export type UnprocessedTrip = {
   end_loc: Point;
   end_local_dt: LocalDt;
   end_ts: number;
-  expectation: any; // TODO "{to_label: boolean}"
-  inferred_labels: any[]; // TODO
-  key: string;
-  locations?: CompTripLocations[];
-  origin_key: string; // e.x., UNPROCESSED_trip
+  expectation: { to_label: true }; // unprocessed trips are always expected to be labeled
+  inferred_labels: []; // unprocessed trips won't have inferred labels
+  key: 'UNPROCESSED_trip';
+  locations?: CompositeTripLocation[];
+  origin_key: 'UNPROCESSED_trip';
   sections: SectionData[];
-  source: string;
+  source: 'unprocessed';
   start_fmt_time: string;
   start_local_dt: LocalDt;
   start_ts: number;
   start_loc: Point;
   starting_trip?: any;
-  user_input: UserInput;
+  user_input: {}; // unprocessed trips won't have any matched processed inputs, so this is always empty
 };
 
 /* These are the properties received from the server (basically matches Python code)
@@ -96,13 +96,13 @@ export type CompositeTrip = {
   end_local_dt: LocalDt;
   end_place: ObjectId;
   end_ts: number;
-  expectation: any; // TODO "{to_label: boolean}"
+  expectation: { to_label: boolean };
   expected_trip: ObjectId;
   inferred_labels: InferredLabels;
   inferred_section_summary: SectionSummary;
   inferred_trip: ObjectId;
   key: string;
-  locations: any[]; // TODO
+  locations: CompositeTripLocation[];
   origin_key: string;
   raw_trip: ObjectId;
   sections: SectionData[];