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

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).
@@ -442,10 +464,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 +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.
@@ -545,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.
@@ -556,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
@@ -565,6 +612,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 +655,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 +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) => 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 +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
@@ -877,6 +939,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 +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;
@@ -988,3 +1052,9 @@ export declare class SelectionInfo {
     isAllRecords(): boolean;
     isEmpty(): boolean;
 }
+export type DataUnitEventOptions = {
+    [key: string]: any;
+};
+export type HideFieldOptions = {
+    visibleOnConfig: boolean;
+};