@progress/kendo-data-query 1.5.5-dev.202010231217 → 1.5.6
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.
- package/LICENSE.md +1 -1
- package/NOTICE.txt +261 -34
- package/README.md +11 -3
- package/dist/cdn/main.js +1 -1
- package/dist/es/array.operators.js +3 -3
- package/dist/es/filtering/filter-expression.factory.js +4 -4
- package/dist/es/filtering/filter.operators.js +1 -1
- package/dist/es/grouping/aggregate.operators.js +3 -3
- package/dist/es/grouping/group.operators.js +1 -1
- package/dist/es/mvc/operators.js +4 -4
- package/dist/es/odata.operators.js +1 -1
- package/dist/es/sorting/sort-array.operator.js +2 -2
- package/dist/es2015/array.operators.js +3 -3
- package/dist/es2015/filtering/filter-expression.factory.js +4 -4
- package/dist/es2015/filtering/filter.operators.js +1 -1
- package/dist/es2015/grouping/aggregate.operators.js +3 -3
- package/dist/es2015/grouping/group.operators.js +1 -1
- package/dist/es2015/mvc/operators.js +4 -4
- package/dist/es2015/odata.operators.js +1 -1
- package/dist/es2015/sorting/sort-array.operator.js +2 -2
- package/dist/npm/array.operators.d.ts +3 -3
- package/dist/npm/array.operators.js +3 -3
- package/dist/npm/common.interfaces.d.ts +1 -1
- package/dist/npm/data-result.interface.d.ts +1 -1
- package/dist/npm/filtering/filter-descriptor.interface.d.ts +4 -4
- package/dist/npm/filtering/filter-expression.factory.d.ts +4 -4
- package/dist/npm/filtering/filter-expression.factory.js +4 -4
- package/dist/npm/filtering/filter.operators.d.ts +1 -1
- package/dist/npm/filtering/filter.operators.js +1 -1
- package/dist/npm/grouping/aggregate.operators.d.ts +4 -4
- package/dist/npm/grouping/aggregate.operators.js +3 -3
- package/dist/npm/grouping/group-descriptor.interface.d.ts +1 -1
- package/dist/npm/grouping/group.operators.d.ts +1 -1
- package/dist/npm/grouping/group.operators.js +1 -1
- package/dist/npm/mvc/deserialization.d.ts +1 -1
- package/dist/npm/mvc/operators.d.ts +6 -6
- package/dist/npm/mvc/operators.js +4 -4
- package/dist/npm/odata.operators.d.ts +1 -1
- package/dist/npm/odata.operators.js +1 -1
- package/dist/npm/sorting/sort-array.operator.d.ts +4 -4
- package/dist/npm/sorting/sort-array.operator.js +2 -2
- package/dist/npm/transducers.d.ts +1 -1
- package/dist/systemjs/kendo-data-query.js +1 -1
- package/package.json +3 -3
|
@@ -22,7 +22,7 @@ var rules = function (settings, state) { return function (key) { return ({
|
|
|
22
22
|
}[key]); }; };
|
|
23
23
|
// tslint:enable:max-line-length
|
|
24
24
|
/**
|
|
25
|
-
* Converts a [
|
|
25
|
+
* Converts a [State]({% slug api_kendo-data-query_state %}) into an OData v4 compatible string.
|
|
26
26
|
*
|
|
27
27
|
* @param {State} state - The state that will be serialized.
|
|
28
28
|
* @param {ODataSettings} settings - The settings that are used during the serialization.
|
|
@@ -20,12 +20,12 @@ var descriptorAsFunc = function (descriptor) {
|
|
|
20
20
|
var initial = function (_a, _b) { return 0; };
|
|
21
21
|
// tslint:disable:max-line-length
|
|
22
22
|
/**
|
|
23
|
-
* Converts the `SortDescriptors` into a [
|
|
23
|
+
* Converts the `SortDescriptors` into a [Comparer]({% slug api_kendo-data-query_comparer %}) function that can be used through `Array.sort`. If multiple descriptors are provided, sorting is applied in a right-to-left order.
|
|
24
24
|
* @param {SortDescriptor[]} descriptors - The descriptors which will be converted.
|
|
25
25
|
* @returns {Comparer} - The produced function.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
|
-
* ```ts
|
|
28
|
+
* ```ts
|
|
29
29
|
* import { composeSortDescriptors } from '@progress/kendo-data-query';
|
|
30
30
|
*
|
|
31
31
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -15,7 +15,7 @@ import { sort } from './sorting/sort';
|
|
|
15
15
|
* @returns {T[]} - The sorted data.
|
|
16
16
|
*
|
|
17
17
|
* @example
|
|
18
|
-
* ```ts
|
|
18
|
+
* ```ts
|
|
19
19
|
* import { orderBy } from '@progress/kendo-data-query';
|
|
20
20
|
*
|
|
21
21
|
* const data = [
|
|
@@ -52,7 +52,7 @@ const _distinct = (data, comparer) => data.filter((x, idx, xs) => xs.findIndex(c
|
|
|
52
52
|
* @returns {T[]} - The reduced data.
|
|
53
53
|
*
|
|
54
54
|
* @example
|
|
55
|
-
* ```ts
|
|
55
|
+
* ```ts
|
|
56
56
|
* import { distinct } from '@progress/kendo-data-query';
|
|
57
57
|
*
|
|
58
58
|
* const data = [
|
|
@@ -100,7 +100,7 @@ export const limit = (data, predicate) => {
|
|
|
100
100
|
* @returns {DataResult} - The processed data.
|
|
101
101
|
*
|
|
102
102
|
* @example
|
|
103
|
-
* ```ts
|
|
103
|
+
* ```ts
|
|
104
104
|
*
|
|
105
105
|
* const result = process(data, {
|
|
106
106
|
* skip: 10,
|
|
@@ -4,13 +4,13 @@ import { normalizeFilters } from './filter.operators';
|
|
|
4
4
|
import { transformCompositeFilter } from "./filter-no-eval";
|
|
5
5
|
// tslint:disable:max-line-length
|
|
6
6
|
/**
|
|
7
|
-
* Creates a [
|
|
7
|
+
* Creates a [Predicate]({% slug api_kendo-data-query_predicate %}) function for the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
8
8
|
*
|
|
9
9
|
* @param {CompositeFilterDescriptor} descriptor - The descriptor for which the predicate is created.
|
|
10
10
|
* @returns {Predicate} - The created function instance.
|
|
11
11
|
*
|
|
12
12
|
* @example
|
|
13
|
-
* ```ts
|
|
13
|
+
* ```ts
|
|
14
14
|
* import { compileFilter } from '@progress/kendo-data-query';
|
|
15
15
|
*
|
|
16
16
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -28,14 +28,14 @@ export const compileFilter = (descriptor) => {
|
|
|
28
28
|
};
|
|
29
29
|
// tslint:disable:max-line-length
|
|
30
30
|
/**
|
|
31
|
-
* Filters the provided array according to the specified [
|
|
31
|
+
* Filters the provided array according to the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
32
32
|
*
|
|
33
33
|
* @param {T[]} data - The data that will be filtered.
|
|
34
34
|
* @param {(CompositeFilterDescriptor | FilterDescriptor)} descriptor - The filter criteria that will be applied.
|
|
35
35
|
* @returns {T[]} - The filtered data.
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
38
|
-
* ```ts
|
|
38
|
+
* ```ts
|
|
39
39
|
* import { filterBy } from '@progress/kendo-data-query';
|
|
40
40
|
*
|
|
41
41
|
* const data = [
|
|
@@ -58,7 +58,7 @@ const normalizeDescriptor = (descriptor) => {
|
|
|
58
58
|
};
|
|
59
59
|
// tslint:disable:max-line-length
|
|
60
60
|
/**
|
|
61
|
-
* Converts a [
|
|
61
|
+
* Converts a [FilterDescriptor]({% slug api_kendo-data-query_filterdescriptor %}) into a [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}). If a `CompositeFilterDescriptor` is passed, no modifications will be made.
|
|
62
62
|
*
|
|
63
63
|
* @param {CompositeFilterDescriptor | FilterDescriptor} descriptor - The descriptor that will be normalized.
|
|
64
64
|
* @returns {CompositeFilterDescriptor} - The normalized descriptor.
|
|
@@ -2,10 +2,10 @@ import { exec, map, aggregatesCombinator, expandAggregates } from '../transducer
|
|
|
2
2
|
const identity = map(x => x);
|
|
3
3
|
// tslint:disable:max-line-length
|
|
4
4
|
/**
|
|
5
|
-
* Applies the specified [
|
|
5
|
+
* Applies the specified [AggregateDescriptors]({% slug api_kendo-data-query_aggregatedescriptor %}) to the data. Returns an [AggregateResult]({% slug api_kendo-data-query_aggregateresult %}) instance.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
|
-
* ```ts
|
|
8
|
+
* ```ts
|
|
9
9
|
* const data = [
|
|
10
10
|
* { unitPrice: 23, unitsInStock: 21 },
|
|
11
11
|
* { unitPrice: 10, unitsInStock: 12 },
|
|
@@ -27,7 +27,7 @@ const identity = map(x => x);
|
|
|
27
27
|
* @param {AggregateDescriptor[]} descriptors - The aggregate operations that will be executed.
|
|
28
28
|
* @param {any} transformers - For internal use.
|
|
29
29
|
* @returns {AggregateResult} - The aggregated result.
|
|
30
|
-
* For more information, refer to the [
|
|
30
|
+
* For more information, refer to the [aggregateresult]({% slug api_kendo-data-query_aggregateresult %}) configuration.
|
|
31
31
|
*/
|
|
32
32
|
// tslint:enable:max-line-length
|
|
33
33
|
export const aggregateBy = (data, descriptors = [], transformers = identity) => {
|
|
@@ -72,7 +72,7 @@ const rules = (state, encode = true) => key => ({
|
|
|
72
72
|
"take": serializePageSize(state)
|
|
73
73
|
}[key]);
|
|
74
74
|
/**
|
|
75
|
-
* Converts a [
|
|
75
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into a string
|
|
76
76
|
* that is comparable with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
77
77
|
*
|
|
78
78
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -80,7 +80,7 @@ const rules = (state, encode = true) => key => ({
|
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* {% platform_content angular %}
|
|
83
|
-
* ```ts
|
|
83
|
+
* ```ts
|
|
84
84
|
* import {
|
|
85
85
|
* toDataSourceRequestString,
|
|
86
86
|
* translateDataSourceResultGroups,
|
|
@@ -116,7 +116,7 @@ const rules = (state, encode = true) => key => ({
|
|
|
116
116
|
* {% endplatform_content %}
|
|
117
117
|
*
|
|
118
118
|
* {% platform_content react %}
|
|
119
|
-
* ```jsx
|
|
119
|
+
* ```jsx
|
|
120
120
|
* import React from 'react';
|
|
121
121
|
* import { toDataSourceRequestString, translateDataSourceResultGroups } from '@progress/kendo-data-query';
|
|
122
122
|
*
|
|
@@ -180,7 +180,7 @@ export const toDataSourceRequestString = (state) => (toQueryString(Object.keys(s
|
|
|
180
180
|
.map(rules(state))
|
|
181
181
|
.filter(isPresent)).join('&'));
|
|
182
182
|
/**
|
|
183
|
-
* Converts a [
|
|
183
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into an object
|
|
184
184
|
* that is compatible with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
185
185
|
*
|
|
186
186
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -21,7 +21,7 @@ const rules = (settings, state) => (key) => ({
|
|
|
21
21
|
}[key]);
|
|
22
22
|
// tslint:enable:max-line-length
|
|
23
23
|
/**
|
|
24
|
-
* Converts a [
|
|
24
|
+
* Converts a [State]({% slug api_kendo-data-query_state %}) into an OData v4 compatible string.
|
|
25
25
|
*
|
|
26
26
|
* @param {State} state - The state that will be serialized.
|
|
27
27
|
* @param {ODataSettings} settings - The settings that are used during the serialization.
|
|
@@ -20,12 +20,12 @@ const descriptorAsFunc = (descriptor) => {
|
|
|
20
20
|
const initial = (_a, _b) => 0;
|
|
21
21
|
// tslint:disable:max-line-length
|
|
22
22
|
/**
|
|
23
|
-
* Converts the `SortDescriptors` into a [
|
|
23
|
+
* Converts the `SortDescriptors` into a [Comparer]({% slug api_kendo-data-query_comparer %}) function that can be used through `Array.sort`. If multiple descriptors are provided, sorting is applied in a right-to-left order.
|
|
24
24
|
* @param {SortDescriptor[]} descriptors - The descriptors which will be converted.
|
|
25
25
|
* @returns {Comparer} - The produced function.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
|
-
* ```ts
|
|
28
|
+
* ```ts
|
|
29
29
|
* import { composeSortDescriptors } from '@progress/kendo-data-query';
|
|
30
30
|
*
|
|
31
31
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -10,7 +10,7 @@ import { Predicate } from './common.interfaces';
|
|
|
10
10
|
* @returns {T[]} - The sorted data.
|
|
11
11
|
*
|
|
12
12
|
* @example
|
|
13
|
-
* ```ts
|
|
13
|
+
* ```ts
|
|
14
14
|
* import { orderBy } from '@progress/kendo-data-query';
|
|
15
15
|
*
|
|
16
16
|
* const data = [
|
|
@@ -32,7 +32,7 @@ declare type Comparer = <T>(a: T, b: T) => boolean;
|
|
|
32
32
|
* @returns {T[]} - The reduced data.
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
|
-
* ```ts
|
|
35
|
+
* ```ts
|
|
36
36
|
* import { distinct } from '@progress/kendo-data-query';
|
|
37
37
|
*
|
|
38
38
|
* const data = [
|
|
@@ -67,7 +67,7 @@ export declare const limit: <T>(data: T[], predicate: Predicate) => T[];
|
|
|
67
67
|
* @returns {DataResult} - The processed data.
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* ```ts
|
|
70
|
+
* ```ts
|
|
71
71
|
*
|
|
72
72
|
* const result = process(data, {
|
|
73
73
|
* skip: 10,
|
|
@@ -17,7 +17,7 @@ var sort_1 = require("./sorting/sort");
|
|
|
17
17
|
* @returns {T[]} - The sorted data.
|
|
18
18
|
*
|
|
19
19
|
* @example
|
|
20
|
-
* ```ts
|
|
20
|
+
* ```ts
|
|
21
21
|
* import { orderBy } from '@progress/kendo-data-query';
|
|
22
22
|
*
|
|
23
23
|
* const data = [
|
|
@@ -56,7 +56,7 @@ var _distinct = function (data, comparer) {
|
|
|
56
56
|
* @returns {T[]} - The reduced data.
|
|
57
57
|
*
|
|
58
58
|
* @example
|
|
59
|
-
* ```ts
|
|
59
|
+
* ```ts
|
|
60
60
|
* import { distinct } from '@progress/kendo-data-query';
|
|
61
61
|
*
|
|
62
62
|
* const data = [
|
|
@@ -107,7 +107,7 @@ exports.limit = function (data, predicate) {
|
|
|
107
107
|
* @returns {DataResult} - The processed data.
|
|
108
108
|
*
|
|
109
109
|
* @example
|
|
110
|
-
* ```ts
|
|
110
|
+
* ```ts
|
|
111
111
|
*
|
|
112
112
|
* const result = process(data, {
|
|
113
113
|
* skip: 10,
|
|
@@ -21,7 +21,7 @@ export declare type Transformer = <T, U>(acc: U, curr: T, index: number) => U |
|
|
|
21
21
|
* A type which represents a function that returns a Boolean value.
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
|
-
* ```ts
|
|
24
|
+
* ```ts
|
|
25
25
|
* const isGreaterThanTen: Predicate = (num: number) => num > 10;
|
|
26
26
|
* isGreaterThanTen(2); // false
|
|
27
27
|
* isGreaterThanTen(20); // true
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A basic filter expression. Usually is a part of [
|
|
2
|
+
* A basic filter expression. Usually is a part of [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
3
3
|
*
|
|
4
|
-
* For more information on filtering the provided data array, refer to the [
|
|
4
|
+
* For more information on filtering the provided data array, refer to the [filterBy]({% slug api_kendo-data-query_filterby %}) method.
|
|
5
5
|
* For examples on using the `FilterDescriptor`, refer to the [documentation on filtering the Grid]({% slug filtering_grid %}).
|
|
6
6
|
*/
|
|
7
7
|
export interface FilterDescriptor {
|
|
@@ -41,7 +41,7 @@ export interface FilterDescriptor {
|
|
|
41
41
|
ignoreCase?: boolean;
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
|
-
* A complex filter expression. For more information, refer to the [
|
|
44
|
+
* A complex filter expression. For more information, refer to the [filterBy]({% slug api_kendo-data-query_filterby %}) method.
|
|
45
45
|
*/
|
|
46
46
|
export interface CompositeFilterDescriptor {
|
|
47
47
|
/**
|
|
@@ -53,7 +53,7 @@ export interface CompositeFilterDescriptor {
|
|
|
53
53
|
*/
|
|
54
54
|
logic: 'or' | 'and';
|
|
55
55
|
/**
|
|
56
|
-
* The nested filter expressions—either [
|
|
56
|
+
* The nested filter expressions—either [FilterDescriptor]({% slug api_kendo-data-query_filterdescriptor %}), or [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}). Supports the same options as `filter`. You can nest filters indefinitely.
|
|
57
57
|
*/
|
|
58
58
|
filters: Array<FilterDescriptor | CompositeFilterDescriptor>;
|
|
59
59
|
}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { CompositeFilterDescriptor, FilterDescriptor } from './filter-descriptor.interface';
|
|
2
2
|
import { Predicate } from '../common.interfaces';
|
|
3
3
|
/**
|
|
4
|
-
* Creates a [
|
|
4
|
+
* Creates a [Predicate]({% slug api_kendo-data-query_predicate %}) function for the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
5
5
|
*
|
|
6
6
|
* @param {CompositeFilterDescriptor} descriptor - The descriptor for which the predicate is created.
|
|
7
7
|
* @returns {Predicate} - The created function instance.
|
|
8
8
|
*
|
|
9
9
|
* @example
|
|
10
|
-
* ```ts
|
|
10
|
+
* ```ts
|
|
11
11
|
* import { compileFilter } from '@progress/kendo-data-query';
|
|
12
12
|
*
|
|
13
13
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -18,14 +18,14 @@ import { Predicate } from '../common.interfaces';
|
|
|
18
18
|
*/
|
|
19
19
|
export declare const compileFilter: (descriptor: CompositeFilterDescriptor) => Predicate;
|
|
20
20
|
/**
|
|
21
|
-
* Filters the provided array according to the specified [
|
|
21
|
+
* Filters the provided array according to the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
22
22
|
*
|
|
23
23
|
* @param {T[]} data - The data that will be filtered.
|
|
24
24
|
* @param {(CompositeFilterDescriptor | FilterDescriptor)} descriptor - The filter criteria that will be applied.
|
|
25
25
|
* @returns {T[]} - The filtered data.
|
|
26
26
|
*
|
|
27
27
|
* @example
|
|
28
|
-
* ```ts
|
|
28
|
+
* ```ts
|
|
29
29
|
* import { filterBy } from '@progress/kendo-data-query';
|
|
30
30
|
*
|
|
31
31
|
* const data = [
|
|
@@ -6,13 +6,13 @@ var filter_operators_1 = require("./filter.operators");
|
|
|
6
6
|
var filter_no_eval_1 = require("./filter-no-eval");
|
|
7
7
|
// tslint:disable:max-line-length
|
|
8
8
|
/**
|
|
9
|
-
* Creates a [
|
|
9
|
+
* Creates a [Predicate]({% slug api_kendo-data-query_predicate %}) function for the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
10
10
|
*
|
|
11
11
|
* @param {CompositeFilterDescriptor} descriptor - The descriptor for which the predicate is created.
|
|
12
12
|
* @returns {Predicate} - The created function instance.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
|
-
* ```ts
|
|
15
|
+
* ```ts
|
|
16
16
|
* import { compileFilter } from '@progress/kendo-data-query';
|
|
17
17
|
*
|
|
18
18
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -30,14 +30,14 @@ exports.compileFilter = function (descriptor) {
|
|
|
30
30
|
};
|
|
31
31
|
// tslint:disable:max-line-length
|
|
32
32
|
/**
|
|
33
|
-
* Filters the provided array according to the specified [
|
|
33
|
+
* Filters the provided array according to the specified [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}).
|
|
34
34
|
*
|
|
35
35
|
* @param {T[]} data - The data that will be filtered.
|
|
36
36
|
* @param {(CompositeFilterDescriptor | FilterDescriptor)} descriptor - The filter criteria that will be applied.
|
|
37
37
|
* @returns {T[]} - The filtered data.
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
|
-
* ```ts
|
|
40
|
+
* ```ts
|
|
41
41
|
* import { filterBy } from '@progress/kendo-data-query';
|
|
42
42
|
*
|
|
43
43
|
* const data = [
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CompositeFilterDescriptor, FilterDescriptor } from './filter-descriptor.interface';
|
|
2
2
|
/**
|
|
3
|
-
* Converts a [
|
|
3
|
+
* Converts a [FilterDescriptor]({% slug api_kendo-data-query_filterdescriptor %}) into a [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}). If a `CompositeFilterDescriptor` is passed, no modifications will be made.
|
|
4
4
|
*
|
|
5
5
|
* @param {CompositeFilterDescriptor | FilterDescriptor} descriptor - The descriptor that will be normalized.
|
|
6
6
|
* @returns {CompositeFilterDescriptor} - The normalized descriptor.
|
|
@@ -60,7 +60,7 @@ var normalizeDescriptor = function (descriptor) {
|
|
|
60
60
|
};
|
|
61
61
|
// tslint:disable:max-line-length
|
|
62
62
|
/**
|
|
63
|
-
* Converts a [
|
|
63
|
+
* Converts a [FilterDescriptor]({% slug api_kendo-data-query_filterdescriptor %}) into a [CompositeFilterDescriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}). If a `CompositeFilterDescriptor` is passed, no modifications will be made.
|
|
64
64
|
*
|
|
65
65
|
* @param {CompositeFilterDescriptor | FilterDescriptor} descriptor - The descriptor that will be normalized.
|
|
66
66
|
* @returns {CompositeFilterDescriptor} - The normalized descriptor.
|
|
@@ -3,7 +3,7 @@ import { Combinator, Transformer } from '../common.interfaces';
|
|
|
3
3
|
/**
|
|
4
4
|
* The aggregate operation.
|
|
5
5
|
*
|
|
6
|
-
* For more information, refer to the [
|
|
6
|
+
* For more information, refer to the [aggregateBy]({% slug api_kendo-data-query_aggregateby %}) method.
|
|
7
7
|
*/
|
|
8
8
|
export interface AggregateDescriptor {
|
|
9
9
|
/**
|
|
@@ -16,10 +16,10 @@ export interface AggregateDescriptor {
|
|
|
16
16
|
aggregate: 'count' | 'sum' | 'average' | 'min' | 'max';
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* Applies the specified [
|
|
19
|
+
* Applies the specified [AggregateDescriptors]({% slug api_kendo-data-query_aggregatedescriptor %}) to the data. Returns an [AggregateResult]({% slug api_kendo-data-query_aggregateresult %}) instance.
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
22
|
-
* ```ts
|
|
22
|
+
* ```ts
|
|
23
23
|
* const data = [
|
|
24
24
|
* { unitPrice: 23, unitsInStock: 21 },
|
|
25
25
|
* { unitPrice: 10, unitsInStock: 12 },
|
|
@@ -41,6 +41,6 @@ export interface AggregateDescriptor {
|
|
|
41
41
|
* @param {AggregateDescriptor[]} descriptors - The aggregate operations that will be executed.
|
|
42
42
|
* @param {any} transformers - For internal use.
|
|
43
43
|
* @returns {AggregateResult} - The aggregated result.
|
|
44
|
-
* For more information, refer to the [
|
|
44
|
+
* For more information, refer to the [aggregateresult]({% slug api_kendo-data-query_aggregateresult %}) configuration.
|
|
45
45
|
*/
|
|
46
46
|
export declare const aggregateBy: <T>(data: T[], descriptors?: AggregateDescriptor[], transformers?: (reduce: Combinator) => Transformer) => AggregateResult;
|
|
@@ -4,10 +4,10 @@ var transducers_1 = require("../transducers");
|
|
|
4
4
|
var identity = transducers_1.map(function (x) { return x; });
|
|
5
5
|
// tslint:disable:max-line-length
|
|
6
6
|
/**
|
|
7
|
-
* Applies the specified [
|
|
7
|
+
* Applies the specified [AggregateDescriptors]({% slug api_kendo-data-query_aggregatedescriptor %}) to the data. Returns an [AggregateResult]({% slug api_kendo-data-query_aggregateresult %}) instance.
|
|
8
8
|
*
|
|
9
9
|
* @example
|
|
10
|
-
* ```ts
|
|
10
|
+
* ```ts
|
|
11
11
|
* const data = [
|
|
12
12
|
* { unitPrice: 23, unitsInStock: 21 },
|
|
13
13
|
* { unitPrice: 10, unitsInStock: 12 },
|
|
@@ -29,7 +29,7 @@ var identity = transducers_1.map(function (x) { return x; });
|
|
|
29
29
|
* @param {AggregateDescriptor[]} descriptors - The aggregate operations that will be executed.
|
|
30
30
|
* @param {any} transformers - For internal use.
|
|
31
31
|
* @returns {AggregateResult} - The aggregated result.
|
|
32
|
-
* For more information, refer to the [
|
|
32
|
+
* For more information, refer to the [aggregateresult]({% slug api_kendo-data-query_aggregateresult %}) configuration.
|
|
33
33
|
*/
|
|
34
34
|
// tslint:enable:max-line-length
|
|
35
35
|
exports.aggregateBy = function (data, descriptors, transformers) {
|
|
@@ -26,7 +26,7 @@ export interface GroupResult {
|
|
|
26
26
|
*/
|
|
27
27
|
items: Object[];
|
|
28
28
|
/**
|
|
29
|
-
* The aggregated values for the group. An [
|
|
29
|
+
* The aggregated values for the group. An [AggregateResult]({% slug api_kendo-data-query_aggregateresult %}) instance.
|
|
30
30
|
*/
|
|
31
31
|
aggregates: AggregateResult;
|
|
32
32
|
/**
|
|
@@ -9,7 +9,7 @@ export declare type ServerGroupResult = {
|
|
|
9
9
|
*/
|
|
10
10
|
Items: Object[];
|
|
11
11
|
/**
|
|
12
|
-
* The aggregated values for the group. An [
|
|
12
|
+
* The aggregated values for the group. An [AggregateResult]({% slug api_kendo-data-query_aggregateresult %}) instance.
|
|
13
13
|
*/
|
|
14
14
|
Aggregates: any;
|
|
15
15
|
/**
|
|
@@ -4,8 +4,8 @@ import { AggregateDescriptor } from '../grouping/aggregate.operators';
|
|
|
4
4
|
* Represents the operation descriptors that will be sent
|
|
5
5
|
* ([see example]({% slug api_kendo-data-query_todatasourcerequeststring %})).
|
|
6
6
|
*
|
|
7
|
-
* Extends [
|
|
8
|
-
* an array of [
|
|
7
|
+
* Extends [State]({% slug api_kendo-data-query_state %}) by adding the `aggregates` descriptors—
|
|
8
|
+
* an array of [AggregateDescriptor]({% slug api_kendo-data-query_aggregatedescriptor %}).
|
|
9
9
|
*/
|
|
10
10
|
export declare type DataSourceRequestState = State & {
|
|
11
11
|
/**
|
|
@@ -15,7 +15,7 @@ export declare type DataSourceRequestState = State & {
|
|
|
15
15
|
aggregates?: Array<AggregateDescriptor>;
|
|
16
16
|
};
|
|
17
17
|
/**
|
|
18
|
-
* Converts a [
|
|
18
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into a string
|
|
19
19
|
* that is comparable with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
20
20
|
*
|
|
21
21
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -23,7 +23,7 @@ export declare type DataSourceRequestState = State & {
|
|
|
23
23
|
*
|
|
24
24
|
* @example
|
|
25
25
|
* {% platform_content angular %}
|
|
26
|
-
* ```ts
|
|
26
|
+
* ```ts
|
|
27
27
|
* import {
|
|
28
28
|
* toDataSourceRequestString,
|
|
29
29
|
* translateDataSourceResultGroups,
|
|
@@ -59,7 +59,7 @@ export declare type DataSourceRequestState = State & {
|
|
|
59
59
|
* {% endplatform_content %}
|
|
60
60
|
*
|
|
61
61
|
* {% platform_content react %}
|
|
62
|
-
* ```jsx
|
|
62
|
+
* ```jsx
|
|
63
63
|
* import React from 'react';
|
|
64
64
|
* import { toDataSourceRequestString, translateDataSourceResultGroups } from '@progress/kendo-data-query';
|
|
65
65
|
*
|
|
@@ -121,7 +121,7 @@ export declare type DataSourceRequestState = State & {
|
|
|
121
121
|
*/
|
|
122
122
|
export declare const toDataSourceRequestString: (state: DataSourceRequestState) => string;
|
|
123
123
|
/**
|
|
124
|
-
* Converts a [
|
|
124
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into an object
|
|
125
125
|
* that is compatible with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
126
126
|
*
|
|
127
127
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -115,7 +115,7 @@ var rules = function (state, encode) {
|
|
|
115
115
|
}[key]); };
|
|
116
116
|
};
|
|
117
117
|
/**
|
|
118
|
-
* Converts a [
|
|
118
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into a string
|
|
119
119
|
* that is comparable with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
120
120
|
*
|
|
121
121
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -123,7 +123,7 @@ var rules = function (state, encode) {
|
|
|
123
123
|
*
|
|
124
124
|
* @example
|
|
125
125
|
* {% platform_content angular %}
|
|
126
|
-
* ```ts
|
|
126
|
+
* ```ts
|
|
127
127
|
* import {
|
|
128
128
|
* toDataSourceRequestString,
|
|
129
129
|
* translateDataSourceResultGroups,
|
|
@@ -159,7 +159,7 @@ var rules = function (state, encode) {
|
|
|
159
159
|
* {% endplatform_content %}
|
|
160
160
|
*
|
|
161
161
|
* {% platform_content react %}
|
|
162
|
-
* ```jsx
|
|
162
|
+
* ```jsx
|
|
163
163
|
* import React from 'react';
|
|
164
164
|
* import { toDataSourceRequestString, translateDataSourceResultGroups } from '@progress/kendo-data-query';
|
|
165
165
|
*
|
|
@@ -223,7 +223,7 @@ exports.toDataSourceRequestString = function (state) { return (toQueryString(Obj
|
|
|
223
223
|
.map(rules(state))
|
|
224
224
|
.filter(utils_1.isPresent)).join('&')); };
|
|
225
225
|
/**
|
|
226
|
-
* Converts a [
|
|
226
|
+
* Converts a [DataSourceRequestState]({% slug api_kendo-data-query_datasourcerequeststate %}) into an object
|
|
227
227
|
* that is compatible with the `DataSourceRequest` format in UI for ASP.NET MVC.
|
|
228
228
|
*
|
|
229
229
|
* @param {DataRequestState} state - The state that will be serialized.
|
|
@@ -9,7 +9,7 @@ export interface ODataSettings {
|
|
|
9
9
|
utcDates?: boolean;
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* Converts a [
|
|
12
|
+
* Converts a [State]({% slug api_kendo-data-query_state %}) into an OData v4 compatible string.
|
|
13
13
|
*
|
|
14
14
|
* @param {State} state - The state that will be serialized.
|
|
15
15
|
* @param {ODataSettings} settings - The settings that are used during the serialization.
|
|
@@ -24,7 +24,7 @@ var rules = function (settings, state) { return function (key) { return ({
|
|
|
24
24
|
}[key]); }; };
|
|
25
25
|
// tslint:enable:max-line-length
|
|
26
26
|
/**
|
|
27
|
-
* Converts a [
|
|
27
|
+
* Converts a [State]({% slug api_kendo-data-query_state %}) into an OData v4 compatible string.
|
|
28
28
|
*
|
|
29
29
|
* @param {State} state - The state that will be serialized.
|
|
30
30
|
* @param {ODataSettings} settings - The settings that are used during the serialization.
|
|
@@ -2,10 +2,10 @@ import { SortDescriptor } from '../sort-descriptor';
|
|
|
2
2
|
/**
|
|
3
3
|
* A type that represents a function which compares two values and returns `1`, `0`, or `-1` (minus one).
|
|
4
4
|
*
|
|
5
|
-
* For more information, refer to the [
|
|
5
|
+
* For more information, refer to the [composeSortDescriptors]({% slug api_kendo-data-query_composesortdescriptors %}) configuration.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
|
-
* ```ts
|
|
8
|
+
* ```ts
|
|
9
9
|
* const isGreaterThan: Comparer = (a, b) => a > b ? 1 : -1;
|
|
10
10
|
* isGreaterThan(42, 42); // 0
|
|
11
11
|
* isGreaterThan(22, 42); // -1
|
|
@@ -14,12 +14,12 @@ import { SortDescriptor } from '../sort-descriptor';
|
|
|
14
14
|
*/
|
|
15
15
|
export declare type Comparer = <T>(a: T, b: T) => number;
|
|
16
16
|
/**
|
|
17
|
-
* Converts the `SortDescriptors` into a [
|
|
17
|
+
* Converts the `SortDescriptors` into a [Comparer]({% slug api_kendo-data-query_comparer %}) function that can be used through `Array.sort`. If multiple descriptors are provided, sorting is applied in a right-to-left order.
|
|
18
18
|
* @param {SortDescriptor[]} descriptors - The descriptors which will be converted.
|
|
19
19
|
* @returns {Comparer} - The produced function.
|
|
20
20
|
*
|
|
21
21
|
* @example
|
|
22
|
-
* ```ts
|
|
22
|
+
* ```ts
|
|
23
23
|
* import { composeSortDescriptors } from '@progress/kendo-data-query';
|
|
24
24
|
*
|
|
25
25
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -22,12 +22,12 @@ var descriptorAsFunc = function (descriptor) {
|
|
|
22
22
|
var initial = function (_a, _b) { return 0; };
|
|
23
23
|
// tslint:disable:max-line-length
|
|
24
24
|
/**
|
|
25
|
-
* Converts the `SortDescriptors` into a [
|
|
25
|
+
* Converts the `SortDescriptors` into a [Comparer]({% slug api_kendo-data-query_comparer %}) function that can be used through `Array.sort`. If multiple descriptors are provided, sorting is applied in a right-to-left order.
|
|
26
26
|
* @param {SortDescriptor[]} descriptors - The descriptors which will be converted.
|
|
27
27
|
* @returns {Comparer} - The produced function.
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
|
-
* ```ts
|
|
30
|
+
* ```ts
|
|
31
31
|
* import { composeSortDescriptors } from '@progress/kendo-data-query';
|
|
32
32
|
*
|
|
33
33
|
* const data = [{ name: "Pork" }, { name: "Pepper" }, { name: "Beef" } ];
|
|
@@ -7,7 +7,7 @@ export declare const groupCombinator: (field: any) => (agg: any, value: any) =>
|
|
|
7
7
|
* The result of the [aggregate operation]({% slug api_kendo-data-query_aggregateby %}) where the keys are the field name used for the calculation and the values are an object with the aggregate function name and a resulting value.
|
|
8
8
|
*
|
|
9
9
|
* @example
|
|
10
|
-
* ```js
|
|
10
|
+
* ```js
|
|
11
11
|
* const result = <AggregateResult>{
|
|
12
12
|
* "unitPrice": { "sum": 53, "count": 2 },
|
|
13
13
|
* "unitsInStock": { "sum": 66, "count": 3 }
|