From 94a23b7ebc24a66869f715d2913c4913c32fddca Mon Sep 17 00:00:00 2001
From: Anastasios Andronidis <anastasios.andronidis@toolsforhumanity.com>
Date: Thu, 3 Oct 2024 20:24:05 +0200
Subject: [PATCH] Wrap types to prepare for the Any type

---
 proto/relay.proto                 |  1 -
 proto/self_serve/app/v1/app.proto | 10 +++++
 proto/self_serve/orb/v1/orb.proto | 64 +++++++++++++++++++++----------
 3 files changed, 54 insertions(+), 21 deletions(-)

diff --git a/proto/relay.proto b/proto/relay.proto
index 776fe79..e07786d 100644
--- a/proto/relay.proto
+++ b/proto/relay.proto
@@ -116,7 +116,6 @@ message RelayPayload {
     self_serve.orb.v1.AgeVerificationRequiredFromOperator age_verification_required_from_operator = 14;
     self_serve.app.v1.StartCapture start_capture = 15;
     self_serve.app.v1.RequestState request_state = 16;
-    self_serve.orb.v1.SelfServeStatus self_serve_status = 17;
     self_serve.orb.v1.NoState no_state = 18;
     self_serve.orb.v1.CaptureTriggerTimeout capture_trigger_timeout = 19;
 
diff --git a/proto/self_serve/app/v1/app.proto b/proto/self_serve/app/v1/app.proto
index e1124d9..db9f551 100644
--- a/proto/self_serve/app/v1/app.proto
+++ b/proto/self_serve/app/v1/app.proto
@@ -2,6 +2,16 @@ syntax = "proto3";
 
 package self_serve.app.v1;
 
+// Wrapper message for all messages that can be sent to and from the app. The reason we do this is to ensure static
+// typing in the clients while the server can still handle all messages through the Any type.
+message W {
+  oneof w {
+    StartCapture start_capture = 1;
+    RequestState request_state = 2;
+    AbortSignup abort_signup = 3;
+  }
+}
+
 message StartCapture {}
 message RequestState {}
 message AbortSignup {}
diff --git a/proto/self_serve/orb/v1/orb.proto b/proto/self_serve/orb/v1/orb.proto
index 6052026..04f0264 100644
--- a/proto/self_serve/orb/v1/orb.proto
+++ b/proto/self_serve/orb/v1/orb.proto
@@ -2,23 +2,47 @@ syntax = "proto3";
 
 package self_serve.orb.v1;
 
-message NoState {}
-message SelfServeStatus {
-  bool is_self_serve_enabled = 1;
+// Wrapper message for all messages that can be sent to and from the orb. The reason we do this is to ensure static
+// typing in the clients while the server can still handle all messages through the Any type.
+message W {
+  oneof w {
+    NoState no_state = 1;
+    AnnounceOrbId announce_orb_id = 2;
+    CaptureStarted capture_started = 3;
+    CaptureTriggerTimeout capture_trigger_timeout = 4;
+    CaptureEnded capture_ended = 5;
+    SignupEnded signup_ended = 6;
+    AgeVerificationRequiredFromOperator age_verification_required_from_operator = 7;
+  }
 }
+
+message NoState {}
 message AnnounceOrbId {
+  enum ModeType {
+    MODE_TYPE_UNSPECIFIED = 0;
+    MODE_TYPE_LEGACY = 1;
+    MODE_TYPE_SELF_SERVE = 2;
+  }
+
+  enum HardwareType {
+    HARDWARE_TYPE_UNSPECIFIED = 0;
+    HARDWARE_TYPE_PEARL = 1;
+    HARDWARE_TYPE_DIAMOND = 2;
+  }
+
   string orb_id = 1;
-  bool is_self_serve_enabled = 2;
+  ModeType mode_type = 2;
+  HardwareType hardware_type = 3;
 }
 message CaptureStarted {}
 message CaptureTriggerTimeout {}
 message CaptureEnded {
   enum FailureFeedbackType {
-    UNKNOWN = 0;
-    FACE_OCCLUSION_OR_POOR_LIGHTING = 1;
-    TOO_FAR = 2;
-    TOO_CLOSE = 3;
-    EYES_OCCLUSION = 4;
+    FAILURE_FEEDBACK_TYPE_UNSPECIFIED = 0;
+    FAILURE_FEEDBACK_TYPE_FACE_OCCLUSION_OR_POOR_LIGHTING = 1;
+    FAILURE_FEEDBACK_TYPE_TOO_FAR = 2;
+    FAILURE_FEEDBACK_TYPE_TOO_CLOSE = 3;
+    FAILURE_FEEDBACK_TYPE_EYES_OCCLUSION = 4;
   }
 
   bool success = 1;
@@ -26,17 +50,17 @@ message CaptureEnded {
 }
 message SignupEnded {
   enum FailureFeedbackType {
-    UNKNOWN = 0;
-    CONTACT_LENSES = 1;
-    EYE_GLASSES = 2;
-    MASK = 3;
-    FACE_OCCLUSION = 4;
-    MULTIPLE_FACES = 5;
-    EYES_OCCLUSION = 6;
-    HEAD_POSE = 7;
-    UNDERAGED = 8;
-    SERVER_ERROR = 9;
-    LOW_IMAGE_QUALITY = 10;
+    FAILURE_FEEDBACK_TYPE_UNSPECIFIED = 0;
+    FAILURE_FEEDBACK_TYPE_CONTACT_LENSES = 1;
+    FAILURE_FEEDBACK_TYPE_EYE_GLASSES = 2;
+    FAILURE_FEEDBACK_TYPE_MASK = 3;
+    FAILURE_FEEDBACK_TYPE_FACE_OCCLUSION = 4;
+    FAILURE_FEEDBACK_TYPE_MULTIPLE_FACES = 5;
+    FAILURE_FEEDBACK_TYPE_EYES_OCCLUSION = 6;
+    FAILURE_FEEDBACK_TYPE_HEAD_POSE = 7;
+    FAILURE_FEEDBACK_TYPE_UNDERAGED = 8;
+    FAILURE_FEEDBACK_TYPE_SERVER_ERROR = 9;
+    FAILURE_FEEDBACK_TYPE_LOW_IMAGE_QUALITY = 10;
   }
 
   bool success = 1;