npm - @sankhyalabs/core-docs - Versions diffs - 0.0.0-hotfix-ga-5468339.0 → 0.0.0-hotfix-rc-5468339.0 - Mend

@sankhyalabs/core-docs 0.0.0-hotfix-ga-5468339.0 → 0.0.0-hotfix-rc-5468339.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

package/classes/Change.md +11 -11
package/classes/DataUnit.md +149 -79
package/classes/ObjectUtils.md +48 -0
package/classes/OverflowWatcher.md +310 -46
package/classes/SelectionInfo.md +11 -11
package/enumerations/ChangeOperation.md +4 -4
package/enumerations/SelectionMode.md +2 -2
package/globals.md +6 -0
package/interfaces/DUActionInterceptor.md +1 -1
package/interfaces/OverFlowWatcherParams.md +67 -0
package/interfaces/PageRequest.md +3 -3
package/interfaces/QuickFilter.md +3 -3
package/interfaces/Record.md +4 -4
package/interfaces/SavedRecord.md +5 -5
package/interfaces/WaitingChange.md +3 -3
package/package.json +1 -1
package/type-aliases/DataUnitEventOptions.md +17 -0
package/variables/OVERFLOWED_CLASS_NAME.md +13 -0

package/classes/DataUnit.md CHANGED Viewed

@@ -26,10 +26,20 @@
 #### Source
-src/dataunit/DataUnit.ts:58
+src/dataunit/DataUnit.ts:59
 ## Properties
+### \_allowReleaseCallbacks
+> `private` **\_allowReleaseCallbacks**: `boolean`
+#### Source
+src/dataunit/DataUnit.ts:51
+***
 ### \_childByName
 > `private` **\_childByName**: `Map`\<`string`, [`DataUnit`](DataUnit.md)\>
@@ -92,7 +102,7 @@ src/dataunit/DataUnit.ts:39
 ### \_observers
-> `private` **\_observers**: (`action`) => `void`[]
+> `private` **\_observers**: (`action`, `options`?) => `void`[]
 #### Source
@@ -176,7 +186,7 @@ src/dataunit/DataUnit.ts:38
 #### Source
-src/dataunit/DataUnit.ts:53
+src/dataunit/DataUnit.ts:54
 ***
@@ -194,7 +204,7 @@ src/dataunit/DataUnit.ts:53
 #### Source
-src/dataunit/DataUnit.ts:52
+src/dataunit/DataUnit.ts:53
 ***
@@ -214,7 +224,7 @@ src/dataunit/DataUnit.ts:52
 #### Source
-src/dataunit/DataUnit.ts:56
+src/dataunit/DataUnit.ts:57
 ***
@@ -234,7 +244,7 @@ src/dataunit/DataUnit.ts:56
 #### Source
-src/dataunit/DataUnit.ts:55
+src/dataunit/DataUnit.ts:56
 ***
@@ -254,7 +264,7 @@ src/dataunit/DataUnit.ts:55
 #### Source
-src/dataunit/DataUnit.ts:54
+src/dataunit/DataUnit.ts:55
 ***
@@ -278,6 +288,20 @@ src/dataunit/DataUnit.ts:36
 ## Accessors
+### allowReleaseCallbacks
+> `set` **allowReleaseCallbacks**(`allow`): `void`
+#### Parameters
+• **allow**: `boolean`
+#### Source
+src/dataunit/DataUnit.ts:1800
+***
 ### dataUnitId
 > `get` **dataUnitId**(): `string`
@@ -288,7 +312,7 @@ src/dataunit/DataUnit.ts:36
 #### Source
-src/dataunit/DataUnit.ts:141
+src/dataunit/DataUnit.ts:145
 ***
@@ -348,7 +372,7 @@ Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uni
 #### Source
-src/dataunit/DataUnit.ts:152
+src/dataunit/DataUnit.ts:156
 ***
@@ -442,7 +466,7 @@ Campo a ser adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1766
+src/dataunit/DataUnit.ts:1781
 ***
@@ -492,7 +516,7 @@ Valor da propriedade
 #### Source
-src/dataunit/DataUnit.ts:128
+src/dataunit/DataUnit.ts:132
 ***
@@ -532,7 +556,7 @@ Retorna uma função responsável por liberar o lock adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1775
+src/dataunit/DataUnit.ts:1790
 ***
@@ -574,7 +598,7 @@ Adiciona um campo stand-alone ao dataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1757
+src/dataunit/DataUnit.ts:1772
 ***
@@ -592,7 +616,7 @@ Retorna as alterações a serem salvas no DataUnit atual.
 #### Source
-src/dataunit/DataUnit.ts:508
+src/dataunit/DataUnit.ts:509
 ***
@@ -612,7 +636,7 @@ src/dataunit/DataUnit.ts:508
 #### Source
