coer-elements 2.0.21 → 2.0.23

package/tools/lib/coer-alert/coer-alert.component.d.ts

@@ -1,23 +1,21 @@
 import * as i0 from "@angular/core";
 export declare class CoerAlert {
-    /** */
+    /** Use this alert to issue a success message */
     Success(message?: string | null, title?: string | null, icon?: string | null, autohide?: number | null): void;
-    /** */
+    /** Use this alert to issue a error or danger */
     Error(message?: string | null, title?: string | null, icon?: string | null, autohide?: number | null): void;
-    /** */
+    /** Use this alert to broadcast an informational message */
     Info(message?: string | null, title?: string | null, icon?: string | null, autohide?: number | null): void;
-    /** */
+    /** Use this alert to issue a warning message */
     Warning(message?: string | null, title?: string | null, icon?: string | null, autohide?: number | null): void;
-    /** */
-    protected Close(alert: 'alert-success' | 'alert-error' | 'alert-info' | 'alert-warning'): Promise<void>;
-    /** */
+    /** Use this alert to confirm a user action */
     Confirm(message?: string, alertType?: 'warning' | 'danger' | 'success' | 'info', icon?: string | null): Promise<boolean>;
     /** */
-    private SetIcon;
+    protected _Close(alert: 'alert-success' | 'alert-error' | 'alert-info' | 'alert-warning'): Promise<void>;
     /** */
-    private SetAutoHide;
+    private _SetIcon;
     /** */
-    private GetIcon;
+    private _SetAutoHide;
     static ɵfac: i0.ɵɵFactoryDeclaration<CoerAlert, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CoerAlert, "coer-alert", never, {}, {}, never, never, true, never>;
 }

package/tools/lib/coer-grid.templates.d.ts

@@ -1,11 +1,11 @@
 import { IGridCoerSwitch, IGridCoerTextBox, IGridItem } from "coer-elements/interfaces";
 export declare const GridTemplates: {
-    /** Template for boolean property */
+    /** Set Active/Disabled values, template for boolean property */
     isActiveTemplate: (item: IGridItem<any>) => string;
-    /** Template for boolean property */
+    /** Enable switch by row, template for boolean property */
     coerSwitchTemplate: (item: IGridItem<any>) => IGridCoerSwitch;
-    /** Template for text property */
+    /** Enable textbox by row, template for text property */
     coerTextboxTemplate: (item: IGridItem<any>) => IGridCoerTextBox;
-    /** Template for text property */
+    /** Template for icons */
     coerIconTemplate: (icon: string, color?: string) => string;
 };

package/tools/lib/collections.tools.d.ts

@@ -0,0 +1,13 @@
+/** Provides several methods for collection manipulation */
+export declare class Collections {
+    /** Set an index and concat more arrays of the same type */
+    static SetIndex<T>(array: T[], ...args: T[][]): T[];
+    /** Sort an array in ascending order by property */
+    static SortBy<T>(array: T[], property: string, propertyType?: 'string' | 'number'): T[];
+    /** Sort an array in descending order by property */
+    static SortByDesc<T>(array: T[], property: string, propertyType?: 'string' | 'number'): T[];
+    /** */
+    static Distinct<T>(array: T[], ...args: T[][]): T[];
+    /** */
+    static Except<T>(array: T[], filter: any[], ...properties: string[]): T[];
+}

package/tools/lib/colors.tools.d.ts

@@ -1,11 +1,16 @@
 import { IActionColors, IAppColors, IFixedColors } from "coer-elements/interfaces";
+/** class to work with colors */
 export declare class Colors {
+    /** Provides the fixed colors set by the coer-elements library */
     static get fixedColors(): IFixedColors;
+    /** Provides the action colors set in the application */
     static get actionColors(): IActionColors;
+    /** Provides the colors of the application */
     static get appColors(): IAppColors;
-    static ToHexadecimal(r: number, g: number, b: number, a?: number): string;
+    /** Get Hexadecimal color */
+    static ToHexadecimal(red: number, green: number, blue: number, alpha?: number): string;
     /** Returns a random color in hexadecimal
     public static GetRandomColorHex = (): string => "#xxxxxx".replace(/x/g, () => (Math.random() * 16 | 0).toString(16)); */
     /** Returns the number of colors requested */
-    static GetColorHexList(quantity: number): string[];
+    static GetColorList(quantity: number): string[];
 }

