Merge pull request #50 from swiftype/query-suggesetion-support

Query suggestion support
swiftype · Jan 29, 2019 · 26bcf84 · 26bcf84
2 parents cf7d685 + 8fe6bdc
commit 26bcf84
Show file tree

Hide file tree

Showing 30 changed files with 229 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 dist
 node_modules
 npm-debug.log
+yarn-error.log
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ like https://github.com/github/fetch.
 The easiest way to install this client is to simply include the built distribution from the [jsDelivr](https://www.jsdelivr.com/) CDN.
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/swiftype-app-search-javascript@2.2.0/dist/swiftype_app_search.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/swiftype-app-search-javascript@2.3.0/dist/swiftype_app_search.umd.js"></script>
 ```
 
 This will make the client available globally at:

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/click_no_options b/fixtures/host-2376rb.api.swiftype.com-443/click_no_options
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/click.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"tags\":[]}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/click_no_tags b/fixtures/host-2376rb.api.swiftype.com-443/click_no_tags
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/click.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"Cat\",\"document_id\":\"rex-cli\",\"request_id\":\"8b55561954484f13d872728f849ffd22\",\"tags\":[]}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/click_simple b/fixtures/host-2376rb.api.swiftype.com-443/click_simple
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/click.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"Cat\",\"document_id\":\"rex-cli\",\"request_id\":\"8b55561954484f13d872728f849ffd22\",\"tags\":[\"Cat\"]}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license b/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"license\":\"BSD\"}]},\"facets\":{\"dependencies\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license_no_array_syntax b/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license_no_array_syntax
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":{\"type\":\"value\",\"size\":3}},\"analytics\":{\"tags\":[\"Facet-Only\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license b/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_also_deps b/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_also_deps
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_with_override_tags b/fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_with_override_tags
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"FromSERP\",\"Disjunctive\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/multi_search b/fixtures/host-2376rb.api.swiftype.com-443/multi_search
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/multi_search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"queries\":[{\"query\":\"cat\",\"page\":{\"size\":1}},{\"query\":\"dog\"}]}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/multi_search_error b/fixtures/host-2376rb.api.swiftype.com-443/multi_search_error
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/multi_search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"queries\":[{\"query\":\"cat\",\"invalid\":\"parameter\"},{\"query\":\"dog\",\"another\":\"parameter\"}]}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion b/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion
@@ -0,0 +1,31 @@
+POST /api/as/v1/engines/node-modules/query_suggestion
+authorization: Bearer api-hean6g8dmxnm2shqqiag757a
+content-type: application/json
+x-swiftype-client: swiftype-app-search-javascript
+x-swiftype-client-version: 2.3.0
+accept: */*
+accept-encoding: gzip,deflate
+body: {\"query\":\"cat\"}
+
+HTTP/1.1 200 OK
+date: Tue, 29 Jan 2019 18:08:51 GMT
+content-type: application/json; charset=utf-8
+transfer-encoding: chunked
+connection: close
+vary: Accept-Encoding, Origin
+status: 200 OK
+x-frame-options: SAMEORIGIN
+x-xss-protection: 1; mode=block
+x-content-type-options: nosniff
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2399
+etag: W/"7bbbb718dc1cca4a9911412b186b6b3e"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 0750887ae5330b6c0234b6098f4459e8
+x-runtime: 0.353357
+x-swiftype-frontend-datacenter: dal05
+x-swiftype-frontend-node: web01.dal05
+x-swiftype-edge-datacenter: dal05
+x-swiftype-edge-node: web01.dal05
+
+{"results":{"documents":[{"suggestion":"catwalk"},{"suggestion":"catcher"},{"suggestion":"https://github.com/stuartpb/catcher"},{"suggestion":"categories"},{"suggestion":"categories for"},{"suggestion":"categories for javascript"},{"suggestion":"http://lcfrs.org/cats"},{"suggestion":"cats"},{"suggestion":"https://github.com/luciferous/cats"},{"suggestion":"cat4d"}]},"meta":{"request_id":"0750887ae5330b6c0234b6098f4459e8"}}
diff --git a/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion_bad_options b/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion_bad_options
@@ -0,0 +1,30 @@
+POST /api/as/v1/engines/node-modules/query_suggestion
+authorization: Bearer api-hean6g8dmxnm2shqqiag757a
+content-type: application/json
+x-swiftype-client: swiftype-app-search-javascript
+x-swiftype-client-version: 2.3.0
+accept: */*
+accept-encoding: gzip,deflate
+body: {\"query\":\"cat\",\"bad\":\"option\"}
+
+HTTP/1.1 400 Bad Request
+date: Tue, 29 Jan 2019 18:11:16 GMT
+content-type: application/json; charset=utf-8
+transfer-encoding: chunked
+connection: close
+status: 400 Bad Request
+x-frame-options: SAMEORIGIN
+x-xss-protection: 1; mode=block
+x-content-type-options: nosniff
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2399
+vary: Origin
+cache-control: no-cache
+x-request-id: 3dc07facebb356d29cfb26e9e3d50ec0
+x-runtime: 0.127407
+x-swiftype-frontend-datacenter: dal05
+x-swiftype-frontend-node: web01.dal05
+x-swiftype-edge-datacenter: dal05
+x-swiftype-edge-node: web01.dal05
+
+{"errors":["Options contains invalid key: bad"]}
diff --git a/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion_with_options b/fixtures/host-2376rb.api.swiftype.com-443/query_suggestion_with_options
@@ -0,0 +1,31 @@
+POST /api/as/v1/engines/node-modules/query_suggestion
+authorization: Bearer api-hean6g8dmxnm2shqqiag757a
+content-type: application/json
+x-swiftype-client: swiftype-app-search-javascript
+x-swiftype-client-version: 2.3.0
+accept: */*
+accept-encoding: gzip,deflate
+body: {\"query\":\"cat\",\"size\":3,\"types\":{\"documents\":{\"fields\":[\"name\"]}}}
+
+HTTP/1.1 200 OK
+date: Tue, 29 Jan 2019 18:14:07 GMT
+content-type: application/json; charset=utf-8
+transfer-encoding: chunked
+connection: close
+vary: Accept-Encoding, Origin
+status: 200 OK
+x-frame-options: SAMEORIGIN
+x-xss-protection: 1; mode=block
+x-content-type-options: nosniff
+x-ratelimit-limit: 2400
+x-ratelimit-remaining: 2399
+etag: W/"b0c17abeee72f6e440978d1c979df21a"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 28aa2fbd5ee7e2cbcbb1535c9e85ecfb
+x-runtime: 0.314690
+x-swiftype-frontend-datacenter: dal05
+x-swiftype-frontend-node: web01.dal05
+x-swiftype-edge-datacenter: dal05
+x-swiftype-edge-node: web01.dal05
+
+{"results":{"documents":[{"suggestion":"catwalk"},{"suggestion":"cats"},{"suggestion":"cat4d"}]},"meta":{"request_id":"28aa2fbd5ee7e2cbcbb1535c9e85ecfb"}}
diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_facet b/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_facet
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{\"license\":[\"BSD\"]},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_multi_facet b/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_multi_facet
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{\"license\":\"BSD\"},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}],\"dependencies\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_multi_facet_with_tags b/fixtures/host-2376rb.api.swiftype.com-443/search_filter_and_multi_facet_with_tags
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{\"license\":\"BSD\"},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}],\"dependencies\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"SERP\"]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_grouped b/fixtures/host-2376rb.api.swiftype.com-443/search_grouped
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"group\":{\"field\":\"license\"}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_missing_query b/fixtures/host-2376rb.api.swiftype.com-443/search_missing_query
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_multi_facet b/fixtures/host-2376rb.api.swiftype.com-443/search_multi_facet
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}],\"dependencies\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_multi_filter_multi_facet b/fixtures/host-2376rb.api.swiftype.com-443/search_multi_filter_multi_facet
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{\"all\":[{\"license\":\"BSD\"},{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}],\"dependencies\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_multi_filter_multi_facet_no_array_syntax b/fixtures/host-2376rb.api.swiftype.com-443/search_multi_filter_multi_facet_no_array_syntax
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{\"all\":[{\"license\":\"BSD\"},{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":{\"type\":\"value\",\"size\":3},\"dependencies\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_simple b/fixtures/host-2376rb.api.swiftype.com-443/search_simple
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\"}

diff --git a/fixtures/host-2376rb.api.swiftype.com-443/search_with_license_facet b/fixtures/host-2376rb.api.swiftype.com-443/search_with_license_facet
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\",\"page\":{\"size\":1},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]}}

diff --git a/fixtures/localhost.swiftype.com-3002/localhost_search b/fixtures/localhost.swiftype.com-3002/localhost_search
@@ -2,7 +2,7 @@ POST /api/as/v1/engines/node-modules/search.json
 authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: swiftype-app-search-javascript
-x-swiftype-client-version: 2.2.0
+x-swiftype-client-version: 2.3.0
 accept: */*
 accept-encoding: gzip,deflate
 body: {\"query\":\"cat\"}

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "swiftype-app-search-javascript",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Javascript client for the Swiftype App Search Api",
   "browser": "dist/swiftype_app_search.umd.js",
   "main": "dist/swiftype_app_search.umd.js",

diff --git a/src/client.js b/src/client.js
@@ -51,9 +51,29 @@ export default class Client {
       : `https://${hostIdentifier}.api.swiftype.com/api/as/v1/`;
     this.searchPath = `engines/${this.engineName}/search`;
     this.multiSearchPath = `engines/${this.engineName}/multi_search`;
+    this.querySuggestionPath = `engines/${this.engineName}/query_suggestion`;
     this.clickPath = `engines/${this.engineName}/click`;
   }
 
+  /**
+   * Sends a query suggestion request to the Swiftype App Search Api
+   *
+   * @param {String} query String that is used to perform a query suggest.
+   * @param {Object} options Object used for configuring the query suggest, like 'types' or 'size'
+   * @returns {Promise<ResultList>} a Promise that returns results, otherwise throws an Error.
+   */
+  querySuggestion(query, options = {}) {
+    const params = Object.assign({ query: query }, options);
+
+    return request(
+      this.searchKey,
+      this.apiEndpoint,
+      this.querySuggestionPath,
+      params,
+      this.cacheResponses
+    ).then(handleErrorResponse);
+  }
+
   /**
    * Sends a search request to the Swiftype App Search Api
    *