@sankhyalabs/core-docs 0.0.0-hotfix-rc-KB-83760.0 → 0.0.0-hotfix-ga-KB-91371.0

package/classes/DataUnitInMemoryLoader.md

@@ -0,0 +1,303 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoader
+
+# Class: DataUnitInMemoryLoader
+
+## Constructors
+
+### new DataUnitInMemoryLoader()
+
+> **new DataUnitInMemoryLoader**(`metadata`?, `records`?, `config`?): [`DataUnitInMemoryLoader`](DataUnitInMemoryLoader.md)
+
+#### Parameters
+
+• **metadata?**: [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+• **records?**: [`Record`](../interfaces/Record.md)[]
+
+• **config?**: [`DataUnitInMemoryLoaderConfig`](../interfaces/DataUnitInMemoryLoaderConfig.md)
+
+#### Returns
+
+[`DataUnitInMemoryLoader`](DataUnitInMemoryLoader.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:26
+
+## Properties
+
+### \_dataUnit
+
+> `private` **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:19
+
+***
+
+### \_initialRecords
+
+> `private` **\_initialRecords**: [`Record`](../interfaces/Record.md)[] = `[]`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:21
+
+***
+
+### \_metadata
+
+> `private` **\_metadata**: `undefined` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:20
+
+***
+
+### recordDateFormat
+
+> `private` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:22
+
+***
+
+### DEFAULT\_PAGE\_SIZE
+
+> `static` `readonly` **DEFAULT\_PAGE\_SIZE**: `150` = `150`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:24
+
+***
+
+### IN\_MEMORY\_DATA\_UNIT\_NAME
+
+> `static` `readonly` **IN\_MEMORY\_DATA\_UNIT\_NAME**: `"InMemoryDataUnit"` = `'InMemoryDataUnit'`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:23
+
+## Accessors
+
+### dataUnit
+
+> `get` **dataUnit**(): [`DataUnit`](DataUnit.md)
+
+#### Returns
+
+[`DataUnit`](DataUnit.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:58
+
+***
+
+### metadata
+
+> `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+> `set` **metadata**(`metadata`): `void`
+
+#### Parameters
+
+• **metadata**: [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Returns
+
+[`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:122
+
+***
+
+### records
+
+> `get` **records**(): [`Record`](../interfaces/Record.md)[]
+
+> `set` **records**(`records`): `void`
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:62
+
+## Methods
+
+### buildColumns()
+
+> `private` **buildColumns**(): `undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Returns
+
+`undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:92
+
+***
+
+### buildInitialRecords()
+
+> `private` **buildInitialRecords**(`records`, `columns`): [`Record`](../interfaces/Record.md)[]
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **columns**: `undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:98
+
+***
+
+### generateUniqueId()
+
+> `private` **generateUniqueId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:134
+
+***
+
+### getRecordsToLoad()
+
+> `private` **getRecordsToLoad**(): [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:46
+
+***
+
+### inMemoryLoader()
+
+> `private` **inMemoryLoader**(`dataUnit`, `request`, `recordsIn`): `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+• **dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+• **recordsIn**: [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:138
+
+***
+
+### metadaLoader()
+
+> `private` **metadaLoader**(): `Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Returns
+
+`Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:142
+
+***
+
+### removeLoader()
+
+> **removeLoader**(`_dataUnit`, `recordIds`): `Promise`\<`string`[]\>
+
+#### Parameters
+
+• **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **recordIds**: `string`[]
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:173
+
+***
+
+### saveLoader()
+
+> `private` **saveLoader**(`_dataUnit`, `changes`): `Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Parameters
+
+• **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **changes**: [`Change`](Change.md)[]
+
+#### Returns
+
+`Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:146
+
+***
+
+### getConvertedValue()
+
+> `static` **getConvertedValue**(`descriptor`, `strValue`, `dateFormat`?): `any`
+
+#### Parameters
+
+• **descriptor**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+• **strValue**: `string`
+
+• **dateFormat?**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Returns
+
+`any`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:77

package/classes/DataUnitLoaderUtils.md

@@ -0,0 +1,151 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitLoaderUtils
+
+# Class: DataUnitLoaderUtils
+
+## Constructors
+
+### new DataUnitLoaderUtils()
+
+> **new DataUnitLoaderUtils**(): [`DataUnitLoaderUtils`](DataUnitLoaderUtils.md)
+
+#### Returns
+
+[`DataUnitLoaderUtils`](DataUnitLoaderUtils.md)
+
+## Methods
+
+### applyFilter()
+
+> `static` **applyFilter**(`records`, `dataUnit`, `filters`): [`Record`](../interfaces/Record.md)[]
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **filters**: [`Filter`](../interfaces/Filter.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:11
+
+***
+
+### applySorting()
+
+> `static` **applySorting**(`records`, `dataUnit`, `sorting`): [`Record`](../interfaces/Record.md)[]
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **sorting**: [`Sort`](../interfaces/Sort.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:40
+
+***
+
+### buildLoadDataResponse()
+
+> `static` **buildLoadDataResponse**(`recordsIn`, `dataUnit`, `request`): `Promise`\<`object`\>
+
+#### Parameters
+
+• **recordsIn**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+#### Returns
+
+`Promise`\<`object`\>
+
+##### paginationInfo
+
+> **paginationInfo**: `undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+##### records
+
+> **records**: [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:20
+
+***
+
+### buildPaginationInfo()
+
+> `static` **buildPaginationInfo**(`__namedParameters`): `undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+#### Parameters
+
+• **\_\_namedParameters**: [`PaginationInfoBuilderParams`](../interfaces/PaginationInfoBuilderParams.md)
+
+#### Returns
+
+`undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:61
+
+***
+
+### getPagesByRecords()
+
+> `static` **getPagesByRecords**(`records`, `offset`, `limit`): [`Record`](../interfaces/Record.md)[]
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **offset**: `number`= `0`
+
+• **limit**: `number`= `0`
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:51
+
+***
+
+### hasValidLimitAndOffset()
+
+> `static` `private` **hasValidLimitAndOffset**(`offset`, `limit`): `boolean`
+
+#### Parameters
+
+• **offset**: `number`
+
+• **limit**: `number`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:57

package/classes/FieldComparator.md

@@ -58,7 +58,7 @@ src/dataunit/sorting/FieldComparator.ts:7
 
 #### Source
 
-src/dataunit/sorting/FieldComparator.ts:26
+src/dataunit/sorting/FieldComparator.ts:19
 
 ***
 
@@ -80,4 +80,4 @@ src/dataunit/sorting/FieldComparator.ts:26
 
 #### Source
 
-src/dataunit/sorting/FieldComparator.ts:16
+src/dataunit/sorting/FieldComparator.ts:14

package/classes/LockManager.md

@@ -26,7 +26,7 @@ Nome do atributo que será utilizado para controlar contexto de locks nos elemen
 
 #### Source
 
-src/utils/LockManager.ts:24
+src/utils/LockManager.ts:28
 
 ***
 
@@ -36,7 +36,7 @@ src/utils/LockManager.ts:24
 
 #### Source
 
-src/utils/LockManager.ts:19
+src/utils/LockManager.ts:23
 
 ## Methods
 
@@ -60,7 +60,7 @@ Elemento de de onde o lock deve começar.
 
 #### Source
 
-src/utils/LockManager.ts:83
+src/utils/LockManager.ts:87
 
 ***
 
@@ -74,7 +74,7 @@ src/utils/LockManager.ts:83
 
 #### Source
 
-src/utils/LockManager.ts:26
+src/utils/LockManager.ts:30
 
 ***
 
@@ -86,7 +86,7 @@ src/utils/LockManager.ts:26
 
 • **ctxId**: `string` \| `HTMLElement`
 
-• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
 
 #### Returns
 
@@ -94,7 +94,7 @@ src/utils/LockManager.ts:26
 
 #### Source
 
-src/utils/LockManager.ts:30
+src/utils/LockManager.ts:34
 
 ***
 
@@ -112,13 +112,13 @@ src/utils/LockManager.ts:30
 
 #### Source
 
-src/utils/LockManager.ts:43
+src/utils/LockManager.ts:47
 
 ***
 
 ### lock()
 
-> `static` **lock**(`id`, `operation`): `any`
+> `static` **lock**(`id`, `operation`): () => `void`
 
 Inicia um locker baseado em um contexto e uma operação.
 
@@ -128,19 +128,51 @@ Inicia um locker baseado em um contexto e uma operação.
 
 Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
 
-• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
 
 Operação do contexto que o lock deve ser feito.
 
 #### Returns
 
-`any`
+`Function`
 
 - Uma função que fara a liberação do lock.
 
+##### Returns
+
+`void`
+
+#### Source
+
+src/utils/LockManager.ts:137
+
+***
+
+### resetLocks()
+
+> `static` **resetLocks**(`id`, `operation`): `Promise`\<`void`\>
+
+Reseta todos os locks existentes para um determinado contexto e operação de forma assíncrona
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+ID do contexto ou elemento HTML contendo contexto
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+Operação específica para resetar os locks
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise que será resolvida quando todos os locks forem resetados
+
 #### Source
 
-src/utils/LockManager.ts:114
+src/utils/LockManager.ts:111
 
 ***
 
@@ -160,13 +192,35 @@ src/utils/LockManager.ts:114
 
 #### Source
 
-src/utils/LockManager.ts:65
+src/utils/LockManager.ts:69
+
+***
+
+### whenHasLock()
+
+> `static` **whenHasLock**(`id`, `operation`, `timeOut`?): `Promise`\<`void`\>
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
+
+• **timeOut?**: `number`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Source
+
+src/utils/LockManager.ts:191
 
 ***
 
 ### whenResolve()
 
-> `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
+> `static` **whenResolve**(`id`, `operation`, `debounce`?, `timeOut`?): `Promise`\<`void`\>
 
 Aguarda todos os lockers de um contexto e operação serem resolvidos.
 
@@ -176,10 +230,14 @@ Aguarda todos os lockers de um contexto e operação serem resolvidos.
 
 Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
 
-• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
 
 Operação do contexto que devera aguardar.
 
+• **debounce?**: `number`
+
+• **timeOut?**: `number`
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -188,4 +246,4 @@ Operação do contexto que devera aguardar.
 
 #### Source
 
-src/utils/LockManager.ts:142
+src/utils/LockManager.ts:164