edit: bump npm, fix tests

Author: hp4k1h5

package.json

@@ -28,16 +28,16 @@
     "typescript"
   ],
   "dependencies": {
-    "arangojs": "^7.7.0"
+    "arangojs": "^8.0.0"
   },
   "devDependencies": {
     "@types/chai": "^4.3.0",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.18",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.9",
     "chai": "^4.3.6",
-    "mocha": "^9.2.1",
+    "mocha": "^10.1.0",
     "ts-node": "^10.5.0",
-    "typedoc": "^0.22.12",
+    "typedoc": "^0.23.20",
     "typedoc-plugin-markdown": "^3.11.14",
     "typescript": "^4.5.5"
   },

src/filter.ts

@@ -1,12 +1,12 @@
-import { aql } from 'arangojs'
+import { aql, literal, join } from 'arangojs/aql'
 import { Filter } from './lib/structs'
 
 export function buildFilters(filters: Filter[]) {
   if (!filters.length) return
 
   let _filters = filters.map(
-    (f: Filter) => aql`doc.${f.field} ${aql.literal(f.op)} ${f.val}`,
+    (f: Filter) => aql`doc.${f.field} ${literal(f.op)} ${f.val}`,
   )
 
-  return aql`FILTER ${aql.join(_filters, ' && ')}`
+  return aql`FILTER ${join(_filters, ' && ')}`
 }

src/index.ts

@@ -1,5 +1,5 @@
-import { aql } from 'arangojs'
-import { query } from './lib/structs'
+import { aql, literal } from 'arangojs/aql'
+import { Query } from './lib/structs'
 import { buildSearch } from './search'
 import { buildFilters } from './filter'
 export { buildFilters } from './filter'
