@repositive/query-parser - npm Package Compare versions

Comparing version 1.1.2 to 2.0.0

package.json

 {
   "name": "@repositive/query-parser",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "description": "",
-  "main": "dist/main/index.js",
-  "types": "dist/main/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "setup": "npm i && rm -fr dist && tsc && pegjs -o dist/main/parser.js src/main/parser.pegjs",
-    "make": "rm -fr dist && tsc && pegjs -o dist/main/parser.js src/main/parser.pegjs",
-    "test": "nyc tape $(find dist -name '*.js') | tap-spec",
+    "setup": "npm i && rm -fr dist && tsc && pegjs -o dist/parsers/natural.js src/parsers/natural.pegjs",
+    "make": "rm -fr dist && tsc && pegjs -o dist/parsers/natural.js src/parsers/natural.pegjs",
+    "test": "nyc --reporter lcov tape $(find dist -name '*.js') | tap-spec",
     "lint": "tslint -c tslint.json src/**/*.ts",
-    "start": "nodemon --watch src --watch package.json -e ts,json,pegjs -q -x 'rm -fr dist && echo \"\\n============\\nCOMPILING...\\n============\\n\\n\" && tsc --outDir dist || return 0 && pegjs -o dist/main/parser.js src/main/parser.pegjs || return 0 && node dist/main/cli.js'",
-    "testdev": "nodemon --watch src --watch package.json -e ts,json,pegjs -q -x 'rm -fr dist && echo \"\\n============\\nCOMPILING...\\n============\\n\\n\" && tsc --outDir dist || return 0 && pegjs -o dist/main/parser.js src/main/parser.pegjs || return 0 && tape \"dist/tests/**/*.js\"'"
+    "start": "nodemon --watch src --watch package.json -e ts,json,pegjs -q -x 'rm -fr dist && echo \"\\n============\\nCOMPILING...\\n============\\n\\n\" && tsc --outDir dist || return 0 && pegjs -o dist/parsers/natural.js src/parsers/natural.pegjs || return 0 && node dist/main/cli.js'",
+    "testdev": "nodemon --watch src --watch package.json -e ts,json,pegjs -q -x 'rm -fr dist && echo \"\\n============\\nCOMPILING...\\n============\\n\\n\" && tsc --outDir dist || return 0 && pegjs -o dist/parsers/natural.js src/parsers/natural.pegjs || return 0 && tape \"dist/**/*.spec.js\"'"
   },
@@ -25,18 +25,26 @@ "nyc": {
   "author": "Repositive Team",
-  "license": "MIT",
+  "license": "LGPL-3.0+",
+  "homepage": "https://github.com/repositive/query-parser",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/repositive/query-parser.git"
+  },
   "devDependencies": {
-    "@repositive/typescript": "^1.1.2",
-    "@types/csv-parse": "^1.1.6",
+    "@repositive/typescript": "1.1.2",
+    "@types/csv-parse": "1.1.9",
+    "@types/node": "7.0.39",
     "@types/pegjs": "^0.10.0",
     "@types/ramda": "0.0.2",
+    "@types/sinon": "2.3.2",
     "@types/tape": "^4.2.28",
     "@types/uuid": "^2.0.29",
-    "csv-parse": "^1.1.7",
+    "csv-parse": "1.2.1",
     "nodemon": "latest",
     "nyc": "^10.3.2",
     "pegjs": "^0.10.0",
+    "sinon": "2.3.8",
     "tap-spec": "^4.1.1",
     "tape": "^4.6.3",
-    "tslint": "^5.3.2",
-    "typescript": "2.0"
+    "tslint": "5.5.0",
+    "typescript": "2.4.2"
   },
