feat: correct shape of autocomplete redirect response (#125)

Co-authored-by: Wesley Walser <[email protected]>
sajari · Sep 28, 2021 · f0d10c6 · f0d10c6
1 parent 35ad133
commit f0d10c6
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 24 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@sajari/sdk-js",
   "description": "Sajari JavaScript SDK",
-  "version": "2.1.5",
+  "version": "2.2.0",
   "main": "dist/index.js",
   "umd:main": "dist/sajarisdk.umd.production.js",
   "module": "dist/sajarisdk.esm.production.js",

diff --git a/src/index.ts b/src/index.ts
@@ -299,7 +299,7 @@ class QueryPipeline extends EventEmitter {
   async search(
     values: Record<string, string>,
     tracking?: Tracking
-  ): Promise<[SearchResponse, Record<string, string>]> {
+  ): Promise<[SearchResponse, Record<string, string | Redirects>]> {
     let pt: TrackingProto = { type: TrackingType.None };
     if (tracking !== undefined) {
       const { queryID, ...rest } = tracking;
@@ -453,7 +453,6 @@ class QueryPipeline extends EventEmitter {
         results: results,
         aggregates: aggregates,
         aggregateFilters: aggregateFilters,
-        redirects: jsonProto.redirects,
       },
       jsonProto.values || {},
     ];
@@ -485,10 +484,6 @@ export interface SearchResponse {
    * AggregateFilters computed on the query results (see [[Aggregates]]).
    */
   aggregateFilters: Aggregates;
-  /**
-   * All Redirects for which the current query is a starting substring (see [[Redirects]]).
-   */
-  redirects?: Redirects;
 }
 
 export interface Result {
@@ -562,8 +557,7 @@ export interface SearchResponseProto {
     aggregateFilters: AggregatesProto;
   }>;
   tokens?: TokenProto[];
-  values?: Record<string, string>;
-  redirects?: Redirects;
+  values?: Record<string, string | Redirects>;
 }
 
 /**

diff --git a/src/user-agent.ts b/src/user-agent.ts
@@ -16,6 +16,6 @@ if (scriptTag) {
  * user agent of sdk
  * @hidden
  */
-export const USER_AGENT = ["sajari-sdk-js/2.1.5", suffix]
+export const USER_AGENT = ["sajari-sdk-js/2.2.0", suffix]
   .filter(Boolean)
   .join(" ");
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -63,7 +63,6 @@ describe("Pipeline", () => {
       results: [],
       aggregates: {},
       aggregateFilters: {},
-      redirects: undefined,
     });
 
     expect(fetchMock.mock.calls.length).toEqual(1);
@@ -78,28 +77,26 @@ describe("Pipeline", () => {
         time: "0.003s",
         totalResults: "0",
       },
-      redirects: {
-        "hello world": {
-          id: "1",
-          target: "https://www.google.com",
-          token: "https://re.sajari.com/12345abcd",
+      values: {
+        suggestions: "hello world",
+        redirects: {
+          "hello world": {
+            id: "1",
+            target: "https://www.google.com",
+            token: "https://re.sajari.com/12345abcd",
+          },
         },
       },
     };
     fetchMock.mockResponseOnce(JSON.stringify(responseObj));
 
     const session = new DefaultSession(TrackingType.None, "url");
     const [response, values] = await client
-      .pipeline("test", "test")
+      .pipeline("autocomplete", "test-autocomplete")
       .search({ q: "hello" }, session.next());
 
-    expect(values).toEqual({});
-    expect(response).toStrictEqual({
-      time: 0.003,
-      totalResults: 0,
-      results: [],
-      aggregates: {},
-      aggregateFilters: {},
+    expect(values).toEqual({
+      suggestions: "hello world",
       redirects: {
         "hello world": {
           id: "1",
@@ -108,6 +105,13 @@ describe("Pipeline", () => {
         },
       },
     });
+    expect(response).toStrictEqual({
+      time: 0.003,
+      totalResults: 0,
+      results: [],
+      aggregates: {},
+      aggregateFilters: {},
+    });
 
     expect(fetchMock.mock.calls.length).toEqual(1);
     expect(fetchMock.mock.calls[0][0]).toEqual(