@searchspring/snap-controller 0.20.0

package/dist/esm/Abstract/AbstractController.js

@@ -0,0 +1,181 @@
+import { LogMode } from '@searchspring/snap-logger';
+import { DomTargeter, cookies, url } from '@searchspring/snap-toolbox';
+const SS_DEV_COOKIE = 'ssDev';
+export class AbstractController {
+    constructor(config, { client, store, urlManager, eventManager, profiler, logger, tracker }) {
+        this.type = 'abstract';
+        this.targeters = {};
+        this._initialized = false;
+        this._environment = LogMode.PRODUCTION;
+        if (typeof config != 'object' || typeof config.id != 'string' || !config.id.match(/^[a-zA-Z0-9_-]*$/)) {
+            throw new Error(`Invalid config passed to controller. The "id" attribute must be an alphanumeric string.`);
+        }
+        if (typeof client != 'object' || typeof client.search != 'function') {
+            throw new Error(`Invalid service 'client' passed to controller. Missing "search" function.`);
+        }
+        if (typeof store != 'object' || typeof store.update != 'function') {
+            throw new Error(`Invalid service 'store' passed to controller. Missing "update" function.`);
+        }
+        if (typeof urlManager != 'object' || typeof urlManager.subscribe != 'function') {
+            throw new Error(`Invalid service 'urlManager' passed to controller. Missing "subscribe" function.`);
+        }
+        if (typeof eventManager != 'object' || typeof eventManager.on != 'function') {
+            throw new Error(`Invalid service 'eventManager' passed to controller. Missing "on" function.`);
+        }
+        if (typeof eventManager != 'object' || typeof eventManager.fire != 'function') {
+            throw new Error(`Invalid service 'eventManager' passed to controller. Missing "fire" function.`);
+        }
+        if (typeof profiler != 'object' || typeof profiler.setNamespace != 'function') {
+            throw new Error(`Invalid service 'profiler' passed to controller. Missing "setNamespace" function.`);
+        }
+        if (typeof profiler != 'object' || typeof profiler.create != 'function') {
+            throw new Error(`Invalid service 'profiler' passed to controller. Missing "create" function.`);
+        }
+        if (typeof logger != 'object' || typeof logger.dev != 'function') {
+            throw new Error(`Invalid service 'logger' passed to controller. Missing "dev" function.`);
+        }
+        if (typeof tracker != 'object' || typeof tracker.track != 'object') {
+            throw new Error(`Invalid service 'tracker' passed to controller. Missing "track" object.`);
+        }
+        window.searchspring = window.searchspring || {};
+        window.searchspring.controller = window.searchspring.controller || {};
+        if (window.searchspring.controller[config.id]) {
+            throw new Error(`Controller with id '${config.id}' is already defined`);
+        }
+        window.searchspring.controller[config.id] = this;
+        this.id = config.id;
+        this.config = config;
+        this.client = client;
+        this.store = store;
+        this.urlManager = urlManager;
+        this.eventManager = eventManager;
+        this.profiler = profiler;
+        this.log = logger;
+        this.tracker = tracker;
+        // configure the logger
+        this.log.setNamespace(this.config.id);
+        // set namespaces
+        this.profiler.setNamespace(this.config.id);
+        // set environment
+        if (url(window.location.href)?.params?.query?.dev) {
+            cookies.set(SS_DEV_COOKIE, '1', 'Lax', 0);
+        }
+        const dev = cookies.get(SS_DEV_COOKIE);
+        this.environment = (dev === '1' ? 'development' : process.env.NODE_ENV);
+    }
+    get initialized() {
+        return this._initialized;
+    }
+    createTargeter(target, onTarget, document) {
+        return this.addTargeter(new DomTargeter([target], onTarget, document));
+    }
+    addTargeter(target) {
+        const firstTarget = target.getTargets()[0];
+        const targetName = firstTarget?.name ?? firstTarget?.selector;
+        if (targetName && !this.targeters[targetName]) {
+            this.targeters[targetName] = target;
+            return target;
+        }
+    }
+    set environment(env) {
+        if (Object.values(LogMode).includes(env)) {
+            this._environment = env;
+            this.log.setMode(env);
+        }
+    }
+    get environment() {
+        return this._environment;
+    }
+    async init() {
+        if (this._initialized) {
+            this.log.warn(`'init' middleware recalled`);
+        }
+        const initProfile = this.profiler.create({ type: 'event', name: 'init', context: this.config }).start();
+        try {
+            try {
+                await this.eventManager.fire('init', {
+                    controller: this,
+                });
+            }
+            catch (err) {
+                if (err?.message == 'cancelled') {
+                    this.log.warn(`'init' middleware cancelled`);
+                }
+                else {
+                    this.log.error(`error in 'init' middleware`);
+                    throw err;
+                }
+            }
+        }
+        catch (err) {
+            if (err) {
+                console.error(err);
+            }
+        }
+        if (!this._initialized) {
+            // subscribe to urlManager changes
+            this.urlManager.subscribe((prev, next) => {
+                try {
+                    const prevString = JSON.stringify(prev);
+                    const nextString = JSON.stringify(next);
+                    if (prevString !== nextString) {
+                        this.search();
+                    }
+                }
+                catch (err) {
+                    this.log.error('URL state is invalid', err);
+                }
+            });
+            this._initialized = true;
+        }
+        initProfile.stop();
+        this.log.profile(initProfile);
+    }
+    retarget() {
+        Object.keys(this.targeters).forEach((target) => {
+            this.targeters[target].retarget();
+        });
+    }
+    async plugin(func, ...args) {
+        await func(this, ...args);
+    }
+    on(event, ...func) {
+        this.eventManager.on(event, ...func);
+    }
+    use(attachments) {
+        // attach plugins
+        if (attachments?.plugins) {
+            try {
+                if (!Array.isArray(attachments?.plugins)) {
+                    throw 'invalid format';
+                }
+                attachments?.plugins.forEach((plugin) => {
+                    if (!Array.isArray(plugin)) {
+                        throw 'invalid format';
+                    }
+                    const [func, ...args] = plugin;
+                    this.plugin(func, ...args);
+                });
+            }
+            catch (err) {
+                this.log.warn('plugins not attached - use format [func, ...args?][]');
+            }
+        }
+        // attach event middleware
+        if (attachments?.middleware) {
+            Object.keys(attachments.middleware).forEach((eventName) => {
+                const eventMiddleware = attachments.middleware[eventName];
+                let middlewareArray;
+                if (Array.isArray(eventMiddleware)) {
+                    middlewareArray = eventMiddleware;
+                }
+                else {
+                    middlewareArray = [eventMiddleware];
+                }
+                middlewareArray.forEach((middleware) => {
+                    this.on(eventName, middleware);
+                });
+            });
+        }
+    }
+}

