@sme.up/ketchup 8.0.2 → 8.2.0

package/dist/types/managers/kup-dates/kup-dates.d.ts

@@ -1,207 +1,207 @@
-import dayjs from 'dayjs';
-import 'dayjs/locale/es';
-import 'dayjs/locale/fr';
-import 'dayjs/locale/it';
-import 'dayjs/locale/pl';
-import 'dayjs/locale/ru';
-import 'dayjs/locale/zh';
-import { KupComponent } from '../../types/GenericTypes';
-import { KupDateTimeFormatOptionsMonth, KupDatesLocales, KupDatesNormalize } from './kup-dates-declarations';
-/**
- * Handles operations and formatting of dates.
- * @module KupDates
- */
-export declare class KupDates {
-  dayjs: Function;
-  locale: KupDatesLocales;
-  managedComponents: Set<KupComponent>;
-  /**
-   * Initializes KupDates.
-   */
-  constructor(locale?: KupDatesLocales);
-  /**
-   * Sets the locale from the browser or from a given argument.
-   * @returns {string} Locale string.
-   * @see https://github.com/iamkun/dayjs/issues/732
-   */
-  setLocale(locale?: KupDatesLocales): string;
-  /**
-   * @returns {string} The current locale.
-   */
-  getLocale(): string;
-  /**
-   * Gets the available locales.
-   * @returns {Array<KupDatesLocales>} Array of locales' names.
-   */
-  getLocales(): Array<KupDatesLocales>;
-  /**
-   * Gets date format by browser locale
-   * @returns {string} date format pattern, by browser locale
-   */
-  getDateFormat(): string;
-  /**
-   * Gets time format by browser locale
-   * @param {boolean} manageSeconds flag to set seconds managing
-   * @returns {string} time format pattern, by browser locale
-   */
-  getTimeFormat(manageSeconds: boolean): string;
-  /**
-   * Formats the given date.
-   * @param {dayjs.ConfigType} input - Date to be formatted.
-   * @param {string} format - Output format.
-   * @see https://day.js.org/docs/en/display/format
-   */
-  format(input: dayjs.ConfigType, format?: string): string;
-  /**
-   * Gets the time formatted
-   * @param {Date} time time as Date object
-   * @param {boolean} manageSeconds flag to set seconds managing
-   * @return {string} time as string, formatted
-   **/
-  formatTime(time: Date, manageSeconds: boolean): string;
-  /**
-   * Validates the given date.
-   * @param {dayjs.ConfigType} date - Date to be validated.
-   * @param {string} format - Format of the input date.
-   * @param {boolean} strict - Strict parsing requires that the format and input match exactly, including delimiters.
-   * @returns {boolean} Returns whether the argument is a valid date or not.
-   */
-  isValid(date: dayjs.ConfigType, format?: string, strict?: boolean): boolean;
-  /**
-   * Validates the given date as string.
-   * @param {string} value time string, formatted by actual browser locale
-   * @param {boolean} manageSeconds if manage seconds
-   * @returns {boolean} true if time string in input is a valid time
-   */
-  isValidFormattedStringTime(value: string, manageSeconds: boolean): boolean;
-  /**
-   * Converts the input in a Date object.
-   * @param {dayjs.ConfigType} input - Input date.
-   * @param {string} format - Format of the input date.
-   * @returns {Date} Date object.
-   */
-  toDate(input: dayjs.ConfigType, format?: string): Date;
-  /**
-   * Converts the input in a Dayjs object.
-   * @param {dayjs.ConfigType} input - Input date.
-   * @param {string} format - Format of the input date.
-   * @returns {dayjs.Dayjs} Dayjs object.
-   */
-  toDayjs(input: dayjs.ConfigType, format?: string): dayjs.Dayjs;
-  /**
-   * Returns a computed ISO date/time from a partial string.
-   * @param {string} input - Input string containing a partial date/time (i.e.: 011221).
-   * @param {KupDatesNormalize} type - Type of the input string.
-   * @returns {dayjs.Dayjs} Dayjs object of the normalized date.
-   */
-  normalize(input: string, type?: KupDatesNormalize): dayjs.Dayjs;
-  /**
-   * Returns the minimum date from an array of dates.
-   * @param {dayjs.ConfigType[]} dates - Array of dates.
-   * @returns {dayjs.Dayjs} Minimum date.
-   */
-  min(dates: dayjs.ConfigType[]): dayjs.Dayjs;
-  /**
-   * Returns the maximum date from an array of dates.
-   * @param {dayjs.ConfigType[]} dates - Array of dates.
-   * @returns {dayjs.Dayjs} Maximum date.
-   */
-  max(dates: dayjs.ConfigType[]): dayjs.Dayjs;
-  /**
-   * Adds the given amount of time to the input date.
-   * @param {dayjs.ConfigType} input - Input date.
-   * @param {number} value - The value of the addition (i.e.: 7).
-   * @param {dayjs.OpUnitType} unit - The unit of the addition (i.e.: "year").
-   * @returns {dayjs.Dayjs} Computed date.
-   * @see https://day.js.org/docs/en/manipulate/add
-   */
-  add(input: dayjs.ConfigType, value: number, unit?: dayjs.OpUnitType): dayjs.Dayjs;
-  /**
-   * Subtracts the given amount of time from the input date.
-   * @param {dayjs.ConfigType} input - Input date.
-   * @param {number} value - The value of the subtraction (i.e.: 7).
-   * @param {dayjs.OpUnitType} unit - The unit of the subtraction (i.e.: "year").
-   * @returns {dayjs.Dayjs} Computed date.
-   * @see https://day.js.org/docs/en/manipulate/subtract
-   */
-  subtract(input: dayjs.ConfigType, value: number, unit?: dayjs.OpUnitType): dayjs.Dayjs;
-  /**
-   * Gets the month formatted
-   * @param {number} month month id
-   * @param {KupDateTimeFormatOptionsMonth} format format
-   * @returns {string} the month formatted, by browser locale
-   */
-  getMonthAsString(month: number, format: KupDateTimeFormatOptionsMonth): string;
-  /**
-   * Gets the year months formatted
-   * @param {KupDateTimeFormatOptionsMonth} format format
-   * @returns {string[]} the months formatted, by browser locale
-   */
-  getMonthsAsString(format?: KupDateTimeFormatOptionsMonth): string[];
-  /**
-   * Gets the day formatted
-   * @param {Date} date date
-   * @returns {string} the day formatted, by browser locale
-   */
-  getDayAsString(date: Date): string;
-  /**
-   * First day of current week
-   * @param {number} firstDayIndex first day of week index
-   * @returns {Date} the first day of current week
-   */
-  firstDayThisWeek(firstDayIndex?: number): Date;
-  /**
-   * Dates of current week
-   * @param {number} firstDayIndex first day of week index
-   * @returns { startDate: Date; endDate: Date } the dates of current week
-   */
-  thisWeek(firstDayIndex?: number): {
-    startDate: Date;
-    endDate: Date;
-  };
-  /**
-   * Gets the days of current week as string
-   * @param {number} firstDayIndex first day of week index
-   * @returns {string[]} the days of current week as string
-   */
-  getDaysOfWeekAsString(firstDayIndex?: number): string[];
-  /**
-   * Gets the timestamp formatted
-   * @param {string} value date/time as string, formatted ISO
-   * @returns {string} date/time as string, formatted by actual browser locale
-   **/
-  timestampStringToFormattedString(value: string): string;
-  /**
-   * Gets ISO date/time from formatted string, as string
-   * @param {string} value date/time as string, formatted by actual browser locale
-   * @returns {string} date/time as string, formatted ISO
-   **/
-  formattedStringToTimestampString(value: string): string;
-  /**
-   * Gets formatted dateTime as customed ISO (see KupDatesFormats)
-   * @param {string} value time as string, formatted by actual browser locale
-   * @param {string} outputFormat time format to return (see KupDatesFormats)
-   * @param {boolean} manageSeconds flag to set seconds managing
-   * @returns {string} time as string, formatted
-   **/
-  formattedStringToCustomDateTime(value: string, outputFormat: string, manageSeconds: boolean): string;
-  /**
-   * Gets the time formatted
-   * @param {string} value time as string, formatted ISO
-   * @param {boolean} manageSeconds flag to set seconds managing
-   * @param {string} customedFormat time format from smeupObject
-   * @returns {string} time as string, formatted by actual browser locale
-   **/
-  timeStringToFormattedString(value: string, manageSeconds: boolean, customedFormat?: string): string;
-  /**
-   * Registers a KupComponent in KupDates, in order to be properly handled whenever the locale changes.
-   * @param {any} component - The Ketchup component to be registered.
-   */
-  register(component: any): void;
-  /**
-   * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
-   *
-   * @param {any} component - The component calling this function.
-   */
-  unregister(component: any): void;
-}
+import dayjs from 'dayjs';
+import 'dayjs/locale/es';
+import 'dayjs/locale/fr';
+import 'dayjs/locale/it';
+import 'dayjs/locale/pl';
+import 'dayjs/locale/ru';
+import 'dayjs/locale/zh';
+import { KupComponent } from '../../types/GenericTypes';
+import { KupDateTimeFormatOptionsMonth, KupDatesLocales, KupDatesNormalize } from './kup-dates-declarations';
+/**
+ * Handles operations and formatting of dates.
+ * @module KupDates
+ */
+export declare class KupDates {
+  dayjs: Function;
+  locale: KupDatesLocales;
+  managedComponents: Set<KupComponent>;
+  /**
+   * Initializes KupDates.
+   */
+  constructor(locale?: KupDatesLocales);
+  /**
+   * Sets the locale from the browser or from a given argument.
+   * @returns {string} Locale string.
+   * @see https://github.com/iamkun/dayjs/issues/732
+   */
+  setLocale(locale?: KupDatesLocales): string;
+  /**
+   * @returns {string} The current locale.
+   */
+  getLocale(): string;
+  /**
+   * Gets the available locales.
+   * @returns {Array<KupDatesLocales>} Array of locales' names.
+   */
+  getLocales(): Array<KupDatesLocales>;
+  /**
+   * Gets date format by browser locale
+   * @returns {string} date format pattern, by browser locale
+   */
+  getDateFormat(): string;
+  /**
+   * Gets time format by browser locale
+   * @param {boolean} manageSeconds flag to set seconds managing
+   * @returns {string} time format pattern, by browser locale
+   */
+  getTimeFormat(manageSeconds: boolean): string;
+  /**
+   * Formats the given date.
+   * @param {dayjs.ConfigType} input - Date to be formatted.
+   * @param {string} format - Output format.
+   * @see https://day.js.org/docs/en/display/format
+   */
+  format(input: dayjs.ConfigType, format?: string): string;
+  /**
+   * Gets the time formatted
+   * @param {Date} time time as Date object
+   * @param {boolean} manageSeconds flag to set seconds managing
+   * @return {string} time as string, formatted
+   **/
+  formatTime(time: Date, manageSeconds: boolean): string;
+  /**
+   * Validates the given date.
+   * @param {dayjs.ConfigType} date - Date to be validated.
+   * @param {string} format - Format of the input date.
+   * @param {boolean} strict - Strict parsing requires that the format and input match exactly, including delimiters.
+   * @returns {boolean} Returns whether the argument is a valid date or not.
+   */
+  isValid(date: dayjs.ConfigType, format?: string, strict?: boolean): boolean;
+  /**
+   * Validates the given date as string.
+   * @param {string} value time string, formatted by actual browser locale
+   * @param {boolean} manageSeconds if manage seconds
+   * @returns {boolean} true if time string in input is a valid time
+   */
+  isValidFormattedStringTime(value: string, manageSeconds: boolean): boolean;
+  /**
+   * Converts the input in a Date object.
+   * @param {dayjs.ConfigType} input - Input date.
+   * @param {string} format - Format of the input date.
+   * @returns {Date} Date object.
+   */
+  toDate(input: dayjs.ConfigType, format?: string): Date;
+  /**
+   * Converts the input in a Dayjs object.
+   * @param {dayjs.ConfigType} input - Input date.
+   * @param {string} format - Format of the input date.
+   * @returns {dayjs.Dayjs} Dayjs object.
+   */
+  toDayjs(input: dayjs.ConfigType, format?: string): dayjs.Dayjs;
+  /**
+   * Returns a computed ISO date/time from a partial string.
+   * @param {string} input - Input string containing a partial date/time (i.e.: 011221).
+   * @param {KupDatesNormalize} type - Type of the input string.
+   * @returns {dayjs.Dayjs} Dayjs object of the normalized date.
+   */
+  normalize(input: string, type?: KupDatesNormalize): dayjs.Dayjs;
+  /**
+   * Returns the minimum date from an array of dates.
+   * @param {dayjs.ConfigType[]} dates - Array of dates.
+   * @returns {dayjs.Dayjs} Minimum date.
+   */
+  min(dates: dayjs.ConfigType[]): dayjs.Dayjs;
+  /**
+   * Returns the maximum date from an array of dates.
+   * @param {dayjs.ConfigType[]} dates - Array of dates.
+   * @returns {dayjs.Dayjs} Maximum date.
+   */
+  max(dates: dayjs.ConfigType[]): dayjs.Dayjs;
+  /**
+   * Adds the given amount of time to the input date.
+   * @param {dayjs.ConfigType} input - Input date.
+   * @param {number} value - The value of the addition (i.e.: 7).
+   * @param {dayjs.OpUnitType} unit - The unit of the addition (i.e.: "year").
+   * @returns {dayjs.Dayjs} Computed date.
+   * @see https://day.js.org/docs/en/manipulate/add
+   */
+  add(input: dayjs.ConfigType, value: number, unit?: dayjs.ManipulateType): dayjs.Dayjs;
+  /**
+   * Subtracts the given amount of time from the input date.
+   * @param {dayjs.ConfigType} input - Input date.
+   * @param {number} value - The value of the subtraction (i.e.: 7).
+   * @param {dayjs.OpUnitType} unit - The unit of the subtraction (i.e.: "year").
+   * @returns {dayjs.Dayjs} Computed date.
+   * @see https://day.js.org/docs/en/manipulate/subtract
+   */
+  subtract(input: dayjs.ConfigType, value: number, unit?: dayjs.ManipulateType): dayjs.Dayjs;
+  /**
+   * Gets the month formatted
+   * @param {number} month month id
+   * @param {KupDateTimeFormatOptionsMonth} format format
+   * @returns {string} the month formatted, by browser locale
+   */
+  getMonthAsString(month: number, format: KupDateTimeFormatOptionsMonth): string;
+  /**
+   * Gets the year months formatted
+   * @param {KupDateTimeFormatOptionsMonth} format format
+   * @returns {string[]} the months formatted, by browser locale
+   */
+  getMonthsAsString(format?: KupDateTimeFormatOptionsMonth): string[];
+  /**
+   * Gets the day formatted
+   * @param {Date} date date
+   * @returns {string} the day formatted, by browser locale
+   */
+  getDayAsString(date: Date): string;
+  /**
+   * First day of current week
+   * @param {number} firstDayIndex first day of week index
+   * @returns {Date} the first day of current week
+   */
+  firstDayThisWeek(firstDayIndex?: number): Date;
+  /**
+   * Dates of current week
+   * @param {number} firstDayIndex first day of week index
+   * @returns { startDate: Date; endDate: Date } the dates of current week
+   */
+  thisWeek(firstDayIndex?: number): {
+    startDate: Date;
+    endDate: Date;
+  };
+  /**
+   * Gets the days of current week as string
+   * @param {number} firstDayIndex first day of week index
+   * @returns {string[]} the days of current week as string
+   */
+  getDaysOfWeekAsString(firstDayIndex?: number): string[];
+  /**
+   * Gets the timestamp formatted
+   * @param {string} value date/time as string, formatted ISO
+   * @returns {string} date/time as string, formatted by actual browser locale
+   **/
+  timestampStringToFormattedString(value: string): string;
+  /**
+   * Gets ISO date/time from formatted string, as string
+   * @param {string} value date/time as string, formatted by actual browser locale
+   * @returns {string} date/time as string, formatted ISO
+   **/
+  formattedStringToTimestampString(value: string): string;
+  /**
+   * Gets formatted dateTime as customed ISO (see KupDatesFormats)
+   * @param {string} value time as string, formatted by actual browser locale
+   * @param {string} outputFormat time format to return (see KupDatesFormats)
+   * @param {boolean} manageSeconds flag to set seconds managing
+   * @returns {string} time as string, formatted
+   **/
+  formattedStringToCustomDateTime(value: string, outputFormat: string, manageSeconds: boolean): string;
+  /**
+   * Gets the time formatted
+   * @param {string} value time as string, formatted ISO
+   * @param {boolean} manageSeconds flag to set seconds managing
+   * @param {string} customedFormat time format from smeupObject
+   * @returns {string} time as string, formatted by actual browser locale
+   **/
+  timeStringToFormattedString(value: string, manageSeconds: boolean, customedFormat?: string): string;
+  /**
+   * Registers a KupComponent in KupDates, in order to be properly handled whenever the locale changes.
+   * @param {any} component - The Ketchup component to be registered.
+   */
+  register(component: any): void;
+  /**
+   * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
+   *
+   * @param {any} component - The component calling this function.
+   */
+  unregister(component: any): void;
+}

