messaging: define typing states

Author: Jeff Yanta

generated/go/messaging/v1/messaging_service.pb.go

@@ -6,7 +6,7 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
 import { Auth, ChatId, ClientPong, IntentId, QueryOptions, ServerPing, UserId } from "../../common/v1/common_pb";
-import { Content, Message as Message$1, MessageBatch, MessageId, MessageIdBatch, Pointer } from "./model_pb";
+import { Content, Message as Message$1, MessageBatch, MessageId, MessageIdBatch, Pointer, TypingState } from "./model_pb";
 
 /**
  * @generated from message flipchat.messaging.v1.StreamMessagesRequest
@@ -830,10 +830,17 @@ export class NotifyIsTypingRequest extends Message<NotifyIsTypingRequest> {
   chatId?: ChatId;
 
   /**
+   * Deprecated: Use typing_state instead
+   *
    * @generated from field: bool is_typing = 2;
    */
   isTyping = false;
 
+  /**
+   * @generated from field: flipchat.messaging.v1.TypingState typing_state = 4;
+   */
+  typingState = TypingState.STARTED_TYPING;
+
   /**
    * @generated from field: flipchat.common.v1.Auth auth = 3;
    */
@@ -849,6 +856,7 @@ export class NotifyIsTypingRequest extends Message<NotifyIsTypingRequest> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "chat_id", kind: "message", T: ChatId },
     { no: 2, name: "is_typing", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 4, name: "typing_state", kind: "enum", T: proto3.getEnumType(TypingState) },
     { no: 3, name: "auth", kind: "message", T: Auth },
   ]);
 

generated/go/messaging/v1/messaging_service.pb.validate.go

@@ -7,6 +7,38 @@ import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialM
 import { Message as Message$1, proto3, Timestamp } from "@bufbuild/protobuf";
 import { PaymentAmount, UserId } from "../../common/v1/common_pb";
 
+/**
+ * @generated from enum flipchat.messaging.v1.TypingState
+ */
+export enum TypingState {
+  /**
+   * @generated from enum value: STARTED_TYPING = 0;
+   */
+  STARTED_TYPING = 0,
+
+  /**
+   * @generated from enum value: STILL_TYPING = 1;
+   */
+  STILL_TYPING = 1,
+
+  /**
+   * @generated from enum value: STOPPED_TYPING = 2;
+   */
+  STOPPED_TYPING = 2,
+
+  /**
+   * @generated from enum value: TYPING_TIMED_OUT = 3;
+   */
+  TYPING_TIMED_OUT = 3,
+}
+// Retrieve enum metadata with: proto3.getEnumType(TypingState)
+proto3.util.setEnumType(TypingState, "flipchat.messaging.v1.TypingState", [
+  { no: 0, name: "STARTED_TYPING" },
+  { no: 1, name: "STILL_TYPING" },
+  { no: 2, name: "STOPPED_TYPING" },
+  { no: 3, name: "TYPING_TIMED_OUT" },
+]);
+
 /**
  * @generated from message flipchat.messaging.v1.MessageId
  */
@@ -294,13 +326,17 @@ export class IsTyping extends Message$1<IsTyping> {
   userId?: UserId;
 
   /**
-   * is_typing indicates whether or not the user is typing.
-   * If false, the user has explicitly stopped typing.
+   * Deprecated: Use typing_state instead
    *
    * @generated from field: bool is_typing = 2;
    */
   isTyping = false;
 
+  /**
+   * @generated from field: flipchat.messaging.v1.TypingState typing_state = 3;
+   */
+  typingState = TypingState.STARTED_TYPING;
+
   constructor(data?: PartialMessage<IsTyping>) {
     super();
     proto3.util.initPartial(data, this);
@@ -311,6 +347,7 @@ export class IsTyping extends Message$1<IsTyping> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "user_id", kind: "message", T: UserId },
     { no: 2, name: "is_typing", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 3, name: "typing_state", kind: "enum", T: proto3.getEnumType(TypingState) },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): IsTyping {

generated/go/messaging/v1/model.pb.go

@@ -187,8 +187,11 @@ message AdvancePointerResponse {
 message NotifyIsTypingRequest {
     common.v1.ChatId chat_id = 1 [(validate.rules).message.required = true];
 
+    // Deprecated: Use typing_state instead
     bool is_typing = 2;
 
+    TypingState typing_state = 4;
+
 	common.v1.Auth auth = 3 [(validate.rules).message.required = true];
 }
 

generated/go/messaging/v1/model.pb.validate.go

@@ -81,9 +81,17 @@ message Pointer {
 message IsTyping {
     common.v1.UserId user_id = 1 [(validate.rules).message.required = true];
 
-    // is_typing indicates whether or not the user is typing.
-    // If false, the user has explicitly stopped typing.
+    // Deprecated: Use typing_state instead
     bool is_typing = 2;
+
+    TypingState typing_state = 3;
+}
+
+enum TypingState {
+    STARTED_TYPING   = 0;
+    STILL_TYPING     = 1;
+    STOPPED_TYPING   = 2;
+    TYPING_TIMED_OUT = 3;
 }
 
 // Content for a chat message