-
Notifications
You must be signed in to change notification settings - Fork 2.9k
/
NextStepUtils.ts
340 lines (305 loc) · 11.7 KB
/
NextStepUtils.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
import {format, lastDayOfMonth, setDate} from 'date-fns';
import Str from 'expensify-common/lib/str';
import Onyx from 'react-native-onyx';
import type {ValueOf} from 'type-fest';
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type {Report, ReportNextStep} from '@src/types/onyx';
import type {Message} from '@src/types/onyx/ReportNextStep';
import type DeepValueOf from '@src/types/utils/DeepValueOf';
import type {EmptyObject} from '@src/types/utils/EmptyObject';
import DateUtils from './DateUtils';
import EmailUtils from './EmailUtils';
import * as PersonalDetailsUtils from './PersonalDetailsUtils';
import * as ReportUtils from './ReportUtils';
let currentUserAccountID = -1;
Onyx.connect({
key: ONYXKEYS.SESSION,
callback: (value) => {
if (!value) {
return;
}
currentUserAccountID = value?.accountID ?? -1;
},
});
function parseMessage(messages: Message[] | undefined) {
let nextStepHTML = '';
messages?.forEach((part) => {
const isEmail = Str.isValidEmail(part.text);
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
let tagType = part.type ?? 'span';
let content = Str.safeEscape(part.text);
if (isEmail) {
tagType = 'next-step-email';
content = EmailUtils.prefixMailSeparatorsWithBreakOpportunities(content);
}
nextStepHTML += `<${tagType}>${content}</${tagType}>`;
});
const formattedHtml = nextStepHTML
.replace(/%expenses/g, 'these expenses')
.replace(/%Expenses/g, 'These expenses')
.replace(/%tobe/g, 'are');
return `<next-step>${formattedHtml}</next-step>`;
}
type BuildNextStepParameters = {
isPaidWithExpensify?: boolean;
};
/**
* Generates an optimistic nextStep based on a current report status and other properties.
*
* @param report
* @param predictedNextStatus - a next expected status of the report
* @param parameters.isPaidWithExpensify - Whether a report has been paid with Expensify or outside
* @returns nextStep
*/
function buildNextStep(
report: Report | EmptyObject,
predictedNextStatus: ValueOf<typeof CONST.REPORT.STATUS_NUM>,
{isPaidWithExpensify}: BuildNextStepParameters = {},
): ReportNextStep | null {
if (!ReportUtils.isExpenseReport(report)) {
return null;
}
const {policyID = '', ownerAccountID = -1, managerID = -1} = report;
const policy = ReportUtils.getPolicy(policyID);
const {submitsTo, harvesting, isPreventSelfApprovalEnabled, preventSelfApproval, autoReportingFrequency, autoReportingOffset} = policy;
const isOwner = currentUserAccountID === ownerAccountID;
const isManager = currentUserAccountID === managerID;
const isSelfApproval = currentUserAccountID === submitsTo;
const ownerLogin = PersonalDetailsUtils.getLoginsByAccountIDs([ownerAccountID])[0] ?? '';
const managerDisplayName = isSelfApproval ? 'you' : ReportUtils.getDisplayNameForParticipant(submitsTo) ?? '';
const type: ReportNextStep['type'] = 'neutral';
let optimisticNextStep: ReportNextStep | null;
switch (predictedNextStatus) {
// Generates an optimistic nextStep once a report has been opened
case CONST.REPORT.STATUS_NUM.OPEN:
// Self review
optimisticNextStep = {
type,
title: 'Next Steps:',
message: [
{
text: 'Waiting for ',
},
{
text: 'you',
type: 'strong',
},
{
text: ' to ',
},
{
text: 'submit',
type: 'strong',
},
{
text: ' these expenses.',
},
],
};
// Scheduled submit enabled
if (harvesting?.enabled && autoReportingFrequency !== CONST.POLICY.AUTO_REPORTING_FREQUENCIES.MANUAL) {
optimisticNextStep.message = [
{
text: 'These expenses are scheduled to ',
},
];
let harvestingSuffix = '';
if (autoReportingFrequency) {
const currentDate = new Date();
let autoSubmissionDate: Date | null = null;
let formattedDate = '';
if (autoReportingOffset === CONST.POLICY.AUTO_REPORTING_OFFSET.LAST_DAY_OF_MONTH) {
autoSubmissionDate = lastDayOfMonth(currentDate);
} else if (autoReportingOffset === CONST.POLICY.AUTO_REPORTING_OFFSET.LAST_BUSINESS_DAY_OF_MONTH) {
const lastBusinessDayOfMonth = DateUtils.getLastBusinessDayOfMonth(currentDate);
autoSubmissionDate = setDate(currentDate, lastBusinessDayOfMonth);
} else if (autoReportingOffset !== undefined) {
autoSubmissionDate = setDate(currentDate, autoReportingOffset);
}
if (autoSubmissionDate) {
formattedDate = format(autoSubmissionDate, CONST.DATE.ORDINAL_DAY_OF_MONTH);
}
const harvestingSuffixes: Record<DeepValueOf<typeof CONST.POLICY.AUTO_REPORTING_FREQUENCIES>, string> = {
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.IMMEDIATE]: 'later today',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.WEEKLY]: 'on Sunday',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.SEMI_MONTHLY]: 'on the 1st and 16th of each month',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.MONTHLY]: formattedDate ? `on the ${formattedDate} of each month` : '',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.TRIP]: 'at the end of your trip',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.INSTANT]: '',
[CONST.POLICY.AUTO_REPORTING_FREQUENCIES.MANUAL]: '',
};
if (harvestingSuffixes[autoReportingFrequency]) {
harvestingSuffix = ` ${harvestingSuffixes[autoReportingFrequency]}`;
}
}
optimisticNextStep.message.push(
{
text: `automatically submit${harvestingSuffix}!`,
type: 'strong',
},
{
text: ' No further action required!',
},
);
}
// Prevented self submitting
if ((isPreventSelfApprovalEnabled ?? preventSelfApproval) && isSelfApproval) {
optimisticNextStep.message = [
{
text: "Oops! Looks like you're submitting to ",
},
{
text: 'yourself',
type: 'strong',
},
{
text: '. Approving your own reports is ',
},
{
text: 'forbidden',
type: 'strong',
},
{
text: ' by your policy. Please submit this report to someone else or contact your admin to change the person you submit to.',
},
];
}
break;
// Generates an optimistic nextStep once a report has been submitted
case CONST.REPORT.STATUS_NUM.SUBMITTED: {
const verb = isManager ? 'review' : 'approve';
// Another owner
optimisticNextStep = {
type,
title: 'Next Steps:',
message: [
{
text: ownerLogin,
type: 'strong',
},
{
text: ' is waiting for ',
},
{
text: 'you',
type: 'strong',
},
{
text: ' to ',
},
{
text: verb,
type: 'strong',
},
{
text: ' these %expenses.',
},
],
};
// Self review & another reviewer
if (isOwner) {
optimisticNextStep.message = [
{
text: 'Waiting for ',
},
{
text: managerDisplayName,
type: 'strong',
},
{
text: ' to ',
},
{
text: verb,
type: 'strong',
},
{
text: ' %expenses.',
},
];
}
break;
}
// Generates an optimistic nextStep once a report has been approved
case CONST.REPORT.STATUS_NUM.APPROVED:
// Self review
optimisticNextStep = {
type,
title: 'Next Steps:',
message: [
{
text: 'Waiting for ',
},
{
text: managerDisplayName,
type: 'strong',
},
{
text: ' to ',
},
{
text: 'pay',
type: 'strong',
},
{
text: ' %expenses.',
},
],
};
// Another owner
if (!isOwner) {
optimisticNextStep.message = [
{
text: 'Waiting for ',
},
{
text: 'you',
type: 'strong',
},
{
text: ' to ',
},
{
text: 'pay',
type: 'strong',
},
{
text: ' %expenses.',
},
];
}
break;
// Generates an optimistic nextStep once a report has been paid
case CONST.REPORT.STATUS_NUM.REIMBURSED:
// Paid with wallet
optimisticNextStep = {
type,
title: 'Finished!',
message: [
{
text: 'You',
type: 'strong',
},
{
text: ' have marked these expenses as ',
},
{
text: 'paid',
type: 'strong',
},
],
};
// Paid outside of Expensify
if (isPaidWithExpensify === false) {
optimisticNextStep.message?.push({text: ' outside of Expensify'});
}
optimisticNextStep.message?.push({text: '.'});
break;
// Resets a nextStep
default:
optimisticNextStep = null;
}
return optimisticNextStep;
}
export {parseMessage, buildNextStep};