@athoscommerce/snap-controller 1.0.0

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export { FinderController } from './Finder/FinderController';
+export { SearchController } from './Search/SearchController';
+export { AutocompleteController, INPUT_DELAY } from './Autocomplete/AutocompleteController';
+export { RecommendationController } from './Recommendation/RecommendationController';
+export { AbstractController } from './Abstract/AbstractController';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,cAAc,SAAS,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export { FinderController } from './Finder/FinderController';
+export { SearchController } from './Search/SearchController';
+export { AutocompleteController, INPUT_DELAY } from './Autocomplete/AutocompleteController';
+export { RecommendationController } from './Recommendation/RecommendationController';
+export { AbstractController } from './Abstract/AbstractController';
+export * from './types';

package/dist/esm/types.d.ts

@@ -0,0 +1,87 @@
+import type { AbstractController, AutocompleteController, SearchController, FinderController, RecommendationController } from './index';
+import type { EventManager, Middleware } from '@athoscommerce/snap-event-manager';
+import type { Client } from '@athoscommerce/snap-client';
+import type { SearchStore, AutocompleteStore, FinderStore, RecommendationStore, StoreConfig, SearchStoreConfig, FinderStoreConfig, AutocompleteStoreConfig, RecommendationStoreConfig } from '@athoscommerce/snap-store-mobx';
+import type { Tracker, ProductViewEvent } from '@athoscommerce/snap-tracker';
+import type { Profiler } from '@athoscommerce/snap-profiler';
+import type { UrlManager } from '@athoscommerce/snap-url-manager';
+import type { Logger } from '@athoscommerce/snap-logger';
+import type { AutocompleteRequestModel, SearchRequestModel } from '@athoscommerce/snapi-types';
+export type PluginFunction = (cntrlr: AbstractController, ...args: any) => Promise<void> | void;
+export type PluginGrouping = [func: PluginFunction, ...args: unknown[]];
+export type BeforeSearchObj = {
+    controller: AbstractController;
+    request: any;
+};
+export type SearchAfterSearchObj = {
+    controller: SearchController;
+    response: any;
+    request: SearchRequestModel;
+};
+export type AutocompleteAfterSearchObj = {
+    controller: AutocompleteController;
+    response: any;
+    request: AutocompleteRequestModel;
+};
+export type FinderAfterSearchObj = {
+    controller: FinderController;
+    response: any;
+    request: SearchRequestModel;
+};
+export type AfterSearchObj = SearchAfterSearchObj | AutocompleteAfterSearchObj | FinderAfterSearchObj;
+export type AfterStoreObj = {
+    controller: AbstractController;
+    request: any;
+    response: any;
+};
+export type RestorePositionObj = {
+    controller: AbstractController;
+    element?: ElementPositionObj;
+};
+export type ElementPositionObj = {
+    href?: string;
+    selector?: string;
+    domRect?: DOMRect;
+};
+export declare enum ControllerTypes {
+    search = "search",
+    autocomplete = "autocomplete",
+    finder = "finder",
+    recommendation = "recommendation"
+}
+export type Controllers = SearchController | AutocompleteController | FinderController | RecommendationController;
+export type ControllerServices = {
+    client: Client;
+    store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore;
+    urlManager: UrlManager;
+    eventManager: EventManager;
+    profiler: Profiler;
+    logger: Logger;
+    tracker: Tracker;
+};
+export type Attachments = {
+    middleware?: {
+        [eventName: string]: Middleware<any> | Middleware<any>[];
+    };
+    plugins?: PluginGrouping[];
+    [any: string]: unknown;
+};
+export type ContextVariables = {
+    shopper?: {
+        id: string;
+        cart?: ProductViewEvent[];
+        [variable: string]: any;
+    };
+    page?: PageContextVariable;
+    [variable: string]: any;
+};
+export type PageContextVariable = {
+    type: 'search' | 'category';
+};
+export type ControllerConfig = StoreConfig & Attachments;
+export type SearchControllerConfig = ControllerConfig & SearchStoreConfig;
+export type FinderControllerConfig = ControllerConfig & FinderStoreConfig;
+export type AutocompleteControllerConfig = ControllerConfig & AutocompleteStoreConfig;
+export type RecommendationControllerConfig = ControllerConfig & RecommendationStoreConfig;
+export type ControllerConfigs = SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AACxI,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAElF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,KAAK,EACX,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,KAAK,EACX,wBAAwB,EAGxB,kBAAkB,EAElB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChG,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAExE,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,UAAU,EAAE,gBAAgB,CAAC;IAE7B,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACxC,UAAU,EAAE,sBAAsB,CAAC;IAEnC,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,wBAAwB,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,UAAU,EAAE,gBAAgB,CAAC;IAE7B,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,kBAAkB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;AAEtG,MAAM,MAAM,aAAa,GAAG;IAC3B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,oBAAY,eAAe;IAC1B,MAAM,WAAW;IACjB,YAAY,iBAAiB;IAC7B,MAAM,WAAW;IACjB,cAAc,mBAAmB;CACjC;AAED,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,gBAAgB,GAAG,wBAAwB,CAAC;AAElH,MAAM,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,WAAW,GAAG,iBAAiB,GAAG,WAAW,GAAG,mBAAmB,CAAC;IAC3E,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,UAAU,CAAC,EAAE;QACZ,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;KACzD,CAAC;IACF,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,OAAO,CAAC,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAC1B,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;KACxB,CAAC;IACF,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAGzD,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,MAAM,MAAM,4BAA4B,GAAG,gBAAgB,GAAG,uBAAuB,CAAC;AAEtF,MAAM,MAAM,8BAA8B,GAAG,gBAAgB,GAAG,yBAAyB,CAAC;AAE1F,MAAM,MAAM,iBAAiB,GAAG,sBAAsB,GAAG,4BAA4B,GAAG,sBAAsB,GAAG,8BAA8B,CAAC"}

