@sankhyalabs/core-docs 0.0.0-bugfix-rc-KB-2229.1 → 0.0.0-bugfix-dev-32613.0

package/classes/IDBRepository.md

@@ -0,0 +1,518 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IDBRepository
+
+# Class: IDBRepository<T\>
+
+Abstração para simplificar o uso do indexed DB
+
+Além de facilitar os comandos de incluir, remover alterar e obter
+objetos, esse repositório preserva a ordem de inserção na lista, 
+além de permitir filtros e ordenações compostas 
+(impossíveis com uso de índices).
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Implements
+
+- [`IRepository`](../interfaces/IRepository.md)<`T`\>
+
+## Table of contents
+
+### Constructors
+
+- [constructor](IDBRepository.md#constructor)
+
+### Properties
+
+- [\_addedStoreName](IDBRepository.md#_addedstorename)
+- [\_db](IDBRepository.md#_db)
+- [\_dbName](IDBRepository.md#_dbname)
+- [\_dbVersion](IDBRepository.md#_dbversion)
+- [\_indexKeyPath](IDBRepository.md#_indexkeypath)
+- [\_indexes](IDBRepository.md#_indexes)
+- [\_operating](IDBRepository.md#_operating)
+- [\_storeName](IDBRepository.md#_storename)
+
+### Methods
+
+- [clear](IDBRepository.md#clear)
+- [count](IDBRepository.md#count)
+- [createStore](IDBRepository.md#createstore)
+- [delete](IDBRepository.md#delete)
+- [distict](IDBRepository.md#distict)
+- [getAddedItems](IDBRepository.md#getaddeditems)
+- [getItemPosition](IDBRepository.md#getitemposition)
+- [getItemPositionByAdded](IDBRepository.md#getitempositionbyadded)
+- [insert](IDBRepository.md#insert)
+- [isEmpty](IDBRepository.md#isempty)
+- [isOperating](IDBRepository.md#isoperating)
+- [load](IDBRepository.md#load)
+- [openDB](IDBRepository.md#opendb)
+- [push](IDBRepository.md#push)
+- [update](IDBRepository.md#update)
+
+## Constructors
+
+### constructor
+
+• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`, `indexes?`)
+
+Construtor padrão
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dbName` | `string` | Nome do DB |
+| `dbVersion` | `number` | Versão do DB |
+| `storeName` | `string` | Nome da store |
+| `indexKeyPath` | `string` | Um atributo que identifique os objetos guardados |
+| `indexes?` | [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[] | - |
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:35
+
+## Properties
+
+### \_addedStoreName
+
+• `Private` **\_addedStoreName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:21
+
+___
+
+### \_db
+
+• `Private` `Optional` **\_db**: `IDBPDatabase`<`unknown`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:24
+
+___
+
+### \_dbName
+
+• `Private` **\_dbName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:18
+
+___
+
+### \_dbVersion
+
+• `Private` **\_dbVersion**: `number`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:19
+
+___
+
+### \_indexKeyPath
+
+• `Private` **\_indexKeyPath**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:22
+
+___
+
+### \_indexes
+
+• `Private` `Optional` **\_indexes**: [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[]
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:23
+
+___
+
+### \_operating
+
+• `Private` **\_operating**: `boolean` = `true`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:25
+
+___
+
+### \_storeName
+
+• `Private` **\_storeName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:20
+
+## Methods
+
+### clear
+
+▸ **clear**(): `Promise`<`void`\>
+
+Limpa todo o repositório
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[clear](../interfaces/IRepository.md#clear)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:123
+
+___
+
+### count
+
+▸ **count**(): `Promise`<`number`\>
+
+Conta os itens do repositório
+
+#### Returns
+
+`Promise`<`number`\>
+
+Promessa de quantidade
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[count](../interfaces/IRepository.md#count)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:236
+
+___
+
+### createStore
+
+▸ `Private` **createStore**(`db`, `name`, `indexPrefix?`): `void`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> | `undefined` |
+| `name` | `string` | `undefined` |
+| `indexPrefix` | `string` | `""` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:271
+
+___
+
+### 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
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[delete](../interfaces/IRepository.md#delete)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:138
+
+___
+
+### 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.
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[distict](../interfaces/IRepository.md#distict)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:78
+
+___
+
+### getAddedItems
+
+▸ `Private` **getAddedItems**(`db`): `Promise`<`IAddedItem`<`T`\>[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+
+#### Returns
+
+`Promise`<`IAddedItem`<`T`\>[]\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:319
+
+___
+
+### getItemPosition
+
+▸ `Private` **getItemPosition**(`db`, `itemTest`): `Promise`<`number`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+| `itemTest` | (`item`: `any`) => `boolean` |
+
+#### Returns
+
+`Promise`<`number`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:284
+
+___
+
+### getItemPositionByAdded
+
+▸ `Private` **getItemPositionByAdded**(`db`, `itemTest`): `Promise`<`number`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+| `itemTest` | (`item`: `any`) => `boolean` |
+
+#### Returns
+
+`Promise`<`number`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:307
+
+___
+
+### 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
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[insert](../interfaces/IRepository.md#insert)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:194
+
+___
+
+### isEmpty
+
+▸ **isEmpty**(): `Promise`<`boolean`\>
+
+Determina se o repositório está vazio ou ainda não foi criado.
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[isEmpty](../interfaces/IRepository.md#isempty)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:218
+
+___
+
+### 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`
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[isOperating](../interfaces/IRepository.md#isoperating)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:214
+
+___
+
+### load
+
+▸ **load**(`filterFunction?`, `sortingFunction?`, `offset?`, `limit?`): `Promise`<[`ILoadResult`](../interfaces/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`](../interfaces/ILoadResult.md)<`T`\>\>
+
+Promessa de um array que satisfaça aos critérios informados
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[load](../interfaces/IRepository.md#load)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:44
+
+___
+
+### openDB
+
+▸ `Private` **openDB**(): `Promise`<`IDBPDatabase`<`unknown`\>\>
+
+#### Returns
+
+`Promise`<`IDBPDatabase`<`unknown`\>\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:250
+
+___
+
+### 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
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[push](../interfaces/IRepository.md#push)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:103
+
+___
+
+### 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
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[update](../interfaces/IRepository.md#update)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:165

package/classes/JSUtils.md

@@ -13,9 +13,12 @@ Classe com utiliários comuns para funções genéricas em JavaScript.
 ### Methods
 
 - [debounce](JSUtils.md#debounce)
+- [debounceLeading](JSUtils.md#debounceleading)
 - [generateUUID](JSUtils.md#generateuuid)
 - [isBase64](JSUtils.md#isbase64)
 - [isEllipsisActive](JSUtils.md#isellipsisactive)
+- [isHiddenElement](JSUtils.md#ishiddenelement)
+- [replaceHtmlEntities](JSUtils.md#replacehtmlentities)
 
 ## Constructors
 
@@ -46,7 +49,33 @@ Método responsável em criar um timer para processar uma determinada função.
 
 #### Defined in
 
-src/utils/JSUtils.ts:16
+src/utils/JSUtils.ts:21
+
+___
+
+### debounceLeading
+
+▸ `Static` **debounceLeading**(`callback`, `timeout?`, `context?`): `VoidFunction`
+
+Método responsável por executar uma função e ignorar as outras posteriores até o tempo especificado.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `callback` | `Function` | `undefined` | Função a ser invocada |
+| `timeout` | `number` | `300` | Quantidade de tempo para aguardar antes de invocar novamente |
+| `context?` | `any` | `undefined` | O contexto atual |
+
+#### Returns
+
+`VoidFunction`
+
+A função com o debounce
+
+#### Defined in
+
+src/utils/JSUtils.ts:37
 
 ___
 
@@ -64,7 +93,7 @@ Método responsável em gerar um UUID.
 
 #### Defined in
 
-src/utils/JSUtils.ts:66
+src/utils/JSUtils.ts:95
 
 ___
 
@@ -88,7 +117,7 @@ Método que verifica se uma string está encodada com base64.
 
 #### Defined in
 
-src/utils/JSUtils.ts:51
+src/utils/JSUtils.ts:80
 
 ___
 
@@ -112,4 +141,48 @@ Método responsável em validar se um elemento HTML está com o ellipsis ativo.
 
 #### Defined in
 
-src/utils/JSUtils.ts:31
+src/utils/JSUtils.ts:60
+
+___
+
+### isHiddenElement
+
+▸ `Static` **isHiddenElement**(`element`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/utils/JSUtils.ts:8
+
+___
+
+### replaceHtmlEntities
+
+▸ `Static` **replaceHtmlEntities**(`source`): `string`
+
+Substitui caracteres para suas entidades HTML.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `source` | `string` | String a ter os caracteres substituidos. |
+
+#### Returns
+
+`string`
+
+- Retorna um UUID.
+
+#### Defined in
+
+src/utils/JSUtils.ts:105