@aitronos/freddy-plugins 0.1.36 → 0.1.37

package/dist/index.d.ts

@@ -113,38 +113,121 @@ declare type __VLS_WithTemplateSlots_3<T, S> = T & {
 
 export declare const AdvancedModal: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 
+/**
+ * Calculates the percentage of a partial value relative to a total value.
+ * @param partialValue - The part of the total value.
+ * @param totalValue - The total value.
+ * @returns The percentage as a string with one decimal place.
+ */
 export declare const calculatePercentage: (partialValue: number, totalValue: number) => string;
 
+/**
+ * Creates a deep clone of the provided value, handling circular references.
+ * This function is similar to Lodash's `cloneDeep`.
+ *
+ * @template T - The type of the value being cloned.
+ * @param {T} value - The value to deeply clone.
+ * @returns {T} - Returns the deeply cloned value.
+ */
+export declare function cloneDeepSafe<T>(value: T): T;
+
+/**
+ * Copies the provided text to the clipboard and shows a toast notification.
+ * @param textToCopy - The text to copy to the clipboard.
+ */
 export declare const copyToClipboard: (textToCopy: string) => Promise<void>;
 
 export declare const daysInMonth: number;
 
+/**
+ * Performs a deep comparison between two values to determine if they are equivalent.
+ * This function is similar to Lodash's `isEqual`.
+ *
+ * @template T - The type of the values being compared.
+ * @param {T} a - The first value to compare.
+ * @param {T} b - The second value to compare.
+ * @returns {boolean} - Returns `true` if the values are deeply equal, otherwise `false`.
+ */
 export declare function deepEqual<T>(a: T, b: T): boolean;
 
 export declare const defaultImageSrc = "https://img.freepik.com/premium-vector/default-image-icon-vector-missing-picture-page-website-design-mobile-app-no-photo-available_87543-11093.jpg";
 
+/**
+ * Formats a file size in bytes into a human-readable string.
+ * @param bytes - The file size in bytes.
+ * @param decimals - The number of decimal places to include.
+ * @returns The formatted file size string.
+ */
 export declare const fileSizeFormatter: (bytes: number, decimals?: number) => string;
 
+/**
+ * Fills missing days in a month's data with a default value of 0.
+ * @param month - The month number (1-12).
+ * @param dayData - An array of objects containing day-value pairs.
+ * @returns An object with all days of the month filled.
+ */
 export declare const fillMissingDays: (month: number, dayData: Array<{
     [key: number]: number;
 }>) => {
     [k: string]: number;
 };
 
+/**
+ * Formats a date to a relative format (e.g., "Yesterday" or "DD MMM YYYY").
+ * @param inputDate - The date string or Date object to format.
+ * @returns The formatted date string.
+ */
 export declare function formatDate(inputDate: Date | string): string;
 
+/**
+ * Formats a date string or Date object to a locale string.
+ * @param dateString - The date string or Date object to format.
+ * @returns The formatted date string.
+ */
 export declare function formatDateToLocaleString(dateString: Date | string): string;
 
+/**
+ * Formats the last used date, defaulting to the created date if not provided.
+ * @param inputDate - The last used date string or Date object.
+ * @param createdOnDate - The created date string or Date object.
+ * @returns The formatted date string.
+ */
 export declare function formatLastUsedDate(inputDate: Date | string, createdOnDate?: Date | string): string;
 
+/**
+ * Generates an array of dates for a given month in "day month_name" format.
+ * @param monthNumber - The month number (1-12).
+ * @returns An array of formatted date strings.
+ */
 export declare const getDatesForMonth: (monthNumber: number) => string[];
 
+/**
+ * Gets the number of days in a given month and year.
+ * @param month - The month number (1-12).
+ * @param year - The year.
+ * @returns The number of days in the month.
+ */
 export declare function getDaysInMonth(month: number, year: number): number;
 
+/**
+ * Extracts the file name from a given URL.
+ * @param url - The URL containing the file name.
+ * @returns The extracted file name, or null if not found.
+ */
 export declare function getFileNameFromUrl(url: string): string | null;
 
+/**
+ * Gets the short name of a month by its number.
+ * @param monthNumber - The month number (1-12).
+ * @returns The short month name (e.g., "Jan").
+ */
 export declare const getShortMonthName: (monthNumber: number) => string;
 
+/**
+ * Checks if an element has overflow content.
+ * @param el - The HTML element to check.
+ * @returns True if the element has overflow, otherwise false.
+ */
 export declare function hasOverflow(el: HTMLElement): boolean;
 
 export declare const IconAitronos: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, SVGSVGElement>;
@@ -375,6 +458,13 @@ export declare interface IMenuListItem {
     path: string;
 }
 
+/**
+ * Generates a series of interpolated colors between two colors.
+ * @param start - The starting color in hex format.
+ * @param end - The ending color in hex format.
+ * @param steps - The number of colors to generate in the series.
+ * @returns An array of interpolated colors in hex format.
+ */
 export declare const interpolateColor: (start: string, end: string, steps: number) => string[];
 
 export declare interface ITabList {
@@ -382,11 +472,6 @@ export declare interface ITabList {
     currentTab?: number;
 }
 
-export declare const lineChartExternalTooltipWithCircularDots: (context: {
-    chart: any;
-    tooltip: any;
-}, currentMonth: string) => void;
-
 export declare const ModalBox: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, __VLS_TemplateResult_2["slots"]>;
 
 export declare const ModalOverlay: __VLS_WithTemplateSlots_3<typeof __VLS_component_3, __VLS_TemplateResult_3["slots"]>;
@@ -423,8 +508,17 @@ required: true;
 "onUpdate:currentPage"?: ((...args: any[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, HTMLElement>;
 
+/**
+ * Converts a date to a human-readable format (e.g., "12 Dec 2023 at 12:34").
+ * @param date - The date string or Date object to format.
+ * @returns The formatted date string.
+ */
 export declare function readableDateFormat(date: Date | string): string;
 
+/**
+ * Smoothly scrolls to a target element by its ID.
+ * @param targetElement - The ID of the target element.
+ */
 export declare const scrollToElement: (targetElement: string) => void;
 
 export declare const SearchInput: DefineComponent<ExtractPropTypes<    {