@sankhyalabs/core 5.20.0-dev.6 → 5.20.0-dev.60

package/.docs/enumerations/OverflowDirection.md

@@ -0,0 +1,29 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverflowDirection
+
+# Enumeration: OverflowDirection
+
+Define em qual direção o overflow será observado
+
+## Enumeration Members
+
+### HORIZONTAL
+
+> **HORIZONTAL**: `1`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:6
+
+***
+
+### VERTICAL
+
+> **VERTICAL**: `0`
+
+#### Source
+
+src/utils/OverflowWatcher/types/overflow-direction.ts:5

package/.docs/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1902
+src/dataunit/DataUnit.ts:2022
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1902
 
 #### Source
 
-src/dataunit/DataUnit.ts:1903
+src/dataunit/DataUnit.ts:2023

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,8 +14,11 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
+- [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -38,15 +41,20 @@
 - [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)
 - [OnboardingUtils](classes/OnboardingUtils.md)
+- [OverflowWatcher](classes/OverflowWatcher.md)
 - [PromiseSync](classes/PromiseSync.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [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)
@@ -69,6 +77,7 @@
 - [IRepositoryIndex](interfaces/IRepositoryIndex.md)
 - [LoadDataRequest](interfaces/LoadDataRequest.md)
 - [LoadDataResponse](interfaces/LoadDataResponse.md)
+- [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
@@ -80,6 +89,15 @@
 - [UnitMetadata](interfaces/UnitMetadata.md)
 - [WaitingChange](interfaces/WaitingChange.md)
 
+## Type Aliases
+
+- [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
+- [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
+
+## Variables
+
+- [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
+
 ## Functions
 
 - [defaultDataLoader](functions/defaultDataLoader.md)

package/.docs/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1777
+src/dataunit/DataUnit.ts:1897

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/OverFlowWatcherParams.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OverFlowWatcherParams
+
+# Interface: OverFlowWatcherParams
+
+## Properties
+
+### callback
+
+> **callback**: [`OnOverflowCallBack`](../type-aliases/OnOverflowCallBack.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:233
+
+***
+
+### debounce?
+
+> `optional` **debounce**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:236
+
+***
+
+### deltaSize?
+
+> `optional` **deltaSize**: `number`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:235
+
+***
+
+### element
+
+> **element**: `HTMLElement`
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:232
+
+***
+
+### notOverFlow?
+
+> `optional` **notOverFlow**: `string`[]
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:237
+
+***
+
+### overFlowDirection?
+
+> `optional` **overFlowDirection**: [`OverflowDirection`](../enumerations/OverflowDirection.md)
+
+#### Source
+
+src/utils/OverflowWatcher/index.ts:234

package/.docs/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1882
+src/dataunit/DataUnit.ts:2002
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1882
 
 #### Source
 
-src/dataunit/DataUnit.ts:1883
+src/dataunit/DataUnit.ts:2003
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1883
 
 #### Source
 
-src/dataunit/DataUnit.ts:1884
+src/dataunit/DataUnit.ts:2004

package/.docs/interfaces/PaginationInfo.md

@@ -70,6 +70,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/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1889
+src/dataunit/DataUnit.ts:2009
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1889
 
 #### Source
 
-src/dataunit/DataUnit.ts:1890
+src/dataunit/DataUnit.ts:2010
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1890
 
 #### Source
 
-src/dataunit/DataUnit.ts:1888
+src/dataunit/DataUnit.ts:2008

package/.docs/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1783
 
 #### Source
 
-src/dataunit/DataUnit.ts:1781
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1781
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1902

package/.docs/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1789
+src/dataunit/DataUnit.ts:1909
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1789
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1904
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1903
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1783
 
 #### Source
 
-src/dataunit/DataUnit.ts:1781
+src/dataunit/DataUnit.ts:1901
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1781
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1902

package/.docs/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1877
+src/dataunit/DataUnit.ts:1997
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1877
 
 #### Source
 
-src/dataunit/DataUnit.ts:1878
+src/dataunit/DataUnit.ts:1998
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1878
 
 #### Source
 
-src/dataunit/DataUnit.ts:1876
+src/dataunit/DataUnit.ts:1996

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

@@ -0,0 +1,17 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitEventOptions
+
+# Type alias: DataUnitEventOptions
+
+> **DataUnitEventOptions**: `object`
+
+## Index signature
+
+ \[`key`: `string`\]: `any`
+
+## Source
+
+src/dataunit/DataUnit.ts:2079

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

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OnOverflowCallBack
+
+# Type alias: OnOverflowCallBack()
+
+> **OnOverflowCallBack**: (`elementsOverFlow`) => `void`
+
+Callback que será chamado quando o overflow de um elemento for alterado.
+
+## Parameters
+
+• **elementsOverFlow**: `Element`[]
+
+Conjunto de elementos filhos que estão causando overflow no elemento pai.
+
+## Returns
+
+`void`
+
+## Source
+
+src/utils/OverflowWatcher/types/overflow-callback.ts:6

package/.docs/variables/OVERFLOWED_CLASS_NAME.md

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / OVERFLOWED\_CLASS\_NAME
+
+# Variable: OVERFLOWED\_CLASS\_NAME
+
+> `const` **OVERFLOWED\_CLASS\_NAME**: `"overflowed"` = `'overflowed'`
+
+## Source
+
+src/utils/OverflowWatcher/index.ts:9

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;
@@ -22,11 +23,14 @@ export default class DataUnit {
     private _loadingLockers;
     private _savingLockers;
     private _defaultSorting;
+    private _allowReleaseCallbacks;
+    private _waitingToReload;
     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.
@@ -60,6 +64,15 @@ 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;
     /**
      *
      * Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uniform Resource Identifier).
@@ -442,10 +455,11 @@ 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>): Promise<boolean>;
+     */
+    setFieldValue(fieldName: string, newValue: any, records?: Array<string>, options?: DataUnitEventOptions): Promise<boolean>;
     /**
      *
      *  Marca campos como inválidos.
@@ -456,6 +470,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.
@@ -556,7 +582,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
@@ -565,6 +591,12 @@ export default class DataUnit {
      *
     */
     getSelectedRecord(): Record | undefined;
+    /**
+     * Retorna o DataUnit pai
+     *
+     * @returns DataUnit pai ou undefined
+     */
+    getParentDataUnit(): DataUnit | undefined;
     /**
      *
      * Limpa todos os registros do DataUnit
@@ -602,10 +634,19 @@ export default class DataUnit {
      *
      * Retorna se existe algum tipo de alteração pendente.
      *
+     * @param ignoreChildren: Define se deverá ignorar alterações pendentes no DataUnit filho.
      * @returns Verdadeiro se existir alterações pendentes.
      *
     */
-    isDirty(): boolean;
+    isDirty(ignoreChildren?: boolean): boolean;
+    /**
+     *
+     * Retorna se existe alterações pendentes no DataUnit pai.
+     *
+     * @returns Verdadeiro se existir alterações pendentes e Falso caso não exista alterações ou não exista DataUnit pai.
+     *
+     */
+    isParentDirty(): boolean;
     /**
      *
      * Retorna se existe algum DataUnit detail com alterações pendentes.
@@ -757,17 +798,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) => 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.
@@ -828,7 +869,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
@@ -877,6 +918,7 @@ export default class DataUnit {
      * @returns Retorna uma função responsável por liberar o lock adicionado.
      */
     addLoadingLocker(): Function;
+    set allowReleaseCallbacks(allow: boolean);
     private processLoadingLockers;
 }
 export interface DUActionInterceptor {
@@ -976,11 +1018,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;
@@ -988,3 +1031,9 @@ export declare class SelectionInfo {
     isAllRecords(): boolean;
     isEmpty(): boolean;
 }
+export type DataUnitEventOptions = {
+    [key: string]: any;
+};
+export type HideFieldOptions = {
+    visibleOnConfig: boolean;
+};