@athoscommerce/snap-client 1.0.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAErI,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,eAAe,CAAC,WAAW,EAAE,qBAAqB,IAAI;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,OAAO,OAAO,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC;IAC7D,MAAM,CAAC,EAAE,eAAe,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IACnE,SAAS,CAAC,EAAE,eAAe,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC;IAC5E,OAAO,CAAC,EAAE,eAAe,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEtD,MAAM,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;CACtC,CAAC;AACF,MAAM,MAAM,UAAU,GAAG;IACxB,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,CAAC,iBAAiB,EAAE,MAAM,GAAG,GAAG,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,cAAc,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,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,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,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,MAAM,MAAM,qBAAqB,GAAG,4BAA4B,GAC/D,4BAA4B,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,4BAA4B,CAAC;CACvC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,MAAM,MAAM,yBAAyB,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gCAAgC,EAAE,CAAC;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,gCAAgC,EAAE,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;IAClE,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,OAAO,EAAE,yBAAyB,EAAE,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,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;gBACf,IAAI,CAAC,EAAE,MAAM,CAAC;aACd,CAAC;YACF,kBAAkB,EAAE;gBACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACvB,CAAC;SACF,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG,qCAAqC,GAAG,qCAAqC,CAAC;AAE7H,KAAK,qCAAqC,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC,CAAC;AAEF,KAAK,qCAAqC,GAAG;IAC5C,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,GAAG;IAAE,OAAO,EAAE,yBAAyB,EAAE,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG;IAC5I,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/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/esm/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/esm/Client/Client.js

