[](https://badge.fury.io/js/@jetstreamapp%2Fsoql-parser-js)
## Description
**This library allows parsing and composing SOQL queries from Salesforce using JavaScript or Typescript.**
### Installation
đ **As of version 6.0.0**, this package is now part of the `@jetstreamapp` npm organization.
```bash
npm install @jetstreamapp/soql-parser-js
```
**Available Features:**
1. Parse SOQL queries into a common `Query` data structure.
2. Deterministically compose a `Query` data structure back into a SOQL query string.
3. Validate a query to check if the syntax is valid.
1. _Even if a query is returned as valid, it might still be invalid based on your Salesforce configuration_
Migrating from version 1 to version 2? [Check out the changelog](CHANGELOG.md#200) for a full list of changes.
Migrating from version 2 to version 3? [Check out the changelog](CHANGELOG.md#300) for a full list of changes.
## Documentation
**[Read the documentation on our docs site](https://paustint.github.io/soql-parser-js/)**.
## Compatibility
**Node**: version 11 or higher, or a polyfill for [Array.flat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flat)
**Browser**: Tested in all modern browsers, may not work with older browsers.
The **commander** dependency is only required for the cli, the other two dependencies **chevrotain** and **lodash.get** are bundled with the non-cli code.
## Quick Start
```javascript
import { parseQuery, composeQuery, isQueryValid } from '@jetstreamapp/soql-parser-js';
const query = parseQuery(`SELECT Id FROM Account WHERE Id = 'FOO'`);
console.log('query', query);
const soql = composeQuery(query);
console.log('soql', soql); // SELECT Id FROM Account WHERE Id = 'FOO'
isQueryValid('SELECT Id, Foo FROM Baz'); // true
isQueryValid('SELECT Id Foo FROM Baz'); // false
```
## Available Features
| Function | Description | Arguments |
| ------------ | ------------------------------------------------------ | ------------------------------------------ |
| parseQuery | Parse a SOQL query string into a Query data structure. | soql: QueryParsed Query: {parsedQueryString}
``` All public exports of the library (`parseQuery`, `composeQuery`, `formatQuery`, `isQueryValid`, the various utility functions, etc.) are available as named imports from `c/soqlParserJs`. ## CLI Install globally or use `npx` to interact with the cli. ### Available Commands - `soql-parser-js --help` (or using `npx`: `npx soql-parser-js --help`) - `soql-parser-js parse --help` - `soql-parser-js compose --help` - `soql-parser-js format --help` ### Examples #### Parse `npx soql-parser-js parse "SELECT Id FROM Account"` ```bash {"fields":[{"type":"Field","field":"Id"}],"sObject":"Account"} ``` #### Compose `npx soql-parser-js compose "{\"fields\":[{\"type\":\"Field\",\"field\":\"Id\"}],\"sObject\":\"Account\"}"` ```bash SELECT Id FROM Account ``` `npx soql-parser-js compose "{\"fields\":[{\"type\":\"Field\",\"field\":\"Id\"}],\"sObject\":\"Account\"}" --json` or -j ```json { "query": "SELECT Id FROM Account" } ``` #### Format `npx soql-parser-js format "SELECT Name, COUNT(Id) FROM Account GROUP BY Name HAVING COUNT(Id) > 1"` ```bash SELECT Name, COUNT(Id) FROM Account GROUP BY Name HAVING COUNT(Id) > 1 ``` `npx soql-parser-js format "SELECT Name, COUNT(Id) FROM Account GROUP BY Name HAVING COUNT(Id) > 1 -j` ```json { "query": "SELECT Name, COUNT(Id)\nFROM Account\nGROUP BY Name\nHAVING COUNT(Id) > 1" } ``` #### Is Valid `npx soql-parser-js valid "SELECT Id FROM Account"` ```bash true ``` `npx soql-parser-js valid "SELECT Id invalid FROM Account"` âšī¸ this returns an exit code of 1 ```bash false ``` `npx soql-parser-js valid "SELECT Id FROM Account" -j` ```json { "isValid": true } ``` `npx soql-parser-js valid "SELECT Id invalid invalid FROM Account" -j` âšī¸ this returns an exit code of 0 ```json { "isValid": false } ``` ### List of options `soql-parser-js --help` ```bash Usage: soql-parser-js [options] [command] Options: -h, --help output usage information Commands: parse [options]