package/dist/types/managers/kup-debug/kup-debug-declarations.d.ts

@@ -1,38 +1,38 @@
-/**
- * Interface for the logs of KupDebug.
- */
-export interface KupDebugLog {
-  category: KupDebugCategory;
-  date: Date;
-  id: string;
-  element: string | Object;
-  message: string;
-}
-/**
- * Interface for printed logs.
- */
-export interface KupDebugLogPrint {
-  [index: string]: {
-    date: string;
-    element: string | Object;
-    message: string;
-  }[];
-}
-/**
- * Category of debug logs.
- */
-export declare enum KupDebugCategory {
-  INFO = "Informational",
-  WARNING = "Warning",
-  ERROR = "Error"
-}
-/**
- * Colors associated with every type of log to be printed.
- */
-export declare enum KupDebugLogColor {
-  'Load' = "green",
-  'Render' = "green",
-  'Resize' = "green",
-  'Misc' = "blue",
-  'Total' = "teal"
-}
+/**
+ * Interface for the logs of KupDebug.
+ */
+export interface KupDebugLog {
+  category: KupDebugCategory;
+  date: Date;
+  id: string;
+  element: string | Object;
+  message: string;
+}
+/**
+ * Interface for printed logs.
+ */
+export interface KupDebugLogPrint {
+  [index: string]: {
+    date: string;
+    element: string | Object;
+    message: string;
+  }[];
+}
+/**
+ * Category of debug logs.
+ */
+export declare enum KupDebugCategory {
+  INFO = "Informational",
+  WARNING = "Warning",
+  ERROR = "Error"
+}
+/**
+ * Colors associated with every type of log to be printed.
+ */
+export declare enum KupDebugLogColor {
+  'Load' = "green",
+  'Render' = "green",
+  'Resize' = "green",
+  'Misc' = "blue",
+  'Total' = "teal"
+}