Rich Text Editor events

schemas/Composer.json

@@ -20,8 +20,21 @@
     "startsThread": {
       "description": "Whether this message begins a new thread or not.",
       "type": "boolean"
+    },
+    "editor": {
+      "description": "Whether this message was composed in legacy editor, the new the rich text editor or the new plain text editor",
+      "type": "string",
+      "enum": [
+        "Legacy",
+        "RteFormatting",
+        "RtePlain"
+      ]
+    },
+    "isMarkdownEnabled": {
+      "description": "Whether markdown is supported in the editor. This value is not applicable (always false) if editor is RteFormatting.",
+      "type": "boolean"
     }
   },
-  "required": ["eventName", "isEditing", "isReply", "inThread"],
+  "required": ["eventName", "isEditing", "isReply", "inThread", "editor", "isMarkdownEnabled"],
   "additionalProperties": false
 }

schemas/FormattedMessage.json

@@ -0,0 +1,37 @@
+{
+    "type": "object",
+    "description": "Triggered when the user formats the message content within the composer.",
+    "properties": {
+      "eventName": {
+        "enum": ["FormattedMessage"]
+      },
+      "editor": {
+        "description": "Whether this message was composed in legacy editor, the new the rich text editor or the new plain text editor",
+        "type": "string",
+        "enum": [
+          "Legacy",
+          "RteFormatting",
+          "RtePlain"
+        ]
+      },
+      "formatAction": {
+        "description": "The format action taken.",
+        "type": "string",
+        "oneOf": [
+          {"const": "Bold", "description": "Bold" },
+          {"const": "Italic", "description": "Italic" },
+          {"const": "Underline", "description": "Underline" },
+          {"const": "Strikethrough", "description": "Strikethrough" },
+          {"const": "UnorderedList", "description": "Unordered list" },
+          {"const": "OrderedList", "description": "Ordered list" },
+          {"const": "Quote", "description": "Quote" },
+          {"const": "InlineCode", "description": "Inline code" },
+          {"const": "CodeBlock", "description": "Code block" },
+          {"const": "Link", "description": "Link" }
+        ]
+      }
+    },
+    "required": ["eventName", "formatAction", "editor"],
+    "additionalProperties": false
+  }
+

schemas/Mention.json

@@ -0,0 +1,29 @@
+{
+    "type": "object",
+    "description": "Triggered when the user mentions another user or room using the @ or # symbols respectively.",
+    "properties": {
+      "eventName": {
+        "enum": ["Mention"]
+      },
+      "targetType": {
+        "description": "The type of object targeted by the mention.",
+        "type": "string",
+        "enum": [
+          "User",
+          "Room"
+        ]
+      },
+      "editor": {
+        "description": "Whether this message was composed in legacy editor, the new the rich text editor or the new plain text editor",
+        "type": "string",
+        "enum": [
+          "Legacy",
+          "RteFormatting",
+          "RtePlain"
+        ]
+      }
+    },
+    "required": ["targetType", "eventName", "editor"],
+    "additionalProperties": false
+  }
+

schemas/SlashCommand.json

@@ -12,8 +12,17 @@
         "Part",
         "Invite"
       ]
+    },
+    "editor": {
+      "description": "Whether this message was composed in legacy editor, the new the rich text editor or the new plain text editor",
+      "type": "string",
+      "enum": [
+        "Legacy",
+        "RteFormatting",
+        "RtePlain"
+      ]
     }
   },
-  "required": ["command", "eventName"],
+  "required": ["command", "eventName", "editor"],
   "additionalProperties": false
 }

types/kotlin/Composer.kt

