@sankhyalabs/core 5.20.0-dev.8 → 5.20.0-dev.80

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:1890
+src/dataunit/DataUnit.ts:2072
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1890
 
 #### Source
 
-src/dataunit/DataUnit.ts:1891
+src/dataunit/DataUnit.ts:2073
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1891
 
 #### Source
 
-src/dataunit/DataUnit.ts:1889
+src/dataunit/DataUnit.ts:2071

package/.docs/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1967
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1785
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1966
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1964
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1782
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1965

package/.docs/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1790
+src/dataunit/DataUnit.ts:1972
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1790
 
 #### Source
 
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1967
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1785
 
 #### Source
 
-src/dataunit/DataUnit.ts:1784
+src/dataunit/DataUnit.ts:1966
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1784
 
 #### Source
 
-src/dataunit/DataUnit.ts:1782
+src/dataunit/DataUnit.ts:1964
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1782
 
 #### Source
 
-src/dataunit/DataUnit.ts:1783
+src/dataunit/DataUnit.ts:1965

package/.docs/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1878
+src/dataunit/DataUnit.ts:2060
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1878
 
 #### Source
 
-src/dataunit/DataUnit.ts:1879
+src/dataunit/DataUnit.ts:2061
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1879
 
 #### Source
 
-src/dataunit/DataUnit.ts:1877
+src/dataunit/DataUnit.ts:2059

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:2142

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/.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;
@@ -22,11 +23,15 @@ export default class DataUnit {
     private _loadingLockers;
     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.
@@ -60,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).
@@ -120,6 +142,7 @@ export default class DataUnit {
      *
     */
     loadMetadata(executionCtx?: ExecutionContext): Promise<UnitMetadata | void>;
+    loadDataWithParams({ source, keepSelection, selectFirstRecord, executionCtx, checkLastFilter, quickFilter }: LoadDataParams): Promise<LoadDataResponse>;
     /**
      *
      * Carrega os registros do DataUnit.
@@ -131,7 +154,7 @@ export default class DataUnit {
      * @returns - Registros requisitados.
      *
     */
-    loadData(quickFilter?: QuickFilter, executionCtx?: ExecutionContext, checkLastFilter?: boolean, source?: string, selectFirstRecord?: boolean): Promise<LoadDataResponse>;
+    loadData(quickFilter?: QuickFilter, executionCtx?: ExecutionContext, checkLastFilter?: boolean, source?: string, selectFirstRecord?: boolean, keepSelection?: boolean): Promise<LoadDataResponse>;
     /**
      *
      * Alterna entre os registros por número de página.
@@ -442,10 +465,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 +480,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.
@@ -545,10 +581,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.
@@ -556,7 +604,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 +613,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 +656,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 +820,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 +891,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,8 +940,17 @@ 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 LoadDataParams {
+    quickFilter?: QuickFilter;
+    executionCtx?: ExecutionContext;
+    checkLastFilter?: boolean;
+    source?: string;
+    selectFirstRecord?: boolean;
+    keepSelection?: boolean;
+}
 export interface DUActionInterceptor {
     interceptAction(action: DataUnitAction): DataUnitAction | Promise<DataUnitAction>;
 }
@@ -976,11 +1048,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 +1061,9 @@ export declare class SelectionInfo {
     isAllRecords(): boolean;
     isEmpty(): boolean;
 }
+export type DataUnitEventOptions = {
+    [key: string]: any;
+};
+export type HideFieldOptions = {
+    visibleOnConfig: boolean;
+};