npm - @bridgeline-digital/hawksearch-handlebars-ui - Versions diffs - 5.2.6 → 5.2.8 - Mend

@bridgeline-digital/hawksearch-handlebars-ui 5.2.6 → 5.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (96) hide show

package/dist/recommendations.html ADDED Viewed

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8" />
+        <title>HawkSearch Demo (recommendations)</title>
+        <meta name="description" content="This is a demo of the HawkSearch Handlebars UI" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <style type="text/css">
+            body {
+                font-family: Arial, Helvetica, sans-serif;
+                font-size: 16px;
+            }
+            .layout-container {
+                margin: 0 auto;
+                min-width: 340px;
+                max-width: 1280px;
+            }
+        </style>
+        <script type="text/javascript">
+            var HawkSearch = HawkSearch || {};
+            HawkSearch.config = {
+                clientId: 'f51060e1c38446f0bacdf283390c37e8',
+                search: {
+                    url: ''
+                },
+                urlPrefixes: {
+                    assets: '//dev.hawksearch.net',
+                    content: '//preview-dev.hawksearch.net/elasticdemo'
+                }
+            };
+        </script>
+    <script defer src="index.js"></script></head>
+    <body>
+        <div class="layout-container">
+            <h1>HawkSearch Demo (recommendations)</h1>
+            <div style="margin: 0 0 30px 0">
+                <hawksearch-search-field></hawksearch-search-field>
+            </div>
+            <hawksearch-recommendations widget-id="ac843f01-3391-41ee-9db2-36929a021622"></hawksearch-recommendations>
+        </div>
+    </body>
+</html>

package/dist/services/autocomplete.service.d.ts ADDED Viewed

@@ -0,0 +1,11 @@
+import { AutocompleteResponse } from '@models';
+import { BaseService } from '@services';
+export declare class AutocompleteService extends BaseService {
+    protected baseUrl: string;
+    private decodeQuery;
+    query(query?: string): Promise<AutocompleteResponse>;
+    private executeAutocomplete;
+    private convertResponse;
+    bindComponent(autocompleteResponse: AutocompleteResponse): void;
+}
+export declare const autocompleteService: AutocompleteService;

package/dist/services/base.service.d.ts ADDED Viewed

@@ -0,0 +1,63 @@
+import { HawkSearchComponents } from '@configuration';
+import { ItemVariant, RawVariantDocument } from '@models';
+export interface FieldMappings {
+    description: Array<string>;
+    imageUrl: Array<string>;
+    price: Array<string>;
+    rating: Array<string>;
+    salePrice: Array<string>;
+    sku: Array<string>;
+    title: Array<string>;
+    type: Array<string>;
+    url: Array<string>;
+}
+export interface VariantFieldMappings {
+    color: {
+        name: Array<string>;
+        hex: Array<string>;
+        imageUrl: Array<string>;
+    };
+    description: Array<string>;
+    id: Array<string>;
+    imageUrl: Array<string>;
+    price: Array<string>;
+    rating: Array<string>;
+    salePrice: Array<string>;
+    sku: Array<string>;
+    title: Array<string>;
+    url: Array<string>;
+}
+export declare abstract class BaseService {
+    protected abstract baseUrl: string;
+    protected fieldMappings: FieldMappings;
+    protected variantFieldMappings: VariantFieldMappings;
+    queryStringParams: {
+        disableSpellcheck: string;
+        page: string;
+        pageSize: string;
+        query: string;
+        searchWithin: string;
+        sort: string;
+    };
+    searchUrl: string;
+    protected get onSearchPage(): boolean;
+    constructor();
+    protected httpPost<T>(relativeUrl: string, body?: any): Promise<T>;
+    private getHeaders;
+    private getFieldMappings;
+    protected getVisitorId(): string;
+    protected getVisitId(): string;
+    protected generateGuid(): string;
+    protected stripHtml(input: string): string;
+    protected getValue(data: object, fieldMappings: Array<string>): Array<string> | undefined;
+    protected getString(data: object, fieldMappings: Array<string>, defaultValue?: string): string | undefined;
+    protected getNumber(data: object, fieldMappings: Array<string>, defaultValue?: number): number | undefined;
+    protected getUrl(data: object, fieldMappings: Array<string>, prefix?: string | undefined): string | undefined;
+    protected getFullUrl(url: string | undefined, prefix: string | undefined): string | undefined;
+    protected getVariants(document: RawVariantDocument): {
+        items: Array<ItemVariant> | undefined;
+        selectedItem?: ItemVariant;
+    };
+    protected triggerBindEvent<T>(component: keyof HawkSearchComponents, data: T, filter?: string): void;
+    protected triggerEvent<T>(name: string, data: T): void;
+}

package/dist/services/index.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+/**
+ * @module Services
+ */
+export * from './base.service';
+export * from './autocomplete.service';
+export * from './recommendations.service';
+export * from './search.service';
+export * from './tracking.service';

