@sankhyalabs/core-docs 0.0.0-feat-dev-kb-15253.0 → 0.0.0-feat-dev-KB-14960.1

package/enums/Action.md

@@ -22,6 +22,7 @@
 - [LOADING\_RECORD](Action.md#loading_record)
 - [METADATA\_LOADED](Action.md#metadata_loaded)
 - [NEXT\_SELECTED](Action.md#next_selected)
+- [PAGINATION\_UPDATED](Action.md#pagination_updated)
 - [PREVIOUS\_SELECTED](Action.md#previous_selected)
 - [RECORDS\_ADDED](Action.md#records_added)
 - [RECORDS\_COPIED](Action.md#records_copied)
@@ -41,7 +42,7 @@
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:51
+src/dataunit/state/action/DataUnitAction.ts:52
 
 ___
 
@@ -51,7 +52,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:50
+src/dataunit/state/action/DataUnitAction.ts:51
 
 ___
 
@@ -61,7 +62,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:44
+src/dataunit/state/action/DataUnitAction.ts:45
 
 ___
 
@@ -71,7 +72,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:62
+src/dataunit/state/action/DataUnitAction.ts:63
 
 ___
 
@@ -81,7 +82,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:46
+src/dataunit/state/action/DataUnitAction.ts:47
 
 ___
 
@@ -101,7 +102,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:47
+src/dataunit/state/action/DataUnitAction.ts:48
 
 ___
 
@@ -111,7 +112,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:36
+src/dataunit/state/action/DataUnitAction.ts:37
 
 ___
 
@@ -121,7 +122,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:49
+src/dataunit/state/action/DataUnitAction.ts:50
 
 ___
 
@@ -131,7 +132,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:64
+src/dataunit/state/action/DataUnitAction.ts:65
 
 ___
 
@@ -141,7 +142,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:65
+src/dataunit/state/action/DataUnitAction.ts:66
 
 ___
 
@@ -171,7 +172,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:59
+src/dataunit/state/action/DataUnitAction.ts:60
 
 ___
 
@@ -191,7 +192,17 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:54
+src/dataunit/state/action/DataUnitAction.ts:55
+
+___
+
+### PAGINATION\_UPDATED
+
+• **PAGINATION\_UPDATED** = ``"paginationUpdated"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:34
 
 ___
 
@@ -201,7 +212,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:55
+src/dataunit/state/action/DataUnitAction.ts:56
 
 ___
 
@@ -211,7 +222,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:41
+src/dataunit/state/action/DataUnitAction.ts:42
 
 ___
 
@@ -221,7 +232,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:42
+src/dataunit/state/action/DataUnitAction.ts:43
 
 ___
 
@@ -231,7 +242,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:39
+src/dataunit/state/action/DataUnitAction.ts:40
 
 ___
 
@@ -241,7 +252,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:60
+src/dataunit/state/action/DataUnitAction.ts:61
 
 ___
 
@@ -251,7 +262,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:38
+src/dataunit/state/action/DataUnitAction.ts:39
 
 ___
 
@@ -261,7 +272,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:35
+src/dataunit/state/action/DataUnitAction.ts:36
 
 ___
 
@@ -271,7 +282,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:53
+src/dataunit/state/action/DataUnitAction.ts:54
 
 ___
 
@@ -281,7 +292,7 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:57
+src/dataunit/state/action/DataUnitAction.ts:58
 
 ___
 
@@ -291,4 +302,4 @@ ___
 
 #### Defined in
 
-src/dataunit/state/action/DataUnitAction.ts:45
+src/dataunit/state/action/DataUnitAction.ts:46

package/enums/ChangeOperation.md

@@ -19,7 +19,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1700
+src/dataunit/DataUnit.ts:1714
 
 ___
 
@@ -29,7 +29,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1702
+src/dataunit/DataUnit.ts:1716
 
 ___
 
@@ -39,7 +39,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1699
+src/dataunit/DataUnit.ts:1713
 
 ___
 
@@ -49,4 +49,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1701
+src/dataunit/DataUnit.ts:1715

package/enums/SelectionMode.md

@@ -17,7 +17,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1810
+src/dataunit/DataUnit.ts:1822
 
 ___
 
@@ -27,4 +27,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1811
+src/dataunit/DataUnit.ts:1823

package/interfaces/DUActionInterceptor.md

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

package/interfaces/ILoadResult.md

@@ -23,7 +23,7 @@
 
 #### Defined in
 
-src/indexeddb/ILoadResult.ts:3
+src/repository/ILoadResult.ts:3
 
 ___
 
@@ -33,4 +33,4 @@ ___
 
 #### Defined in
 
-src/indexeddb/ILoadResult.ts:2
+src/repository/ILoadResult.ts:2

package/interfaces/IRepository.md

@@ -0,0 +1,245 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IRepository
+
+# Interface: IRepository<T\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Implemented by
+
+- [`IDBRepository`](../classes/IDBRepository.md)
+
+## Table of contents
+
+### Methods
+
+- [clear](IRepository.md#clear)
+- [count](IRepository.md#count)
+- [delete](IRepository.md#delete)
+- [distict](IRepository.md#distict)
+- [insert](IRepository.md#insert)
+- [isEmpty](IRepository.md#isempty)
+- [isOperating](IRepository.md#isoperating)
+- [load](IRepository.md#load)
+- [push](IRepository.md#push)
+- [update](IRepository.md#update)
+
+## Methods
+
+### clear
+
+▸ **clear**(): `Promise`<`void`\>
+
+Limpa todo o repositório
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Defined in
+
+src/repository/IRepository.ts:38
+
+___
+
+### count
+
+▸ **count**(): `Promise`<`number`\>
+
+Conta os itens do repositório
+
+#### Returns
+
+`Promise`<`number`\>
+
+Promessa de quantidade
+
+#### Defined in
+
+src/repository/IRepository.ts:81
+
+___
+
+### delete
+
+▸ **delete**(`items`): `Promise`<`void`\>
+
+Remove itens do repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os itens a serem removidos |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Defined in
+
+src/repository/IRepository.ts:46
+
+___
+
+### distict
+
+▸ **distict**(`itemProcessor`): `Promise`<`Map`<`string`, `any`\>\>
+
+Itera todos os items colecionando os valores distintos.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `itemProcessor` | (`item`: `T`) => { `key`: `string` ; `value`: `any`  } | Uma função que processa um item e gera a chave e valor |
+
+#### Returns
+
+`Promise`<`Map`<`string`, `any`\>\>
+
+Promessa de array com os valores distintos.
+
+#### Defined in
+
+src/repository/IRepository.ts:23
+
+___
+
+### insert
+
+▸ **insert**(`itemReference`, `items`): `Promise`<`void`\>
+
+Insere itens em uma posição de referência
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `itemReference` | `T` | O item posterior aos inseridos |
+| `items` | `T`[] | Os itens a serem inseridos |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Defined in
+
+src/repository/IRepository.ts:63
+
+___
+
+### isEmpty
+
+▸ **isEmpty**(): `Promise`<`boolean`\>
+
+Determina se o repositório está vazio ou ainda não foi criado.
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+src/repository/IRepository.ts:74
+
+___
+
+### isOperating
+
+▸ **isOperating**(): `boolean`
+
+Determina se o repositório está em condições normais de funcionamento.
+Caso o banco tenha sido excluido, retorna false.
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/repository/IRepository.ts:69
+
+___
+
+### load
+
+▸ **load**(`filterFunction?`, `sortingFunction?`, `offset?`, `limit?`): `Promise`<[`ILoadResult`](ILoadResult.md)<`T`\>\>
+
+Recupera registros do repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `filterFunction?` | (`value`: `T`) => `boolean` | Teste para determinar se um registro está no universo desejado |
+| `sortingFunction?` | (`itemA`: `T`, `itemB`: `T`) => `number` | Critério comparação para ordenação |
+| `offset?` | `number` | Determina que o resultado descarta os registros iniciais |
+| `limit?` | `number` | Descarta o resultado a partir de uma quantidade de registros |
+
+#### Returns
+
+`Promise`<[`ILoadResult`](ILoadResult.md)<`T`\>\>
+
+Promessa de um array que satisfaça aos critérios informados
+
+#### Defined in
+
+src/repository/IRepository.ts:14
+
+___
+
+### push
+
+▸ **push**(`items`): `Promise`<`void`\>
+
+Adiciona registros no final do repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os items a serem adicionados |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Defined in
+
+src/repository/IRepository.ts:31
+
+___
+
+### update
+
+▸ **update**(`items`): `Promise`<`void`\>
+
+Altera itens já persistido no repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os itens a serem alterados |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Defined in
+
+src/repository/IRepository.ts:54

package/interfaces/IRepositoryIndex.md

@@ -0,0 +1,66 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IRepositoryIndex
+
+# Interface: IRepositoryIndex
+
+## Hierarchy
+
+- `IDBIndexParameters`
+
+  ↳ **`IRepositoryIndex`**
+
+## Table of contents
+
+### Properties
+
+- [multiEntry](IRepositoryIndex.md#multientry)
+- [name](IRepositoryIndex.md#name)
+- [path](IRepositoryIndex.md#path)
+- [unique](IRepositoryIndex.md#unique)
+
+## Properties
+
+### multiEntry
+
+• `Optional` **multiEntry**: `boolean`
+
+#### Inherited from
+
+IDBIndexParameters.multiEntry
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:583
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IRepositoryIndex.ts:2
+
+___
+
+### path
+
+• **path**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IRepositoryIndex.ts:3
+
+___
+
+### unique
+
+• `Optional` **unique**: `boolean`
+
+#### Inherited from
+
+IDBIndexParameters.unique
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:584

package/interfaces/LoadDataRequest.md

@@ -15,6 +15,7 @@ Atributos enviados na requisição de carregamento dos registros
 - [parentRecordId](LoadDataRequest.md#parentrecordid)
 - [quickFilter](LoadDataRequest.md#quickfilter)
 - [sort](LoadDataRequest.md#sort)
+- [source](LoadDataRequest.md#source)
 
 ## Properties
 
@@ -26,7 +27,7 @@ Filtros
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:16
+src/dataunit/loading/LoadDataRequest.ts:19
 
 ___
 
@@ -38,7 +39,7 @@ Na navegação de páginas devemos manter a seleção
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:25
+src/dataunit/loading/LoadDataRequest.ts:28
 
 ___
 
@@ -50,7 +51,7 @@ Quantidade de registros que será retornado
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:10
+src/dataunit/loading/LoadDataRequest.ts:13
 
 ___
 
@@ -62,7 +63,7 @@ Indice inicial dos registros que será retornado
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:7
+src/dataunit/loading/LoadDataRequest.ts:10
 
 ___
 
@@ -74,7 +75,7 @@ Info parent
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:22
+src/dataunit/loading/LoadDataRequest.ts:25
 
 ___
 
@@ -86,7 +87,7 @@ Filtro rápido
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:13
+src/dataunit/loading/LoadDataRequest.ts:16
 
 ___
 
@@ -98,4 +99,16 @@ Ordenação dos resultados
 
 #### Defined in
 
-src/dataunit/loading/LoadDataRequest.ts:19
+src/dataunit/loading/LoadDataRequest.ts:22
+
+___
+
+### source
+
+• `Optional` **source**: `String`
+
+De onde partiu o refresh. Por padrão a fonte não é identificada
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:7

package/interfaces/PageRequest.md

@@ -18,7 +18,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1790
+src/dataunit/DataUnit.ts:1802
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1791
+src/dataunit/DataUnit.ts:1803
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1792
+src/dataunit/DataUnit.ts:1804