@sankhyalabs/core 5.20.0-dev.7 → 5.20.0-dev.71

package/src/utils/MaskFormatter.ts

@@ -58,7 +58,8 @@ export class MaskFormatter {
         "cnpj": "##.###.###/####-##",
         "cpf": "###.###.###-##",
         "phone": "(##) ####-####",
-        "cep": "##.###-###"
+        "cep": "##.###-###",
+        "cor_rgb" : "'#AAAAAA"
     };
 
 
@@ -92,13 +93,103 @@ export class MaskFormatter {
         this.mask = mask;
     }
 
+    
+    /**
+    * Aplica a máscara quando o input é alterado
+    *
+    * @param value Valor a ser aplicado com a máscara.
+    * @return O valor processado de acordo com o padrão.
+    */
+    public applyMask(value: string) {
+        if (this.mask === MaskFormatter.DEFAULT_MASKS.cor_rgb) {
+            value = value.replace("#", "")
+
+            const expectedFormattedValue = this.format(value.replace(/\s/g, ""));
+
+            if (value === expectedFormattedValue) {
+                return value;
+            }
+
+            if (value.length >= 6) {
+                const formattedValue = this.format(value);
+                return formattedValue;
+            } else {
+                return value;
+            }
+        }
+
+        const expectedFormattedValue = this.format(value.replace(/\s/g, ""));
+
+        if (value === expectedFormattedValue) {
+            return value;
+        }
+        const maskPlaceholders = this.mask.match(/[UAL#?*']/g) || [];
+        const placeholderCount = maskPlaceholders.length;
+
+        const validValue = value.split('').filter((char, index) => {
+            const placeholder = maskPlaceholders[index];
+            if (!placeholder) return false;
+
+            switch (placeholder) {
+                case MaskFormatter.DIGIT_KEY:
+                    return /\d/.test(char);
+                case MaskFormatter.UPPERCASE_KEY:
+                    return /[a-zA-Z]/.test(char);
+                case MaskFormatter.LOWERCASE_KEY:
+                    return /[a-zA-Z]/.test(char);
+                case MaskFormatter.ALPHA_NUMERIC_KEY:
+                    return /[a-zA-Z0-9]/.test(char);
+                case MaskFormatter.CHARACTER_KEY:
+                    return /[a-zA-Z]/.test(char);
+                case MaskFormatter.ANYTHING_KEY:
+                    return true;
+                case MaskFormatter.LITERAL_KEY:
+                    const literalChar = this.mask.charAt(index);
+                    return char === literalChar;
+                default:
+                    return false;
+            }
+        });
+
+        if (validValue.length >= placeholderCount) {
+            const formattedValue = this.format(validValue.join(''));
+            return formattedValue;
+        } else {
+            const partialValue = validValue.join('');
+            return partialValue;
+        }
+    }
+
+    /**
+     * Remove a máscara formatando a string retornando sem máscara
+     *
+     * @param value Valor a ser formatado com máscara.
+     * @return O valor processado de acordo com o padrão.
+     */
+    public removeMask(value: string): string {
+        const maskString = this.mask.replace("#", "");
+        const maskElements = maskString.split("");
+
+        let valueMapped = value
+
+        maskElements.forEach(maskChar => {
+            valueMapped = valueMapped.replace(maskChar, "")
+        })
+
+        return valueMapped;
+    }
+
     /**
      * Formata a string passada baseada na máscara definda pelo atributo mask.
      *
      * @param value Valor a ser formatado.
+     * @param trimBefore Executa um trim para remover espaços em branco.
      * @return O valor processado de acordo com o padrão.
      */
-    public format(value: string): string {
+    public format(value: string, trimBefore: boolean = false): string {
+        if(trimBefore){
+            value = value.trim();
+        }
         let result: string = '';
         const index: Array<number> = [0];
 

package/src/utils/ObjectUtils.ts

@@ -84,4 +84,60 @@ export default class ObjectUtils{
     public static equals(obj1: any, obj2: any): any {
       return ObjectUtils.objectToString(obj1) === ObjectUtils.objectToString(obj2);
     }
+
+    /**
+     * Compara se o valor de dois items são equivalentes.
+     * Comparando tanto o valor do item em si, quanto sua propriedade "value"
+     *
+     * @param obj1 - Objeto a ser comparado.
+     * @param obj2 - Objeto a ser comparado.
+     * @param propToCompare - propriedade que deve ser comparada.
+     * @returns - Se o objeto 1 é equivalente ao objeto 2.
+     *
+     * * @example
+     * hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
+     * @example
+     * hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
+     */
+    public static hasEquivalentProps(obj1: any, obj2: any, propToCompare:string = "value"): boolean{
+      return this.getComparableProp(obj1, propToCompare) == this.getComparableProp(obj2, propToCompare);
+    }
+
+    private static getComparableProp(value: any, propToCompare:string = "value"): boolean{
+      if (typeof value === 'object' && value !== null && propToCompare in value) {
+        return value[propToCompare];
+      }
+      return value;
+    }
+
+    /**
+    * Verifica se o objeto está vazio (sem atributos).
+    * 
+    * @param obj - Objeto a ser verificado.
+    * @returns - True caso o objeto esteja vazio.
+    */
+    public static isEmpty(obj: object): boolean{
+      return Object.keys(obj).length === 0 && obj.constructor === Object;
+    }
+
+    /**
+     * Verifica se o objeto NÃO está vazio (sem atributos).
+     * 
+     * @param obj - Objeto a ser verificado.
+     * @returns - True caso o objeto NÃO esteja vazio
+     */
+    public static isNotEmpty(obj: object): boolean{
+      return !this.isEmpty(obj);
+    }
+
+    /**
+     * Busca a propriedade de um objeto baseado em seu caminho.
+     * 
+     * @param obj - Objeto a ser verificado.
+     * @param keyPath - Caminho da propriedade a ser buscada.
+     * @returns - O valor da propriedade caso ela exista.
+     */
+    public static getProp(obj: Record<string, any>, keyPath: string): Record<string, any> | undefined {
+      return keyPath.split('.').reduce((previous, current) => previous?.[current], obj);
+    }
 }

package/src/utils/OnboardingUtils.ts

@@ -32,7 +32,7 @@ export class OnboardingUtils {
     }
 
     private register(ctx: EnvironmentContext){
-        (window as any).userGuiding.identify(`${ctx.userID}-${ctx.userName}-${ctx.clientGaId}`, ctx);
+        (window as any).userGuiding.identify(`${encodeURIComponent(ctx.userID)}-${encodeURIComponent(ctx.userName)}-${encodeURIComponent(ctx.clientGaId)}`, ctx);
     }
 }
 

package/src/utils/OverflowWatcher/index.ts

@@ -0,0 +1,243 @@
+import { JSUtils } from "../JSUtils.js";
+import { OverflowDirection } from "./types/overflow-direction.js"
+import { OnOverflowCallBack } from "./types/overflow-callback.js"
+import { calcMarginSize } from '../ElementUtils.js';
+
+export * from "./types/overflow-direction.js";
+export * from "./types/overflow-callback.js";
+
+export const OVERFLOWED_CLASS_NAME = 'overflowed';
+
+export default class OverflowWatcher {
+    private _onResize:OnOverflowCallBack;
+    private _resizeObserver:ResizeObserver;
+    private _lastContainerSize:number|undefined = undefined;
+    private _lastContainerInstance: HTMLElement | undefined = undefined;
+    private _scrollDirection = OverflowDirection.HORIZONTAL;
+    private _propSize:string;
+    private _hiddenItemsProps:Map<Element, SizeProps> = new Map();
+    private _notOverFlowPros:Map<string, SizeProps> = new Map();
+    private _deltaSize:number;
+    private _notOverFlow: string[] = [];
+
+    readonly DATA_ELEMENT_ID = 'data-element-id';
+
+    /**
+     * Cria uma instancia do OverflowWatcher
+     *
+     * @param element - Elemento HTML que o overflow será observado.
+     * @param callback - Função que sera chamada quando ocorrer overflow no elemento.
+     * @param overFlowDirection - Indica direção que o overflow será monitorado.
+     * @param deltaSize - Variação de tamanho que será considerada como overflow.
+     * @param debounce - Tempo até execução do callback em milissegundos.
+     * @param notOverFlow - Lista de ids ou data-element-ids dos elementos que não devem sofrer overFlow.
+     */
+    constructor({
+                    element,
+                    callback,
+                    overFlowDirection = OverflowDirection.HORIZONTAL,
+                    debounce = 200,
+                    deltaSize = 0,
+                    notOverFlow = []
+    }: OverFlowWatcherParams){
+        this._onResize = callback;
+        this._scrollDirection = overFlowDirection;
+        this._propSize = (OverflowDirection.HORIZONTAL === overFlowDirection) ? "width" : "height";
+        this._resizeObserver = new ResizeObserver(JSUtils.debounce((entries: ResizeObserverEntry[]) => this.handleResize(entries), debounce));
+        this._resizeObserver.observe(element);
+        this._deltaSize = deltaSize;
+        this._notOverFlow = notOverFlow;
+    }
+
+    public addNotOverFlowElement(elementId: string){
+        if(!this._notOverFlow.includes(elementId)){
+            this._notOverFlow.push(elementId);
+        }
+    }
+
+    public destroy(){
+        this._resizeObserver.disconnect();
+    }
+
+    public forceUpdate(){
+        if(this._lastContainerSize && this._lastContainerInstance){
+            this.updateOverFlowedItems(this._lastContainerInstance, this._lastContainerSize);
+        }
+    }
+
+    private handleResize(entries: ResizeObserverEntry[]){
+        if(!entries || entries.length === 0) return;
+
+        const container = entries[0];
+        const containerSize:number = (container.contentRect as any)[this._propSize];
+        if(!containerSize) return;
+
+        if(this.hasChangedSize(containerSize)){
+           this.updateOverFlowedItems(container.target as HTMLElement, containerSize);
+        }
+    }
+
+    private updateOverFlowedItems(container: HTMLElement, containerSize: number){
+        const children:Element[] = Array.from(container.children);
+        this.registerNotOverflowProps(children);
+        this.proccessElements(containerSize, children);
+        this._lastContainerSize = containerSize;
+        this._lastContainerInstance = container;
+    }
+
+    private registerNotOverflowProps(children: Element[]) {
+        children.forEach(childElement => {
+            const id = childElement.id || this.getDataElementId(childElement);
+            if (this.canNotRegisterNotOverFlow(id)) return;
+            this._notOverFlowPros.set(id, this.getElementSizeProps(childElement));
+        });
+    }
+
+    private canNotRegisterNotOverFlow(id: string) {
+        return !id || !this._notOverFlow.includes(id) || this._notOverFlowPros.has(id);
+    }
+
+    private hasChangedSize(elementSize: number):boolean{
+        if(!this._lastContainerSize) return true;
+        const variation = elementSize - this._lastContainerSize;
+
+        if(variation < 0){
+            const absoluteVariation = Math.abs(variation);
+            return (absoluteVariation > this._deltaSize);
+        }
+
+        return variation > 0;
+    }
+
+    private proccessElements(elementSize:number, children:Element[]){
+        if(children.length === 0) return;
+
+        const childrenSize = this.calcChildrenSize(children);
+        let diff = Number((elementSize - childrenSize).toFixed(4));
+
+        if(diff > 0){
+            this.clearOverFlow();
+            return;
+        }
+
+        this.proccessElementsOverFlow(children, elementSize);
+    }
+
+    private clearOverFlow(){
+        this._hiddenItemsProps = new Map();
+        this._onResize([]);
+    }
+
+    private proccessElementsOverFlow(allElements:Element[], avaliableSize:number){
+        const elementsThatFit: Element[] = [];
+        const avaliableSizeConsideringDelta = (avaliableSize - this._deltaSize);
+
+        let sumElementsSize = 0;
+        for (const element of allElements) {
+            sumElementsSize += this.calcElementSize(element);
+            if(this.exceedsAvaliableSize(sumElementsSize, elementsThatFit, avaliableSizeConsideringDelta)) break;
+            elementsThatFit.push(element);
+        }
+
+        const overFlowedElements = allElements.filter(element => this.isElementOverFlowing(elementsThatFit, element));
+
+        overFlowedElements.forEach(overFlowed => {
+            if(!this._hiddenItemsProps.has(overFlowed)){
+                this.registerElementSize(overFlowed);
+            }
+        });
+
+        this._onResize(overFlowedElements);
+    }
+
+    private isElementOverFlowing(elementsThatFit: Element[], element: Element) {
+        return !elementsThatFit.includes(element) && this.canOverFlowElement(element);
+    }
+
+    private canOverFlowElement(element: Element) {
+        return !this._notOverFlow.includes(element.id)
+          && !this._notOverFlow.includes(this.getDataElementId(element));
+    }
+
+    private getDataElementId(element: Element): string {
+        return (element as HTMLElement).getAttribute('data-element-id') ?? "";
+    }
+
+    private exceedsAvaliableSize(sumElementsSize: number, elements: Element[], avaliableSize: number): boolean {
+        if(!this._notOverFlow.length) return sumElementsSize > avaliableSize
+
+        const elementIdsToCalculate = this.canNotOverFlowNotIncludedIds(elements);
+        if(!elementIdsToCalculate.length) return sumElementsSize > avaliableSize
+
+        const variation = this.calculateVariation(elementIdsToCalculate);
+        const occupiedSize = sumElementsSize + variation;
+        return occupiedSize > avaliableSize;
+    }
+
+    private calculateVariation(elementIdsToCalculate: string[]) {
+        let variation = 0
+        elementIdsToCalculate.forEach(id => {
+            const sizeProps = this._notOverFlowPros.get(id);
+            variation += sizeProps?.size ?? 0;
+            variation += sizeProps?.margin ?? 0;
+        });
+        return variation;
+    }
+
+    private canNotOverFlowNotIncludedIds(elements: Element[]): string[]{
+        const elementsIdList = elements.map(el =>  el.id || this.getDataElementId(el)).filter(id => !!id);
+        return this._notOverFlow.filter(id => !elementsIdList.includes(id));
+    }
+
+    private registerElementSize(element: Element) {
+        const sizeProps = this.getElementSizeProps(element);
+        this._hiddenItemsProps.set(element, sizeProps);
+    }
+
+    private getElementSizeProps(element: Element) {
+        const sizeProps: SizeProps = {
+            size: (element.getBoundingClientRect() as any)[this._propSize],
+            margin: calcMarginSize(element, this._scrollDirection),
+        };
+        return sizeProps;
+    }
+
+    private calcChildrenSize(children:Element[]):number{
+        let sumChildren = 0;
+        sumChildren += this._deltaSize;
+        Array.from(children).forEach(el => sumChildren += this.calcElementSize(el));
+        return sumChildren;
+    }
+
+    private calcElementSize(el: Element) {
+        let size = 0
+        if (this.isOverFlowed(el)) {
+            const sizeProps = this._hiddenItemsProps.get(el);
+            size += sizeProps?.size ?? 0;
+            size += sizeProps?.margin ?? 0;
+            return size;
+        }
+
+        size += (el.getBoundingClientRect() as any)[this._propSize];
+        size += calcMarginSize(el, this._scrollDirection);
+        return size;
+    }
+
+    private isOverFlowed(el: Element) {
+        return el.classList.contains(OVERFLOWED_CLASS_NAME);
+    }
+}
+
+export interface OverFlowWatcherParams {
+    element:HTMLElement,
+    callback:OnOverflowCallBack,
+    overFlowDirection?:OverflowDirection,
+    deltaSize?:number,
+    debounce?: number,
+    notOverFlow?: string[]
+}
+
+interface SizeProps {
+    size: number,
+    margin: number,
+}

package/src/utils/OverflowWatcher/types/overflow-callback.ts

@@ -0,0 +1,6 @@
+/**
+ * Callback que será chamado quando o overflow de um elemento for alterado.
+ * 
+ * @param elementsOverFlow - Conjunto de elementos filhos que estão causando overflow no elemento pai.
+ */
+export type OnOverflowCallBack = (elementsOverFlow:Array<Element>) => void;

package/src/utils/OverflowWatcher/types/overflow-direction.ts

@@ -0,0 +1,7 @@
+/**
+ * Define em qual direção o overflow será observado
+ */
+export enum OverflowDirection {
+    'VERTICAL',
+    'HORIZONTAL'
+}

package/src/utils/ServiceUtils.ts

@@ -0,0 +1,36 @@
+import { CacheManager } from './CacheManager/index.js';
+import { StorageType } from './CacheManager/interfaces/index.js';
+
+
+export class ServiceUtils {
+
+    
+    /**
+     * Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
+     *
+     * @template T Tipo do dado a ser retornado.
+     * @param identifier Identificadores únicos usados para compor a chave de cache.
+     * @param fetchFunction Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
+     * @param storageType Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
+     * @returns Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
+     *
+     * @example
+     * ```typescript
+     * const actions = await useCacheWithService(
+     *  `${this.entityName} - ${this.resourceID}`,
+     *   async () => {
+     *     return await fetchActionsFromAPI();
+     *   }
+     * );
+     * console.log(actions);
+     * ```
+     */
+    public static async useCacheWithService<T>(
+        identifier: string,
+        fetchFunction: () => Promise<T>,
+        storageType: StorageType = StorageType.IN_MEMORY_CACHE
+    ): Promise<T> {
+        const cacheKey = `${identifier}`;
+        return CacheManager.getOrSet(cacheKey, fetchFunction, storageType);
+    }
+}

package/src/utils/SortingUtils.ts

@@ -0,0 +1,30 @@
+import DataUnit from "../dataunit/DataUnit.js";
+import { FieldDescriptor, Sort, SortMode } from "../dataunit/metadata/UnitMetadata.js";
+import { FieldComparator } from "../dataunit/sorting/FieldComparator.js";
+import { Record } from '../dataunit/DataUnit.js';
+
+/**
+ * `SortingUtils`: Utilizado para auxiliar na ordenacao de registros.
+ */
+export default class SortingUtils {    
+
+    public static getSortingFunction(dataUnit: DataUnit, sorting?: Array<Sort>): ((recordA: Record, recordB: Record) => number) | undefined {
+
+        if (sorting == undefined || sorting.length == 0) {
+            return undefined;
+        }
+
+        return (recordA, recordB) => {
+            for (const sort of sorting) {
+                if (sort.field){
+                    const result = FieldComparator.compare(dataUnit.getField(sort.field) as FieldDescriptor, recordA, recordB, sort.mode === SortMode.ASC);
+                    if (result != 0) {
+                        return result;
+                    }
+                }
+            }
+            return 0;
+        };
+    }
+    
+}

package/src/utils/UserAgentUtils/index.ts

@@ -15,6 +15,11 @@ export class UserAgentUtils {
         return !!browser.firefox;
     }
 
+    public static isElectron() {
+        const browser = this.getBrowserInfo();
+        return !!browser.electron;
+    }
+
     /**
      * Obtém nome e versão do navegador que está sendo utilizado.
      * @returns Objeto com o nome e versão do navegador.
@@ -40,6 +45,7 @@ export class UserAgentUtils {
                         }
                     } catch (e) {
                         //ignored
+                        console.warn(e);
                     }
 
                     browser = {
@@ -49,7 +55,6 @@ export class UserAgentUtils {
                         simpleVersion,
                         ...(Array.isArray(type) ? type.reduce((acc, val) => ({ ...acc, [val]: true}), {}) : { [type]: true })
                     }
-
                     return !hasFound;
                 }
             })

package/src/utils/test/objectUtils.spec.ts

@@ -0,0 +1,109 @@
+import ObjectUtils from '../ObjectUtils'
+
+describe("ObjectUtils", () => {
+    describe('hasEquivalentValues', () => {
+        it('should return true if both objects have the same property value', () => {
+            const obj1 = { value: 10 };
+            const obj2 = { value: 10 };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(true);
+        });
+
+        it('should return false if both objects have different property values', () => {
+            const obj1 = { value: 10 };
+            const obj2 = { value: 20 };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(false);
+        });
+
+        it('should return true if both objects are equivalent with custom property to compare', () => {
+            const obj1 = { customProp: 'hello' };
+            const obj2 = { customProp: 'hello' };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2, 'customProp')).toBe(true);
+        });
+
+        it('should return false if both objects are not equivalent with custom property to compare', () => {
+            const obj1 = { customProp: 'hello' };
+            const obj2 = { customProp: 'world' };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2, 'customProp')).toBe(false);
+        });
+
+        it('should return false if one object does not have the property', () => {
+            const obj1 = { value: 10 };
+            const obj2 = { anotherProp: 10 };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(false);
+        });
+
+        it('should return true if comparing primitive values directly', () => {
+            const obj1 = 5;
+            const obj2 = 5;
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(true);
+        });
+
+        it('should return false if comparing different primitive values', () => {
+            const obj1 = 5;
+            const obj2 = 10;
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(false);
+        });
+
+        it('should return true when comparing object with a null value', () => {
+            const obj1 = null;
+            const obj2 = null;
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(true);
+        });
+
+        it('should return false when comparing object with null and non-null value', () => {
+            const obj1 = null;
+            const obj2 = { value: 5 };
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(false);
+        });
+
+        it('should return true when comparing non-object values that are equal', () => {
+            const obj1 = 'same';
+            const obj2 = 'same';
+            expect(ObjectUtils.hasEquivalentProps(obj1, obj2)).toBe(true);
+        });
+
+    });
+
+
+    it("should get an object value based on its path", async () => {
+        const obj = {
+            food: {
+                fruits: {
+                    apple: 1,
+                    banana: 2
+                }
+            }
+        };
+
+        const value = ObjectUtils.getProp(obj, "food.fruits.banana");
+        expect(value).toBe(2);
+    });
+
+    it("should get an object value based on its path", async () => {
+        const food = {
+            fruits: {
+                apple: 1,
+                banana: 2
+            }
+        }
+
+        const obj = { food };
+
+        const value = ObjectUtils.getProp(obj, "food");
+        expect(JSON.stringify(value)).toBe(JSON.stringify(food));
+    });
+
+    it("should return undefined if the path doesn't exist in the object", async () => {
+        const obj = {
+            food: {
+                fruits: {
+                    apple: 1,
+                    banana: 2
+                }
+            }
+        };
+
+        const value = ObjectUtils.getProp(obj, "vegetables");
+        expect(value).toBe(undefined);
+    });
+});