@sankhyalabs/core-docs 2.3.4 → 2.3.5

package/README.md

@@ -0,0 +1,57 @@
+@sankhyalabs/core / [Exports](modules.md)
+
+# @sankhyalabs/core
+
+### Intro
+Esse projeto é responsavél por disponibilizar utilitários JavaScript comuns entre vários projetos.
+
+# Como usar
+
+```sh
+$ npm install @sankhyalabs/core
+```
+
+```ts
+import { StringUtils } from '@sankhyalabs/core'
+
+function test(){
+    alert(StringUtils.isEmpty(''));
+}
+```
+# Executar testes
+```sh
+$ npm t
+```
+# Como contribuir
+- Criar uma branch com nome sugestivo para o problema/melhoria.
+- Dentro do projeto criar uma pasta chamada "change_proposal" dentro dessa pasta deverá existir um exemplo do caso de uso/problema que você está resolvendo.
+- Realizar as alterações.
+- Criar caso de teste para o problema que você está resolvendo.
+- Fazer commit na branch.
+- Abrir MR para master, na descrição do MR, colocar a seguinte documentação :arrow_down:
+
+##### Tipo de problema:
+- [ ] Hotfix
+- [ ] Feature
+##### Ambiente simulação:
+- [ ] Teste/Desenvolvimento
+- [ ] Produçãp
+
+##### Nome do projeto de origem (core, flow, wms...):
+
+##### Descrição do problema:
+
+##### Num.OS de origem(caso exista):
+
+#
+#
+#
+#
+
+### Build em ambiente de desenvolvimento
+
+```sh
+$ npm run build --watch
+```
+
+Veja mais informações em nossa [Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)

package/classes/ApplicationContext.md

@@ -0,0 +1,76 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ApplicationContext
+
+# Class: ApplicationContext
+
+## 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`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:3
+
+___
+
+### getCtx
+
+▸ `Static` `Private` **getCtx**(): `any`
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:11
+
+___
+
+### setContextValue
+
+▸ `Static` **setContextValue**(`key`, `value`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+| `value` | `any` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/ApplicationContext.ts:7

package/classes/ArrayUtils.md

@@ -0,0 +1,89 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ArrayUtils
+
+# Class: ArrayUtils
+
+## 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. Se "argument" for omitido, ou nulo, o array original é retornado.
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:13
+
+___
+
+### normalizeSearchString
+
+▸ `Static` `Private` **normalizeSearchString**(`original`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `original` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:25
+
+___
+
+### sortAlphabetically
+
+▸ `Static` **sortAlphabetically**(`originalArray`, `fieldName?`): `any`[]
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `originalArray` | `any`[] | `undefined` |
+| `fieldName` | `string` | `"label"` |
+
+#### Returns
+
+`any`[]
+
+#### Defined in
+
+src/utils/ArrayUtils.ts:29

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,168 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Change
+
+# Class: Change
+
+## 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:584
+
+## Properties
+
+### \_operation
+
+• `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:582
+
+___
+
+### dataUnit
+
+• **dataUnit**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:577
+
+___
+
+### record
+
+• **record**: [`Record`](../interfaces/Record.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:578
+
+___
+
+### sourceId
+
+• **sourceId**: `undefined` \| `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:579
+
+___
+
+### updatingFields
+
+• **updatingFields**: `any`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:580
+
+## Accessors
+
+### operation
+
+• `get` **operation**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:592
+
+## Methods
+
+### isCopy
+
+▸ **isCopy**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:600
+
+___
+
+### isDelete
+
+▸ **isDelete**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:604
+
+___
+
+### isInsert
+
+▸ **isInsert**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:596
+
+___
+
+### isUpdate
+
+▸ **isUpdate**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:608