Merge pull request #28570 from fabioh8010/ts/lib/ReportActionsUtils

[No QA] [TS migration] Migrate 'ReportActionsUtils.js' lib to TypeScript

src/ONYXKEYS.ts

@@ -390,7 +390,7 @@ type OnyxValues = {
  [ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MEMBERS_DRAFT]: Record<string, number>;
  [ONYXKEYS.COLLECTION.REPORT]: OnyxTypes.Report;
  [ONYXKEYS.COLLECTION.REPORT_METADATA]: OnyxTypes.ReportMetadata;
- [ONYXKEYS.COLLECTION.REPORT_ACTIONS]: OnyxTypes.ReportAction;
+ [ONYXKEYS.COLLECTION.REPORT_ACTIONS]: OnyxTypes.ReportActions;
  [ONYXKEYS.COLLECTION.REPORT_ACTIONS_DRAFTS]: string;
  [ONYXKEYS.COLLECTION.REPORT_ACTIONS_REACTIONS]: OnyxTypes.ReportActionReactions;
  [ONYXKEYS.COLLECTION.REPORT_DRAFT_COMMENT]: string;

src/languages/types.ts

@@ -1,3 +1,4 @@
+import {ReportAction} from '../types/onyx';
 import en from './en';
 
 type AddressLineParams = {
@@ -42,15 +43,15 @@ type LocalTimeParams = {
 };
 
 type EditActionParams = {
- action: NonNullable<unknown>;
+ action: ReportAction | null;
 };
 
 type DeleteActionParams = {
- action: NonNullable<unknown>;
+ action: ReportAction | null;
 };
 
 type DeleteConfirmationParams = {
- action: NonNullable<unknown>;
+ action: ReportAction | null;
 };
 
 type BeginningOfChatHistoryDomainRoomPartOneParams = {

src/libs/actions/IOU.js

@@ -2006,7 +2006,7 @@ function deleteMoneyRequest(transactionID, reportAction, isSingleTransactionView
  }
 
  updatedIOUReport.lastMessageText = iouReportLastMessageText;
- updatedIOUReport.lastVisibleActionCreated = lastVisibleAction.created;
+ updatedIOUReport.lastVisibleActionCreated = lodashGet(lastVisibleAction, 'created');
 
  updatedReportPreviewAction = {...reportPreviewAction};
  const hasNonReimbursableTransactions = ReportUtils.hasNonReimbursableTransactions(iouReport);
@@ -2068,7 +2068,7 @@ function deleteMoneyRequest(transactionID, reportAction, isSingleTransactionView
  hasOutstandingIOU: false,
  iouReportID: null,
  lastMessageText: ReportActionsUtils.getLastVisibleMessage(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).lastMessageText,
- lastVisibleActionCreated: ReportActionsUtils.getLastVisibleAction(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}).created,
+ lastVisibleActionCreated: lodashGet(ReportActionsUtils.getLastVisibleAction(iouReport.chatReportID, {[reportPreviewAction.reportActionID]: null}), 'created'),
  },
  },
  ]

src/libs/actions/Report.js

