edit: readme and export issues

Author: hp4k1h5

README.md

@@ -1,2 +1,80 @@
 # AQLqueryBuilder.js
-a typescript query builder for [arangodb](https://www.arangodb.com)'s [ArangoSearch](https://www.arangodb.com/docs/stable/arangosearch.html) 
+> a typescript query builder for [arangodb](https://www.arangodb.com)'s [ArangoSearch](https://www.arangodb.com/docs/stable/arangosearch.html)
+
+## overview
+ArangoSearch provides a high-level API for interacting with Arango Search Views
+through the Arango Query Language (AQL). This library aims to provide a query
+parser and AQL query builder to enable full boolean search operations across
+all available Arango Search View capabilities, including, `PHRASE` and
+`TOKENS` operations. With minimal syntax overhead the user can generate
+multi-lingual and language-specific, complex phrase, proximity and tokenized
+search terms.
+
+For example, passing a search phrase like: `+mandatory -exclude ?"optional
+phrase"` to `buildAQL`, will produce the following query:
+```aql
+FOR doc IN search_view
+
+  SEARCH
+    MIN_MATCH(
+      ANALYZER(
+        TOKENS(@value0, @value1)
+        ALL IN doc.@value2, @value1),
+    @value3) OR (MIN_MATCH(
+      ANALYZER(
+        TOKENS(@value0, @value1)
+        ALL IN doc.@value2, @value1),
+    @value3) AND @value4)
+
+     AND
+
+     MIN_MATCH(
+      ANALYZER(
+        TOKENS(@value5, @value1)
+        NONE IN doc.@value2, @value1),
+    @value3)
+
+    OPTIONS @value6
+      SORT TFIDF(doc) DESC
+
+      LIMIT @value7, @value8
+  RETURN doc
+```
+This query will retrieve all documents that __include__ the term "mandatory"
+AND __do not include__ the term "exclude", AND whose ranking will be boosted by the
+presence of the phrase "optional phrase". If no mandatory or exclude terms are
+provided, optional terms are considered required, so as not to retrieve all
+documents.
+
+## setup
+## installation
+## usage
+### query object
+
+`buildAQL` accepts an object with the following properties:
+Example:
+```json
+{
+  "view": "the_arango-search_view-name",
+  "collections": [
+    {
+      "name":
+      "collection_name", "analyzer":
+       "analyzer_name"
+    }
+  ],
+  "query": "either a +query ?\"string for parseQuery to parse\"",
+  "query": [
+           {"type": "phr", "op": "?", "val": "\"or a list of query objects\""},
+           {"type": "tok", "op": "-", "val": "tokens"}
+         ],
+  "limit":
+    {
+      "start": 0,
+      "end": 20,
+    }
+}
+```
+### default query syntax
+## bugs
+## contributing

package.json

@@ -1,12 +1,29 @@
 {
-  "name": "aql-js-andsorsnots",
+  "name": "@hp4k1h5/aqlquerybuilder.js",
   "version": "0.0.1",
   "license": "MIT",
+  "main": "./built/index.d.ts",
   "scripts": {
     "test": "mocha -r ts-node/register",
     "tests": "mocha -r ts-node/register 'tests/*.ts'",
     "doc": "typedoc src/"
   },
+  "homepage": "https://github.com/HP4k1h5/AQLqueryBuilder.js",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:HP4k1h5/AQLqueryBuilder.js.git"
+  },
+  "description": "a typescript query builder for the Arango Query Language (AQL) via ArangoSearch",
+  "keywords": [
+    "AQL",
+    "arangojs",
+    "arangodb",
+    "ArangoSearch",
+    "nodeJs",
+    "query-builder",
+    "query-parser",
+    "typescript"
+  ],
   "dependencies": {
     "arangojs": "^6.14.1"
   },
@@ -19,5 +36,7 @@
     "ts-node": "^8.10.2",
     "typedoc": "^0.17.7",
     "typescript": "^3.9.5"
-  }
+  },
+  "author": "HP4k1h5",
+  "email": "robertwalks@gmail.com"
 }

src/index.ts

