@sankhyalabs/core 5.20.0-dev.4 → 5.20.0-dev.41

package/.docs/interfaces/Record.md

@@ -1,62 +1,55 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: Record
-
-## Hierarchy
-
-- **`Record`**
+***
 
-  ↳ [`SavedRecord`](SavedRecord.md)
+[@sankhyalabs/core](../globals.md) / Record
 
-## Indexable
+# Interface: Record
 
-▪ [key: `string`]: `any`
+## Extended by
 
-## Table of contents
+- [`SavedRecord`](SavedRecord.md)
 
-### Properties
+## Indexable
 
-- [\_\_owner\_\_dataunit\_\_name\_\_](Record.md#__owner__dataunit__name__)
-- [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
-- [\_\_record\_\_id\_\_](Record.md#__record__id__)
-- [\_\_record\_\_label\_\_](Record.md#__record__label__)
+ \[`key`: `string`\]: `any`
 
 ## Properties
 
-### \_\_owner\_\_dataunit\_\_name\_\_
+### \_\_owner\_\_dataunit\_\_name\_\_?
 
-• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+> `optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1750
+src/dataunit/DataUnit.ts:1844
 
-___
+***
 
-### \_\_parent\_\_record\_\_id\_\_
+### \_\_parent\_\_record\_\_id\_\_?
 
-• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+> `optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1749
+src/dataunit/DataUnit.ts:1843
 
-___
+***
 
 ### \_\_record\_\_id\_\_
 
-• **\_\_record\_\_id\_\_**: `string`
+> **\_\_record\_\_id\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1747
+src/dataunit/DataUnit.ts:1841
 
-___
+***
 
-### \_\_record\_\_label\_\_
+### \_\_record\_\_label\_\_?
 
-• `Optional` **\_\_record\_\_label\_\_**: `string`
+> `optional` **\_\_record\_\_label\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1748
+src/dataunit/DataUnit.ts:1842

package/.docs/interfaces/SavedRecord.md

@@ -1,85 +1,77 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SavedRecord
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: SavedRecord
-
-## Hierarchy
-
-- [`Record`](Record.md)
+***
 
-  ↳ **`SavedRecord`**
+[@sankhyalabs/core](../globals.md) / SavedRecord
 
-## Table of contents
+# Interface: SavedRecord
 
-### Properties
+## Extends
 
-- [\_\_old\_\_id\_\_](SavedRecord.md#__old__id__)
-- [\_\_owner\_\_dataunit\_\_name\_\_](SavedRecord.md#__owner__dataunit__name__)
-- [\_\_parent\_\_record\_\_id\_\_](SavedRecord.md#__parent__record__id__)
-- [\_\_record\_\_id\_\_](SavedRecord.md#__record__id__)
-- [\_\_record\_\_label\_\_](SavedRecord.md#__record__label__)
+- [`Record`](Record.md)
 
 ## Properties
 
-### \_\_old\_\_id\_\_
+### \_\_old\_\_id\_\_?
 
-• `Optional` **\_\_old\_\_id\_\_**: `string`
+> `optional` **\_\_old\_\_id\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1755
+src/dataunit/DataUnit.ts:1849
 
-___
+***
 
-### \_\_owner\_\_dataunit\_\_name\_\_
+### \_\_owner\_\_dataunit\_\_name\_\_?
 
-• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+> `optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
 
 #### Inherited from
 
-[Record](Record.md).[__owner__dataunit__name__](Record.md#__owner__dataunit__name__)
+[`Record`](Record.md).[`__owner__dataunit__name__`](Record.md#__owner__dataunit__name__)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1750
+src/dataunit/DataUnit.ts:1844
 
-___
+***
 
-### \_\_parent\_\_record\_\_id\_\_
+### \_\_parent\_\_record\_\_id\_\_?
 
-• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+> `optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
 
 #### Inherited from
 
-[Record](Record.md).[__parent__record__id__](Record.md#__parent__record__id__)
+[`Record`](Record.md).[`__parent__record__id__`](Record.md#__parent__record__id__)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1749
+src/dataunit/DataUnit.ts:1843
 
-___
+***
 
 ### \_\_record\_\_id\_\_
 
-• **\_\_record\_\_id\_\_**: `string`
+> **\_\_record\_\_id\_\_**: `string`
 
 #### Inherited from
 
-[Record](Record.md).[__record__id__](Record.md#__record__id__)
+[`Record`](Record.md).[`__record__id__`](Record.md#__record__id__)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1747
+src/dataunit/DataUnit.ts:1841
 
-___
+***
 
-### \_\_record\_\_label\_\_
+### \_\_record\_\_label\_\_?
 
-• `Optional` **\_\_record\_\_label\_\_**: `string`
+> `optional` **\_\_record\_\_label\_\_**: `string`
 
 #### Inherited from
 
-[Record](Record.md).[__record__label__](Record.md#__record__label__)
+[`Record`](Record.md).[`__record__label__`](Record.md#__record__label__)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1748
+src/dataunit/DataUnit.ts:1842

package/.docs/interfaces/Sort.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Sort
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: Sort
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / Sort
 
-- [dataType](Sort.md#datatype)
-- [field](Sort.md#field)
-- [mode](Sort.md#mode)
+# Interface: Sort
 
 ## Properties
 
 ### dataType
 
-• **dataType**: [`DataType`](../enums/DataType.md)
+> **dataType**: [`DataType`](../enumerations/DataType.md)
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:58
 
-___
+***
 
 ### field
 
-• **field**: `string`
+> **field**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:56
 
-___
+***
 
 ### mode
 
-• **mode**: [`SortMode`](../enums/SortMode.md)
+> **mode**: [`SortMode`](../enumerations/SortMode.md)
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:57

package/.docs/interfaces/SortingProvider.md

@@ -1,30 +1,27 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortingProvider
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: SortingProvider
-
-## Table of contents
+***
 
-### Methods
+[@sankhyalabs/core](../globals.md) / SortingProvider
 
-- [getSort](SortingProvider.md#getsort)
+# Interface: SortingProvider
 
 ## Methods
 
-### getSort
+### getSort()
 
-▸ **getSort**(`dataUnit`, `defaultSorting`): `undefined` \| [`Sort`](Sort.md)[]
+> **getSort**(`dataUnit`, `defaultSorting`): `undefined` \| [`Sort`](Sort.md)[]
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `dataUnit` | `string` |
-| `defaultSorting` | [`Sort`](Sort.md)[] |
+• **dataUnit**: `string`
+
+• **defaultSorting**: [`Sort`](Sort.md)[]
 
 #### Returns
 
 `undefined` \| [`Sort`](Sort.md)[]
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:67

package/.docs/interfaces/UnitMetadata.md

@@ -1,52 +1,47 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UnitMetadata
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: UnitMetadata
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / UnitMetadata
 
-- [children](UnitMetadata.md#children)
-- [fields](UnitMetadata.md#fields)
-- [label](UnitMetadata.md#label)
-- [name](UnitMetadata.md#name)
+# Interface: UnitMetadata
 
 ## Properties
 
-### children
+### children?
 
-• `Optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
+> `optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:7
 
-___
+***
 
 ### fields
 
-• **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
+> **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:6
 
-___
+***
 
 ### label
 
-• **label**: `string`
+> **label**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:5
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:4

package/.docs/interfaces/WaitingChange.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChange
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: WaitingChange
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / WaitingChange
 
-- [blocking](WaitingChange.md#blocking)
-- [promise](WaitingChange.md#promise)
-- [waitmessage](WaitingChange.md#waitmessage)
+# Interface: WaitingChange
 
 ## Properties
 
 ### blocking
 
-• **blocking**: `boolean`
+> **blocking**: `boolean`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1843
+src/dataunit/DataUnit.ts:1937
 
-___
+***
 
-### promise
+### promise?
 
-• `Optional` **promise**: `Promise`<`any`\>
+> `optional` **promise**: `Promise`\<`any`\>
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1844
+src/dataunit/DataUnit.ts:1938
 
-___
+***
 
 ### waitmessage
 
-• **waitmessage**: `string`
+> **waitmessage**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1842
+src/dataunit/DataUnit.ts:1936

package/.docs/namespaces/MaskFormatter/README.md

@@ -0,0 +1,17 @@
+[**@sankhyalabs/core**](../../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../../globals.md) / MaskFormatter
+
+# Namespace: MaskFormatter
+
+## Index
+
+### Type Aliases
+
+- [MaskCharacter](type-aliases/MaskCharacter.md)
+
+### Variables
+
+- [MaskCharacter](variables/MaskCharacter.md)

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

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../../../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../../../globals.md) / [MaskFormatter](../README.md) / MaskCharacter
+
+# Type alias: MaskCharacter
+
+> **MaskCharacter**: `InstanceType`\<*typeof* [`MaskCharacter`](../variables/MaskCharacter.md)\>
+
+## Source
+
+src/utils/MaskFormatter.ts:170

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

@@ -0,0 +1,13 @@
+[**@sankhyalabs/core**](../../../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../../../globals.md) / [MaskFormatter](../README.md) / MaskCharacter
+
+# Variable: MaskCharacter
+
+> **MaskCharacter**: *typeof* `__class`
+
+## Source
+
+src/utils/MaskFormatter.ts:170

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

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,13 @@ export default class DataUnit {
     private _loadingLockers;
     private _savingLockers;
     private _defaultSorting;
+    private _allowReleaseCallbacks;
     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.
@@ -43,6 +46,22 @@ export default class DataUnit {
      * - Sorting Providers
      */
     releaseCallbacks(): void;
+    /**
+     * Adiciona uma propriedade transacional que será envida aos
+     * loaders (dataLoader, saveLoader, removeLoader e recordLoader) na chamada.
+     * Essas propriedades serão limpas ao final da execução de cada método.
+     *
+     * @param name - Nome da propriedade
+     * @param value - Valor da propriedade
+     *
+     */
+    addGlobalLoaderProp(name: string, value: string): void;
+    /**
+     * Retorna as propriedades transacionais adicionados anteriores à chamada.
+     *
+     * @returns - Todas as propriedades desde o final do último loader.
+     */
+    getGlobalLoaderProps(): Map<string, string>;
     get dataUnitId(): string;
     /**
      *
@@ -429,7 +448,7 @@ export default class DataUnit {
      * @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.
@@ -540,7 +559,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
@@ -549,6 +568,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
@@ -586,10 +611,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.
@@ -743,7 +777,7 @@ export default class DataUnit {
      * @param observer - Função que recebe como parâmetro as ações que serão monitoradas.
      *
     */
-    subscribe(observer: (action: DataUnitAction) => void): void;
+    subscribe(observer: (action: DataUnitAction, options?: DataUnitEventOptions) => void | Promise<void>): void;
     /**
      *
      * Remove um observer existente.
@@ -861,6 +895,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 {
@@ -960,11 +995,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;
@@ -972,3 +1008,6 @@ export declare class SelectionInfo {
     isAllRecords(): boolean;
     isEmpty(): boolean;
 }
+export type DataUnitEventOptions = {
+    [key: string]: any;
+};