@sankhyalabs/core-docs 5.20.0-dev.54 → 5.20.0-dev.56

package/classes/LockManager.md

@@ -0,0 +1,191 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManager
+
+# Class: LockManager
+
+## Constructors
+
+### new LockManager()
+
+> **new LockManager**(): [`LockManager`](LockManager.md)
+
+#### Returns
+
+[`LockManager`](LockManager.md)
+
+## Properties
+
+### ATTRIBUTE\_NAME
+
+> `static` **ATTRIBUTE\_NAME**: `string` = `"data-locker-manger-context-id"`
+
+Nome do atributo que será utilizado para controlar contexto de locks nos elementos da DOM.
+
+#### Source
+
+src/utils/LockManager.ts:24
+
+***
+
+### \_locks
+
+> `static` `private` **\_locks**: `Map`\<`string`, `Lock`[]\>
+
+#### Source
+
+src/utils/LockManager.ts:19
+
+## Methods
+
+### addLockManagerCtxId()
+
+> `static` **addLockManagerCtxId**(`startElement`): `string`
+
+Cria um contexto de locker, caso nao exista, para todos elementos pais iniciados com ez- ou snk-.
+
+#### Parameters
+
+• **startElement**: `HTMLElement`
+
+Elemento de de onde o lock deve começar.
+
+#### Returns
+
+`string`
+
+- O id do locker, que pode ser usado para iniciar ou aguardar um lock do contexto.
+
+#### Source
+
+src/utils/LockManager.ts:83
+
+***
+
+### buildContextID()
+
+> `static` `private` **buildContextID**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/utils/LockManager.ts:26
+
+***
+
+### buildLockerID()
+
+> `static` `private` **buildLockerID**(`ctxId`, `operation`): `undefined` \| `string`
+
+#### Parameters
+
+• **ctxId**: `string` \| `HTMLElement`
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:30
+
+***
+
+### findExistingCtxId()
+
+> `static` `private` **findExistingCtxId**(`element`): `null` \| `string`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+#### Returns
+
+`null` \| `string`
+
+#### Source
+
+src/utils/LockManager.ts:43
+
+***
+
+### lock()
+
+> `static` **lock**(`id`, `operation`): `any`
+
+Inicia um locker baseado em um contexto e uma operação.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+Operação do contexto que o lock deve ser feito.
+
+#### Returns
+
+`any`
+
+- Uma função que fara a liberação do lock.
+
+#### Source
+
+src/utils/LockManager.ts:114
+
+***
+
+### traverseAndAddAttr()
+
+> `static` `private` **traverseAndAddAttr**(`element`, `ctxId`): `void`
+
+#### Parameters
+
+• **element**: `HTMLElement`
+
+• **ctxId**: `string`
+
+#### Returns
+
+`void`
+
+#### Source
+
+src/utils/LockManager.ts:65
+
+***
+
+### whenResolve()
+
+> `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
+
+Aguarda todos os lockers de um contexto e operação serem resolvidos.
+
+#### Parameters
+
+• **id**: `string` \| `HTMLElement`
+
+Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
+
+• **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
+
+Operação do contexto que devera aguardar.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+- Promise que será resolvida quando todos lockers forem finalizados.
+
+#### Source
+
+src/utils/LockManager.ts:142

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2027
+src/dataunit/DataUnit.ts:2030
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2027
 
 #### Source
 
-src/dataunit/DataUnit.ts:2024
+src/dataunit/DataUnit.ts:2027
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2024
 
 #### Source
 
-src/dataunit/DataUnit.ts:2025
+src/dataunit/DataUnit.ts:2028
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2025
 
 #### Source
 
-src/dataunit/DataUnit.ts:2021
+src/dataunit/DataUnit.ts:2024
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2021
 
 #### Source
 
-src/dataunit/DataUnit.ts:2023
+src/dataunit/DataUnit.ts:2026
 
 ***
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2023
 
 #### Source
 
-src/dataunit/DataUnit.ts:2020
+src/dataunit/DataUnit.ts:2023
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2020
 
 #### Source
 
-src/dataunit/DataUnit.ts:2022
+src/dataunit/DataUnit.ts:2025
 
 ## Accessors
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2022
 
 #### Source
 
-src/dataunit/DataUnit.ts:2055
+src/dataunit/DataUnit.ts:2058
 
 ***
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2055
 
 #### Source
 
-src/dataunit/DataUnit.ts:2045
+src/dataunit/DataUnit.ts:2048
 
 ***
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2045
 
 #### Source
 
-src/dataunit/DataUnit.ts:2035
+src/dataunit/DataUnit.ts:2038
 
 ## Methods
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2035
 
 #### Source
 
-src/dataunit/DataUnit.ts:2062
+src/dataunit/DataUnit.ts:2065
 
 ***
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2062
 
 #### Source
 
-src/dataunit/DataUnit.ts:2066
+src/dataunit/DataUnit.ts:2069

package/classes/ServiceUtils.md

@@ -0,0 +1,67 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ServiceUtils
+
+# Class: ServiceUtils
+
+## Constructors
+
+### new ServiceUtils()
+
+> **new ServiceUtils**(): [`ServiceUtils`](ServiceUtils.md)
+
+#### Returns
+
+[`ServiceUtils`](ServiceUtils.md)
+
+## Methods
+
+### useCacheWithService()
+
+> `static` **useCacheWithService**\<`T`\>(`identifier`, `fetchFunction`, `storageType`): `Promise`\<`T`\>
+
+Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
+
+#### Type parameters
+
+• **T**
+
+Tipo do dado a ser retornado.
+
+#### Parameters
+
+• **identifier**: `string`
+
+Identificadores únicos usados para compor a chave de cache.
+
+• **fetchFunction**
+
+Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
+
+• **storageType**: [`StorageType`](../enumerations/StorageType.md)= `StorageType.IN_MEMORY_CACHE`
+
+Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
+
+#### Example
+
+```typescript
+const actions = await useCacheWithService(
+ `${this.entityName} - ${this.resourceID}`,
+  async () => {
+    return await fetchActionsFromAPI();
+  }
+);
+console.log(actions);
+```
+
+#### Source
+
+src/utils/ServiceUtils.ts:28

package/classes/SilentException.md

@@ -0,0 +1,193 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / SilentException
+
+# Class: SilentException
+
+`SilentException`: Exceção lançada quando uma exception silenciosa é.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### new SilentException()
+
+> **new SilentException**(`title`, `message`, `errorCode`): [`SilentException`](SilentException.md)
+
+#### Parameters
+
+• **title**: `string`= `""`
+
+• **message**: `string`= `""`
+
+• **errorCode**: `string`= `""`
+
+#### Returns
+
+[`SilentException`](SilentException.md)
+
+#### Overrides
+
+`Error.constructor`
+
+#### Source
+
+src/exceptions/SilentException.ts:18
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+#### Inherited from
+
+`Error.cause`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+***
+
+### errorCode
+
+> **errorCode**: `string`
+
+Código do erro, indica o erro disparado pelo backend.
+
+#### Source
+
+src/exceptions/SilentException.ts:16
+
+***
+
+### message
+
+> **message**: `string`
+
+Descrição do erro.
+
+#### Overrides
+
+`Error.message`
+
+#### Source
+
+src/exceptions/SilentException.ts:13
+
+***
+
+### name
+
+> **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+`Error.name`
+
+#### Source
+
+src/exceptions/SilentException.ts:7
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+`Error.stack`
+
+#### Source
+
+node\_modules/typescript/lib/lib.es5.d.ts:1055
+
+***
+
+### title
+
+> **title**: `string`
+
+Titulo do erro.
+
+#### Source
+
+src/exceptions/SilentException.ts:10
+
+***
+
+### prepareStackTrace()?
+
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
+
+Optional override for formatting stack traces
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Parameters
+
+• **err**: `Error`
+
+• **stackTraces**: `CallSite`[]
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:27
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:29
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+• **targetObject**: `object`
+
+• **constructorOpt?**: `Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+#### Source
+
+node\_modules/@types/node/globals.d.ts:20

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1906
+src/dataunit/DataUnit.ts:1909
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1906
 
 #### Source
 
