@sankhyalabs/core-docs 5.20.0-dev.7 → 5.20.0-dev.70

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/DateUtils.md

@@ -40,7 +40,7 @@ Data a ser ajustada.
 
 #### Source
 
-src/utils/DateUtils.ts:136
+src/utils/DateUtils.ts:139
 
 ***
 
@@ -130,7 +130,7 @@ define se devemos considerar os segundos.
 
 #### Source
 
-src/utils/DateUtils.ts:53
+src/utils/DateUtils.ts:56
 
 ***
 
@@ -161,7 +161,7 @@ Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
 
 #### Source
 
-src/utils/DateUtils.ts:186
+src/utils/DateUtils.ts:189
 
 ***
 
@@ -213,7 +213,7 @@ Caso true retorna a data com informações de horário.
 
 #### Source
 
-src/utils/DateUtils.ts:107
+src/utils/DateUtils.ts:110
 
 ***
 
@@ -247,7 +247,7 @@ Informo:  2     | Obtenho: "02"
 
 #### Source
 
-src/utils/DateUtils.ts:155
+src/utils/DateUtils.ts:158
 
 ***
 
@@ -279,7 +279,7 @@ Quando ativado, retorna o primeiro dia do mês apenas para construir a data.
 
 #### Source
 
-src/utils/DateUtils.ts:65
+src/utils/DateUtils.ts:68
 
 ***
 
@@ -303,7 +303,7 @@ Timezone da data.
 
 #### Source
 
-src/utils/DateUtils.ts:165
+src/utils/DateUtils.ts:168
 
 ***
 
@@ -331,4 +331,4 @@ Determina se a data retornada deve conter informação de horário ou não. Por
 
 #### Source
 
-src/utils/DateUtils.ts:124
+src/utils/DateUtils.ts:127

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/IDBRepository.md

@@ -279,6 +279,28 @@ src/repository/indexeddb/IDBRepository.ts:319
 
 ***
 
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Implementation of
+
+[`IRepository`](../interfaces/IRepository.md).[`getFromCache`](../interfaces/IRepository.md#getfromcache)
+
+#### Source
+
+src/repository/indexeddb/IDBRepository.ts:324
+
+***
+
 ### getItemPosition()
 
 > `private` **getItemPosition**(`db`, `itemTest`): `Promise`\<`number`\>