npm - @sankhyalabs/core-docs - Versions diffs - 0.0.0-feat-dev-KB-83113.2 → 0.0.0-feat-dev-KB-69274.1 - Mend

@sankhyalabs/core-docs 0.0.0-feat-dev-KB-83113.2 → 0.0.0-feat-dev-KB-69274.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/classes/FieldComparator.md +2 -2
package/enumerations/UserInterface.md +15 -5
package/globals.md +0 -6
package/package.json +1 -1
package/classes/ColumnFilterManager.md +0 -145
package/classes/DataUnitInMemoryLoader.md +0 -303
package/classes/DataUnitLoaderUtils.md +0 -151
package/enumerations/RECORD_DATE_FORMAT.md +0 -27
package/interfaces/DataUnitInMemoryLoaderConfig.md +0 -37
package/interfaces/PaginationInfoBuilderParams.md +0 -37

package/classes/FieldComparator.md CHANGED Viewed

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

package/enumerations/UserInterface.md CHANGED Viewed

@@ -74,7 +74,7 @@ src/dataunit/metadata/UnitMetadata.ts:82
 #### Source
-src/dataunit/metadata/UnitMetadata.ts:98
+src/dataunit/metadata/UnitMetadata.ts:99
 ***
@@ -104,7 +104,7 @@ src/dataunit/metadata/UnitMetadata.ts:92
 #### Source
-src/dataunit/metadata/UnitMetadata.ts:97
+src/dataunit/metadata/UnitMetadata.ts:98
 ***
@@ -114,7 +114,7 @@ src/dataunit/metadata/UnitMetadata.ts:97
 #### Source
-src/dataunit/metadata/UnitMetadata.ts:96
+src/dataunit/metadata/UnitMetadata.ts:97
 ***
@@ -134,7 +134,7 @@ src/dataunit/metadata/UnitMetadata.ts:90
 #### Source
-src/dataunit/metadata/UnitMetadata.ts:95
+src/dataunit/metadata/UnitMetadata.ts:96
 ***
@@ -148,13 +148,23 @@ src/dataunit/metadata/UnitMetadata.ts:93
 ***
+### SEARCHPLUS
+> **SEARCHPLUS**: `"SEARCHPLUS"`
+#### Source
+src/dataunit/metadata/UnitMetadata.ts:94
+***
 ### SHORTTEXT
 > **SHORTTEXT**: `"SHORTTEXT"`
 #### Source
-src/dataunit/metadata/UnitMetadata.ts:94
+src/dataunit/metadata/UnitMetadata.ts:95
 ***

package/globals.md CHANGED Viewed

@@ -16,7 +16,6 @@
 - [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)
@@ -28,11 +27,8 @@
 - [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)
-- [DataUnitLoaderUtils](classes/DataUnitLoaderUtils.md)
 - [DataUnitStorage](classes/DataUnitStorage.md)
 - [DateUtils](classes/DateUtils.md)
 - [ElementIDUtils](classes/ElementIDUtils.md)
@@ -72,7 +68,6 @@
 - [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)
@@ -85,7 +80,6 @@
 - [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)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "0.0.0-feat-dev-KB-83113.2",