-src/dataunit/DataUnit.ts:1908
+src/dataunit/DataUnit.ts:1911
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1908
 
 #### Source
 
-src/dataunit/DataUnit.ts:1905
+src/dataunit/DataUnit.ts:1908
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1905
 
 #### Source
 
-src/dataunit/DataUnit.ts:1907
+src/dataunit/DataUnit.ts:1910

package/enumerations/LockManagerOperation.md

@@ -0,0 +1,21 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / LockManagerOperation
+
+# Enumeration: LockManagerOperation
+
+Define os tipos de operação que o locker pode controlar
+
+## Enumeration Members
+
+### TASKBAR\_CLICK
+
+> **TASKBAR\_CLICK**: `"taskbar_click"`
+
+Operação de lock utilizada para controlar cliques nos botoes da taskbar.
+
+#### Source
+
+src/utils/LockManager.ts:9

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2014
+src/dataunit/DataUnit.ts:2017
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2014
 
 #### Source
 
-src/dataunit/DataUnit.ts:2015
+src/dataunit/DataUnit.ts:2018

package/enumerations/StorageType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / StorageType
+
+# Enumeration: StorageType
+
+## Enumeration Members
+
+### IN\_MEMORY\_CACHE
+
+> **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:2
+
+***
+
+### LOCAL\_STORAGE
+
+> **LOCAL\_STORAGE**: `"localStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:4
+
+***
+
+### SESSION\_STORAGE
+
+> **SESSION\_STORAGE**: `"sessionStorage"`
+
+#### Source
+
+src/utils/CacheManager/interfaces/index.ts:3

package/globals.md

@@ -14,9 +14,11 @@
 - [ChangeOperation](enumerations/ChangeOperation.md)
 - [DataType](enumerations/DataType.md)
 - [DependencyType](enumerations/DependencyType.md)
+- [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
+- [StorageType](enumerations/StorageType.md)
 - [UserInterface](enumerations/UserInterface.md)
 
 ## Classes
@@ -39,6 +41,7 @@
 - [IDBRepository](classes/IDBRepository.md)
 - [JSUtils](classes/JSUtils.md)
 - [KeyboardManager](classes/KeyboardManager.md)
+- [LockManager](classes/LockManager.md)
 - [MaskFormatter](classes/MaskFormatter.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
@@ -50,6 +53,8 @@
 - [SearchUtils](classes/SearchUtils.md)
 - [SelectionInfo](classes/SelectionInfo.md)
 - [ServiceCanceledException](classes/ServiceCanceledException.md)
+- [ServiceUtils](classes/ServiceUtils.md)
+- [SilentException](classes/SilentException.md)
 - [SkwHttpProvider](classes/SkwHttpProvider.md)
 - [StringUtils](classes/StringUtils.md)
 - [TimeFormatter](classes/TimeFormatter.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1889
+src/dataunit/DataUnit.ts:1892

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1994
+src/dataunit/DataUnit.ts:1997
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1994
 
 #### Source
 
-src/dataunit/DataUnit.ts:1995
+src/dataunit/DataUnit.ts:1998
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1995
 
 #### Source
 
-src/dataunit/DataUnit.ts:1996
+src/dataunit/DataUnit.ts:1999