@sankhyalabs/core-docs 0.0.0-feat-dev-KB-74304-6.0 → 0.0.0-feat-dev-KB-83113.0

package/classes/DataUnitInMemoryLoader.md

@@ -0,0 +1,293 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoader
+
+# Class: DataUnitInMemoryLoader
+
+## Constructors
+
+### new DataUnitInMemoryLoader()
+
+> **new DataUnitInMemoryLoader**(`metadata`?, `records`?, `config`?): [`DataUnitInMemoryLoader`](DataUnitInMemoryLoader.md)
+
+#### Parameters
+
+• **metadata?**: [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+• **records?**: [`Record`](../interfaces/Record.md)[]
+
+• **config?**: [`DataUnitInMemoryLoaderConfig`](../interfaces/DataUnitInMemoryLoaderConfig.md)
+
+#### Returns
+
+[`DataUnitInMemoryLoader`](DataUnitInMemoryLoader.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:25
+
+## Properties
+
+### \_dataUnit
+
+> `private` **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:19
+
+***
+
+### \_initialRecords
+
+> `private` **\_initialRecords**: [`Record`](../interfaces/Record.md)[] = `[]`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:21
+
+***
+
+### \_metadata
+
+> `private` **\_metadata**: `undefined` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:20
+
+***
+
+### recordDateFormat
+
+> `private` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:22
+
+***
+
+### IN\_MEMORY\_DATA\_UNIT\_NAME
+
+> `static` `readonly` **IN\_MEMORY\_DATA\_UNIT\_NAME**: `"InMemoryDataUnit"` = `'InMemoryDataUnit'`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:23
+
+## Accessors
+
+### dataUnit
+
+> `get` **dataUnit**(): [`DataUnit`](DataUnit.md)
+
+#### Returns
+
+[`DataUnit`](DataUnit.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:57
+
+***
+
+### metadata
+
+> `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+> `set` **metadata**(`metadata`): `void`
+
+#### Parameters
+
+• **metadata**: [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Returns
+
+[`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:121
+
+***
+
+### records
+
+> `get` **records**(): [`Record`](../interfaces/Record.md)[]
+
+> `set` **records**(`records`): `void`
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:61
+
+## Methods
+
+### buildColumns()
+
+> `private` **buildColumns**(): `undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Returns
+
+`undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:91
+
+***
+
+### buildInitialRecords()
+
+> `private` **buildInitialRecords**(`records`, `columns`): [`Record`](../interfaces/Record.md)[]
+
+#### Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **columns**: `undefined` \| `Map`\<`string`, [`FieldDescriptor`](../interfaces/FieldDescriptor.md)\>
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:97
+
+***
+
+### generateUniqueId()
+
+> `private` **generateUniqueId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:133
+
+***
+
+### getRecordsToLoad()
+
+> `private` **getRecordsToLoad**(): [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:45
+
+***
+
+### inMemoryLoader()
+
+> `private` **inMemoryLoader**(`dataUnit`, `request`, `recordsIn`): `Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Parameters
+
+• **dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+• **recordsIn**: [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`Promise`\<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:137
+
+***
+
+### metadaLoader()
+
+> `private` **metadaLoader**(): `Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Returns
+
+`Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:141
+
+***
+
+### removeLoader()
+
+> **removeLoader**(`_dataUnit`, `recordIds`): `Promise`\<`string`[]\>
+
+#### Parameters
+
+• **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **recordIds**: `string`[]
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:172
+
+***
+
+### saveLoader()
+
+> `private` **saveLoader**(`_dataUnit`, `changes`): `Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Parameters
+
+• **\_dataUnit**: [`DataUnit`](DataUnit.md)
+
+• **changes**: [`Change`](Change.md)[]
+
+#### Returns
+
+`Promise`\<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:145
+
+***
+
+### getConvertedValue()
+
+> `static` **getConvertedValue**(`descriptor`, `strValue`, `dateFormat`?): `any`
+
+#### Parameters
+
+• **descriptor**: [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+• **strValue**: `string`
+
+• **dateFormat?**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Returns
+
+`any`
+
+#### Source
+
+src/dataunit/loader/dataUnitInMemoryLoader.ts:76

package/classes/FieldComparator.md

@@ -58,7 +58,7 @@ src/dataunit/sorting/FieldComparator.ts:7
 
 #### Source
 
-src/dataunit/sorting/FieldComparator.ts:26
+src/dataunit/sorting/FieldComparator.ts:19
 
 ***
 
@@ -80,4 +80,4 @@ src/dataunit/sorting/FieldComparator.ts:26
 
 #### Source
 
-src/dataunit/sorting/FieldComparator.ts:16
+src/dataunit/sorting/FieldComparator.ts:14

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2057
+src/dataunit/DataUnit.ts:2074
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2057
 
 #### Source
 
-src/dataunit/DataUnit.ts:2054
+src/dataunit/DataUnit.ts:2071
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2054
 
 #### Source
 
-src/dataunit/DataUnit.ts:2055
+src/dataunit/DataUnit.ts:2072
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2055
 
 #### Source
 
-src/dataunit/DataUnit.ts:2051
+src/dataunit/DataUnit.ts:2068
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2051
 
 #### Source
 
-src/dataunit/DataUnit.ts:2053
+src/dataunit/DataUnit.ts:2070
 
 ***
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2053
 
 #### Source
 
-src/dataunit/DataUnit.ts:2050
+src/dataunit/DataUnit.ts:2067
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2050
 
 #### Source
 
-src/dataunit/DataUnit.ts:2052
+src/dataunit/DataUnit.ts:2069
 
 ## Accessors
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2052
 
 #### Source
 
-src/dataunit/DataUnit.ts:2085
+src/dataunit/DataUnit.ts:2102
 
 ***
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2085
 
 #### Source
 
-src/dataunit/DataUnit.ts:2075
+src/dataunit/DataUnit.ts:2092
 
 ***
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2075
 
 #### Source
 
-src/dataunit/DataUnit.ts:2065
+src/dataunit/DataUnit.ts:2082
 
 ## Methods
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2065
 
 #### Source
 
-src/dataunit/DataUnit.ts:2092
+src/dataunit/DataUnit.ts:2109
 
 ***
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2092
 
 #### Source
 
-src/dataunit/DataUnit.ts:2096
+src/dataunit/DataUnit.ts:2113

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1936
+src/dataunit/DataUnit.ts:1953
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1936
 
 #### Source
 
-src/dataunit/DataUnit.ts:1938
+src/dataunit/DataUnit.ts:1955
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1938
 
 #### Source
 
-src/dataunit/DataUnit.ts:1935
+src/dataunit/DataUnit.ts:1952
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1935
 
 #### Source
 
-src/dataunit/DataUnit.ts:1937
+src/dataunit/DataUnit.ts:1954

package/enumerations/RECORD_DATE_FORMAT.md

@@ -0,0 +1,27 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / RECORD\_DATE\_FORMAT
+
+# Enumeration: RECORD\_DATE\_FORMAT
+
+## Enumeration Members
+
+### DD\_MM\_YYYY
+
+> **DD\_MM\_YYYY**: `"DD/MM/YYYY"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:8
+
+***
+
+### ISO
+
+> **ISO**: `"ISO"`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:9

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:2044
+src/dataunit/DataUnit.ts:2061
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2044
 
 #### Source
 
-src/dataunit/DataUnit.ts:2045
+src/dataunit/DataUnit.ts:2062

package/functions/applyFilter.md

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / applyFilter
+
+# Function: applyFilter()
+
+> **applyFilter**(`records`, `dataUnit`, `filters`): [`Record`](../interfaces/Record.md)[]
+
+## Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
+
+• **filters**: [`Filter`](../interfaces/Filter.md)[]
+
+## Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+## Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:9

package/functions/applySorting.md

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / applySorting
+
+# Function: applySorting()
+
+> **applySorting**(`records`, `dataUnit`, `sorting`): [`Record`](../interfaces/Record.md)[]
+
+## Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
+
+• **sorting**: [`Sort`](../interfaces/Sort.md)[]
+
+## Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+## Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:36

package/functions/buildLoadDataResponse.md

@@ -0,0 +1,33 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / buildLoadDataResponse
+
+# Function: buildLoadDataResponse()
+
+> **buildLoadDataResponse**(`recordsIn`, `dataUnit`, `request`): `Promise`\<`object`\>
+
+## Parameters
+
+• **recordsIn**: [`Record`](../interfaces/Record.md)[]
+
+• **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
+
+• **request**: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+## Returns
+
+`Promise`\<`object`\>
+
+### paginationInfo
+
+> **paginationInfo**: `undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+### records
+
+> **records**: [`Record`](../interfaces/Record.md)[]
+
+## Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:17

package/functions/buildPaginationInfo.md

@@ -0,0 +1,21 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / buildPaginationInfo
+
+# Function: buildPaginationInfo()
+
+> **buildPaginationInfo**(`__namedParameters`): [`PaginationInfo`](../interfaces/PaginationInfo.md) \| `undefined`
+
+## Parameters
+
+• **\_\_namedParameters**: [`PaginationInfoBuilderParams`](../interfaces/PaginationInfoBuilderParams.md)
+
+## Returns
+
+[`PaginationInfo`](../interfaces/PaginationInfo.md) \| `undefined`
+
+## Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:57

package/functions/getPagesByRecords.md

@@ -0,0 +1,25 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / getPagesByRecords
+
+# Function: getPagesByRecords()
+
+> **getPagesByRecords**(`records`, `offset`, `limit`): [`Record`](../interfaces/Record.md)[]
+
+## Parameters
+
+• **records**: [`Record`](../interfaces/Record.md)[]
+
+• **offset**: `number`= `0`
+
+• **limit**: `number`= `0`
+
+## Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+## Source
+
+src/dataunit/loader/utils/dataUnitLoaderUtils.ts:51

package/globals.md

@@ -16,6 +16,7 @@
 - [DependencyType](enumerations/DependencyType.md)
 - [LockManagerOperation](enumerations/LockManagerOperation.md)
 - [OverflowDirection](enumerations/OverflowDirection.md)
+- [RECORD\_DATE\_FORMAT](enumerations/RECORD_DATE_FORMAT.md)
 - [SelectionMode](enumerations/SelectionMode.md)
 - [SortMode](enumerations/SortMode.md)
 - [StorageType](enumerations/StorageType.md)
@@ -27,8 +28,10 @@
 - [ArrayUtils](classes/ArrayUtils.md)
 - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
 - [Change](classes/Change.md)
+- [ColumnFilterManager](classes/ColumnFilterManager.md)
 - [DataUnit](classes/DataUnit.md)
 - [DataUnitAction](classes/DataUnitAction.md)
+- [DataUnitInMemoryLoader](classes/DataUnitInMemoryLoader.md)
 - [DataUnitStorage](classes/DataUnitStorage.md)
 - [DateUtils](classes/DateUtils.md)
 - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -68,6 +71,7 @@
 - [ChildDescriptor](interfaces/ChildDescriptor.md)
 - [ChildLink](interfaces/ChildLink.md)
 - [DUActionInterceptor](interfaces/DUActionInterceptor.md)
+- [DataUnitInMemoryLoaderConfig](interfaces/DataUnitInMemoryLoaderConfig.md)
 - [ExecutionContext](interfaces/ExecutionContext.md)
 - [FieldDescriptor](interfaces/FieldDescriptor.md)
 - [Filter](interfaces/Filter.md)
@@ -80,6 +84,7 @@
 - [OverFlowWatcherParams](interfaces/OverFlowWatcherParams.md)
 - [PageRequest](interfaces/PageRequest.md)
 - [PaginationInfo](interfaces/PaginationInfo.md)
+- [PaginationInfoBuilderParams](interfaces/PaginationInfoBuilderParams.md)
 - [PromiseSyncCallback](interfaces/PromiseSyncCallback.md)
 - [QuickFilter](interfaces/QuickFilter.md)
 - [Record](interfaces/Record.md)
@@ -100,4 +105,9 @@
 
 ## Functions
 
+- [applyFilter](functions/applyFilter.md)
+- [applySorting](functions/applySorting.md)
+- [buildLoadDataResponse](functions/buildLoadDataResponse.md)
+- [buildPaginationInfo](functions/buildPaginationInfo.md)
 - [defaultDataLoader](functions/defaultDataLoader.md)
+- [getPagesByRecords](functions/getPagesByRecords.md)

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1919
+src/dataunit/DataUnit.ts:1936

package/interfaces/DataUnitInMemoryLoaderConfig.md

@@ -0,0 +1,37 @@
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / DataUnitInMemoryLoaderConfig
+
+# Interface: DataUnitInMemoryLoaderConfig
+
+## Properties
+
+### autoLoad?
+
+> `optional` **autoLoad**: `boolean`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:2
+
+***
+
+### pageSize?
+
+> `optional` **pageSize**: `number`
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:3
+
+***
+
+### recordDateFormat?
+
+> `optional` **recordDateFormat**: [`RECORD_DATE_FORMAT`](../enumerations/RECORD_DATE_FORMAT.md)
+
+#### Source
+
+src/dataunit/loader/DataUnitInMemoryLoaderConfig.ts:4