@athoscommerce/snap-client 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Athos Commerce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,261 @@
+# Snap Javascript Client
+
+Simple Javascript client for communicating with the Athos Snap API.
+
+## Installation
+
+```bash
+npm install --save @athoscommerce/snap-client
+```
+
+## Import
+```js
+import { Client } from '@athoscommerce/snap-client';
+```
+
+## Global Config
+Client is constructed with `globals`.  
+
+Globals are API parameters that will be applied to all searches requested by the client. This will typically contain just the *siteId*; but could also include global filters, background filters, sorts, or merchandising segments.
+
+`siteId` (required)
+
+```js
+const globals = {
+	siteId: 'a1b2c3'
+};
+```
+
+Any other keys defined here will be passed to the API request
+
+For example, with background filter:
+
+```js
+const globals = {
+	siteId: 'a1b2c3',
+  filters: [{
+    field: 'stock_status',
+    value: 'yes',
+    type: 'value',
+    background: true
+  }]
+};
+```
+
+## Client Config
+Optional configuration for each requester. This can be used to specifiy a development origin URL or to configure cache settings per requester.
+
+```js
+type ClientConfig = {
+	mode?: keyof typeof AppMode | AppMode;
+	initiator?: string;
+	fetchApi?: WindowOrWorkerGlobalScope['fetch'];
+	meta?: RequesterConfig<MetaRequestModel, MetaRequesterPaths>;
+	search?: RequesterConfig<SearchRequestModel, SearchRequesterPaths>; // also used by autocomplete, category, and finder
+	recommend?: RequesterConfig<RecommendRequestModel, RecommendRequesterPaths>;
+	suggest?: RequesterConfig<SuggestRequestModel, SuggestRequesterPaths>; // also used by trending
+};
+
+type RequesterConfig<RequestType, PathConfigurationType> = {
+	origin?: string;
+	headers?: HTTPHeaders;
+	cache?: CacheConfig;
+	globals?: Partial<RequestType>;
+	paths?: Partial<PathConfigurationType>;
+};
+
+type CacheConfig = {
+	enabled?: boolean;
+	ttl?: number;
+	maxSize?: number;
+	purgeable?: boolean;
+	entries?: { [key: string]: Response };
+};
+
+```
+
+## Controller usage
+Snap Client is a dependency of Snap Controller and it is recommended to use the Controller's `search` method to perform a search. 
+
+## Cache usage
+Each requester in the Snap Client has its own cache settings, which can be configured via the `ClientConfig` under `cache`. Settings include: 
+
+  `enabled`: to opt out - Defaults to `true`, 
+
+  `ttl`: to adjust how long the requests are stored (in ms) - Defaults to `300000`,
+
+  `maxSize`: to adjust the maximum size of the cache allowed to be stored in localStorage (in kb - Defaults to `200`,
+
+  `purgeable`: to allow auto purging of the requests from localstorage when maxSize is hit, based on time remaining to expiration.  - Defaults to `true` with the exception of `meta`,
+
+  `entries`: to allow preload the cache. This is primarily used in Email Recommendations. 
+
+```js
+const metaResponse = {
+    "facets": {
+        "brand": {
+            "display": "list",
+            "label": "Brand",
+            "collapsed": false,
+            "multiple": "or"
+        },
+        "collection": {
+            "display": "list",
+            "label": "Collection",
+            "collapsed": false,
+            "multiple": "or"
+        },
+        "color_family": {
+            "display": "palette",
+            "label": "Color",
+            "collapsed": false,
+            "multiple": "or"
+        }
+    },
+    "sortOptions": [
+        {
+            "type": "relevance",
+            "field": "relevance",
+            "direction": "desc",
+            "label": "Best Match"
+        },
+        {
+            "type": "field",
+            "field": "sales_rank",
+            "direction": "desc",
+            "label": "Most Popular"
+        }
+    ]
+};
+
+const metaKey = `/v1/meta{"siteId":"atkzs2"}`;
+
+const clientConfig = {
+  search: {
+    cache: {
+      entries: {
+        [metaKey]: metaResponse
+      }
+    }
+  }
+}
+
+const client = new Client(globals, clientConfig);
+
+const response = await client.search({
+  search: {
+    query: {
+      string: 'dress'
+    }
+  }
+});
+```
+
+## Standalone usage
+```js
+const client = new Client(globals, clientConfig);
+
+const { meta, search } = await client.search({
+  search: {
+    query: {
+      string: 'dress'
+    }
+  }
+});
+```
+
+## `search` method
+Makes a request to the Athos Search API and returns a promise.  
+
+```js
+const client = new Client(globals, clientConfig);
+
+const { meta, search } = await client.search({
+  search: {
+    query: {
+      string: 'dress'
+    }
+  }
+});
+```
+
+## `autocomplete` method
+Makes a request to the Athos Autocomplete API and returns a promise.  
+
+```js
+const client = new Client(globals, clientConfig);
+
+const { meta, search } = await client.autocomplete({
+  suggestions: {
+    count: 5
+  },
+  search: {
+    query: {
+      string: 'yellw',
+    }
+  }
+});
+```
+
+## `category` method
+Makes a request to the Athos Category API and returns a promise.
+
+```js
+const client = new Client(globals, clientConfig);
+
+const { meta, search } = await client.category({
+  filters: [{
+    field: 'categoryId',
+    value: '12345',
+    type: 'value',
+    background: true,
+  }]
+});
+```
+
+## `meta` method
+Makes a request to the Athos Search API to fetch meta properties, it returns a promise. The `search` method utilizes this method.
+
+```js
+const client = new Client(globals, clientConfig);
+const meta = await client.meta();
+```
+
+## `trending` method
+Makes a request to the Athos Trending API and returns a promise. The `siteId` is sourced from globals automatically, but if provided that siteId would be used.
+
+```js
+const client = new Client(globals, clientConfig);
+const results = await client.trending({
+  siteId: 'REPLACE_WITH_YOUR_SITE_ID',
+  limit: 5
+});
+```
+
+## `finder` method
+Makes a request to the Athos finder API and returns a promise.
+
+```js
+const client = new Client(globals, clientConfig);
+const { meta, search } = await client.finder({
+  filters: [{
+    type: "value",
+    field: "color",
+    background: false,
+    value: "red",
+  }]
+});
+```
+
+## `recommend` method
+Makes a request to the Athos Recommend API and returns a promise.
+
+```js
+const client = new Client(globals, clientConfig);
+const { profile, meta, results, responseId } = await client.recommend({
+  tag: 'similar',
+  siteId: 'REPLACE_WITH_YOUR_SITE_ID',
+  products: ['product123'],
+  shopper: '[REPLACE WITH LOGGED IN SHOPPER ID]'
+});
+```

package/dist/cjs/Client/Client.d.ts

@@ -0,0 +1,29 @@
+import type { ClientGlobals, ClientConfig, TrendingRequestModel, TrendingResponseModel, RecommendRequestModel, RecommendCombinedResponseModel } from '../types';
+import type { MetaRequestModel, MetaResponseModel, SearchRequestModel, SearchResponseModel, AutocompleteRequestModel, AutocompleteResponseModel } from '@athoscommerce/snapi-types';
+export declare class Client {
+    private mode;
+    private globals;
+    private config;
+    private requesters;
+    constructor(globals: ClientGlobals, config?: ClientConfig);
+    meta(params?: MetaRequestModel): Promise<MetaResponseModel>;
+    autocomplete(params?: AutocompleteRequestModel): Promise<{
+        meta: MetaResponseModel;
+        search: AutocompleteResponseModel;
+    }>;
+    search(params?: SearchRequestModel): Promise<{
+        meta: MetaResponseModel;
+        search: SearchResponseModel;
+    }>;
+    category(params?: SearchRequestModel): Promise<{
+        meta: MetaResponseModel;
+        search: SearchResponseModel;
+    }>;
+    finder(params?: SearchRequestModel): Promise<{
+        meta: MetaResponseModel;
+        search: SearchResponseModel;
+    }>;
+    trending(params: Partial<TrendingRequestModel>): Promise<TrendingResponseModel>;
+    recommend(params: RecommendRequestModel): Promise<RecommendCombinedResponseModel>;
+}
+//# sourceMappingURL=Client.d.ts.map

package/dist/cjs/Client/Client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../../src/Client/Client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACX,aAAa,EACb,YAAY,EACZ,oBAAoB,EACpB,qBAAqB,EAErB,qBAAqB,EACrB,8BAA8B,EAE9B,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EACX,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EAEzB,MAAM,4BAA4B,CAAC;AAcpC,qBAAa,MAAM;IAClB,OAAO,CAAC,IAAI,CAAsB;IAClC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,UAAU,CAKhB;gBAEU,OAAO,EAAE,aAAa,EAAE,MAAM,GAAE,YAAiB;IAgEvD,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO3D,YAAY,CAAC,MAAM,GAAE,wBAA6B,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,yBAAyB,CAAA;KAAE,CAAC;IAgD5H,MAAM,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,mBAAmB,CAAA;KAAE,CAAC;IAO1G,QAAQ,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,mBAAmB,CAAA;KAAE,CAAC;IAO5G,MAAM,CAAC,MAAM,GAAE,kBAAuB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,mBAAmB,CAAA;KAAE,CAAC;IAO1G,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAM/E,SAAS,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,8BAA8B,CAAC;CAmCvF"}

package/dist/cjs/Client/Client.js

@@ -0,0 +1,278 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+var snap_toolbox_1 = require("@athoscommerce/snap-toolbox");
+var apis_1 = require("./apis");
+var deepmerge_1 = __importDefault(require("deepmerge"));
+var transforms_1 = require("./transforms");
+var defaultConfig = {
+    mode: snap_toolbox_1.AppMode.production,
+    meta: {
+        cache: {
+            purgeable: false,
+        },
+    },
+};
+var Client = /** @class */ (function () {
+    function Client(globals, config) {
+        if (config === void 0) { config = {}; }
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+        this.mode = snap_toolbox_1.AppMode.production;
+        if (!(globals === null || globals === void 0 ? void 0 : globals.siteId)) {
+            throw 'no siteId specified!';
+        }
+        this.globals = globals;
+        this.config = (0, deepmerge_1.default)(defaultConfig, config);
+        if (Object.values(snap_toolbox_1.AppMode).includes(this.config.mode)) {
+            this.mode = this.config.mode;
+        }
+        this.requesters = {
+            meta: new apis_1.MetaAPI(new apis_1.ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: (_a = this.config.meta) === null || _a === void 0 ? void 0 : _a.origin,
+                headers: (_b = this.config.meta) === null || _b === void 0 ? void 0 : _b.headers,
+                cache: (_c = this.config.meta) === null || _c === void 0 ? void 0 : _c.cache,
+                globals: (_d = this.config.meta) === null || _d === void 0 ? void 0 : _d.globals,
+                paths: (_e = this.config.meta) === null || _e === void 0 ? void 0 : _e.paths,
+            })),
+            recommend: new apis_1.RecommendAPI(new apis_1.ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: (_f = this.config.recommend) === null || _f === void 0 ? void 0 : _f.origin,
+                headers: (_g = this.config.recommend) === null || _g === void 0 ? void 0 : _g.headers,
+                cache: (_h = this.config.recommend) === null || _h === void 0 ? void 0 : _h.cache,
+                globals: (_j = this.config.recommend) === null || _j === void 0 ? void 0 : _j.globals,
+                paths: (_k = this.config.recommend) === null || _k === void 0 ? void 0 : _k.paths,
+            })),
+            search: new apis_1.SearchAPI(new apis_1.ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: (_l = this.config.search) === null || _l === void 0 ? void 0 : _l.origin,
+                headers: (_m = this.config.search) === null || _m === void 0 ? void 0 : _m.headers,
+                cache: (_o = this.config.search) === null || _o === void 0 ? void 0 : _o.cache,
+                globals: (_p = this.config.search) === null || _p === void 0 ? void 0 : _p.globals,
+                paths: (_q = this.config.search) === null || _q === void 0 ? void 0 : _q.paths,
+            })),
+            suggest: new apis_1.SuggestAPI(new apis_1.ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: (_r = this.config.suggest) === null || _r === void 0 ? void 0 : _r.origin,
+                headers: (_s = this.config.suggest) === null || _s === void 0 ? void 0 : _s.headers,
+                cache: (_t = this.config.suggest) === null || _t === void 0 ? void 0 : _t.cache,
+                globals: (_u = this.config.suggest) === null || _u === void 0 ? void 0 : _u.globals,
+                paths: (_v = this.config.suggest) === null || _v === void 0 ? void 0 : _v.paths,
+            })),
+        };
+    }
+    Client.prototype.meta = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var defaultParams;
+            return __generator(this, function (_a) {
+                defaultParams = { siteId: this.globals.siteId };
+                params = (0, deepmerge_1.default)(defaultParams, params || {});
+                return [2 /*return*/, this.requesters.meta.getMeta(params)];
+            });
+        });
+    };
+    Client.prototype.autocomplete = function () {
+        return __awaiter(this, arguments, void 0, function (params) {
+            var metaPromise, suggestParams, suggestResults, transformedSuggestResults, q, searchResults, autocompleteResponse, _a, meta, search;
+            var _b, _c, _d, _e, _f, _g, _h, _j;
+            if (params === void 0) { params = {}; }
+            return __generator(this, function (_k) {
+                switch (_k.label) {
+                    case 0:
+                        if (!((_c = (_b = params.search) === null || _b === void 0 ? void 0 : _b.query) === null || _c === void 0 ? void 0 : _c.string)) {
+                            throw 'query string parameter is required';
+                        }
+                        params = (0, deepmerge_1.default)(this.globals, params);
+                        metaPromise = this.meta({ siteId: params.siteId || '' });
+                        suggestParams = {
+                            siteId: params.siteId || '',
+                            language: 'en',
+                            query: ((_e = (_d = params.search) === null || _d === void 0 ? void 0 : _d.query) === null || _e === void 0 ? void 0 : _e.string) || '',
+                            suggestionCount: (params.suggestions || {}).count || 5,
+                        };
+                        if (((_g = (_f = params.search) === null || _f === void 0 ? void 0 : _f.query) === null || _g === void 0 ? void 0 : _g.spellCorrection) === false) {
+                            suggestParams.disableSpellCorrect = true;
+                        }
+                        return [4 /*yield*/, this.requesters.suggest.getSuggest(suggestParams)];
+                    case 1:
+                        suggestResults = _k.sent();
+                        transformedSuggestResults = (0, transforms_1.transformSuggestResponse)(suggestResults);
+                        q = (transformedSuggestResults.suggested || {}).text || transformedSuggestResults.query || transformedSuggestResults.correctedQuery;
+                        params.search = params.search || {};
+                        params.search.redirectResponse = 'full';
+                        // set the query to the most relevant suggestion
+                        // params.search.query = params.search.query || {};
+                        if (q && ((_j = (_h = params.search) === null || _h === void 0 ? void 0 : _h.query) === null || _j === void 0 ? void 0 : _j.string)) {
+                            params.search.query.string = q;
+                        }
+                        return [4 /*yield*/, this.requesters.search.getAutocomplete(params)];
+                    case 2:
+                        searchResults = _k.sent();
+                        autocompleteResponse = __assign(__assign({}, searchResults), { autocomplete: transformedSuggestResults });
+                        return [4 /*yield*/, Promise.all([metaPromise, autocompleteResponse])];
+                    case 3:
+                        _a = _k.sent(), meta = _a[0], search = _a[1];
+                        return [2 /*return*/, { meta: meta, search: search }];
+                }
+            });
+        });
+    };
+    Client.prototype.search = function () {
+        return __awaiter(this, arguments, void 0, function (params) {
+            var _a, meta, search;
+            if (params === void 0) { params = {}; }
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        params = (0, deepmerge_1.default)(this.globals, params);
+                        return [4 /*yield*/, Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getSearch(params)])];
+                    case 1:
+                        _a = _b.sent(), meta = _a[0], search = _a[1];
+                        return [2 /*return*/, { meta: meta, search: search }];
+                }
+            });
+        });
+    };
+    Client.prototype.category = function () {
+        return __awaiter(this, arguments, void 0, function (params) {
+            var _a, meta, search;
+            if (params === void 0) { params = {}; }
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        params = (0, deepmerge_1.default)(this.globals, params);
+                        return [4 /*yield*/, Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getCategory(params)])];
+                    case 1:
+                        _a = _b.sent(), meta = _a[0], search = _a[1];
+                        return [2 /*return*/, { meta: meta, search: search }];
+                }
+            });
+        });
+    };
+    Client.prototype.finder = function () {
+        return __awaiter(this, arguments, void 0, function (params) {
+            var _a, meta, search;
+            if (params === void 0) { params = {}; }
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        params = (0, deepmerge_1.default)(this.globals, params);
+                        return [4 /*yield*/, Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getFinder(params)])];
+                    case 1:
+                        _a = _b.sent(), meta = _a[0], search = _a[1];
+                        return [2 /*return*/, { meta: meta, search: search }];
+                }
+            });
+        });
+    };
+    Client.prototype.trending = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                params = (0, deepmerge_1.default)({ siteId: this.globals.siteId }, params || {});
+                return [2 /*return*/, this.requesters.suggest.getTrending(params)];
+            });
+        });
+    };
+    Client.prototype.recommend = function (params) {
+        return __awaiter(this, void 0, void 0, function () {
+            var tag, otherParams, profileParams, recommendParams, _a, meta, profile, recommendations;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        tag = params.tag, otherParams = __rest(params, ["tag"]);
+                        if (!tag) {
+                            throw 'tag parameter is required';
+                        }
+                        profileParams = {
+                            tag: tag,
+                            siteId: params.siteId || this.globals.siteId,
+                        };
+                        if (otherParams.branch) {
+                            profileParams.branch = otherParams.branch;
+                            delete otherParams.branch;
+                        }
+                        recommendParams = __assign(__assign({ tag: tag }, otherParams), { siteId: params.siteId || this.globals.siteId });
+                        return [4 /*yield*/, Promise.all([
+                                this.meta(params.siteId ? { siteId: params.siteId } : undefined),
+                                this.requesters.recommend.getProfile(profileParams),
+                                this.requesters.recommend.batchRecommendations(recommendParams),
+                            ])];
+                    case 1:
+                        _a = _b.sent(), meta = _a[0], profile = _a[1], recommendations = _a[2];
+                        return [2 /*return*/, __assign(__assign({}, profile), { meta: meta, results: recommendations && recommendations.results, responseId: recommendations ? recommendations.responseId : '' })];
+                }
+            });
+        });
+    };
+    return Client;
+}());
+exports.Client = Client;

package/dist/cjs/Client/NetworkCache/NetworkCache.d.ts

@@ -0,0 +1,12 @@
+import { CacheConfig, Cache, DefaultCacheConfig } from '../../types';
+export declare class NetworkCache {
+    protected memoryCache: Cache;
+    protected config: DefaultCacheConfig;
+    constructor(config?: CacheConfig);
+    load(): void;
+    get(key: string): Response | void;
+    private purgeExpired;
+    set(key: string, value: Response): void;
+    clear(): void;
+}
+//# sourceMappingURL=NetworkCache.d.ts.map

package/dist/cjs/Client/NetworkCache/NetworkCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NetworkCache.d.ts","sourceRoot":"","sources":["../../../../src/Client/NetworkCache/NetworkCache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAWrE,qBAAa,YAAY;IACxB,SAAS,CAAC,WAAW,EAAE,KAAK,CAAM;IAClC,SAAS,CAAC,MAAM,EAAE,kBAAkB,CAAC;gBAEzB,MAAM,CAAC,EAAE,WAAW;IAczB,IAAI,IAAI,IAAI;IAcZ,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI;IA2ExC,OAAO,CAAC,YAAY;IAmBb,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI;IAuCvC,KAAK;CAUZ"}