@@ -14,7 +14,7 @@ export { parseQuery } from './parse'
  * <https://www.arangodb.com/docs/stable/aql/operations-limit.html> @param
  * limit is an object with keys `start` @default 0, and `count` @default 20 */
 export function buildAQL(
-  query: query,
+  query: Query,
   limit: any = { start: 0, count: 20 },
 ): any {
   validateQuery(query)
@@ -25,21 +25,21 @@ export function buildAQL(
 
   /* FOR doc IN ${query.view} */
   return aql`
-    FOR doc IN ${aql.literal(query.view)}
+    FOR doc IN ${literal(query.view)}
       ${SEARCH}
       ${FILTER}
       LIMIT ${limit.start}, ${limit.count}
     RETURN doc`
 }
 
-function validateQuery(query: query) {
+function validateQuery(query: Query) {
   if (!query.view.length)
     throw new Error('query.view must be a valid ArangoSearch View name')
   if (!query.collections.length)
     throw new Error('query.collections must have at least one name')
 }
 
-function collectKeys(query: query) {
+function collectKeys(query: Query) {
   /* unify query.key */
   let _keys: string[]
   if (typeof query.key == 'string') {

src/lib/structs.ts

@@ -2,7 +2,7 @@
  * passed to buildAQL, i.e. `let generatedAQL = buildAQL(query)`. Properties
  * mimic or match those familiar to AQL.
  * */
-export interface query {
+export interface Query {
   /**
    * the name of the ArangoSearch View the query will be run against
    * */
@@ -11,7 +11,7 @@ export interface query {
    * the names and analyzers  of the collections indexed by @param
    * view to query
    * */
-  collections: collection[]
+  collections: Collection[]
   /**
    * either an array of @param term interfaces or a string to be parsed by `parseQuery()`
    * */
@@ -40,7 +40,7 @@ export interface query {
  * In either case all desired collection/analyzer combinations must be
  * specified.
  * */
-export interface collection {
+export interface Collection {
   /** the name of the collection */
   name: string
   /** the name of the text analyzer */

src/search.ts

@@ -1,8 +1,8 @@
-import { aql } from 'arangojs'
-import { query, collection, Term, Type } from './lib/structs'
+import { aql, literal, join } from 'arangojs/aql'
+import { Query, Collection, Term, Type } from './lib/structs'
 import { parseQuery } from './parse'
 
-export function buildSearch(query: query): any {
+export function buildSearch(query: Query): any {
   /* parse string query */
   query.terms =
     typeof query.terms == 'string' ? parseQuery(query.terms) : query.terms
@@ -18,9 +18,9 @@ export function buildSearch(query: query): any {
     ORS = undefined
   }
   if (!!NOTS) {
-    NOTS = aql`${ANDS || ORS ? aql.literal(' AND ') : undefined} 
-    ${NOTS.phrases ? aql.literal(' NOT ') : undefined} ${NOTS.phrases}
-    ${NOTS.phrases && NOTS.tokens ? aql.literal(' AND ') : undefined} ${
+    NOTS = aql`${ANDS || ORS ? literal(' AND ') : undefined} 
+    ${NOTS.phrases ? literal(' NOT ') : undefined} ${NOTS.phrases}
+    ${NOTS.phrases && NOTS.tokens ? literal(' AND ') : undefined} ${
       NOTS.tokens
     }`
   }
@@ -36,7 +36,7 @@ export function buildSearch(query: query): any {
       OPTIONS { collections: ${cols} }
       SORT TFIDF(doc) DESC`
 }
-function buildOps(collections: collection[], terms: Term[], op: string): any {
+function buildOps(collections: Collection[], terms: Term[], op: string): any {
   const opWord: string = op == '+' ? ' AND ' : ' OR '
 
   let queryTerms: any = terms.filter((t: Term) => t.op == op)
@@ -52,24 +52,24 @@ function buildOps(collections: collection[], terms: Term[], op: string): any {
 
   /* if (!phrases && !tokens) return */
   if (op == '-') return { phrases, tokens }
-  if (phrases && tokens) return aql.join([phrases, tokens], opWord)
+  if (phrases && tokens) return join([phrases, tokens], opWord)
   return tokens || phrases
 }
 
 function buildPhrases(
   phrases: Term[],
-  collections: collection[],
+  collections: Collection[],
   opWord: string,
 ): any {
   if (!phrases.length) return undefined
 
-  return aql.join(
+  return join(
     phrases.map((phrase: any) => buildPhrase(phrase, collections)),
     opWord,
   )
 }
 
-function buildPhrase(phrase: Term, collections: collection[]): any {
+function buildPhrase(phrase: Term, collections: Collection[]): any {
   const phrases = []
   collections.forEach((coll) =>
     coll.keys.forEach((k: string) =>
@@ -78,10 +78,10 @@ function buildPhrase(phrase: Term, collections: collection[]): any {
       ),
     ),
   )
-  return aql`(${aql.join(phrases, ' OR ')})`
+  return aql`(${join(phrases, ' OR ')})`
 }
 
-function buildTokens(tokens: Term[], collections: collection[]): any {
+function buildTokens(tokens: Term[], collections: Collection[]): any {
   if (!tokens.length) return
 
   const opWordMap = {
@@ -102,12 +102,12 @@ function buildTokens(tokens: Term[], collections: collection[]): any {
     analyzer: string,
     keys: string[],
   ) => {
-    return aql.join(
+    return join(
       keys.map(
         (k) => aql`
       ANALYZER(
         TOKENS(${tokens}, ${analyzer})
-        ${aql.literal(op)} IN doc.${k}, ${analyzer})`,
+        ${literal(op)} IN doc.${k}, ${analyzer})`,
       ),
       ' OR ',
     )
@@ -122,6 +122,6 @@ function buildTokens(tokens: Term[], collections: collection[]): any {
     )
   })
 
-  return aql`MIN_MATCH(${aql.join(remapped, ', ')}, 
+  return aql`MIN_MATCH(${join(remapped, ', ')}, 
     ${tokens[0].op === '-' ? collections.length : 1})`
 }

tests/bool.ts

@@ -1,29 +1,28 @@
 import { expect } from 'chai'
-import { Database, aql } from 'arangojs'
+import { Database } from 'arangojs/database'
+import { aql, literal } from 'arangojs/aql'
 
 import { buildAQL } from '../src/index'
+import { Query } from '../src/lib/structs'
+import { View } from 'arangojs/view'
 
 const ARANGO_URL = process.env.TEST_ARANGODB_URL || 'http://127.0.0.1:8529'
 
 describe('boolean search logic', () => {
   let db: Database
-  let collection
-  let view
+  let collection: string | number | boolean | Record<string, any> | null | undefined
+  let view: View
   let date = new Date().valueOf()
   const dbName = `testdb_${date}`
   const collectionName = `coll_${date}`
 
   before(async () => {
     /* create db */
     db = new Database({ url: ARANGO_URL, databaseName: '_system' })
-    try {
-      await db.createDatabase(dbName)
-    } catch (e) {
-      // console.error('could not create test db', e)
-      console.error(e)
-    }
 
-    db = new Database({ url: ARANGO_URL, databaseName: dbName })
+    await db.createDatabase(dbName)
+    db.database(dbName)
+
     /* create coll */
     collection = db.collection(collectionName)
     await collection.create()
@@ -37,7 +36,10 @@ describe('boolean search logic', () => {
         text_es: { analyzers: ['text_es'] },
       },
     }
-    await view.create({ links })
+    await view.create({
+      links,
+      type: 'arangosearch'
+    })
     let info = await view.get()
     expect(info.name).to.equal(view.name)
 
@@ -83,7 +85,7 @@ describe('boolean search logic', () => {
     await wait(1600)
 
     const getAllInViewQuery = aql`
-    FOR doc in ${aql.literal(info.name)}
+    FOR doc in ${literal(info.name)}
       RETURN doc`
     let allResults = await db.query(getAllInViewQuery)
     let all = await allResults.batches.all()
@@ -93,7 +95,7 @@ describe('boolean search logic', () => {
 
   after(async () => {
     try {
-      db.useDatabase('_system')
+      db = db.database('_system')
       await db.dropDatabase(dbName)
       /* should get deleted when dropping db */
       /* await view.drop() */
@@ -179,7 +181,7 @@ describe('boolean search logic', () => {
       await cursor.next()
 
       /* english */
-      query.key = ['text_en', 'text_es']
+      query.key = ['text_en', 'text_es'] as any
       query.terms = '+"in document"'
       aqlQuery = buildAQL(query)
       expect(aqlQuery.bindVars.value0).to.equal('text_en')
@@ -195,7 +197,7 @@ describe('boolean search logic', () => {
 
       /* should match 1 document */
       query.terms = '+"across  "  '
-      query.key = ['text_en', 'text_es']
+      query.key = ['text_en', 'text_es'] as any
       cursor = await db.query(buildAQL(query))
 
       result = await cursor.all()
@@ -211,7 +213,7 @@ describe('boolean search logic', () => {
       cursor = await db.query(buildAQL(query))
 
       /* multikey */
-      query.key = ['text', 'text_es']
+      query.key = ['text', 'text_es'] as any
       query.terms = '+"buscar"'
 
       let q = buildAQL(query)
@@ -371,7 +373,7 @@ describe('boolean search logic', () => {
   describe('NOTS', () => {
     it(`should bring back results *not* matching NOT'ed values
        when -'ed PHRASE's are passed`, async () => {
-      const query = {
+      const query: Query = {
         view: view.name,
         collections: [
           {
@@ -387,7 +389,7 @@ describe('boolean search logic', () => {
         ],
         /*  should bring back 1 result */
         terms: '  -"sample  " word  ',
-        key: ['text_en', , 'text_es'],
+        key: ['text_en', , 'text_es'] as any,
       }
 
       /* should bring back 1 results */