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

package/enums/ChangeOperation.md

@@ -0,0 +1,52 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChangeOperation
+
+# Enumeration: ChangeOperation
+
+## Table of contents
+
+### Enumeration Members
+
+- [COPY](ChangeOperation.md#copy)
+- [DELETE](ChangeOperation.md#delete)
+- [INSERT](ChangeOperation.md#insert)
+- [UPDATE](ChangeOperation.md#update)
+
+## Enumeration Members
+
+### COPY
+
+• **COPY** = ``"COPY"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1647
+
+___
+
+### DELETE
+
+• **DELETE** = ``"DELETE"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1649
+
+___
+
+### INSERT
+
+• **INSERT** = ``"INSERT"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1646
+
+___
+
+### UPDATE
+
+• **UPDATE** = ``"UPDATE"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1648

package/enums/DataType.md

@@ -0,0 +1,63 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataType
+
+# Enumeration: DataType
+
+## Table of contents
+
+### Enumeration Members
+
+- [BOOLEAN](DataType.md#boolean)
+- [DATE](DataType.md#date)
+- [NUMBER](DataType.md#number)
+- [OBJECT](DataType.md#object)
+- [TEXT](DataType.md#text)
+
+## Enumeration Members
+
+### BOOLEAN
+
+• **BOOLEAN** = ``"BOOLEAN"``
+
+#### Defined in
+
+src/dataunit/metadata/DataType.ts:9
+
+___
+
+### DATE
+
+• **DATE** = ``"DATE"``
+
+#### Defined in
+
+src/dataunit/metadata/DataType.ts:7
+
+___
+
+### NUMBER
+
+• **NUMBER** = ``"NUMBER"``
+
+#### Defined in
+
+src/dataunit/metadata/DataType.ts:6
+
+___
+
+### OBJECT
+
+• **OBJECT** = ``"OBJECT"``
+
+#### Defined in
+
+src/dataunit/metadata/DataType.ts:10
+
+___
+
+### TEXT
+
+• **TEXT** = ``"TEXT"``
+
+#### Defined in
+
+src/dataunit/metadata/DataType.ts:8

package/enums/DependencyType.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DependencyType
+
+# Enumeration: DependencyType
+
+## Table of contents
+
+### Enumeration Members
+
+- [REQUIREMENT](DependencyType.md#requirement)
+- [SEARCHING](DependencyType.md#searching)
+- [VISIBILITY](DependencyType.md#visibility)
+
+## Enumeration Members
+
+### REQUIREMENT
+
+• **REQUIREMENT** = ``"REQUIREMENT"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:76
+
+___
+
+### SEARCHING
+
+• **SEARCHING** = ``"SEARCHING"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:75
+
+___
+
+### VISIBILITY
+
+• **VISIBILITY** = ``"REQUIREMENT"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:77

package/enums/SelectionMode.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionMode
+
+# Enumeration: SelectionMode
+
+## Table of contents
+
+### Enumeration Members
+
+- [ALL\_RECORDS](SelectionMode.md#all_records)
+- [SOME\_RECORDS](SelectionMode.md#some_records)
+
+## Enumeration Members
+
+### ALL\_RECORDS
+
+• **ALL\_RECORDS** = ``"ALL_RECORDS"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1757
+
+___
+
+### SOME\_RECORDS
+
+• **SOME\_RECORDS** = ``"SOME_RECORDS"``
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1758

package/enums/SortMode.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SortMode
+
+# Enumeration: SortMode
+
+## Table of contents
+
+### Enumeration Members
+
+- [ASC](SortMode.md#asc)
+- [DESC](SortMode.md#desc)
+
+## Enumeration Members
+
+### ASC
+
+• **ASC** = ``"ASC"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:70
+
+___
+
+### DESC
+
+• **DESC** = ``"DESC"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:71

package/enums/UserInterface.md

@@ -0,0 +1,195 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / UserInterface
+
+# Enumeration: UserInterface
+
+## Table of contents
+
+### Enumeration Members
+
+- [CHECKBOX](UserInterface.md#checkbox)
+- [DATE](UserInterface.md#date)
+- [DATETIME](UserInterface.md#datetime)
+- [DECIMALNUMBER](UserInterface.md#decimalnumber)
+- [ELAPSEDTIME](UserInterface.md#elapsedtime)
+- [FILE](UserInterface.md#file)
+- [HTML](UserInterface.md#html)
+- [IMAGE](UserInterface.md#image)
+- [INTEGERNUMBER](UserInterface.md#integernumber)
+- [LONGTEXT](UserInterface.md#longtext)
+- [MASKEDTEXT](UserInterface.md#maskedtext)
+- [OPTIONSELECTOR](UserInterface.md#optionselector)
+- [PASSWORD](UserInterface.md#password)
+- [SEARCH](UserInterface.md#search)
+- [SHORTTEXT](UserInterface.md#shorttext)
+- [SWITCH](UserInterface.md#switch)
+- [TIME](UserInterface.md#time)
+
+## Enumeration Members
+
+### CHECKBOX
+
+• **CHECKBOX** = ``"CHECKBOX"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:87
+
+___
+
+### DATE
+
+• **DATE** = ``"DATE"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:83
+
+___
+
+### DATETIME
+
+• **DATETIME** = ``"DATETIME"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:84
+
+___
+
+### DECIMALNUMBER
+
+• **DECIMALNUMBER** = ``"DECIMALNUMBER"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:90
+
+___
+
+### ELAPSEDTIME
+
+• **ELAPSEDTIME** = ``"ELAPSEDTIME"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:86
+
+___
+
+### FILE
+
+• **FILE** = ``"FILE"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:81
+
+___
+
+### HTML
+
+• **HTML** = ``"HTML"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:97
+
+___
+
+### IMAGE
+
+• **IMAGE** = ``"IMAGE"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:82
+
+___
+
+### INTEGERNUMBER
+
+• **INTEGERNUMBER** = ``"INTEGERNUMBER"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:91
+
+___
+
+### LONGTEXT
+
+• **LONGTEXT** = ``"LONGTEXT"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:96
+
+___
+
+### MASKEDTEXT
+
+• **MASKEDTEXT** = ``"MASKEDTEXT"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:95
+
+___
+
+### OPTIONSELECTOR
+
+• **OPTIONSELECTOR** = ``"OPTIONSELECTOR"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:89
+
+___
+
+### PASSWORD
+
+• **PASSWORD** = ``"PASSWORD"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:94
+
+___
+
+### SEARCH
+
+• **SEARCH** = ``"SEARCH"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:92
+
+___
+
+### SHORTTEXT
+
+• **SHORTTEXT** = ``"SHORTTEXT"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:93
+
+___
+
+### SWITCH
+
+• **SWITCH** = ``"SWITCH"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:88
+
+___
+
+### TIME
+
+• **TIME** = ``"TIME"``
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:85

package/interfaces/ChildDescriptor.md

@@ -0,0 +1,41 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildDescriptor
+
+# Interface: ChildDescriptor
+
+## Table of contents
+
+### Properties
+
+- [label](ChildDescriptor.md#label)
+- [links](ChildDescriptor.md#links)
+- [name](ChildDescriptor.md#name)
+
+## Properties
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:11
+
+___
+
+### links
+
+• **links**: [`ChildLink`](ChildLink.md)[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:13
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:12

package/interfaces/ChildLink.md

@@ -0,0 +1,30 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildLink
+
+# Interface: ChildLink
+
+## Table of contents
+
+### Properties
+
+- [source](ChildLink.md#source)
+- [target](ChildLink.md#target)
+
+## Properties
+
+### source
+
+• **source**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:17
+
+___
+
+### target
+
+• **target**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:18

package/interfaces/DUActionInterceptor.md

@@ -0,0 +1,29 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DUActionInterceptor
+
+# Interface: DUActionInterceptor
+
+## Table of contents
+
+### Methods
+
+- [interceptAction](DUActionInterceptor.md#interceptaction)
+
+## Methods
+
+### interceptAction
+
+▸ **interceptAction**(`action`): [`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+#### Returns
+
+[`DataUnitAction`](../classes/DataUnitAction.md) \| `Promise`<[`DataUnitAction`](../classes/DataUnitAction.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1630

package/interfaces/ExecutionContext.md

@@ -0,0 +1,58 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ExecutionContext
+
+# Interface: ExecutionContext
+
+## Table of contents
+
+### Properties
+
+- [after](ExecutionContext.md#after)
+- [before](ExecutionContext.md#before)
+
+## Properties
+
+### after
+
+• `Optional` **after**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => `void`
+
+#### Type declaration
+
+▸ (`action`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:24
+
+___
+
+### before
+
+• `Optional` **before**: (`action`: [`DataUnitAction`](../classes/DataUnitAction.md)) => [`DataUnitAction`](../classes/DataUnitAction.md)
+
+#### Type declaration
+
+▸ (`action`): [`DataUnitAction`](../classes/DataUnitAction.md)
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](../classes/DataUnitAction.md) |
+
+##### Returns
+
+[`DataUnitAction`](../classes/DataUnitAction.md)
+
+#### Defined in
+
+src/dataunit/state/action/DataUnitAction.ts:23

package/interfaces/FieldDescriptor.md

@@ -0,0 +1,140 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldDescriptor
+
+# Interface: FieldDescriptor
+
+## Table of contents
+
+### Properties
+
+- [dataType](FieldDescriptor.md#datatype)
+- [defaultValue](FieldDescriptor.md#defaultvalue)
+- [dependencies](FieldDescriptor.md#dependencies)
+- [group](FieldDescriptor.md#group)
+- [label](FieldDescriptor.md#label)
+- [name](FieldDescriptor.md#name)
+- [order](FieldDescriptor.md#order)
+- [properties](FieldDescriptor.md#properties)
+- [readOnly](FieldDescriptor.md#readonly)
+- [required](FieldDescriptor.md#required)
+- [userInterface](FieldDescriptor.md#userinterface)
+- [visible](FieldDescriptor.md#visible)
+
+## Properties
+
+### dataType
+
+• **dataType**: [`DataType`](../enums/DataType.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:24
+
+___
+
+### defaultValue
+
+• `Optional` **defaultValue**: `any`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:26
+
+___
+
+### dependencies
+
+• `Optional` **dependencies**: `FieldDependency`[]
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:31
+
+___
+
+### group
+
+• `Optional` **group**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:32
+
+___
+
+### label
+
+• **label**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:23
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:22
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:33
+
+___
+
+### properties
+
+• `Optional` **properties**: `any`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:30
+
+___
+
+### readOnly
+
+• `Optional` **readOnly**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:28
+
+___
+
+### required
+
+• `Optional` **required**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:29
+
+___
+
+### userInterface
+
+• `Optional` **userInterface**: [`UserInterface`](../enums/UserInterface.md)
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:25
+
+___
+
+### visible
+
+• `Optional` **visible**: `boolean`
+
+#### Defined in
+
+src/dataunit/metadata/UnitMetadata.ts:27