@searchspring/snap-client 0.20.0

package/dist/esm/Client/apis/Recommend.d.ts

@@ -0,0 +1,81 @@
+import { API, ApiConfiguration } from './Abstract';
+import { SearchResponseModelResult } from '@searchspring/snapi-types';
+export declare type RecommendRequestModel = {
+    tags: string[];
+    siteId: string;
+    product?: string;
+    shopper?: string;
+    categories?: string[];
+    cart?: string[];
+    lastViewed?: string[];
+    test?: boolean;
+    batched?: boolean;
+};
+export declare type RecommendResponseModel = {
+    profile: {
+        tag: string;
+    };
+    results: SearchResponseModelResult[];
+}[];
+export declare type ProfileRequestModel = {
+    siteId: string;
+    tag: string;
+    branch?: string;
+};
+export declare type ProfileResponseModel = {
+    profile: {
+        tag: string;
+        placement: string;
+        display: {
+            threshold: number;
+            template: {
+                name: string;
+                uuid: string;
+                markup?: string;
+                styles?: string;
+                component?: string;
+                branch?: string;
+                group?: string;
+            };
+            templateParameters: {
+                [any: string]: unknown;
+            };
+        };
+    };
+};
+export declare type RecommendCombinedRequestModel = {
+    tag: string;
+    siteId: string;
+    product?: string;
+    shopper?: string;
+    categories?: string[];
+    cart?: string[];
+    lastViewed?: string[];
+    test?: boolean;
+    branch?: string;
+};
+declare class Deferred {
+    promise: Promise<any>;
+    resolve: any;
+    reject: any;
+    constructor();
+}
+export declare type RecommendCombinedResponseModel = ProfileResponseModel & {
+    results: SearchResponseModelResult[];
+};
+export declare class RecommendAPI extends API {
+    batches: {
+        [key: string]: {
+            timeout: number;
+            request: any;
+            deferreds?: Deferred[];
+        };
+    };
+    constructor(config: ApiConfiguration);
+    getProfile(queryParameters: ProfileRequestModel): Promise<ProfileResponseModel>;
+    batchRecommendations(parameters: RecommendRequestModel): Promise<RecommendResponseModel>;
+    getRecommendations(queryParameters: RecommendRequestModel): Promise<RecommendResponseModel>;
+    postRecommendations(requestParameters: RecommendRequestModel): Promise<RecommendResponseModel>;
+}
+export {};
+//# sourceMappingURL=Recommend.d.ts.map

package/dist/esm/Client/apis/Recommend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Recommend.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Recommend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,gBAAgB,EAAe,MAAM,YAAY,CAAC;AAGhE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAGtE,oBAAY,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,oBAAY,sBAAsB,GAAG;IACpC,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,OAAO,EAAE,yBAAyB,EAAE,CAAC;CACrC,EAAE,CAAC;AAEJ,oBAAY,mBAAmB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IAClC,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;YAClB,QAAQ,EAAE;gBACT,IAAI,EAAE,MAAM,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;gBACb,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,SAAS,CAAC,EAAE,MAAM,CAAC;gBACnB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,KAAK,CAAC,EAAE,MAAM,CAAC;aACf,CAAC;YACF,kBAAkB,EAAE;gBACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACvB,CAAC;SACF,CAAC;KACF,CAAC;CACF,CAAC;AAEF,oBAAY,6BAA6B,GAAG;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,cAAM,QAAQ;IACb,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,MAAC;IACR,MAAM,MAAC;;CAQP;AAED,oBAAY,8BAA8B,GAAG,oBAAoB,GAAG;IAAE,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAAE,CAAC;AAG7G,qBAAa,YAAa,SAAQ,GAAG;IACpC,OAAO,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG;YACd,OAAO,EAAE,MAAM,CAAC;YAChB,OAAO,EAAE,GAAG,CAAC;YACb,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;SACvB,CAAC;KACF,CAAC;gBAEU,MAAM,EAAE,gBAAgB;IAK9B,UAAU,CAAC,eAAe,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgB/E,oBAAoB,CAAC,UAAU,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA+CxF,kBAAkB,CAAC,eAAe,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAmB3F,mBAAmB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAmBpG"}

package/dist/esm/Client/apis/Recommend.js

