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
//! 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] = &[
    // ── date ─────────────────────────────────────────────────────────────────
    BuiltinFunctionCatalogEntry {
        name: "today",
        category: "date",
        parameters: &[],
        returns: FelType::Date,
        return_description: None,
        description: "Returns the current date as an ISO 8601 date string (YYYY-MM-DD). Non-deterministic.",
        null_handling: Some("N/A — no parameters."),
        deterministic: false,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "today()",
            result_json: "\"2025-07-10\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "now",
        category: "date",
        parameters: &[],
        returns: FelType::DateTime,
        return_description: None,
        description: "Returns the current date and time as an ISO 8601 dateTime string. Non-deterministic.",
        null_handling: Some("N/A — no parameters."),
        deterministic: false,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "now()",
            result_json: "\"2025-07-10T14:30:00.000Z\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "year",
        category: "date",
        parameters: &[Parameter {
            name: "date",
            fel_type: FelType::Date,
            description: Some("ISO 8601 date or dateTime string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the 4-digit year from a date.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "year(@2025-07-10)",
                result_json: "2025",
                note: None,
            },
            Example {
                expression: "year($birthDate)",
                result_json: "1990",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "month",
        category: "date",
        parameters: &[Parameter {
            name: "date",
            fel_type: FelType::Date,
            description: Some("ISO 8601 date or dateTime string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the month (1-12) from a date.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "month(@2025-07-10)",
            result_json: "7",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "day",
        category: "date",
        parameters: &[Parameter {
            name: "date",
            fel_type: FelType::Date,
            description: Some("ISO 8601 date or dateTime string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the day of month (1-31) from a date.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "day(@2025-07-10)",
            result_json: "10",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "hours",
        category: "date",
        parameters: &[Parameter {
            name: "dateTime",
            fel_type: FelType::DateTime,
            description: Some("ISO 8601 dateTime or time string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the hour component (0-23) from a dateTime or time value.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "hours(@2025-07-10T14:30:00Z)",
            result_json: "14",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "minutes",
        category: "date",
        parameters: &[Parameter {
            name: "dateTime",
            fel_type: FelType::DateTime,
            description: Some("ISO 8601 dateTime or time string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the minute component (0-59) from a dateTime or time value.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "minutes(@2025-07-10T14:30:00Z)",
            result_json: "30",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "seconds",
        category: "date",
        parameters: &[Parameter {
            name: "dateTime",
            fel_type: FelType::DateTime,
            description: Some("ISO 8601 dateTime or time string."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Extracts the second component (0-59) from a dateTime or time value.",
        null_handling: Some("Null returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "seconds(@2025-07-10T14:30:45Z)",
            result_json: "45",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "time",
        category: "date",
        parameters: &[
            Parameter {
                name: "hours",
                fel_type: FelType::Number,
                description: Some("Hour (0-23)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "minutes",
                fel_type: FelType::Number,
                description: Some("Minute (0-59)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "seconds",
                fel_type: FelType::Number,
                description: Some("Second (0-59)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Time,
        return_description: None,
        description: "Constructs an HH:MM:SS time string from numeric components.",
        null_handling: Some("Null components treated as 0."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "time(14, 30, 0)",
                result_json: "\"14:30:00\"",
                note: None,
            },
            Example {
                expression: "time(9, 5, 30)",
                result_json: "\"09:05:30\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "dateDiff",
        category: "date",
        parameters: &[
            Parameter {
                name: "date1",
                fel_type: FelType::Date,
                description: Some("First date (ISO 8601)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "date2",
                fel_type: FelType::Date,
                description: Some("Second date (ISO 8601)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "unit",
                fel_type: FelType::String,
                description: Some("Unit of measurement."),
                required: true,
                variadic: false,
                allowed_values: Some(&["days", "months", "years"]),
            },
        ],
        returns: FelType::Number,
        return_description: None,
        description: "Returns the difference laterDate − earlierDate in the specified unit (arguments: date1 as laterDate, date2 as earlierDate). Result is positive when date1 > date2, negative when date1 < date2. For months/years, incomplete periods are truncated (not rounded).",
        null_handling: Some("Null or invalid dates return null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "dateDiff(@2025-07-10, @2025-01-01, 'days')",
                result_json: "190",
                note: None,
            },
            Example {
                expression: "dateDiff($endDate, $startDate, 'months')",
                result_json: "6",
                note: None,
            },
            Example {
                expression: "dateDiff(today(), $birthDate, 'years')",
                result_json: "35",
                note: Some("Age calculation"),
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "dateAdd",
        category: "date",
        parameters: &[
            Parameter {
                name: "date",
                fel_type: FelType::Date,
                description: Some("Base date (ISO 8601)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "amount",
                fel_type: FelType::Number,
                description: Some("Number of units to add (negative to subtract)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "unit",
                fel_type: FelType::String,
                description: Some("Unit of measurement."),
                required: true,
                variadic: false,
                allowed_values: Some(&["days", "months", "years"]),
            },
        ],
        returns: FelType::Date,
        return_description: Some("ISO 8601 date string (YYYY-MM-DD)."),
        description: "Adds the specified number of units to a date. Negative values subtract. Month/year arithmetic handles end-of-month overflow per the host language's Date implementation.",
        null_handling: Some("Null date returns null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "dateAdd(@2025-01-15, 30, 'days')",
                result_json: "\"2025-02-14\"",
                note: None,
            },
            Example {
                expression: "dateAdd(today(), 1, 'years')",
                result_json: "\"2026-07-10\"",
                note: None,
            },
            Example {
                expression: "dateAdd($startDate, -6, 'months')",
                result_json: "\"2025-01-10\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "timeDiff",
        category: "date",
        parameters: &[
            Parameter {
                name: "laterTime",
                fel_type: FelType::Time,
                description: Some("Later ISO 8601 time string (HH:MM:SS)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "earlierTime",
                fel_type: FelType::Time,
                description: Some("Earlier ISO 8601 time string (HH:MM:SS)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Number,
        return_description: Some(
            "Signed difference in whole seconds: laterTime minus earlierTime (positive when the first argument is later in the day).",
        ),
        description: "Difference in seconds between two time-of-day strings. Distinct from duration(), which parses an ISO 8601 duration and returns milliseconds.",
        null_handling: Some("Invalid time strings produce a diagnostic and null."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "timeDiff('14:30:00', '13:00:00')",
                result_json: "5400",
                note: None,
            },
            Example {
                expression: "timeDiff('13:00:00', '14:30:00')",
                result_json: "-5400",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "duration",
        category: "date",
        parameters: &[Parameter {
            name: "isoDuration",
            fel_type: FelType::String,
            description: Some("ISO 8601 duration (PnYnMnDTnHnMnS subset), optional leading minus."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Parses a duration string and returns its length in milliseconds. Years/months in the date part use fixed 365-day years and 30-day months (not calendar arithmetic). Distinct from timeDiff, which compares two clock times in seconds.",
        null_handling: Some(
            "Null argument returns null. Invalid strings produce an error diagnostic and null.",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "duration('PT1H')",
                result_json: "3600000",
                note: None,
            },
            Example {
                expression: "duration('P1D')",
                result_json: "86400000",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
];