-src/dataunit/DataUnit.ts:512
+src/dataunit/DataUnit.ts:513
 ***
@@ -630,7 +654,7 @@ Verdadeiro se for possível refazer a ação.
 #### Source
-src/dataunit/DataUnit.ts:1397
+src/dataunit/DataUnit.ts:1420
 ***
@@ -648,7 +672,7 @@ Verdadeiro se for possível desfazer a ação.
 #### Source
-src/dataunit/DataUnit.ts:1386
+src/dataunit/DataUnit.ts:1409
 ***
@@ -674,7 +698,7 @@ Contexto de execução do cancelamento da seleção dos registros.
 #### Source
-src/dataunit/DataUnit.ts:1253
+src/dataunit/DataUnit.ts:1262
 ***
@@ -714,7 +738,7 @@ Verdadeiro se existir alterações pendentes em algum DataUnit detail.
 #### Source
-src/dataunit/DataUnit.ts:1282
+src/dataunit/DataUnit.ts:1305
 ***
@@ -730,7 +754,7 @@ Limpa todos os registros do DataUnit
 #### Source
-src/dataunit/DataUnit.ts:1186
+src/dataunit/DataUnit.ts:1195
 ***
@@ -822,13 +846,13 @@ nome do campo para ficar desabilitado.
 #### Source
-src/dataunit/DataUnit.ts:1667
+src/dataunit/DataUnit.ts:1682
 ***
 ### dispatchAction()
-> `private` **dispatchAction**(`actionType`, `payload`?, `executionCtx`?): `Promise`\<`boolean`\>
+> `private` **dispatchAction**(`actionType`, `payload`?, `executionCtx`?, `options`?): `Promise`\<`boolean`\>
 Lança ação do DataUnit para que sejam processadas.
@@ -846,6 +870,8 @@ Dados que serão processados na ação.
 Contexto de execução de lançar a ação que será executada.
+• **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
 #### Returns
 `Promise`\<`boolean`\>
@@ -854,13 +880,13 @@ Contexto de execução de lançar a ação que será executada.
 #### Source
-src/dataunit/DataUnit.ts:1447
+src/dataunit/DataUnit.ts:1470
 ***
 ### doDispatchAction()
-> `private` **doDispatchAction**(`action`): `void`
+> `private` **doDispatchAction**(`action`, `options`): `void`
 Processa as ações no DataUnit e notifica os observers.
@@ -870,13 +896,15 @@ Processa as ações no DataUnit e notifica os observers.
 Ações em execução no DataUnit.
+• **options**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)= `{}`
 #### Returns
 `void`
 #### Source
-src/dataunit/DataUnit.ts:1503
+src/dataunit/DataUnit.ts:1518
 ***
@@ -898,7 +926,7 @@ nome do campo para ser habilitado.
 #### Source
-src/dataunit/DataUnit.ts:1652
+src/dataunit/DataUnit.ts:1667
 ***
@@ -932,7 +960,7 @@ Habilita a verificação da última requisição, evitando carga desnecessária.
 #### Source
-src/dataunit/DataUnit.ts:219
+src/dataunit/DataUnit.ts:225
 ***
@@ -968,7 +996,7 @@ Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Ma
 #### Source
-src/dataunit/DataUnit.ts:530
+src/dataunit/DataUnit.ts:531
 ***
@@ -986,7 +1014,7 @@ Obtém os filtros aplicados.
 #### Source
-src/dataunit/DataUnit.ts:1641
+src/dataunit/DataUnit.ts:1656
 ***
@@ -1000,7 +1028,7 @@ src/dataunit/DataUnit.ts:1641
 #### Source
-src/dataunit/DataUnit.ts:430
+src/dataunit/DataUnit.ts:435
 ***
@@ -1022,7 +1050,7 @@ Nome do dataunit filho.
 #### Source
-src/dataunit/DataUnit.ts:1526
+src/dataunit/DataUnit.ts:1541
 ***
@@ -1118,7 +1146,7 @@ Interface FilterProvider na qual será retornada uma chave correspondente.
 #### Source
-src/dataunit/DataUnit.ts:201
+src/dataunit/DataUnit.ts:207
 ***
@@ -1136,7 +1164,7 @@ Obtém todos os filtros de dados.
 #### Source
-src/dataunit/DataUnit.ts:1612
+src/dataunit/DataUnit.ts:1627
 ***
@@ -1167,7 +1195,7 @@ Nome do campo utilizado do qual se quer obter valor.
 #### Source
-src/dataunit/DataUnit.ts:654
+src/dataunit/DataUnit.ts:655
 ***
@@ -1185,7 +1213,7 @@ Retorna as propriedades transacionais adicionados anteriores à chamada.
 #### Source
-src/dataunit/DataUnit.ts:137
+src/dataunit/DataUnit.ts:141
 ***