@@ -0,0 +1,91 @@
+import { API } from './Abstract';
+import { hashParams } from '../utils/hashParams';
+import { charsParams } from '../utils/charsParams';
+class Deferred {
+    constructor() {
+        this.promise = new Promise((resolve, reject) => {
+            this.reject = reject;
+            this.resolve = resolve;
+        });
+    }
+}
+const BATCH_TIMEOUT = 150;
+export class RecommendAPI extends API {
+    constructor(config) {
+        super(config);
+        this.batches = {};
+    }
+    async getProfile(queryParameters) {
+        const headerParameters = {};
+        const response = await this.request({
+            path: '/api/personalized-recommendations/profile.json',
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, '/api/personalized-recommendations/profile.json' + JSON.stringify(queryParameters));
+        return response;
+    }
+    async batchRecommendations(parameters) {
+        const { tags, ...otherParams } = parameters;
+        const [tag] = tags || [];
+        if (!tag)
+            return;
+        let key = hashParams(otherParams);
+        if ('batched' in otherParams) {
+            if (otherParams.batched) {
+                key = otherParams.siteId;
+            }
+            delete otherParams.batched; // remove from request parameters
+        }
+        this.batches[key] = this.batches[key] || { timeout: null, request: { tags: [], ...otherParams }, deferreds: [] };
+        const paramBatch = this.batches[key];
+        const deferred = new Deferred();
+        paramBatch.request.tags.push(tag);
+        paramBatch.deferreds.push(deferred);
+        window.clearTimeout(paramBatch.timeout);
+        paramBatch.timeout = window.setTimeout(async () => {
+            let requestMethod = 'getRecommendations';
+            if (charsParams(paramBatch.request) > 1024) {
+                requestMethod = 'postRecommendations';
+            }
+            try {
+                const response = await this[requestMethod](paramBatch.request);
+                paramBatch.deferreds.forEach((def, index) => {
+                    def.resolve([response[index]]);
+                });
+            }
+            catch (err) {
+                paramBatch.deferreds.forEach((def) => {
+                    def.reject(err);
+                });
+            }
+            delete this.batches[key];
+        }, BATCH_TIMEOUT);
+        return deferred.promise;
+    }
+    async getRecommendations(queryParameters) {
+        const headerParameters = {};
+        const siteId = queryParameters.siteId;
+        const path = `/boost/${siteId}/recommend`;
+        const response = await this.request({
+            path,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, path + JSON.stringify(queryParameters));
+        return response;
+    }
+    async postRecommendations(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const siteId = requestParameters.siteId;
+        const path = `/boost/${siteId}/recommend`;
+        const response = await this.request({
+            path,
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, path + JSON.stringify(requestParameters));
+        return response;
+    }
+}

package/dist/esm/Client/apis/Snap.d.ts

@@ -0,0 +1,8 @@
+import { AutocompleteRequestModel, AutocompleteResponseModel, MetaRequestModel, MetaResponseModel, SearchRequestModel, SearchResponseModel } from '@searchspring/snapi-types';
+import { API } from '.';
+export declare class SnapAPI extends API {
+    postMeta(requestParameters: MetaRequestModel): Promise<MetaResponseModel>;
+    postSearch(requestParameters: SearchRequestModel): Promise<SearchResponseModel>;
+    postAutocomplete(requestParameters: AutocompleteRequestModel): Promise<AutocompleteResponseModel>;
+}
+//# sourceMappingURL=Snap.d.ts.map

package/dist/esm/Client/apis/Snap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Snap.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Snap.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,wBAAwB,EACxB,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,GAAG,EAAe,MAAM,GAAG,CAAC;AAErC,qBAAa,OAAQ,SAAQ,GAAG;IACzB,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiBzE,UAAU,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiB/E,gBAAgB,CAAC,iBAAiB,EAAE,wBAAwB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAgBvG"}

package/dist/esm/Client/apis/Snap.js

@@ -0,0 +1,36 @@
+import { API } from '.';
+export class SnapAPI extends API {
+    async postMeta(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: '/api/v1/meta',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, '/api/v1/meta' + JSON.stringify(requestParameters));
+        return response;
+    }
+    async postSearch(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: '/api/v1/search',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, '/api/v1/search' + JSON.stringify(requestParameters));
+        return response;
+    }
+    async postAutocomplete(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: '/api/v1/autocomplete',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, '/api/v1/autocomplete' + JSON.stringify(requestParameters));
+        return response;
+    }
+}

