From d0690b0216fa5cae8c958112efde9c500895758a Mon Sep 17 00:00:00 2001
From: Jonathon Herbert <jonathon.herbert@guardian.co.uk>
Date: Wed, 10 Jul 2024 17:23:16 +0100
Subject: [PATCH] Add description to frontend; factor typeahead suggestions out
 of Typeahead service

---
 build.sbt                                     |   2 +-
 project/build.properties                      |   2 +-
 prosemirror-client/src/cqlInput/CqlInput.ts   |  18 +--
 .../src/cqlInput/TypeaheadPopover.ts          |   5 +-
 prosemirror-client/src/cqlInput/testUtils.ts  |   0
 prosemirror-client/src/services/CqlService.ts |   2 +-
 src/main/scala/Handler.scala                  |  12 +-
 src/main/scala/HttpServer.scala               |   9 +-
 src/main/scala/lang/Cql.scala                 |   7 +-
 src/main/scala/lang/Typeahead.scala           | 114 +++---------------
 .../scala/lang/TypeaheadHelpersCapi.scala     | 106 ++++++++++++++++
 .../scala/lang/TypeaheadQueryClient.scala     |   8 --
 .../scala/lang/TypeaheadQueryClientCapi.scala |  40 ------
 src/test/scala/lang/CqlTest.scala             |   5 +-
 .../scala/lang/TestTypeaheadHelpers.scala     |  35 ++++++
 .../scala/lang/TypeaheadQueryClientTest.scala |  15 ---
 src/test/scala/lang/TypeaheadTest.scala       |  42 +++++--
 17 files changed, 229 insertions(+), 193 deletions(-)
 create mode 100644 prosemirror-client/src/cqlInput/testUtils.ts
 create mode 100644 src/main/scala/lang/TypeaheadHelpersCapi.scala
 delete mode 100644 src/main/scala/lang/TypeaheadQueryClient.scala
 delete mode 100644 src/main/scala/lang/TypeaheadQueryClientCapi.scala
 create mode 100644 src/test/scala/lang/TestTypeaheadHelpers.scala
 delete mode 100644 src/test/scala/lang/TypeaheadQueryClientTest.scala

