@openeld/openeld 0.1.0

package/proto/services/normalization/service.proto

@@ -0,0 +1,62 @@
+syntax = "proto3";
+
+package openeld.services.normalization.v1;
+
+import "logistics/asset.proto";
+import "logistics/asset_location.proto";
+import "logistics/carrier.proto";
+import "logistics/data_consent.proto";
+import "logistics/driver.proto";
+import "logistics/dvir.proto";
+import "logistics/gps_location.proto";
+import "logistics/hos_daily_summary.proto";
+import "logistics/hos_event.proto";
+import "logistics/ifta_trip.proto";
+import "logistics/safety_event.proto";
+import "logistics/vehicle.proto";
+import "logistics/vehicle_assignment.proto";
+import "providers/eld/geotab/contracts.proto";
+import "providers/eld/keeptruckin/contracts.proto";
+import "providers/eld/motive/contracts.proto";
+import "providers/eld/samsara/contracts.proto";
+import "providers/telematics/fleet_complete/contracts.proto";
+import "providers/telematics/fourkites/contracts.proto";
+import "providers/telematics/project44/contracts.proto";
+import "providers/telematics/verizon_connect/contracts.proto";
+
+// * Accepts provider-native payloads for normalization into canonical messages.
+message NormalizeProviderPayloadRequest {
+  optional string tenant_id = 1;
+  oneof provider_payload {
+    openeld.providers.eld.samsara.v1.SamsaraPayload samsara = 10;
+    openeld.providers.eld.motive.v1.MotivePayload motive = 11;
+    openeld.providers.eld.geotab.v1.GeotabPayload geotab = 12;
+    openeld.providers.eld.keeptruckin.v1.KeeptruckinPayload keeptruckin = 13;
+    openeld.providers.telematics.project44.v1.Project44Payload project44 = 14;
+    openeld.providers.telematics.fourkites.v1.FourKitesPayload four_kites = 15;
+    openeld.providers.telematics.verizon_connect.v1.VerizonConnectPayload verizon_connect = 16;
+    openeld.providers.telematics.fleet_complete.v1.FleetCompletePayload fleet_complete = 17;
+  }
+}
+
+// * Returns the normalized logistics entities derived from a provider payload.
+message NormalizeProviderPayloadResponse {
+  repeated openeld.logistics.v1.Carrier carriers = 1;
+  repeated openeld.logistics.v1.Driver drivers = 2;
+  repeated openeld.logistics.v1.Vehicle vehicles = 3;
+  repeated openeld.logistics.v1.VehicleAssignment vehicle_assignments = 4;
+  repeated openeld.logistics.v1.HosEvent hos_events = 5;
+  repeated openeld.logistics.v1.HosDailySummary hos_daily_summaries = 6;
+  repeated openeld.logistics.v1.GpsLocation gps_locations = 7;
+  repeated openeld.logistics.v1.Dvir dvirs = 8;
+  repeated openeld.logistics.v1.SafetyEvent safety_events = 9;
+  repeated openeld.logistics.v1.IftaTrip ifta_trips = 10;
+  repeated openeld.logistics.v1.Asset assets = 11;
+  repeated openeld.logistics.v1.AssetLocation asset_locations = 12;
+  repeated openeld.logistics.v1.DataConsent data_consents = 13;
+  repeated string warnings = 14;
+}
+
+service NormalizationService {
+  rpc NormalizeProviderPayload(NormalizeProviderPayloadRequest) returns (NormalizeProviderPayloadResponse);
+}

package/proto/services/query/service.proto