package/dist/esm/Client/apis/Suggest.d.ts

@@ -0,0 +1,45 @@
+import { API } from './Abstract';
+export declare type SuggestRequestModel = {
+    siteId: string;
+    query: string;
+    language?: string;
+    suggestionCount?: number;
+    productCount?: number;
+    disableSpellCorrect?: boolean;
+};
+export declare type SuggestResponseModelSuggestion = {
+    text: string;
+    type?: string;
+    source?: string;
+    popularity?: number;
+    completed?: {
+        token: string;
+        query: string;
+        type: string;
+    }[];
+};
+export declare type SuggestResponseModel = {
+    query: string;
+    'corrected-query'?: string;
+    suggested?: SuggestResponseModelSuggestion;
+    alternatives?: SuggestResponseModelSuggestion[];
+};
+export declare type TrendingRequestModel = {
+    siteId: string;
+    limit?: number;
+};
+export declare type TrendingResponseModel = {
+    trending: {
+        queries: {
+            popularity: number;
+            searchQuery: string;
+        }[];
+    };
+};
+export declare class SuggestAPI extends API {
+    getSuggest(queryParameters: SuggestRequestModel): Promise<SuggestResponseModel>;
+    postSuggest(requestParameters: SuggestRequestModel): Promise<SuggestResponseModel>;
+    getTrending(queryParameters: TrendingRequestModel): Promise<TrendingResponseModel>;
+    postTrending(requestParameters: TrendingRequestModel): Promise<TrendingResponseModel>;
+}
+//# sourceMappingURL=Suggest.d.ts.map

package/dist/esm/Client/apis/Suggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Suggest.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Suggest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAe,MAAM,YAAY,CAAC;AAE9C,oBAAY,mBAAmB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,oBAAY,8BAA8B,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACb,EAAE,CAAC;CACJ,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,8BAA8B,CAAC;IAC3C,YAAY,CAAC,EAAE,8BAA8B,EAAE,CAAC;CAChD,CAAC;AAEF,oBAAY,oBAAoB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IACnC,QAAQ,EAAE;QACT,OAAO,EAAE;YACR,UAAU,EAAE,MAAM,CAAC;YACnB,WAAW,EAAE,MAAM,CAAC;SACpB,EAAE,CAAC;KACJ,CAAC;CACF,CAAC;AAEF,qBAAa,UAAW,SAAQ,GAAG;IAC5B,UAAU,CAAC,eAAe,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgB/E,WAAW,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAiBlF,WAAW,CAAC,eAAe,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAgBlF,YAAY,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAgB3F"}

package/dist/esm/Client/apis/Suggest.js

@@ -0,0 +1,45 @@
+import { API } from './Abstract';
+export class SuggestAPI extends API {
+    async getSuggest(queryParameters) {
+        const headerParameters = {};
+        const response = await this.request({
+            path: '/api/suggest/query',
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, '/api/suggest/query' + JSON.stringify(queryParameters));
+        return response;
+    }
+    async postSuggest(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: '/api/suggest/query',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, '/api/suggest/query' + JSON.stringify(requestParameters));
+        return response;
+    }
+    async getTrending(queryParameters) {
+        const headerParameters = {};
+        const response = await this.request({
+            path: '/api/suggest/trending',
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, '/api/suggest/trending' + JSON.stringify(queryParameters));
+        return response;
+    }
+    async postTrending(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: '/api/suggest/trending',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, '/api/suggest/trending' + JSON.stringify(requestParameters));
+        return response;
+    }
+}

package/dist/esm/Client/apis/index.d.ts

@@ -0,0 +1,7 @@
+export * from './Abstract';
+export * from './Legacy';
+export * from './Recommend';
+export * from './Snap';
+export * from './Suggest';
+export * from './Hybrid';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/Client/apis/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC"}

package/dist/esm/Client/apis/index.js

@@ -0,0 +1,6 @@
+export * from './Abstract';
+export * from './Legacy';
+export * from './Recommend';
+export * from './Snap';
+export * from './Suggest';
+export * from './Hybrid';

package/dist/esm/Client/transforms/index.d.ts

@@ -0,0 +1,4 @@
+export * from './searchRequest';
+export * from './searchResponse';
+export * from './suggestResponse';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/Client/transforms/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Client/transforms/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/dist/esm/Client/transforms/index.js