package/dist/services/recommendations.service.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { RecommendationsRequest, RecommendationsResponse } from '@models';
+import { BaseService } from '@services';
+export declare class RecommendationsService extends BaseService {
+    protected baseUrl: string;
+    getItems(recommendationsRequest: RecommendationsRequest): Promise<RecommendationsResponse>;
+    private executeRecommendations;
+    private convertResponse;
+    bindComponents(recommendationsResponse: RecommendationsResponse): void;
+}
+export declare const recommendationsService: RecommendationsService;

package/dist/services/search.service.d.ts ADDED Viewed

@@ -0,0 +1,53 @@
+import { SearchRequest, SearchResponse, SelectedFacets } from '@models';
+import { BaseService } from '@services';
+export declare class SearchService extends BaseService {
+    protected baseUrl: string;
+    private facetExclusionPrefix;
+    private decodeQuery;
+    private decodeFacetValues;
+    private shouldRenderUI;
+    search(searchRequest: SearchRequest): Promise<SearchResponse>;
+    query(query?: string, selectedFacets?: SelectedFacets | undefined, disableSpellcheck?: boolean): Promise<SearchResponse | void>;
+    addFacetValue(field: string, value: string): Promise<SearchResponse>;
+    removeFacetValue(field: string, value: string): Promise<SearchResponse>;
+    includeFacetValue(field: string, value: string): Promise<SearchResponse>;
+    excludeFacetValue(field: string, value: string): Promise<SearchResponse>;
+    private clearExistingFacetValue;
+    setFacetValue(field: string, value: string): Promise<SearchResponse>;
+    searchWithin(value: string): Promise<SearchResponse>;
+    selectTab(value?: string): Promise<SearchResponse>;
+    paginate(page: number): Promise<SearchResponse>;
+    setPageSize(pageSize: number): Promise<SearchResponse>;
+    sort(value?: string): Promise<SearchResponse>;
+    private executeSearch;
+    private ensureSearchRequest;
+    private convertResponse;
+    bindComponents(searchResponse: SearchResponse): void;
+    bindFacetsListComponent(searchResponse: SearchResponse | undefined): void;
+    bindLandingPageComponent(searchResponse: SearchResponse | undefined): void;
+    bindModifiedQueryComponent(searchResponse: SearchResponse | undefined): void;
+    bindPageSizeComponent(searchResponse: SearchResponse | undefined): void;
+    bindPaginationComponent(searchResponse: SearchResponse | undefined): void;
+    bindSearchFieldComponent(searchResponse: SearchResponse | undefined): void;
+    bindSearchResultsComponent(searchResponse: SearchResponse | undefined): void;
+    bindSearchResultsListComponent(searchResponse: SearchResponse | undefined): void;
+    bindQuerySuggestionsComponent(searchResponse: SearchResponse | undefined): void;
+    bindSortingComponent(searchResponse: SearchResponse | undefined): void;
+    bindSelectedFacetsComponent(searchResponse: SearchResponse | undefined): void;
+    bindTabsComponent(searchResponse: SearchResponse | undefined): void;
+    bindZoneComponent(searchResponse: SearchResponse | undefined): void;
+    getRequestFromUrl(): SearchRequest;
+    private setQueryString;
+    private getSearchUrl;
+    private getBooleanParameter;
+    private getPositiveIntegerParameter;
+    private getStringParameter;
+    private getRecentQueries;
+    private saveRecentQueries;
+    protected setSeoElements(searchResponse: SearchResponse): void;
+    private removeElement;
+    private setLinkTag;
+    private setMetaTag;
+    private setTitle;
+}
+export declare const searchService: SearchService;

package/dist/services/tracking.service.d.ts ADDED Viewed

@@ -0,0 +1,29 @@
+import { AutocompleteItemType, EventType, PageType } from '@models';
+import { BaseService } from '@services';
+export declare class TrackingService extends BaseService {
+    protected baseUrl: string;
+    trackAddToCart(productId: string, quantity: number, price: number, currencyIsoCode: string): Promise<void>;
+    trackAddToCartMultiple(items: Array<{
+        productId: string;
+        quantity: number;
+        price: number;
+        currencyIsoCode: string;
+    }>): Promise<void>;
+    trackAutocompleteClick(query: string | undefined, itemType: AutocompleteItemType, title: string, url: string): Promise<void>;
+    trackBannerClick(bannerId: number, campaignId: number): Promise<void>;
+    trackBannerImpression(bannerId: number, campaignId: number): Promise<void>;
+    trackOrder(orderId: string, items: Array<{
+        productId: string;
+        quantity: number;
+        price: number;
+    }>, subTotal: number, tax: number, total: number, currencyIsoCode: string): Promise<void>;
+    trackPageLoad(pageType: PageType, productId?: string): Promise<void>;
+    trackRating(productId: string, rating: number): Promise<void>;
+    trackRecommendationClick(widgetId: string, requestId: string, productId: string): Promise<void>;
+    trackSearchResultClick(id: string, url: string, event?: PointerEvent): Promise<void>;
+    trackSearch(query: string | undefined, newSearch: boolean): Promise<void>;
+    trackEvent(type: EventType, data: any): Promise<void>;
+    private getQueryId;
+    private setNewQueryId;
+}
+export declare const trackingService: TrackingService;