package/dist/esm/types.js

@@ -0,0 +1,7 @@
+export var ControllerTypes;
+(function (ControllerTypes) {
+    ControllerTypes["search"] = "search";
+    ControllerTypes["autocomplete"] = "autocomplete";
+    ControllerTypes["finder"] = "finder";
+    ControllerTypes["recommendation"] = "recommendation";
+})(ControllerTypes || (ControllerTypes = {}));

package/dist/esm/utils/getParams.d.ts

@@ -0,0 +1,3 @@
+import type { ImmutableUrlState } from '@athoscommerce/snap-url-manager';
+export declare function getSearchParams(state: ImmutableUrlState): Record<string, any>;
+//# sourceMappingURL=getParams.d.ts.map

package/dist/esm/utils/getParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getParams.d.ts","sourceRoot":"","sources":["../../../src/utils/getParams.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAEzE,wBAAgB,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgF7E"}

package/dist/esm/utils/getParams.js

@@ -0,0 +1,67 @@
+export function getSearchParams(state) {
+    const params = {};
+    if (state.tag) {
+        params.merchandising = params.merchandising || {};
+        params.merchandising.landingPage = state.tag;
+    }
+    if (state.query) {
+        params.search = params.search || {};
+        params.search.query = params.search.query || {};
+        params.search.query.string = state.query;
+    }
+    if (state.rq) {
+        params.search = params.search || {};
+        params.search.subQuery = state.rq;
+    }
+    if (state.fallbackQuery) {
+        params.search = params.search || {};
+        params.search.fallbackQuery = state.fallbackQuery;
+    }
+    if (state.page) {
+        params.pagination = params.pagination || {};
+        params.pagination.page = state.page;
+    }
+    if (state.pageSize) {
+        params.pagination = params.pagination || {};
+        params.pagination.pageSize = state.pageSize;
+    }
+    if (state.sort) {
+        params.sorts = params.sorts || [];
+        const sorts = Array.isArray(state.sort) ? state.sort : [state.sort];
+        const sort = sorts[0];
+        if (sort && sort.field && sort.direction) {
+            params.sorts.push({
+                field: sort.field,
+                direction: sort.direction,
+            });
+        }
+    }
+    if (state.filter) {
+        params.filters = params.filters || [];
+        Object.keys(state.filter).forEach((field) => {
+            if (typeof field != 'string') {
+                return;
+            }
+            const filter = state.filter[field];
+            // ensure values are an array
+            const values = Array.isArray(filter) ? filter : [filter];
+            values.forEach((value) => {
+                if (typeof value != 'object') {
+                    params.filters.push({
+                        type: 'value',
+                        field: field,
+                        value,
+                    });
+                }
+                else if (typeof value.low != 'undefined' && typeof value.high != 'undefined') {
+                    params.filters.push({
+                        type: 'range',
+                        field: field,
+                        value,
+                    });
+                }
+            });
+        });
+    }
+    return params;
+}

package/dist/esm/utils/isClickWithinBannerLink.d.ts

@@ -0,0 +1,2 @@
+export declare const isClickWithinBannerLink: (e: MouseEvent) => boolean;
+//# sourceMappingURL=isClickWithinBannerLink.d.ts.map