@@ -1229,7 +1257,7 @@ Obtém as informações da última carga de dados.
 #### Source
-src/dataunit/DataUnit.ts:1630
+src/dataunit/DataUnit.ts:1645
 ***
@@ -1249,7 +1277,7 @@ src/dataunit/DataUnit.ts:1630
 #### Source
-src/dataunit/DataUnit.ts:391
+src/dataunit/DataUnit.ts:400
 ***
@@ -1289,6 +1317,24 @@ src/dataunit/DataUnit.ts:720
 ***
+### getParentDataUnit()
+> **getParentDataUnit**(): `undefined` \| [`DataUnit`](DataUnit.md)
+Retorna o DataUnit pai
+#### Returns
+`undefined` \| [`DataUnit`](DataUnit.md)
+DataUnit pai ou undefined
+#### Source
+src/dataunit/DataUnit.ts:1185
+***
 ### getParentRecordId()
 > `private` **getParentRecordId**(): `undefined` \| `string`
@@ -1359,7 +1405,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Source
-src/dataunit/DataUnit.ts:1717
+src/dataunit/DataUnit.ts:1732
 ***
@@ -1383,7 +1429,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Source
-src/dataunit/DataUnit.ts:1741
+src/dataunit/DataUnit.ts:1756
 ***
@@ -1419,7 +1465,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
 #### Source
-src/dataunit/DataUnit.ts:1601
+src/dataunit/DataUnit.ts:1616
 ***
@@ -1447,7 +1493,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:343
+src/dataunit/DataUnit.ts:352
 ***
@@ -1465,7 +1511,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1366
+src/dataunit/DataUnit.ts:1389
 ***
@@ -1483,7 +1529,7 @@ Verdadeiro se existir alterações de registros pendentes.
 #### Source
-src/dataunit/DataUnit.ts:1296
+src/dataunit/DataUnit.ts:1319
 ***
@@ -1501,7 +1547,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1354
+src/dataunit/DataUnit.ts:1377
 ***
@@ -1519,7 +1565,7 @@ Verdadeiro se existir uma próxima página.
 #### Source
-src/dataunit/DataUnit.ts:1307
+src/dataunit/DataUnit.ts:1330
 ***
@@ -1537,7 +1583,7 @@ Verdadeiro se existir uma página anterior.
 #### Source
-src/dataunit/DataUnit.ts:1322
+src/dataunit/DataUnit.ts:1345
 ***
@@ -1577,7 +1623,7 @@ nome do campo para ficar invisível.
 #### Source
-src/dataunit/DataUnit.ts:1682
+src/dataunit/DataUnit.ts:1697
 ***
@@ -1605,16 +1651,20 @@ Interceptors que serão notificados.
 #### Source
-src/dataunit/DataUnit.ts:1482
+src/dataunit/DataUnit.ts:1501
 ***
 ### isDirty()
-> **isDirty**(): `boolean`
+> **isDirty**(`ignoreChildren`?): `boolean`
 Retorna se existe algum tipo de alteração pendente.
+#### Parameters
+• **ignoreChildren?**: `boolean`
 #### Returns
 `boolean`
@@ -1623,7 +1673,7 @@ Verdadeiro se existir alterações pendentes.
 #### Source
-src/dataunit/DataUnit.ts:1271
+src/dataunit/DataUnit.ts:1281
 ***
@@ -1647,7 +1697,25 @@ Verdadeiro se o id solicitado é de um registro novo.
 #### Source
-src/dataunit/DataUnit.ts:1338
+src/dataunit/DataUnit.ts:1361
+***
+### isParentDirty()
+> **isParentDirty**(): `boolean`
+Retorna se existe alterações pendentes no DataUnit pai.
+#### Returns
+`boolean`
+Verdadeiro se existir alterações pendentes e Falso caso não exista alterações ou não exista DataUnit pai.
+#### Source
+src/dataunit/DataUnit.ts:1294
 ***
@@ -1665,7 +1733,7 @@ src/dataunit/DataUnit.ts:1338
 #### Source
-src/dataunit/DataUnit.ts:272
+src/dataunit/DataUnit.ts:278
 ***
@@ -1701,7 +1769,7 @@ Habilita a verificação da última requisição, evitando carga desnecessária.
 #### Source
-src/dataunit/DataUnit.ts:316
+src/dataunit/DataUnit.ts:322
 ***
@@ -1725,7 +1793,7 @@ Contexto de execução do carregamento dos metadados do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:287
+src/dataunit/DataUnit.ts:293
 ***
@@ -1749,7 +1817,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:374
+src/dataunit/DataUnit.ts:383
 ***
@@ -1771,7 +1839,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1198
+src/dataunit/DataUnit.ts:1207
 ***
@@ -1789,7 +1857,7 @@ src/dataunit/DataUnit.ts:1198
 #### Source
