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
//! 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] = &[
    // ── string ───────────────────────────────────────────────────────────────
    BuiltinFunctionCatalogEntry {
        name: "length",
        category: "string",
        parameters: &[Parameter {
            name: "value",
            fel_type: FelType::String,
            description: Some("String to measure."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Number,
        return_description: None,
        description: "Returns the number of characters in the string.",
        null_handling: Some("Null returns 0."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "length('hello')",
                result_json: "5",
                note: None,
            },
            Example {
                expression: "length(null)",
                result_json: "0",
                note: None,
            },
            Example {
                expression: "length($name)",
                result_json: "12",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "contains",
        category: "string",
        parameters: &[
            Parameter {
                name: "haystack",
                fel_type: FelType::String,
                description: Some("String to search in."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "needle",
                fel_type: FelType::String,
                description: Some("Substring to find."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "Returns true if the haystack string contains the needle substring. Case-sensitive.",
        null_handling: Some("Null haystack treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "contains('hello world', 'world')",
                result_json: "true",
                note: None,
            },
            Example {
                expression: "contains($email, '@')",
                result_json: "true",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "startsWith",
        category: "string",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::String,
                description: Some("String to test."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "prefix",
                fel_type: FelType::String,
                description: Some("Expected prefix."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "Returns true if value starts with prefix. Case-sensitive.",
        null_handling: Some("Null value treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "startsWith($url, 'https://')",
            result_json: "true",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "endsWith",
        category: "string",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::String,
                description: Some("String to test."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "suffix",
                fel_type: FelType::String,
                description: Some("Expected suffix."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "Returns true if value ends with suffix. Case-sensitive.",
        null_handling: Some("Null value treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "endsWith($email, '.gov')",
            result_json: "true",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "substring",
        category: "string",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::String,
                description: Some("Source string."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "start",
                fel_type: FelType::Number,
                description: Some("1-based start position."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "length",
                fel_type: FelType::Number,
                description: Some("Number of characters to extract."),
                required: false,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Extracts a substring starting at the 1-based position. If length is omitted, extracts to the end of the string.",
        null_handling: Some("Null value treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "substring('abcdef', 2, 3)",
                result_json: "\"bcd\"",
                note: None,
            },
            Example {
                expression: "substring('abcdef', 4)",
                result_json: "\"def\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "replace",
        category: "string",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::String,
                description: Some("Source string."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "search",
                fel_type: FelType::String,
                description: Some("Literal substring to find (NOT regex)."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "replacement",
                fel_type: FelType::String,
                description: Some("Replacement string."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Replaces ALL occurrences of the search literal with the replacement. Not regex — literal string match only.",
        null_handling: Some("Null value treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "replace('hello world', 'world', 'there')",
                result_json: "\"hello there\"",
                note: None,
            },
            Example {
                expression: "replace($phone, '-', '')",
                result_json: "\"5551234567\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "upper",
        category: "string",
        parameters: &[Parameter {
            name: "value",
            fel_type: FelType::String,
            description: Some("String to convert."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::String,
        return_description: None,
        description: "Converts string to uppercase.",
        null_handling: Some("Null treated as empty string, returns empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "upper('hello')",
            result_json: "\"HELLO\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "lower",
        category: "string",
        parameters: &[Parameter {
            name: "value",
            fel_type: FelType::String,
            description: Some("String to convert."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::String,
        return_description: None,
        description: "Converts string to lowercase.",
        null_handling: Some("Null treated as empty string, returns empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "lower('HELLO')",
            result_json: "\"hello\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "trim",
        category: "string",
        parameters: &[Parameter {
            name: "value",
            fel_type: FelType::String,
            description: Some("String to trim."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::String,
        return_description: None,
        description: "Removes leading and trailing whitespace.",
        null_handling: Some("Null treated as empty string, returns empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "trim('  hello  ')",
            result_json: "\"hello\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "matches",
        category: "string",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::String,
                description: Some("String to test."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "pattern",
                fel_type: FelType::String,
                description: Some("Regular expression pattern."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::Boolean,
        return_description: None,
        description: "Returns true if the string matches the regular expression pattern. Pattern syntax follows the host language's regex engine (ECMA-262 for TypeScript, Python re for Python).",
        null_handling: Some("Null value treated as empty string."),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "matches($ein, '^[0-9]{2}-[0-9]{7}$')",
                result_json: "true",
                note: None,
            },
            Example {
                expression: "matches($email, '^[^@]+@[^@]+$')",
                result_json: "true",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
    BuiltinFunctionCatalogEntry {
        name: "format",
        category: "string",
        parameters: &[
            Parameter {
                name: "template",
                fel_type: FelType::String,
                description: Some("Format string with {0}, {1}, ... positional placeholders."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "args",
                fel_type: FelType::Any,
                description: Some("Values to substitute for placeholders."),
                required: true,
                variadic: true,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Positional string interpolation. Replaces {0}, {1}, etc. in the template with stringified arguments. Null arguments become empty string. Numbers strip trailing zeros. Booleans become 'true'/'false'.",
        null_handling: Some(
            "Null template returns empty string. Null arguments substituted as empty string.",
        ),
        deterministic: true,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[
            Example {
                expression: "format('{0} of {1}', $current, $total)",
                result_json: "\"3 of 10\"",
                note: None,
            },
            Example {
                expression: "format('Hello, {0}!', $name)",
                result_json: "\"Hello, Alice!\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Universal,
    },
];