Merge pull request #7 from afosto/Feature/change-proxy-id-to-search-e…

…ngine-key

Feature/change-proxy-id-to-search-engine-key

README.md

@@ -47,28 +47,28 @@ This library supports the **last two** versions of major browsers (Chrome, Edge,
 
 ## Getting started
 
-First you initialize the Afosto search client with your **proxy key**. This proxy key can be found in the Afosto app.
+First you initialize the Afosto search client with your **search engine key**. This search engine key can be found in the Afosto app.
 
 ### ES6
 
 ```js
 import { afostoInstantSearch } from '@afosto/instant-search-client';
 
-const client = afostoInstantSearch('proxy-key');
+const client = afostoInstantSearch('my-search-engine-key');
 ```
 
 ### CJS
 
 ```js
 const { afostoInstantSearch } = require('@afosto/instant-search-client');
 
-const client = afostoInstantSearch('proxy-key');
+const client = afostoInstantSearch('my-search-engine-key');
 ```
 
 ### Browser
 
 ```js
-const client = afostoInstantSearch('proxy-key');
+const client = afostoInstantSearch('my-search-engine-key');
 ```
 
 ## Usage
@@ -78,7 +78,7 @@ const client = afostoInstantSearch('proxy-key');
 ### Basic
 
 ```js
-const client = afostoInstantSearch('proxy-key');
+const client = afostoInstantSearch('my-search-engine-key');
 const search = instantsearch({
   indexName: 'my-index',
   searchClient: client,
@@ -97,7 +97,7 @@ You can use the initialized Afosto client with the [React InstantSearch](https:/
 import { afostoInstantSearch } from '@afosto/instant-search-client';
 import { InstantSearch, SearchBox, Hits } from 'react-instantsearch-dom';
 
-const searchClient = afostoInstantSearch('proxy-key');
+const searchClient = afostoInstantSearch('my-search-engine-key');
 
 const App = () => (
   <InstantSearch searchClient={searchClient} indexName="my-index">

src/afostoInstantSearch.js

@@ -3,22 +3,22 @@ import { DEFAULT_OPTIONS } from './constants';
 
 /**
  * Afosto instant search client
- * @param {String} proxyId
+ * @param {String} searchEngineKey
  * @param {Object} options
  * @returns {Object}
  * @constructor
  */
-const afostoInstantSearch = (proxyId, options) => {
-  if (!proxyId) {
-    throw new Error('A proxyId is required to use the Afosto instant search client.')
+const afostoInstantSearch = (searchEngineKey, options = {}) => {
+  if (!searchEngineKey) {
+    throw new Error('A search engine key is required to use the Afosto instant search client.')
   }
 
   const clientOptions = { ...DEFAULT_OPTIONS, ...(options ?? {}) };
   const searchRequestAdapter = SearchRequestAdapter();
   const searchResponseAdapter = SearchResponseAdapter();
 
   const searchRequest = async context => {
-    const url = clientOptions.baseUrl?.replace('{proxyId}', proxyId);
+    const url = clientOptions.baseUrl?.replace('{key}', searchEngineKey);
     const requestOptions = clientOptions.requestOptions || {};
     const hasContextFormatter = clientOptions.transformContext && typeof clientOptions.transformContext === 'function';
     const hasResponseFormatter = clientOptions.transformResponse && typeof clientOptions.transformResponse === 'function';

src/constants.js

@@ -1,6 +1,6 @@
 export const DEFAULT_OPTIONS = {
   allowEmptyQuery: true,
-  baseUrl: 'https://afosto.io/api/instant/search/{proxyId}',
+  baseUrl: 'https://afosto.io/api/instant/search/{key}',
   hitsPerPage: 10,
   requestOptions: {},
   threshold: 1,