SDK Deprecation message Authentication (#42)

* add deprecation warning field

* sdk deprecation structure

* lint

Author: Gawor270

doc/docs.md

@@ -80,8 +80,10 @@
     - [PeerMessage.Authenticated](#fishjam-PeerMessage-Authenticated)
     - [PeerMessage.MediaEvent](#fishjam-PeerMessage-MediaEvent)
     - [PeerMessage.RTCStatsReport](#fishjam-PeerMessage-RTCStatsReport)
+    - [PeerMessage.SdkDeprecation](#fishjam-PeerMessage-SdkDeprecation)
 
     - [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType)
+    - [PeerMessage.SdkDeprecation.Status](#fishjam-PeerMessage-SdkDeprecation-Status)
 
 - [fishjam/server_notifications.proto](#fishjam_server_notifications-proto)
     - [ServerMessage](#fishjam-ServerMessage)
@@ -1190,6 +1192,7 @@ Response sent by FJ, confirming successful authentication
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | room_type | [PeerMessage.RoomType](#fishjam-PeerMessage-RoomType) |  |  |
+| sdk_deprecation | [PeerMessage.SdkDeprecation](#fishjam-PeerMessage-SdkDeprecation) |  |  |
 
 
 
@@ -1226,6 +1229,22 @@ https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport#the_statistic_ty
 
 
 
+
+<a name="fishjam-PeerMessage-SdkDeprecation"></a>
+
+### PeerMessage.SdkDeprecation
+Deprecation status for SDK version
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| status | [PeerMessage.SdkDeprecation.Status](#fishjam-PeerMessage-SdkDeprecation-Status) |  |  |
+| message | [string](#string) |  |  |
+
+
+
+
+
 
 
 
@@ -1242,6 +1261,20 @@ Defines types of rooms peers may connect to
 | ROOM_TYPE_LIVESTREAM | 3 |  |
 
 
+
+<a name="fishjam-PeerMessage-SdkDeprecation-Status"></a>
+
+### PeerMessage.SdkDeprecation.Status
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| STATUS_UNSPECIFIED | 0 |  |
+| STATUS_UP_TO_DATE | 1 |  |
+| STATUS_DEPRECATED | 2 |  |
+| STATUS_UNSUPPORTED | 3 |  |
+
+
 
 
 

fishjam/peer_notifications.proto

@@ -15,9 +15,23 @@ message PeerMessage {
     ROOM_TYPE_LIVESTREAM = 3;
   }
 
+  // Deprecation status for SDK version
+  message SdkDeprecation {
+    enum Status {
+      STATUS_UNSPECIFIED = 0;
+      STATUS_UP_TO_DATE = 1;
+      STATUS_DEPRECATED = 2;
+      STATUS_UNSUPPORTED = 3;
+    }
+
+    Status status = 1;
+    string message = 2;
+  }
+
   // Response sent by FJ, confirming successful authentication
   message Authenticated {
     RoomType room_type = 1;
+    SdkDeprecation sdk_deprecation = 2;
   }
 
   // Request sent by peer, to authenticate to FJ server

fishjam_protos/lib/fishjam/peer_notifications.pb.ex

@@ -13,6 +13,33 @@ defmodule Fishjam.PeerMessage.RoomType do
   field :ROOM_TYPE_LIVESTREAM, 3
 end
 
+defmodule Fishjam.PeerMessage.SdkDeprecation.Status do
+  @moduledoc false
+
+  use Protobuf,
+    enum: true,
+    full_name: "fishjam.PeerMessage.SdkDeprecation.Status",
+    protoc_gen_elixir_version: "0.16.0",
+    syntax: :proto3
+
+  field :STATUS_UNSPECIFIED, 0
+  field :STATUS_UP_TO_DATE, 1
+  field :STATUS_DEPRECATED, 2
+  field :STATUS_UNSUPPORTED, 3
+end
+
+defmodule Fishjam.PeerMessage.SdkDeprecation do
+  @moduledoc false
+
+  use Protobuf,
+    full_name: "fishjam.PeerMessage.SdkDeprecation",
+    protoc_gen_elixir_version: "0.16.0",
+    syntax: :proto3
+
+  field :status, 1, type: Fishjam.PeerMessage.SdkDeprecation.Status, enum: true
+  field :message, 2, type: :string
+end
+
 defmodule Fishjam.PeerMessage.Authenticated do
   @moduledoc false
 
@@ -22,6 +49,7 @@ defmodule Fishjam.PeerMessage.Authenticated do
     syntax: :proto3
 
   field :room_type, 1, type: Fishjam.PeerMessage.RoomType, json_name: "roomType", enum: true
+  field :sdk_deprecation, 2, type: Fishjam.PeerMessage.SdkDeprecation, json_name: "sdkDeprecation"
 end
 
 defmodule Fishjam.PeerMessage.AuthRequest do