Fix aql.literal

Author: pluma

src/aql-query.ts

@@ -1,11 +1,20 @@
-export type AqlQuery = {
+import { ArangoCollection, isArangoCollection } from "./collection";
+
+export interface AqlQuery {
   query: string;
   bindVars: { [key: string]: any };
-};
+}
 
-export type AqlLiteral = {
+export interface AqlLiteral {
   toAQL: () => string;
-};
+}
+
+export type AqlValue =
+  | string
+  | number
+  | boolean
+  | ArangoCollection
+  | AqlLiteral;
 
 export function isAqlQuery(query: any): query is AqlQuery {
   return Boolean(query && query.query && query.bindVars);
@@ -15,21 +24,24 @@ export function isAqlLiteral(literal: any): literal is AqlLiteral {
   return Boolean(literal && typeof literal.toAQL === "function");
 }
 
-export function aql(strings: TemplateStringsArray, ...args: any[]): AqlQuery {
+export function aql(
+  strings: TemplateStringsArray,
+  ...args: AqlValue[]
+): AqlQuery {
   const bindVars: AqlQuery["bindVars"] = {};
   const bindVals = [];
   let query = strings[0];
   for (let i = 0; i < args.length; i++) {
     const rawValue = args[i];
     let value = rawValue;
-    if (rawValue && typeof rawValue.toAQL === "function") {
+    if (isAqlLiteral(rawValue)) {
       query += `${rawValue.toAQL()}${strings[i + 1]}`;
       continue;
     }
     const index = bindVals.indexOf(rawValue);
     const isKnown = index !== -1;
     let name = `value${isKnown ? index : bindVals.length}`;
-    if (rawValue && rawValue.isArangoCollection) {
+    if (isArangoCollection(rawValue)) {
       name = `@${name}`;
       value = rawValue.name;
     }
@@ -42,4 +54,10 @@ export function aql(strings: TemplateStringsArray, ...args: any[]): AqlQuery {
   return { query, bindVars };
 }
 
-aql.literal = (value: any) => ({toAQL () {return value;}});
+export namespace aql {
+  export const literal = (value: any): AqlLiteral => ({
+    toAQL() {
+      return String(value);
+    }
+  });
+}

src/test/05-aql-queries.ts

@@ -1,8 +1,7 @@
-import { Database, aql } from "../arangojs";
-
-import { ArangoError } from "../error";
-import { ArrayCursor } from "../cursor";
 import { expect } from "chai";
+import { aql, Database } from "../arangojs";
+import { ArrayCursor } from "../cursor";
+import { ArangoError } from "../error";
 
 describe("AQL queries", function() {
   // create database takes 11s in a standard cluster
@@ -134,7 +133,7 @@ describe("AQL queries", function() {
   });
   describe("aql", () => {
     it("correctly handles simple parameters", () => {
-      let values = [
+      let values: any[] = [
         0,
         42,
         -1,
@@ -190,7 +189,7 @@ describe("AQL queries", function() {
         name = "tomato";
       }
       let collection = new ArangoCollection();
-      let query = aql`${collection}`;
+      let query = aql`${collection as any}`;
       expect(query.query).to.equal("@@value0");
       expect(Object.keys(query.bindVars)).to.eql(["@value0"]);
       expect(query.bindVars["@value0"]).to.equal("tomato");