diff --git a/build.sbt b/build.sbt
index d9dc159..80db5aa 100644
--- a/build.sbt
+++ b/build.sbt
@@ -35,7 +35,7 @@ val circeVersion = "0.14.4"
 lazy val cql = project.in(file("."))
   .enablePlugins(RiffRaffArtifact)
   .settings(
-    scalaVersion := "3.3.1",
+    scalaVersion := "3.4.2",
     libraryDependencies ++= Seq(
       "org.apache.pekko" %% "pekko-actor-typed" % PekkoVersion,
       "org.apache.pekko" %% "pekko-stream" % PekkoVersion,
diff --git a/project/build.properties b/project/build.properties
index 04267b1..ee4c672 100644
--- a/project/build.properties
+++ b/project/build.properties
@@ -1 +1 @@
-sbt.version=1.9.9
+sbt.version=1.10.1
diff --git a/prosemirror-client/src/cqlInput/CqlInput.ts b/prosemirror-client/src/cqlInput/CqlInput.ts
index 2420141..4b0c756 100644
--- a/prosemirror-client/src/cqlInput/CqlInput.ts
+++ b/prosemirror-client/src/cqlInput/CqlInput.ts
@@ -2,8 +2,8 @@ import { CqlServiceInterface } from "../services/CqlService";
 import { QueryChangeEventDetail } from "./dom";
 import { createEditor } from "./editor";
 
-const baseFontSize = "28px";
-const baseBorderRadius = "5px";
+const baseFontSize = 28;
+const baseBorderRadius = 5;
 const template = document.createElement("template");
 template.innerHTML = `
   <style>
@@ -21,7 +21,7 @@ template.innerHTML = `
       display: inline-flex;
       background-color: rgba(255,255,255,0.2);
       margin: 0 5px;
-      border-radius: ${baseBorderRadius};
+      border-radius: ${baseBorderRadius}px;
     }
 
     chip {
@@ -53,18 +53,18 @@ template.innerHTML = `
     #cql-input {
       position: relative;
       padding: 5px;
-      font-size: ${baseFontSize};
+      font-size: ${baseFontSize}px;
       anchor-name: --cql-input;
       border: 2px solid grey;
-      border-radius: ${baseBorderRadius};
+      border-radius: ${baseBorderRadius}px;
     }
 
     #cql-popover {
-      width: 250px;
+      width: 500px;
       margin: 0;
       padding: 0;
       top: anchor(end);
-      font-size: ${baseFontSize};
+      font-size: ${baseFontSize}px;
       position-anchor: --cql-input;
     }
 
@@ -81,6 +81,10 @@ template.innerHTML = `
       cursor: pointer;
     }
 
+    .Cql__OptionDescription {
+      font-size: ${baseFontSize * 0.8}px;
+    }
+
     .Cql__ChipWrapper--is-pending-delete chip {
       background-color: darkred;
     }
diff --git a/prosemirror-client/src/cqlInput/TypeaheadPopover.ts b/prosemirror-client/src/cqlInput/TypeaheadPopover.ts
index db4323a..3598203 100644
--- a/prosemirror-client/src/cqlInput/TypeaheadPopover.ts
+++ b/prosemirror-client/src/cqlInput/TypeaheadPopover.ts
@@ -8,6 +8,7 @@ import { TextSelection } from "prosemirror-state";
 type MenuItem = {
   label: string;
   value: string;
+  description: string;
 };
 
 export class TypeaheadPopover {
@@ -134,10 +135,10 @@ export class TypeaheadPopover {
 
   private updateItems(items: MenuItem[]) {
     this.popoverEl.innerHTML = items
-      .map(({ label }, index) => {
+      .map(({ label, description }, index) => {
         return `<div class="Cql__Option ${
           index === this.currentOptionIndex ? "Cql__Option--is-selected" : ""
-        }" data-index="${index}">${label}</div>`;
+        }" data-index="${index}"><div class="Cql__OptionLabel">${label}</div><div class="Cql__OptionDescription">${description}</div></div>`;
       })
       .join("");
   }
diff --git a/prosemirror-client/src/cqlInput/testUtils.ts b/prosemirror-client/src/cqlInput/testUtils.ts
new file mode 100644
index 0000000..e69de29
diff --git a/prosemirror-client/src/services/CqlService.ts b/prosemirror-client/src/services/CqlService.ts
index 88651f5..9efbc74 100644
--- a/prosemirror-client/src/services/CqlService.ts
+++ b/prosemirror-client/src/services/CqlService.ts
@@ -24,7 +24,7 @@ type Suggestions = {
 };
 
 type TextSuggestion = { suggestions: Array<TextSuggestionOption> };
-type TextSuggestionOption = { label: string; value: string };
+type TextSuggestionOption = { label: string; value: string, description: string };
 type DateSuggestion = { validFrom?: string; validTo?: string };
 
 export interface CqlServiceInterface {
diff --git a/src/main/scala/Handler.scala b/src/main/scala/Handler.scala
index da1cc7b..f91553d 100644
--- a/src/main/scala/Handler.scala
+++ b/src/main/scala/Handler.scala
@@ -8,13 +8,14 @@ import com.amazonaws.services.lambda.runtime.events.{
 import io.circe.generic.auto._
 import io.circe.syntax._
 import util.Logging
-import cql.lang.Cql
+
 import scala.util.Try
 import scala.concurrent.Await
 import scala.concurrent.duration.DurationInt
 import scala.jdk.CollectionConverters._
 import scala.concurrent.Future
-
+import com.gu.contentapi.client.GuardianContentClient
+import cql.lang.{Cql, Typeahead, TypeaheadHelpersCapi}
 class Handler
     extends RequestHandler[
       APIGatewayProxyRequestEvent,
@@ -24,7 +25,12 @@ class Handler
     with QueryJson {
   private implicit val ec: scala.concurrent.ExecutionContext =
     scala.concurrent.ExecutionContext.global
-  private val cql = new Cql()
+
+  val guardianContentClient = new GuardianContentClient("test")
+  val typeaheadHelpers = new TypeaheadHelpersCapi(guardianContentClient)
+  val typeahead = new Typeahead(typeaheadHelpers.fieldResolvers, typeaheadHelpers.outputModifierResolvers)
+  
+  private val cql = new Cql(typeahead)
 
   def handleRequest(
       event: APIGatewayProxyRequestEvent,
diff --git a/src/main/scala/HttpServer.scala b/src/main/scala/HttpServer.scala
index 5b8f0f1..a9cb2ed 100644
--- a/src/main/scala/HttpServer.scala
+++ b/src/main/scala/HttpServer.scala
@@ -10,10 +10,15 @@ import io.circe.syntax.*
 import com.github.pjfanning.pekkohttpcirce.*
 import scala.io.StdIn
 import scala.util.{Failure, Success, Try}
-import cql.lang.Cql
+import cql.lang.{Cql, Typeahead, TypeaheadHelpersCapi}
+import com.gu.contentapi.client.GuardianContentClient
 
 object HttpServer extends QueryJson {
-  val cql = new Cql()
+  val guardianContentClient = new GuardianContentClient("test")
+  val typeaheadHelpers = new TypeaheadHelpersCapi(guardianContentClient)
+  val typeahead = new Typeahead(typeaheadHelpers.fieldResolvers, typeaheadHelpers.outputModifierResolvers)
+
+  val cql = new Cql(typeahead)
 
   def run(): Unit = {
 
diff --git a/src/main/scala/lang/Cql.scala b/src/main/scala/lang/Cql.scala
index bf177b4..f07a114 100644
--- a/src/main/scala/lang/Cql.scala
+++ b/src/main/scala/lang/Cql.scala
@@ -1,10 +1,7 @@
 package cql.lang
 
-import scala.io.Source
 import scala.util.{Failure, Success, Try}
-import cql.lang.QueryList
 import io.circe.generic.semiauto.*
-import io.circe.Encoder
 
 import scala.concurrent.Future
 import com.gu.contentapi.client.GuardianContentClient
@@ -19,12 +16,10 @@ case class CqlResult(
     error: Option[String] = None
 )
 
-class Cql:
+class Cql(typeahead: Typeahead):
   implicit val ec: scala.concurrent.ExecutionContext =
     scala.concurrent.ExecutionContext.global
   val guardianContentClient = new GuardianContentClient("test")
-  val typeaheadClient = new TypeaheadQueryClientTest()
-  val typeahead = new Typeahead(typeaheadClient)
 
   def run(program: String): Future[CqlResult] =
     val scanner = new Scanner(program)
diff --git a/src/main/scala/lang/Typeahead.scala b/src/main/scala/lang/Typeahead.scala
index 2116034..d4222fd 100644
--- a/src/main/scala/lang/Typeahead.scala
+++ b/src/main/scala/lang/Typeahead.scala
@@ -32,14 +32,8 @@ type TypeaheadResolver = (String => Future[List[TextSuggestionOption]]) |
 
 type TypeaheadType = "TEXT" | "DATE"
 
-class Typeahead(client: TypeaheadQueryClient) {
-  private val typeaheadTokenResolverMap = Map(
-    TokenType.QUERY_FIELD_KEY -> suggestFieldKey,
-    TokenType.QUERY_OUTPUT_MODIFIER_KEY -> suggestOutputModifierKey,
-    TokenType.QUERY_VALUE -> suggestFieldValue
-  )
-
   case class TypeaheadField(
+      id: String,
       name: String,
       description: String,
       resolver: TypeaheadResolver,
@@ -56,88 +50,20 @@ class Typeahead(client: TypeaheadQueryClient) {
     def toSuggestionOption: TextSuggestionOption =
       TextSuggestionOption(name, name, description)
 
-  private val typeaheadFieldResolverMap = Map(
-    "tag" -> TypeaheadField(
-      "Tag",
-      "Search by content tags, e.g. sport/football",
-      suggestTags
-    ),
-    "section" -> TypeaheadField(
-      "Section",
-      "Search by content sections, e.g. section/news",
-      suggestSections
-    )
+class Typeahead(fieldResolvers: List[TypeaheadField], outputModifierResolvers: List[TypeaheadField]) {
+  private val typeaheadTokenResolverMap = Map(
+    TokenType.QUERY_FIELD_KEY -> suggestFieldKey,
+    TokenType.QUERY_OUTPUT_MODIFIER_KEY -> suggestOutputModifierKey,
+    TokenType.QUERY_VALUE -> suggestFieldValue
   )
 
-  private val typeaheadFieldResolverEntries = TextSuggestion(
-    typeaheadFieldResolverMap.map {
-      case (value, TypeaheadField(label, description, _, _)) =>
-        TextSuggestionOption(label, value, description)
+  private val typeaheadFieldEntries = TextSuggestion(
+    fieldResolvers.map {
+      case TypeaheadField(id, label, description, _, _) =>
+        TextSuggestionOption(label, id, description)
     }.toList
   )
 
-  private val typeaheadOutputModifierResolvers = List(
-    TypeaheadField(
-      "show-fields",
-      "Determine the list of fields to return",
-      List(
-        TextSuggestionOption("all", "all", "Description"),
-        TextSuggestionOption("trailText", "trailText", "Description"),
-        TextSuggestionOption("headline", "headline", "Description"),
-        TextSuggestionOption(
-          "showInRelatedContent",
-          "showInRelatedContent",
-          "Description"
-        ),
-        TextSuggestionOption("body", "body", "Description"),
-        TextSuggestionOption("lastModified", "lastModified", "Description"),
-        TextSuggestionOption(
-          "hasStoryPackage",
-          "hasStoryPackage",
-          "Description"
-        ),
-        TextSuggestionOption("score", "score", "Description"),
-        TextSuggestionOption("standfirst", "standfirst", "Description"),
-        TextSuggestionOption("shortUrl", "shortUrl", "Description"),
-        TextSuggestionOption("thumbnail", "thumbnail", "Description"),
-        TextSuggestionOption("wordcount", "wordcount", "Description"),
-        TextSuggestionOption("commentable", "commentable", "Description"),
-        TextSuggestionOption("isPremoderated", "isPremoderated", "Description"),
-        TextSuggestionOption("allowUgc", "allowUgc", "Description"),
-        TextSuggestionOption("byline", "byline", "Description"),
-        TextSuggestionOption("publication", "publication", "Description"),
-        TextSuggestionOption(
-          "internalPageCode",
-          "internalPageCode",
-          "Description"
-        ),
-        TextSuggestionOption(
-          "productionOffice",
-          "productionOffice",
-          "Description"
-        ),
-        TextSuggestionOption(
-          "shouldHideAdverts",
-          "shouldHideAdverts",
-          "Description"
-        ),
-        TextSuggestionOption(
-          "liveBloggingNow",
-          "liveBloggingNow",
-          "Description"
-        ),
-        TextSuggestionOption(
-          "commentCloseDate",
-          "commentCloseDate",
-          "Description"
-        ),
-        TextSuggestionOption("starRating", "starRating", "Description")
-      )
-    ),
-    TypeaheadField("from-date", "The date to search from", List.empty),
-    TypeaheadField("to-date", "The date to search to", List.empty)
-  )
-
   def getSuggestions(
       program: QueryList
   ): Future[List[TypeaheadSuggestion]] =
@@ -235,10 +161,10 @@ class Typeahead(client: TypeaheadQueryClient) {
 
   private def suggestFieldKey(str: String): TextSuggestion =
     str match
-      case "" => typeaheadFieldResolverEntries
+      case "" => typeaheadFieldEntries
       case str =>
-        typeaheadFieldResolverEntries.copy(
-          suggestions = typeaheadFieldResolverEntries.suggestions
+        typeaheadFieldEntries.copy(
+          suggestions = typeaheadFieldEntries.suggestions
             .filter(_.value.contains(str.toLowerCase()))
         )
 
@@ -246,15 +172,15 @@ class Typeahead(client: TypeaheadQueryClient) {
       key: String,
       str: String
   ): Future[List[TextSuggestionOption]] =
-    typeaheadFieldResolverMap
-      .get(key)
+    fieldResolvers
+      .find(_.id == key)
       .map(_.resolveSuggestions(str))
       .getOrElse(Future.successful(List.empty))
 
   private def suggestOutputModifierKey(str: String): Future[TextSuggestion] =
     Future.successful(
       TextSuggestion(
-        typeaheadOutputModifierResolvers
+        outputModifierResolvers
           .filter(
             _.name.contains(str.toLowerCase())
           )
@@ -266,7 +192,7 @@ class Typeahead(client: TypeaheadQueryClient) {
       key: String,
       str: String
   ): Future[TextSuggestion | DateSuggestion] =
-    typeaheadOutputModifierResolvers.find(_.name == key) match
+    outputModifierResolvers.find(_.name == key) match
       case Some(typeaheadField) if typeaheadField.suggestionType == "TEXT" =>
         typeaheadField.resolveSuggestions(str).map { suggestions =>
           TextSuggestion(
@@ -282,10 +208,4 @@ class Typeahead(client: TypeaheadQueryClient) {
       case Some(typeaheadField) if typeaheadField.suggestionType == "DATE" =>
         Future.successful(DateSuggestion(None, None))
       case _ => Future.successful(TextSuggestion(List.empty))
-
-  private def suggestTags(str: String) =
-    client.getTags(str)
-
-  private def suggestSections(str: String) =
-    client.getSections(str)
 }
diff --git a/src/main/scala/lang/TypeaheadHelpersCapi.scala b/src/main/scala/lang/TypeaheadHelpersCapi.scala
new file mode 100644
index 0000000..3130712
--- /dev/null
+++ b/src/main/scala/lang/TypeaheadHelpersCapi.scala
@@ -0,0 +1,106 @@
+package cql.lang
+
+import scala.concurrent.Future
+import com.gu.contentapi.client.{ContentApiClient, GuardianContentClient}
+import scala.concurrent.ExecutionContext.Implicits.global
+
+class TypeaheadHelpersCapi(client: GuardianContentClient) {
+
+  val fieldResolvers = List(
+    TypeaheadField(
+      "tag",
+      "Tag",
+      "Search by content tags, e.g. sport/football",
+      getTags
+    ),
+    TypeaheadField(
+      "section",
+      "Section",
+      "Search by content sections, e.g. section/news",
+      getSections
+    )
+  )
+
+  val outputModifierResolvers = List(
+    TypeaheadField(
+      "show-fields",
+      "Show fields",
+      "Determine the list of fields to return",
+      List(
+        TextSuggestionOption("all", "all", "Description"),
+        TextSuggestionOption("trailText", "trailText", "Description"),
+        TextSuggestionOption("headline", "headline", "Description"),
+        TextSuggestionOption(
+          "showInRelatedContent",
+          "showInRelatedContent",
+          "Description"
+        ),
+        TextSuggestionOption("body", "body", "Description"),
+        TextSuggestionOption("lastModified", "lastModified", "Description"),
+        TextSuggestionOption(
+          "hasStoryPackage",
+          "hasStoryPackage",
+          "Description"
+        ),
+        TextSuggestionOption("score", "score", "Description"),
+        TextSuggestionOption("standfirst", "standfirst", "Description"),
+        TextSuggestionOption("shortUrl", "shortUrl", "Description"),
+        TextSuggestionOption("thumbnail", "thumbnail", "Description"),
+        TextSuggestionOption("wordcount", "wordcount", "Description"),
+        TextSuggestionOption("commentable", "commentable", "Description"),
+        TextSuggestionOption("isPremoderated", "isPremoderated", "Description"),
+        TextSuggestionOption("allowUgc", "allowUgc", "Description"),
+        TextSuggestionOption("byline", "byline", "Description"),
+        TextSuggestionOption("publication", "publication", "Description"),
+        TextSuggestionOption(
+          "internalPageCode",
+          "internalPageCode",
+          "Description"
+        ),
+        TextSuggestionOption(
+          "productionOffice",
+          "productionOffice",
+          "Description"
+        ),
+        TextSuggestionOption(
+          "shouldHideAdverts",
+          "shouldHideAdverts",
+          "Description"
+        ),
+        TextSuggestionOption(
+          "liveBloggingNow",
+          "liveBloggingNow",
+          "Description"
+        ),
+        TextSuggestionOption(
+          "commentCloseDate",
+          "commentCloseDate",
+          "Description"
+        ),
+        TextSuggestionOption("starRating", "starRating", "Description")
+      )
+    ),
+    TypeaheadField("from-date", "From date", "The date to search from", List.empty),
+    TypeaheadField("to-date","To date", "The date to search to", List.empty)
+  )
+
+  private def getTags(str: String): Future[List[TextSuggestionOption]] =
+    val query = str match
+      case ""  => ContentApiClient.tags
+      case str => ContentApiClient.tags.q(str)
+    client.getResponse(query).map { response =>
+      response.results.map { tag =>
+        TextSuggestionOption(tag.webTitle, tag.id, tag.description.getOrElse(""))
+      }.toList
+    }
+
+  private def getSections(str: String): Future[List[TextSuggestionOption]] =
+    val query = str match
+      case ""  => ContentApiClient.sections
+      case str => ContentApiClient.sections.q(str)
+    client.getResponse(query).map { response =>
+      response.results.map { section =>
+        TextSuggestionOption(section.webTitle, section.id, section.webTitle)
+      }.toList
+    }
+}
diff --git a/src/main/scala/lang/TypeaheadQueryClient.scala b/src/main/scala/lang/TypeaheadQueryClient.scala
deleted file mode 100644
index cff0f88..0000000
--- a/src/main/scala/lang/TypeaheadQueryClient.scala
+++ /dev/null
@@ -1,8 +0,0 @@
-package cql.lang
-
-import scala.concurrent.Future
-
-trait TypeaheadQueryClient {
-  def getTags(str: String): Future[List[TextSuggestionOption]]
-  def getSections(str: String): Future[List[TextSuggestionOption]]
-}
diff --git a/src/main/scala/lang/TypeaheadQueryClientCapi.scala b/src/main/scala/lang/TypeaheadQueryClientCapi.scala
deleted file mode 100644
index 8891fbb..0000000
--- a/src/main/scala/lang/TypeaheadQueryClientCapi.scala
+++ /dev/null
@@ -1,40 +0,0 @@
-package cql.lang
-
-import scala.concurrent.Future
-import com.gu.contentapi.client.{ContentApiClient, GuardianContentClient}
-import scala.concurrent.ExecutionContext.Implicits.global
-
-class TypeaheadQueryCapiClient(client: GuardianContentClient)
-    extends TypeaheadQueryClient {
-  def getTags(str: String): Future[List[TextSuggestionOption]] =
-    val query = str match
-      case ""  => ContentApiClient.tags
-      case str => ContentApiClient.tags.q(str)
-    client.getResponse(query).map { response =>
-      response.results.map { tag =>
-        TextSuggestionOption(tag.webTitle, tag.id, tag.description.getOrElse(""))
-      }.toList
-    }
-
-  def getSections(str: String): Future[List[TextSuggestionOption]] =
-    val query = str match
-      case ""  => ContentApiClient.sections
-      case str => ContentApiClient.sections.q(str)
-    client.getResponse(query).map { response =>
-      response.results.map { section =>
-        TextSuggestionOption(section.webTitle, section.id, section.webTitle)
-      }.toList
-    }
-}
-
-class TypeaheadQueryClientTest extends TypeaheadQueryClient {
-  def getTags(str: String): Future[List[TextSuggestionOption]] =
-    Future.successful(
-      List(TextSuggestionOption("Tags are magic", "tags-are-magic", "A magic tag"))
-    )
-
-  def getSections(str: String): Future[List[TextSuggestionOption]] =
-    Future.successful(
-      List(TextSuggestionOption("Also sections", "sections-are-magic", "Sections are less magic"))
-    )
-}
diff --git a/src/test/scala/lang/CqlTest.scala b/src/test/scala/lang/CqlTest.scala
index 97bd1f3..06d72ab 100644
--- a/src/test/scala/lang/CqlTest.scala
+++ b/src/test/scala/lang/CqlTest.scala
@@ -4,7 +4,10 @@ import concurrent.ExecutionContext.Implicits.global // Todo: sticking plaster
 
 class CqlTest extends BaseTest {
   describe("a program") {
-    val cql = new Cql()
+    val typeaheadHelpers = new TestTypeaheadHelpers()
+    val typeahead = new Typeahead(typeaheadHelpers.fieldResolvers, List.empty)
+
+    val cql = new Cql(typeahead)
     it("should produce a query string") {
       cql.run("+section:commentisfree").map { result =>
         result.queryResult shouldBe Some("section=commentisfree")
diff --git a/src/test/scala/lang/TestTypeaheadHelpers.scala b/src/test/scala/lang/TestTypeaheadHelpers.scala
new file mode 100644
index 0000000..06f55c7
--- /dev/null
+++ b/src/test/scala/lang/TestTypeaheadHelpers.scala
@@ -0,0 +1,35 @@
+package cql.lang
+
+import scala.concurrent.Future
+
+class TestTypeaheadHelpers {
+ val fieldResolvers = List(
+    TypeaheadField(
+      "tag",
+      "Tag",
+      "Search by content tags, e.g. sport/football",
+      getTags
+    ),
+    TypeaheadField(
+      "section",
+      "Section",
+      "Search by content sections, e.g. section/news",
+      getSections
+    )
+  )
+
+  val outputModifierResolvers = List(
+    TypeaheadField("from-date", "From date", "The date to search from", List.empty),
+    TypeaheadField("to-date","To date", "The date to search to", List.empty)
+  )
+
+  private def getTags(str: String): Future[List[TextSuggestionOption]] =
+    Future.successful(
+      List(TextSuggestionOption("Tags are magic", "tags-are-magic", "A magic tag"))
+    )
+
+  private def getSections(str: String): Future[List[TextSuggestionOption]] =
+    Future.successful(
+      List(TextSuggestionOption("Also sections", "sections-are-magic", "Sections are less magic"))
+    )
+}
diff --git a/src/test/scala/lang/TypeaheadQueryClientTest.scala b/src/test/scala/lang/TypeaheadQueryClientTest.scala
deleted file mode 100644
index 7bf9b5a..0000000
--- a/src/test/scala/lang/TypeaheadQueryClientTest.scala
+++ /dev/null
@@ -1,15 +0,0 @@
-package cql.lang
-
-import scala.concurrent.Future
-
-class TypeaheadQueryClientTest extends TypeaheadQueryClient {
-  def getTags(str: String): Future[List[TextSuggestionOption]] =
-    Future.successful(
-      List(TextSuggestionOption("Tags are magic", "tags-are-magic"))
-    )
-
-  def getSections(str: String): Future[List[TextSuggestionOption]] =
-    Future.successful(
-      List(TextSuggestionOption("Also sections", "sections-are-magic"))
-    )
-}
diff --git a/src/test/scala/lang/TypeaheadTest.scala b/src/test/scala/lang/TypeaheadTest.scala
index 40f68d1..05c55a1 100644
--- a/src/test/scala/lang/TypeaheadTest.scala
+++ b/src/test/scala/lang/TypeaheadTest.scala
@@ -4,10 +4,10 @@ import scala.concurrent.Future
 import scala.concurrent.ExecutionContext.Implicits.global
 
 class TypeaheadTest extends BaseTest {
-
   describe("typeahead") {
-    val typeaheadQueryClient = new TypeaheadQueryClientTest()
-    val typeahead = new Typeahead(typeaheadQueryClient)
+    val typeaheadQueryClient = new TestTypeaheadHelpers()
+    val typeahead =
+      new Typeahead(typeaheadQueryClient.fieldResolvers, List.empty)
 
     it("should give no typeahead where none is warranted") {
       typeahead.getSuggestions(QueryList(List.empty)).map { result =>
@@ -47,7 +47,11 @@ class TypeaheadTest extends BaseTest {
               ":",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("Tag", "tag")
+                  TextSuggestionOption(
+                    "Tag",
+                    "tag",
+                    "Search by content tags, e.g. sport/football"
+                  )
                 )
               )
             )
@@ -74,7 +78,11 @@ class TypeaheadTest extends BaseTest {
               ":",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("Tag", "tag")
+                  TextSuggestionOption(
+                    "Tag",
+                    "tag",
+                    "Search by content tags, e.g. sport/football"
+                  )
                 )
               )
             ),
@@ -84,7 +92,11 @@ class TypeaheadTest extends BaseTest {
               " ",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("Tags are magic", "tags-are-magic")
+                  TextSuggestionOption(
+                    "Tags are magic",
+                    "tags-are-magic",
+                    "A magic tag"
+                  )
                 )
               )
             )
@@ -111,7 +123,11 @@ class TypeaheadTest extends BaseTest {
               ":",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("Tag", "tag")
+                  TextSuggestionOption(
+                    "Tag",
+                    "tag",
+                    "Search by content tags, e.g. sport/football"
+                  )
                 )
               )
             ),
@@ -121,7 +137,11 @@ class TypeaheadTest extends BaseTest {
               " ",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("Tags are magic", "tags-are-magic")
+                  TextSuggestionOption(
+                    "Tags are magic",
+                    "tags-are-magic",
+                    "A magic tag"
+                  )
                 )
               )
             )
@@ -144,7 +164,11 @@ class TypeaheadTest extends BaseTest {
               ":",
               TextSuggestion(
                 List(
-                  TextSuggestionOption("from-date", "from-date")
+                  TextSuggestionOption(
+                    "from-date",
+                    "from-date",
+                    "The date to search from"
+                  )
                 )
               )
             ),