Files
twenty/packages/twenty-front/src/utils/date-utils.ts
Lucas Bordeau ccf4d1eeec Date formatting per workspace member settings (#6408)
Implement date formatting per workspace member settings

We'll need another round to maybe initialize all workspaces on the
default settings.

For now the default behavior is to take system settings if nothing is
found in DB.

---------

Co-authored-by: Weiko <corentin@twenty.com>
2024-07-30 14:52:10 +02:00

216 lines
5.9 KiB
TypeScript

/* eslint-disable @nx/workspace-explicit-boolean-predicates-in-if */
import { isDate, isNumber, isString } from '@sniptt/guards';
import { differenceInCalendarDays, formatDistanceToNow } from 'date-fns';
import { DateTime } from 'luxon';
import moize from 'moize';
import { isDefined } from '~/utils/isDefined';
import { logError } from './logError';
export const DEFAULT_DATE_LOCALE = 'en-EN';
export const parseDate = (dateToParse: Date | string | number) => {
if (dateToParse === 'now') return DateTime.fromJSDate(new Date());
let formattedDate: DateTime | null = null;
if (!dateToParse) {
throw new Error(`Invalid date passed to formatPastDate: "${dateToParse}"`);
} else if (isString(dateToParse)) {
formattedDate = DateTime.fromISO(dateToParse);
} else if (isDate(dateToParse)) {
formattedDate = DateTime.fromJSDate(dateToParse);
} else if (isNumber(dateToParse)) {
formattedDate = DateTime.fromMillis(dateToParse);
}
if (!formattedDate) {
throw new Error(`Invalid date passed to formatPastDate: "${dateToParse}"`);
}
if (!formattedDate.isValid) {
throw new Error(`Invalid date passed to formatPastDate: "${dateToParse}"`);
}
return formattedDate.setLocale(DEFAULT_DATE_LOCALE);
};
const isSameDay = (a: DateTime, b: DateTime): boolean =>
a.hasSame(b, 'day') && a.hasSame(b, 'month') && a.hasSame(b, 'year');
export const formatDate = (
dateToFormat: Date | string | number,
format: string,
) => {
try {
const parsedDate = parseDate(dateToFormat);
return parsedDate.toFormat(format);
} catch (error) {
logError(error);
return '';
}
};
export const beautifyExactDateTime = (
dateToBeautify: Date | string | number,
) => {
const isToday = isSameDay(parseDate(dateToBeautify), DateTime.local());
const dateFormat = isToday ? 'T' : 'DD · T';
return formatDate(dateToBeautify, dateFormat);
};
export const beautifyExactDate = (dateToBeautify: Date | string | number) => {
const isToday = isSameDay(parseDate(dateToBeautify), DateTime.local());
const dateFormat = isToday ? "'Today'" : 'DD';
return formatDate(dateToBeautify, dateFormat);
};
export const beautifyPastDateRelativeToNow = (
pastDate: Date | string | number,
) => {
try {
const parsedDate = parseDate(pastDate);
return formatDistanceToNow(parsedDate.toJSDate(), {
addSuffix: true,
}).replace('less than a minute ago', 'now');
} catch (error) {
logError(error);
return '';
}
};
export const beautifyPastDateAbsolute = (pastDate: Date | string | number) => {
try {
const parsedPastDate = parseDate(pastDate);
const hoursDiff = parsedPastDate.diffNow('hours').negate().hours;
if (hoursDiff <= 24) {
return parsedPastDate.toFormat('HH:mm');
} else if (hoursDiff <= 7 * 24) {
return parsedPastDate.toFormat('cccc - HH:mm');
} else if (hoursDiff <= 365 * 24) {
return parsedPastDate.toFormat('MMMM d - HH:mm');
} else {
return parsedPastDate.toFormat('dd/MM/yyyy - HH:mm');
}
} catch (error) {
logError(error);
return '';
}
};
export const hasDatePassed = (date: Date | string | number) => {
try {
const parsedDate = parseDate(date);
return (
differenceInCalendarDays(
DateTime.local().toJSDate(),
parsedDate.toJSDate(),
) >= 1
);
} catch (error) {
logError(error);
return false;
}
};
export const beautifyDateDiff = (
date: string,
dateToCompareWith?: string,
short = false,
) => {
const dateDiff = DateTime.fromISO(date).diff(
dateToCompareWith ? DateTime.fromISO(dateToCompareWith) : DateTime.now(),
['years', 'days'],
);
let result = '';
if (dateDiff.years) result = result + `${dateDiff.years} year`;
if (![0, 1].includes(dateDiff.years)) result = result + 's';
if (short && dateDiff.years) return result;
if (dateDiff.years && dateDiff.days) result = result + ' and ';
if (dateDiff.days) result = result + `${Math.floor(dateDiff.days)} day`;
if (![0, 1].includes(dateDiff.days)) result = result + 's';
return result;
};
const getMonthLabels = () => {
const formatter = new Intl.DateTimeFormat(undefined, {
month: 'short',
timeZone: 'UTC',
});
return [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
.map((month) => {
const monthZeroFilled = month < 10 ? `0${month}` : month;
return new Date(`2017-${monthZeroFilled}-01T00:00:00+00:00`);
})
.map((date) => formatter.format(date));
};
export const getMonthLabelsMemoized = moize(getMonthLabels);
export const formatISOStringToHumanReadableDateTime = (date: string) => {
const monthLabels = getMonthLabelsMemoized();
if (!isDefined(monthLabels)) {
return formatToHumanReadableDateTime(date);
}
const year = date.slice(0, 4);
const month = date.slice(5, 7);
const monthLabel = monthLabels[parseInt(month, 10) - 1];
const jsDate = new Date(date);
const day = jsDate.getDate();
const hours = `0${jsDate.getHours()}`.slice(-2);
const minutes = `0${jsDate.getMinutes()}`.slice(-2);
return `${day} ${monthLabel} ${year} - ${hours}:${minutes}`;
};
export const formatISOStringToHumanReadableDate = (date: string) => {
const monthLabels = getMonthLabelsMemoized();
if (!isDefined(monthLabels)) {
return formatToHumanReadableDate(date);
}
const year = date.slice(0, 4);
const month = date.slice(5, 7);
const day = date.slice(8, 10);
const monthLabel = monthLabels[parseInt(month, 10) - 1];
return `${day} ${monthLabel} ${year}`;
};
export const formatToHumanReadableDate = (date: Date | string) => {
const parsedJSDate = parseDate(date).toJSDate();
return new Intl.DateTimeFormat(undefined, {
month: 'short',
day: 'numeric',
year: 'numeric',
}).format(parsedJSDate);
};
export const formatToHumanReadableDateTime = (date: Date | string) => {
const parsedJSDate = parseDate(date).toJSDate();
return new Intl.DateTimeFormat(undefined, {
month: 'short',
day: 'numeric',
year: 'numeric',
hour: 'numeric',
minute: 'numeric',
}).format(parsedJSDate);
};