@@ -43,0 +51,0 @@ "dependencies": {

README.md

@@ -1,2 +0,141 @@
-# Queryalizer
-Query serializer, creating a query string from query object.
+# @repositive/query-parser
+
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://choosealicense.com/licenses/lgpl-3.0/)  
+[![npm version](https://badge.fury.io/js/%40repositive%2Fquery-parser.svg)](https://badge.fury.io/js/%40repositive%2Fquery-parser)  
+[![CircleCI](https://circleci.com/gh/repositive/query-parser.svg?style=svg)](https://circleci.com/gh/repositive/query-parser)  
+
+* [Installation](#installation)
+* [Available Serializers](#available-serializers)
+* [Usage](#usage)
+
+The purpose of this library is to transform a search string to a tokenized data structure that can be used to perform analysis on the search input or as an intermediate structure to translate the query into other DSLs or query structures.
+
+**Features:**
+- Basic boolean algebra operators (`AND`, `OR`, `NOT`)
+  - Implicit intersections (`AND`) on non quoted spaces.
+  - Logic grouping with parens
+  > (white or blue) flower not thistle
+- Exact match between quoted strings on non predicated tokens.
+  > flower "white daisy"
+- Predicated/Filtered search
+  > family:Asteraceae population:>100000 england
+
+
+### Installation
+
+**With npm:**
+```bash
+$ npm i @repositive/query-parser
+```
+
+
+### Available Serializers
+
+- Natural Language String
+- ElasticSearch 2.x
+
+
+### Usage
+
+The library exposes the following functions:
+
+**Tree construction**
+- **token**: `(str: string) => Token`
+- **predicate**: `({key: string, value: string}) => Predicate`
+- **and**: `<L extends Node, R extends  Node>({left: L, right: R}) => AND<L, R>`
+- **or**: `<L extends Node, R extends Node>({left: L, right: R}) => OR<L, R>`
+- **not**: `<N extends Node>(negated: N) => NOT<N>`
+
+**Tools**
+- **fold**: `<R>(node: Node, f: (node: Node, l: R, r: R) => R, R) => R`
+- **filter**: `<R> (node: Node, f: (node: Node) => node is R) => R[]`
+- **path**: `(node: Node, target: Node) => Node[]`
+- **remove**: `(node: Node, target: Node) => Node`
+- **replace**: `({on: Node, target: Node, replacement: Node}) => Node`
+
+
+**Parsing natural language string**
+- **fromNatural**: `(str: string) => Node`  
+  _Parses the current string and returns a boolean binary tree representing the search._
+
+**Serialization**
+- **toNatural**: `(tree: Node) => string`  
+  _Serializes a boolean binary tree into a string emulating how a human would write it._
+- **toElastic2**: `(tree: Node) => any`  
+  _Serializes the boolean binary tree into a elasticsearch 2.x query._
+
+```ts
+import QP from 'npm:@repositive/query-parser';
+// var QP = require(`@repositive/query-parser`); non ES6
+/**
+* "fromNatural" will generate the following tree from "is:user Istar NOT profession:developer":
+* {                            
+*   "_id": "6bd6c61f-eab6-43bc-81d2-97f96c7c5f0a",           
+*   "_type": "AND",            
+*   "left": {                  
+*     "_id": "081c058a-e8cc-4ede-9637-6fd6593d5388",         
+*     "_type": "predicate",    
+*     "key": "is",             
+*     "relation": "=",         
+*     "value": "user"          
+*   },                         
+*   "right": {                 
+*     "_id": "4719c7d4-965a-45cc-8132-87ed3acdc560",         
+*     "_type": "AND",          
+*     "left": {                
+*       "_id": "8c8fae87-3aeb-4298-8f29-baf4c761ca12",       
+*       "_type": "token",      
+*       "value": "Istar"       
+*     },                       
+*     "right": {               
+*       "_id": "b0b49e4a-c2cc-4954-bc1d-b68bad17f441",       
+*       "_type": "NOT",        
+*       "negated": {           
+*         "_id": "323596ca-24fa-4ec5-a7a5-0d4d1ed45645",     
+*         "_type": "predicate",                              
+*         "key": "profession", 
+*         "relation": "=",     
+*         "value": "developer" 
+*       }                      
+*     }                        
+*   }                          
+* }         
+*/
+const tree = QP.fromNatural('is:user Istar NOT profession:developer')
+
+/*
+* We can find the profession predicate using the filter function
+*
+*/
+const profession = QP.filter(tree, (n) => n.key === 'profession')[0];
+
+/**
+* If we remove the profession filter with "remove" we expect to end with the following tree:
+* {
+*   value: 'AND',
+*   right: { text: 'Istar' },
+*   left: {predicate: 'is', text: 'user'}
+* }
+*/
+const professional = QP.remove(tree, profession);
+
+/**
+* Adding a new filter (attribute:awesome) to the three will return a new tree with the attribute inserted in the leftmost position
+* {
+*   value: 'AND',
+*   left: { predicate: 'attribute', text: 'awesome'},
+*   right: {
+*     value: 'AND',
+*     right: { text: 'Istar' },
+*     left: { predicate: 'is', text: 'user'}
+*   }
+* }
+*/
+const awesome = QP.and({left: professional, right: QP.predicate({key: 'attribute', value: 'awesome'}));
+
+/**
+* The serialization value of the new tree using "toBoolString" resembles the text as a human would write it:
+* "is:user Istar attribute: awesome"
+*/
+const newQueryString = QP.toNatural(awesome);
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

230185

increased by125.89%

Number of package files

46

increased by43.75%

Lines of code

5514

increased by163.95%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

142

increased by4633.33%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

17

increased by21.43%

Number of low license alerts

3

increased byInfinity%

License quality

70

decreased by-30%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes