npm - @prairielearn/formatter - Versions diffs - 1.3.14 → 1.4.0 - Mend

@prairielearn/formatter 1.3.14 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

package/dist/date.test.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import { assert, describe, it } from 'vitest';
-import { formatDate, formatDateYMD, formatDateYMDHM } from './date.js';
+import { formatDate, formatDateFriendly, formatDateRangeFriendly, formatDateWithinRange, formatDateYMD, formatDateYMDHM, } from './date.js';
 describe('date formatting', () => {
     describe('formatDate', () => {
         it('formats a UTC date', () => {
@@ -67,5 +67,242 @@ describe('date formatting', () => {
             assert.equal(formatDateYMDHM(date, 'UTC'), '2018-01-01 00:01');
         });
     });
+    describe('formatDateWithinRange()', () => {
+        it('should handle a date within the same day in UTC', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 34, 7));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            const end = new Date(Date.UTC(2018, 0, 1, 12, 59, 59));
+            assert.equal(formatDateWithinRange(date, start, end, 'UTC'), '12:34');
+        });
+        it('should handle a date within the same day in CST', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 23, 8, 57));
+            const start = new Date(Date.UTC(2018, 0, 1, 21, 0, 0));
+            const end = new Date(Date.UTC(2018, 0, 2, 2, 14, 0));
+            assert.equal(formatDateWithinRange(date, start, end, 'America/Chicago'), '17:08');
+        });
+        it('should handle a date within the same year in UTC', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 34, 7));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            const end = new Date(Date.UTC(2018, 0, 4, 12, 59, 59));
+            assert.equal(formatDateWithinRange(date, start, end, 'UTC'), 'Jan 1, 12:34');
+        });
+        it('should handle a date within different years in UTC', () => {
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 34, 7));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            const end = new Date(Date.UTC(2019, 0, 1, 12, 59, 59));
+            assert.equal(formatDateWithinRange(date, start, end, 'UTC'), '2018-01-01 12:34');
+        });
+    });
+    describe('formatDateFriendly()', () => {
+        it('should handle a date on the same day at the same time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 12:34pm (UTC)');
+        });
+        it('should handle a date on the same day at a later time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 1, 16, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 4:34pm (UTC)');
+        });
+        it('should handle a date on the same day at an earlier time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 1, 9, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 9:34am (UTC)');
+        });
+        it('should handle a date on the next day at the same time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 2, 12, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'tomorrow, 12:34pm (UTC)');
+        });
+        it('should handle a date on the next day at a later time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 2, 16, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'tomorrow, 4:34pm (UTC)');
+        });
+        it('should handle a date on the next day at an earlier time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 0, 2, 9, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'tomorrow, 9:34am (UTC)');
+        });
+        it('should handle a date on the previous day at the same time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2017, 11, 31, 12, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'yesterday, 12:34pm (UTC)');
+        });
+        it('should handle a date on the previous day at a later time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2017, 11, 31, 16, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'yesterday, 4:34pm (UTC)');
+        });
+        it('should handle a date on the previous day at an earlier time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2017, 11, 31, 9, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'yesterday, 9:34am (UTC)');
+        });
+        it('should handle a date in the near future', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'Sun, Apr\u00a015, 12:34am (UTC)');
+        });
+        it('should handle a date in the far future', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 9, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'Mon, Oct\u00a015, 2018, 12:34am (UTC)');
+        });
+        it('should handle a date in the near past', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2017, 9, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'Sun, Oct\u00a015, 12:34am (UTC)');
+        });
+        it('should handle a date in the far past', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2017, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'Sat, Apr\u00a015, 2017, 12:34am (UTC)');
+        });
+        it('should display without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, includeTz: false }), 'Sun, Apr\u00a015, 12:34am');
+        });
+        it('should handle a date in CDT', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'America/Chicago', { baseDate }), 'Sat, Apr\u00a014, 7:34pm (CDT)');
+        });
+        it('should handle a date in CDT without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'America/Chicago', { baseDate, includeTz: false }), 'Sat, Apr\u00a014, 7:34pm');
+        });
+        it('should handle displaying only the date', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, dateOnly: true }), 'Sun, Apr\u00a015 (UTC)');
+        });
+        it('should handle displaying only the date without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, dateOnly: true, includeTz: false }), 'Sun, Apr\u00a015');
+        });
+        it('should handle displaying only the time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, timeOnly: true }), '12:34am (UTC)');
+        });
+        it('should handle displaying only the time without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, timeOnly: true, includeTz: false }), '12:34am');
+        });
+        it('should handle displaying dates with the time first', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const date = new Date(Date.UTC(2018, 3, 15, 0, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate, timeFirst: true }), '12:34am Sun, Apr\u00a015 (UTC)');
+        });
+        it('should handle a time with seconds', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 2));
+            const date = new Date(Date.UTC(2018, 0, 1, 13, 34, 7));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 1:34:07pm (UTC)');
+        });
+        it('should handle a time with minutes', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 2));
+            const date = new Date(Date.UTC(2018, 0, 1, 13, 34, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 1:34pm (UTC)');
+        });
+        it('should handle a time with hours', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 2));
+            const date = new Date(Date.UTC(2018, 0, 1, 13, 0, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 1pm (UTC)');
+        });
+        it('should handle midnight', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 2));
+            const date = new Date(Date.UTC(2018, 0, 1, 0, 0, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 12am (UTC)');
+        });
+        it('should handle noon', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 2));
+            const date = new Date(Date.UTC(2018, 0, 1, 12, 0, 0));
+            assert.equal(formatDateFriendly(date, 'UTC', { baseDate }), 'today, 12pm (UTC)');
+        });
+    });
+    describe('formatDateRangeFriendly()', () => {
+        it('should handle two different dates', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate }), 'today, 12:34pm to Wed, Jan\u00a03, 10am (UTC)');
+        });
+        it('should handle the same date with different times', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 1, 13, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate }), 'today, 12:34pm to 1pm (UTC)');
+        });
+        it('should handle the same date with the same time', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate }), 'today, 12:34pm (UTC)');
+        });
+        it('should handle two different dates with the time first', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate, timeFirst: true }), '12:34pm today to 10am Wed, Jan\u00a03 (UTC)');
+        });
+        it('should handle the same date with different times with the time first', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 1, 13, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate, timeFirst: true }), '12:34pm to 1pm today (UTC)');
+        });
+        it('should handle the same date with the same time and the time first', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate, timeFirst: true }), '12:34pm today (UTC)');
+        });
+        it('should handle two different dates without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', { baseDate, includeTz: false }), 'today, 12:34pm to Wed, Jan\u00a03, 10am');
+        });
+        it('should handle two different dates with only dates and without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', {
+                baseDate,
+                dateOnly: true,
+                includeTz: false,
+            }), 'today to Wed, Jan\u00a03');
+        });
+        it('should handle two different dates with time first and without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'UTC', {
+                baseDate,
+                timeFirst: true,
+                includeTz: false,
+            }), '12:34pm today to 10am Wed, Jan\u00a03');
+        });
+        it('should handle two different dates in CST', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 0, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'America/Chicago', { baseDate }), 'yesterday, 6:34pm to Wed, Jan\u00a03, 4am (CST)');
+        });
+        it('should handle two different dates in CDT without the timezone', () => {
+            const baseDate = new Date(Date.UTC(2018, 0, 1, 12, 34, 0));
+            const start = new Date(Date.UTC(2018, 0, 1, 0, 34, 0));
+            const end = new Date(Date.UTC(2018, 0, 3, 10, 0, 0));
+            assert.equal(formatDateRangeFriendly(start, end, 'America/Chicago', {
+                baseDate,
+                includeTz: false,
+            }), 'yesterday, 6:34pm to Wed, Jan\u00a03, 4am');
+        });
+    });
 });
 //# sourceMappingURL=date.test.js.map

