fel-core 0.3.0

Formspec Expression Language — parser, evaluator, and dependency analysis
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
//! Static builtin catalog data (`BUILTIN_FUNCTIONS`) and reserved names.
#![allow(clippy::missing_docs_in_private_items)]

use super::super::types::*;

pub(super) const ENTRIES: &[BuiltinFunctionCatalogEntry] = &[
    // ── aggregate ────────────────────────────────────────────────────────────
    BuiltinFunctionCatalogEntry {
        name: "sum",
        category: "aggregate",
        parameters: &[Parameter {
            name: "values",
            fel_type: FelType::Array,
            description: Some("Array of numbers."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Sums all numeric elements in the array. Money values are rejected; use moneySum() for currency-safe aggregation.",
        null_handling: Some(
            "Null elements are skipped. Arrays containing money emit FEL_SUM_REJECTS_MONEY and return null.",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "sum($items[*].amount)",
                result_json: "1500",
                note: None,
            },
            Example {
                expression: "sum([10, null, 20])",
                result_json: "30",
                note: None,
            },
            Example {
                expression: "sum([])",
                result_json: "0",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "count",
        category: "aggregate",
        parameters: &[Parameter {
            name: "values",
            fel_type: FelType::Array,
            description: Some("Array to count."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Returns the number of elements in the array, including nulls.",
        null_handling: Some("Null argument returns 0. Null elements ARE counted."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "count($items[*].name)",
                result_json: "3",
                note: None,
            },
            Example {
                expression: "count([1, null, 3])",
                result_json: "3",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "countWhere",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array to filter."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Number,
        return_description: None,
        description: "Counts array elements for which the predicate evaluates to true. The predicate receives each element via '$' (the self-reference is rebound per element). Special argument handling: the predicate is NOT pre-evaluated — it is evaluated once per element.",
        null_handling: Some("Null array returns 0. Null predicate result counts as false."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[
            Example {
                expression: "countWhere($items[*].amount, $ > 100)",
                result_json: "2",
                note: None,
            },
            Example {
                expression: "countWhere($scores[*], $ >= 60)",
                result_json: "4",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "sumWhere",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some(
                    "Array of numbers (or elements from which numeric matches are taken).",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Number,
        return_description: None,
        description: "Sums numeric array elements for which the predicate evaluates to true. The predicate is NOT pre-evaluated — it is evaluated once per element.",
        null_handling: Some(
            "Null array returns null. Non-numeric matches are skipped. No numeric matches returns 0.",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[Example {
            expression: "sumWhere([1, 2, 3, 4], $ > 2)",
            result_json: "7",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "avgWhere",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array of numbers."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Number,
        return_description: None,
        description: "Arithmetic mean of numeric elements for which the predicate is true. Returns null when no elements match.",
        null_handling: Some("Null array returns null. No matches returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[Example {
            expression: "avgWhere([40, 50, 60], $ >= 50)",
            result_json: "55",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "minWhere",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array of comparable values."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Any,
        return_description: None,
        description: "Smallest element among those satisfying the predicate. Also applies to dates and strings.",
        null_handling: Some("Null array returns null. No matches returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[Example {
            expression: "minWhere([3, 1, 4], $ > 0)",
            result_json: "1",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "maxWhere",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array of comparable values."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Any,
        return_description: None,
        description: "Largest element among those satisfying the predicate. Also applies to dates and strings.",
        null_handling: Some("Null array returns null. No matches returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[Example {
            expression: "maxWhere([3, 1, 4], $ < 4)",
            result_json: "3",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "every",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array to test."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "True if the array is empty or the predicate is true for every element. The predicate is NOT pre-evaluated — it is evaluated once per element.",
        null_handling: Some(
            "Null array returns null. Null predicate result is not true (element fails every, does not satisfy some).",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[
            Example {
                expression: "every([1, 2, 3], $ > 0)",
                result_json: "true",
                note: None,
            },
            Example {
                expression: "every([], $ > 0)",
                result_json: "true",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "some",
        category: "aggregate",
        parameters: &[
            Parameter {
                name: "values",
                fel_type: FelType::Array,
                description: Some("Array to test."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "predicate",
                fel_type: FelType::Boolean,
                description: Some(
                    "FEL expression evaluated per element with '$' rebound to the current element.",
                ),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "True if at least one element satisfies the predicate. The predicate is NOT pre-evaluated — it is evaluated once per element.",
        null_handling: Some("Null array returns null. Null predicate result counts as false."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: true,
        examples: &[
            Example {
                expression: "some([0, 2, 4], $ > 3)",
                result_json: "true",
                note: None,
            },
            Example {
                expression: "some([], $ > 0)",
                result_json: "false",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "avg",
        category: "aggregate",
        parameters: &[Parameter {
            name: "values",
            fel_type: FelType::Array,
            description: Some("Array of numbers."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Arithmetic mean of all finite numeric elements. Skips nulls and non-numeric values.",
        null_handling: Some(
            "Null/non-numeric elements skipped. Empty array or all-null returns 0.",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "avg([10, 20, 30])",
                result_json: "20",
                note: None,
            },
            Example {
                expression: "avg([10, null, 30])",
                result_json: "20",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "min",
        category: "aggregate",
        parameters: &[Parameter {
            name: "values",
            fel_type: FelType::Any,
            description: Some(
                "Either a single array argument or two or more scalar arguments (variadic scalar form).",
            ),
            required: true,
            variadic: true,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Returns the smallest finite numeric value. Accepts either `min([...])` (single array) or `min(a, b, ...)` (variadic scalars).",
        null_handling: Some("Null/non-numeric elements skipped. Empty array returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "min([5, 2, 8])",
                result_json: "2",
                note: None,
            },
            Example {
                expression: "min($items[*].amount)",
                result_json: "100",
                note: None,
            },
            Example {
                expression: "min(5, 2, 8)",
                result_json: "2",
                note: Some("Variadic scalar form"),
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "max",
        category: "aggregate",
        parameters: &[Parameter {
            name: "values",
            fel_type: FelType::Any,
            description: Some(
                "Either a single array argument or two or more scalar arguments (variadic scalar form).",
            ),
            required: true,
            variadic: true,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Returns the largest finite numeric value. Accepts either `max([...])` (single array) or `max(a, b, ...)` (variadic scalars).",
        null_handling: Some("Null/non-numeric elements skipped. Empty array returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "max([5, 2, 8])",
                result_json: "8",
                note: None,
            },
            Example {
                expression: "max(5, 2, 8)",
                result_json: "8",
                note: Some("Variadic scalar form"),
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
];