@sankhyalabs/core 5.17.3 → 5.18.0-ms.1

package/.docs/enumerations/LockManagerOperation.md

@@ -0,0 +1,33 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManagerOperation
+
+# Enumeration: LockManagerOperation
+
+Define os tipos de operação que o locker pode controlar
+
+## Enumeration Members
+
+### APP\_LOADING
+
+> **APP\_LOADING**: `"app_loading"`
+
+Operação de lock utilizada para controlar carregamento da aplicação.
+
+#### Source
+
+src/utils/LockManager.ts:13
+
+***
+
+### TASKBAR\_CLICK
+
+> **TASKBAR\_CLICK**: `"taskbar_click"`
+
+Operação de lock utilizada para controlar cliques nos botoes da taskbar.
+
+#### Source
+
+src/utils/LockManager.ts:9

package/.docs/enumerations/RECORD_DATE_FORMAT.md

@@ -0,0 +1,27 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / RECORD\_DATE\_FORMAT
+
+# Enumeration: RECORD\_DATE\_FORMAT
+
+## Enumeration Members
+
+### DD\_MM\_YYYY
+
+> **DD\_MM\_YYYY**: `"DD/MM/YYYY"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:8
+
+***
+
+### ISO
+
+> **ISO**: `"ISO"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:9

package/.docs/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1940
+src/dataunit/DataUnit.ts:2061
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1940
 
 #### Source
 
-src/dataunit/DataUnit.ts:1941
+src/dataunit/DataUnit.ts:2062

package/.docs/enumerations/StorageType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / StorageType
+
+# Enumeration: StorageType
+
+## Enumeration Members
+
+### IN\_MEMORY\_CACHE
+
+> **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:2
+
+***
+
+### LOCAL\_STORAGE
+
+> **LOCAL\_STORAGE**: `"localStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:4
+
+***
+
+### SESSION\_STORAGE
+
+> **SESSION\_STORAGE**: `"sessionStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:3

package/.docs/globals.md