@@ -0,0 +1,157 @@
+import { AppMode } from '@athoscommerce/snap-toolbox';
+import { SuggestAPI, RecommendAPI, ApiConfiguration, SearchAPI, MetaAPI } from './apis';
+import deepmerge from 'deepmerge';
+import { transformSuggestResponse } from './transforms';
+const defaultConfig = {
+    mode: AppMode.production,
+    meta: {
+        cache: {
+            purgeable: false,
+        },
+    },
+};
+export class Client {
+    constructor(globals, config = {}) {
+        this.mode = AppMode.production;
+        if (!globals?.siteId) {
+            throw 'no siteId specified!';
+        }
+        this.globals = globals;
+        this.config = deepmerge(defaultConfig, config);
+        if (Object.values(AppMode).includes(this.config.mode)) {
+            this.mode = this.config.mode;
+        }
+        this.requesters = {
+            meta: new MetaAPI(new ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: this.config.meta?.origin,
+                headers: this.config.meta?.headers,
+                cache: this.config.meta?.cache,
+                globals: this.config.meta?.globals,
+                paths: this.config.meta?.paths,
+            })),
+            recommend: new RecommendAPI(new ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: this.config.recommend?.origin,
+                headers: this.config.recommend?.headers,
+                cache: this.config.recommend?.cache,
+                globals: this.config.recommend?.globals,
+                paths: this.config.recommend?.paths,
+            })),
+            search: new SearchAPI(new ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: this.config.search?.origin,
+                headers: this.config.search?.headers,
+                cache: this.config.search?.cache,
+                globals: this.config.search?.globals,
+                paths: this.config.search?.paths,
+            })),
+            suggest: new SuggestAPI(new ApiConfiguration({
+                fetchApi: this.config.fetchApi,
+                initiator: this.config.initiator,
+                mode: this.mode,
+                origin: this.config.suggest?.origin,
+                headers: this.config.suggest?.headers,
+                cache: this.config.suggest?.cache,
+                globals: this.config.suggest?.globals,
+                paths: this.config.suggest?.paths,
+            })),
+        };
+    }
+    async meta(params) {
+        const defaultParams = { siteId: this.globals.siteId };
+        params = deepmerge(defaultParams, params || {});
+        return this.requesters.meta.getMeta(params);
+    }
+    async autocomplete(params = {}) {
+        if (!params.search?.query?.string) {
+            throw 'query string parameter is required';
+        }
+        params = deepmerge(this.globals, params);
+        // start meta request immediately so it runs in parallel with suggest/search
+        const metaPromise = this.meta({ siteId: params.siteId || '' });
+        const suggestParams = {
+            siteId: params.siteId || '',
+            language: 'en',
+            query: params.search?.query?.string || '',
+            suggestionCount: (params.suggestions || {}).count || 5,
+        };
+        if (params.search?.query?.spellCorrection === false) {
+            suggestParams.disableSpellCorrect = true;
+        }
+        const suggestResults = await this.requesters.suggest.getSuggest(suggestParams);
+        const transformedSuggestResults = transformSuggestResponse(suggestResults);
+        // determine the query to use for the search request
+        // suggested text → original query → correctedQuery
+        const 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 && params.search?.query?.string) {
+            params.search.query.string = q;
+        }
+        const searchResults = await this.requesters.search.getAutocomplete(params);
+        const autocompleteResponse = {
+            ...searchResults,
+            autocomplete: transformedSuggestResults,
+        };
+        const [meta, search] = await Promise.all([metaPromise, autocompleteResponse]);
+        return { meta, search };
+    }
+    async search(params = {}) {
+        params = deepmerge(this.globals, params);
+        const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getSearch(params)]);
+        return { meta, search };
+    }
+    async category(params = {}) {
+        params = deepmerge(this.globals, params);
+        const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getCategory(params)]);
+        return { meta, search };
+    }
+    async finder(params = {}) {
+        params = deepmerge(this.globals, params);
+        const [meta, search] = await Promise.all([this.meta({ siteId: params.siteId || '' }), this.requesters.search.getFinder(params)]);
+        return { meta, search };
+    }
+    async trending(params) {
+        params = deepmerge({ siteId: this.globals.siteId }, params || {});
+        return this.requesters.suggest.getTrending(params);
+    }
+    async recommend(params) {
+        const { tag, ...otherParams } = params;
+        if (!tag) {
+            throw 'tag parameter is required';
+        }
+        const profileParams = {
+            tag,
+            siteId: params.siteId || this.globals.siteId,
+        };
+        if (otherParams.branch) {
+            profileParams.branch = otherParams.branch;
+            delete otherParams.branch;
+        }
+        const recommendParams = {
+            tag: tag,
+            ...otherParams,
+            siteId: params.siteId || this.globals.siteId,
+        };
+        const [meta, profile, recommendations] = 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 && recommendations.results,
+            responseId: recommendations ? recommendations.responseId : '',
+        };
+    }
+}

package/dist/esm/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/esm/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"}

package/dist/esm/Client/NetworkCache/NetworkCache.js

