@contentful/field-editor-rich-text 6.2.1 → 6.3.0

package/dist/cjs/helpers/formatDateAndTime.js

@@ -19,26 +19,23 @@ _export(exports, {
         return formatTime;
     }
 });
-const _moment = /*#__PURE__*/ _interop_require_default(require("moment"));
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
+const _datefns = require("date-fns");
 const formatDate = (date, short)=>{
-    switch((0, _moment.default)().startOf('day').diff((0, _moment.default)(date).startOf('day'), 'days')){
+    const d = new Date(date);
+    const diff = (0, _datefns.differenceInCalendarDays)((0, _datefns.startOfDay)(new Date()), (0, _datefns.startOfDay)(d));
+    switch(diff){
         case 0:
-            return short ? 'Today' : `Today, ${(0, _moment.default)(date).format('DD MMM YYYY')}`;
+            return short ? 'Today' : `Today, ${(0, _datefns.format)(d, 'dd MMM yyyy')}`;
         case -1:
-            return short ? 'Tomorrow' : `Tomorrow, ${(0, _moment.default)(date).format('DD MMM YYYY')}`;
+            return short ? 'Tomorrow' : `Tomorrow, ${(0, _datefns.format)(d, 'dd MMM yyyy')}`;
         case 1:
-            return short ? 'Yesterday' : `Yesterday, ${(0, _moment.default)(date).format('DD MMM YYYY')}`;
+            return short ? 'Yesterday' : `Yesterday, ${(0, _datefns.format)(d, 'dd MMM yyyy')}`;
         default:
-            return (0, _moment.default)(date).format('ddd, DD MMM YYYY');
+            return (0, _datefns.format)(d, 'eee, dd MMM yyyy');
     }
 };
 const formatTime = (date)=>{
-    return _moment.default.utc(date).local().format('h:mm A');
+    return (0, _datefns.format)(new Date(date), 'h:mm a');
 };
 const formatDateAndTime = (date, short)=>{
     return `${formatDate(date, short)} at ${formatTime(date)}`;

package/dist/cjs/helpers/formatDateAndTime.spec.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+const _formatDateAndTime = require("./formatDateAndTime");
+const TODAY = new Date('2024-06-15T12:00:00.000Z');
+beforeEach(()=>{
+    jest.useFakeTimers();
+    jest.setSystemTime(TODAY);
+});
+afterEach(()=>{
+    jest.useRealTimers();
+});
+describe('formatDate', ()=>{
+    it('returns "Today" (short) for a date on the same calendar day', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-15T08:00:00.000Z', true)).toBe('Today');
+    });
+    it('returns long form for today', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-15T08:00:00.000Z')).toBe('Today, 15 Jun 2024');
+    });
+    it('returns "Tomorrow" (short) for the next calendar day', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-16T08:00:00.000Z', true)).toBe('Tomorrow');
+    });
+    it('returns long form for tomorrow', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-16T08:00:00.000Z')).toBe('Tomorrow, 16 Jun 2024');
+    });
+    it('returns "Yesterday" (short) for the previous calendar day', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-14T08:00:00.000Z', true)).toBe('Yesterday');
+    });
+    it('returns long form for yesterday', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-14T08:00:00.000Z')).toBe('Yesterday, 14 Jun 2024');
+    });
+    it('returns weekday + date for a past date beyond yesterday', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-01T08:00:00.000Z')).toBe('Sat, 01 Jun 2024');
+    });
+    it('returns weekday + date for a future date beyond tomorrow', ()=>{
+        expect((0, _formatDateAndTime.formatDate)('2024-06-20T08:00:00.000Z')).toBe('Thu, 20 Jun 2024');
+    });
+    it('accepts a Date object', ()=>{
+        expect((0, _formatDateAndTime.formatDate)(new Date('2024-06-15T09:30:00.000Z'), true)).toBe('Today');
+    });
+});
+describe('formatTime', ()=>{
+    it('formats a UTC ISO string to local h:mm AM/PM', ()=>{
+        expect((0, _formatDateAndTime.formatTime)('2024-06-15T15:36:45.000Z')).toBe('3:36 PM');
+    });
+    it('formats midnight UTC correctly', ()=>{
+        expect((0, _formatDateAndTime.formatTime)('2024-06-15T00:00:00.000Z')).toBe('12:00 AM');
+    });
+    it('formats noon UTC correctly', ()=>{
+        expect((0, _formatDateAndTime.formatTime)('2024-06-15T12:00:00.000Z')).toBe('12:00 PM');
+    });
+    it('timezone shift: two UTC times 1 hour apart produce different outputs', ()=>{
+        expect((0, _formatDateAndTime.formatTime)('2024-06-15T10:00:00.000Z')).toBe('10:00 AM');
+        expect((0, _formatDateAndTime.formatTime)('2024-06-15T11:00:00.000Z')).toBe('11:00 AM');
+    });
+    it('accepts a Date object', ()=>{
+        expect((0, _formatDateAndTime.formatTime)(new Date('2024-06-15T15:36:45.000Z'))).toBe('3:36 PM');
+    });
+});
+describe('formatDateAndTime', ()=>{
+    it('combines date and time with " at " separator', ()=>{
+        expect((0, _formatDateAndTime.formatDateAndTime)('2024-06-15T15:36:45.000Z')).toBe('Today, 15 Jun 2024 at 3:36 PM');
+    });
+    it('passes short flag through to date portion', ()=>{
+        expect((0, _formatDateAndTime.formatDateAndTime)('2024-06-15T15:36:45.000Z', true)).toBe('Today at 3:36 PM');
+    });
+    it('works for a past date', ()=>{
+        expect((0, _formatDateAndTime.formatDateAndTime)('2024-06-01T08:00:00.000Z')).toBe('Sat, 01 Jun 2024 at 8:00 AM');
+    });
+});

