@leapdevuk/component-toolbox 0.0.128 → 0.0.129

package/dist/components/datepicker/index.d.ts

@@ -4,7 +4,7 @@ export { formatAsDBDate as lctFormatAsDBDate } from './utils';
 export { formatDate as lctFormatDate } from './utils';
 export { formatDateTime as lctFormatDateTime } from './utils';
 export { formatReportDate as lctFormatReportDate } from './utils';
-export { getFormattedLocalDateTime as lctGetFormattedLocalDateTime } from './utils';
+export { convertLocalDateToUTCDateTime as lctConvertLocalDateToUTCDateTime } from './utils';
 export { getLocale as lctGetLocale } from './utils';
 export { parseDate as lctParseDate } from './utils';
 export { utcFormat as lctUTCFormat } from './utils';

package/dist/components/datepicker/utils.d.ts

@@ -170,11 +170,11 @@ export declare const getLocale: (leapContext?: LeapContext) => Locale | undefine
 /**
  * This function formats a date or datetime value into a string based on the provided locale.
  * It supports both date-only and datetime formats, and can handle UTC dates.
- * @param value (string | Date | undefined): The date or datetime value to format.
+ * @param inputValue (string | Date | undefined): The date or datetime value to format.
  * @param locale (Locale | undefined): The locale to use for formatting. If undefined, it will not format the date.
- * @param isUtc (boolean): Whether the date is in UTC format. Defaults to true.
- * @param dateOnly (boolean): Whether to format the value as a date only.
- * @param show24H (boolean): Whether to show the time in 24-hour format. Defaults to false.
+ * @param outputAsUtc (boolean): Whether the date is in UTC format. Defaults to true.
+ * @param outputAsDateOnly (boolean): Whether to format the value as a date only.
+ * @param outputAs24H (boolean): Whether to show the time in 24-hour format. Defaults to false.
  * @returns (string): A formatted date or datetime string. If the input value is invalid or locale is undefined, it returns an empty string.
  * @example
  * ```typescript
@@ -184,7 +184,7 @@ export declare const getLocale: (leapContext?: LeapContext) => Locale | undefine
  *    const formattedInvalid = lctFormatDateTime(undefined, enGB); // Returns ""
  * ```
  */
-export declare const formatDateTime: (value?: string | Date, locale?: Locale, isUtc?: boolean, dateOnly?: boolean, show24H?: boolean) => string;
+export declare const formatDateTime: (inputValue?: string | Date, locale?: Locale, outputAsUtc?: boolean, outputAsDateOnly?: boolean, outputAs24H?: boolean) => string;
 /**
  * This function formats a date string into a report-friendly format based on the provided locale.
  * It handles both ISO date strings and strings in the format "yyyy-MM-dd".
@@ -234,26 +234,22 @@ export declare const formatAsDBDate: (date: Date) => string;
  * This function formats a date or datetime value into a string based on the provided locale.
  * It supports both date-only and datetime formats, and can handle UTC dates.
  * It also allows for formatting the start or end of the day.
- * @param value (string | Date | undefined): The date or datetime value to format.
+ * @param inputValue (string | Date | undefined): The date or datetime value to format.
  * @param locale (Locale | undefined): The locale to use for formatting. If undefined, it will not format the date.
- * @param isUtc (boolean): Whether the date is in UTC format. Defaults to true.
- * @param dateOnly (boolean): Whether to format the value as a date only.
- * @param show24H (boolean): Whether to show the time in 24-hour format. Defaults to false.
- * @param formatString (string): The format string to use for formatting the date. If not provided, it defaults to the locale's short date format.
- * @param formatStartOfDay (boolean): If true, formats the date to the start of the day.
- * @param formatEndOfDay (boolean): If true, formats the date to the end of the day.
+ * @param outputAsStartOfDay (boolean): If true, formats the date to the start of the day.
+ * @param outputAsEndOfDay (boolean): If true, formats the date to the end of the day.
  * @returns  (string): A formatted date or datetime string. If the input value is invalid or locale is undefined, it returns an empty string.
  * @example
  * ```typescript
- *    const formattedDate = getFormattedLocalDateTime(new Date(), enGB, true, false, true); // Returns "01/01/2023 14:30"
- *    const formattedDateTime = getFormattedLocalDateTime("2023-01-01T14:30:00Z", enUS, true, false, false); // Returns "01/01/2023 02:30 PM"
- *    const formattedDateOnly = getFormattedLocalDateTime("2023-01-01", enAU, false, true); // Returns "01/01/2023"
- *    const formattedInvalid = getFormattedLocalDateTime(undefined, enGB); // Returns ""
- *    const formattedStartOfDay = getFormattedLocalDateTime(new Date(), enGB, true, false, true, undefined, true); // Returns "01/01/2023 00:00"
- *    const formattedEndOfDay = getFormattedLocalDateTime(new Date(), enGB, true, false, true, undefined, false, true); // Returns "01/01/2023 23:59"
+ *    const formattedDate = convertLocalDateToUTCDateTime(new Date(), enGB, true, false, true); // Returns "01/01/2023 14:30"
+ *    const formattedDateTime = convertLocalDateToUTCDateTime("2023-01-01T14:30:00Z", enUS, true, false, false); // Returns "01/01/2023 02:30 PM"
+ *    const formattedDateOnly = convertLocalDateToUTCDateTime("2023-01-01", enAU, false, true); // Returns "01/01/2023"
+ *    const formattedInvalid = convertLocalDateToUTCDateTime(undefined, enGB); // Returns ""
+ *    const outputAsStartOfDay = convertLocalDateToUTCDateTime(new Date(), enGB, true, false, true, undefined, true); // Returns "01/01/2023 00:00"
+ *    const outputAsEndOfDay = convertLocalDateToUTCDateTime(new Date(), enGB, true, false, true, undefined, false, true); // Returns "01/01/2023 23:59"
  * ```
  */
-export declare const getFormattedLocalDateTime: (value?: string | Date, locale?: Locale, isUtc?: boolean, dateOnly?: boolean, show24H?: boolean, formatString?: string, formatStartOfDay?: boolean, formatEndOfDay?: boolean) => string;
+export declare const convertLocalDateToUTCDateTime: (inputValue?: string | Date, locale?: Locale, outputAsStartOfDay?: boolean, outputAsEndOfDay?: boolean) => string;
 /**
  * This enum defines the types of buttons available in the dialog.
  * It is used to identify which button was clicked by the user.