package/dist/esm/utils/isClickWithinBannerLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isClickWithinBannerLink.d.ts","sourceRoot":"","sources":["../../../src/utils/isClickWithinBannerLink.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,uBAAuB,MAAO,UAAU,KAAG,OAcvD,CAAC"}

package/dist/esm/utils/isClickWithinBannerLink.js

@@ -0,0 +1,17 @@
+import { CLICK_THROUGH_CLOSEST_MAX_LEVELS } from './isClickWithinProductLink';
+const TRACKING_ATTRIBUTE = 'sstracking';
+export const isClickWithinBannerLink = (e) => {
+    let currentElement = e.target;
+    let href = null;
+    let level = 0;
+    while (currentElement && (level < CLICK_THROUGH_CLOSEST_MAX_LEVELS || !currentElement.getAttribute(TRACKING_ATTRIBUTE))) {
+        href = currentElement.getAttribute('href');
+        const isAnchor = currentElement.tagName.toLowerCase() === 'a';
+        if (href && isAnchor) {
+            return true;
+        }
+        currentElement = currentElement.parentElement;
+        level++;
+    }
+    return false;
+};

package/dist/esm/utils/isClickWithinProductLink.d.ts

@@ -0,0 +1,5 @@
+import type { Product } from '@athoscommerce/snap-store-mobx';
+export declare const CLICK_DUPLICATION_TIMEOUT = 300;
+export declare const CLICK_THROUGH_CLOSEST_MAX_LEVELS = 12;
+export declare const isClickWithinProductLink: (e: MouseEvent, result: Product) => boolean;
+//# sourceMappingURL=isClickWithinProductLink.d.ts.map

package/dist/esm/utils/isClickWithinProductLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isClickWithinProductLink.d.ts","sourceRoot":"","sources":["../../../src/utils/isClickWithinProductLink.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAE9D,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAC7C,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD,eAAO,MAAM,wBAAwB,MAAO,UAAU,UAAU,OAAO,KAAG,OAoBzE,CAAC"}

package/dist/esm/utils/isClickWithinProductLink.js

@@ -0,0 +1,19 @@
+export const CLICK_DUPLICATION_TIMEOUT = 300;
+export const CLICK_THROUGH_CLOSEST_MAX_LEVELS = 12;
+export const isClickWithinProductLink = (e, result) => {
+    const resultDisplayUrl = result?.display?.mappings.core?.url || '';
+    const resultCoreUrl = result?.mappings.core?.url || '';
+    // Get the composed path to handle shadow DOM elements
+    const path = e.composedPath ? e.composedPath() : [e.target];
+    // Check up to CLICK_THROUGH_CLOSEST_MAX_LEVELS elements in the path
+    const elementsToCheck = path.slice(0, CLICK_THROUGH_CLOSEST_MAX_LEVELS);
+    for (const element of elementsToCheck) {
+        if (element instanceof Element) {
+            const href = element.getAttribute('href');
+            if (href && ((resultCoreUrl && href.includes(resultCoreUrl)) || (resultDisplayUrl && href.includes(resultDisplayUrl)))) {
+                return true;
+            }
+        }
+    }
+    return false;
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@athoscommerce/snap-controller",
+	"version": "1.0.0",
+	"description": "Snap Controllers",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"author": "Athos Commerce",
+	"license": "MIT",
+	"repository": "https://github.com/athoscommerce/snap",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "rm -rf ./dist && rm -fr ./components/dist && tsc & p1=$!; tsc -p tsconfig.cjs.json & p2=$!; wait $p1 && wait $p2",
+		"build:docs": "typedoc --out docs src/index.ts",
+		"dev": "tsc --watch",
+		"format": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+		"lint": "eslint 'src/**/*.{js,jsx,ts,tsx}'",
+		"test": "jest",
+		"test:watch": "jest --watch"
+	},
+	"dependencies": {
+		"@athoscommerce/snap-toolbox": "1.0.0",
+		"css.escape": "1.5.1",
+		"deepmerge": "4.3.1"
+	},
+	"devDependencies": {
+		"@athoscommerce/snap-client": "1.0.0",
+		"@athoscommerce/snap-event-manager": "1.0.0",
+		"@athoscommerce/snap-logger": "1.0.0",
+		"@athoscommerce/snap-profiler": "1.0.0",
+		"@athoscommerce/snap-store-mobx": "1.0.0",
+		"@athoscommerce/snap-tracker": "1.0.0",
+		"@athoscommerce/snap-url-manager": "1.0.0"
+	},
+	"sideEffects": false,
+	"files": [
+		"dist/**/*"
+	],
+	"gitHead": "714fb2d140d44581a559a6025310f8df9e33e216"
+}