@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6

package/classes/WarningException.md

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

package/enumerations/Action.md

@@ -0,0 +1,297 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / Action
+
+# Enumeration: Action
+
+## Enumeration Members
+
+### CHANGE\_REDONE
+
+> **CHANGE\_REDONE**: `"changeRedone"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:52
+
+***
+
+### CHANGE\_UNDONE
+
+> **CHANGE\_UNDONE**: `"changeUndone"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:51
+
+***
+
+### CHANGING\_DATA
+
+> **CHANGING\_DATA**: `"changingData"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:45
+
+***
+
+### CHILD\_CHANGED
+
+> **CHILD\_CHANGED**: `"childChanged"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:63
+
+***
+
+### DATA\_CHANGED
+
+> **DATA\_CHANGED**: `"dataChanged"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:47
+
+***
+
+### DATA\_LOADED
+
+> **DATA\_LOADED**: `"dataLoaded"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:33
+
+***
+
+### DATA\_RESOLVED
+
+> **DATA\_RESOLVED**: `"dataResolved"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:48
+
+***
+
+### DATA\_SAVED
+
+> **DATA\_SAVED**: `"dataSaved"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:37
+
+***
+
+### EDITION\_CANCELED
+
+> **EDITION\_CANCELED**: `"editionCanceled"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:50
+
+***
+
+### FIELD\_INVALIDATED
+
+> **FIELD\_INVALIDATED**: `"fieldInvalidated"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:65
+
+***
+
+### INVALIDATE\_CLEAN
+
+> **INVALIDATE\_CLEAN**: `"invalidateClean"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:66
+
+***
+
+### LOADING\_DATA
+
+> **LOADING\_DATA**: `"loadingData"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:32
+
+***
+
+### LOADING\_METADATA
+
+> **LOADING\_METADATA**: `"loadingMetadata"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:29
+
+***
+
+### LOADING\_PROPERTIES\_CLEANED
+
+> **LOADING\_PROPERTIES\_CLEANED**: `"loadingPropertiesCleaned"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:69
+
+***
+
+### LOADING\_PROPERTY\_ADDED
+
+> **LOADING\_PROPERTY\_ADDED**: `"loadingPropertyAdded"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:68
+
+***
+
+### LOADING\_RECORD
+
+> **LOADING\_RECORD**: `"loadingRecord"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:60
+
+***
+
+### METADATA\_LOADED
+
+> **METADATA\_LOADED**: `"metadataLoaded"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:30
+
+***
+
+### NEXT\_SELECTED
+
+> **NEXT\_SELECTED**: `"nextSelected"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:55
+
+***
+
+### PAGINATION\_UPDATED
+
+> **PAGINATION\_UPDATED**: `"paginationUpdated"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:34
+
+***
+
+### PREVIOUS\_SELECTED
+
+> **PREVIOUS\_SELECTED**: `"previousSelected"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:56
+
+***
+
+### RECORDS\_ADDED
+
+> **RECORDS\_ADDED**: `"recordsAdded"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:42
+
+***
+
+### RECORDS\_COPIED
+
+> **RECORDS\_COPIED**: `"recordsCopied"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:43
+
+***
+
+### RECORDS\_REMOVED
+
+> **RECORDS\_REMOVED**: `"recordsRemoved"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:40
+
+***
+
+### RECORD\_LOADED
+
+> **RECORD\_LOADED**: `"recordLoaded"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:61
+
+***
+
+### REMOVING\_RECORDS
+
+> **REMOVING\_RECORDS**: `"removingRecords"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:39
+
+***
+
+### SAVING\_DATA
+
+> **SAVING\_DATA**: `"savingData"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:36
+
+***
+
+### SELECTION\_CHANGED
+
+> **SELECTION\_CHANGED**: `"selectionChanged"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:54
+
+***
+
+### STATE\_CHANGED
+
+> **STATE\_CHANGED**: `"stateChanged"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:58
+
+***
+
+### WAITING\_CHANGE\_CANCELED
+
+> **WAITING\_CHANGE\_CANCELED**: `"waitingChangeCanceled"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:46

package/enumerations/ChangeOperation.md

@@ -0,0 +1,47 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ChangeOperation
+
+# Enumeration: ChangeOperation
+
+## Enumeration Members
+
+### COPY
+
+> **COPY**: `"COPY"`
+
+#### Source
+
+src/dataunit/DataUnit.ts:1794
+
+***
+
+### DELETE
+
+> **DELETE**: `"DELETE"`
+
+#### Source
+
+src/dataunit/DataUnit.ts:1796
+
+***
+
+### INSERT
+
+> **INSERT**: `"INSERT"`
+
+#### Source
+
+src/dataunit/DataUnit.ts:1793
+
+***
+
+### UPDATE
+
+> **UPDATE**: `"UPDATE"`
+
+#### Source
+
+src/dataunit/DataUnit.ts:1795

package/enumerations/DataType.md

@@ -0,0 +1,57 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataType
+
+# Enumeration: DataType
+
+## Enumeration Members
+
+### BOOLEAN
+
+> **BOOLEAN**: `"BOOLEAN"`
+
+#### Source
+
+src/dataunit/metadata/DataType.ts:12
+
+***
+
+### DATE
+
+> **DATE**: `"DATE"`
+
+#### Source
+
+src/dataunit/metadata/DataType.ts:10
+
+***
+
+### NUMBER
+
+> **NUMBER**: `"NUMBER"`
+
+#### Source
+
+src/dataunit/metadata/DataType.ts:9
+
+***
+
+### OBJECT
+
+> **OBJECT**: `"OBJECT"`
+
+#### Source
+
+src/dataunit/metadata/DataType.ts:13
+
+***
+
+### TEXT
+
+> **TEXT**: `"TEXT"`
+
+#### Source
+
+src/dataunit/metadata/DataType.ts:11

package/enumerations/DependencyType.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DependencyType
+
+# Enumeration: DependencyType
+
+## Enumeration Members
+
+### REQUIREMENT
+
+> **REQUIREMENT**: `"REQUIREMENT"`
+
+#### Source
+
+src/dataunit/metadata/UnitMetadata.ts:77
+
+***
+
+### SEARCHING
+
+> **SEARCHING**: `"SEARCHING"`
+
+#### Source
+
+src/dataunit/metadata/UnitMetadata.ts:76
+
+***
+
+### VISIBILITY
+
+> **VISIBILITY**: `"REQUIREMENT"`
+
+#### Source
+
+src/dataunit/metadata/UnitMetadata.ts:78