@sankhyalabs/core 0.0.0-bugfix-dev-KB-17130.1 → 0.0.0-bugfix-dev-KB-35840.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/core",
-  "version": "0.0.0-bugfix-dev-KB-17130.1",
+  "version": "0.0.0-bugfix-dev-KB-35840.0",
   "description": "Modulo core JavaScript da Sankhya.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -10,7 +10,7 @@
     "build": "tsc",
     "build:watch": "tsc --watch",
     "compile": "tsc",
-    "test": "jest",
+    "test": "jest --coverage --silent --testResultsProcessor jest-sonar-reporter",
     "coverage": "jest --coverage",
     "serve": "es-dev-server --node-resolve --watch",
     "eslint": "eslint src/**",
@@ -43,11 +43,18 @@
     "eslint-plugin-import": "^2.26.0",
     "husky": "^8.0.3",
     "jest": "^29.4.1",
+    "jest-sonar-reporter": "^2.0.0",
     "jest-environment-jsdom": "^29.4.1",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.24",
-    "typedoc-plugin-markdown": "^3.14.0",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.1",
     "typescript": "^4.9.5"
+  },
+  "jestSonar": {
+    "sonar56x": true,
+    "reportPath": "reports",
+    "reportFile": "test-report.xml",
+    "indent": 4
   }
 }

package/sonar-project.properties

@@ -0,0 +1,7 @@
+sonar.testExecutionReportPaths=./reports/test-report.xml
+sonar.typescript.lcov.reportPaths=./coverage/lcov.info
+sonar.test.inclusions="**/test/*.e2e.ts","**/test/*.spec.ts","**/test/*.spec.tsx","**/utils/*.spec.ts"
+sonar.tests=.
+sonar.c.file.suffixes=-
+sonar.cpp.file.suffixes=-
+sonar.objc.file.suffixes=-

package/src/dataunit/DataUnit.ts

@@ -25,6 +25,7 @@ import { getFormattedValue } from "./formatting/PrettyFormatter.js";
 import { v4 as uuid } from "uuid";
 import { DataUnitStorage } from "./DataUnitStorage.js";
 import { getInvalidFieldMessage, InvalidFieldsReducer } from "./state/slice/InvalidFieldsSlice.js";
