refactor: client and store interface

packages/snap-client/README.md

@@ -150,7 +150,7 @@ const clientConfig = {
 
 const client = new Client(globals, clientConfig);
 
-const results = await client.search({
+const response = await client.search({
   search: {
     query: {
       string: 'dress'
@@ -163,7 +163,7 @@ const results = await client.search({
 ```typescript
 const client = new Client(globals, clientConfig);
 
-const [meta, results] = await client.search({
+const { meta, results } = await client.search({
   search: {
     query: {
       string: 'dress'
@@ -178,7 +178,7 @@ Makes a request to the Searchspring Search API and returns a promise.
 ```typescript
 const client = new Client(globals, clientConfig);
 
-const [meta, results] = await client.search({
+const { meta, results } = await client.search({
   search: {
     query: {
       string: 'dress'
@@ -193,7 +193,7 @@ Makes a request to the Searchspring Autocomplete API and returns a promise.
 ```typescript
 const client = new Client(globals, clientConfig);
 
-const [meta, results] = await client.autocomplete({
+const { meta, results } = await client.autocomplete({
   suggestions: {
     count: 5
   },
@@ -219,7 +219,7 @@ Makes a request to the Searchspring Trending API and returns a promise.
 
 ```typescript
 const client = new Client(globals, clientConfig);
-const results = await client.trending({
+const trending = await client.trending({
   siteId: 'abc123',
   limit: 5
 });
@@ -230,7 +230,7 @@ Makes a request to the Searchspring finder API and returns a promise.
 
 ```typescript
 const client = new Client(globals, clientConfig);
-const [meta, results] = await client.finder({
+const { meta, results } = await client.finder({
   filters: [{
     type: "value",
     field: "color",
@@ -245,7 +245,7 @@ Makes a request to the Searchspring Recommend API and returns a promise.
 
 ```typescript
 const client = new Client(globals, clientConfig);
-const results = await client.recommend({
+const { profile, meta, recommend } = await client.recommend({
   tag: 'similar',
   siteId: 'abc123',
   products: ['product123'],

packages/snap-client/src/Client/Client.ts

@@ -7,7 +7,8 @@ import type {
 	TrendingRequestModel,
 	TrendingResponseModel,
 	ProfileRequestModel,
-	RecommendCombinedResponseModel,
+	ProfileResponseModel,
+	RecommendResponseModel,
 	RecommendRequestModel,
 } from '../types';
 
@@ -143,26 +144,29 @@ export class Client {
 		return this.requesters.meta.getMeta(params);
 	}
 
-	async autocomplete(params: AutocompleteRequestModel = {}): Promise<[MetaResponseModel, AutocompleteResponseModel]> {
+	async autocomplete(params: AutocompleteRequestModel = {}): Promise<{ meta: MetaResponseModel; search: AutocompleteResponseModel }> {
 		if (!params.search?.query?.string) {
 			throw 'query string parameter is required';
 		}
 
 		params = deepmerge(this.globals, params);
 
-		return Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.autocomplete.getAutocomplete(params)]);
+		const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.autocomplete.getAutocomplete(params)]);
+		return { meta, search };
 	}
 
-	async search(params: SearchRequestModel = {}): Promise<[MetaResponseModel, SearchResponseModel]> {
+	async search(params: SearchRequestModel = {}): Promise<{ meta: MetaResponseModel; search: SearchResponseModel }> {
 		params = deepmerge(this.globals, params);
 
-		return Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getSearch(params)]);
+		const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getSearch(params)]);
+		return { meta, search };
 	}
 
-	async finder(params: SearchRequestModel = {}): Promise<[MetaResponseModel, SearchResponseModel]> {
+	async finder(params: SearchRequestModel = {}): Promise<{ meta: MetaResponseModel; search: SearchResponseModel }> {
 		params = deepmerge(this.globals, params);
 
-		return Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.finder.getFinder(params)]);
+		const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.finder.getFinder(params)]);
+		return { meta, search };
 	}
 
 	async trending(params: Partial<TrendingRequestModel>): Promise<TrendingResponseModel> {
@@ -171,7 +175,9 @@ export class Client {
 		return this.requesters.suggest.getTrending(params as TrendingRequestModel);
 	}
 
-	async recommend(params: RecommendRequestModel): Promise<RecommendCombinedResponseModel> {
+	async recommend(
+		params: RecommendRequestModel
+	): Promise<{ meta: MetaResponseModel; profile: ProfileResponseModel; recommend: RecommendResponseModel }> {
 		const { tag, ...otherParams } = params;
 		if (!tag) {
 			throw 'tag parameter is required';
@@ -193,16 +199,16 @@ export class Client {
 			siteId: params.siteId || this.globals.siteId,
 		};
 
-		const [meta, profile, recommendations] = await Promise.all([
+		const [meta, profile, recommend] = await Promise.all([
 			this.meta(params.siteId ? { siteId: params.siteId } : undefined),
 			this.requesters.recommend.getProfile(profileParams),
 			this.requesters.recommend.batchRecommendations(recommendParams),
 		]);
 
 		return {
-			...profile,
 			meta,
-			results: recommendations[0] && recommendations[0].results,
+			profile,
+			recommend,
 		};
 	}
 }

packages/snap-client/src/Client/apis/Abstract.ts

@@ -34,15 +34,15 @@ export class API {
 		return this.configuration.mode;
 	}
 
-	protected async request(context: RequestOpts, cacheKey?: string): Promise<Response> {
+	protected async request<T>(context: RequestOpts, cacheKey?: string): Promise<T> {
 		const { url, init } = this.createFetchParams(context);
 
 		if (cacheKey) {
 			const cachedResponse = this.cache.get(`${context.path}/${cacheKey}`) || this.cache.get(`${context.path}/*`);
 			if (cachedResponse) {
 				this.retryCount = 0; // reset count and delay incase rate limit occurs again before a page refresh
 				this.retryDelay = 1000;
-				return cachedResponse;
+				return cachedResponse as T;
 			}
 		}
 		let response;

packages/snap-client/src/Client/apis/Legacy.ts

@@ -31,7 +31,7 @@ export class LegacyAPI extends API {
 
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<MetaResponseModel>(
 			{
 				path: '/api/meta/meta.json',
 				method: 'POST',
@@ -41,13 +41,13 @@ export class LegacyAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as MetaResponseModel;
+		return response;
 	}
 
 	async getMeta(queryParameters: MetaRequestModel): Promise<MetaResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 
-		const response = await this.request(
+		const response = await this.request<MetaResponseModel>(
 			{
 				path: '/api/meta/meta.json',
 				method: 'GET',
@@ -57,7 +57,7 @@ export class LegacyAPI extends API {
 			JSON.stringify(queryParameters)
 		);
 
-		return response as MetaResponseModel;
+		return response;
 	}
 
 	async getSearch(queryParameters: any): Promise<any> {

packages/snap-client/src/Client/apis/Recommend.test.ts

@@ -537,8 +537,8 @@ describe('Recommend Api', () => {
 
 		const [response1, response2] = await Promise.all([promise1, promise2]);
 
-		expect(response1[0].results.length).toBe(response[1].results.length);
-		expect(response2[0].results.length).toBe(response[0].results.length);
+		expect(response1.results.length).toBe(response[1].results.length);
+		expect(response2.results.length).toBe(response[0].results.length);
 
 		requestMock.mockReset();
 	});

packages/snap-client/src/Client/apis/Recommend.ts

@@ -40,7 +40,7 @@ export class RecommendAPI extends API {
 	async getProfile(queryParameters: ProfileRequestModel): Promise<ProfileResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 
-		const response = await this.request(
+		const response = await this.request<ProfileResponseModel>(
 			{
 				path: '/api/personalized-recommendations/profile.json',
 				method: 'GET',
@@ -50,7 +50,7 @@ export class RecommendAPI extends API {
 			JSON.stringify(queryParameters)
 		);
 
-		return response as unknown as ProfileResponseModel;
+		return response;
 	}
 
 	async batchRecommendations(parameters: RecommendRequestModel): Promise<RecommendResponseModel> {
@@ -149,7 +149,7 @@ export class RecommendAPI extends API {
 				const response = await this.postRecommendations(batch.request as RecommendPostRequestModel);
 
 				batch.entries?.forEach((entry, index) => {
-					entry.deferred.resolve([response[index]]);
+					entry.deferred.resolve(response[index]);
 				});
 			} catch (err) {
 				batch.entries?.forEach((entry) => {
@@ -161,14 +161,14 @@ export class RecommendAPI extends API {
 		return deferred.promise;
 	}
 
-	async postRecommendations(requestParameters: RecommendPostRequestModel): Promise<RecommendResponseModel> {
+	async postRecommendations(requestParameters: RecommendPostRequestModel): Promise<RecommendResponseModel[]> {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'text/plain';
 
 		const siteId = requestParameters.siteId;
 		const path = `/boost/${siteId}/recommend`;
 
-		const response = await this.request(
+		const response = await this.request<RecommendResponseModel[]>(
 			{
 				path,
 				method: 'POST',
@@ -178,7 +178,7 @@ export class RecommendAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as unknown as RecommendResponseModel;
+		return response;
 	}
 }
 

packages/snap-client/src/Client/apis/Snap.ts

@@ -15,7 +15,7 @@ export class SnapAPI extends API {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<MetaResponseModel>(
 			{
 				path: '/api/v1/meta',
 				method: 'POST',
@@ -25,14 +25,14 @@ export class SnapAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as MetaResponseModel;
+		return response;
 	}
 
 	async postSearch(requestParameters: SearchRequestModel): Promise<SearchResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<SearchResponseModel>(
 			{
 				path: '/api/v1/search',
 				method: 'POST',
@@ -42,14 +42,14 @@ export class SnapAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as SearchResponseModel;
+		return response;
 	}
 
 	async postAutocomplete(requestParameters: AutocompleteRequestModel): Promise<AutocompleteResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<AutocompleteResponseModel>(
 			{
 				path: '/api/v1/autocomplete',
 				method: 'POST',
@@ -59,6 +59,6 @@ export class SnapAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as AutocompleteResponseModel;
+		return response;
 	}
 }

packages/snap-client/src/Client/apis/Suggest.ts

@@ -5,7 +5,7 @@ export class SuggestAPI extends API {
 	async getSuggest(queryParameters: SuggestRequestModel): Promise<SuggestResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 
-		const response = await this.request(
+		const response = await this.request<SuggestResponseModel>(
 			{
 				path: '/api/suggest/query',
 				method: 'GET',
@@ -15,14 +15,14 @@ export class SuggestAPI extends API {
 			JSON.stringify(queryParameters)
 		);
 
-		return response as unknown as SuggestResponseModel;
+		return response;
 	}
 
 	async postSuggest(requestParameters: SuggestRequestModel): Promise<SuggestResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<SuggestResponseModel>(
 			{
 				path: '/api/suggest/query',
 				method: 'POST',
@@ -32,13 +32,13 @@ export class SuggestAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as unknown as SuggestResponseModel;
+		return response;
 	}
 
 	async getTrending(queryParameters: TrendingRequestModel): Promise<TrendingResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 
-		const response = await this.request(
+		const response = await this.request<TrendingResponseModel>(
 			{
 				path: '/api/suggest/trending',
 				method: 'GET',
@@ -48,14 +48,14 @@ export class SuggestAPI extends API {
 			JSON.stringify(queryParameters)
 		);
 
-		return response as unknown as TrendingResponseModel;
+		return response;
 	}
 
 	async postTrending(requestParameters: TrendingRequestModel): Promise<TrendingResponseModel> {
 		const headerParameters: HTTPHeaders = {};
 		headerParameters['Content-Type'] = 'application/json';
 
-		const response = await this.request(
+		const response = await this.request<TrendingResponseModel>(
 			{
 				path: '/api/suggest/trending',
 				method: 'POST',
@@ -65,6 +65,6 @@ export class SuggestAPI extends API {
 			JSON.stringify(requestParameters)
 		);
 
-		return response as unknown as TrendingResponseModel;
+		return response;
 	}
 }

packages/snap-client/src/index.ts

@@ -4,7 +4,9 @@ export {
 	ClientGlobals,
 	ClientConfig,
 	TrendingResponseModel,
+	RecommendCombinedResponseModel,
+	ProfileResponseModel,
+	RecommendResponseModel,
 	RecommendRequestModel,
 	RecommendationRequestFilterModel,
-	RecommendCombinedResponseModel,
 } from './types';

packages/snap-client/src/types.ts

@@ -171,7 +171,7 @@ export type RecommendResponseModel = {
 		tag: string;
 	};
 	results: SearchResponseModelResult[];
-}[];
+};
 
 export type ProfileRequestModel = {
 	siteId: string;