Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leifg/formulon
Salesforce Formula Parser implemented in ES2017. Live demo at
https://github.com/leifg/formulon
Last synced: 2 months ago
JSON representation
Salesforce Formula Parser implemented in ES2017. Live demo at
- Host: GitHub
- URL: https://github.com/leifg/formulon
- Owner: leifg
- License: mit
- Created: 2016-02-23T19:22:27.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-18T14:16:04.000Z (7 months ago)
- Last Synced: 2023-12-20T11:58:41.065Z (7 months ago)
- Language: JavaScript
- Homepage: https://formulon.io
- Size: 3.42 MB
- Stars: 61
- Watchers: 5
- Forks: 16
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Lists
- awesome-salesforce - Formulon - Formula parser completely implemented in ES6. [See Demo](http://formulon.io) (Javascript Libraries for Salesforce / Open Source Projects Repositories from Salesforce)
- awesome-salesforce - Formulon - Formula parser completely implemented in ES6. [See Demo](http://formulon.io) (Javascript Libraries for Salesforce / Open Source Projects Repositories from Salesforce)
README
# Formulon
[](https://github.com/semantic-release/semantic-release)
[](https://david-dm.org/leifg/formulon)
[](https://david-dm.org/leifg/formulon#info=devDependencies)
[](https://circleci.com/gh/leifg/formulon)
Formulon is a Parser for [Salesforce Formulas](https://help.salesforce.com/apex/HTViewHelpDoc?id=customize_functions.htm) completely written in ECMA Script 2015. It is the engine behind [formulon.io](https://formulon.io).
Featured on [Phil's Tip of the Week](https://www.cloudgalacticos.co.uk/2020/04/17/formulon-io-salesforce-formulas-helper-phils-tip-of-the-week-395/)
## Use Cases
- Test your Salesforce formulas using the web interface [without the need of creating records](https://www.cloudgalacticos.co.uk/2020/04/17/formulon-io-salesforce-formulas-helper-phils-tip-of-the-week-395/)
- Parse formula input programmatically and evaluate correctness outside of a Salesforce org
- In general if you use the [Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm) to add/change formulas, you could benefit from parsing formulas before submitting back to Salesforce
## Usage
### parse
This method will return a object holding value and its metadata
```javascript
import { parse } from 'formulon'
```
#### Examples
```javascript
parse('IF(TRUE, "True String", "False String")')
// {
// type: 'literal',
// value: 'True String',
// dataType: 'text',
// options: { length: 11 }
// }
```
`type`: Metadata from the parser (always `literal`)
`value`: The value of the result always as a string
`dataType`: The type of the return (currently `number`, `text`, `checkbox`, `date`, `time`, `datetime`, `geolocation` or `null`)
`options`: different options per data type
#### Data Types
Currently the following data types are supported (naming is taken from the Salesforce Field Types):
- Number (Integer or Float depending on the options)
- Text
- Checkbox (TRUE or FALSE)
- Date (as UTC Date with time components set to 0)
- Time (as UTC Date with date set to 1970-01-01)
- Datetime (as UTC Date)
- Geolocation (as lat, long array)
- Null (js null value)
#### Options
Options depend on the data type:
##### Number
- Length: Number of digits to the left of the decimal point
- Scale: Number of digits to the right of the decimal point
##### Text
- Length: Number of characters
##### Checkbox
*no options*
#### Errors
Whenever an error occurs, an according object is returned:
```javascript
parse('IF(TRUE)')
// {
// type: 'error',
// errorType: 'ArgumentError',
// message: "Incorrect number of parameters for function 'IF()'. Expected 3, received 1",
// function: 'if',
// expected: 3,
// received: 1,
// }
```
#### Identifiers (Variables)
It's possible to specify formulas that contain variables. In that case pass the value of the variable in as a second argument:
```javascript
parse('IF(Variable__c, "True String", "False String")', {Variable__c: {type: 'literal', dataType: 'checkbox', value: true}})
// {
// type: 'literal',
// value: 'True String',
// dataType: 'text',
// options: { length: 11 }
// }
```
You'll have to provide the variable in the form:
```javascript
{
type: 'literal',
value: ,
dataType: ,
options:
}
```
### extract
Utility function that returns a list of used variables
```javascript
extract('IF(Variable__c, Variable__c, AnotherVariable__c)')
// [ 'Variable__c', 'AnotherVariable__c' ]
```
### ast
Return the abstract syntax tree built from the formula.
```javascript
ast('IF(Variable__c, "True String", "False String")')
// {
// "type": "callExpression",
// "id": "if",
// "arguments": [
// {
// "type": "identifier",
// "name": "Variable__c"
// },
// {
// "type": "literal",
// "value": "True String",
// "dataType": "text",
// "options": {
// "length": 11
// }
// },
// {
// "type": "literal",
// "value": "False String",
// "dataType": "text",
// "options": {
// "length": 12
// }
// }
// ]
// }
```
## Contributors
Formulon exists thanks to the following people who have contributed.
- [Jordan Henderson](https://github.com/jordanhenderson)
- [Leif Gensert](https://github.com/leifg)
- [James Melville](https://github.com/jamesmelville)
- [Michael Mason](https://github.com/mjmasn)
- [Kyle Crouse](https://github.com/kacrouse)