@jetstreamapp/soql-parser-js 6.0.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -1
- package/README.md +10 -11
- package/dist/cjs/index.js +143 -2
- package/dist/cli/index.js +148 -113
- package/dist/esm/index.js +143 -4
- package/dist/{cjs/src → types}/index.d.ts +1 -1
- package/package.json +15 -23
- package/dist/cjs/index.js.LICENSE.txt +0 -1
- package/dist/cjs/main.licenses.txt +0 -898
- package/dist/cjs/src/api/api-models.js +0 -2
- package/dist/cjs/src/api/public-utils.js +0 -175
- package/dist/cjs/src/composer/composer.js +0 -295
- package/dist/cjs/src/formatter/formatter.js +0 -236
- package/dist/cjs/src/index.js +0 -23
- package/dist/cjs/src/models.js +0 -2
- package/dist/cjs/src/parser/lexer.js +0 -954
- package/dist/cjs/src/parser/parser.js +0 -697
- package/dist/cjs/src/parser/visitor.js +0 -856
- package/dist/cjs/src/utils.js +0 -245
- package/dist/esm/api/api-models.js +0 -1
- package/dist/esm/api/public-utils.js +0 -153
- package/dist/esm/composer/composer.js +0 -273
- package/dist/esm/formatter/formatter.js +0 -223
- package/dist/esm/models.js +0 -1
- package/dist/esm/parser/lexer.js +0 -947
- package/dist/esm/parser/parser.js +0 -667
- package/dist/esm/parser/visitor.js +0 -823
- package/dist/esm/utils.js +0 -200
- package/dist/src/api/api-models.js +0 -2
- package/dist/src/api/public-utils.js +0 -203
- package/dist/src/composer/composer.js +0 -358
- package/dist/src/formatter/formatter.js +0 -263
- package/dist/src/index.js +0 -28
- package/dist/src/models.js +0 -2
- package/dist/src/parser/lexer.js +0 -997
- package/dist/src/parser/parser.js +0 -711
- package/dist/src/parser/visitor.js +0 -862
- package/dist/src/utils.js +0 -251
- /package/dist/{cjs/src → types}/api/api-models.d.ts +0 -0
- /package/dist/{cjs/src → types}/api/public-utils.d.ts +0 -0
- /package/dist/{cjs/src → types}/composer/composer.d.ts +0 -0
- /package/dist/{cjs/src → types}/formatter/formatter.d.ts +0 -0
- /package/dist/{cjs/src → types}/models.d.ts +0 -0
- /package/dist/{cjs/src → types}/parser/lexer.d.ts +0 -0
- /package/dist/{cjs/src → types}/parser/parser.d.ts +0 -0
- /package/dist/{cjs/src → types}/parser/visitor.d.ts +0 -0
- /package/dist/{cjs/src → types}/utils.d.ts +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 6.1.0
|
|
4
|
+
|
|
5
|
+
June 16, 2024
|
|
6
|
+
|
|
7
|
+
- Add support for [negative currency values](https://help.salesforce.com/s/articleView?id=release-notes.rn_api_soql.htm&release=250&type=5) (#244)
|
|
8
|
+
|
|
3
9
|
## 6.0.0
|
|
4
10
|
|
|
5
11
|
June 16, 2024
|
|
@@ -644,7 +650,7 @@ Minified, uncompressed:
|
|
|
644
650
|
- Version 2.0: **207kb**
|
|
645
651
|
|
|
646
652
|
```javascript
|
|
647
|
-
var soqlParser = require('soql-parser-js');
|
|
653
|
+
var soqlParser = require('@jetstreamapp/soql-parser-js');
|
|
648
654
|
|
|
649
655
|
const query = soqlParser.parseQuery(`SELECT Id FROM Account WHERE Id = 'FOO'`);
|
|
650
656
|
console.log('query', query);
|
package/README.md
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
<img src="./assets/soql-parser-js-logo.svg">
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://david-dm.org/jetstreamapp/soql-parser-js)
|
|
3
|
+

|
|
4
|
+
[](https://badge.fury.io/js/@jetstreamapp%2Fsoql-parser-js)
|
|
6
5
|
|
|
7
6
|
## Description
|
|
8
7
|
|
|
@@ -41,7 +40,7 @@ The **commander** dependency is only required for the cli, the other two depende
|
|
|
41
40
|
## Quick Start
|
|
42
41
|
|
|
43
42
|
```javascript
|
|
44
|
-
import { parseQuery, composeQuery, isQueryValid } from 'soql-parser-js';
|
|
43
|
+
import { parseQuery, composeQuery, isQueryValid } from '@jetstreamapp/soql-parser-js';
|
|
45
44
|
|
|
46
45
|
const query = parseQuery(`SELECT Id FROM Account WHERE Id = 'FOO'`);
|
|
47
46
|
console.log('query', query);
|
|
@@ -125,7 +124,7 @@ Many of hte utility functions are provided to easily determine the shape of spec
|
|
|
125
124
|
Parsing a SOQL query can be completed by calling `parseQuery(soqlQueryString)`. A `Query` data structure will be returned.
|
|
126
125
|
|
|
127
126
|
```typescript
|
|
128
|
-
import { parseQuery } from 'soql-parser-js';
|
|
127
|
+
import { parseQuery } from '@jetstreamapp/soql-parser-js';
|
|
129
128
|
|
|
130
129
|
const soql = `
|
|
131
130
|
SELECT UserId, COUNT(Id)
|
|
@@ -189,7 +188,7 @@ console.log(JSON.stringify(soqlQuery, null, 2));
|
|
|
189
188
|
Added support for `allowPartialQuery` in version `4.4.0`
|
|
190
189
|
|
|
191
190
|
```typescript
|
|
192
|
-
import { parseQuery } from 'soql-parser-js';
|
|
191
|
+
import { parseQuery } from '@jetstreamapp/soql-parser-js';
|
|
193
192
|
|
|
194
193
|
const soql = `
|
|
195
194
|
WHERE LoginTime > 2010-09-20T22:16:30.000Z
|
|
@@ -235,7 +234,7 @@ console.log(JSON.stringify(soqlQuery, null, 2));
|
|
|
235
234
|
### Validating Queries
|
|
236
235
|
|
|
237
236
|
```typescript
|
|
238
|
-
import { isQueryValid } from 'soql-parser-js';
|
|
237
|
+
import { isQueryValid } from '@jetstreamapp/soql-parser-js';
|
|
239
238
|
|
|
240
239
|
const invalidSoql = `SELECT UserId, COUNT(Id) Account`;
|
|
241
240
|
const validSoql = `SELECT UserId, COUNT(Id) Account`;
|
|
@@ -259,7 +258,7 @@ Some utility methods have been provided to make it easier to build the field dat
|
|
|
259
258
|
**Note:** There are a number of fields populated on the Query object when `parseQuery()` is called that are not required to compose a query. Look at the examples below and the comments in the data model for more information.
|
|
260
259
|
|
|
261
260
|
```typescript
|
|
262
|
-
import { composeQuery, getField, Query } from 'soql-parser-js';
|
|
261
|
+
import { composeQuery, getField, Query } from '@jetstreamapp/soql-parser-js';
|
|
263
262
|
|
|
264
263
|
// Build a subquery
|
|
265
264
|
const oppLineItemsSubquery = {
|
|
@@ -339,7 +338,7 @@ Starting in version `4.4`, compose will not fail if there are missing `SELECT` a
|
|
|
339
338
|
Partial compose support it supported without any additional steps.
|
|
340
339
|
|
|
341
340
|
```typescript
|
|
342
|
-
import { Compose, parseQuery } from 'soql-parser-js';
|
|
341
|
+
import { Compose, parseQuery } from '@jetstreamapp/soql-parser-js';
|
|
343
342
|
|
|
344
343
|
const soql = `WHERE Name LIKE 'A%' AND MailingCity = 'California`;
|
|
345
344
|
const parsedQuery = parseQuery(soql, { allowPartialQuery: true });
|
|
@@ -374,7 +373,7 @@ If you need to compose just a part of a query instead of the entire query, you c
|
|
|
374
373
|
For example, if you just need the `WHERE` clause from a query as a string, you can do the following:
|
|
375
374
|
|
|
376
375
|
```typescript
|
|
377
|
-
import { Compose, parseQuery } from 'soql-parser-js';
|
|
376
|
+
import { Compose, parseQuery } from '@jetstreamapp/soql-parser-js';
|
|
378
377
|
|
|
379
378
|
const soql = `SELECT Id FROM Account WHERE Name = 'Foo'`;
|
|
380
379
|
const parsedQuery = parseQuery(soql);
|
|
@@ -430,7 +429,7 @@ This function is provided as a convenience and just calls parse and compose.
|
|
|
430
429
|
[Check out the demo](https://jetstreamapp.github.io/soql-parser-js/) to see the outcome of the various format options.
|
|
431
430
|
|
|
432
431
|
```typescript
|
|
433
|
-
import { formatQuery } from 'soql-parser-js';
|
|
432
|
+
import { formatQuery } from '@jetstreamapp/soql-parser-js';
|
|
434
433
|
|
|
435
434
|
const query = `SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, BillingCity, BillingCountry, BillingGeocodeAccuracy, ShippingStreet, Sic, SicDesc, Site, SystemModstamp, TickerSymbol, Type, Website, (SELECT Id, Name, AccountId, Amount, CampaignId, CloseDate, CreatedById, Type FROM Opportunities), (SELECT Id, Name, AccountNumber, AccountSource, AnnualRevenue, BillingAddress, Website FROM ChildAccounts) FROM Account WHERE Name LIKE 'a%' OR Name LIKE 'b%' OR Name LIKE 'c%'`;
|
|
436
435
|
|