fel-core 0.3.0

Formspec Expression Language — parser, evaluator, and dependency analysis
Documentation
//! 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] = &[
    // ── locale ───────────────────────────────────────────────────────────────
    BuiltinFunctionCatalogEntry {
        name: "locale",
        category: "locale",
        parameters: &[],
        returns: FelType::String,
        return_description: None,
        description: "Returns the active BCP 47 locale tag from the evaluation context.",
        null_handling: Some("When the host has not set a locale, returns null."),
        deterministic: false,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "locale()",
            result_json: "\"en-US\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Formspec,
    },
    BuiltinFunctionCatalogEntry {
        name: "runtimeMeta",
        category: "locale",
        parameters: &[Parameter {
            name: "key",
            fel_type: FelType::String,
            description: Some("Key in the host-provided runtime metadata bag."),
            required: true,
            variadic: false,
            allowed_values: None,
        }],
        returns: FelType::Any,
        return_description: None,
        description: "Reads a value from runtime metadata supplied by the host.",
        null_handling: Some("Missing key returns null."),
        deterministic: false,
        emit_deterministic_explicitly: false,
        short_circuit: false,
        examples: &[Example {
            expression: "runtimeMeta('tenantId')",
            result_json: "\"acme-42\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Formspec,
    },
    BuiltinFunctionCatalogEntry {
        name: "pluralCategory",
        category: "locale",
        parameters: &[
            Parameter {
                name: "count",
                fel_type: FelType::Number,
                description: Some("Numeric count for plural rule selection."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "localeTag",
                fel_type: FelType::String,
                description: Some("Optional BCP 47 tag; defaults to locale()."),
                required: false,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Returns the CLDR cardinal plural category (zero, one, two, few, many, other) for the count and locale.",
        null_handling: Some("Null count returns null."),
        deterministic: true,
        emit_deterministic_explicitly: true,
        short_circuit: false,
        examples: &[
            Example {
                expression: "pluralCategory(1)",
                result_json: "\"one\"",
                note: None,
            },
            Example {
                expression: "pluralCategory(2, 'en')",
                result_json: "\"other\"",
                note: None,
            },
        ],
        since_version: "1.0",
        package: Package::Formspec,
    },
    BuiltinFunctionCatalogEntry {
        name: "formatNumber",
        category: "locale",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::Number,
                description: Some("Numeric value to format."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "localeTag",
                fel_type: FelType::String,
                description: Some("Optional BCP 47 tag; defaults to locale()."),
                required: false,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Formats a number using locale decimal and grouping conventions.",
        null_handling: Some("Null value returns null."),
        deterministic: true,
        emit_deterministic_explicitly: true,
        short_circuit: false,
        examples: &[Example {
            expression: "formatNumber(1234.5, 'en')",
            result_json: "\"1,234.5\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Formspec,
    },
    BuiltinFunctionCatalogEntry {
        name: "formatDate",
        category: "locale",
        parameters: &[
            Parameter {
                name: "value",
                fel_type: FelType::Any,
                description: Some("FEL date value or ISO 8601 date string."),
                required: true,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "pattern",
                fel_type: FelType::String,
                description: Some("short, medium, long, or full; defaults to medium."),
                required: false,
                variadic: false,
                allowed_values: None,
            },
            Parameter {
                name: "localeTag",
                fel_type: FelType::String,
                description: Some("Optional BCP 47 tag; defaults to locale()."),
                required: false,
                variadic: false,
                allowed_values: None,
            },
        ],
        returns: FelType::String,
        return_description: None,
        description: "Formats a date using a deterministic cross-runtime subset (en/fr month names for medium/long/full; not full CLDR).",
        null_handling: Some("Null value returns null."),
        deterministic: true,
        emit_deterministic_explicitly: true,
        short_circuit: false,
        examples: &[Example {
            expression: "formatDate('2026-05-17', 'medium', 'en')",
            result_json: "\"May 17, 2026\"",
            note: None,
        }],
        since_version: "1.0",
        package: Package::Formspec,
    },
];