@@ -0,0 +1,3 @@
+export * from './searchRequest';
+export * from './searchResponse';
+export * from './suggestResponse';

package/dist/esm/Client/transforms/searchRequest.d.ts

@@ -0,0 +1,47 @@
+import { SearchRequestModel } from '@searchspring/snapi-types';
+export declare function transformSearchRequest(request: SearchRequestModel): any;
+export declare namespace transformSearchRequest {
+    var sorts: (request?: SearchRequestModel) => import("@searchspring/snapi-types").SearchRequestModelSorts;
+    var search: (request?: SearchRequestModel) => {
+        q?: string;
+        rq?: string;
+        originalQuery?: string;
+        redirectResponse?: string;
+    };
+    var filters: (request?: SearchRequestModel) => {};
+    var merchandising: (request?: SearchRequestModel) => {
+        disableMerchandising: boolean;
+    } | {
+        disableMerchandising?: undefined;
+    };
+    var pagination: (request?: SearchRequestModel) => {
+        page?: number;
+        resultsPerPage?: number;
+    };
+    var siteId: (request?: SearchRequestModel) => {
+        siteId: string;
+    } | {
+        siteId?: undefined;
+    };
+    var facets: (request?: SearchRequestModel) => {
+        includedFacets: string[];
+        excludedFacets?: undefined;
+    } | {
+        excludedFacets: string[];
+        includedFacets?: undefined;
+    } | {
+        includedFacets?: undefined;
+        excludedFacets?: undefined;
+    };
+    var tracking: (request?: SearchRequestModel) => {
+        userId?: string;
+        domain?: string;
+    };
+    var personalization: (request?: SearchRequestModel) => {
+        skipPersonalization?: boolean;
+        cart?: string;
+        shopper?: string;
+        lastViewed?: string;
+    };
+}
+//# sourceMappingURL=searchRequest.d.ts.map

package/dist/esm/Client/transforms/searchRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchRequest.d.ts","sourceRoot":"","sources":["../../../../src/Client/transforms/searchRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAgE,MAAM,2BAA2B,CAAC;AAE7H,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,kBAAkB,GAAG,GAAG,CAYvE;yBAZe,sBAAsB"}

package/dist/esm/Client/transforms/searchRequest.js