package/dist/esm/Autocomplete/AutocompleteController.d.ts

@@ -0,0 +1,40 @@
+import { StorageStore } from '@searchspring/snap-store-mobx';
+import { AbstractController } from '../Abstract/AbstractController';
+import type { AutocompleteStore } from '@searchspring/snap-store-mobx';
+import type { AutocompleteControllerConfig, ControllerServices } from '../types';
+import type { AutocompleteRequestModel } from '@searchspring/snapi-types';
+declare type AutocompleteTrackMethods = {
+    product: {
+        click: (e: any, result: any) => void;
+    };
+};
+export declare class AutocompleteController extends AbstractController {
+    type: string;
+    store: AutocompleteStore;
+    config: AutocompleteControllerConfig;
+    storage: StorageStore;
+    constructor(config: AutocompleteControllerConfig, { client, store, urlManager, eventManager, profiler, logger, tracker }: ControllerServices);
+    track: AutocompleteTrackMethods;
+    get params(): AutocompleteRequestModel;
+    setFocused(inputElement?: HTMLInputElement): Promise<void>;
+    reset(): void;
+    handlers: {
+        input: {
+            enterKey: (e: KeyboardEvent) => Promise<void>;
+            escKey: (e: KeyboardEvent) => void;
+            focus: (e: FocusEvent) => void;
+            formSubmit: (e: any) => Promise<void>;
+            keyUp: (e: KeyboardEvent) => void;
+            timeoutDelay: any;
+        };
+        document: {
+            click: (e: MouseEvent) => void;
+        };
+    };
+    unbind(): void;
+    bind(): Promise<void>;
+    searchTrending: () => Promise<void>;
+    search: () => Promise<void>;
+}
+export {};
+//# sourceMappingURL=AutocompleteController.d.ts.map

package/dist/esm/Autocomplete/AutocompleteController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutocompleteController.d.ts","sourceRoot":"","sources":["../../../src/Autocomplete/AutocompleteController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAA0B,MAAM,+BAA+B,CAAC;AAErF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAGpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EAAE,4BAA4B,EAAkD,kBAAkB,EAAa,MAAM,UAAU,CAAC;AAC5I,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAuB1E,aAAK,wBAAwB,GAAG;IAC/B,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,KAAA,EAAE,MAAM,KAAA,KAAK,IAAI,CAAC;KAC3B,CAAC;CACF,CAAC;AAEF,qBAAa,sBAAuB,SAAQ,kBAAkB;IACtD,IAAI,SAAkB;IACtB,KAAK,EAAE,iBAAiB,CAAC;IACzB,MAAM,EAAE,4BAA4B,CAAC;IACrC,OAAO,EAAE,YAAY,CAAC;gBAEjB,MAAM,EAAE,4BAA4B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB;IAkD5I,KAAK,EAAE,wBAAwB,CAO7B;IAEF,IAAI,MAAM,IAAI,wBAAwB,CA+BrC;IAEK,UAAU,CAAC,YAAY,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BhE,KAAK,IAAI,IAAI;IASb,QAAQ;;0BAEc,aAAa,KAAG,QAAQ,IAAI,CAAC;wBA6CrC,aAAa,KAAG,IAAI;uBAMrB,UAAU,KAAG,IAAI;oCAQL,QAAQ,IAAI,CAAC;uBAwCzB,aAAa,KAAG,IAAI;;;;uBA0CpB,UAAU,KAAG,IAAI;;MAS5B;IAEF,MAAM,IAAI,IAAI;IAYR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgE3B,cAAc,QAAa,QAAQ,IAAI,CAAC,CAsBtC;IAEF,MAAM,QAAa,QAAQ,IAAI,CAAC,CA6G9B;CACF"}