@@ -375,8 +375,8 @@ function addActions(reportID, text = '', file) {
  const {lastMessageText = '', lastMessageTranslationKey = ''} = ReportActionsUtils.getLastVisibleMessage(reportID);
  if (lastMessageText || lastMessageTranslationKey) {
  const lastVisibleAction = ReportActionsUtils.getLastVisibleAction(reportID);
- const lastVisibleActionCreated = lastVisibleAction.created;
- const lastActorAccountID = lastVisibleAction.actorAccountID;
+ const lastVisibleActionCreated = lodashGet(lastVisibleAction, 'created');
+ const lastActorAccountID = lodashGet(lastVisibleAction, 'actorAccountID');
  failureReport = {
  lastMessageTranslationKey,
  lastMessageText,
@@ -1057,8 +1057,8 @@ function deleteReportComment(reportID, reportAction) {
  const {lastMessageText = '', lastMessageTranslationKey = ''} = ReportUtils.getLastVisibleMessage(originalReportID, optimisticReportActions);
  if (lastMessageText || lastMessageTranslationKey) {
  const lastVisibleAction = ReportActionsUtils.getLastVisibleAction(originalReportID, optimisticReportActions);
- const lastVisibleActionCreated = lastVisibleAction.created;
- const lastActorAccountID = lastVisibleAction.actorAccountID;
+ const lastVisibleActionCreated = lodashGet(lastVisibleAction, 'created');
+ const lastActorAccountID = lodashGet(lastVisibleAction, 'actorAccountID');
  optimisticReport = {
  lastMessageTranslationKey,
  lastMessageText,
@@ -1239,7 +1239,7 @@ function editReportComment(reportID, originalReportAction, textForNewComment) {
  ];
 
  const lastVisibleAction = ReportActionsUtils.getLastVisibleAction(originalReportID, optimisticReportActions);
- if (reportActionID === lastVisibleAction.reportActionID) {
+ if (reportActionID === lodashGet(lastVisibleAction, 'reportActionID')) {
  const lastMessageText = ReportUtils.formatReportLastMessageText(reportComment);
  const optimisticReport = {
  lastMessageTranslationKey: '',

src/libs/isReportMessageAttachment.ts

@@ -1,18 +1,13 @@
 import CONST from '../CONST';
-
-type IsReportMessageAttachmentParams = {
- text: string;
- html: string;
- translationKey: string;
-};
+import {Message} from '../types/onyx/ReportAction';
 
 /**
  * Check whether a report action is Attachment or not.
  * Ignore messages containing [Attachment] as the main content. Attachments are actions with only text as [Attachment].
  *
  * @param reportActionMessage report action's message as text, html and translationKey
  */
-export default function isReportMessageAttachment({text, html, translationKey}: IsReportMessageAttachmentParams): boolean {
+export default function isReportMessageAttachment({text, html, translationKey}: Message): boolean {
  if (!text || !html) {
  return false;
  }

src/types/onyx/OriginalMessage.ts

@@ -1,5 +1,19 @@
 import {ValueOf} from 'type-fest';
 import CONST from '../../CONST';
+import DeepValueOf from '../utils/DeepValueOf';
+
+type ActionName = DeepValueOf<typeof CONST.REPORT.ACTIONS.TYPE>;
+
+type OriginalMessageApproved = {
+ actionName: typeof CONST.REPORT.ACTIONS.TYPE.APPROVED;
+ originalMessage: unknown;
+};
+
+type IOUDetails = {
+ amount: number;
+ comment?: string;
+ currency: string;
+};
 
 type OriginalMessageIOU = {
  actionName: typeof CONST.REPORT.ACTIONS.TYPE.IOU;
@@ -8,23 +22,38 @@ type OriginalMessageIOU = {
  IOUTransactionID?: string;
 
  IOUReportID?: number;
+
+ /** Only exists when we are sending money */
+ IOUDetails?: IOUDetails;
+
  amount: number;
  comment?: string;
  currency: string;
  lastModified?: string;
  participantAccountIDs?: number[];
- type: string;
+ type: ValueOf<typeof CONST.IOU.REPORT_ACTION_TYPE>;
  };
 };
 
-type FlagSeverityName = 'spam' | 'inconsiderate' | 'bullying' | 'intimidation' | 'harassment' | 'assault';
+type FlagSeverityName = ValueOf<
+ Pick<
+ typeof CONST.MODERATION,
+ 'FLAG_SEVERITY_SPAM' | 'FLAG_SEVERITY_INCONSIDERATE' | 'FLAG_SEVERITY_INTIMIDATION' | 'FLAG_SEVERITY_BULLYING' | 'FLAG_SEVERITY_HARASSMENT' | 'FLAG_SEVERITY_ASSAULT'
+ >
+>;
 type FlagSeverity = {
  accountID: number;
  timestamp: string;
 };
 
+type DecisionName = ValueOf<
+ Pick<
+ typeof CONST.MODERATION,
+ 'MODERATOR_DECISION_PENDING' | 'MODERATOR_DECISION_PENDING_HIDE' | 'MODERATOR_DECISION_PENDING_REMOVE' | 'MODERATOR_DECISION_APPROVED' | 'MODERATOR_DECISION_HIDDEN'
+ >
+>;
 type Decision = {
- decision: string;
+ decision: DecisionName;
  timestamp: string;
 };
 
@@ -62,7 +91,7 @@ type OriginalMessageClosed = {
  actionName: typeof CONST.REPORT.ACTIONS.TYPE.CLOSED;
  originalMessage: {
  policyName: string;
- reason: 'default' | 'accountClosed' | 'accountMerged' | 'removedPolicy' | 'policyDeleted';
+ reason: ValueOf<typeof CONST.REPORT.ARCHIVE_REASON>;
  lastModified?: string;
  };
 };
@@ -128,7 +157,18 @@ type OriginalMessagePolicyTask = {
  originalMessage: unknown;
 };
 
+type OriginalMessageModifiedExpense = {
+ actionName: typeof CONST.REPORT.ACTIONS.TYPE.MODIFIEDEXPENSE;
+ originalMessage: unknown;
+};
+
+type OriginalMessageReimbursementQueued = {
+ actionName: typeof CONST.REPORT.ACTIONS.TYPE.REIMBURSEMENTQUEUED;
+ originalMessage: unknown;
+};
+
 type OriginalMessage =
+ | OriginalMessageApproved
  | OriginalMessageIOU
  | OriginalMessageAddComment
  | OriginalMessageSubmitted
@@ -138,7 +178,9 @@ type OriginalMessage =
  | OriginalMessageChronosOOOList
  | OriginalMessageReportPreview
  | OriginalMessagePolicyChangeLog
- | OriginalMessagePolicyTask;
+ | OriginalMessagePolicyTask
+ | OriginalMessageModifiedExpense
+ | OriginalMessageReimbursementQueued;
 
 export default OriginalMessage;
-export type {Reaction, ChronosOOOEvent};
+export type {ChronosOOOEvent, Decision, Reaction, ActionName};

src/types/onyx/Report.ts

@@ -57,6 +57,7 @@ type Report = {
  /** The report type */
  type?: string;
 
+ lastMessageTranslationKey?: string;
  parentReportID?: string;
  parentReportActionID?: string;
  isOptimisticReport?: boolean;

src/types/onyx/ReportAction.ts

@@ -1,10 +1,13 @@
-import OriginalMessage, {Reaction} from './OriginalMessage';
 import * as OnyxCommon from './OnyxCommon';
+import OriginalMessage, {Decision, Reaction} from './OriginalMessage';
 
 type Message = {
  /** The type of the action item fragment. Used to render a corresponding component */
  type: string;
 
+ /** The html content of the fragment. */
+ html: string;
+
  /** The text content of the fragment. */
  text: string;
 
@@ -37,6 +40,9 @@ type Message = {
  isReversedTransaction?: boolean;
  whisperedTo: number[];
  reactions: Reaction[];
+
+ moderationDecision?: Decision;
+ translationKey?: string;
 };
 
 type Person = {
@@ -47,7 +53,10 @@ type Person = {
 
 type ReportActionBase = {
  /** The ID of the reportAction. It is the string representation of the a 64-bit integer. */
- reportActionID?: string;
+ reportActionID: string;
+
+ /** @deprecated Used in old report actions before migration. Replaced by reportActionID. */
+ sequenceNumber?: number;
 
  /** The ID of the previous reportAction on the report. It is a string represenation of a 64-bit integer (or null for CREATED actions). */
  previousReportActionID?: string;
@@ -58,7 +67,7 @@ type ReportActionBase = {
  person?: Person[];
 
  /** ISO-formatted datetime */
- created?: string;
+ created: string;
 
  /** report action message */
  message?: Message[];
@@ -83,10 +92,23 @@ type ReportActionBase = {
  childCommenterCount?: number;
  childLastVisibleActionCreated?: string;
  childVisibleActionCount?: number;
+ childMoneyRequestCount?: number;
+
+ /** ISO-formatted datetime */
+ lastModified?: string;
 
  pendingAction?: OnyxCommon.PendingAction;
+ delegateAccountID?: string;
+
+ /** Server side errors keyed by microtime */
+ errors?: OnyxCommon.Errors;
+
+ isAttachment?: boolean;
 };
 
 type ReportAction = ReportActionBase & OriginalMessage;
 
+type ReportActions = Record<string, ReportAction>;
+
 export default ReportAction;
+export type {ReportActions, Message};

src/types/onyx/index.ts

@@ -37,7 +37,7 @@ import Policy from './Policy';
 import PolicyCategory from './PolicyCategory';
 import Report from './Report';
 import ReportMetadata from './ReportMetadata';
-import ReportAction from './ReportAction';
+import ReportAction, {ReportActions} from './ReportAction';
 import ReportActionReactions from './ReportActionReactions';
 import SecurityGroup from './SecurityGroup';
 import Transaction from './Transaction';
@@ -88,6 +88,7 @@ export type {
  Report,
  ReportMetadata,
  ReportAction,
+ ReportActions,
  ReportActionReactions,
  SecurityGroup,
  Transaction,