@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/interfaces/Filter.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Filter
+
+# Interface: Filter
+
+## Table of contents
+
+### Properties
+
+- [expression](Filter.md#expression)
+- [name](Filter.md#name)
+- [params](Filter.md#params)
+
+## Properties
+
+### expression
+
+• **expression**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:44
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:43
+
+___
+
+### params
+
+• `Optional` **params**: `FilterParam`[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:45

package/interfaces/IElementIDInfo.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IElementIDInfo
+
+# Interface: IElementIDInfo
+
+## Table of contents
+
+### Properties
+
+- [dataUnit](IElementIDInfo.md#dataunit)
+- [id](IElementIDInfo.md#id)
+
+## Properties
+
+### dataUnit
+
+• `Optional` **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:7
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+src/utils/ElementIDUtils.ts:6

package/interfaces/LoadDataRequest.md

@@ -0,0 +1,101 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataRequest
+
+# Interface: LoadDataRequest
+
+Atributos enviados na requisição de carregamento dos registros
+
+## Table of contents
+
+### Properties
+
+- [filters](LoadDataRequest.md#filters)
+- [keepSelection](LoadDataRequest.md#keepselection)
+- [limit](LoadDataRequest.md#limit)
+- [offset](LoadDataRequest.md#offset)
+- [parentRecordId](LoadDataRequest.md#parentrecordid)
+- [quickFilter](LoadDataRequest.md#quickfilter)
+- [sort](LoadDataRequest.md#sort)
+
+## Properties
+
+### filters
+
+• `Optional` **filters**: [`Filter`](Filter.md)[]
+
+Filtros
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:16
+
+___
+
+### keepSelection
+
+• `Optional` **keepSelection**: `boolean`
+
+Na navegação de páginas devemos manter a seleção
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:25
+
+___
+
+### limit
+
+• `Optional` **limit**: `number`
+
+Quantidade de registros que será retornado
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:10
+
+___
+
+### offset
+
+• `Optional` **offset**: `number`
+
+Indice inicial dos registros que será retornado
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:7
+
+___
+
+### parentRecordId
+
+• `Optional` **parentRecordId**: `string`
+
+Info parent
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:22
+
+___
+
+### quickFilter
+
+• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+
+Filtro rápido
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:13
+
+___
+
+### sort
+
+• `Optional` **sort**: [`Sort`](Sort.md)[]
+
+Ordenação dos resultados
+
+#### Defined in
+
+src/dataunit/loading/LoadDataRequest.ts:19

package/interfaces/LoadDataResponse.md

@@ -0,0 +1,36 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataResponse
+
+# Interface: LoadDataResponse
+
+Retorno dos registros da requisição de carregamento de dados
+
+## Table of contents
+
+### Properties
+
+- [paginationInfo](LoadDataResponse.md#paginationinfo)
+- [records](LoadDataResponse.md#records)
+
+## Properties
+
+### paginationInfo
+
+• `Optional` **paginationInfo**: [`PaginationInfo`](PaginationInfo.md)
+
+Informações da paginação
+
+#### Defined in
+
+src/dataunit/loading/LoadDataResponse.ts:10
+
+___
+
+### records
+
+• **records**: [`Record`](Record.md)[]
+
+Registros retornados na requisição
+
+#### Defined in
+
+src/dataunit/loading/LoadDataResponse.ts:7

package/interfaces/PageRequest.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PageRequest
+
+# Interface: PageRequest
+
+## Table of contents
+
+### Properties
+
+- [limit](PageRequest.md#limit)
+- [offset](PageRequest.md#offset)
+- [quickFilter](PageRequest.md#quickfilter)
+
+## Properties
+
+### limit
+
+• **limit**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1737
+
+___
+
+### offset
+
+• **offset**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1738
+
+___
+
+### quickFilter
+
+• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1739

package/interfaces/PaginationInfo.md

@@ -0,0 +1,75 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PaginationInfo
+
+# Interface: PaginationInfo
+
+Informações da paginação retornada na requisição de carregamento de registros
+
+## Table of contents
+
+### Properties
+
+- [currentPage](PaginationInfo.md#currentpage)
+- [firstRecord](PaginationInfo.md#firstrecord)
+- [hasMore](PaginationInfo.md#hasmore)
+- [lastRecord](PaginationInfo.md#lastrecord)
+- [total](PaginationInfo.md#total)
+
+## Properties
+
+### currentPage
+
+• **currentPage**: `number`
+
+Página atual
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:5
+
+___
+
+### firstRecord
+
+• **firstRecord**: `number`
+
+Indice do primeiro registro na página
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:8
+
+___
+
+### hasMore
+
+• **hasMore**: `boolean`
+
+Se ainda existem mais registros além dos exibidos na página
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:17
+
+___
+
+### lastRecord
+
+• **lastRecord**: `number`
+
+Indice do último registro na página
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:11
+
+___
+
+### total
+
+• **total**: `number`
+
+Quantidade total de registros
+
+#### Defined in
+
+src/dataunit/loading/PaginationInfo.ts:14

package/interfaces/PromiseSyncCallback.md

@@ -0,0 +1,39 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSyncCallback
+
+# Interface: PromiseSyncCallback<T\>
+
+Representa o callback de um sincronizador `PromiseSync<T>`.
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Table of contents
+
+### Methods
+
+- [resolve](PromiseSyncCallback.md#resolve)
+
+## Methods
+
+### resolve
+
+▸ **resolve**(`result`): `void`
+
+Será chamado sempre que todas as promessas adicionadas finalizarem.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `result` | `PromiseSettledResult`<`Awaited`<`T`\>\>[] | A lista com o resultado de todas as promises aguardadas. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/async/PromiseSync.ts:48

package/interfaces/QuickFilter.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / QuickFilter
+
+# Interface: QuickFilter
+
+## Table of contents
+
+### Properties
+
+- [fields](QuickFilter.md#fields)
+- [filter](QuickFilter.md#filter)
+- [term](QuickFilter.md#term)
+
+## Properties
+
+### fields
+
+• `Optional` **fields**: `string`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1744
+
+___
+
+### filter
+
+• `Optional` **filter**: [`Filter`](Filter.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1745
+
+___
+
+### term
+
+• **term**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1743

package/interfaces/Record.md

@@ -0,0 +1,62 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
+
+# Interface: Record
+
+## Hierarchy
+
+- **`Record`**
+
+  ↳ [`SavedRecord`](SavedRecord.md)
+
+## Indexable
+
+▪ [key: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [\_\_owner\_\_dataunit\_\_name\_\_](Record.md#__owner__dataunit__name__)
+- [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
+- [\_\_record\_\_id\_\_](Record.md#__record__id__)
+- [\_\_record\_\_label\_\_](Record.md#__record__label__)
+
+## Properties
+
+### \_\_owner\_\_dataunit\_\_name\_\_
+
+• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1637
+
+___
+
+### \_\_parent\_\_record\_\_id\_\_
+
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1636
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1634
+
+___
+
+### \_\_record\_\_label\_\_
+
+• `Optional` **\_\_record\_\_label\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1635

package/interfaces/SavedRecord.md

@@ -0,0 +1,85 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SavedRecord
+
+# Interface: SavedRecord
+
+## Hierarchy
+
+- [`Record`](Record.md)
+
+  ↳ **`SavedRecord`**
+
+## Table of contents
+
+### Properties
+
+- [\_\_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__)
+
+## Properties
+
+### \_\_old\_\_id\_\_
+
+• `Optional` **\_\_old\_\_id\_\_**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1642
+
+___
+
+### \_\_owner\_\_dataunit\_\_name\_\_
+
+• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__owner__dataunit__name__](Record.md#__owner__dataunit__name__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1637
+
+___
+
+### \_\_parent\_\_record\_\_id\_\_
+
+• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__parent__record__id__](Record.md#__parent__record__id__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1636
+
+___
+
+### \_\_record\_\_id\_\_
+
+• **\_\_record\_\_id\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__record__id__](Record.md#__record__id__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1634
+
+___
+
+### \_\_record\_\_label\_\_
+
+• `Optional` **\_\_record\_\_label\_\_**: `string`
+
+#### Inherited from
+
+[Record](Record.md).[__record__label__](Record.md#__record__label__)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1635

package/interfaces/Sort.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Sort
+
+# Interface: Sort
+
+## Table of contents
+
+### Properties
+
+- [dataType](Sort.md#datatype)
+- [field](Sort.md#field)
+- [mode](Sort.md#mode)
+
+## Properties
+
+### dataType
+
+• **dataType**: [`DataType`](../enums/DataType.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:57
+
+___
+
+### field
+
+• **field**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:55
+
+___
+
+### mode
+
+• **mode**: [`SortMode`](../enums/SortMode.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:56

package/interfaces/SortingProvider.md

@@ -0,0 +1,29 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortingProvider
+
+# Interface: SortingProvider
+
+## Table of contents
+
+### Methods
+
+- [getSort](SortingProvider.md#getsort)
+
+## Methods
+
+### getSort
+
+▸ **getSort**(`dataUnit`): `undefined` \| [`Sort`](Sort.md)[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | `string` |
+
+#### Returns
+
+`undefined` \| [`Sort`](Sort.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:66

package/interfaces/UnitMetadata.md

@@ -0,0 +1,52 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UnitMetadata
+
+# Interface: UnitMetadata
+
+## Table of contents
+
+### Properties
+
+- [children](UnitMetadata.md#children)
+- [fields](UnitMetadata.md#fields)
+- [label](UnitMetadata.md#label)
+- [name](UnitMetadata.md#name)
+
+## Properties
+
+### children
+
+• `Optional` **children**: [`ChildDescriptor`](ChildDescriptor.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:7
+
+___
+
+### fields
+
+• **fields**: [`FieldDescriptor`](FieldDescriptor.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:6
+
+___
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:5
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:4