@@ -0,0 +1,168 @@
+import deepmerge from 'deepmerge';
+const CACHE_STORAGE_KEY = 'athos-networkcache';
+const defaultConfig = {
+    enabled: true,
+    ttl: 300000, // ms
+    maxSize: 1000, // KB
+    purgeable: true,
+};
+export class NetworkCache {
+    constructor(config) {
+        this.memoryCache = {};
+        this.config = deepmerge(defaultConfig, config || {});
+        this.load();
+        // this allows you to pre-populate the cache from the config - primarily used for email recs
+        this.config?.entries &&
+            Object.keys(this.config.entries).map((key) => {
+                if (this.config.entries && this.config.entries[key]) {
+                    this.set(key, this.config.entries[key]);
+                }
+            });
+    }
+    load() {
+        // initialize cache from session storage
+        if (typeof window !== 'undefined' && window?.sessionStorage) {
+            const stored = window.sessionStorage.getItem(CACHE_STORAGE_KEY);
+            const newStored = {
+                ...(stored && JSON.parse(stored)),
+            };
+            this.memoryCache = newStored || {};
+        }
+        this.purgeExpired();
+    }
+    get(key) {
+        if (this.config.enabled) {
+            this.load();
+            try {
+                let ignoreKeys = [];
+                if (typeof window !== 'undefined') {
+                    const navigationType = window.performance?.getEntriesByType('navigation')?.[0]?.type;
+                    if (navigationType === 'back_forward') {
+                        ignoreKeys = ['lastViewed', 'cart'];
+                    }
+                }
+                if (Object.keys(this.memoryCache).length && key) {
+                    let storageKey = key;
+                    // this only applies to search calls
+                    if (ignoreKeys.length && key.startsWith('/v1/search')) {
+                        try {
+                            const url = key.split('{')[0];
+                            const payload = '{' + key.split('{')[1];
+                            const searchParams = JSON.parse(payload);
+                            const foundKey = Object.keys(this.memoryCache).find((cachedResponse) => {
+                                try {
+                                    const storedUrl = cachedResponse.split('{')[0];
+                                    if (storedUrl == url) {
+                                        const storedPayload = '{' + cachedResponse.split('{')[1];
+                                        const parsedPayload = JSON.parse(storedPayload);
+                                        const allKeys = Array.from(new Set([...Object.keys(searchParams), ...Object.keys(parsedPayload)]));
+                                        for (const k of allKeys) {
+                                            if (ignoreKeys.includes(k))
+                                                continue;
+                                            if (JSON.stringify(searchParams[k]) !== JSON.stringify(parsedPayload[k])) {
+                                                return false;
+                                            }
+                                        }
+                                        return true;
+                                    }
+                                    else
+                                        return false;
+                                }
+                                catch {
+                                    return false;
+                                }
+                            });
+                            if (foundKey) {
+                                storageKey = foundKey;
+                            }
+                        }
+                        catch (e) {
+                            // key is not json
+                        }
+                    }
+                    if (this.memoryCache[storageKey]) {
+                        // compare the expiry time of the item with the current time
+                        if (Date.now() >= this.memoryCache[storageKey].expires) {
+                            // remove item
+                            const newStored = {
+                                ...this.memoryCache,
+                            };
+                            delete newStored[storageKey];
+                            // update storage
+                            window.sessionStorage.setItem(CACHE_STORAGE_KEY, JSON.stringify(newStored));
+                        }
+                        else {
+                            return this.memoryCache[storageKey].value;
+                        }
+                    }
+                }
+            }
+            catch (err) {
+                console.warn('something went wrong getting from cache', err);
+            }
+        }
+    }
+    purgeExpired() {
+        Object.keys(this.memoryCache).forEach((cacheKey) => {
+            //clean up expired cache keys in memory
+            if (Date.now() > this.memoryCache[cacheKey].expires) {
+                delete this.memoryCache[cacheKey];
+            }
+        });
+        // update storage
+        try {
+            if (typeof window !== 'undefined' && window?.sessionStorage) {
+                const stringifiedCache = JSON.stringify(this.memoryCache);
+                window.sessionStorage.setItem(CACHE_STORAGE_KEY, stringifiedCache);
+            }
+        }
+        catch {
+            console.warn('failed to store network cache');
+        }
+    }
+    set(key, value) {
+        if (this.config.enabled) {
+            this.load();
+            try {
+                const cacheObject = {
+                    value,
+                    expires: Date.now() + this.config.ttl,
+                    purgeable: this.config.purgeable,
+                };
+                // purge old items if we are over max size
+                let size = new Blob([JSON.stringify(this.memoryCache)], { endings: 'native' }).size / 1024;
+                while (size > this.config.maxSize) {
+                    const oldestKey = Object.keys(this.memoryCache)
+                        .filter((key) => this.memoryCache[key].purgeable)
+                        .sort((a, b) => {
+                        return this.memoryCache[a].expires - this.memoryCache[b].expires;
+                    })[0];
+                    if (!oldestKey)
+                        break;
+                    delete this.memoryCache[oldestKey];
+                    // recalculate size after removing oldest
+                    size = new Blob([JSON.stringify(this.memoryCache)], { endings: 'native' }).size / 1024;
+                }
+                // store cache in memory
+                this.memoryCache[key] = cacheObject;
+                if (typeof window !== 'undefined' && window?.sessionStorage) {
+                    window.sessionStorage.setItem(CACHE_STORAGE_KEY, JSON.stringify(this.memoryCache));
+                }
+            }
+            catch {
+                console.warn('something went wrong setting to cache');
+            }
+        }
+    }
+    clear() {
+        try {
+            this.memoryCache = {};
+            if (typeof window !== 'undefined' && window?.sessionStorage) {
+                window.sessionStorage.setItem(CACHE_STORAGE_KEY, '');
+            }
+        }
+        catch {
+            console.warn('something went wrong clearing cache');
+        }
+    }
+}

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