@@ -0,0 +1,238 @@
+syntax = "proto3";
+
+package openeld.services.query.v1;
+
+import "common/metadata/source.proto";
+import "logistics/asset.proto";
+import "logistics/asset_location.proto";
+import "logistics/carrier.proto";
+import "logistics/data_consent.proto";
+import "logistics/driver.proto";
+import "logistics/dvir.proto";
+import "logistics/gps_location.proto";
+import "logistics/hos_daily_summary.proto";
+import "logistics/hos_event.proto";
+import "logistics/ifta_trip.proto";
+import "logistics/safety_event.proto";
+import "logistics/vehicle.proto";
+import "logistics/vehicle_assignment.proto";
+import "google/protobuf/timestamp.proto";
+
+message CursorPageRequest {
+  optional uint32 page_size = 1;
+  optional string cursor = 2;
+}
+
+message CursorPageResponse {
+  optional string next_cursor = 1;
+  bool has_more = 2;
+}
+
+message EntityScope {
+  optional string tenant_id = 1;
+  optional string carrier_id = 2;
+  optional openeld.common.metadata.v1.SourceProvider provider = 3;
+  optional string provider_account_id = 4;
+}
+
+message TimeRangeFilter {
+  optional google.protobuf.Timestamp start_time = 1;
+  optional google.protobuf.Timestamp end_time = 2;
+}
+
+message LatestViewOptions {
+  bool latest_only = 1;
+}
+
+message GetCarrierRequest {
+  string carrier_id = 1;
+  optional EntityScope scope = 2;
+}
+
+message GetCarrierResponse {
+  optional openeld.logistics.v1.Carrier carrier = 1;
+}
+
+message GetDataConsentRequest {
+  string consent_id = 1;
+  optional EntityScope scope = 2;
+}
+
+message GetDataConsentResponse {
+  optional openeld.logistics.v1.DataConsent data_consent = 1;
+}
+
+message ListDataConsentsRequest {
+  optional EntityScope scope = 1;
+  optional string platform_id = 2;
+  optional CursorPageRequest page = 3;
+}
+
+message ListDataConsentsResponse {
+  repeated openeld.logistics.v1.DataConsent data_consents = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListDriversRequest {
+  optional EntityScope scope = 1;
+  optional CursorPageRequest page = 2;
+}
+
+message ListDriversResponse {
+  repeated openeld.logistics.v1.Driver drivers = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListVehiclesRequest {
+  optional EntityScope scope = 1;
+  optional CursorPageRequest page = 2;
+}
+
+message ListVehiclesResponse {
+  repeated openeld.logistics.v1.Vehicle vehicles = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListVehicleAssignmentsRequest {
+  optional string driver_id = 1;
+  optional string vehicle_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional CursorPageRequest page = 5;
+}
+
+message ListVehicleAssignmentsResponse {
+  repeated openeld.logistics.v1.VehicleAssignment vehicle_assignments = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListHosEventsRequest {
+  optional string driver_id = 1;
+  optional string vehicle_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional LatestViewOptions view = 5;
+  optional CursorPageRequest page = 6;
+}
+
+message ListHosEventsResponse {
+  repeated openeld.logistics.v1.HosEvent hos_events = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListHosDailySummariesRequest {
+  optional string driver_id = 1;
+  optional EntityScope scope = 2;
+  optional TimeRangeFilter time_range = 3;
+  optional CursorPageRequest page = 4;
+}
+
+message ListHosDailySummariesResponse {
+  repeated openeld.logistics.v1.HosDailySummary hos_daily_summaries = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListGpsLocationsRequest {
+  optional string vehicle_id = 1;
+  optional string driver_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional LatestViewOptions view = 5;
+  optional CursorPageRequest page = 6;
+}
+
+message ListGpsLocationsResponse {
+  repeated openeld.logistics.v1.GpsLocation gps_locations = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListSafetyEventsRequest {
+  optional string vehicle_id = 1;
+  optional string driver_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional CursorPageRequest page = 5;
+}
+
+message ListSafetyEventsResponse {
+  repeated openeld.logistics.v1.SafetyEvent safety_events = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListIftaTripsRequest {
+  optional string vehicle_id = 1;
+  optional string driver_id = 2;
+  optional string jurisdiction = 3;
+  optional EntityScope scope = 4;
+  optional TimeRangeFilter time_range = 5;
+  optional CursorPageRequest page = 6;
+}
+
+message ListIftaTripsResponse {
+  repeated openeld.logistics.v1.IftaTrip ifta_trips = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message GetAssetRequest {
+  string asset_id = 1;
+  optional EntityScope scope = 2;
+}
+
+message GetAssetResponse {
+  optional openeld.logistics.v1.Asset asset = 1;
+}
+
+message ListAssetsRequest {
+  optional EntityScope scope = 1;
+  optional CursorPageRequest page = 2;
+}
+
+message ListAssetsResponse {
+  repeated openeld.logistics.v1.Asset assets = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListAssetLocationsRequest {
+  optional string asset_id = 1;
+  optional string linked_vehicle_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional LatestViewOptions view = 5;
+  optional CursorPageRequest page = 6;
+}
+
+message ListAssetLocationsResponse {
+  repeated openeld.logistics.v1.AssetLocation asset_locations = 1;
+  optional CursorPageResponse page = 2;
+}
+
+message ListDvirsRequest {
+  optional string vehicle_id = 1;
+  optional string driver_id = 2;
+  optional EntityScope scope = 3;
+  optional TimeRangeFilter time_range = 4;
+  optional CursorPageRequest page = 5;
+}
+
+message ListDvirsResponse {
+  repeated openeld.logistics.v1.Dvir dvirs = 1;
+  optional CursorPageResponse page = 2;
+}
+
+service QueryService {
+  rpc GetCarrier(GetCarrierRequest) returns (GetCarrierResponse);
+  rpc GetDataConsent(GetDataConsentRequest) returns (GetDataConsentResponse);
+  rpc ListDataConsents(ListDataConsentsRequest) returns (ListDataConsentsResponse);
+  rpc ListDrivers(ListDriversRequest) returns (ListDriversResponse);
+  rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse);
+  rpc ListVehicleAssignments(ListVehicleAssignmentsRequest) returns (ListVehicleAssignmentsResponse);
+  rpc ListHosEvents(ListHosEventsRequest) returns (ListHosEventsResponse);
+  rpc ListHosDailySummaries(ListHosDailySummariesRequest) returns (ListHosDailySummariesResponse);
+  rpc ListGpsLocations(ListGpsLocationsRequest) returns (ListGpsLocationsResponse);
+  rpc ListSafetyEvents(ListSafetyEventsRequest) returns (ListSafetyEventsResponse);
+  rpc ListIftaTrips(ListIftaTripsRequest) returns (ListIftaTripsResponse);
+  rpc GetAsset(GetAssetRequest) returns (GetAssetResponse);
+  rpc ListAssets(ListAssetsRequest) returns (ListAssetsResponse);
+  rpc ListAssetLocations(ListAssetLocationsRequest) returns (ListAssetLocationsResponse);
+  rpc ListDvirs(ListDvirsRequest) returns (ListDvirsResponse);
+}

package/proto/services/sync/service.proto

@@ -0,0 +1,89 @@
+syntax = "proto3";
+
+package openeld.services.sync.v1;
+
+import "common/metadata/source.proto";
+import "google/protobuf/timestamp.proto";
+
+// * Represents the resource family being synchronized.
+enum SyncResourceType {
+  SYNC_RESOURCE_TYPE_UNSPECIFIED = 0;
+  SYNC_RESOURCE_TYPE_DRIVERS = 1;
+  SYNC_RESOURCE_TYPE_VEHICLES = 2;
+  SYNC_RESOURCE_TYPE_ASSIGNMENTS = 3;
+  SYNC_RESOURCE_TYPE_HOS_EVENTS = 4;
+  SYNC_RESOURCE_TYPE_HOS_CLOCKS = 5;
+  SYNC_RESOURCE_TYPE_GPS_LOCATIONS = 6;
+  SYNC_RESOURCE_TYPE_DVIRS = 7;
+  SYNC_RESOURCE_TYPE_SAFETY_EVENTS = 8;
+  SYNC_RESOURCE_TYPE_IFTA_TRIPS = 9;
+  SYNC_RESOURCE_TYPE_ASSETS = 10;
+  SYNC_RESOURCE_TYPE_ASSET_LOCATIONS = 11;
+}
+
+// * Represents the checkpoint style used by a provider resource.
+enum CheckpointKind {
+  CHECKPOINT_KIND_UNSPECIFIED = 0;
+  CHECKPOINT_KIND_CURSOR = 1;
+  CHECKPOINT_KIND_PAGE_TOKEN = 2;
+  CHECKPOINT_KIND_VERSION_TOKEN = 3;
+  CHECKPOINT_KIND_TIME_WINDOW = 4;
+  CHECKPOINT_KIND_COMPOSITE = 5;
+}
+
+// * Defines the sync boundary for a provider account and resource.
+message SyncResourceScope {
+  string tenant_id = 1;
+  optional string carrier_id = 2;
+  optional string provider_account_id = 3;
+  SyncResourceType resource_type = 4;
+}
+
+// * Stores checkpoint values for a provider resource.
+message SyncCheckpoint {
+  CheckpointKind kind = 1;
+  optional string cursor = 2;
+  optional string page_token = 3;
+  optional string version_token = 4;
+  optional google.protobuf.Timestamp window_start = 5;
+  optional google.protobuf.Timestamp window_end = 6;
+  optional google.protobuf.Timestamp last_synced_at = 7;
+}
+
+// * Captures health and retry state for a provider sync process.
+message SyncHealth {
+  optional google.protobuf.Timestamp last_attempt_at = 1;
+  optional google.protobuf.Timestamp last_success_at = 2;
+  uint32 consecutive_failures = 3;
+  optional string last_error = 4;
+}
+
+// * Requests the stored sync checkpoint for a provider and resource boundary.
+message GetSyncCheckpointRequest {
+  openeld.common.metadata.v1.SourceProvider provider = 1;
+  SyncResourceScope scope = 2;
+}
+
+// * Returns the checkpoint used to resume provider polling.
+message GetSyncCheckpointResponse {
+  optional SyncCheckpoint checkpoint = 1;
+  optional SyncHealth health = 2;
+}
+
+// * Updates the stored sync checkpoint after a provider sync attempt.
+message UpdateSyncCheckpointRequest {
+  openeld.common.metadata.v1.SourceProvider provider = 1;
+  SyncResourceScope scope = 2;
+  SyncCheckpoint checkpoint = 3;
+  optional SyncHealth health = 4;
+}
+
+// * Acknowledges that a sync checkpoint update was accepted.
+message UpdateSyncCheckpointResponse {
+  bool acknowledged = 1;
+}
+
+service SyncService {
+  rpc GetSyncCheckpoint(GetSyncCheckpointRequest) returns (GetSyncCheckpointResponse);
+  rpc UpdateSyncCheckpoint(UpdateSyncCheckpointRequest) returns (UpdateSyncCheckpointResponse);
+}

package/proto/v1/openeld.proto

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package openeld.v1;
+
+import public "common/metadata/audit.proto";
+import public "common/metadata/source.proto";
+import public "common/primitives/ids.proto";
+import public "common/primitives/location.proto";
+import public "common/primitives/time.proto";
+import public "common/units/measurements.proto";
+import public "logistics/asset.proto";
+import public "logistics/asset_location.proto";
+import public "logistics/carrier.proto";
+import public "logistics/data_consent.proto";
+import public "logistics/driver.proto";
+import public "logistics/dvir.proto";
+import public "logistics/enums.proto";
+import public "logistics/gps_location.proto";
+import public "logistics/hos_daily_summary.proto";
+import public "logistics/hos_event.proto";
+import public "logistics/ifta_trip.proto";
+import public "logistics/safety_event.proto";
+import public "logistics/vehicle.proto";
+import public "logistics/vehicle_assignment.proto";
+import public "providers/eld/geotab/contracts.proto";
+import public "providers/eld/keeptruckin/contracts.proto";
+import public "providers/eld/motive/contracts.proto";
+import public "providers/eld/samsara/contracts.proto";
+import public "providers/eld/shared/common.proto";
+import public "providers/telematics/fleet_complete/contracts.proto";
+import public "providers/telematics/fourkites/contracts.proto";
+import public "providers/telematics/project44/contracts.proto";
+import public "providers/telematics/shared/common.proto";
+import public "providers/telematics/verizon_connect/contracts.proto";
+import public "services/ingestion/service.proto";
+import public "services/normalization/service.proto";
+import public "services/query/service.proto";
+import public "services/sync/service.proto";
+