@hmcts/opal-frontend-common 0.0.13 → 0.0.14

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

@@ -183,6 +183,24 @@ class DateService {
         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: "19.2.11", ngImport: i0, type: DateService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
     static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.11", ngImport: i0, type: DateService, providedIn: 'root' });
 }

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

@@ -1 +1 @@
-{"version":3,"file":"hmcts-opal-frontend-common-services-date-service.mjs","sources":["../../../projects/opal-frontend-common/services/date-service/date.service.ts","../../../projects/opal-frontend-common/services/date-service/hmcts-opal-frontend-common-services-date-service.ts"],"sourcesContent":["import { Injectable } from '@angular/core';\nimport { DateTime, Duration, DurationLikeObject } from 'luxon';\n\n@Injectable({\n  providedIn: 'root',\n})\nexport class DateService {\n  /**\n   * Calculates the difference in minutes between two DateTime objects.\n   * @param startDate The start date and time.\n   * @param endDate The end date and time.\n   * @returns The difference in minutes between the start and end dates.\n   */\n  public calculateMinutesDifference(startDate: DateTime, endDate: DateTime): number {\n    const minuteDifference = endDate.diff(startDate, 'minutes');\n    return Math.max(0, Math.ceil(minuteDifference.minutes));\n  }\n\n  /**\n   * Converts milliseconds to minutes.\n   * @param milliseconds - The number of milliseconds to convert.\n   * @returns The equivalent number of minutes.\n   */\n  public convertMillisecondsToMinutes(milliseconds: number): number {\n    const minutes = Duration.fromMillis(milliseconds).as('minutes');\n    return Math.max(0, Math.ceil(minutes));\n  }\n\n  /**\n   * Calculates the age based on the given date of birth.\n   * @param dateOfBirth - The date of birth to calculate the age from.\n   * @param format - The format of the date of birth. Defaults to 'dd/MM/yyyy'.\n   * @returns The calculated age.\n   */\n  public calculateAge(dateOfBirth: DateTime | string, format: string = 'dd/MM/yyyy'): number {\n    const date = typeof dateOfBirth === 'string' ? this.getFromFormat(dateOfBirth, format) : dateOfBirth;\n\n    return Math.floor(DateTime.now().diff(date, 'years').years);\n  }\n\n  /**\n   * Checks if a given date is valid.\n   * @param dateInput - The date to be checked. It can be a DateTime object, a string, or null.\n   * @param format - The format of the date string (default: 'dd/MM/yyyy').\n   * @returns A boolean indicating whether the date is valid or not.\n   */\n  public isValidDate(dateInput: DateTime | string | null, format: string = 'dd/MM/yyyy'): boolean {\n    if (dateInput) {\n      const date = typeof dateInput === 'string' ? this.getFromFormat(dateInput, format) : dateInput;\n      return date.isValid;\n    }\n    return false;\n  }\n\n  /**\n   * Returns a string representation of a date subtracted by the given duration.\n   * @param duration A DurationLikeObject representing the amount of time to subtract from the current date.\n   * @returns A string representing the subtracted date in the format specified by the current locale.\n   */\n  public getPreviousDate(duration: DurationLikeObject): string {\n    return DateTime.now().minus(duration).setLocale('en-gb').toLocaleString();\n  }\n\n  /**\n   * Parses a string value into a DateTime object based on the specified format.\n   * @param value - The string value to parse.\n   * @param format - The format of the string value.\n   * @returns A DateTime object representing the parsed value.\n   */\n  public getFromFormat(value: string, format: string): DateTime<true> | DateTime<false> {\n    return DateTime.fromFormat(value, format);\n  }\n\n  /**\n   * Parses a string value into a native JavaScript Date object based on the specified format.\n   * @param value - The string value to parse.\n   * @param format - The format of the string value.\n   * @returns A Date object representing the parsed value, or null if parsing fails.\n   */\n  public getDateFromFormat(value: string, format: string): Date | null {\n    const dateTime = DateTime.fromFormat(value, format);\n    return dateTime.isValid ? dateTime.toJSDate() : null;\n  }\n\n  /**\n   * Converts a DateTime value to a formatted string.\n   *\n   * @param value - The DateTime value to format.\n   * @param format - The format string to apply to the DateTime value.\n   * @returns The formatted string representation of the DateTime value.\n   */\n  public toFormat(value: DateTime<true> | DateTime<false>, format: string): string {\n    return value.toFormat(format);\n  }\n\n  /**\n   * Converts a given Date object to a formatted string based on the specified format.\n   *\n   * @param value - The Date object to be formatted.\n   * @param format - The string format to apply to the Date object.\n   * @returns The formatted date string.\n   */\n  public toDateStringFormat(value: Date, format: string): string {\n    return DateTime.fromJSDate(value).toFormat(format);\n  }\n\n  /**\n   * Converts a string in ISO format to a DateTime object.\n   * @param value - The string value in ISO format.\n   * @returns A DateTime object representing the given value.\n   */\n  public getFromIso(value: string): DateTime {\n    return DateTime.fromISO(value);\n  }\n\n  /**\n   * Returns the current date and time.\n   * @returns {DateTime} The current date and time.\n   */\n  public getDateNow(): DateTime {\n    return DateTime.now();\n  }\n\n  /**\n   * Adds a duration to a given date and returns the result in the specified format.\n   * @param date - The date to which the duration will be added.\n   * @param years - The number of years to add to the date (default: 0).\n   * @param months - The number of months to add to the date (default: 0).\n   * @param weeks - The number of weeks to add to the date (default: 0).\n   * @param days - The number of days to add to the date (default: 0).\n   * @param format - The format in which the resulting date will be returned (default: 'dd/MM/yyyy').\n   * @returns The resulting date in the specified format.\n   */\n  public addDurationToDate(\n    date: string,\n    years: number = 0,\n    months: number = 0,\n    weeks: number = 0,\n    days: number = 0,\n    format: string = 'dd/MM/yyyy',\n  ): string {\n    const dateObj = this.getFromFormat(date, format);\n    const newDate = dateObj.plus({ years, months, weeks, days });\n    return newDate.toFormat(format);\n  }\n\n  /**\n   * Calculates the number of days between two dates.\n   * @param startDate - The start date in the specified format.\n   * @param endDate - The end date in the specified format.\n   * @param format - The format of the dates (default: 'dd/MM/yyyy').\n   * @returns The number of days between the start and end dates.\n   */\n  public calculateDaysBetweenDates(startDate: string, endDate: string, format: string = 'dd/MM/yyyy'): number {\n    const start = this.getFromFormat(startDate, format);\n    const end = this.getFromFormat(endDate, format);\n    const diff = end.diff(start, 'days');\n    return diff.days;\n  }\n\n  /**\n   * Checks if a given date is in the past.\n   * @param date - The date to check.\n   * @param format - The format of the date string. Defaults to 'dd/MM/yyyy'.\n   * @returns True if the date is in the past, false otherwise.\n   */\n  public isDateInThePast(date: string, format: string = 'dd/MM/yyyy'): boolean {\n    return this.getFromFormat(date, format) < DateTime.now();\n  }\n\n  /**\n   * Checks if a given date is in the future.\n   * @param date - The date to check.\n   * @param yearsInTheFuture - Optional. The number of years in the future to compare against. If not provided, the current date is used.\n   * @param format - Optional. The format of the input date. Defaults to 'dd/MM/yyyy'.\n   * @returns True if the date is in the future, false otherwise.\n   */\n  public isDateInTheFuture(date: string, yearsInTheFuture?: number, format: string = 'dd/MM/yyyy'): boolean {\n    const now = DateTime.now();\n    const dateValue = this.getFromFormat(date, format);\n\n    if (yearsInTheFuture) {\n      const futureDate = now.plus({ years: yearsInTheFuture });\n      return dateValue > futureDate;\n    }\n\n    return dateValue > now;\n  }\n\n  /**\n   * Converts a date string from one format to another.\n   *\n   * @param date - The date string to be converted.\n   * @param fromFormat - The format of the input date string.\n   * @param toFormat - The desired format of the output date string.\n   * @returns The date string in the desired format.\n   */\n  public getFromFormatToFormat(date: string, fromFormat: string, toFormat: string): string {\n    return this.getFromFormat(date, fromFormat).toFormat(toFormat);\n  }\n\n  /**\n   * Calculates the number of days between the current date and a given ISO date string.\n   *\n   * @param value - An ISO 8601 formatted date string representing the target date.\n   * @returns The number of days between the current date and the input date.\n   *          Returns 0 if the input date is invalid.\n   */\n  public getDaysAgo(value: string): number {\n    const inputDate = this.getFromIso(value).startOf('day');\n\n    const now = this.getDateNow().startOf('day');\n    return Math.round(now.diff(inputDate, 'days').days);\n  }\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;MAMa,WAAW,CAAA;AACtB;;;;;AAKG;IACI,0BAA0B,CAAC,SAAmB,EAAE,OAAiB,EAAA;QACtE,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;AAC3D,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;;AAGzD;;;;AAIG;AACI,IAAA,4BAA4B,CAAC,YAAoB,EAAA;AACtD,QAAA,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC;AAC/D,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;AAGxC;;;;;AAKG;AACI,IAAA,YAAY,CAAC,WAA8B,EAAE,MAAA,GAAiB,YAAY,EAAA;QAC/E,MAAM,IAAI,GAAG,OAAO,WAAW,KAAK,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,WAAW;AAEpG,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC;;AAG7D;;;;;AAKG;AACI,IAAA,WAAW,CAAC,SAAmC,EAAE,MAAA,GAAiB,YAAY,EAAA;QACnF,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,SAAS;YAC9F,OAAO,IAAI,CAAC,OAAO;;AAErB,QAAA,OAAO,KAAK;;AAGd;;;;AAIG;AACI,IAAA,eAAe,CAAC,QAA4B,EAAA;AACjD,QAAA,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE;;AAG3E;;;;;AAKG;IACI,aAAa,CAAC,KAAa,EAAE,MAAc,EAAA;QAChD,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;;AAG3C;;;;;AAKG;IACI,iBAAiB,CAAC,KAAa,EAAE,MAAc,EAAA;QACpD,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;AACnD,QAAA,OAAO,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,EAAE,GAAG,IAAI;;AAGtD;;;;;;AAMG;IACI,QAAQ,CAAC,KAAuC,EAAE,MAAc,EAAA;AACrE,QAAA,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAG/B;;;;;;AAMG;IACI,kBAAkB,CAAC,KAAW,EAAE,MAAc,EAAA;QACnD,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAGpD;;;;AAIG;AACI,IAAA,UAAU,CAAC,KAAa,EAAA;AAC7B,QAAA,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;;AAGhC;;;AAGG;IACI,UAAU,GAAA;AACf,QAAA,OAAO,QAAQ,CAAC,GAAG,EAAE;;AAGvB;;;;;;;;;AASG;AACI,IAAA,iBAAiB,CACtB,IAAY,EACZ,KAAgB,GAAA,CAAC,EACjB,MAAiB,GAAA,CAAC,EAClB,KAAA,GAAgB,CAAC,EACjB,IAAA,GAAe,CAAC,EAChB,SAAiB,YAAY,EAAA;QAE7B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC;AAChD,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC5D,QAAA,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAGjC;;;;;;AAMG;AACI,IAAA,yBAAyB,CAAC,SAAiB,EAAE,OAAe,EAAE,SAAiB,YAAY,EAAA;QAChG,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;QAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,IAAI;;AAGlB;;;;;AAKG;AACI,IAAA,eAAe,CAAC,IAAY,EAAE,MAAA,GAAiB,YAAY,EAAA;AAChE,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE;;AAG1D;;;;;;AAMG;AACI,IAAA,iBAAiB,CAAC,IAAY,EAAE,gBAAyB,EAAE,SAAiB,YAAY,EAAA;AAC7F,QAAA,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC;QAElD,IAAI,gBAAgB,EAAE;AACpB,YAAA,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;YACxD,OAAO,SAAS,GAAG,UAAU;;QAG/B,OAAO,SAAS,GAAG,GAAG;;AAGxB;;;;;;;AAOG;AACI,IAAA,qBAAqB,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAA;AAC7E,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;;AAGhE;;;;;;AAMG;AACI,IAAA,UAAU,CAAC,KAAa,EAAA;AAC7B,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QAEvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AAC5C,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC;;wGA9M1C,WAAW,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAX,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,WAAW,cAFV,MAAM,EAAA,CAAA;;4FAEP,WAAW,EAAA,UAAA,EAAA,CAAA;kBAHvB,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACLD;;AAEG;;;;"}
+{"version":3,"file":"hmcts-opal-frontend-common-services-date-service.mjs","sources":["../../../projects/opal-frontend-common/services/date-service/date.service.ts","../../../projects/opal-frontend-common/services/date-service/hmcts-opal-frontend-common-services-date-service.ts"],"sourcesContent":["import { Injectable } from '@angular/core';\nimport { DateTime, Duration, DurationLikeObject } from 'luxon';\nimport { IDateRange } from './interfaces/date.service.interface';\n\n@Injectable({\n  providedIn: 'root',\n})\nexport class DateService {\n  /**\n   * Calculates the difference in minutes between two DateTime objects.\n   * @param startDate The start date and time.\n   * @param endDate The end date and time.\n   * @returns The difference in minutes between the start and end dates.\n   */\n  public calculateMinutesDifference(startDate: DateTime, endDate: DateTime): number {\n    const minuteDifference = endDate.diff(startDate, 'minutes');\n    return Math.max(0, Math.ceil(minuteDifference.minutes));\n  }\n\n  /**\n   * Converts milliseconds to minutes.\n   * @param milliseconds - The number of milliseconds to convert.\n   * @returns The equivalent number of minutes.\n   */\n  public convertMillisecondsToMinutes(milliseconds: number): number {\n    const minutes = Duration.fromMillis(milliseconds).as('minutes');\n    return Math.max(0, Math.ceil(minutes));\n  }\n\n  /**\n   * Calculates the age based on the given date of birth.\n   * @param dateOfBirth - The date of birth to calculate the age from.\n   * @param format - The format of the date of birth. Defaults to 'dd/MM/yyyy'.\n   * @returns The calculated age.\n   */\n  public calculateAge(dateOfBirth: DateTime | string, format: string = 'dd/MM/yyyy'): number {\n    const date = typeof dateOfBirth === 'string' ? this.getFromFormat(dateOfBirth, format) : dateOfBirth;\n\n    return Math.floor(DateTime.now().diff(date, 'years').years);\n  }\n\n  /**\n   * Checks if a given date is valid.\n   * @param dateInput - The date to be checked. It can be a DateTime object, a string, or null.\n   * @param format - The format of the date string (default: 'dd/MM/yyyy').\n   * @returns A boolean indicating whether the date is valid or not.\n   */\n  public isValidDate(dateInput: DateTime | string | null, format: string = 'dd/MM/yyyy'): boolean {\n    if (dateInput) {\n      const date = typeof dateInput === 'string' ? this.getFromFormat(dateInput, format) : dateInput;\n      return date.isValid;\n    }\n    return false;\n  }\n\n  /**\n   * Returns a string representation of a date subtracted by the given duration.\n   * @param duration A DurationLikeObject representing the amount of time to subtract from the current date.\n   * @returns A string representing the subtracted date in the format specified by the current locale.\n   */\n  public getPreviousDate(duration: DurationLikeObject): string {\n    return DateTime.now().minus(duration).setLocale('en-gb').toLocaleString();\n  }\n\n  /**\n   * Parses a string value into a DateTime object based on the specified format.\n   * @param value - The string value to parse.\n   * @param format - The format of the string value.\n   * @returns A DateTime object representing the parsed value.\n   */\n  public getFromFormat(value: string, format: string): DateTime<true> | DateTime<false> {\n    return DateTime.fromFormat(value, format);\n  }\n\n  /**\n   * Parses a string value into a native JavaScript Date object based on the specified format.\n   * @param value - The string value to parse.\n   * @param format - The format of the string value.\n   * @returns A Date object representing the parsed value, or null if parsing fails.\n   */\n  public getDateFromFormat(value: string, format: string): Date | null {\n    const dateTime = DateTime.fromFormat(value, format);\n    return dateTime.isValid ? dateTime.toJSDate() : null;\n  }\n\n  /**\n   * Converts a DateTime value to a formatted string.\n   *\n   * @param value - The DateTime value to format.\n   * @param format - The format string to apply to the DateTime value.\n   * @returns The formatted string representation of the DateTime value.\n   */\n  public toFormat(value: DateTime<true> | DateTime<false>, format: string): string {\n    return value.toFormat(format);\n  }\n\n  /**\n   * Converts a given Date object to a formatted string based on the specified format.\n   *\n   * @param value - The Date object to be formatted.\n   * @param format - The string format to apply to the Date object.\n   * @returns The formatted date string.\n   */\n  public toDateStringFormat(value: Date, format: string): string {\n    return DateTime.fromJSDate(value).toFormat(format);\n  }\n\n  /**\n   * Converts a string in ISO format to a DateTime object.\n   * @param value - The string value in ISO format.\n   * @returns A DateTime object representing the given value.\n   */\n  public getFromIso(value: string): DateTime {\n    return DateTime.fromISO(value);\n  }\n\n  /**\n   * Returns the current date and time.\n   * @returns {DateTime} The current date and time.\n   */\n  public getDateNow(): DateTime {\n    return DateTime.now();\n  }\n\n  /**\n   * Adds a duration to a given date and returns the result in the specified format.\n   * @param date - The date to which the duration will be added.\n   * @param years - The number of years to add to the date (default: 0).\n   * @param months - The number of months to add to the date (default: 0).\n   * @param weeks - The number of weeks to add to the date (default: 0).\n   * @param days - The number of days to add to the date (default: 0).\n   * @param format - The format in which the resulting date will be returned (default: 'dd/MM/yyyy').\n   * @returns The resulting date in the specified format.\n   */\n  public addDurationToDate(\n    date: string,\n    years: number = 0,\n    months: number = 0,\n    weeks: number = 0,\n    days: number = 0,\n    format: string = 'dd/MM/yyyy',\n  ): string {\n    const dateObj = this.getFromFormat(date, format);\n    const newDate = dateObj.plus({ years, months, weeks, days });\n    return newDate.toFormat(format);\n  }\n\n  /**\n   * Calculates the number of days between two dates.\n   * @param startDate - The start date in the specified format.\n   * @param endDate - The end date in the specified format.\n   * @param format - The format of the dates (default: 'dd/MM/yyyy').\n   * @returns The number of days between the start and end dates.\n   */\n  public calculateDaysBetweenDates(startDate: string, endDate: string, format: string = 'dd/MM/yyyy'): number {\n    const start = this.getFromFormat(startDate, format);\n    const end = this.getFromFormat(endDate, format);\n    const diff = end.diff(start, 'days');\n    return diff.days;\n  }\n\n  /**\n   * Checks if a given date is in the past.\n   * @param date - The date to check.\n   * @param format - The format of the date string. Defaults to 'dd/MM/yyyy'.\n   * @returns True if the date is in the past, false otherwise.\n   */\n  public isDateInThePast(date: string, format: string = 'dd/MM/yyyy'): boolean {\n    return this.getFromFormat(date, format) < DateTime.now();\n  }\n\n  /**\n   * Checks if a given date is in the future.\n   * @param date - The date to check.\n   * @param yearsInTheFuture - Optional. The number of years in the future to compare against. If not provided, the current date is used.\n   * @param format - Optional. The format of the input date. Defaults to 'dd/MM/yyyy'.\n   * @returns True if the date is in the future, false otherwise.\n   */\n  public isDateInTheFuture(date: string, yearsInTheFuture?: number, format: string = 'dd/MM/yyyy'): boolean {\n    const now = DateTime.now();\n    const dateValue = this.getFromFormat(date, format);\n\n    if (yearsInTheFuture) {\n      const futureDate = now.plus({ years: yearsInTheFuture });\n      return dateValue > futureDate;\n    }\n\n    return dateValue > now;\n  }\n\n  /**\n   * Converts a date string from one format to another.\n   *\n   * @param date - The date string to be converted.\n   * @param fromFormat - The format of the input date string.\n   * @param toFormat - The desired format of the output date string.\n   * @returns The date string in the desired format.\n   */\n  public getFromFormatToFormat(date: string, fromFormat: string, toFormat: string): string {\n    return this.getFromFormat(date, fromFormat).toFormat(toFormat);\n  }\n\n  /**\n   * Calculates the number of days between the current date and a given ISO date string.\n   *\n   * @param value - An ISO 8601 formatted date string representing the target date.\n   * @returns The number of days between the current date and the input date.\n   *          Returns 0 if the input date is invalid.\n   */\n  public getDaysAgo(value: string): number {\n    const inputDate = this.getFromIso(value).startOf('day');\n\n    const now = this.getDateNow().startOf('day');\n    return Math.round(now.diff(inputDate, 'days').days);\n  }\n\n  /**\n   * Returns a date range object with 'from' and 'to' properties.\n   * @param pastDays - The number of days in the past from today.\n   * @param futureDays - The number of days in the future from today.\n   * @param format - The format for the date strings (default: 'yyyy-MM-dd').\n   * @returns An object containing 'from' and 'to' date strings in the specified format.\n   */\n  public getDateRange(pastDays: number = 0, futureDays: number = 0, format: string = 'yyyy-MM-dd'): IDateRange {\n    const dateTo = this.getDateNow().plus({ days: futureDays }).toISODate();\n    const dateFrom = this.getDateNow().minus({ days: pastDays }).toISODate();\n\n    if (!dateTo || !dateFrom) {\n      throw new Error('Invalid date range');\n    }\n\n    return {\n      from: this.toFormat(this.getFromIso(dateFrom), format),\n      to: this.toFormat(this.getFromIso(dateTo), format),\n    };\n  }\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;MAOa,WAAW,CAAA;AACtB;;;;;AAKG;IACI,0BAA0B,CAAC,SAAmB,EAAE,OAAiB,EAAA;QACtE,MAAM,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;AAC3D,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;;AAGzD;;;;AAIG;AACI,IAAA,4BAA4B,CAAC,YAAoB,EAAA;AACtD,QAAA,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC;AAC/D,QAAA,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;;AAGxC;;;;;AAKG;AACI,IAAA,YAAY,CAAC,WAA8B,EAAE,MAAA,GAAiB,YAAY,EAAA;QAC/E,MAAM,IAAI,GAAG,OAAO,WAAW,KAAK,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,WAAW;AAEpG,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC;;AAG7D;;;;;AAKG;AACI,IAAA,WAAW,CAAC,SAAmC,EAAE,MAAA,GAAiB,YAAY,EAAA;QACnF,IAAI,SAAS,EAAE;YACb,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,SAAS;YAC9F,OAAO,IAAI,CAAC,OAAO;;AAErB,QAAA,OAAO,KAAK;;AAGd;;;;AAIG;AACI,IAAA,eAAe,CAAC,QAA4B,EAAA;AACjD,QAAA,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE;;AAG3E;;;;;AAKG;IACI,aAAa,CAAC,KAAa,EAAE,MAAc,EAAA;QAChD,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;;AAG3C;;;;;AAKG;IACI,iBAAiB,CAAC,KAAa,EAAE,MAAc,EAAA;QACpD,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC;AACnD,QAAA,OAAO,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,EAAE,GAAG,IAAI;;AAGtD;;;;;;AAMG;IACI,QAAQ,CAAC,KAAuC,EAAE,MAAc,EAAA;AACrE,QAAA,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAG/B;;;;;;AAMG;IACI,kBAAkB,CAAC,KAAW,EAAE,MAAc,EAAA;QACnD,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAGpD;;;;AAIG;AACI,IAAA,UAAU,CAAC,KAAa,EAAA;AAC7B,QAAA,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;;AAGhC;;;AAGG;IACI,UAAU,GAAA;AACf,QAAA,OAAO,QAAQ,CAAC,GAAG,EAAE;;AAGvB;;;;;;;;;AASG;AACI,IAAA,iBAAiB,CACtB,IAAY,EACZ,KAAgB,GAAA,CAAC,EACjB,MAAiB,GAAA,CAAC,EAClB,KAAA,GAAgB,CAAC,EACjB,IAAA,GAAe,CAAC,EAChB,SAAiB,YAAY,EAAA;QAE7B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC;AAChD,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAC5D,QAAA,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;;AAGjC;;;;;;AAMG;AACI,IAAA,yBAAyB,CAAC,SAAiB,EAAE,OAAe,EAAE,SAAiB,YAAY,EAAA;QAChG,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;QAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,IAAI;;AAGlB;;;;;AAKG;AACI,IAAA,eAAe,CAAC,IAAY,EAAE,MAAA,GAAiB,YAAY,EAAA;AAChE,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE;;AAG1D;;;;;;AAMG;AACI,IAAA,iBAAiB,CAAC,IAAY,EAAE,gBAAyB,EAAE,SAAiB,YAAY,EAAA;AAC7F,QAAA,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC;QAElD,IAAI,gBAAgB,EAAE;AACpB,YAAA,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;YACxD,OAAO,SAAS,GAAG,UAAU;;QAG/B,OAAO,SAAS,GAAG,GAAG;;AAGxB;;;;;;;AAOG;AACI,IAAA,qBAAqB,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAA;AAC7E,QAAA,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;;AAGhE;;;;;;AAMG;AACI,IAAA,UAAU,CAAC,KAAa,EAAA;AAC7B,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;QAEvD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;AAC5C,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC;;AAGrD;;;;;;AAMG;IACI,YAAY,CAAC,WAAmB,CAAC,EAAE,aAAqB,CAAC,EAAE,SAAiB,YAAY,EAAA;AAC7F,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,SAAS,EAAE;AACvE,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE;AAExE,QAAA,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE;AACxB,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;;QAGvC,OAAO;AACL,YAAA,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;AACtD,YAAA,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;SACnD;;wGAnOQ,WAAW,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAX,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,WAAW,cAFV,MAAM,EAAA,CAAA;;4FAEP,WAAW,EAAA,UAAA,EAAA,CAAA;kBAHvB,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACND;;AAEG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hmcts/opal-frontend-common",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "license": "MIT",
   "peerDependencies": {
     "@angular/common": "^18.2.0 || ^19.0.0",

package/services/date-service/date.service.d.ts

@@ -1,4 +1,5 @@
 import { DateTime, DurationLikeObject } from 'luxon';
+import { IDateRange } from './interfaces/date.service.interface';
 import * as i0 from "@angular/core";
 export declare class DateService {
     /**
@@ -126,6 +127,14 @@ export declare class DateService {
      *          Returns 0 if the input date is invalid.
      */
     getDaysAgo(value: string): number;
+    /**
+     * 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?: number, futureDays?: number, format?: string): IDateRange;
     static ɵfac: i0.ɵɵFactoryDeclaration<DateService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DateService>;
 }

package/services/date-service/interfaces/date.service.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IDateRange {
+    to: string;
+    from: string;
+}