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

package/README.md

@@ -0,0 +1,63 @@
+@sankhyalabs/core / [Exports](modules.md)
+
+# @sankhyalabs/core
+
+Esse projeto é responsavél por disponibilizar utilitários JavaScript comuns entre vários projetos.
+
+## ❓ Como usar
+
+---
+
+Instale as dependências:
+
+```sh
+$ npm install @sankhyalabs/core
+```
+
+E utilize as funcionalidades:
+
+```ts
+import {StringUtils} from '@sankhyalabs/core'
+
+function test() {
+    alert(StringUtils.isEmpty(''));
+}
+```
+
+## ⁉️ Como contribuir
+
+---
+
+1. Crie uma branch com nome dentro
+   dos [padrões semânticos](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
+2. Realize as alterações para resolução das suas tarefas
+3. Se possível,
+   crie [casos de teste](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o#testes)
+   para a tarefa que você está executando
+4. Faça os commits dentro
+   dos [padrões semânticos](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191) para
+   a sua branch
+5. Abra um merge request para a branch alvo com as informações de acordo
+
+> Por favor, siga os padrões de código descritos
+> em [nossa Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)!
+
+## ⚡ Utilitários
+
+---
+
+Aqui estão alguns utilitários que podem ajudar a melhorar a experiência de uso do **sankhyacore**:
+
+- Projeto [cz-sankhya](https://git.sankhya.com.br/ferramentas/devops/semantic-release/cz-sankhya) - é um adaptador que
+  extende as funcionalidades do [commitizen](https://github.com/commitizen/cz-cli), e que te ajuda a escrever mensagens
+  de commit bem formatadas e guiadas, de maneira interativa e assertiva.
+
+#### Links comunidade Sankhya Developer 🧠
+
+- [Semantic Version](https://comunidade.sankhya.com.br/t/versionamento-semantico-sem-complicacao/7184)
+- [Padrão de nomenclatura de branches](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
+- Fluxo de trabalho
+  - [Branch feat-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-feat-dev/7226/1)
+  - [Branch bugfix-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-bugfix-dev/7190)
+  - [Branch hotfix-ga](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-hotfix-ga/7233)
+- [cz-sankhya](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191)

package/classes/ApplicationContext.md

@@ -0,0 +1,90 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ApplicationContext
+
+# Class: ApplicationContext
+
+`ApplicationContext`: Utilizado para manipulação do contexto.
+- Evitar uso da classe sem alinhamento com a arquitetura devido ao uso de variáveis globais.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ApplicationContext.md#constructor)
+
+### Methods
+
+- [getContextValue](ApplicationContext.md#getcontextvalue)
+- [getCtx](ApplicationContext.md#getctx)
+- [setContextValue](ApplicationContext.md#setcontextvalue)
+
+## Constructors
+
+### constructor
+
+• **new ApplicationContext**()
+
+## Methods
+
+### getContextValue
+
+▸ `Static` **getContextValue**(`key`): `any`
+
+Obtém informação específica do contexto.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `key` | `string` | Chave do contexto desejada. |
+
+#### Returns
+
+`any`
+
+- Informação do contexto desejado.
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:15
+
+___
+
+### getCtx
+
+▸ `Static` `Private` **getCtx**(): `any`
+
+Obtém o contexto global da aplicação sankhyacore.
+- Esse contexto pode ser entendido como um ponto de coesão para atores que não se conhecem poderem trocar informação. Assim, o código x busca por um possível valor no contexto. Se essa informação estiver lá, ele reage de certa forma. O código Y, sabe dessa necessidade mas não consegue passar essa informação diretamente, então atribui o valor ao contexto.
+
+#### Returns
+
+`any`
+
+- Objeto com as propriedades da variável global ___snkcore___ctx___.
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:34
+
+___
+
+### setContextValue
+
+▸ `Static` **setContextValue**(`key`, `value`): `any`
+
+Aplica informação no contexto.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `key` | `string` | Identificador do contexto. |
+| `value` | `any` | Informação a ser inserida no contexto. |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:25

package/classes/ArrayUtils.md

@@ -0,0 +1,99 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ArrayUtils
+
+# Class: ArrayUtils
+
+`ArrayUtils`: Utilitário com a responsabilidade de manipular Arrays.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ArrayUtils.md#constructor)
+
+### Methods
+
+- [applyStringFilter](ArrayUtils.md#applystringfilter)
+- [normalizeSearchString](ArrayUtils.md#normalizesearchstring)
+- [sortAlphabetically](ArrayUtils.md#sortalphabetically)
+
+## Constructors
+
+### constructor
+
+• **new ArrayUtils**()
+
+## Methods
+
+### applyStringFilter
+
+▸ `Static` **applyStringFilter**(`argument`, `originalArray`, `alphabeticalSorting?`, `fieldName?`): `any`[]
+
+Filtra um array a partir de um critério textual.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `argument` | `string` | `undefined` | Texto a ser usado no filtro. |
+| `originalArray` | `any`[] | `undefined` | Array no formato original. |
+| `alphabeticalSorting` | `boolean` | `true` | Determina se o resultado deve ser ordenado ou mantido na ordem original. Por padrão ordena. |
+| `fieldName` | `string` | `"label"` | Caso o objeto deva ser filtrado por um campo diferente de "label", pode-se usar esse parâmetro. |
+
+#### Returns
+
+`any`[]
+
+- Um array filtrado e ordenado conforme necessidade..
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:17
+
+___
+
+### normalizeSearchString
+
+▸ `Static` `Private` **normalizeSearchString**(`original`): `string`
+
+Converte texto para caixa alta e substitui caracteres acentuados.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | Texto a ser convertido. |
+
+#### Returns
+
+`string`
+
+- Texto com as letras acentuadas sem os acentos e em caixa alta.
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:35
+
+___
+
+### sortAlphabetically
+
+▸ `Static` **sortAlphabetically**(`originalArray`, `fieldName?`): `any`[]
+
+Ordena valores de um array alfabeticamente.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `originalArray` | `any`[] | `undefined` | Array a ser ordenado. |
+| `fieldName` | `string` | `"label"` | - |
+
+#### Returns
+
+`any`[]
+
+- Array ordenado alfabeticamente..
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:45

package/classes/AuthorizedServiceCaller.md

@@ -0,0 +1,76 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / AuthorizedServiceCaller
+
+# Class: AuthorizedServiceCaller
+
+## Table of contents
+
+### Constructors
+
+- [constructor](AuthorizedServiceCaller.md#constructor)
+
+### Properties
+
+- [serverURL](AuthorizedServiceCaller.md#serverurl)
+- [unauthorizedPath](AuthorizedServiceCaller.md#unauthorizedpath)
+
+### Methods
+
+- [requestService](AuthorizedServiceCaller.md#requestservice)
+
+## Constructors
+
+### constructor
+
+• **new AuthorizedServiceCaller**(`serverURL`, `unauthorizedPath`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serverURL` | `string` |
+| `unauthorizedPath` | `string` |
+
+#### Defined in
+
+src/http/AuthorizedServiceCaller.ts:6
+
+## Properties
+
+### serverURL
+
+• `Private` **serverURL**: `string` = `"http://192.168.1.218:8503"`
+
+#### Defined in
+
+src/http/AuthorizedServiceCaller.ts:3
+
+___
+
+### unauthorizedPath
+
+• `Private` **unauthorizedPath**: `string` = `"/"`
+
+#### Defined in
+
+src/http/AuthorizedServiceCaller.ts:4
+
+## Methods
+
+### requestService
+
+▸ **requestService**(`request`, `callback?`): `Promise`<`void` \| `Response`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | `AuthorizedRequest` |
+| `callback?` | `Function` |
+
+#### Returns
+
+`Promise`<`void` \| `Response`\>
+
+#### Defined in
+
+src/http/AuthorizedServiceCaller.ts:12

package/classes/Change.md

@@ -0,0 +1,190 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Change
+
+# Class: Change
+
+`Change`: Dados que representam uma alteração.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Change.md#constructor)
+
+### Properties
+
+- [\_operation](Change.md#_operation)
+- [dataUnit](Change.md#dataunit)
+- [record](Change.md#record)
+- [sourceId](Change.md#sourceid)
+- [updatingFields](Change.md#updatingfields)
+
+### Accessors
+
+- [operation](Change.md#operation)
+
+### Methods
+
+- [isCopy](Change.md#iscopy)
+- [isDelete](Change.md#isdelete)
+- [isInsert](Change.md#isinsert)
+- [isUpdate](Change.md#isupdate)
+
+## Constructors
+
+### constructor
+
+• **new Change**(`dataUnit`, `record`, `updates`, `operation`, `sourceId?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | `string` |
+| `record` | [`Record`](../interfaces/Record.md) |
+| `updates` | `any` |
+| `operation` | [`ChangeOperation`](../enums/ChangeOperation.md) |
+| `sourceId?` | `string` |
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1664
+
+## Properties
+
+### \_operation
+
+• `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1662
+
+___
+
+### dataUnit
+
+• **dataUnit**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1657
+
+___
+
+### record
+
+• **record**: [`Record`](../interfaces/Record.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1658
+
+___
+
+### sourceId
+
+• **sourceId**: `undefined` \| `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1659
+
+___
+
+### updatingFields
+
+• **updatingFields**: `any`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1660
+
+## Accessors
+
+### operation
+
+• `get` **operation**(): `string`
+
+Obtém o tipo de operação que está sendo realizada.
+
+#### Returns
+
+`string`
+
+- Ação que está sendo executada.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1679
+
+## Methods
+
+### isCopy
+
+▸ **isCopy**(): `boolean`
+
+Retorna se o DataUnit está em uma operação de cópia.
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se a operação for de cópia.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1701
+
+___
+
+### isDelete
+
+▸ **isDelete**(): `boolean`
+
+Retorna se o DataUnit está em uma operação de deleção.
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se a operação for de deleção.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1712
+
+___
+
+### isInsert
+
+▸ **isInsert**(): `boolean`
+
+Retorna se o DataUnit está em uma operação de inserção.
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se a operação for de inserção.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1690
+
+___
+
+### isUpdate
+
+▸ **isUpdate**(): `boolean`
+
+Retorna se o DataUnit está em uma operação de atualização.
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se a operação for de atualização.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1723