@@ -14,9 +14,12 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
+- [RECORD\_DATE\_FORMAT](enumerations/RECORD_DATE_FORMAT.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -25,8 +28,11 @@
 - [ArrayUtils](classes/ArrayUtils.md)
 - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
 - [Change](classes/Change.md)
+- [ColumnFilterManager](classes/ColumnFilterManager.md)
 - [DataUnit](classes/DataUnit.md)
 - [DataUnitAction](classes/DataUnitAction.md)
+- [DataUnitInMemoryLoader](classes/DataUnitInMemoryLoader.md)
+- [DataUnitLoaderUtils](classes/DataUnitLoaderUtils.md)
 - [DataUnitStorage](classes/DataUnitStorage.md)
 - [DateUtils](classes/DateUtils.md)
 - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -39,6 +45,7 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
@@ -49,6 +56,9 @@
 - [RequestMetadata](classes/RequestMetadata.md)
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
+- [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
+- [SilentException](classes/SilentException.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)
@@ -62,6 +72,7 @@
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)
+- [DataUnitInMemoryLoaderConfig](interfaces/DataUnitInMemoryLoaderConfig.md)
 - [ExecutionContext](interfaces/ExecutionContext.md)
 - [FieldDescriptor](interfaces/FieldDescriptor.md)
 - [Filter](interfaces/Filter.md)
@@ -74,6 +85,7 @@
 - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
+- [PaginationInfoBuilderParams](interfaces/PaginationInfoBuilderParams.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
 - [QuickFilter](interfaces/QuickFilter.md)
 - [Record](interfaces/Record.md)

package/.docs/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1815
+src/dataunit/DataUnit.ts:1936

package/.docs/interfaces/DataUnitInMemoryLoaderConfig.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoaderConfig
+
+# Interface: DataUnitInMemoryLoaderConfig
+
+## Properties
+
+### autoLoad?
+
+> `optional` **autoLoad**: `boolean`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:2
+
+***
+
+### pageSize?
+
+> `optional` **pageSize**: `number`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:3
+
+***
+
+### recordDateFormat?
+
+> `optional` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:4

package/.docs/interfaces/IRepository.md

@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
 
 ***
 
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Source
+
+src/repository/IRepository.ts:88
+
+***
+
 ### insert()
 
 > **insert**(`itemReference`, `items`): `Promise`\<`void`\>

package/.docs/interfaces/LoadDataRequest.md

@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
 
 ### source?
 
-> `optional` **source**: `String`
+> `optional` **source**: `string`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 

package/.docs/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1920
+src/dataunit/DataUnit.ts:2041
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1920
 
 #### Source
 
-src/dataunit/DataUnit.ts:1921
+src/dataunit/DataUnit.ts:2042
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1921
 
 #### Source
 
-src/dataunit/DataUnit.ts:1922
+src/dataunit/DataUnit.ts:2043

package/.docs/interfaces/PaginationInfo.md

@@ -10,6 +10,18 @@ Informações da paginação retornada na requisição de carregamento de regist
 
 ## Properties
 
+### askRowsLimit?
+
+> `optional` **askRowsLimit**: `number`
+
+Informa se deve exibir diálogo para cancelar carregamento de registros
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:30
+
+***
+
 ### count?
 
 > `optional` **count**: `number`
@@ -70,6 +82,19 @@ src/dataunit/loading/PaginationInfo.ts:11
 
 ***
 
+### loadingInProgress?
+
+> `optional` **loadingInProgress**: `boolean`
+
+Informa se o carregamento de dados em background está sendo executado
+ Caso o dataunit não tenha carga paralela o valor será indefinido
+
+#### Source
+
+src/dataunit/loading/PaginationInfo.ts:25
+
+***
+
 ### total?
 
 > `optional` **total**: `number`

package/.docs/interfaces/PaginationInfoBuilderParams.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / PaginationInfoBuilderParams
+
+# Interface: PaginationInfoBuilderParams
+
+## Properties
+
+### offset
+
+> **offset**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
+
+***
+
+### recordsLength
+
+> **recordsLength**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
+
+***
+
+### recordsPerPage
+
+> **recordsPerPage**: `number`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85

package/.docs/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1927
+src/dataunit/DataUnit.ts:2048
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1927
 
 #### Source
 
-src/dataunit/DataUnit.ts:1928
+src/dataunit/DataUnit.ts:2049
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1928
 
 #### Source
 
-src/dataunit/DataUnit.ts:1926
+src/dataunit/DataUnit.ts:2047

package/.docs/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1822
+src/dataunit/DataUnit.ts:1943
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1822
 
 #### Source
 
-src/dataunit/DataUnit.ts:1821
+src/dataunit/DataUnit.ts:1942
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1821
 
 #### Source
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1940
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1819
 
 #### Source
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1941

package/.docs/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1827
+src/dataunit/DataUnit.ts:1948
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1827
 
 #### Source
 
-src/dataunit/DataUnit.ts:1822
+src/dataunit/DataUnit.ts:1943
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1822
 
 #### Source
 
-src/dataunit/DataUnit.ts:1821
+src/dataunit/DataUnit.ts:1942
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1821
 
 #### Source
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1940
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1819
 
 #### Source
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1941

package/.docs/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1915
+src/dataunit/DataUnit.ts:2036
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1915
 
 #### Source
 
-src/dataunit/DataUnit.ts:1916
+src/dataunit/DataUnit.ts:2037
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1916
 
 #### Source
 
-src/dataunit/DataUnit.ts:1914
+src/dataunit/DataUnit.ts:2035

package/.docs/namespaces/MaskFormatter/type-aliases/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/.docs/namespaces/MaskFormatter/variables/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:257

package/.docs/type-aliases/DataUnitEventOptions.md

@@ -14,4 +14,4 @@
 
 ## Source
 
-src/dataunit/DataUnit.ts:1993
+src/dataunit/DataUnit.ts:2118

package/.releaserc

@@ -3,6 +3,7 @@
   "branches": [
     "master",
     { "name": "develop", "channel": "dev", "prerelease": "dev" },
+    { "name": "milestone", "channel": "ms",  "prerelease": "ms" },
     { "name": "release", "channel": "rc",  "prerelease": "rc"  }
   ],
   "plugins": [

package/dist/dataunit/DataUnit.d.ts

@@ -8,6 +8,7 @@ import { PaginationInfo } from "./loading/PaginationInfo.js";
 */
 export default class DataUnit {
     static CHANGING_PAGE_LOADING_SOURCE: string;
+    static ALL_RECORDS_SELECTION_SOURCE: string;
     static DEFAULT_DATAUNIT_NAME: string;
     private _uuid;
     private _name;
@@ -23,11 +24,14 @@ export default class DataUnit {
     private _savingLockers;
     private _defaultSorting;
     private _allowReleaseCallbacks;
+    private _waitingToReload;
+    private _cancelPagination;
     metadataLoader?: (dataUnit: DataUnit) => Promise<UnitMetadata>;
     dataLoader?: (dataUnit: DataUnit, request: LoadDataRequest) => Promise<LoadDataResponse>;
     saveLoader?: (dataUnit: DataUnit, changes: Array<Change>) => Promise<Array<SavedRecord>>;
     removeLoader?: (dataUnit: DataUnit, recordIds: Array<string>) => Promise<Array<string>>;
     recordLoader?: (dataUnit: DataUnit, recordIds: Array<string>) => Promise<Array<Record>>;
+    allRecordsLoader?: (dataUnit: DataUnit) => Array<Record> | undefined;
     constructor(name?: string, parentDataUnit?: DataUnit);
     /**
      * Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
@@ -61,6 +65,23 @@ export default class DataUnit {
      */
     getGlobalLoaderProps(): Map<string, string>;
     get dataUnitId(): string;
+    /**
+     * Retorna se o dataUnit está com recarregamento pendente.
+     */
+    isWaitingToReload(): boolean;
+    /**
+     * Define se o dataUnit tem um recarregamento pendente.
+     * @param isWaiting
+     */
+    setWaitingToReload(isWaiting: boolean): void;
+    /**
+     * Informa se a paginação deve ser cancelada.
+     */
+    get cancelPagination(): boolean;
+    /**
+     * Informa se a paginação deve ser cancelada.
+     */
+    set cancelPagination(cancelPagination: boolean);
     /**
      *
      * Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uniform Resource Identifier).
@@ -443,9 +464,10 @@ export default class DataUnit {
      * @param fieldName -Identificador do campo a ser modificado.
      * @param newValue - Valor a ser inserido no campo.
      * @param records - Indica quais registros foram afetados pela alteração no valor do campo.
+     * @param options - Configurações do evento
      * @returns - Promise que será resolvida quando o novo valor for persistido no state.
      *
-    */
+     */
     setFieldValue(fieldName: string, newValue: any, records?: Array<string>, options?: DataUnitEventOptions): Promise<boolean>;
     /**
      *
@@ -457,6 +479,18 @@ export default class DataUnit {
      *
     */
     setInvalidField(fieldName: string, message: string, recordId: string): void;
+    /**
+     *
+     *  Cancela o saving exibindo os campos invalidos.
+     *
+     * @param filds - Lista dos campos
+     * @param recordId - Indica qual registro está com os campos inválido.
+     *
+    */
+    savingCanceled(fields: Array<{
+        name: string;
+        message: string;
+    }>, recordId: string): void;
     /**
      *
      *  Limpa campos inválidos.
@@ -546,10 +580,22 @@ export default class DataUnit {
      *
      * @param selection - IDs dos registros selecionados no snapshot atual
      * @param executionCtx - Contexto de execução da seleção dos registros do DataUnit.
-     *
      * @returns - Informações sobre a seleção.
     */
     updatePageSelection(selection: Array<string>, executionCtx?: ExecutionContext): Promise<SelectionInfo | undefined>;
+    private updatePageSelectionAll;
+    /**
+     * Seleciona todos os registros da página.
+     *
+     * @returns - Informações sobre a seleção.
+     */
+    selectAllRecords(): Promise<SelectionInfo | undefined>;
+    /**
+     * Desseleciona todos os registros da página.
+     *
+     * @returns - Informações sobre a seleção.
+     */
+    unSelectAllRecords(): Promise<SelectionInfo | undefined>;
     /**
      *
      * Obtém informações sobre a seleção atual.
@@ -557,7 +603,7 @@ export default class DataUnit {
      * @returns - Objeto com informações como registros selecionados e seleção por critério.
      *
      **/
-    getSelectionInfo(): SelectionInfo | undefined;
+    getSelectionInfo(): SelectionInfo;
     /**
      *
      * Retorna apenas um registro selecionado no Dataunit
@@ -773,17 +819,17 @@ export default class DataUnit {
      * Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
      *
      * @param observer - Função que recebe como parâmetro as ações que serão monitoradas.
-     *
+     * @param uuid - Identificador do observer. Quando não informado, será gerado um identificador aleatório.
     */
-    subscribe(observer: (action: DataUnitAction, options?: DataUnitEventOptions) => void | Promise<void>): void;
+    subscribe(observer: (action: DataUnitAction, options?: DataUnitEventOptions) => void | Promise<void>, uuid?: string): string;
     /**
      *
      * Remove um observer existente.
      *
      * @param observer - Observer que se deseja remover.
-     *
+     * @param uuid - Identificador do observer. Quando não informado o delete removera com base no equals do observer.
     */
-    unsubscribe(observer: Function): void;
+    unsubscribe(observer: Function, uuid?: string): void;
     /**
      *
      * Recarrega registro selecionado com dados atualizados do servidor.
@@ -844,7 +890,7 @@ export default class DataUnit {
      * @param fieldName - nome do campo para ficar invisível.
      *
     */
-    hideField(fieldName: string): void;
+    hideField(fieldName: string, options: HideFieldOptions): void;
     /**
      *
      * Deixa um campo do DataUnit visível
@@ -993,11 +1039,12 @@ export declare enum SelectionMode {
     SOME_RECORDS = "SOME_RECORDS"
 }
 export declare class SelectionInfo {
-    private _records;
     mode: SelectionMode;
-    private _total?;
     filters?: Array<Filter>;
     sort?: Array<Sort>;
+    getAllRecords?: () => Array<Record> | undefined;
+    private _records;
+    private _total?;
     constructor(records: Array<Record>, mode?: SelectionMode, total?: number, filters?: Array<Filter>, sort?: Array<Sort>);
     get records(): Array<Record> | undefined;
     get recordIds(): Array<string> | undefined;
@@ -1008,3 +1055,6 @@ export declare class SelectionInfo {
 export type DataUnitEventOptions = {
     [key: string]: any;
 };
+export type HideFieldOptions = {
+    visibleOnConfig: boolean;
+};