ASUPF-239: Change adapter application interface (#32)

* Change adapter application interface

Gives the user more control over the index

* Update README.md

* Minor version upgrade package.json

Via semantic versioning

* Eslint fix :)

* Update packag.json to Minor change

* Backwards compatibility with v1.0.4

* Better readable code

README.md

@@ -61,9 +61,9 @@ const  options = {
 	},
 };
 
-createIndex(data, options);
+const index = createIndex(data, options);
 
-const searchClient = getSearchClient();
+const searchClient = getSearchClient(index);
 ```
 `options` Options are from the ItemsJS API found here: [ItemsJS](https://github.com/itemsapi/itemsjs)
 

__tests__/adapter.test.ts

@@ -83,20 +83,26 @@ describe("getSearchClient", () => {
       },
     ];
 
+    const index = createIndex(products, options);
+
     expect(() => {
-      getSearchClient().searchForFacetValues();
+      getSearchClient(index).searchForFacetValues();
     }).toThrowError(new Error("Not implemented"));
+    expect(getSearchClient(index).search(queries)).toBeDefined();
 
+    expect(() => {
+      getSearchClient().searchForFacetValues();
+    }).toThrowError(new Error("Not implemented"));
     expect(getSearchClient().search(queries)).toBeDefined();
   });
 });
 
 describe("performSearch", () => {
   it("Performs a search", async () => {
-    createIndex(products, options);
+    const index = createIndex(products, options);
 
     const response: Readonly<MultipleQueriesResponse<object>> =
-      await performSearch(requests);
+      await performSearch(requests, index);
 
     expect(response.results[0].hits.length).toBe(per_page || products.length);
     expect(response.results[0].page).toBe(page - 1);
@@ -144,4 +150,13 @@ describe("performSearch", () => {
       price: { min: 7, max: 999, avg: 161.45, sum: 3229 },
     });
   });
+
+  it("Performs no search, when there is no index", async () => {
+    const index = null;
+
+    const response: Readonly<MultipleQueriesResponse<object>> =
+      await performSearch(requests, index);
+
+    expect(response).toBeNull();
+  });
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch-itemsjs-adapter",
-  "version": "1.0.4",
+  "version": "1.1.4",
   "description": "An adapter to use ItemsJs based client-side search with an Algolia Instantsearch front-end.",
   "main": "./lib/adapter",
   "directories": {

src/adapter.ts

@@ -9,21 +9,24 @@ import { ItemsJsOptions, SearchClient } from "./itemsjsInterface";
 
 let index;
 
-export function getSearchClient(): SearchClient {
+export function getSearchClient(newIndex?: any): SearchClient {
   return {
-    search: (queries: MultipleQueriesQuery[]) => performSearch(queries),
+    search: (queries: MultipleQueriesQuery[]) =>
+      performSearch(queries, index || newIndex),
     searchForFacetValues: () => {
       throw new Error("Not implemented");
     },
   };
 }
 
-export function createIndex(data: object, options: ItemsJsOptions): void {
+export function createIndex(data: object, options: ItemsJsOptions): any {
   index = itemsjs(data, options);
+  return index;
 }
 
 export function performSearch(
-  requests: MultipleQueriesQuery[]
+  requests: MultipleQueriesQuery[],
+  index: any
 ): Readonly<Promise<MultipleQueriesResponse<object>>> {
   if (index) {
     let processingTimeMS = 0;
@@ -52,5 +55,6 @@ export function performSearch(
 
     return Promise.resolve({ results: responses });
   }
+
   return null;
 }