+import { getLoadingProperties, LoadingPropertiesReducer } from "./state/slice/LoadingProperties.js";
 
 /***
  * `DataUnit`: Atua como uma camada de abstração entre o back-end e a interface do usuário.
@@ -61,6 +62,7 @@ export default class DataUnit {
         this._stateManager = new StateManager(
             [
                 HistReducer,
+                LoadingPropertiesReducer,
                 UnitMetadataReducer,
                 LoadingControlReducer,
                 RecordsReducer,
@@ -114,6 +116,27 @@ export default class DataUnit {
         this._interceptors = [];
     }
 
+    /**
+     * Adiciona uma propriedade transacional que será envida aos 
+     * loaders (dataLoader, saveLoader, removeLoader e recordLoader) na chamada.
+     * Essas propriedades serão limpas ao final da execução de cada método.
+     * 
+     * @param name - Nome da propriedade
+     * @param value - Valor da propriedade
+     * 
+     */
+    public addGlobalLoaderProp(name: string, value: string):void{
+        this.dispatchAction(Action.LOADING_PROPERTY_ADDED, {[name]: value});
+    }
+
+    /**
+     * Retorna as propriedades transacionais adicionados anteriores à chamada.
+     * 
+     * @returns - Todas as propriedades desde o final do último loader.
+     */
+    public getGlobalLoaderProps(): Map<string, string>{
+        return getLoadingProperties(this._stateManager) || new Map();
+    }
 
     public get dataUnitId(): string{
         return this._uuid;
@@ -215,18 +238,24 @@ export default class DataUnit {
             if (await this.dispatchAction(Action.LOADING_DATA, request, executionCtx)) {
                 if (this.dataLoader) {
                     this.dataLoader(this, request).then(
-                        response => {
-                            this.dispatchAction(Action.DATA_LOADED, {...response, keepSelection: request.keepSelection}, executionCtx);
+                        async response => {
+                            await this.dispatchAction(
+                                Action.DATA_LOADED, 
+                                {...response, keepSelection: request.keepSelection, filters: request.filters},
+                                executionCtx
+                            );
+                            
+                            await this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
 
                             if(selectFirstRecord){
                                 this.requestSelectFirst(executionCtx);
                             }
-
                             resolve(response);
                         }
                     ).catch(error => {
                         console.error(error);
                         const {errorCode} = error;
+                        this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                         fail(new ErrorException("Erro ao carregar registros", error, errorCode))
                     });
                 }
@@ -427,6 +456,7 @@ export default class DataUnit {
                                 const changes: Array<Change> = this.getAllChangesToSave();
 
                                 this.saveLoader(this, changes).then((records) => {
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     const recordsByDataUnit = this.getRecordsByDataUnit(records);
 
                                     const dispatchPromisses = [];
@@ -441,9 +471,11 @@ export default class DataUnit {
                                     Promise.all(dispatchPromisses).then(() => resolve());
                                 }).catch(cause => {
                                     const {errorCode} = cause;
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     fail(new ErrorException("Erro ao salvar alterações", cause, errorCode));
                                 });
                             } else {
+                                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                 resolve();
                             }
                         });
@@ -532,6 +564,7 @@ export default class DataUnit {
     public async removeRecords(recordIds: Array<string>, cachedRecords: Array<Record>, buffered: boolean = false, executionCtx?: ExecutionContext, silent: boolean = false): Promise<Array<string>> {
         if (recordIds) {
             if (buffered || !this.removeLoader) {
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                 this.dispatchAction(Action.RECORDS_REMOVED, { records: recordIds, cachedRecords, buffered: true }, executionCtx);
             } else {
                 if (await this.dispatchAction(Action.REMOVING_RECORDS, {silent}, executionCtx)) {
@@ -549,9 +582,11 @@ export default class DataUnit {
                                     const selectionAfterRemove = [currentRecordsKeys[nextIndex]];
 
                                     this.dispatchAction(Action.RECORDS_REMOVED, { records: removedIds, cachedRecords, removedIndex, buffered: false, selectionAfterRemove }, executionCtx);
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     resolve(removedIds);
                                 }
                             ).catch(error => {
+                                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                 const {errorCode} = error;
                                 fail(new ErrorException("Erro ao remover registros", error, errorCode))
                             });
@@ -608,15 +643,14 @@ export default class DataUnit {
      * 
     */
     public getFormattedValue(fieldName: string, value?: any): string {
-        
         const descriptor = this.getField(fieldName);
-        if (value == undefined) {
+        if (value === undefined) {
             value = this.getFieldValue(fieldName);
         } else if (typeof value === "string" && descriptor?.dataType != DataType.TEXT){
             value = this.valueFromString(fieldName, value);
         }
 
-        if(value == undefined){
+        if(value === undefined){
             return "";
         }
 
@@ -1496,7 +1530,7 @@ export default class DataUnit {
      * @param observer - Função que recebe como parâmetro as ações que serão monitoradas.
      * 
     */
-    public subscribe(observer: (action: DataUnitAction) => void) {
+    public subscribe(observer: (action: DataUnitAction) => void | Promise<void>) {
         this._observers.push(observer);
     }
 
@@ -1523,12 +1557,16 @@ export default class DataUnit {
             const selection = getSelection(this._stateManager);
             this.dispatchAction(Action.LOADING_RECORD, selection);
             
-            if(!this.dataLoader) return;
-            if(!this.recordLoader) return;
+            if(!this.recordLoader || !this.dataLoader) {
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
+                return;
+            }
             
             this.recordLoader(this, selection).then(response => {
                 this.dispatchAction(Action.RECORD_LOADED, response)
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
             }).catch(cause => {
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                 const {errorCode} = cause;
                 fail(new ErrorException("Erro ao recarregar registro", cause, errorCode));
             });
@@ -1693,12 +1731,21 @@ export default class DataUnit {
         return selection?.recordIds || [];
     }
 
+    /**
+     * Adiciona um campo stand-alone ao dataUnit.
+     * 
+     * @deprecated - metodo depreciado, utilizar o metodo addField
+     */
+    public addStandAloneField() : void {
+        console.warn("metodo depreciado, para adicionar um campo standAlone, utilizar o metodo addField")
+    }
+
     /**
      * Adiciona um campo stand-alone ao dataUnit.
      * 
      * @param field - Campo a ser adicionado.
      */
-    public addStandAloneField(field: Omit<FieldDescriptor, 'standAlone'>) : void {
+    public addField(field: Omit<FieldDescriptor, 'standAlone'>) : void {
         const standAloneField = {...field, standAlone: true};
         this.metadata = {...this.metadata, fields: [...this.metadata.fields, standAloneField]};
     }

package/src/dataunit/formatting/PrettyFormatter.ts

@@ -10,10 +10,10 @@ export const getFormattedValue = (value: any, descriptor?: FieldDescriptor) => {
     }
 
     if(descriptor?.dataType === DataType.OBJECT){
-        if(Object.hasOwn(value, "value")){
+        if(value && Object.hasOwn(value, "value")){
             return getSearchFormat(value, descriptor);
         }
-        return value == undefined ? "" : value.toString();
+        return !value ? "" : value.toString();
     }
 
     if(descriptor?.userInterface === UserInterface.OPTIONSELECTOR){
@@ -53,6 +53,7 @@ export const getFormattedValue = (value: any, descriptor?: FieldDescriptor) => {
 }
 
 const getNumberFormat = (value: any, descriptor: FieldDescriptor) => {
+    if(!value) return "";
     if(descriptor.userInterface === UserInterface.INTEGERNUMBER){
         return value;
     }
@@ -79,10 +80,12 @@ const getOptionFormat = (value: any, descriptor: FieldDescriptor) => {
         options = JSON.parse(prop);
     } else {
         options = {};
-        prop.forEach(opt => options[opt.label] = opt.value);
+        if(prop != undefined){
+            prop.forEach(opt => options[opt.label] = opt.value);
+        }
     }
 
-    if(typeof value === "object"){
+    if(value && typeof value === "object" ){
         value = value.value
     }
 
@@ -90,7 +93,7 @@ const getOptionFormat = (value: any, descriptor: FieldDescriptor) => {
         return options[value];
     }
 
-    return value;     
+    return value ?? "";
 }
 
 

package/src/dataunit/metadata/DataType.ts

@@ -67,7 +67,16 @@ export const getConvertedValue = (dataType: DataType, value: any): any => {
     case DataType.NUMBER:
       return value === "" || isNaN(Number(value)) ? null : Number(value);
     case DataType.OBJECT:
-      return typeof value === "string" ? JSON.parse(value) : value;
+    //Caso de uso campo DataType do tipo STRING e UserInterface do tipo TEXT, que tem relacionamento (TGFPRO.GRUPOPIS)
+    if(typeof value === "string") {
+        try{
+            return JSON.parse(value);
+        }catch(e){
+            console.warn(`Erro ao fazer parse do valor ${value} para objeto, dataType: ${dataType}`);
+        }
+      }
+
+      return value;
     case DataType.BOOLEAN:
       if (typeof value === "string") {
         return Boolean(value === 'true');

package/src/dataunit/state/action/DataUnitAction.ts

@@ -63,6 +63,8 @@ export enum Action{
     CHILD_CHANGED = "childChanged",
 
     FIELD_INVALIDATED = "fieldInvalidated",
-    INVALIDATE_CLEAN = "invalidateClean"
+    INVALIDATE_CLEAN = "invalidateClean",
     
+    LOADING_PROPERTY_ADDED = "loadingPropertyAdded",
+    LOADING_PROPERTIES_CLEANED = "loadingPropertiesCleaned"
 }

package/src/dataunit/state/slice/ChangesSlice.ts

@@ -94,27 +94,28 @@ export const getChangedFieldValue = (fieldName: string, record: Record, stateMan
 }
 
 export const getChangesToSave = (dataUnit: string, stateManager: StateManager): Array<Change> => {
-    const result: Array<Change> = [];
-
+    
     const changes = getChanges(stateManager);
     const selectedRecords = getSelectionRecords(stateManager) || [];
-    const records: Set<Record> = new Set(
+    const records: Map<string, Record> = new Map(
         getRecords(stateManager)
         .concat(
-            selectedRecords
-                .filter(record => !isAddedRecord(record.__record__id__, stateManager)
-            )
+            selectedRecords.filter(record => !isAddedRecord(record.__record__id__, stateManager))
         )
+        .map(r => [r.__record__id__, r])
     );
-
-    records?.forEach(r => {
-        if(changes){
-            const c = changes.get(r.__record__id__);
-            if (c) {
-                result.push(new Change(dataUnit, r, c, ChangeOperation.UPDATE,  r.__record__source__id__));
+    
+    const result: Array<Change> = [];
+    
+    if(changes != undefined){
+        Array.from(changes.entries())
+        .forEach(([recordId, change]) =>{
+            const record = records.get(recordId);
+            if(record != undefined){
+                result.push(new Change(dataUnit, record, change, ChangeOperation.UPDATE,  record.__record__source__id__));
             }
-        }
-    });
+        });
+    }
 
     const addedRecords = getAddedRecords(stateManager);
     if (addedRecords) {

package/src/dataunit/state/slice/InvalidFieldsSlice.ts

@@ -15,6 +15,8 @@ class InvalidFieldsReducerImpl implements ActionReducer{
                 return makeInvalid(currentState, action.payload);
             case Action.INVALIDATE_CLEAN:
                 return clearRecord(currentState, action.payload);
+            case Action.EDITION_CANCELED:
+                return undefined;
         }
 
         return currentState;

package/src/dataunit/state/slice/LoadingProperties.ts

@@ -0,0 +1,37 @@
+
+import { ActionReducer, StateAction } from "../StateManager.js";
+import { Action } from "../action/DataUnitAction.js";
+import StateManager from "../StateManager.js";
+
+class LoadingPropertiesImpl implements ActionReducer{
+    
+    public sliceName: string = "loadingProperties";
+
+    public reduce(_stateManager:StateManager, currentState: Map<string, string>, action: StateAction): Map<string, string>|undefined {
+        switch(action.type){
+            case Action.LOADING_PROPERTY_ADDED:
+                return buildNewState(currentState, action.payload);
+            case Action.LOADING_PROPERTIES_CLEANED:
+                return undefined;
+        }
+        return currentState;
+    }
+}
+
+export const LoadingPropertiesReducer = new LoadingPropertiesImpl();
+
+export const getLoadingProperties = (stateManager: StateManager): Map<string, string>|undefined => {
+    return stateManager.select(LoadingPropertiesReducer.sliceName, (state: Map<string, string>) => state);
+};
+
+function buildNewState(currentState: Map<string, string>, payload: any): Map<string, string>{
+    const newState =  new Map(currentState);
+    if(payload != undefined){
+        for (const [key, value] of Object.entries(payload)) {
+            if(typeof key === "string" && typeof value === "string"){
+                newState.set(key, value);
+            }
+        }
+    }
+    return newState;
+}

package/src/dataunit/state/slice/SelectionSlice.ts

@@ -17,7 +17,8 @@ class SelectionReducerImpl implements ActionReducer {
                 return !action.payload?.keepSelection ? undefined : currentState;
             case Action.RECORDS_ADDED:
             case Action.RECORDS_COPIED:
-                return {currentSelection: action.payload.map((r: Record)=>r.__record__id__), lastSelection: currentState?.currentSelection};
+                const lastSelection = currentState?.currentSelection || [];
+                return {currentSelection: action.payload.map((r: Record)=>r.__record__id__), lastSelection};
             case Action.DATA_SAVED:
                 return {currentSelection: updateSavedIds(stateManager, action.payload.records)};
             case Action.RECORDS_REMOVED:
@@ -67,7 +68,7 @@ class SelectionReducerImpl implements ActionReducer {
                 if(currentState?.lastSelection){
                     return { currentSelection: currentState.lastSelection };
                 }
-                break;
+                return { currentSelection: [] }
         }
 
         return currentState;

package/src/index.ts

@@ -38,6 +38,8 @@ import { ILoadResult } from "./repository/ILoadResult.js";
 import { IRepositoryIndex } from "./repository/indexeddb/IRepositoryIndex.js"
 import { FieldComparator } from "./dataunit/sorting/FieldComparator.js";
 import { KeyboardManager } from "./utils/KeyboardManager/index.js";
+import { SearchUtils } from "./utils/SearchUtils.js";
+import OverflowWatcher, { OnOverflowCallBack, OverflowDirection } from "./utils/OverflowWatcher/index.js";
 
 /*Classes públicas no pacote*/
 export {
@@ -104,4 +106,8 @@ export {
     FieldComparator,
     defaultDataLoader,
     KeyboardManager,
+    SearchUtils,
+    OverflowWatcher,
+    OnOverflowCallBack,
+    OverflowDirection
 };

package/src/utils/ArrayUtils.ts

@@ -1,5 +1,6 @@
 import { StringUtils } from "./StringUtils.js";
 import { NumberUtils } from './NumberUtils.js';
+import ObjectUtils from "./ObjectUtils.js";
 
 /**
  * `ArrayUtils`: Utilitário com a responsabilidade de manipular Arrays.
@@ -58,4 +59,76 @@ export default class ArrayUtils {
           }
         });
     }
+
+    /**
+     * Ordena valores de um array alfabeticamente.
+     *
+     * @param arr - Array a ser ordenado.
+     * @returns - Array ordenado alfabeticamente..
+     */
+    public static find(arr: any, checkerFn: any) {
+      if (arr) {
+        for (let i = 0, length = arr.length; i < length; i++) {
+          if (checkerFn(arr[i], i, arr)) {
+            return arr[i];
+          }
+        }
+      } else {
+        return undefined;
+      }
+    }
+
+    /**
+     * Retorna o objeto se for encontrado no array, ou -1 se não for encontrado.
+     *
+     * @param arr - Array onde está o objeto.
+     * @param obj - Objeto a ser procurado.
+     * @returns - Array ordenado alfabeticamente..
+     */
+    public static indexOf(arr: any, obj: any) {
+      let index = -1;
+      if (Array.isArray(arr)) {
+        ArrayUtils.find(arr, (item: any, i: number) => {
+          index = i;
+          return ObjectUtils.equals(obj, item);
+        });
+      }
+      return index;
+    }
+
+    /**
+     * Remove um item de array de acordo com o index.
+     *
+     * @param array - Array onde está o item.
+     * @param index - Index do item a ser removido.
+     * @returns - Array sem o item do index informado.
+     */
+    public static removeAtIndex(array: any, index: number) {
+      if (index >= 0 && index < array.length) {
+        return array.splice(index, 1)[0];
+      }
+    }
+
+    /**
+     * Remove um objeto do array.
+     *
+     * @param array - Array onde está o objeto.
+     * @param obj - Objeto a ser removido.
+     * @returns - Array sem o Objeto informado.
+     */
+    public static removeReference(array: any, obj: any) {
+      let index = ArrayUtils.indexOf(array, obj);
+      return ArrayUtils.removeAtIndex(array, index);
+    }
+
+    /**
+     * Remove um objeto do array.
+     *
+     * @param array - Array onde está o objeto.
+     * @param obj - Objeto a ser removido.
+     * @returns - Array sem o Objeto informado.
+     */
+    public static isIn(arr: any, obj: any) {
+      return ArrayUtils.indexOf(arr, obj) > -1;
+    }
 }

package/src/utils/DateUtils.ts

@@ -39,6 +39,7 @@ export default class DateUtils{
      * @returns - Uma string com as horas no formato HH:MM ou HH:MM:SS.
      */
     public static formatTime(date: Date, showSeconds: boolean = false): string{
+        if(!date) return "";
         const timeOptions:Intl.DateTimeFormatOptions = {hour: "2-digit", minute: "2-digit", second: showSeconds ? "2-digit" : undefined};
         return new Intl.DateTimeFormat("pt-BR", timeOptions).format(date);
     }
@@ -51,6 +52,7 @@ export default class DateUtils{
      * @returns - Uma string com as horas no formato DD/MM/YYYY HH:MM ou DD/MM/YYYY HH:MM:SS.
      */
     public static formatDateTime(date: Date, showSeconds: boolean = false): string{
+        if(!date) return "";
         return `${DateUtils.formatDate(date)} ${DateUtils.formatTime(date, showSeconds)}`;
     }
   

package/src/utils/JSUtils.ts

@@ -95,4 +95,22 @@ export class JSUtils{
   public static generateUUID(): string {
     return uuid();
   }
+
+  /**
+   * Substitui caracteres para suas entidades HTML.
+   * 
+   * @param source - String a ter os caracteres substituidos.
+   * @returns - Retorna um UUID.
+  */
+  public static replaceHtmlEntities(source: string) {
+    if (source == undefined) {
+      return source;
+    }
+
+    return String(source)
+      .replace(/&/g, '&')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;');
+  }
 }

package/src/utils/ObjectUtils.ts

@@ -73,4 +73,15 @@ export default class ObjectUtils{
       );
 
     }
+
+    /**
+     * Compara se um objeto é igual a outro objeto.
+     * 
+     * @param obj1 - Objeto a ser comparado.
+     * @param obj2 - Objeto a ser comparado.
+     * @returns - Se o objeto 1 é igual ao objeto 2.
+     */
+    public static equals(obj1: any, obj2: any): any {
+      return ObjectUtils.objectToString(obj1) === ObjectUtils.objectToString(obj2);
+    }
 }