-src/dataunit/DataUnit.ts:411
+src/dataunit/DataUnit.ts:420
 ***
@@ -1809,7 +1877,7 @@ Trata as Actions do DataUnit Parent
 #### Source
-src/dataunit/DataUnit.ts:177
+src/dataunit/DataUnit.ts:181
 ***
@@ -1833,7 +1901,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:387
+src/dataunit/DataUnit.ts:396
 ***
@@ -1855,7 +1923,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1225
+src/dataunit/DataUnit.ts:1234
 ***
@@ -1869,7 +1937,7 @@ src/dataunit/DataUnit.ts:1225
 #### Source
-src/dataunit/DataUnit.ts:1785
+src/dataunit/DataUnit.ts:1804
 ***
@@ -1891,7 +1959,7 @@ Contexto de execução de refazer a última ação.
 #### Source
-src/dataunit/DataUnit.ts:1420
+src/dataunit/DataUnit.ts:1443
 ***
@@ -1907,7 +1975,7 @@ Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
 #### Source
-src/dataunit/DataUnit.ts:92
+src/dataunit/DataUnit.ts:94
 ***
@@ -1930,7 +1998,7 @@ Callbacks que são liberados:
 #### Source
-src/dataunit/DataUnit.ts:112
+src/dataunit/DataUnit.ts:114
 ***
@@ -1948,7 +2016,7 @@ Recarrega registro selecionado com dados atualizados do servidor.
 #### Source
-src/dataunit/DataUnit.ts:1573
+src/dataunit/DataUnit.ts:1588
 ***
@@ -1970,7 +2038,7 @@ Nome do dataunit filho.
 #### Source
-src/dataunit/DataUnit.ts:1539
+src/dataunit/DataUnit.ts:1554
 ***
@@ -2054,7 +2122,7 @@ Define se haverá mensagem de confirmação da remoção
 #### Source
-src/dataunit/DataUnit.ts:573
+src/dataunit/DataUnit.ts:574
 ***
@@ -2082,7 +2150,7 @@ Define se haverá mensagem de confirmação da remoção
 #### Source
-src/dataunit/DataUnit.ts:547
+src/dataunit/DataUnit.ts:548
 ***
@@ -2100,7 +2168,7 @@ src/dataunit/DataUnit.ts:547
 #### Source
-src/dataunit/DataUnit.ts:266
+src/dataunit/DataUnit.ts:272
 ***
@@ -2124,7 +2192,7 @@ Contexto de execução da persistencia do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:445
+src/dataunit/DataUnit.ts:450
 ***
@@ -2174,7 +2242,7 @@ src/dataunit/DataUnit.ts:1078
 ### setFieldValue()
-> **setFieldValue**(`fieldName`, `newValue`, `records`?): `Promise`\<`boolean`\>
+> **setFieldValue**(`fieldName`, `newValue`, `records`?, `options`?): `Promise`\<`boolean`\>
 Insere valor no campo desejado.
@@ -2192,6 +2260,8 @@ Valor a ser inserido no campo.
 Indica quais registros foram afetados pela alteração no valor do campo.
+• **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
 #### Returns
 `Promise`\<`boolean`\>
@@ -2304,7 +2374,7 @@ nome do campo para ficar visível.
 #### Source
-src/dataunit/DataUnit.ts:1697
+src/dataunit/DataUnit.ts:1712
 ***
@@ -2353,7 +2423,7 @@ Função que recebe como parâmetro as ações que serão monitoradas.
 #### Source
-src/dataunit/DataUnit.ts:1551
+src/dataunit/DataUnit.ts:1566
 ***
@@ -2371,7 +2441,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1431
+src/dataunit/DataUnit.ts:1454
 ***
@@ -2393,7 +2463,7 @@ Contexto de execução de desfazer a última ação.
 #### Source
-src/dataunit/DataUnit.ts:1409
+src/dataunit/DataUnit.ts:1432
 ***
@@ -2415,7 +2485,7 @@ Observer que se deseja remover.
 #### Source
-src/dataunit/DataUnit.ts:1562
+src/dataunit/DataUnit.ts:1577
 ***
@@ -2493,7 +2563,7 @@ Novo valor que será atribuído ao campo pós validação.
 #### Source
-src/dataunit/DataUnit.ts:166
+src/dataunit/DataUnit.ts:170
 ***
@@ -2521,7 +2591,7 @@ Texto que será convertido de acordo com o tipo identificado no campo.
 #### Source
-src/dataunit/DataUnit.ts:621
+src/dataunit/DataUnit.ts:622
 ***
@@ -2549,7 +2619,7 @@ Valor a ser convertido.
 #### Source
-src/dataunit/DataUnit.ts:636
+src/dataunit/DataUnit.ts:637
 ***