+    "version": "0.0.0-feat-dev-KB-69274.1",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [

package/classes/ColumnFilterManager.md DELETED Viewed

@@ -1,145 +0,0 @@
-[**@sankhyalabs/core**](../README.md) • **Docs**
-***
-[@sankhyalabs/core](../globals.md) / ColumnFilterManager
-# Class: ColumnFilterManager
-## Constructors
-### new ColumnFilterManager()
-> **new ColumnFilterManager**(): [`ColumnFilterManager`](ColumnFilterManager.md)
-#### Returns
-[`ColumnFilterManager`](ColumnFilterManager.md)
-## Methods
-### compileDistinct()
-> `static` **compileDistinct**(`fieldName`, `dataUnit`): `IMultiSelectionOption`[]
-#### Parameters
-• **fieldName**: `string`
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-#### Returns
-`IMultiSelectionOption`[]
-#### Source
-src/utils/ColumnFilterManager.ts:59
-***
-### compileDistinctFromArray()
-> `static` **compileDistinctFromArray**(`fieldName`, `dataUnit`, `records`): `IMultiSelectionOption`[]
-#### Parameters
-• **fieldName**: `string`
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **records**: [`Record`](../interfaces/Record.md)[]
-#### Returns
-`IMultiSelectionOption`[]
-#### Source
-src/utils/ColumnFilterManager.ts:65
-***
-### doCompileDistinct()
-> `static` `private` **doCompileDistinct**(`request`, `fieldName`, `dataUnit`, `list`): `IMultiSelectionOption`[]
-#### Parameters
-• **request**: `undefined` \| [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
-• **fieldName**: `string`
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **list**: [`Record`](../interfaces/Record.md)[]
-#### Returns
-`IMultiSelectionOption`[]
-#### Source
-src/utils/ColumnFilterManager.ts:70
-***
-### getColumnFilters()
-> `static` **getColumnFilters**(`filters`, `fieldName`): `Map`\<`string`, `IColumnFilter`\>
-#### Parameters
-• **filters**: [`Filter`](../interfaces/Filter.md)[]
-• **fieldName**: `string`
-#### Returns
-`Map`\<`string`, `IColumnFilter`\>
-#### Source
-src/utils/ColumnFilterManager.ts:10
-***
-### getFilterFunction()
-> `static` **getFilterFunction**(`dataUnit`, `filters`?): `undefined` \| (`record`) => `boolean`
-#### Parameters
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **filters?**: `IColumnFilter`[]
-#### Returns
-`undefined` \| (`record`) => `boolean`
-#### Source
-src/utils/ColumnFilterManager.ts:29
-***
-### recordMatchesFilter()
-> `static` `private` **recordMatchesFilter**(`dataUnit`, `record`, `columnFilter`): `boolean`
-#### Parameters
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **record**: [`Record`](../interfaces/Record.md)
-• **columnFilter**: `IColumnFilter`
-#### Returns
-`boolean`
-#### Source
-src/utils/ColumnFilterManager.ts:42

package/classes/DataUnitInMemoryLoader.md DELETED Viewed

@@ -1,303 +0,0 @@
-[**@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:26
-## 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
-***
-### DEFAULT\_PAGE\_SIZE
-> `static` `readonly` **DEFAULT\_PAGE\_SIZE**: `150` = `150`
-#### Source
-src/dataunit/loader/dataUnitInMemoryLoader.ts:24
-***
-### 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:58
-***
-### 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:122
-***
-### 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:62
-## 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:92
-***
-### 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:98
-***
-### generateUniqueId()
-> `private` **generateUniqueId**(): `string`
-#### Returns
-`string`
-#### Source
-src/dataunit/loader/dataUnitInMemoryLoader.ts:134
-***
-### getRecordsToLoad()
-> `private` **getRecordsToLoad**(): [`Record`](../interfaces/Record.md)[]
-#### Returns
-[`Record`](../interfaces/Record.md)[]
-#### Source
-src/dataunit/loader/dataUnitInMemoryLoader.ts:46
-***
-### 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:138
-***
-### metadaLoader()
-> `private` **metadaLoader**(): `Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
-#### Returns
-`Promise`\<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
-#### Source
-src/dataunit/loader/dataUnitInMemoryLoader.ts:142
-***
-### removeLoader()
-> **removeLoader**(`_dataUnit`, `recordIds`): `Promise`\<`string`[]\>
-#### Parameters
-• **\_dataUnit**: [`DataUnit`](DataUnit.md)
-• **recordIds**: `string`[]
-#### Returns
-`Promise`\<`string`[]\>
-#### Source
-src/dataunit/loader/dataUnitInMemoryLoader.ts:173
-***
-### 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:146
-***
-### 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:77

package/classes/DataUnitLoaderUtils.md DELETED Viewed

@@ -1,151 +0,0 @@
-[**@sankhyalabs/core**](../README.md) • **Docs**
-***
-[@sankhyalabs/core](../globals.md) / DataUnitLoaderUtils
-# Class: DataUnitLoaderUtils
-## Constructors
-### new DataUnitLoaderUtils()
-> **new DataUnitLoaderUtils**(): [`DataUnitLoaderUtils`](DataUnitLoaderUtils.md)
-#### Returns
-[`DataUnitLoaderUtils`](DataUnitLoaderUtils.md)
-## Methods
-### applyFilter()
-> `static` **applyFilter**(`records`, `dataUnit`, `filters`): [`Record`](../interfaces/Record.md)[]
-#### Parameters
-• **records**: [`Record`](../interfaces/Record.md)[]
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **filters**: [`Filter`](../interfaces/Filter.md)[]
-#### Returns
-[`Record`](../interfaces/Record.md)[]
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:11
-***
-### applySorting()
-> `static` **applySorting**(`records`, `dataUnit`, `sorting`): [`Record`](../interfaces/Record.md)[]
-#### Parameters
-• **records**: [`Record`](../interfaces/Record.md)[]
-• **dataUnit**: [`DataUnit`](DataUnit.md)
-• **sorting**: [`Sort`](../interfaces/Sort.md)[]
-#### Returns
-[`Record`](../interfaces/Record.md)[]
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:40
-***
-### buildLoadDataResponse()
-> `static` **buildLoadDataResponse**(`recordsIn`, `dataUnit`, `request`): `Promise`\<`object`\>
-#### Parameters
-• **recordsIn**: [`Record`](../interfaces/Record.md)[]
-• **dataUnit**: [`DataUnit`](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:20
-***
-### buildPaginationInfo()
-> `static` **buildPaginationInfo**(`__namedParameters`): `undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
-#### Parameters
-• **\_\_namedParameters**: [`PaginationInfoBuilderParams`](../interfaces/PaginationInfoBuilderParams.md)
-#### Returns
-`undefined` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:61
-***
-### getPagesByRecords()
-> `static` **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
-***
-### hasValidLimitAndOffset()
-> `static` `private` **hasValidLimitAndOffset**(`offset`, `limit`): `boolean`
-#### Parameters
-• **offset**: `number`
-• **limit**: `number`
-#### Returns
-`boolean`
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:57

package/enumerations/RECORD_DATE_FORMAT.md DELETED Viewed

@@ -1,27 +0,0 @@
-[**@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/interfaces/DataUnitInMemoryLoaderConfig.md DELETED Viewed

@@ -1,37 +0,0 @@
-[**@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

package/interfaces/PaginationInfoBuilderParams.md DELETED Viewed

@@ -1,37 +0,0 @@
-[**@sankhyalabs/core**](../README.md) • **Docs**
-***
-[@sankhyalabs/core](../globals.md) / PaginationInfoBuilderParams
-# Interface: PaginationInfoBuilderParams
-## Properties
-### offset
-> **offset**: `number`
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:84
-***
-### recordsLength
-> **recordsLength**: `number`
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:83
-***
-### recordsPerPage
-> **recordsPerPage**: `number`
-#### Source
-src/dataunit/loader/utils/dataUnitLoaderUtils.ts:85