@sankhyalabs/core 4.4.0 → 4.4.1

package/.docs/classes/SelectionInfo.md

@@ -0,0 +1,168 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
+
+# Class: SelectionInfo
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SelectionInfo.md#constructor)
+
+### Properties
+
+- [\_records](SelectionInfo.md#_records)
+- [\_total](SelectionInfo.md#_total)
+- [filters](SelectionInfo.md#filters)
+- [mode](SelectionInfo.md#mode)
+- [sort](SelectionInfo.md#sort)
+
+### Accessors
+
+- [length](SelectionInfo.md#length)
+- [recordIds](SelectionInfo.md#recordids)
+- [records](SelectionInfo.md#records)
+
+### Methods
+
+- [isAllRecords](SelectionInfo.md#isallrecords)
+- [isEmpty](SelectionInfo.md#isempty)
+
+## Constructors
+
+### constructor
+
+• **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `records` | [`Record`](../interfaces/Record.md)[] | `undefined` |
+| `mode` | [`SelectionMode`](../enums/SelectionMode.md) | `SelectionMode.SOME_RECORDS` |
+| `total?` | `number` | `undefined` |
+| `filters?` | [`Filter`](../interfaces/Filter.md)[] | `undefined` |
+| `sort?` | [`Sort`](../interfaces/Sort.md)[] | `undefined` |
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1704
+
+## Properties
+
+### \_records
+
+• `Private` **\_records**: [`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1698
+
+___
+
+### \_total
+
+• `Private` `Optional` **\_total**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1700
+
+___
+
+### filters
+
+• `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1701
+
+___
+
+### mode
+
+• **mode**: [`SelectionMode`](../enums/SelectionMode.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1699
+
+___
+
+### sort
+
+• `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1702
+
+## Accessors
+
+### length
+
+• `get` **length**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1729
+
+___
+
+### recordIds
+
+• `get` **recordIds**(): `undefined` \| `string`[]
+
+#### Returns
+
+`undefined` \| `string`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1719
+
+___
+
+### records
+
+• `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1712
+
+## Methods
+
+### isAllRecords
+
+▸ **isAllRecords**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1736
+
+___
+
+### isEmpty
+
+▸ **isEmpty**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1740

package/.docs/enums/Action.md

@@ -29,7 +29,6 @@
 - [REMOVING\_RECORDS](Action.md#removing_records)
 - [SAVING\_DATA](Action.md#saving_data)
 - [SELECTION\_CHANGED](Action.md#selection_changed)
-- [SELECTION\_REMOVED](Action.md#selection_removed)
 - [STATE\_CHANGED](Action.md#state_changed)
 - [WAITING\_CHANGE\_CANCELED](Action.md#waiting_change_canceled)
 
@@ -71,7 +70,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:63
+src/dataunit/state/action/DataUnitAction.ts:61
 
 ___
 
@@ -121,7 +120,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:65
+src/dataunit/state/action/DataUnitAction.ts:63
 
 ___
 
@@ -131,7 +130,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:66
+src/dataunit/state/action/DataUnitAction.ts:64
 
 ___
 
@@ -265,16 +264,6 @@ src/dataunit/state/action/DataUnitAction.ts:52
 
 ___
 
-### SELECTION\_REMOVED
-
-• **SELECTION\_REMOVED** = ``"selectionRemoved"``
-
-#### Defined in
-
-src/dataunit/state/action/DataUnitAction.ts:61
-
-___
-
 ### STATE\_CHANGED
 
 • **STATE\_CHANGED** = ``"stateChanged"``

package/.docs/enums/ChangeOperation.md

@@ -19,7 +19,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1533
+src/dataunit/DataUnit.ts:1583
 
 ___
 
@@ -29,7 +29,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1535
+src/dataunit/DataUnit.ts:1585
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1532
+src/dataunit/DataUnit.ts:1582
 
 ___
 
@@ -49,4 +49,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1534
+src/dataunit/DataUnit.ts:1584

package/.docs/enums/SelectionMode.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionMode
+
+# Enumeration: SelectionMode
+
+## Table of contents
+
+### Enumeration Members
+
+- [ALL\_RECORDS](SelectionMode.md#all_records)
+- [SOME\_RECORDS](SelectionMode.md#some_records)
+
+## Enumeration Members
+
+### ALL\_RECORDS
+
+• **ALL\_RECORDS** = ``"ALL_RECORDS"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1692
+
+___
+
+### SOME\_RECORDS
+
+• **SOME\_RECORDS** = ``"SOME_RECORDS"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1693

package/.docs/interfaces/DUActionInterceptor.md

@@ -26,4 +26,4 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1511
+src/dataunit/DataUnit.ts:1566

package/.docs/interfaces/LoadDataRequest.md

@@ -9,6 +9,7 @@ Atributos enviados na requisição de carregamento dos registros
 ### Properties
 
 - [filters](LoadDataRequest.md#filters)
+- [keepSelection](LoadDataRequest.md#keepselection)
 - [limit](LoadDataRequest.md#limit)
 - [offset](LoadDataRequest.md#offset)
 - [parentRecordId](LoadDataRequest.md#parentrecordid)
@@ -29,6 +30,18 @@ src/dataunit/loading/LoadDataRequest.ts:16
 
 ___
 
+### keepSelection
+
+• `Optional` **keepSelection**: `boolean`
+
+Na navegação de páginas devemos manter a seleção
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:25
+
+___
+
 ### limit
 
 • `Optional` **limit**: `number`

package/.docs/interfaces/PageRequest.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1622
+src/dataunit/DataUnit.ts:1672
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1623
+src/dataunit/DataUnit.ts:1673
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1624
+src/dataunit/DataUnit.ts:1674

package/.docs/interfaces/QuickFilter.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1629
+src/dataunit/DataUnit.ts:1679
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1630
+src/dataunit/DataUnit.ts:1680
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1628
+src/dataunit/DataUnit.ts:1678

package/.docs/interfaces/Record.md

@@ -8,8 +8,6 @@
 
   ↳ [`SavedRecord`](SavedRecord.md)
 
-  ↳ [`AllRecord`](AllRecord.md)
-
 ## Indexable
 
 ▪ [key: `string`]: `any`
@@ -31,7 +29,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1518
+src/dataunit/DataUnit.ts:1573
 
 ___
 
@@ -41,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1517
+src/dataunit/DataUnit.ts:1572
 
 ___
 
@@ -51,7 +49,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1515
+src/dataunit/DataUnit.ts:1570
 
 ___
 
@@ -61,4 +59,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1516
+src/dataunit/DataUnit.ts:1571

package/.docs/interfaces/SavedRecord.md

@@ -26,7 +26,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1523
+src/dataunit/DataUnit.ts:1578
 
 ___
 
@@ -40,7 +40,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1518
+src/dataunit/DataUnit.ts:1573
 
 ___
 
@@ -54,7 +54,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1517
+src/dataunit/DataUnit.ts:1572
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1515
+src/dataunit/DataUnit.ts:1570
 
 ___
 
@@ -82,4 +82,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1516
+src/dataunit/DataUnit.ts:1571

package/.docs/interfaces/WaitingChange.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1617
+src/dataunit/DataUnit.ts:1667
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1618
+src/dataunit/DataUnit.ts:1668
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1616
+src/dataunit/DataUnit.ts:1666

package/.docs/modules.md

@@ -14,6 +14,7 @@
 - [ChangeOperation](enums/ChangeOperation.md)
 - [DataType](enums/DataType.md)
 - [DependencyType](enums/DependencyType.md)
+- [SelectionMode](enums/SelectionMode.md)
 - [SortMode](enums/SortMode.md)
 - [UserInterface](enums/UserInterface.md)
 
@@ -38,6 +39,7 @@
 - [ObjectUtils](classes/ObjectUtils.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [RequestMetadata](classes/RequestMetadata.md)
+- [SelectionInfo](classes/SelectionInfo.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)
@@ -47,7 +49,6 @@
 
 ### Interfaces
 
-- [AllRecord](interfaces/AllRecord.md)
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)

package/README.md

@@ -52,4 +52,6 @@ $ npm t
 $ npm run build --watch
 ```
 
-Veja mais informações em nossa [Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)
+Veja mais informações em nossa [Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)
+
+

package/dist/dataunit/DataUnit.d.ts

@@ -130,6 +130,7 @@ export default class DataUnit {
      *
     */
     previousPage(executionCtx?: ExecutionContext): Promise<LoadDataResponse | void>;
+    private getLoadDataRequest;
     private notifySavingData;
     /**
      *
@@ -429,79 +430,67 @@ export default class DataUnit {
      *
     */
     cancelWaitingChange(fieldName: string): void;
-    /**
-     * Obtém todos os registros selecionados.
-     *
-     * @returns - Lista de todos os registros selecionados.
-    */
-    getSelection(): Array<Record>;
     /**
      *
-     * Seleciona múltiplos registros.
-     *
-     * @param selection - Registros para selecionar.
-     * @param executionCtx - Contexto de execução da seleção dos registros do DataUnit.
+     * Seleciona o primeiro registro.
      *
-     * @returns - Verdadeiro se ação executada.
+     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
      *
     */
-    setSelection(selection: Array<Record>, executionCtx?: ExecutionContext): Promise<boolean>;
+    selectFirst(executionCtx?: ExecutionContext): void;
     /**
      *
-     * Remove a seleção de múltiplos registros.
-     *
-     * @param unselection - Registros para remover a seleção.
-     * @param executionCtx - Contexto de execução da remoção da seleção dos registros do DataUnit.
+     * Seleciona o último registro.
      *
-     * @returns - Verdadeiro se ação executada.
+     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
      *
     */
-    setUnselection(unselection: Array<Record>, executionCtx?: ExecutionContext): Promise<boolean>;
+    selectLast(executionCtx?: ExecutionContext): void;
     /**
      *
-     * Remove a seleção de todos os registros.
-     *
-     * @param executionCtx - Contexto de execução da remoção da seleção dos registros do DataUnit.
+     * Seleciona múltiplos registros por índice.
      *
-     * @returns - Verdadeiro se ação executada.
+     * @param selection - Índices desejados para a seleção.
+     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
      *
     */
-    clearSelection(executionCtx?: ExecutionContext): Promise<boolean>;
+    setSelectionByIndex(selection: Array<number>, executionCtx?: ExecutionContext): void;
     /**
      *
-     * Seleciona o primeiro registro.
+     * Seleciona múltiplos registros por ID ou todos os registros (multipágina) .
+     *
+     * @param selection - IDs para selecionar ou o modo de seleção completo.
+     * @param executionCtx - Contexto de execução da seleção dos registros do DataUnit.
      *
-     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
      *
     */
-    selectFirst(executionCtx?: ExecutionContext): void;
+    setSelection(selection: Array<string> | SelectionMode.ALL_RECORDS, executionCtx?: ExecutionContext): Promise<SelectionInfo>;
     /**
      *
-     * Seleciona o último registro.
+     * Limpa a seleção.
      *
-     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
+     * @param executionCtx - Contexto de execução da seleção dos registros do DataUnit.
      *
     */
-    selectLast(executionCtx?: ExecutionContext): void;
+    clearSelection(executionCtx?: ExecutionContext): void;
     /**
      *
-     * Seleciona múltiplos registros por índice.
-     *
-     * @param selection - Índices desejados para a seleção.
-     * @param executionCtx - Contexto de execução da seleção do registro do DataUnit.
+     * Atualiza a seleção dos registros atuais.
      *
-     * @returns - Verdadeiro se ação executada.
+     * @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.
     */
-    setSelectionByIndex(selection: Array<number>, executionCtx?: ExecutionContext): Promise<boolean>;
+    updatePageSelection(selection: Array<string>, executionCtx?: ExecutionContext): Promise<SelectionInfo | undefined>;
     /**
      *
-     * Obtém os registros selecionados da página atual.
+     * Obtém informações sobre a seleção atual.
      *
-     * @returns - Lista de registros selecionados da página atual.
+     * @returns - Objeto com informações como registros selecionados e seleção por critério.
      *
-    */
-    getSelectedRecords(): Array<Record> | undefined;
+     **/
+    getSelectionInfo(): SelectionInfo | undefined;
     /**
      *
      * Retorna apenas um registro selecionado no Dataunit
@@ -515,7 +504,6 @@ export default class DataUnit {
      * Limpa todos os registros do DataUnit
      *
      *
-     *
     */
     clearDataUnit(): void;
     /**
@@ -773,6 +761,30 @@ export default class DataUnit {
      *
     */
     showField(fieldName: string): void;
+    /**
+     *
+     * Obtém todos os registros selecionados.
+     *
+     * @returns - Lista de registros selecionados.
+     *
+     * @deprecated - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
+     * Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
+     * método foi descontinuado e pode retornar erros no caso da seleção virtual.
+     *
+    */
+    getSelectedRecords(): Array<Record> | undefined;
+    /**
+     *
+     * Obtém ids dos registros selecionados.
+     *
+     * @returns - Lista com id de todos os registros selecionados.
+     *
+     * @deprecated - Utilize o método `getSelectionInfo()` para obter os registros selecionados.
+     * Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
+     * método foi descontinuado e pode retornar erros no caso da seleção virtual.
+     *
+    */
+    getSelection(): Array<string>;
 }
 export interface DUActionInterceptor {
     interceptAction(action: DataUnitAction): DataUnitAction | Promise<DataUnitAction>;
@@ -787,10 +799,6 @@ export interface Record {
 export interface SavedRecord extends Record {
     __old__id__?: string;
 }
-export interface AllRecord extends Record {
-    filter: Array<Filter>;
-    sort: Array<Sort>;
-}
 export declare enum ChangeOperation {
     INSERT = "INSERT",
     COPY = "COPY",
@@ -870,3 +878,20 @@ export interface PageResponse {
     hasMore: boolean;
     records: Array<Record>;
 }
+export declare enum SelectionMode {
+    ALL_RECORDS = "ALL_RECORDS",
+    SOME_RECORDS = "SOME_RECORDS"
+}
+export declare class SelectionInfo {
+    private _records;
+    mode: SelectionMode;
+    private _total?;
+    filters?: Array<Filter>;
+    sort?: Array<Sort>;
+    constructor(records: Array<Record>, mode?: SelectionMode, total?: number, filters?: Array<Filter>, sort?: Array<Sort>);
+    get records(): Array<Record> | undefined;
+    get recordIds(): Array<string> | undefined;
+    get length(): number;
+    isAllRecords(): boolean;
+    isEmpty(): boolean;
+}