@@ -4,6 +4,12 @@ package quicktype
  * Triggered when the user sends a message via the composer.
  */
 data class Composer (
+    /**
+     * Whether this message was composed in legacy editor, the new the rich text editor or the
+     * new plain text editor
+     */
+    val editor: Editor,
+
     val eventName: EventName,
 
     /**
@@ -16,6 +22,12 @@ data class Composer (
      */
     val isEditing: Boolean,
 
+    /**
+     * Whether markdown is supported in the editor. This value is not applicable (always false)
+     * if editor is RteFormatting.
+     */
+    val isMarkdownEnabled: Boolean,
+
     /**
      * Whether the user's composer interaction was a reply to a previously sent event.
      */
@@ -27,6 +39,16 @@ data class Composer (
     val startsThread: Boolean? = null
 )
 
+/**
+ * Whether this message was composed in legacy editor, the new the rich text editor or the
+ * new plain text editor
+ */
+enum class Editor {
+    Legacy,
+    RTEFormatting,
+    RTEPlain
+}
+
 enum class EventName {
     Composer
 }

types/kotlin/FormattedMessage.kt

@@ -0,0 +1,33 @@
+package quicktype
+
+/**
+ * Triggered when the user formats the message content within the composer.
+ */
+data class FormattedMessage (
+    /**
+     * Whether this message was composed in legacy editor, the new the rich text editor or the
+     * new plain text editor
+     */
+    val editor: Editor,
+
+    val eventName: EventName,
+
+    /**
+     * The format action taken.
+     */
+    val formatAction: String
+)
+
+/**
+ * Whether this message was composed in legacy editor, the new the rich text editor or the
+ * new plain text editor
+ */
+enum class Editor {
+    Legacy,
+    RTEFormatting,
+    RTEPlain
+}
+
+enum class EventName {
+    FormattedMessage
+}

types/kotlin/Mention.kt

@@ -0,0 +1,42 @@
+package quicktype
+
+/**
+ * Triggered when the user mentions another user or room using the @ or # symbols
+ * respectively.
+ */
+data class Mention (
+    /**
+     * Whether this message was composed in legacy editor, the new the rich text editor or the
+     * new plain text editor
+     */
+    val editor: Editor,
+
+    val eventName: EventName,
+
+    /**
+     * The type of object targeted by the mention.
+     */
+    val targetType: TargetType
+)
+
+/**
+ * Whether this message was composed in legacy editor, the new the rich text editor or the
+ * new plain text editor
+ */
+enum class Editor {
+    Legacy,
+    RTEFormatting,
+    RTEPlain
+}
+
+enum class EventName {
+    Mention
+}
+
+/**
+ * The type of object targeted by the mention.
+ */
+enum class TargetType {
+    Room,
+    User
+}

types/kotlin/SlashCommand.kt

@@ -9,6 +9,12 @@ data class SlashCommand (
      */
     val command: Command,
 
+    /**
+     * Whether this message was composed in legacy editor, the new the rich text editor or the
+     * new plain text editor
+     */
+    val editor: Editor,
+
     val eventName: EventName
 )
 
@@ -20,6 +26,16 @@ enum class Command {
     Part
 }
 
+/**
+ * Whether this message was composed in legacy editor, the new the rich text editor or the
+ * new plain text editor
+ */
+enum class Editor {
+    Legacy,
+    RTEFormatting,
+    RTEPlain
+}
+
 enum class EventName {
     SlashCommand
 }

types/kotlin2/Composer.kt

@@ -25,6 +25,11 @@ import im.vector.app.features.analytics.itf.VectorAnalyticsEvent
  * Triggered when the user sends a message via the composer.
  */
 data class Composer(
+        /**
+         * Whether this message was composed in legacy editor, the new the rich
+         * text editor or the new plain text editor
+         */
+        val editor: Editor,
         /**
          * Whether the user was using the composer inside of a thread.
          */
@@ -34,6 +39,11 @@ data class Composer(
          * event.
          */
         val isEditing: Boolean,
+        /**
+         * Whether markdown is supported in the editor. This value is not
+         * applicable (always false) if editor is RteFormatting.
+         */
+        val isMarkdownEnabled: Boolean,
         /**
          * Whether the user's composer interaction was a reply to a previously
          * sent event.
@@ -45,12 +55,20 @@ data class Composer(
         val startsThread: Boolean? = null,
 ) : VectorAnalyticsEvent {
 
+    enum class Editor {
+        Legacy,
+        RteFormatting,
+        RtePlain,
+    }
+
     override fun getName() = "Composer"
 
     override fun getProperties(): Map<String, Any>? {
         return mutableMapOf<String, Any>().apply {
+            put("editor", editor.name)
             put("inThread", inThread)
             put("isEditing", isEditing)
+            put("isMarkdownEnabled", isMarkdownEnabled)
             put("isReply", isReply)
             startsThread?.let { put("startsThread", it) }
         }.takeIf { it.isNotEmpty() }