@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

package/interfaces/ChildDescriptor.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildDescriptor
+
+# Interface: ChildDescriptor
+
+## Table of contents
+
+### Properties
+
+- [label](ChildDescriptor.md#label)
+- [links](ChildDescriptor.md#links)
+- [name](ChildDescriptor.md#name)
+
+## Properties
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:11
+
+___
+
+### links
+
+• **links**: [`ChildLink`](ChildLink.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:13
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:12

package/interfaces/ChildLink.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildLink
+
+# Interface: ChildLink
+
+## Table of contents
+
+### Properties
+
+- [source](ChildLink.md#source)
+- [target](ChildLink.md#target)
+
+## Properties
+
+### source
+
+• **source**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:17
+
+___
+
+### target
+
+• **target**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:18

package/interfaces/DUActionInterceptor.md

@@ -0,0 +1,29 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DUActionInterceptor
+
+# Interface: DUActionInterceptor
+
+## Table of contents
+
+### Methods
+
+- [interceptAction](DUActionInterceptor.md#interceptaction)
+
+## Methods
+
+### interceptAction
+
+▸ **interceptAction**(`action`): [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+#### Returns
+
+[`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1657

package/interfaces/ExecutionContext.md

@@ -0,0 +1,58 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ExecutionContext
+
+# Interface: ExecutionContext
+
+## Table of contents
+
+### Properties
+
+- [after](ExecutionContext.md#after)
+- [before](ExecutionContext.md#before)
+
+## Properties
+
+### after
+
+• `Optional` **after**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => `void`
+
+#### Type declaration
+
+▸ (`action`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:24
+
+___
+
+### before
+
+• `Optional` **before**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => [`DataUnitAction`](../classes/DataUnitAction.md)
+
+#### Type declaration
+
+▸ (`action`): [`DataUnitAction`](../classes/DataUnitAction.md)
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+##### Returns
+
+[`DataUnitAction`](../classes/DataUnitAction.md)
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:23

package/interfaces/FieldDescriptor.md

@@ -0,0 +1,140 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldDescriptor
+
+# Interface: FieldDescriptor
+
+## Table of contents
+
+### Properties
+
+- [dataType](FieldDescriptor.md#datatype)
+- [defaultValue](FieldDescriptor.md#defaultvalue)
+- [dependencies](FieldDescriptor.md#dependencies)
+- [group](FieldDescriptor.md#group)
+- [label](FieldDescriptor.md#label)
+- [name](FieldDescriptor.md#name)
+- [order](FieldDescriptor.md#order)
+- [properties](FieldDescriptor.md#properties)
+- [readOnly](FieldDescriptor.md#readonly)
+- [required](FieldDescriptor.md#required)
+- [userInterface](FieldDescriptor.md#userinterface)
+- [visible](FieldDescriptor.md#visible)
+
+## Properties
+
+### dataType
+
+• **dataType**: [`DataType`](../enums/DataType.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:24
+
+___
+
+### defaultValue
+
+• `Optional` **defaultValue**: `any`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:26
+
+___
+
+### dependencies
+
+• `Optional` **dependencies**: `FieldDependency`[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:31
+
+___
+
+### group
+
+• `Optional` **group**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:32
+
+___
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:23
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:22
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:33
+
+___
+
+### properties
+
+• `Optional` **properties**: `any`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:30
+
+___
+
+### readOnly
+
+• `Optional` **readOnly**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:28
+
+___
+
+### required
+
+• `Optional` **required**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:29
+
+___
+
+### userInterface
+
+• `Optional` **userInterface**: [`UserInterface`](../enums/UserInterface.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:25
+
+___
+
+### visible
+
+• `Optional` **visible**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:27

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:1764
+
+___
+
+### offset
+
+• **offset**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1765
+
+___
+
+### quickFilter
+
+• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1766

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:1771
+
+___
+
+### filter
+
+• `Optional` **filter**: [`Filter`](Filter.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1772
+
+___
+
+### term
+
+• **term**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1770