@@ -0,0 +1,133 @@
+import { mergeParams } from '../utils';
+export function transformSearchRequest(request) {
+    return mergeParams(transformSearchRequest.sorts(request), transformSearchRequest.search(request), transformSearchRequest.filters(request), transformSearchRequest.merchandising(request), transformSearchRequest.pagination(request), transformSearchRequest.siteId(request), transformSearchRequest.facets(request), transformSearchRequest.tracking(request), transformSearchRequest.personalization(request));
+}
+transformSearchRequest.sorts = (request = {}) => {
+    return (request.sorts || []).reduce((acc, sort) => {
+        if (!sort.field && !sort.direction) {
+            return acc;
+        }
+        if (!sort.field || !sort.direction) {
+            throw 'valid sort requires field and direction';
+        }
+        if (sort.direction != 'asc' && sort.direction != 'desc') {
+            throw 'valid sort directions: asc, desc';
+        }
+        return {
+            ...acc,
+            ['sort.' + sort.field]: (acc[sort.field] || []).concat(sort.direction),
+        };
+    }, {});
+};
+transformSearchRequest.search = (request = {}) => {
+    const reqSearch = request.search || {};
+    const search = {};
+    if (reqSearch.query && reqSearch.query.string) {
+        search.q = reqSearch.query.string.trim();
+    }
+    if (reqSearch.subQuery) {
+        search.rq = reqSearch.subQuery.trim();
+    }
+    if (reqSearch.originalQuery) {
+        search.originalQuery = reqSearch.originalQuery.trim();
+    }
+    if (reqSearch.redirectResponse) {
+        search.redirectResponse = reqSearch.redirectResponse;
+    }
+    return search;
+};
+transformSearchRequest.filters = (request = {}) => {
+    return (request.filters || []).reduce((acc, filter) => {
+        const baseKey = filter.background ? 'bgfilter' : 'filter';
+        if (filter.type == 'value') {
+            const key = baseKey + '.' + filter.field;
+            return {
+                ...acc,
+                [key]: (acc[key] || []).concat([filter.value]),
+            };
+        }
+        else if (filter.type == 'range') {
+            const keyLow = baseKey + '.' + filter.field + '.low';
+            const keyHigh = baseKey + '.' + filter.field + '.high';
+            const low = filter.value.low ?? '*';
+            const high = filter.value.high ?? '*';
+            return {
+                ...acc,
+                [keyLow]: (acc[keyLow] || []).concat([low]),
+                [keyHigh]: (acc[keyHigh] || []).concat([high]),
+            };
+        }
+        return acc;
+    }, {});
+};
+transformSearchRequest.merchandising = (request = {}) => {
+    const reqMerch = request.merchandising || {};
+    const merch = reqMerch.disabled ? { disableMerchandising: true } : {};
+    if (reqMerch.landingPage) {
+        merch['landing-page'] = reqMerch.landingPage;
+    }
+    if (reqMerch.segments instanceof Array && reqMerch.segments.length) {
+        merch['tag'] = reqMerch.segments.map((segment) => {
+            return `merch.segment/${segment}`;
+        });
+    }
+    return merch;
+};
+transformSearchRequest.pagination = (request = {}) => {
+    const pagination = request.pagination || {};
+    const params = {};
+    if (pagination.page) {
+        params.page = pagination.page;
+    }
+    if (pagination.pageSize || pagination.pageSize === 0) {
+        params.resultsPerPage = pagination.pageSize;
+    }
+    return params;
+};
+transformSearchRequest.siteId = (request = {}) => {
+    if (request.siteId) {
+        return { siteId: request.siteId };
+    }
+    return {};
+};
+transformSearchRequest.facets = (request = {}) => {
+    const facets = request.facets || {};
+    if (facets.include && facets.include.length && facets.exclude && facets.exclude.length) {
+        throw 'cannot use facet include and exclude at the same time';
+    }
+    if (facets.include?.length) {
+        return { includedFacets: facets.include };
+    }
+    if (facets.exclude?.length) {
+        return { excludedFacets: facets.exclude };
+    }
+    return {};
+};
+transformSearchRequest.tracking = (request = {}) => {
+    const reqTracking = request.tracking || {};
+    const params = {};
+    if (reqTracking.userId) {
+        params.userId = reqTracking.userId;
+    }
+    if (reqTracking.domain) {
+        params.domain = reqTracking.domain;
+    }
+    return params;
+};
+transformSearchRequest.personalization = (request = {}) => {
+    const personalization = request.personalization || {};
+    const params = {};
+    if (personalization.disabled) {
+        params.skipPersonalization = personalization.disabled;
+    }
+    if (personalization.cart) {
+        params.cart = personalization.cart;
+    }
+    if (personalization.lastViewed) {
+        params.lastViewed = personalization.lastViewed;
+    }
+    if (personalization.shopper) {
+        params.shopper = personalization.shopper;
+    }
+    return params;
+};

package/dist/esm/Client/transforms/searchResponse.d.ts

@@ -0,0 +1,31 @@
+import { SearchRequestModel, SearchResponseModel, SearchResponseModelResult, SearchResponseModelPagination } from '@searchspring/snapi-types';
+export declare function transformSearchResponse(response: any, request: SearchRequestModel): SearchResponseModel;
+export declare namespace transformSearchResponse {
+    var pagination: (response: any) => {
+        pagination: SearchResponseModelPagination;
+    };
+    var results: (response: any) => {
+        results: any;
+    };
+    var result: (rawResult: any) => SearchResponseModelResult;
+    var filters: (response: any) => {
+        filters: any;
+    };
+    var facets: (response: any, request?: SearchRequestModel) => {
+        facets: any;
+    };
+    var sorting: (response: any) => {
+        sorting: any;
+    };
+    var merchandising: (response: any) => {
+        merchandising: any;
+    };
+    var search: (response: any, request: any) => {
+        search: {
+            query: any;
+            didYouMean: any;
+            originalQuery: any;
+        };
+    };
+}
+//# sourceMappingURL=searchResponse.d.ts.map

package/dist/esm/Client/transforms/searchResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchResponse.d.ts","sourceRoot":"","sources":["../../../../src/Client/transforms/searchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,kBAAkB,EAElB,mBAAmB,EACnB,yBAAyB,EAIzB,6BAA6B,EAC7B,MAAM,2BAA2B,CAAC;AA8BnC,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,kBAAkB,GAAG,mBAAmB,CAUvG;yBAVe,uBAAuB"}