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

package/classes/VersionUtils.md

@@ -0,0 +1,42 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / VersionUtils
+
+# Class: VersionUtils
+
+## Table of contents
+
+### Constructors
+
+- [constructor](VersionUtils.md#constructor)
+
+### Methods
+
+- [isRequiredVersion](VersionUtils.md#isrequiredversion)
+
+## Constructors
+
+### constructor
+
+• **new VersionUtils**()
+
+## Methods
+
+### isRequiredVersion
+
+▸ `Static` **isRequiredVersion**(`currentVersion`, `requiredVersion`): `boolean`
+
+Verifica se a versão do backend (SankhyaOM) é maior ou igual a uma determinada versão.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `currentVersion` | `string` |
+| `requiredVersion` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/utils/VersionUtils.ts:8

package/classes/WaitingChangeException.md

@@ -0,0 +1,200 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WaitingChangeException
+
+# Class: WaitingChangeException
+
+`WaitingChangeException`: Exceção lançada quando um campo está pendente de finalizar a alteração antes de executar uma ação.
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`WaitingChangeException`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](WaitingChangeException.md#constructor)
+
+### Properties
+
+- [cause](WaitingChangeException.md#cause)
+- [message](WaitingChangeException.md#message)
+- [name](WaitingChangeException.md#name)
+- [stack](WaitingChangeException.md#stack)
+- [title](WaitingChangeException.md#title)
+- [prepareStackTrace](WaitingChangeException.md#preparestacktrace)
+- [stackTraceLimit](WaitingChangeException.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](WaitingChangeException.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new WaitingChangeException**(`title`, `message`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `title` | `string` |
+| `message` | `string` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+src/exceptions/WaitingChangeException.ts:15
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### message
+
+• **message**: `string`
+
+Descrição do erro.
+
+#### Overrides
+
+Error.message
+
+#### Defined in
+
+src/exceptions/WaitingChangeException.ts:13
+
+___
+
+### name
+
+• **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+Error.name
+
+#### Defined in
+
+src/exceptions/WaitingChangeException.ts:7
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1055
+
+___
+
+### title
+
+• **title**: `string`
+
+Titulo do erro.
+
+#### Defined in
+
+src/exceptions/WaitingChangeException.ts:10
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/classes/WarningException.md

@@ -0,0 +1,214 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / WarningException
+
+# Class: WarningException
+
+`WarningException`: Exceção lançada quando o "erro" vindo do backend é caracterizado como warning.
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`WarningException`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](WarningException.md#constructor)
+
+### Properties
+
+- [cause](WarningException.md#cause)
+- [errorCode](WarningException.md#errorcode)
+- [message](WarningException.md#message)
+- [name](WarningException.md#name)
+- [stack](WarningException.md#stack)
+- [title](WarningException.md#title)
+- [prepareStackTrace](WarningException.md#preparestacktrace)
+- [stackTraceLimit](WarningException.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](WarningException.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new WarningException**(`title`, `message`, `errorCode?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `title` | `string` | `undefined` |
+| `message` | `string` | `undefined` |
+| `errorCode` | `string` | `""` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+src/exceptions/WarningException.ts:18
+
+## Properties
+
+### cause
+
+• `Optional` **cause**: `unknown`
+
+#### Inherited from
+
+Error.cause
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+___
+
+### errorCode
+
+• **errorCode**: `string`
+
+Código do alerta, indica o alerta disparado pelo backend.
+
+#### Defined in
+
+src/exceptions/WarningException.ts:16
+
+___
+
+### message
+
+• **message**: `string`
+
+Descrição do alerta.
+
+#### Overrides
+
+Error.message
+
+#### Defined in
+
+src/exceptions/WarningException.ts:13
+
+___
+
+### name
+
+• **name**: `string`
+
+Nome da exceção.
+
+#### Overrides
+
+Error.name
+
+#### Defined in
+
+src/exceptions/WarningException.ts:7
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:1055
+
+___
+
+### title
+
+• **title**: `string`
+
+Titulo do alerta.
+
+#### Defined in
+
+src/exceptions/WarningException.ts:10
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/enums/Action.md

@@ -0,0 +1,283 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Action
+
+# Enumeration: Action
+
+## Table of contents
+
+### Enumeration Members
+
+- [CHANGE\_REDONE](Action.md#change_redone)
+- [CHANGE\_UNDONE](Action.md#change_undone)
+- [CHANGING\_DATA](Action.md#changing_data)
+- [CHILD\_CHANGED](Action.md#child_changed)
+- [DATA\_CHANGED](Action.md#data_changed)
+- [DATA\_LOADED](Action.md#data_loaded)
+- [DATA\_SAVED](Action.md#data_saved)
+- [EDITION\_CANCELED](Action.md#edition_canceled)
+- [FIELD\_INVALIDATED](Action.md#field_invalidated)
+- [INVALIDATE\_CLEAN](Action.md#invalidate_clean)
+- [LOADING\_DATA](Action.md#loading_data)
+- [LOADING\_METADATA](Action.md#loading_metadata)
+- [LOADING\_RECORD](Action.md#loading_record)
+- [METADATA\_LOADED](Action.md#metadata_loaded)
+- [NEXT\_SELECTED](Action.md#next_selected)
+- [PREVIOUS\_SELECTED](Action.md#previous_selected)
+- [RECORDS\_ADDED](Action.md#records_added)
+- [RECORDS\_COPIED](Action.md#records_copied)
+- [RECORDS\_REMOVED](Action.md#records_removed)
+- [RECORD\_LOADED](Action.md#record_loaded)
+- [REMOVING\_RECORDS](Action.md#removing_records)
+- [SAVING\_DATA](Action.md#saving_data)
+- [SELECTION\_CHANGED](Action.md#selection_changed)
+- [STATE\_CHANGED](Action.md#state_changed)
+- [WAITING\_CHANGE\_CANCELED](Action.md#waiting_change_canceled)
+
+## Enumeration Members
+
+### CHANGE\_REDONE
+
+• **CHANGE\_REDONE** = ``"changeRedone"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:50
+
+___
+
+### CHANGE\_UNDONE
+
+• **CHANGE\_UNDONE** = ``"changeUndone"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:49
+
+___
+
+### CHANGING\_DATA
+
+• **CHANGING\_DATA** = ``"changingData"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:44
+
+___
+
+### CHILD\_CHANGED
+
+• **CHILD\_CHANGED** = ``"childChanged"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:61
+
+___
+
+### DATA\_CHANGED
+
+• **DATA\_CHANGED** = ``"dataChanged"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:46
+
+___
+
+### DATA\_LOADED
+
+• **DATA\_LOADED** = ``"dataLoaded"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:33
+
+___
+
+### DATA\_SAVED
+
+• **DATA\_SAVED** = ``"dataSaved"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:36
+
+___
+
+### EDITION\_CANCELED
+
+• **EDITION\_CANCELED** = ``"editionCanceled"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:48
+
+___
+
+### FIELD\_INVALIDATED
+
+• **FIELD\_INVALIDATED** = ``"fieldInvalidated"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:63
+
+___
+
+### INVALIDATE\_CLEAN
+
+• **INVALIDATE\_CLEAN** = ``"invalidateClean"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:64
+
+___
+
+### LOADING\_DATA
+
+• **LOADING\_DATA** = ``"loadingData"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:32
+
+___
+
+### LOADING\_METADATA
+
+• **LOADING\_METADATA** = ``"loadingMetadata"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:29
+
+___
+
+### LOADING\_RECORD
+
+• **LOADING\_RECORD** = ``"loadingRecord"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:58
+
+___
+
+### METADATA\_LOADED
+
+• **METADATA\_LOADED** = ``"metadataLoaded"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:30
+
+___
+
+### NEXT\_SELECTED
+
+• **NEXT\_SELECTED** = ``"nextSelected"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:53
+
+___
+
+### PREVIOUS\_SELECTED
+
+• **PREVIOUS\_SELECTED** = ``"previousSelected"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:54
+
+___
+
+### RECORDS\_ADDED
+
+• **RECORDS\_ADDED** = ``"recordsAdded"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:41
+
+___
+
+### RECORDS\_COPIED
+
+• **RECORDS\_COPIED** = ``"recordsCopied"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:42
+
+___
+
+### RECORDS\_REMOVED
+
+• **RECORDS\_REMOVED** = ``"recordsRemoved"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:39
+
+___
+
+### RECORD\_LOADED
+
+• **RECORD\_LOADED** = ``"recordLoaded"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:59
+
+___
+
+### REMOVING\_RECORDS
+
+• **REMOVING\_RECORDS** = ``"removingRecords"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:38
+
+___
+
+### SAVING\_DATA
+
+• **SAVING\_DATA** = ``"savingData"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:35
+
+___
+
+### SELECTION\_CHANGED
+
+• **SELECTION\_CHANGED** = ``"selectionChanged"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:52
+
+___
+
+### STATE\_CHANGED
+
+• **STATE\_CHANGED** = ``"stateChanged"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:56
+
+___
+
+### WAITING\_CHANGE\_CANCELED
+
+• **WAITING\_CHANGE\_CANCELED** = ``"waitingChangeCanceled"``
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:45