api types: Define list of valid message flags

Author: gnprice

src/actionTypes.js

@@ -60,6 +60,7 @@ import {
   DISMISS_SERVER_COMPAT_NOTICE,
 } from './actionConstants';
 
+import type { UserMessageFlag } from './api/modelTypes';
 import type {
   CustomProfileFieldsEvent,
   MessageEvent,
@@ -413,7 +414,7 @@ type EventUpdateMessageFlagsAction = $ReadOnly<{|
   type: typeof EVENT_UPDATE_MESSAGE_FLAGS,
   all: boolean,
   allMessages: MessagesState,
-  flag: string,
+  flag: UserMessageFlag,
   messages: $ReadOnlyArray<number>,
   op: 'add' | 'remove',
   message_details?: Map<number, UpdateMessageFlagsMessageDetails>,

src/api/eventTypes.js

@@ -20,6 +20,7 @@ import type {
   PropagateMode,
   Stream,
   UserId,
+  UserMessageFlag,
   UserPresence,
   UserStatusUpdate,
 } from './modelTypes';
@@ -106,7 +107,7 @@ export type MessageEvent = $ReadOnly<{|
   message: Message,
 
   /** See the same-named property on `Message`. */
-  flags?: $ReadOnlyArray<string>,
+  flags?: $ReadOnlyArray<UserMessageFlag>,
 
   /**
    * When the message was sent by this client (with `queue_id` this queue),
@@ -335,7 +336,7 @@ export type UpdateMessageEvent = $ReadOnly<{|
   //   guarantee of that in the API nor, apparently, in the implementation.
   message_ids: $ReadOnlyArray<number>,
 
-  flags: $ReadOnlyArray<string>,
+  flags: $ReadOnlyArray<UserMessageFlag>,
 
   // TODO(server-5.0): Always present as of FL 114; make required.
   edit_timestamp?: number,

src/api/messages/messagesFlags.js

@@ -1,5 +1,6 @@
 /* @flow strict-local */
 import type { ApiResponseSuccess, Auth } from '../transportTypes';
+import type { UserMessageFlag } from '../modelTypes';
 import { apiPost } from '../apiFetch';
 
 export type ApiResponseMessagesFlags = {|
@@ -11,6 +12,6 @@ export default (
   auth: Auth,
   messages: $ReadOnlyArray<number>,
   op: string,
-  flag: string,
+  flag: UserMessageFlag,
 ): Promise<ApiResponseMessagesFlags> =>
   apiPost(auth, 'messages/flags', { messages: JSON.stringify(messages), flag, op });

src/api/modelTypes.js

@@ -749,6 +749,21 @@ export type Submessage = $ReadOnly<{|
   content: string,
 |}>;
 
+/**
+ * A flag that can be set on a message for a user.
+ *
+ * See:
+ *   https://zulip.com/api/update-message-flags#available-flags
+ */
+export type UserMessageFlag =
+  | 'read'
+  | 'starred'
+  | 'collapsed'
+  | 'mentioned'
+  | 'wildcard_mentioned'
+  | 'has_alert_word'
+  | 'historical';
+
 /**
  * Properties in common among the two different flavors of a
  * `Message`: `PmMessage` and `StreamMessage`.
@@ -845,7 +860,7 @@ type MessageBase = $ReadOnly<{|
    *  * Absent in the Redux `state.messages`; we move the information to a
    *    separate subtree `state.flags`.
    */
-  flags?: $ReadOnlyArray<string>,
+  flags?: $ReadOnlyArray<UserMessageFlag>,
 
   /** Our own flag; if true, really type `Outbox`. */
   isOutbox?: false,

src/chat/flagsReducer.js

@@ -13,6 +13,7 @@ import {
   ACCOUNT_SWITCH,
 } from '../actionConstants';
 import { deeperMerge } from '../utils/misc';
+import type { UserMessageFlag } from '../api/modelTypes';
 
 type ReadWriteFlagsState = $Rest<ReadWrite<$ObjMap<FlagsState, <V>(V) => ReadWrite<V>>>, { ... }>;
 type ReadWritePerFlagState = $Values<ReadWriteFlagsState>;
@@ -35,7 +36,7 @@ const initialState = {
 const addFlagsForMessages = (
   state: FlagsState,
   messages: $ReadOnlyArray<number>,
-  flags: $ReadOnlyArray<string>,
+  flags: $ReadOnlyArray<UserMessageFlag>,
 ): FlagsState => {
   if (messages.length === 0 || flags.length === 0) {
     return state;
@@ -117,7 +118,7 @@ const eventUpdateMessageFlags = (state, action) => {
       // know about. After all, we can't have any code intending to do
       // anything with them. Flow should be complaining here:
       //   https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/Flow.20spread.20bug/near/1318081
-      return { ...state, [action.flag]: {} };
+      return { ...state, [(action.flag: string)]: {} };
     }
   }
 

src/reduxTypes.js

@@ -129,17 +129,23 @@ export type FetchingState = $ReadOnly<{|
  * `state.messages`.
  */
 export type FlagsState = $ReadOnly<{|
+  // Flags that are currently documented in the API:
+  //   https://zulip.com/api/update-message-flags#available-flags
+  // i.e., those found in `UserMessageFlag`.
   read: {| +[messageId: number]: true |},
   starred: {| +[messageId: number]: true |},
   collapsed: {| +[messageId: number]: true |},
   mentioned: {| +[messageId: number]: true |},
   wildcard_mentioned: {| +[messageId: number]: true |},
+  has_alert_word: {| +[messageId: number]: true |},
+  historical: {| +[messageId: number]: true |},
+
+  // Flags not documented in the API.
+  // TODO(server): Do these ever exist?  Did they use to and get removed?
   summarize_in_home: {| +[messageId: number]: true |},
   summarize_in_stream: {| +[messageId: number]: true |},
   force_expand: {| +[messageId: number]: true |},
   force_collapse: {| +[messageId: number]: true |},
-  has_alert_word: {| +[messageId: number]: true |},
-  historical: {| +[messageId: number]: true |},
   is_me_message: {| +[messageId: number]: true |},
 |}>;
 

src/utils/narrow.js

@@ -12,6 +12,7 @@ import {
   pmKeyRecipientsFor1to1,
   makePmKeyRecipients_UNSAFE,
 } from './recipient';
+import type { UserMessageFlag } from '../api/modelTypes';
 
 /* eslint-disable no-use-before-define */
 
@@ -461,7 +462,7 @@ export const apiNarrowOfNarrow = (
  */
 export const isMessageInNarrow = (
   message: Message | Outbox,
-  flags: $ReadOnlyArray<string>,
+  flags: $ReadOnlyArray<UserMessageFlag>,
   narrow: Narrow,
   ownUserId: UserId,
 ): boolean =>
@@ -524,7 +525,7 @@ export const showComposeBoxOnNarrow = (narrow: Narrow): boolean =>
 export const getNarrowsForMessage = (
   message: Message | Outbox,
   ownUserId: UserId,
-  flags: $ReadOnlyArray<string>,
+  flags: $ReadOnlyArray<UserMessageFlag>,
 ): $ReadOnlyArray<Narrow> => {
   const result = [];