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

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:1789
 
-___
+***
 
-### \_\_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:1784
 
-___
+***
 
-### \_\_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:1783
 
-___
+***
 
 ### \_\_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:1781
 
-___
+***
 
-### \_\_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:1782

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:1877
 
-___
+***
 
-### promise
+### promise?
 
-• `Optional` **promise**: `Promise`<`any`\>
+> `optional` **promise**: `Promise`\<`any`\>
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1844
+src/dataunit/DataUnit.ts:1878
 
-___
+***
 
 ### waitmessage
 
-• **waitmessage**: `string`
+> **waitmessage**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1842
+src/dataunit/DataUnit.ts:1876

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

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

package/dist/dataunit/DataUnit.d.ts

@@ -43,6 +43,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;
     /**
      *

package/dist/dataunit/DataUnit.js

@@ -28,6 +28,7 @@ import { getFormattedValue } from "./formatting/PrettyFormatter.js";
 import { v4 as uuid } from "uuid";
 import { DataUnitStorage } from "./DataUnitStorage.js";
 import { getInvalidFieldMessage, InvalidFieldsReducer } from "./state/slice/InvalidFieldsSlice.js";
+import { getLoadingProperties, LoadingPropertiesReducer } from "./state/slice/LoadingProperties.js";
 /***
  * `DataUnit`: Atua como uma camada de abstração entre o back-end e a interface do usuário.
 */
@@ -62,6 +63,7 @@ export default class DataUnit {
         this._pageSize = 0;
         this._stateManager = new StateManager([
             HistReducer,
+            LoadingPropertiesReducer,
             UnitMetadataReducer,
             LoadingControlReducer,
             RecordsReducer,
@@ -110,6 +112,26 @@ export default class DataUnit {
         this._sortingProvider = undefined;
         this._interceptors = [];
     }
+    /**
+     * 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, value) {
+        this.dispatchAction(Action.LOADING_PROPERTY_ADDED, { [name]: value });
+    }
+    /**
+     * Retorna as propriedades transacionais adicionados anteriores à chamada.
+     *
+     * @returns - Todas as propriedades desde o final do último loader.
+     */
+    getGlobalLoaderProps() {
+        return getLoadingProperties(this._stateManager) || new Map();
+    }
     get dataUnitId() {
         return this._uuid;
     }
@@ -182,6 +204,7 @@ export default class DataUnit {
                 if (this.dataLoader) {
                     this.dataLoader(this, request).then(response => {
                         this.dispatchAction(Action.DATA_LOADED, Object.assign(Object.assign({}, response), { keepSelection: request.keepSelection, filters: request.filters }), executionCtx);
+                        this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                         if (selectFirstRecord) {
                             this.requestSelectFirst(executionCtx);
                         }
@@ -189,6 +212,7 @@ export default class DataUnit {
                     }).catch(error => {
                         console.error(error);
                         const { errorCode } = error;
+                        this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                         fail(new ErrorException("Erro ao carregar registros", error, errorCode));
                     });
                 }
@@ -368,6 +392,7 @@ export default class DataUnit {
                                 if (this.saveLoader) {
                                     const changes = this.getAllChangesToSave();
                                     this.saveLoader(this, changes).then((records) => {
+                                        this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                         const recordsByDataUnit = this.getRecordsByDataUnit(records);
                                         const dispatchPromisses = [];
                                         for (const [ownerDataUnitName, splittedRecords] of recordsByDataUnit) {
@@ -380,10 +405,12 @@ export default class DataUnit {
                                         Promise.all(dispatchPromisses).then(() => resolve());
                                     }).catch(cause => {
                                         const { errorCode } = cause;
+                                        this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                         fail(new ErrorException("Erro ao salvar alterações", cause, errorCode));
                                     });
                                 }
                                 else {
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     resolve();
                                 }
                             });
@@ -471,6 +498,7 @@ export default class DataUnit {
         return __awaiter(this, void 0, void 0, function* () {
             if (recordIds) {
                 if (buffered || !this.removeLoader) {
+                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                     this.dispatchAction(Action.RECORDS_REMOVED, { records: recordIds, cachedRecords, buffered: true }, executionCtx);
                 }
                 else {
@@ -485,8 +513,10 @@ export default class DataUnit {
                                     const nextIndex = Math.min(removedIndex.slice(-1)[0] + 1, currentRecordsKeys.length);
                                     const selectionAfterRemove = [currentRecordsKeys[nextIndex]];
                                     this.dispatchAction(Action.RECORDS_REMOVED, { records: removedIds, cachedRecords, removedIndex, buffered: false, selectionAfterRemove }, executionCtx);
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     resolve(removedIds);
                                 }).catch(error => {
+                                    this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                                     const { errorCode } = error;
                                     fail(new ErrorException("Erro ao remover registros", error, errorCode));
                                 });
@@ -1391,13 +1421,15 @@ export default class DataUnit {
         return new Promise((resolve, fail) => __awaiter(this, void 0, void 0, function* () {
             const selection = getSelection(this._stateManager);
             this.dispatchAction(Action.LOADING_RECORD, selection);
-            if (!this.dataLoader)
-                return;
-            if (!this.recordLoader)
+            if (!this.recordLoader || !this.dataLoader) {
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                 return;
+            }
             this.recordLoader(this, selection).then(response => {
                 this.dispatchAction(Action.RECORD_LOADED, response);
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
             }).catch(cause => {
+                this.dispatchAction(Action.LOADING_PROPERTIES_CLEANED);
                 const { errorCode } = cause;
                 fail(new ErrorException("Erro ao recarregar registro", cause, errorCode));
             });