package/tools/lib/control-value.tools.d.ts

@@ -4,22 +4,23 @@ export declare const CONTROL_VALUE: <T>(component: T) => {
     useExisting: import("@angular/core").Type<any>;
     multi: boolean;
 };
-export declare class ControlValue implements ControlValueAccessor {
-    protected _value: any;
+/** Implements the ControlValueAccessor interface to build a components */
+export declare abstract class ControlValue implements ControlValueAccessor {
     private _isTouched;
-    protected _UpdateValue: Function;
     private _IsTouched;
+    protected _UpdateValue: Function;
+    /** Current value of the component */
+    protected _value: any;
+    /** Property to validate if the component has been touched */
     get isTouched(): boolean;
-    /** */
-    protected SetValue(value: any): void;
-    /** */
-    SetTouched(isTouched: boolean): void;
-    /** */
+    /** Sets the value of the component when it is created */
     writeValue(value: any): void;
-    /** */
+    /** Sets the value of the component when it is updated */
     registerOnChange(callback: Function): void;
-    /** */
+    /** Sets the component's touched status when it is updated */
     registerOnTouched(callback: Function): void;
-    /** */
-    setDisabledState(isDisabled: boolean): void;
+    /** Sets the value of the component */
+    protected SetValue(value: any): void;
+    /** Sets whether the component has been touched */
+    SetTouched(isTouched: boolean): void;
 }

package/tools/lib/date-time.tools.d.ts

@@ -1,14 +1,15 @@
 import moment from "moment";
-export declare class DateTime {
+/** Provides several methods for dates manipulation */
+export declare class Dates {
     /** Get UTC Offset */
     static GetOffset(): number;
     /** YYYY-MM-DD HH:mm:ss */
     static GetCurrentDateTime(): string;
     /** YYYY-MM-DD HH:mm:ss */
     static GetFormatDB(date: string | Date | moment.Moment): string;
-    /** Convert UTC Date to Local Zone */
+    /** Convert UTC Date to Local Zone. YYYY-MM-DD HH:mm:ss */
     static ToLocalZone(date: string | Date | moment.Moment): string;
-    /** Convert Local Zone Date to UTC */
+    /** Convert Local Zone Date to UTC. YYYY-MM-DD HH:mm:ss */
     static ToUTC(date: string | Date | moment.Moment): string;
     /** MMM, DD YYYY */
     static GetDateFormat(date: string | Date | moment.Moment): string;
@@ -16,8 +17,8 @@ export declare class DateTime {
     static GetDateTimeFormat(date: string | Date | moment.Moment): string;
     /** */
     static IsValidDate(date: string | Date | moment.Moment): boolean;
-    /** */
-    static SetFirstHour(date?: string | Date | moment.Moment, format?: 'database' | 'display'): string;
-    /** */
-    static SetLastHour(date?: string | Date | moment.Moment, format?: 'database' | 'display'): string;
+    /** YYYY-MM-DD HH:mm:ss */
+    static SetFirstHour(date: string | Date | moment.Moment): string;
+    /** YYYY-MM-DD HH:mm:ss */
+    static SetLastHour(date: string | Date | moment.Moment): string;
 }

package/tools/lib/files.tools.d.ts

@@ -2,7 +2,7 @@ export declare class Files {
     static readonly EXCEL_EXTENSIONS: string[];
     /** Get Extension File */
     static GetExtension(file: File): string | null;
-    /** Is Excel File */
+    /** */
     static IsExcel(file: File): boolean;
     /** Read excel file */
     static ReadExcel<T>(file: File): Promise<{

package/tools/lib/{elements-html.tools.d.ts → html-elements.tools.d.ts}

@@ -1,16 +1,16 @@
-export declare class ElementsHTML {
+export declare class HTMLElements {
     /** */
     static GetElement: (selector: string) => HTMLElement | null;
     /** */
-    static GetCssValueBy: (selector: string, style: string) => string;
+    static GetCssValueBySelector: (selector: string, style: string) => string;
     /** */
-    static GetCssValue: (element: Element | null, style: string) => string;
-    /** Get width in px */
+    static GetCssValue: (element: HTMLElement | null, style: string) => string;
+    /** Gets the width of the element in px */
     static GetElementWidth: (element: HTMLElement | null | undefined, ...args: (number | HTMLElement | null | undefined)[]) => string;
-    /** Get height in px */
+    /** Gets the height of the element in px */
     static GetElementHeight: (element: HTMLElement | null | undefined, ...args: (number | HTMLElement | null | undefined)[]) => string;
     /** */
     static IsInvalidElement: (element: any) => boolean;
-    /** Get color in hexadecimal format */
+    /** Gets the color of the element in hexadecimal */
     static GetElementColor: (element: HTMLElement | null | undefined) => string;
 }

package/tools/lib/numbers.tools.d.ts

@@ -0,0 +1,9 @@
+/** Provides several methods for string manipulation */
+export declare class Numbers {
+    /** Validates if the value is a numeric type */
+    static IsNumber(value: any): boolean;
+    /** Validates if the value isn't a numeric type */
+    static IsNotNumber(value: any): boolean;
+    /** Return a string with numeric format */
+    static GetNumericFormat(value: string | number | null | undefined, decimals?: number): string;
+}

package/tools/lib/page.tools.d.ts

@@ -3,10 +3,10 @@ import { AfterViewInit, OnDestroy } from '@angular/core';
 import { IBreadcrumb, IGoBack } from 'coer-elements/interfaces';
 import { CoerAlert } from './coer-alert/coer-alert.component';
 import * as i0 from "@angular/core";
-export declare class Page implements AfterViewInit, OnDestroy {
+export declare abstract class Page implements AfterViewInit, OnDestroy {
     protected readonly alert: CoerAlert;
     protected readonly router: Router;
-    private readonly activatedRoute;
+    private readonly __activatedRoute;
     /** */
     protected isUpdate: boolean;
     /** */
@@ -29,10 +29,10 @@ export declare class Page implements AfterViewInit, OnDestroy {
     protected pageFilters: any;
     /** */
     protected goBack: IGoBack;
-    private _path;
-    private _page;
-    private _source;
-    private _preventDestroy;
+    private __path;
+    private __page;
+    private __source;
+    private __preventDestroy;
     constructor(page: string);
     ngAfterViewInit(): Promise<void>;
     ngOnDestroy(): void;
@@ -68,18 +68,16 @@ export declare class Page implements AfterViewInit, OnDestroy {
     private __GetPageFilter;
     /** */
     protected RemovePageFilter(): void;
-    /** */
-    protected Log(value: any, log?: string | null): void;
-    protected isActiveTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => string;
-    protected coerSwitchTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => import("coer-elements/interfaces").IGridCoerSwitch;
-    protected coerTextboxTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => import("coer-elements/interfaces").IGridCoerTextBox;
-    protected coerIconTemplate: (icon: string, color?: string) => string;
+    /** Emit a console.log() */
+    protected Log(value: any, logName?: string | null): void;
+    /** Returns true if the value is null or undefined, false otherwise */
     protected IsNull: (value: any) => boolean;
+    /** Returns true if the value is not null or undefined, false otherwise */
     protected IsNotNull: (value: any) => boolean;
+    /** Returns true if the value is null or undefined or is an empty string or contains only whitespace, false otherwise */
     protected IsOnlyWhiteSpace: (value: any) => boolean;
+    /** Returns true if it has a string value and is not all whitespace, false otherwise */
     protected IsNotOnlyWhiteSpace: (value: any) => boolean;
-    protected Sleep: (milliseconds?: number, reference?: string | null) => Promise<void>;
-    protected IsInvalidElement: (element: any) => boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<Page, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Page, "ng-component", never, {}, {}, never, never, true, never>;
 }

package/tools/lib/screen.tools.d.ts

@@ -1,13 +1,18 @@
 import { IScreenSize } from "coer-elements/interfaces";
 import { Observable } from "rxjs";
 export declare class Screen {
+    /** Gets the width of the browser window */
     static get WINDOW_WIDTH(): number;
+    /** Gets the height of the screen window */
     static get WINDOW_HEIGHT(): number;
+    /** Gets the width of the device screen */
     static get DEVICE_WIDTH(): number;
+    /** Gets the height of the device screen */
     static get DEVICE_HEIGHT(): number;
+    /** gets the breakpoint based on the width of the browsing window */
     static get BREAKPOINT(): 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
-    /** */
+    /** Provides an observable for screen resizing */
     static Resize: Observable<IScreenSize>;
-    /** */
+    /** Provides an observable for the browser buttons */
     static BackButtonBrowser: Observable<string>;
 }

package/tools/lib/section.tools.d.ts

@@ -1,34 +1,43 @@
-import { Router } from '@angular/router';
 import { AfterViewInit, OnDestroy } from '@angular/core';
 import { CoerAlert } from './coer-alert/coer-alert.component';
+import { Router } from '@angular/router';
 import * as i0 from "@angular/core";
-export declare class Section<T> implements AfterViewInit, OnDestroy {
+/** Use this component to extend the functionality of a page section. */
+export declare abstract class Section<T> implements AfterViewInit, OnDestroy {
+    /** */
     protected readonly alert: CoerAlert;
+    /** */
     protected readonly router: Router;
+    /** */
     isLoading: import("@angular/core").InputSignal<boolean>;
+    /** */
     isUpdate: import("@angular/core").InputSignal<boolean>;
+    /** */
     onReady: import("@angular/core").OutputEmitterRef<void>;
+    /** */
     onDestroy: import("@angular/core").OutputEmitterRef<any>;
+    /** */
     onIsLoading: import("@angular/core").OutputEmitterRef<boolean>;
+    /** */
     onUpdated: import("@angular/core").OutputEmitterRef<T | null>;
+    /** */
     protected enableAnimations: boolean;
+    /** */
     protected isReadySection: boolean;
     ngAfterViewInit(): Promise<void>;
     ngOnDestroy(): void;
     /** Main method. Starts after ngAfterViewInit() */
     protected RunSection(): void;
-    /** */
-    protected Log(value: any, log?: string | null): void;
-    protected isActiveTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => string;
-    protected coerSwitchTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => import("coer-elements/interfaces").IGridCoerSwitch;
-    protected coerTextboxTemplate: (item: import("coer-elements/interfaces").IGridItem<any>) => import("coer-elements/interfaces").IGridCoerTextBox;
-    protected coerIconTemplate: (icon: string, color?: string) => string;
+    /** Emit a console.log() */
+    protected Log(value: any, logName?: string | null): void;
+    /** Returns true if the value is null or undefined, false otherwise */
     protected IsNull: (value: any) => boolean;
+    /** Returns true if the value is not null or undefined, false otherwise */
     protected IsNotNull: (value: any) => boolean;
+    /** Returns true if the value is null or undefined or is an empty string or contains only whitespace, false otherwise */
     protected IsOnlyWhiteSpace: (value: any) => boolean;
+    /** Returns true if it has a string value and is not all whitespace, false otherwise */
     protected IsNotOnlyWhiteSpace: (value: any) => boolean;
-    protected Sleep: (milliseconds?: number, reference?: string | null) => Promise<void>;
-    protected IsInvalidElement: (element: any) => boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<Section<any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Section<any>, "ng-component", never, { "isLoading": { "alias": "isLoading"; "required": false; "isSignal": true; }; "isUpdate": { "alias": "isUpdate"; "required": false; "isSignal": true; }; }, { "onReady": "onReady"; "onDestroy": "onDestroy"; "onIsLoading": "onIsLoading"; "onUpdated": "onUpdated"; }, never, never, true, never>;
 }

package/tools/lib/service.tools.d.ts

@@ -2,10 +2,11 @@ import { HttpClient } from "@angular/common/http";
 import { CoerAlert } from "./coer-alert/coer-alert.component";
 import { IHttpRequest, IHttpResponse } from "coer-elements/interfaces";
 import { Subscription } from "rxjs";
-export declare class Service {
+/** Provides several methods for handling http requests */
+export declare abstract class Service {
     protected readonly alert: CoerAlert;
     protected readonly http: HttpClient;
-    protected httpCode: {
+    protected readonly HTTP_CODE: {
         Ok: number;
         Created: number;
         NoContent: number;
@@ -24,21 +25,21 @@ export declare class Service {
     private _PUT$;
     private _PATCH$;
     private _DELETE$;
-    /** */
+    /** Clear and release a subscription */
     protected ReleaseSubscription(subscription: Subscription): void;
-    /** HTTP GET */
+    /** Generates a GET http request */
     protected HTTP_GET<T>(request: IHttpRequest<T>, cancelPrevious?: boolean): Promise<IHttpResponse<T>>;
-    /** HTTP POST */
+    /** Generates a POST http request */
     protected HTTP_POST<T>(request: IHttpRequest<T>, cancelPrevious?: boolean): Promise<IHttpResponse<T>>;
-    /** HTTP PUT */
+    /** Generates a PUT http request */
     protected HTTP_PUT<T>(request: IHttpRequest<T>, cancelPrevious?: boolean): Promise<IHttpResponse<void>>;
-    /** HTTP PATCH */
+    /** Generates a PATCH http request */
     protected HTTP_PATCH<T>(request: IHttpRequest<T>, cancelPrevious?: boolean): Promise<IHttpResponse<void>>;
-    /** HTTP DELETE */
+    /** Generates a DELETE http request */
     protected HTTP_DELETE<T>(request: IHttpRequest<T>, cancelPrevious?: boolean): Promise<IHttpResponse<void>>;
-    /** */
+    /** Download a csv file from browser */
     protected DOWNLOAD_CSV(buffer: ArrayBuffer, fileName?: string): Blob;
-    /** */
+    /** Download a txt file from browser */
     protected DOWNLOAD_TXT(buffer: ArrayBuffer, fileName?: string): Blob;
     /** */
     private AlertError;

package/tools/lib/source.tools.d.ts

@@ -1,20 +1,21 @@
 import { IAppSource } from "coer-elements/interfaces";
+/** Controls source information in sessionStorage */
 export declare class Source {
     private static readonly storage;
-    /** */
-    static Set(page: string): void;
+    /** Save the source to sessionStorage and add the breadcrumb */
+    static Set(pageName: string): void;
     /** */
     private static Save;
-    /** */
+    /** Get the source from sessionStorage */
     static Get(): IAppSource | null;
-    /** */
+    /** Gets the first breadcrumb from sessionStorage */
     static GetRoot(): IAppSource | null;
-    /** */
+    /** Save the pageResponse to sessionStorage */
     static SetPageResponse<T>(pageResponse: T): void;
-    /** */
+    /** Gets the pageResponse from sessionStorage */
     static GetPageResponse<T>(): T | null;
-    /** */
+    /** Remove the pageResponse from sessionStorage */
     static ClearPageResponse(): void;
-    /** */
+    /** Remove the sessionStorage */
     static Reset(): void;
 }

package/tools/lib/{string.tools.d.ts → strings.tools.d.ts}

@@ -1,4 +1,5 @@
-export declare class StringTools {
+/** Provides several methods for string manipulation */
+export declare class Strings {
     /** Sets the first character to lowercase */
     static FirstCharToLower(value: string | number | null | undefined): string;
     /** Sets the first character to uppercase */

package/tools/lib/tools.d.ts

@@ -1,38 +1,23 @@
+/** Generic Methods */
 export declare const Tools: {
-    /** Generate a Guid */
+    /** Generates a guid */
     GetGuid: (seed?: string) => string;
     /** Returns true if the value is null or undefined, false otherwise */
     IsNull: (value: any) => boolean;
     /** Returns true if the value is not null or undefined, false otherwise */
     IsNotNull: (value: any) => boolean;
-    /** Returns true if the value is null or undefined or contains only whitespace, false otherwise */
+    /** Returns true if the value is null or undefined or is an empty string or contains only whitespace, false otherwise */
     IsOnlyWhiteSpace: (value: any) => boolean;
-    /** Returns true if has string value and is not only whitespace, false otherwise */
+    /** Returns true if it has a string value and is not all whitespace, false otherwise */
     IsNotOnlyWhiteSpace: (value: any) => boolean;
-    /** Avoid Null value */
-    AvoidNull: <T>(value: T | null | undefined, type?: "string" | "number" | "boolean" | null) => T;
+    /** Avoids null value and responds with the specified type */
+    AvoidNull: <T>(value: T | null | undefined, type?: "string" | "number" | "boolean") => T;
     /** Break reference of a object or array */
     BreakReference: <T>(object: T) => T;
     /** Get properties of an object */
-    GetPropertyList: <T>(object: T | null | undefined) => string[];
-    /**
-     * Set an index and merge more arrays of the same type
-     * */
-    SetIndex: <T>(array: T[], ...args: T[][]) => T[];
-    /** Sort an array in ascending order by property */
-    SortBy: <T>(array: T[], property: string, propertyType?: "string" | "number") => T[];
-    /** Sort an array in descending order by property */
-    SortByDesc: <T>(array: T[], property: string, propertyType?: "string" | "number") => T[];
-    /** Return a string with forman numeric */
-    GetNumericFormat: (value: string | number | null | undefined, decimals?: number) => string;
+    GetPropertyList: <T extends object | null | undefined>(object: T | null | undefined) => string[];
     /** Wait the time indicated */
     Sleep: (milliseconds?: number, reference?: string | null) => Promise<void>;
-    /** */
-    Distinct: <T>(array: T[], ...args: T[][]) => T[];
-    /** */
-    Except: <T>(array: T[], filter: any[], ...properties: string[]) => T[];
-    /** */
-    IsNumber: (value: any) => boolean;
-    /** */
+    /** Send text to the computer's clipboard */
     Clipboard: (text: string, message?: string, title?: string) => void;
 };

package/tools/lib/user.class.d.ts

@@ -1,12 +1,13 @@
 import { IUserLoginResponse } from "coer-elements/interfaces";
+/** Controls user information in localStorage */
 export declare class User {
     private static readonly storage;
-    /** */
+    /** Save the user to localStorage */
     static Set(user: IUserLoginResponse): void;
-    /** */
+    /** Get the user from localStorage */
     static Get(): IUserLoginResponse | null;
-    /** */
-    static LogIn(): boolean;
-    /** */
+    /** Validates if the user and the jwt exist in the localStorage */
+    static IsLogIn(): boolean;
+    /** Removes data from localStorage and sessionStorage, except for the user and navigate to root */
     static LogOut(): void;
 }

package/tools/public-api.d.ts

@@ -1,18 +1,20 @@
 export * from './lib/coer-alert/coer-alert.component';
 export * from './lib/breadcrumbs.tools';
 export * from './lib/coer-grid.templates';
+export * from './lib/collections.tools';
 export * from './lib/colors.tools';
 export * from './lib/control-value.tools';
 export * from './lib/date-time.tools';
-export * from './lib/elements-html.tools';
+export * from './lib/html-elements.tools';
 export * from './lib/files.tools';
 export * from './lib/user.class';
 export * from './lib/filters.tools';
 export * from './lib/menu.tools';
+export * from './lib/numbers.tools';
 export * from './lib/page.tools';
 export * from './lib/screen.tools';
 export * from './lib/section.tools';
 export * from './lib/service.tools';
 export * from './lib/source.tools';
-export * from './lib/string.tools';
+export * from './lib/strings.tools';
 export * from './lib/tools';