@lanetix/formula-fields-parser

formula-fields-parser

This repository contains the WIP Formula Fields Parser. Currently implemented:

1. Lexer
2. Parser
3. Visitor
4. Symbol Table
5. Semantic Analysis

Exports

• Parser - The formula fields parser
• visit - The formula fields AST Visitor
• errors - Built in errors for use with the visitor
• validate - The formula fields semantic analysis

default

The default export is a convenience function that takes the text of a formula, parses it, and runs semantic validation. It takes the following parameters:

• formulaText - The formula text
• recordType - Optional. The type definition of the record the formula is being applied to. If not provided, all fields are assumed to be semantically valid
• recordTypeName - Optional, but required if recordType is provided. The human friendly name of recordType. If recordType is provided and this is not, all fields are assumed to be semantically valid

It returns an object with the following properties:

• ast - The formula abstract syntax tree. This may be undefined if there are errors during the lexing or parsing phases.
• errors - An array of any lex, parse, or semantic errors that occurred when validating the formula.

All errors are guaranteed to have the following properties, although some may have additional:

• name - The name of the error type (e.g. MismatchedTokenException)
• message - The error message
• location - The location where the error occurred

Example

import parseAndValidate from '@lanetix/formula-fields-parser'

// fields *are not* validated
const { ast, errors } = parseAndValidate('CONCAT($first_name, $last_name)')

// fields are validated
const recordType = ...     // get from records service if not available
const recordTypeName = ... // get from records service if not available
const { ast, errors } = parseAndValidate('CONCAT($first_name, $last_name)', recordType, recordTypeName)