@hmcts/opal-frontend-common 0.0.109 → 0.0.111

package/fesm2022/hmcts-opal-frontend-common-services-date-service.mjs

@@ -1,234 +1,119 @@
-import * as i0 from '@angular/core';
-import { Injectable } from '@angular/core';
-import { Duration, DateTime } from 'luxon';
-
-class DateService {
-    /**
-     * Calculates the difference in minutes between two DateTime objects.
-     * @param startDate The start date and time.
-     * @param endDate The end date and time.
-     * @returns The difference in minutes between the start and end dates.
-     */
-    calculateMinutesDifference(startDate, endDate) {
-        const minuteDifference = endDate.diff(startDate, 'minutes');
-        return Math.max(0, Math.ceil(minuteDifference.minutes));
-    }
-    /**
-     * Converts milliseconds to minutes.
-     * @param milliseconds - The number of milliseconds to convert.
-     * @returns The equivalent number of minutes.
-     */
-    convertMillisecondsToMinutes(milliseconds) {
-        const minutes = Duration.fromMillis(milliseconds).as('minutes');
-        return Math.max(0, Math.ceil(minutes));
-    }
-    /**
-     * Calculates the age based on the given date of birth.
-     * @param dateOfBirth - The date of birth to calculate the age from.
-     * @param format - The format of the date of birth. Defaults to 'dd/MM/yyyy'.
-     * @returns The calculated age.
-     */
-    calculateAge(dateOfBirth, format = 'dd/MM/yyyy') {
-        const date = typeof dateOfBirth === 'string' ? this.getFromFormat(dateOfBirth, format) : dateOfBirth;
-        return Math.floor(DateTime.now().diff(date, 'years').years);
-    }
-    /**
-     * Checks if a given date is valid.
-     * @param dateInput - The date to be checked. It can be a DateTime object, a string, or null.
-     * @param format - The format of the date string (default: 'dd/MM/yyyy').
-     * @returns A boolean indicating whether the date is valid or not.
-     */
-    isValidDate(dateInput, format = 'dd/MM/yyyy') {
-        if (dateInput) {
-            const date = typeof dateInput === 'string' ? this.getFromFormat(dateInput, format) : dateInput;
-            return date.isValid;
-        }
-        return false;
-    }
-    /**
-     * Returns a string representation of a date subtracted by the given duration.
-     * @param duration A DurationLikeObject representing the amount of time to subtract from the current date.
-     * @returns A string representing the subtracted date in the format specified by the current locale.
-     */
-    getPreviousDate(duration) {
-        return DateTime.now().minus(duration).setLocale('en-gb').toLocaleString();
-    }
-    /**
-     * Parses a string value into a DateTime object based on the specified format.
-     * @param value - The string value to parse.
-     * @param format - The format of the string value.
-     * @returns A DateTime object representing the parsed value.
-     */
-    getFromFormat(value, format) {
-        return DateTime.fromFormat(value, format);
-    }
-    /**
-     * Returns an object containing the age and age group based on the date of birth.
-     * @param dateOfBirth - The date of birth to calculate the age from.
-     * @returns An object containing the age value and group ('Adult' or 'Youth') if the date is valid, or null if the date is invalid.
-     */
-    getAgeObject(dateOfBirth) {
-        if (this.isValidDate(dateOfBirth)) {
-            const age = this.calculateAge(dateOfBirth);
-            return {
-                value: age,
-                group: age >= 18 ? 'Adult' : 'Youth',
-            };
-        }
-        return null;
-    }
-    /**
-     * Parses a string value into a native JavaScript Date object based on the specified format.
-     * @param value - The string value to parse.
-     * @param format - The format of the string value.
-     * @returns A Date object representing the parsed value, or null if parsing fails.
-     */
-    getDateFromFormat(value, format) {
-        const dateTime = DateTime.fromFormat(value, format);
-        return dateTime.isValid ? dateTime.toJSDate() : null;
-    }
-    /**
-     * Converts a DateTime value to a formatted string.
-     *
-     * @param value - The DateTime value to format.
-     * @param format - The format string to apply to the DateTime value.
-     * @returns The formatted string representation of the DateTime value.
-     */
-    toFormat(value, format) {
-        return value.toFormat(format);
-    }
-    /**
-     * Converts a given Date object to a formatted string based on the specified format.
-     *
-     * @param value - The Date object to be formatted.
-     * @param format - The string format to apply to the Date object.
-     * @returns The formatted date string.
-     */
-    toDateStringFormat(value, format) {
-        return DateTime.fromJSDate(value).toFormat(format);
-    }
-    /**
-     * Converts a string in ISO format to a DateTime object.
-     * @param value - The string value in ISO format.
-     * @returns A DateTime object representing the given value.
-     */
-    getFromIso(value) {
-        return DateTime.fromISO(value);
-    }
-    /**
-     * Returns the current date and time.
-     * @returns {DateTime} The current date and time.
-     */
-    getDateNow() {
-        return DateTime.now();
-    }
-    /**
-     * Adds a duration to a given date and returns the result in the specified format.
-     * @param date - The date to which the duration will be added.
-     * @param years - The number of years to add to the date (default: 0).
-     * @param months - The number of months to add to the date (default: 0).
-     * @param weeks - The number of weeks to add to the date (default: 0).
-     * @param days - The number of days to add to the date (default: 0).
-     * @param format - The format in which the resulting date will be returned (default: 'dd/MM/yyyy').
-     * @returns The resulting date in the specified format.
-     */
-    addDurationToDate(date, years = 0, months = 0, weeks = 0, days = 0, format = 'dd/MM/yyyy') {
-        const dateObj = this.getFromFormat(date, format);
-        const newDate = dateObj.plus({ years, months, weeks, days });
-        return newDate.toFormat(format);
-    }
-    /**
-     * Calculates the number of days between two dates.
-     * @param startDate - The start date in the specified format.
-     * @param endDate - The end date in the specified format.
-     * @param format - The format of the dates (default: 'dd/MM/yyyy').
-     * @returns The number of days between the start and end dates.
-     */
-    calculateDaysBetweenDates(startDate, endDate, format = 'dd/MM/yyyy') {
-        const start = this.getFromFormat(startDate, format);
-        const end = this.getFromFormat(endDate, format);
-        const diff = end.diff(start, 'days');
-        return diff.days;
-    }
-    /**
-     * Checks if a given date is in the past.
-     * @param date - The date to check.
-     * @param format - The format of the date string. Defaults to 'dd/MM/yyyy'.
-     * @returns True if the date is in the past, false otherwise.
-     */
-    isDateInThePast(date, format = 'dd/MM/yyyy') {
-        return this.getFromFormat(date, format) < DateTime.now();
-    }
-    /**
-     * Checks if a given date is in the future.
-     * @param date - The date to check.
-     * @param yearsInTheFuture - Optional. The number of years in the future to compare against. If not provided, the current date is used.
-     * @param format - Optional. The format of the input date. Defaults to 'dd/MM/yyyy'.
-     * @returns True if the date is in the future, false otherwise.
-     */
-    isDateInTheFuture(date, yearsInTheFuture, format = 'dd/MM/yyyy') {
-        const now = DateTime.now();
-        const dateValue = this.getFromFormat(date, format);
-        if (yearsInTheFuture) {
-            const futureDate = now.plus({ years: yearsInTheFuture });
-            return dateValue > futureDate;
-        }
-        return dateValue > now;
-    }
-    /**
-     * Converts a date string from one format to another.
-     *
-     * @param date - The date string to be converted.
-     * @param fromFormat - The format of the input date string.
-     * @param toFormat - The desired format of the output date string.
-     * @returns The date string in the desired format.
-     */
-    getFromFormatToFormat(date, fromFormat, toFormat) {
-        return this.getFromFormat(date, fromFormat).toFormat(toFormat);
-    }
-    /**
-     * Calculates the number of days between the current date and a given ISO date string.
-     *
-     * @param value - An ISO 8601 formatted date string representing the target date.
-     * @returns The number of days between the current date and the input date.
-     *          Returns 0 if the input date is invalid.
-     */
-    getDaysAgo(value) {
-        const inputDate = this.getFromIso(value).startOf('day');
-        const now = this.getDateNow().startOf('day');
-        return Math.round(now.diff(inputDate, 'days').days);
-    }
-    /**
-     * Returns a date range object with 'from' and 'to' properties.
-     * @param pastDays - The number of days in the past from today.
-     * @param futureDays - The number of days in the future from today.
-     * @param format - The format for the date strings (default: 'yyyy-MM-dd').
-     * @returns An object containing 'from' and 'to' date strings in the specified format.
-     */
-    getDateRange(pastDays = 0, futureDays = 0, format = 'yyyy-MM-dd') {
-        const dateTo = this.getDateNow().plus({ days: futureDays }).toISODate();
-        const dateFrom = this.getDateNow().minus({ days: pastDays }).toISODate();
-        if (!dateTo || !dateFrom) {
-            throw new Error('Invalid date range');
-        }
-        return {
-            from: this.toFormat(this.getFromIso(dateFrom), format),
-            to: this.toFormat(this.getFromIso(dateTo), format),
-        };
-    }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.23", ngImport: i0, type: DateService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
-    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.23", ngImport: i0, type: DateService, providedIn: 'root' });
-}
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.23", ngImport: i0, type: DateService, decorators: [{
-            type: Injectable,
-            args: [{
-                    providedIn: 'root',
-                }]
-        }] });
-
-/**
- * Generated bundle index. Do not edit.
- */
-
+import * as i0 from "@angular/core";
+import { Injectable } from "@angular/core";
+import { DateTime, Duration } from "luxon";
+var DateService = class DateService {
+	calculateMinutesDifference(startDate, endDate) {
+		const minuteDifference = endDate.diff(startDate, "minutes");
+		return Math.max(0, Math.ceil(minuteDifference.minutes));
+	}
+	convertMillisecondsToMinutes(milliseconds) {
+		const minutes = Duration.fromMillis(milliseconds).as("minutes");
+		return Math.max(0, Math.ceil(minutes));
+	}
+	calculateAge(dateOfBirth, format = "dd/MM/yyyy") {
+		const date = typeof dateOfBirth === "string" ? this.getFromFormat(dateOfBirth, format) : dateOfBirth;
+		return Math.floor(DateTime.now().diff(date, "years").years);
+	}
+	isValidDate(dateInput, format = "dd/MM/yyyy") {
+		if (dateInput) return (typeof dateInput === "string" ? this.getFromFormat(dateInput, format) : dateInput).isValid;
+		return false;
+	}
+	getPreviousDate(duration) {
+		return DateTime.now().minus(duration).setLocale("en-gb").toLocaleString();
+	}
+	getFromFormat(value, format) {
+		return DateTime.fromFormat(value, format);
+	}
+	getAgeObject(dateOfBirth) {
+		if (this.isValidDate(dateOfBirth)) {
+			const age = this.calculateAge(dateOfBirth);
+			return {
+				value: age,
+				group: age >= 18 ? "Adult" : "Youth"
+			};
+		}
+		return null;
+	}
+	getDateFromFormat(value, format) {
+		const dateTime = DateTime.fromFormat(value, format);
+		return dateTime.isValid ? dateTime.toJSDate() : null;
+	}
+	toFormat(value, format) {
+		return value.toFormat(format);
+	}
+	toDateStringFormat(value, format) {
+		return DateTime.fromJSDate(value).toFormat(format);
+	}
+	getFromIso(value) {
+		return DateTime.fromISO(value);
+	}
+	getDateNow() {
+		return DateTime.now();
+	}
+	addDurationToDate(date, years = 0, months = 0, weeks = 0, days = 0, format = "dd/MM/yyyy") {
+		return this.getFromFormat(date, format).plus({
+			years,
+			months,
+			weeks,
+			days
+		}).toFormat(format);
+	}
+	calculateDaysBetweenDates(startDate, endDate, format = "dd/MM/yyyy") {
+		const start = this.getFromFormat(startDate, format);
+		return this.getFromFormat(endDate, format).diff(start, "days").days;
+	}
+	isDateInThePast(date, format = "dd/MM/yyyy") {
+		return this.getFromFormat(date, format) < DateTime.now();
+	}
+	isDateInTheFuture(date, yearsInTheFuture, format = "dd/MM/yyyy") {
+		const now = DateTime.now();
+		const dateValue = this.getFromFormat(date, format);
+		if (yearsInTheFuture) return dateValue > now.plus({ years: yearsInTheFuture });
+		return dateValue > now;
+	}
+	getFromFormatToFormat(date, fromFormat, toFormat) {
+		return this.getFromFormat(date, fromFormat).toFormat(toFormat);
+	}
+	getDaysAgo(value) {
+		const inputDate = this.getFromIso(value).startOf("day");
+		const now = this.getDateNow().startOf("day");
+		return Math.round(now.diff(inputDate, "days").days);
+	}
+	getDateRange(pastDays = 0, futureDays = 0, format = "yyyy-MM-dd") {
+		const dateTo = this.getDateNow().plus({ days: futureDays }).toISODate();
+		const dateFrom = this.getDateNow().minus({ days: pastDays }).toISODate();
+		if (!dateTo || !dateFrom) throw new Error("Invalid date range");
+		return {
+			from: this.toFormat(this.getFromIso(dateFrom), format),
+			to: this.toFormat(this.getFromIso(dateTo), format)
+		};
+	}
+	static ɵfac = i0.ɵɵngDeclareFactory({
+		minVersion: "12.0.0",
+		version: "21.2.25",
+		ngImport: i0,
+		type: DateService,
+		deps: [],
+		target: i0.ɵɵFactoryTarget.Injectable
+	});
+	static ɵprov = i0.ɵɵngDeclareInjectable({
+		minVersion: "12.0.0",
+		version: "21.2.25",
+		ngImport: i0,
+		type: DateService,
+		providedIn: "root"
+	});
+};
+i0.ɵɵngDeclareClassMetadata({
+	minVersion: "12.0.0",
+	version: "21.2.25",
+	ngImport: i0,
+	type: DateService,
+	decorators: [{
+		type: Injectable,
+		args: [{ providedIn: "root" }]
+	}]
+});
 export { DateService };
-//# sourceMappingURL=hmcts-opal-frontend-common-services-date-service.mjs.map
+
+//# sourceMappingURL=hmcts-opal-frontend-common-services-date-service.mjs.map