package/dist/esm/helpers/formatDateAndTime.js

@@ -1,18 +1,20 @@
-import moment from 'moment';
+import { differenceInCalendarDays, format, startOfDay } from 'date-fns';
 export const formatDate = (date, short)=>{
-    switch(moment().startOf('day').diff(moment(date).startOf('day'), 'days')){
+    const d = new Date(date);
+    const diff = differenceInCalendarDays(startOfDay(new Date()), startOfDay(d));
+    switch(diff){
         case 0:
-            return short ? 'Today' : `Today, ${moment(date).format('DD MMM YYYY')}`;
+            return short ? 'Today' : `Today, ${format(d, 'dd MMM yyyy')}`;
         case -1:
-            return short ? 'Tomorrow' : `Tomorrow, ${moment(date).format('DD MMM YYYY')}`;
+            return short ? 'Tomorrow' : `Tomorrow, ${format(d, 'dd MMM yyyy')}`;
         case 1:
-            return short ? 'Yesterday' : `Yesterday, ${moment(date).format('DD MMM YYYY')}`;
+            return short ? 'Yesterday' : `Yesterday, ${format(d, 'dd MMM yyyy')}`;
         default:
-            return moment(date).format('ddd, DD MMM YYYY');
+            return format(d, 'eee, dd MMM yyyy');
     }
 };
 export const formatTime = (date)=>{
-    return moment.utc(date).local().format('h:mm A');
+    return format(new Date(date), 'h:mm a');
 };
 export const formatDateAndTime = (date, short)=>{
     return `${formatDate(date, short)} at ${formatTime(date)}`;

package/dist/esm/helpers/formatDateAndTime.spec.js

@@ -0,0 +1,67 @@
+import { formatDate, formatDateAndTime, formatTime } from './formatDateAndTime';
+const TODAY = new Date('2024-06-15T12:00:00.000Z');
+beforeEach(()=>{
+    jest.useFakeTimers();
+    jest.setSystemTime(TODAY);
+});
+afterEach(()=>{
+    jest.useRealTimers();
+});
+describe('formatDate', ()=>{
+    it('returns "Today" (short) for a date on the same calendar day', ()=>{
+        expect(formatDate('2024-06-15T08:00:00.000Z', true)).toBe('Today');
+    });
+    it('returns long form for today', ()=>{
+        expect(formatDate('2024-06-15T08:00:00.000Z')).toBe('Today, 15 Jun 2024');
+    });
+    it('returns "Tomorrow" (short) for the next calendar day', ()=>{
+        expect(formatDate('2024-06-16T08:00:00.000Z', true)).toBe('Tomorrow');
+    });
+    it('returns long form for tomorrow', ()=>{
+        expect(formatDate('2024-06-16T08:00:00.000Z')).toBe('Tomorrow, 16 Jun 2024');
+    });
+    it('returns "Yesterday" (short) for the previous calendar day', ()=>{
+        expect(formatDate('2024-06-14T08:00:00.000Z', true)).toBe('Yesterday');
+    });
+    it('returns long form for yesterday', ()=>{
+        expect(formatDate('2024-06-14T08:00:00.000Z')).toBe('Yesterday, 14 Jun 2024');
+    });
+    it('returns weekday + date for a past date beyond yesterday', ()=>{
+        expect(formatDate('2024-06-01T08:00:00.000Z')).toBe('Sat, 01 Jun 2024');
+    });
+    it('returns weekday + date for a future date beyond tomorrow', ()=>{
+        expect(formatDate('2024-06-20T08:00:00.000Z')).toBe('Thu, 20 Jun 2024');
+    });
+    it('accepts a Date object', ()=>{
+        expect(formatDate(new Date('2024-06-15T09:30:00.000Z'), true)).toBe('Today');
+    });
+});
+describe('formatTime', ()=>{
+    it('formats a UTC ISO string to local h:mm AM/PM', ()=>{
+        expect(formatTime('2024-06-15T15:36:45.000Z')).toBe('3:36 PM');
+    });
+    it('formats midnight UTC correctly', ()=>{
+        expect(formatTime('2024-06-15T00:00:00.000Z')).toBe('12:00 AM');
+    });
+    it('formats noon UTC correctly', ()=>{
+        expect(formatTime('2024-06-15T12:00:00.000Z')).toBe('12:00 PM');
+    });
+    it('timezone shift: two UTC times 1 hour apart produce different outputs', ()=>{
+        expect(formatTime('2024-06-15T10:00:00.000Z')).toBe('10:00 AM');
+        expect(formatTime('2024-06-15T11:00:00.000Z')).toBe('11:00 AM');
+    });
+    it('accepts a Date object', ()=>{
+        expect(formatTime(new Date('2024-06-15T15:36:45.000Z'))).toBe('3:36 PM');
+    });
+});
+describe('formatDateAndTime', ()=>{
+    it('combines date and time with " at " separator', ()=>{
+        expect(formatDateAndTime('2024-06-15T15:36:45.000Z')).toBe('Today, 15 Jun 2024 at 3:36 PM');
+    });
+    it('passes short flag through to date portion', ()=>{
+        expect(formatDateAndTime('2024-06-15T15:36:45.000Z', true)).toBe('Today at 3:36 PM');
+    });
+    it('works for a past date', ()=>{
+        expect(formatDateAndTime('2024-06-01T08:00:00.000Z')).toBe('Sat, 01 Jun 2024 at 8:00 AM');
+    });
+});

package/dist/types/helpers/formatDateAndTime.d.ts

@@ -1,6 +1,6 @@
 type DateFormatFn = (date: Date | string, short?: boolean) => string;
 /**
- * @param {Date|string} date A valid constructor argument for moment()
+ * @param {Date|string} date A valid Date object or ISO string
  * @param {boolean=} short Render only Today/Tomorrow/Yesterday if valid. Defaults to false
  */
 export declare const formatDate: DateFormatFn;

package/dist/types/helpers/formatDateAndTime.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/field-editor-rich-text",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "source": "./src/index.tsx",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -45,7 +45,7 @@
     "@contentful/f36-icons": "^6.7.1",
     "@contentful/f36-tokens": "^6.1.2",
     "@contentful/f36-utils": "^6.1.0",
-    "@contentful/field-editor-reference": "^8.1.1",
+    "@contentful/field-editor-reference": "^8.2.0",
     "@contentful/field-editor-shared": "^4.1.0",
     "@contentful/rich-text-plain-text-renderer": "^17.0.0",
     "@contentful/rich-text-types": "^17.2.5",
@@ -63,11 +63,11 @@
     "@udecode/plate-table": "36.5.9",
     "@udecode/plate-trailing-block": "36.0.0",
     "constate": "^3.3.2",
+    "date-fns": "^2.30.0",
     "fast-deep-equal": "^3.1.3",
     "is-hotkey": "^0.2.0",
     "is-plain-obj": "^3.0.0",
     "lodash": "^4.17.21",
-    "moment": "^2.20.0",
     "p-debounce": "^2.1.0",
     "react-popper": "^2.3.0",
     "slate": "0.94.1",
@@ -94,5 +94,5 @@
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/"
   },
-  "gitHead": "a393f89372b4357e5912066afeb873e9cfe2fa5e"
+  "gitHead": "920695a78a03f560d41d4dd06793e9980f0a3de0"
 }