@sankhyalabs/core-docs 2.3.4 → 2.3.5

package/classes/ErrorTracking.md

@@ -0,0 +1,54 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ErrorTracking
+
+# Class: ErrorTracking
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ErrorTracking.md#constructor)
+
+### Methods
+
+- [init](ErrorTracking.md#init)
+- [isInternalException](ErrorTracking.md#isinternalexception)
+
+## Constructors
+
+### constructor
+
+• **new ErrorTracking**()
+
+## Methods
+
+### init
+
+▸ `Static` **init**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/traking/ErrorTraking.ts:6
+
+___
+
+### isInternalException
+
+▸ `Static` `Private` **isInternalException**(`error`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `error` | `any` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/traking/ErrorTraking.ts:17

package/classes/FloatingManager.md

@@ -0,0 +1,384 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FloatingManager
+
+# Class: FloatingManager
+
+## Table of contents
+
+### Constructors
+
+- [constructor](FloatingManager.md#constructor)
+
+### Properties
+
+- [MODAL\_DEFAULT\_CLASSNAME](FloatingManager.md#modal_default_classname)
+- [MODAL\_ELEMENT\_ID](FloatingManager.md#modal_element_id)
+- [STYLE\_ELEMENT\_ID](FloatingManager.md#style_element_id)
+- [entries](FloatingManager.md#entries)
+- [initialized](FloatingManager.md#initialized)
+
+### Methods
+
+- [applyStyle](FloatingManager.md#applystyle)
+- [close](FloatingManager.md#close)
+- [createOrUpdatOverlay](FloatingManager.md#createorupdatoverlay)
+- [createStyleElement](FloatingManager.md#createstyleelement)
+- [doClose](FloatingManager.md#doclose)
+- [float](FloatingManager.md#float)
+- [getFloatIndex](FloatingManager.md#getfloatindex)
+- [handleDocumentEvent](FloatingManager.md#handledocumentevent)
+- [handleKeyboardEvent](FloatingManager.md#handlekeyboardevent)
+- [hideOverlay](FloatingManager.md#hideoverlay)
+- [init](FloatingManager.md#init)
+- [innerClick](FloatingManager.md#innerclick)
+- [isFloating](FloatingManager.md#isfloating)
+- [showOverlay](FloatingManager.md#showoverlay)
+- [updateFloatPosition](FloatingManager.md#updatefloatposition)
+
+## Constructors
+
+### constructor
+
+• **new FloatingManager**()
+
+## Properties
+
+### MODAL\_DEFAULT\_CLASSNAME
+
+▪ `Static` **MODAL\_DEFAULT\_CLASSNAME**: `string` = `"FloatingManager__modal"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:50
+
+___
+
+### MODAL\_ELEMENT\_ID
+
+▪ `Static` **MODAL\_ELEMENT\_ID**: `string` = `"FloatingManager__overlay"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:51
+
+___
+
+### STYLE\_ELEMENT\_ID
+
+▪ `Static` **STYLE\_ELEMENT\_ID**: `string` = `"FloatingManager__style"`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:52
+
+___
+
+### entries
+
+▪ `Static` `Private` **entries**: `FloatingEntry`[]
+
+#### Defined in
+
+src/ui/FloatingManager.ts:55
+
+___
+
+### initialized
+
+▪ `Static` `Private` **initialized**: `boolean`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:54
+
+## Methods
+
+### applyStyle
+
+▸ `Static` `Private` **applyStyle**(`element`, `propertyName`, `value?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `element` | `HTMLElement` |
+| `propertyName` | `string` |
+| `value?` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:115
+
+___
+
+### close
+
+▸ `Static` **close**(`id`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `number` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:233
+
+___
+
+### createOrUpdatOverlay
+
+▸ `Static` `Private` **createOrUpdatOverlay**(`className?`): `HTMLDivElement`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `className` | `string` | `FloatingManager.MODAL_DEFAULT_CLASSNAME` |
+
+#### Returns
+
+`HTMLDivElement`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:179
+
+___
+
+### createStyleElement
+
+▸ `Static` `Private` **createStyleElement**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:198
+
+___
+
+### doClose
+
+▸ `Static` `Private` **doClose**(`id`, `entry`, `target?`, `event?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `number` |
+| `entry` | `FloatingEntry` |
+| `target?` | `HTMLElement` |
+| `event?` | `Event` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:76
+
+___
+
+### float
+
+▸ `Static` **float**(`content`, `parent`, `options?`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `content` | `HTMLElement` |
+| `parent` | `HTMLElement` |
+| `options` | `FloatingOptions` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:136
+
+___
+
+### getFloatIndex
+
+▸ `Static` `Private` **getFloatIndex**(`content`, `parent`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `content` | `HTMLElement` |
+| `parent` | `HTMLElement` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:121
+
+___
+
+### handleDocumentEvent
+
+▸ `Static` `Private` **handleDocumentEvent**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | `Event` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:96
+
+___
+
+### handleKeyboardEvent
+
+▸ `Static` `Private` **handleKeyboardEvent**(`event`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `event` | `KeyboardEvent` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:103
+
+___
+
+### hideOverlay
+
+▸ `Static` `Private` **hideOverlay**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:167
+
+___
+
+### init
+
+▸ `Static` `Private` **init**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:57
+
+___
+
+### innerClick
+
+▸ `Static` `Private` **innerClick**(`container`, `node`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `container` | `HTMLElement` |
+| `node` | `HTMLElement` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:64
+
+___
+
+### isFloating
+
+▸ `Static` **isFloating**(`id`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `number` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:132
+
+___
+
+### showOverlay
+
+▸ `Static` `Private` **showOverlay**(`options`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `FloatingOptions` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:161
+
+___
+
+### updateFloatPosition
+
+▸ `Static` **updateFloatPosition**(`content`, `parent`, `options?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `content` | `HTMLElement` |
+| `parent` | `HTMLElement` |
+| `options` | `FloatingOptions` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/ui/FloatingManager.ts:222

package/classes/HttpProvider.md

@@ -0,0 +1,96 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / HttpProvider
+
+# Class: HttpProvider
+
+Abstração do XMLHttpRequest. Este serviço é responsável por realizar as requisições
+ao backend. Todos os métodos são estáticos.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](HttpProvider.md#constructor)
+
+### Methods
+
+- [dispatch](HttpProvider.md#dispatch)
+- [get](HttpProvider.md#get)
+- [post](HttpProvider.md#post)
+
+## Constructors
+
+### constructor
+
+• **new HttpProvider**()
+
+## Methods
+
+### dispatch
+
+▸ `Static` `Private` **dispatch**(`requestMetadata`, `payload?`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `requestMetadata` | [`RequestMetadata`](RequestMetadata.md) |
+| `payload?` | `Object` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+src/http/HttpProvider.ts:32
+
+___
+
+### get
+
+▸ `Static` **get**(`url`, `headers?`): `Promise`<`Object`\>
+
+Faz uma requisição usando o método GET do HTTP para uma URL específica.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `headers?` | `Header`[] | [Opcional] Cabeçalhos HTTP. |
+
+#### Returns
+
+`Promise`<`Object`\>
+
+Uma promessa de que a requisição será preenchida.
+
+#### Defined in
+
+src/http/HttpProvider.ts:16
+
+___
+
+### post
+
+▸ `Static` **post**(`url`, `payload`, `headers?`): `Promise`<`any`\>
+
+Faz uma requisição usando o método POST do HTTP para uma URL específica.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `payload` | `Object` | Informações a serem enviadas. |
+| `headers?` | `Header`[] | [Opcional] Cabeçalhos HTTP. |
+
+#### Returns
+
+`Promise`<`any`\>
+
+Uma promessa de que a requisição será preenchida.
+
+#### Defined in
+
+src/http/HttpProvider.ts:28