@@ -0,0 +1,60 @@
+import { AppMode } from '@athoscommerce/snap-toolbox';
+import { NetworkCache } from '../NetworkCache/NetworkCache';
+import { CacheConfig, HTTPHeaders, GenericGlobals } from '../../types';
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+    origin?: string;
+    subDomain?: string;
+}
+export declare class API<PathConfigurationType> {
+    configuration: ApiConfiguration<PathConfigurationType>;
+    private retryDelay;
+    private retryCount;
+    cache: NetworkCache;
+    constructor(configuration: ApiConfiguration<PathConfigurationType>);
+    protected get mode(): AppMode;
+    protected request<T>(context: RequestOpts, cacheKey?: string): Promise<T>;
+    private createFetchParams;
+    private fetchApi;
+}
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export interface ApiConfigurationParameters<PathConfigurationType = Record<string, string>> {
+    mode?: keyof typeof AppMode | AppMode;
+    initiator?: string;
+    origin?: string;
+    fetchApi?: FetchAPI;
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    headers?: HTTPHeaders;
+    maxRetry?: number;
+    cache?: CacheConfig;
+    globals?: GenericGlobals;
+    paths?: PathConfigurationType;
+}
+export declare class ApiConfiguration<PathConfigurationType> {
+    private config;
+    constructor(config?: ApiConfigurationParameters<PathConfigurationType>);
+    get cache(): CacheConfig;
+    get maxRetry(): number;
+    get origin(): string;
+    get initiator(): string;
+    get fetchApi(): FetchAPI;
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get headers(): HTTPHeaders;
+    set headers(newHeaders: HTTPHeaders);
+    get globals(): GenericGlobals;
+    set globals(newGlobals: GenericGlobals);
+    get mode(): AppMode;
+    get paths(): PathConfigurationType;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+//# sourceMappingURL=Abstract.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Abstract.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Abstract.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAW,MAAM,6BAA6B,CAAC;AAG/D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAIvE,MAAM,MAAM,IAAI,GAAG,GAAG,CAAC;AACvB,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAC1F,MAAM,MAAM,SAAS,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;AAClI,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,QAAQ,GAAG,eAAe,CAAC;AAEzD,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,GAAG,CAAC,qBAAqB;IAMlB,aAAa,EAAE,gBAAgB,CAAC,qBAAqB,CAAC;IALzE,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAK;IAEhB,KAAK,EAAE,YAAY,CAAC;gBAER,aAAa,EAAE,gBAAgB,CAAC,qBAAqB,CAAC;IAIzE,SAAS,KAAK,IAAI,IAAI,OAAO,CAE5B;cAEe,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAmD/E,OAAO,CAAC,iBAAiB;YAoCX,QAAQ;CAKtB;AAED,MAAM,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;AAE1D,MAAM,WAAW,0BAA0B,CAAC,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IACzF,IAAI,CAAC,EAAE,MAAM,OAAO,OAAO,GAAG,OAAO,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,oBAAoB,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAAC;IACrD,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC9B;AAED,qBAAa,gBAAgB,CAAC,qBAAqB;IACtC,OAAO,CAAC,MAAM;gBAAN,MAAM,GAAE,0BAA0B,CAAC,qBAAqB,CAAM;IAalF,IAAI,KAAK,IAAI,WAAW,CAEvB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAED,IAAI,oBAAoB,IAAI,CAAC,MAAM,EAAE,SAAS,KAAK,MAAM,CAExD;IAED,IAAI,OAAO,IAAI,WAAW,CAEzB;IAED,IAAI,OAAO,CAAC,UAAU,EAAE,WAAW,EAElC;IAED,IAAI,OAAO,IAAI,cAAc,CAE5B;IAED,IAAI,OAAO,CAAC,UAAU,EAAE,cAAc,EAErC;IAED,IAAI,IAAI,IAAI,OAAO,CAElB;IAED,IAAI,KAAK,IAAI,qBAAqB,CAEjC;CACD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,SAAK,GAAG,MAAM,CAmBlE"}

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

@@ -0,0 +1,165 @@
+import deepmerge from 'deepmerge';
+import { AppMode, version } from '@athoscommerce/snap-toolbox';
+import { fibonacci } from '../utils/fibonacci';
+import { NetworkCache } from '../NetworkCache/NetworkCache';
+const isBlob = (value) => typeof Blob !== 'undefined' && value instanceof Blob;
+export class API {
+    constructor(configuration) {
+        this.configuration = configuration;
+        this.retryDelay = 1000;
+        this.retryCount = 0;
+        this.cache = new NetworkCache(this.configuration.cache);
+    }
+    get mode() {
+        return this.configuration.mode;
+    }
+    async request(context, cacheKey) {
+        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;
+            }
+        }
+        let response;
+        let responseJSON;
+        try {
+            response = await this.fetchApi(url, init);
+            responseJSON = await response?.json();
+            if (response.status >= 200 && response.status < 300) {
+                this.retryCount = 0; // reset count and delay incase rate limit occurs again before a page refresh
+                this.retryDelay = 1000;
+                if (cacheKey) {
+                    // save in the cache before returning
+                    this.cache.set(`${context.path}/${cacheKey}`, responseJSON);
+                }
+                return responseJSON;
+            }
+            else if (response.status == 429) {
+                if (this.retryCount < this.configuration.maxRetry) {
+                    await new Promise((resolve) => setTimeout(resolve, this.retryDelay)); // delay retry
+                    this.retryDelay = fibonacci(this.retryCount) * 1000;
+                    this.retryCount++;
+                    throw new Error('Rate limited.');
+                }
+                else {
+                    throw new Error('Retry rate limit exceeded.');
+                }
+            }
+            else if (response.status == 404 && responseJSON?.message == 'Profile is currently paused') {
+                //dont throw if profile is paused.
+                throw new Error(`${responseJSON.message}: ${context.query?.tag}`);
+            }
+            throw new Error('Unexpected Response Status.');
+        }
+        catch (err) {
+            if (err.message == 'Rate limited.') {
+                return await this.request(context, cacheKey);
+            }
+            // throw an object with fetch details
+            throw { err, fetchDetails: { status: response?.status, message: response?.statusText || 'FAILED', url, ...init } };
+        }
+    }
+    createFetchParams(context) {
+        // grab siteID out of context to generate apiHost fo URL
+        const siteId = context?.body?.siteId || context?.query?.siteId;
+        if (!siteId) {
+            throw new Error(`Request failed. Missing "siteId" parameter.`);
+        }
+        const siteIdHost = `https://${siteId}.a${context.subDomain ? `.${context.subDomain}` : ''}.athoscommerce.net`;
+        const origin = (context.origin || this.configuration.origin || siteIdHost).replace(/\/$/, '');
+        let url = `${origin}/${context.path.replace(/^\//, '')}`;
+        // merging globals to request query
+        const combinedQuery = deepmerge(context.query || {}, this.configuration.globals);
+        if (Object.keys(combinedQuery).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            url += '?' + this.configuration.queryParamsStringify(combinedQuery);
+        }
+        // merging globals to request body
+        const body = (typeof FormData !== 'undefined' && context.body instanceof FormData) || context.body instanceof URLSearchParams || isBlob(context.body)
+            ? context.body
+            : JSON.stringify(context.body ? deepmerge(context.body, this.configuration.globals) : context.body);
+        const headers = { ...this.configuration.headers, ...context.headers };
+        const init = {
+            method: context.method,
+            headers: headers,
+            body,
+        };
+        return { url, init };
+    }
+    async fetchApi(url, init) {
+        const response = await this.configuration.fetchApi(url, init);
+        return response;
+    }
+}
+export class ApiConfiguration {
+    constructor(config = {}) {
+        this.config = config;
+        if (!config.maxRetry) {
+            this.config.maxRetry = 8;
+        }
+        this.config.cache = this.config.cache || {};
+        this.config.mode = this.config.mode || AppMode.production;
+        if (this.config.mode == AppMode.development) {
+            this.config.cache.enabled = false;
+        }
+    }
+    get cache() {
+        return this.config?.cache || {};
+    }
+    get maxRetry() {
+        return this.config.maxRetry || 8;
+    }
+    get origin() {
+        return this.config.origin || '';
+    }
+    get initiator() {
+        return this.config.initiator || `snap/client/${version}`;
+    }
+    get fetchApi() {
+        return this.config.fetchApi || (typeof window !== 'undefined' ? window.fetch?.bind(window) : fetch);
+    }
+    get queryParamsStringify() {
+        return this.config.queryParamsStringify || querystring;
+    }
+    get headers() {
+        return this.config.headers || {};
+    }
+    set headers(newHeaders) {
+        this.config.headers = newHeaders;
+    }
+    get globals() {
+        return this.config.globals || {};
+    }
+    set globals(newGlobals) {
+        this.config.globals = newGlobals;
+    }
+    get mode() {
+        return this.config.mode;
+    }
+    get paths() {
+        return this.config.paths || {};
+    }
+}
+export function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map((key) => {
+        const fullKey = prefix + (prefix.length ? `[${key}]` : key);
+        const value = params[key];
+        if (value instanceof Array) {
+            const multiValue = value.map((singleValue) => encodeURIComponent(String(singleValue))).join(`&${encodeURIComponent(fullKey)}=`);
+            return `${encodeURIComponent(fullKey)}=${multiValue}`;
+        }
+        if (value instanceof Date) {
+            return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+        }
+        if (value instanceof Object) {
+            return querystring(value, fullKey);
+        }
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+    })
+        .filter((part) => part.length > 0)
+        .join('&');
+}

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