@@ -17,6 +17,7 @@ export function buildAQL(query: query, limit: any = { start: 0, end: 20 }): any
       LIMIT ${limit.start}, ${limit.end}
     RETURN doc`
 }
+exports.buildAQL = buildAQL
 
 function validateQuery(query: query) {
   if (!query.view.length) throw Error('query.view must be a valid ArangoSearch View name')

tests/bool.ts

@@ -96,4 +96,20 @@ describe("boolean search logic", () => {
             expect(result).to.deep.equal({ a: 1 })
         })
     })
+    describe('ORS', () => {
+        it(`should exclude all results that do not match required terms`, async () => {
+            const query = {
+                view: view.name,
+                collections: [{
+                    name: collectionName,
+                    analyzer: 'text_en'
+                }],
+                terms: '+mandatory -exclude ?"optional phrase"'
+            }
+            const aqlQuery = buildAQL(query)
+            expect(aqlQuery.query).to.equal('')
+
+        })
+    })
+
 })

tests/search.ts

@@ -2,33 +2,33 @@ import { expect } from 'chai'
 import { buildSearch } from '../src/search'
 
 describe('search.js', () => {
-    it('should export a function named buildSearch', () => {
-        expect(buildSearch).to.be.a('function')
-    })
+  it('should export a function named buildSearch', () => {
+    expect(buildSearch).to.be.a('function')
+  })
 
-    it('should return SEARCH true when terms: is an empty string', () => {
-        const query = { view: 'search_view', collections: [{ name: 'coll', analyzer: 'text_en' }], terms: '' }
-        const builtSearch = buildSearch(query)
+  it('should return SEARCH true when terms: is an empty string', () => {
+    const query = { view: 'search_view', collections: [ { name: 'coll', analyzer: 'text_en' } ], terms: '' }
+    const builtSearch = buildSearch(query)
 
-        expect(builtSearch).to.be.an('object')
-        expect(Object.keys(builtSearch.bindVars)).to.have.length(2)
-        expect(builtSearch.bindVars.value0).to.equal(true)
-        expect(builtSearch.bindVars.value1).to.deep.equal({ collections: ['coll'] })
-    })
+    expect(builtSearch).to.be.an('object')
+    expect(Object.keys(builtSearch.bindVars)).to.have.length(2)
+    expect(builtSearch.bindVars.value0).to.equal(true)
+    expect(builtSearch.bindVars.value1).to.deep.equal({ collections: [ 'coll' ] })
+  })
 
-    it('should return an array of aql objects', () => {
-        const query = { view: 'search_view', collections: [{ name: 'coll', analyzer: 'text_en' }], terms: '-a +"query string" ?token' }
-        const builtSearch = buildSearch(query)
+  it('should return an array of aql objects', () => {
+    const query = { view: 'search_view', collections: [ { name: 'coll', analyzer: 'text_en' } ], terms: '-a +"query string" ?token' }
+    const builtSearch = buildSearch(query)
 
-        expect(Object.keys(builtSearch.bindVars)).to.have.length(7)
-        expect(builtSearch.bindVars.value0[0].query).to.equal('PHRASE(doc.text, @value0, @value1)')
-        expect(builtSearch.bindVars.value1).to.deep.equal('token')
-        expect(builtSearch.bindVars.value2).to.deep.equal('text_en')
-        expect(builtSearch.bindVars.value3).to.deep.equal('text')
-        expect(builtSearch.bindVars.value4).to.deep.equal(1)
-        expect(builtSearch.bindVars.value5).to.deep.equal('a')
-        expect(builtSearch.bindVars.value6).to.deep.equal({ collections: [query.collections[0].name] })
-        expect(builtSearch.query).to.equal(`
+    expect(Object.keys(builtSearch.bindVars)).to.have.length(7)
+    expect(builtSearch.bindVars.value0[ 0 ].query).to.equal('PHRASE(doc.text, @value0, @value1)')
+    expect(builtSearch.bindVars.value1).to.deep.equal('token')
+    expect(builtSearch.bindVars.value2).to.deep.equal('text_en')
+    expect(builtSearch.bindVars.value3).to.deep.equal('text')
+    expect(builtSearch.bindVars.value4).to.deep.equal(1)
+    expect(builtSearch.bindVars.value5).to.deep.equal('a')
+    expect(builtSearch.bindVars.value6).to.deep.equal({ collections: [ query.collections[ 0 ].name ] })
+    expect(builtSearch.query).to.equal(`
   SEARCH 
     @value0 OR (@value0 AND MIN_MATCH(
       ANALYZER(
@@ -46,5 +46,11 @@ describe('search.js', () => {
     
     OPTIONS @value6
       SORT TFIDF(doc) DESC`)
-    })
+  })
+
+  it('should return an array of aql objects', () => {
+    const query = { view: 'search_view', collections: [ { name: 'coll', analyzer: 'text_en' } ], terms: '+mandatory -exclude ?"optional phrase"' }
+    const builtSearch = buildSearch(query)
+    expect(builtSearch.query).to.equal(``)
+  }).skip()
 })

tsconfig.json

@@ -2,16 +2,12 @@
   "compilerOptions": {
     "outDir": "./built",
     "allowJs": true,
-    "target": "es5",
+    "target": "ES2015",
+    "module": "CommonJS",
     "declaration": true,
     "emitDeclarationOnly": true
   },
   "include": [
     "./src/**/*"
-  ],
-  "exclude": [
-    "./built/",
-    "./node_modules/",
-    "./tests/"
   ]
 }