package/dist/date.test.js.map CHANGED Viewed

package/dist/index.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
-export { formatDate, formatDateYMD, formatDateYMDHM, formatTz } from './date.js';
-export { formatInterval } from './interval.js';
+export { formatDate, formatDateFriendly, formatDateRangeFriendly, formatDateWithinRange, formatDateYMD, formatDateYMDHM, formatTz, } from './date.js';
+export { formatInterval, formatIntervalHM, formatIntervalMinutes, formatIntervalRelative, makeInterval, } from './interval.js';

package/dist/index.js CHANGED Viewed

@@ -1,3 +1,3 @@
-export { formatDate, formatDateYMD, formatDateYMDHM, formatTz } from './date.js';
-export { formatInterval } from './interval.js';
+export { formatDate, formatDateFriendly, formatDateRangeFriendly, formatDateWithinRange, formatDateYMD, formatDateYMDHM, formatTz, } from './date.js';
+export { formatInterval, formatIntervalHM, formatIntervalMinutes, formatIntervalRelative, makeInterval, } from './interval.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,~~EAAE~~,UAAU,~~EAAE~~,aAAa,~~EAAE~~,eAAe,~~EAAE~~,QAAQ,~~EAAE~~,MAAM,WAAW,CAAC;~~AACjF~~,OAAO,~~EAAE~~,cAAc,~~EAAE~~,MAAM,eAAe,CAAC","sourcesContent":["export { formatDate, formatDateYMD, formatDateYMDHM, formatTz } from './date.js';\nexport { formatInterval } from './interval.js';\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,QAAQ,GACT,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,YAAY,GACb,MAAM,eAAe,CAAC","sourcesContent":["export {\n formatDate,\n formatDateFriendly,\n formatDateRangeFriendly,\n formatDateWithinRange,\n formatDateYMD,\n formatDateYMDHM,\n formatTz,\n} from './date.js';\nexport {\n formatInterval,\n formatIntervalHM,\n formatIntervalMinutes,\n formatIntervalRelative,\n makeInterval,\n} from './interval.js';\n"]}

package/dist/interval.d.ts CHANGED Viewed

@@ -2,6 +2,20 @@ export declare const SECOND_IN_MILLISECONDS = 1000;
 export declare const MINUTE_IN_MILLISECONDS: number;
 export declare const HOUR_IN_MILLISECONDS: number;
 export declare const DAY_IN_MILLISECONDS: number;
+/**
+ * Makes an interval (in milliseconds).
+ *
+ * @param param.days The number of days in the interval.
+ * @param param.hours The number of hours in the interval.
+ * @param param.minutes The number of minutes in the interval.
+ * @param param.seconds The number of seconds in the interval.
+ */
+export declare function makeInterval({ days, hours, minutes, seconds, }: {
+    days?: number;
+    hours?: number;
+    minutes?: number;
+    seconds?: number;
+}): number;
 /**
  * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.
  *
@@ -9,3 +23,30 @@ export declare const DAY_IN_MILLISECONDS: number;
  * @returns Human-readable string representing the interval.
  */
 export declare function formatInterval(interval: number): string;
+/**
+ * Format an interval (in milliseconds) to a human-readable string like 'Until 6
+ * minutes before the session start time'.
+ *
+ * @param interval Time interval in milliseconds relative to `reference` (positive intervals are after `reference`).
+ * @param prefix The prefix to use, must be 'Until' or 'From' (or lowercase versions of these).
+ * @param reference The reference time, for example 'session start time'.
+ * @returns Human-readable string representing the interval.
+ */
+export declare function formatIntervalRelative(interval: number, prefix: 'Until' | 'until' | 'From' | 'from', reference: string): string;
+/**
+ * Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.
+ *
+ * @param interval Time interval in milliseconds.
+ * @param options.signed Whether to include the sign in the output.
+ * @returns Human-readable string representing the interval in minutes.
+ */
+export declare function formatIntervalHM(interval: number, { signed }?: {
+    signed?: boolean;
+}): string;
+/**
+ * Format an interval (in milliseconds) to a human-readable string with the number of minutes, like '7 minutes' or '1 minute'.
+ *
+ * @param interval Time interval in milliseconds.
+ * @returns Human-readable string representing the interval in minutes.
+ */
+export declare function formatIntervalMinutes(interval: number): string;

package/dist/interval.js CHANGED Viewed

@@ -2,6 +2,17 @@ export const SECOND_IN_MILLISECONDS = 1000;
 export const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;
 export const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 export const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;
+/**
+ * Makes an interval (in milliseconds).
+ *
+ * @param param.days The number of days in the interval.
+ * @param param.hours The number of hours in the interval.
+ * @param param.minutes The number of minutes in the interval.
+ * @param param.seconds The number of seconds in the interval.
+ */
+export function makeInterval({ days = 0, hours = 0, minutes = 0, seconds = 0, }) {
+    return (((days * 24 + hours) * 60 + minutes) * 60 + seconds) * 1000;
+}
 /**
  * Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.
  *
@@ -32,4 +43,56 @@ export function formatInterval(interval) {
     }
     return parts.join(' ');
 }
+/**
+ * Format an interval (in milliseconds) to a human-readable string like 'Until 6
+ * minutes before the session start time'.
+ *
+ * @param interval Time interval in milliseconds relative to `reference` (positive intervals are after `reference`).
+ * @param prefix The prefix to use, must be 'Until' or 'From' (or lowercase versions of these).
+ * @param reference The reference time, for example 'session start time'.
+ * @returns Human-readable string representing the interval.
+ */
+export function formatIntervalRelative(interval, prefix, reference) {
+    if (interval > 0) {
+        return `${prefix} ${formatInterval(interval)} after ${reference}`;
+    }
+    else if (interval < 0) {
+        return `${prefix} ${formatInterval(-interval)} before ${reference}`;
+    }
+    else if (interval === 0) {
+        return `${prefix} ${reference}`;
+    }
+    else {
+        return `Invalid interval: ${interval}`;
+    }
+}
+/**
+ * Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.
+ *
+ * @param interval Time interval in milliseconds.
+ * @param options.signed Whether to include the sign in the output.
+ * @returns Human-readable string representing the interval in minutes.
+ */
+export function formatIntervalHM(interval, { signed = false } = { signed: false }) {
+    const sign = interval < 0 ? '-' : interval > 0 ? (signed ? '+' : '') : '';
+    const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS);
+    const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;
+    return `${sign}${hours.toString().padStart(2, '0')}:${mins.toString().padStart(2, '0')}`;
+}
+/**
+ * Format an interval (in milliseconds) to a human-readable string with the number of minutes, like '7 minutes' or '1 minute'.
+ *
+ * @param interval Time interval in milliseconds.
+ * @returns Human-readable string representing the interval in minutes.
+ */
+export function formatIntervalMinutes(interval) {
+    const sign = interval < 0 ? '-' : '';
+    const minutes = Math.ceil(Math.abs(interval / MINUTE_IN_MILLISECONDS));
+    if (minutes === 1) {
+        return `${sign}1 minute`;
+    }
+    else {
+        return `${sign}${minutes} minutes`;
+    }
+}
 //# sourceMappingURL=interval.js.map