@@ -0,0 +1,8 @@
+import { MetaRequestModel, MetaResponseModel } from '@athoscommerce/snapi-types';
+import { API } from '.';
+import { MetaRequesterPaths } from '../../types';
+export declare class MetaAPI extends API<MetaRequesterPaths> {
+    postMeta(requestParameters: MetaRequestModel): Promise<MetaResponseModel>;
+    getMeta(queryParameters: MetaRequestModel): Promise<MetaResponseModel>;
+}
+//# sourceMappingURL=Meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../../../src/Client/apis/Meta.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEjF,OAAO,EAAE,GAAG,EAAa,MAAM,GAAG,CAAC;AACnC,OAAO,EAAe,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE9D,qBAAa,OAAQ,SAAQ,GAAG,CAAC,kBAAkB,CAAC;IACtC,QAAQ,CAAC,iBAAiB,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBzE,OAAO,CAAC,eAAe,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAanF"}

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

@@ -0,0 +1,23 @@
+import { API } from '.';
+export class MetaAPI extends API {
+    async postMeta(requestParameters) {
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        const response = await this.request({
+            path: this.configuration.paths.meta || '/v1/meta',
+            method: 'POST',
+            headers: headerParameters,
+            body: requestParameters,
+        }, JSON.stringify(requestParameters));
+        return response;
+    }
+    async getMeta(queryParameters) {
+        const response = await this.request({
+            path: this.configuration.paths.meta || '/v1/meta',
+            method: 'GET',
+            headers: {},
+            query: queryParameters,
+        }, JSON.stringify(queryParameters));
+        return response;
+    }
+}