@searchspring/snap-controller 0.20.0

package/dist/esm/types.d.ts

@@ -0,0 +1,52 @@
+import type { AbstractController } from './Abstract/AbstractController';
+import type { EventManager, Middleware, Next } from '@searchspring/snap-event-manager';
+import type { Client } from '@searchspring/snap-client';
+import type { AbstractStore, StoreConfig, SearchStoreConfig, FinderStoreConfig, AutocompleteStoreConfig, RecommendationStoreConfig } from '@searchspring/snap-store-mobx';
+import type { Tracker } from '@searchspring/snap-tracker';
+import type { Profiler } from '@searchspring/snap-profiler';
+import type { UrlManager } from '@searchspring/snap-url-manager';
+import type { Logger } from '@searchspring/snap-logger';
+declare global {
+    interface Window {
+        searchspring?: any;
+    }
+}
+export declare type NextEvent = Next;
+export declare type PluginFunction = (cntrlr: AbstractController, ...args: any[]) => Promise<void>;
+export declare type PluginGrouping = [func: PluginFunction, ...args: unknown[]];
+export declare type BeforeSearchObj = {
+    controller: AbstractController;
+    request: any;
+};
+export declare type AfterSearchObj = {
+    controller: AbstractController;
+    response: any;
+};
+export declare type AfterStoreObj = {
+    controller: AbstractController;
+    request: any;
+    response: any;
+};
+export declare type ControllerServices = {
+    client: Client;
+    store: AbstractStore;
+    urlManager: UrlManager;
+    eventManager: EventManager;
+    profiler: Profiler;
+    logger: Logger;
+    tracker: Tracker;
+};
+export declare type Attachments = {
+    middleware?: {
+        [eventName: string]: Middleware<unknown> | Middleware<unknown>[];
+    };
+    plugins?: PluginGrouping[];
+    [any: string]: unknown;
+};
+export declare type ControllerConfig = StoreConfig & Attachments;
+export declare type SearchControllerConfig = ControllerConfig & SearchStoreConfig;
+export declare type FinderControllerConfig = ControllerConfig & FinderStoreConfig;
+export declare type AutocompleteControllerConfig = ControllerConfig & AutocompleteStoreConfig;
+export declare type RecommendationControllerConfig = ControllerConfig & RecommendationStoreConfig;
+export declare 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,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAEvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EACX,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,YAAY,CAAC,EAAE,GAAG,CAAC;KACnB;CACD;AAID,oBAAY,SAAS,GAAG,IAAI,CAAC;AAE7B,oBAAY,cAAc,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AACpF,oBAAY,cAAc,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAExE,oBAAY,eAAe,GAAG;IAC7B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC5B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC3B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,CAAC;IACrB,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,oBAAY,WAAW,GAAG;IACzB,UAAU,CAAC,EAAE;QACZ,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;KACjE,CAAC;IACF,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB,CAAC;AAEF,oBAAY,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAGzD,oBAAY,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,oBAAY,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,oBAAY,4BAA4B,GAAG,gBAAgB,GAAG,uBAAuB,CAAC;AAEtF,oBAAY,8BAA8B,GAAG,gBAAgB,GAAG,yBAAyB,CAAC;AAE1F,oBAAY,iBAAiB,GAAG,sBAAsB,GAAG,4BAA4B,GAAG,sBAAsB,GAAG,8BAA8B,CAAC"}

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export declare function getSearchParams(state: any): 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":"AAkCA,wBAAgB,eAAe,CAAC,KAAK,KAAA,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgF1D"}

package/dist/esm/utils/getParams.js

@@ -0,0 +1,68 @@
+// translate state to snAPI params
+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.oq) {
+        params.search = params.search || {};
+        params.search.originalQuery = state.oq;
+    }
+    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/package.json

@@ -0,0 +1,40 @@
+{
+	"name": "@searchspring/snap-controller",
+	"version": "0.20.0",
+	"description": "Snap Controllers",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"author": "Searchspring",
+	"license": "MIT",
+	"repository": "https://github.com/searchspring/snap",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "rm -rf ./dist && tsc && tsc -p tsconfig.cjs.json",
+		"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": {
+		"@searchspring/snap-toolbox": "^0.20.0",
+		"deepmerge": "^4.2.2"
+	},
+	"devDependencies": {
+		"@searchspring/snap-client": "^0.20.0",
+		"@searchspring/snap-event-manager": "^0.20.0",
+		"@searchspring/snap-logger": "^0.20.0",
+		"@searchspring/snap-profiler": "^0.20.0",
+		"@searchspring/snap-store-mobx": "^0.20.0",
+		"@searchspring/snap-tracker": "^0.20.0",
+		"@searchspring/snap-url-manager": "^0.20.0"
+	},
+	"sideEffects": false,
+	"files": [
+		"dist/**/*"
+	],
+	"gitHead": "122405b27b497c7bb6a189c30535fdc197bc3ef0"
+}