package/dist/interval.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"interval.js","sourceRoot":"","sources":["../src/interval.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAE1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC","sourcesContent":["export const SECOND_IN_MILLISECONDS = 1000;\nexport const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;\nexport const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;\nexport const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;\n\n/*\n Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval.\n */\nexport function formatInterval(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n\n const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;\n\n const parts: string[] = [];\n\n if (days > 0) {\n parts.push(`${sign}${days} d`);\n }\n if (hours > 0) {\n parts.push(`${sign}${hours} h`);\n }\n if (mins > 0) {\n parts.push(`${sign}${mins} min`);\n }\n if (secs > 0) {\n parts.push(`${sign}${secs} s`);\n }\n if (parts.length === 0) {\n parts.push('0 s');\n }\n\n return parts.join(' ');\n}\n"]}
1	+ {"version":3,"file":"interval.js","sourceRoot":"","sources":["../src/interval.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,IAAI,GAAG,CAAC,EACR,KAAK,GAAG,CAAC,EACT,OAAO,GAAG,CAAC,EACX,OAAO,GAAG,CAAC,GAMZ;IACC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAE1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAgB,EAChB,MAA2C,EAC3C,SAAiB;IAEjB,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,SAAS,EAAE,CAAC;IACpE,CAAC;SAAM,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,CAAC,QAAQ,CAAC,WAAW,SAAS,EAAE,CAAC;IACtE,CAAC;SAAM,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,GAAG,MAAM,IAAI,SAAS,EAAE,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,QAAQ,EAAE,CAAC;IACzC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAgB,EAChB,EAAE,MAAM,GAAG,KAAK,KAA2B,EAAE,MAAM,EAAE,KAAK,EAAE;IAE5D,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAgB;IACpD,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC;IACvE,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,GAAG,IAAI,UAAU,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,GAAG,OAAO,UAAU,CAAC;IACrC,CAAC;AACH,CAAC","sourcesContent":["export const SECOND_IN_MILLISECONDS = 1000;\nexport const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;\nexport const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;\nexport const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;\n\n/*\n Makes an interval (in milliseconds).\n \n @param param.days The number of days in the interval.\n * @param param.hours The number of hours in the interval.\n * @param param.minutes The number of minutes in the interval.\n * @param param.seconds The number of seconds in the interval.\n /\nexport function makeInterval({\n days = 0,\n hours = 0,\n minutes = 0,\n seconds = 0,\n}: {\n days?: number;\n hours?: number;\n minutes?: number;\n seconds?: number;\n}): number {\n return (((days 24 + hours) * 60 + minutes) * 60 + seconds) * 1000;\n}\n\n/*\n Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval.\n /\nexport function formatInterval(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n\n const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;\n\n const parts: string[] = [];\n\n if (days > 0) {\n parts.push(`${sign}${days} d`);\n }\n if (hours > 0) {\n parts.push(`${sign}${hours} h`);\n }\n if (mins > 0) {\n parts.push(`${sign}${mins} min`);\n }\n if (secs > 0) {\n parts.push(`${sign}${secs} s`);\n }\n if (parts.length === 0) {\n parts.push('0 s');\n }\n\n return parts.join(' ');\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like 'Until 6\n * minutes before the session start time'.\n \n @param interval Time interval in milliseconds relative to `reference` (positive intervals are after `reference`).\n * @param prefix The prefix to use, must be 'Until' or 'From' (or lowercase versions of these).\n * @param reference The reference time, for example 'session start time'.\n * @returns Human-readable string representing the interval.\n /\nexport function formatIntervalRelative(\n interval: number,\n prefix: 'Until' \| 'until' \| 'From' \| 'from',\n reference: string,\n): string {\n if (interval > 0) {\n return `${prefix} ${formatInterval(interval)} after ${reference}`;\n } else if (interval < 0) {\n return `${prefix} ${formatInterval(-interval)} before ${reference}`;\n } else if (interval === 0) {\n return `${prefix} ${reference}`;\n } else {\n return `Invalid interval: ${interval}`;\n }\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.\n \n @param interval Time interval in milliseconds.\n * @param options.signed Whether to include the sign in the output.\n * @returns Human-readable string representing the interval in minutes.\n /\nexport function formatIntervalHM(\n interval: number,\n { signed = false }: { signed?: boolean } = { signed: false },\n): string {\n const sign = interval < 0 ? '-' : interval > 0 ? (signed ? '+' : '') : '';\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS);\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n return `${sign}${hours.toString().padStart(2, '0')}:${mins.toString().padStart(2, '0')}`;\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string with the number of minutes, like '7 minutes' or '1 minute'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval in minutes.\n */\nexport function formatIntervalMinutes(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n const minutes = Math.ceil(Math.abs(interval / MINUTE_IN_MILLISECONDS));\n if (minutes === 1) {\n return `${sign}1 minute`;\n } else {\n return `${sign}${minutes} minutes`;\n }\n}\n"]}

package/dist/interval.test.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import { assert, describe, it } from 'vitest';
-import { formatInterval } from './interval.js';
+import { formatInterval, formatIntervalHM, formatIntervalMinutes, formatIntervalRelative, makeInterval, } from './interval.js';
 describe('interval formatting', () => {
     describe('formatInterval()', () => {
         it('should handle seconds', () => {
@@ -27,5 +27,70 @@ describe('interval formatting', () => {
             assert.equal(formatInterval(-(((4 * 24 + 3) * 60 + 2) * 60 + 7) * 1000), '-4 d -3 h -2 min -7 s');
         });
     });
+    describe('formatIntervalRelative()', () => {
+        it('should handle positive intervals', () => {
+            assert.equal(formatIntervalRelative(3 * 1000, 'Until', 'the start time'), 'Until 3 s after the start time');
+        });
+        it('should handle negative intervals', () => {
+            assert.equal(formatIntervalRelative(-7 * 60 * 1000, 'From', 'the start time'), 'From 7 min before the start time');
+        });
+        it('should handle zero intervals', () => {
+            assert.equal(formatIntervalRelative(0, 'From', 'the start time'), 'From the start time');
+        });
+    });
+    describe('formatIntervalMinutes()', () => {
+        it('should correctly round up', () => {
+            assert.equal(formatIntervalMinutes(3.2 * 60 * 1000), '4 minutes');
+        });
+        it('should correctly handle 1 minute', () => {
+            assert.equal(formatIntervalMinutes(17 * 1000), '1 minute');
+        });
+        it('should correctly handle zero', () => {
+            assert.equal(formatIntervalMinutes(0), '0 minutes');
+        });
+        it('should correctly handle -1 minute', () => {
+            assert.equal(formatIntervalMinutes(-17 * 1000), '-1 minute');
+        });
+        it('should correctly handle negative intervals', () => {
+            assert.equal(formatIntervalMinutes(-3.2 * 60 * 1000), '-4 minutes');
+        });
+    });
+    describe('formatIntervalHM()', () => {
+        it('should correctly handle postive minutes', () => {
+            assert.equal(formatIntervalHM(3.2 * 60 * 1000), '00:03');
+        });
+        it('should correctly handle postive hours', () => {
+            assert.equal(formatIntervalHM((4 * 60 + 17.8) * 60 * 1000), '04:17');
+        });
+        it('should correctly handle large postive hours', () => {
+            assert.equal(formatIntervalHM((143 * 60 + 17.8) * 60 * 1000), '143:17');
+        });
+        it('should correctly handle an explicit sign', () => {
+            assert.equal(formatIntervalHM((4 * 60 + 17.8) * 60 * 1000, { signed: true }), '+04:17');
+        });
+        it('should correctly handle negative minutes', () => {
+            assert.equal(formatIntervalHM(-3.2 * 60 * 1000), '-00:03');
+        });
+        it('should correctly handle negative hours', () => {
+            assert.equal(formatIntervalHM(-(4 * 60 + 17.8) * 60 * 1000), '-04:17');
+        });
+    });
+    describe('makeInterval()', () => {
+        it('should handle seconds', () => {
+            assert.equal(makeInterval({ seconds: 7 }), 7 * 1000);
+        });
+        it('should handle minutes', () => {
+            assert.equal(makeInterval({ minutes: 2 }), 2 * 60 * 1000);
+        });
+        it('should handle hours', () => {
+            assert.equal(makeInterval({ hours: 3 }), 3 * 60 * 60 * 1000);
+        });
+        it('should handle days', () => {
+            assert.equal(makeInterval({ days: 4 }), 4 * 24 * 60 * 60 * 1000);
+        });
+        it('should default to zero', () => {
+            assert.equal(makeInterval({}), 0);
+        });
+    });
 });
 //# sourceMappingURL=interval.test.js.map