@getlupa/client 0.5.0 → 0.5.1-alpha-3

package/dist/es/store/modules/options.d.ts

@@ -1,16 +1,21 @@
 import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
 import { SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
-import { Options } from "@getlupa/client-sdk/Types";
+import { FilterGroup, Options } from "@getlupa/client-sdk/Types";
 import { VuexModule } from "vuex-module-decorators";
 export default class OptionsModule extends VuexModule {
     searchBoxOptions: SearchBoxOptions;
     searchResultOptions: SearchResultsOptions;
+    searchResultInitialFilters: FilterGroup;
     get envOptions(): Options;
     get classMap(): Record<string, string>;
+    get initialFilters(): FilterGroup;
     setSearchBoxOptions({ options }: {
         options: SearchBoxOptions;
     }): void;
     setSearchResultOptions({ options }: {
         options: SearchResultsOptions;
     }): void;
+    setInitialFilters({ initialFilters }: {
+        initialFilters: FilterGroup;
+    }): void;
 }

package/dist/es/store/modules/params.d.ts

@@ -25,25 +25,27 @@ export default class ParamsModule extends VuexModule {
         params: QueryParams;
         searchString: string;
     };
-    removeParams({ paramsToRemove }: {
+    removeParams({ paramsToRemove, save, }: {
         paramsToRemove?: "all" | string[];
+        save: boolean;
     }): {
-        params: QueryParams;
-        searchString: string;
+        params?: QueryParams;
+        searchString?: string;
     };
     goToResults({ searchText, facet, }: {
         searchText: string;
         facet?: InputSuggestionFacet;
     }): void;
-    appendParams({ params, paramsToRemove, encode, }: {
+    appendParams({ params, paramsToRemove, encode, save, }: {
         params: {
             name: string;
             value: string;
         }[];
         paramsToRemove?: "all" | string[];
         encode?: boolean;
+        save?: boolean;
     }): {
-        params: QueryParams;
+        params?: QueryParams;
         searchString?: string;
     };
     setDefaultLimit(defaultLimit: number): {

package/dist/es/store/modules/searchResult.d.ts

@@ -1,3 +1,4 @@
+import { LabeledFilter } from "@/types/search-results/Filters";
 import { ResultsLayout } from "@/types/search-results/ResultsLayout";
 import { ProductGrid } from "@/types/search-results/SearchResultsOptions";
 import { FacetResult, FilterGroup, SearchQueryResult } from "@getlupa/client-sdk/Types";
@@ -15,6 +16,9 @@ export default class SearchResultModule extends VuexModule {
     get currentQueryText(): string;
     get totalItems(): number;
     get hasResults(): boolean;
+    get labeledFilters(): LabeledFilter[];
+    get displayFilters(): LabeledFilter[];
+    get currentFilterCount(): number;
     get hasAnyFilter(): boolean;
     get itemRange(): number[];
     setSidebarVisibility({ visible }: {

package/dist/es/types/product-list/ProductListOptions.d.ts

@@ -0,0 +1,28 @@
+import { FilterGroup } from "@getlupa/client-sdk/Types";
+import { RoutingBehavior } from "../search-results/RoutingBehavior";
+import { SearchResultsOptions } from "../search-results/SearchResultsOptions";
+export declare type CategoryFilterOptions = {
+    queryKey: string;
+    routingBehavior?: RoutingBehavior;
+    keys: {
+        titleKey?: string;
+        urlKey?: string;
+    };
+    filters?: Record<string, string[]>;
+    back?: {
+        url: string;
+        title: string;
+    };
+    parent?: {
+        url: string;
+        title: string;
+    };
+    current?: {
+        title: string;
+        description: string;
+    };
+};
+export declare type ProductListOptions = SearchResultsOptions & {
+    initialFilters?: FilterGroup;
+    categories?: CategoryFilterOptions;
+};

package/dist/es/types/search-results/RoutingBehavior.d.ts

@@ -0,0 +1 @@
+export declare type RoutingBehavior = "direct-link" | "event";

package/dist/es/types/search-results/SearchResultsOptions.d.ts

@@ -1,4 +1,5 @@
 import { SdkOptions } from "../General";
+import { CategoryFilterOptions } from "../product-list/ProductListOptions";
 import { SearchResultsAdditionalPanelOptions } from "./SearchResultsAdditionalPanelOptions";
 import { SearchResultsProductCardOptions } from "./SearchResultsProductCardOptions";
 import { SearchResultsSortOptions } from "./SearchResultsSort";
@@ -6,7 +7,10 @@ export declare type SearchResultsOptions = SearchResultsProductOptions & SearchR
     containerSelector: string;
     breadcrumbs: SearchResultsBreadcrumb[];
     classMap?: Record<string, string>;
+    searchTitlePosition?: string;
+    noResultsQueryFlag?: string;
 };
+export declare type SearchTitlePosition = "page-top" | "search-results-top";
 export declare type SearchResultsDidYouMeanLabels = {
     noResultsSuggestion: string;
     didYouMean: string;
@@ -19,6 +23,7 @@ export declare type SearchResultsOptionLabels = SearchResultsPaginationLabels &
     sortBy: string;
     currency: string;
     priceSeparator?: string;
+    searchResults?: string;
     itemCount: string;
     emptyResults: string;
     mobileFilterButton: string;
@@ -38,6 +43,7 @@ export declare type SearchResultsProductOptions = SearchResultsProductCardOption
         layoutSelector?: boolean;
         itemSummary?: boolean;
         clearFilters?: boolean;
+        totalCount?: boolean;
     };
 };
 export declare type ProductGrid = {
@@ -76,12 +82,17 @@ export declare type ResultCurrentFilterOptions = {
         mobileSidebar: boolean;
         mobileToolbar: boolean;
     };
+    mobileSidebar?: {
+        showFilterCount?: boolean;
+        activeFiltersExpanded?: boolean;
+    };
 };
 export declare type FacetStyle = "sidebar" | "top-dropdown";
 export declare type ResultFacetOptions = {
     labels: {
         title: string;
         showAll: string;
+        showLess?: string;
         facetFilter: string;
         facetClear?: string;
     };
@@ -94,15 +105,25 @@ export declare type ResultFacetOptions = {
         topLevelValueCountLimit?: number;
         filterable?: boolean;
     };
+    stats?: {
+        slider?: boolean;
+        inputs?: boolean;
+        labels?: {
+            from?: string;
+            to?: string;
+        };
+    };
     facetValueCountLimit?: number;
     showDocumentCount?: boolean;
     style?: {
         type: FacetStyle;
     };
+    exclude?: string[];
 };
 export declare type SearchResultsFilterOptions = {
     currentFilters?: ResultCurrentFilterOptions;
     facets?: ResultFacetOptions;
+    categories?: CategoryFilterOptions;
 };
 export declare type SearchResultsBreadcrumb = {
     label: string;

package/dist/es/types/search-results/SearchResultsProductCardOptions.d.ts

@@ -1,9 +1,11 @@
 import { Document } from "@getlupa/client-sdk/Types";
 import { DocumentElement } from "../DocumentElement";
 import { BadgeElement } from "./BadgeOptions";
+import { RoutingBehavior } from "./RoutingBehavior";
 import { SearchResultsOptionLabels } from "./SearchResultsOptions";
 export declare type SearchResultsProductCardOptions = {
     labels: SearchResultsOptionLabels;
+    routingBehavior?: RoutingBehavior;
     isInStock: (doc: Document) => boolean;
     badges: SearchResultBadgeOptions;
     links: {

package/dist/es/utils/query.utils.d.ts

@@ -1,4 +1,5 @@
 import { QueryParams } from "@/types/search-results/QueryParams";
 import { SearchResultsSortOptions } from "@/types/search-results/SearchResultsSort";
-import { PublicQuery } from "@getlupa/client-sdk/Types";
+import { FilterGroup, PublicQuery } from "@getlupa/client-sdk/Types";
 export declare const createPublicQuery: (queryParams: QueryParams, sortOptions?: SearchResultsSortOptions[] | undefined) => PublicQuery;
+export declare const getPublicQuery: (publicQuery: PublicQuery, initialFilters: FilterGroup, isProductList: boolean) => PublicQuery;

package/dist/es/utils/routing.utils.d.ts

@@ -0,0 +1 @@
+export declare const emitRoutingEvent: (url: string) => void;

package/dist/iife/ProductListEntry.vue.d.ts

@@ -0,0 +1,5 @@
+import Vue from "vue";
+import { ProductListOptions } from "./types/product-list/ProductListOptions";
+export default class ProductListEntry extends Vue {
+    productListOptions: ProductListOptions;
+}

package/dist/iife/components/product-list/CategoryDescription.vue.d.ts

@@ -0,0 +1,8 @@
+import Vue from "vue";
+import { ProductListOptions } from "@/types/product-list/ProductListOptions";
+export default class CategoryDescription extends Vue {
+    options: ProductListOptions;
+    get title(): string | undefined;
+    get description(): string | undefined;
+    get overviewVisible(): boolean;
+}

package/dist/iife/components/product-list/CategoryFilter.vue.d.ts

@@ -0,0 +1,20 @@
+import Vue from "vue";
+import { Options } from "@getlupa/client-sdk/Types";
+import { CategoryFilterOptions } from "@/types/product-list/ProductListOptions";
+export default class CategoryFilter extends Vue {
+    options: CategoryFilterOptions;
+    categoryChildren: Record<string, string>[];
+    envOptions: Options;
+    get hasBackButton(): boolean;
+    get hasDirectRouting(): boolean;
+    get backTitle(): string | undefined;
+    get backUrl(): string | undefined;
+    get backUrlLink(): string | undefined;
+    get parentTitle(): string | undefined;
+    get parentUrl(): string | undefined;
+    get parentUrlLink(): string | undefined;
+    get isActive(): boolean;
+    mounted(): Promise<void>;
+    getCategoryKey(item: Record<string, string>): string;
+    handleNavigation(url: string): void;
+}

package/dist/iife/components/product-list/CategoryFilterItem.vue.d.ts

@@ -0,0 +1,12 @@
+import Vue from "vue";
+import { CategoryFilterOptions } from "@/types/product-list/ProductListOptions";
+export default class CategoryFilterItem extends Vue {
+    options: CategoryFilterOptions;
+    item: Record<string, string>;
+    get title(): string;
+    get urlLink(): string;
+    get url(): string | undefined;
+    get isActive(): boolean;
+    get hasDirectRouting(): boolean;
+    handleNavigation(): void;
+}

package/dist/iife/components/product-list/ProductList.vue.d.ts

@@ -0,0 +1,6 @@
+import Vue from "vue";
+import { ProductListOptions } from "@/types/product-list/ProductListOptions";
+export default class ProductList extends Vue {
+    options: ProductListOptions;
+    get componentOptions(): ProductListOptions;
+}

package/dist/iife/components/search-results/SearchResults.vue.d.ts

@@ -1,13 +1,16 @@
 import { QueryParams } from "@/types/search-results/QueryParams";
 import { ProductGrid, SearchResultsDidYouMeanLabels, SearchResultsOptions, SearchResultsProductOptions } from "@/types/search-results/SearchResultsOptions";
-import { PublicQuery, SearchQueryResult } from "@getlupa/client-sdk/Types";
+import { FilterGroup, PublicQuery, SearchQueryResult } from "@getlupa/client-sdk/Types";
 import Vue from "vue";
 export default class SearchResults extends Vue {
     options: SearchResultsOptions;
+    initialFilters: FilterGroup;
+    isProductList: boolean;
     get productsOptions(): SearchResultsProductOptions;
+    currentQueryText: string;
     get didYouMeanLabels(): SearchResultsDidYouMeanLabels;
-    get queryText(): string;
     get showFilterSidebar(): boolean;
+    get isTitleResultTopPosition(): boolean;
     trackSearch: ({ queryKey, query, }: {
         queryKey: string;
         query: PublicQuery;
@@ -16,8 +19,6 @@ export default class SearchResults extends Vue {
         queryKey: string;
         results: SearchQueryResult;
     }) => void;
-    currentQueryText: string;
-    suggestedSearchText: string;
     searchString: string;
     setDefaultLimit: (defaultLimit: number) => {
         defaultLimit: number;
@@ -25,9 +26,23 @@ export default class SearchResults extends Vue {
     addParams: (params: QueryParams) => {
         params: QueryParams;
     };
+    removeParams: ({ paramsToRemove, save, }: {
+        paramsToRemove: string[];
+        save: boolean;
+    }) => void;
+    appendParams: ({ params, save, }: {
+        params: {
+            name: string;
+            value: string;
+        }[];
+        save: boolean;
+    }) => void;
     setSearchResultOptions: ({ options, }: {
         options: SearchResultsOptions;
     }) => void;
+    setInitialFilters: ({ initialFilters, }: {
+        initialFilters: FilterGroup;
+    }) => void;
     mounted(): void;
     beforeDestroy(): void;
     handleMounted(): void;
@@ -38,6 +53,10 @@ export default class SearchResults extends Vue {
     };
     handleUrlChange(params?: URLSearchParams): void;
     query(publicQuery: PublicQuery): void;
+    handleResults({ queryKey, results, }: {
+        queryKey: string;
+        results: SearchQueryResult;
+    }): void;
     setColumnCount: ({ width, grid, }: {
         width: number;
         grid: ProductGrid;

package/dist/iife/components/search-results/SearchResultsTitle.vue.d.ts

@@ -0,0 +1,13 @@
+import { SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
+import Vue from "vue";
+export default class SearchResultsTitle extends Vue {
+    options: SearchResultsOptions;
+    isProductList: boolean;
+    currentQueryText: string;
+    totalItems: number;
+    suggestedSearchText: string;
+    get queryText(): string;
+    get showProductCount(): boolean;
+    get showSearchTitle(): boolean;
+    getLabel(label: string): string;
+}

package/dist/iife/components/search-results/filters/CurrentFilters.vue.d.ts

@@ -9,9 +9,10 @@ export default class CurrentFilters extends Vue {
     isOpen: boolean;
     currentFilters: FilterGroup;
     facets: FacetResult[] | undefined;
-    get labeledFilters(): LabeledFilter[];
+    displayFilters: LabeledFilter[];
+    currentFilterCount: number;
+    initialFilters: FilterGroup;
     get hasFilters(): boolean;
-    get filterCount(): number;
     removeParams: ({ paramsToRemove, }: {
         paramsToRemove?: string[];
     }) => {

package/dist/iife/components/search-results/filters/MobileFilterSidebar.vue.d.ts

@@ -6,5 +6,9 @@ export default class MobileFilterSidebar extends Vue {
         visible: boolean;
     }) => void;
     isMobileSidebarVisible: boolean;
+    currentFilterCount: number;
+    get sidebarTitle(): string;
+    get isFilterCountVisible(): boolean;
+    get isActiveFiltersExpanded(): boolean;
     handleMobileToggle(): void;
 }

package/dist/iife/components/search-results/filters/facets/FacetList.vue.d.ts

@@ -8,6 +8,7 @@ export default class FacetList extends Vue {
     currentFilters: FilterGroup;
     facetStyle: FacetStyle;
     clearable: boolean;
+    get displayFacets(): FacetResult[];
     handleFacetSelect(facetAction: FacetAction): void;
     clear(facet: FacetResult): void;
 }

package/dist/iife/components/search-results/filters/facets/StatsFacet.vue.d.ts

@@ -1,11 +1,21 @@
 import Vue from "vue";
 import { FacetGroupTypeStats, FilterGroupItemTypeRange } from "@getlupa/client-sdk/Types";
-import { ResultFacetOptions } from "@/types/search-results/SearchResultsOptions";
+import { ResultFacetOptions, SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
 export default class TermFacet extends Vue {
     options: ResultFacetOptions;
     facet: FacetGroupTypeStats;
     currentFilters: FilterGroupItemTypeRange;
     innerSliderRange: number[];
+    searchResultOptions: SearchResultsOptions;
+    get rangeLabelFrom(): string;
+    get rangeLabelTo(): string;
+    get currency(): string;
+    get isSliderVisible(): boolean;
+    get isInputVisible(): boolean;
+    get fromValue(): string;
+    set fromValue(stringValue: string);
+    get toValue(): string;
+    set toValue(stringValue: string);
     get currentGte(): number | undefined;
     get currentLte(): number | undefined;
     get currentMinValue(): number;
@@ -18,6 +28,7 @@ export default class TermFacet extends Vue {
     get statsSummary(): string;
     onMinValueChange(): void;
     onMaxValueChange(): void;
+    handleInputChange(): void;
     handleChange(): void;
     handleDragging(value: number[]): void;
 }

package/dist/iife/components/search-results/filters/facets/TermFacet.vue.d.ts

@@ -13,7 +13,8 @@ export default class TermFacet extends Vue {
     get filteredValues(): FacetGroupItem[];
     get isFilterable(): boolean;
     get isRange(): boolean;
+    get displayShowMore(): boolean;
     handleFacetClick(item: FacetGroupItem): void;
-    handleShowAll(): void;
+    toggleShowAll(): void;
     isChecked(item: FacetGroupItem): boolean;
 }

package/dist/iife/components/search-results/products/SearchResultsMobileToggle.vue.d.ts

@@ -1,6 +1,8 @@
 import Vue from "vue";
 export default class SearchResultsMobileToggle extends Vue {
     label: string;
+    showFilterCount: boolean;
+    currentFilterCount: number;
     setSidebarVisibility: ({ visible, }: {
         visible: boolean;
     }) => void;

package/dist/iife/components/search-results/products/SearchResultsToolbar.vue.d.ts

@@ -14,6 +14,7 @@ export default class SearchResultsToolbar extends Vue {
     hasAnyFilter: boolean;
     get displayPageSelect(): boolean;
     get searchSummaryLabel(): string;
+    get showMobileFilterCount(): boolean;
     removeAllFilters: () => {
         params: QueryParams;
     };

package/dist/iife/components/search-results/products/product-card/SearchResultsProductCard.vue.d.ts

@@ -22,6 +22,8 @@ export default class SearchResultsProductCard extends Vue {
     get detailElements(): DocumentElement[];
     get labels(): SearchResultsOptionLabels;
     get link(): string;
+    get hasEventRouting(): boolean;
+    get url(): string | undefined;
     isInStock: boolean;
     mounted(): void;
     checkIfIsInStock(): Promise<void>;
@@ -30,4 +32,5 @@ export default class SearchResultsProductCard extends Vue {
     handleProductEvent(item: {
         type: ReportableEventType;
     }): void;
+    handleNavigation(): void;
 }

package/dist/iife/components/search-results/products/product-card/elements/SearchResultsProductTitle.vue.d.ts

@@ -1,11 +1,15 @@
 import Vue from "vue";
 import { Document } from "@getlupa/client-sdk/Types";
 import { TitleDocumentElement } from "@/types/DocumentElement";
+import { SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
 export default class SearchResultsProductTitle extends Vue {
     item: Document;
     options: TitleDocumentElement;
     link: string;
+    searchResultOptions: SearchResultsOptions;
     get title(): unknown;
     get isHtml(): boolean;
     get maxLines(): number;
+    get hasEventRouting(): boolean;
+    handleNavigation(): void;
 }

package/dist/iife/constants/development/searchBoxDev.example.const.d.ts

@@ -19,6 +19,7 @@ export declare const SEARCH_BOX_CONFIGURATION: {
     links: {
         searchResults: string;
     };
+    searchTitlePosition: string;
     panels: SearchBoxPanel[];
     history: {
         labels: {

package/dist/iife/constants/development/searchProductListDev.example.d.ts

@@ -0,0 +1,28 @@
+export declare const PRODUCT_LIST_CONFIGURATION: {
+    initialFilters: {
+        category: string[];
+    };
+    categories: {
+        queryKey: string;
+        routingBehavior: string;
+        keys: {
+            titleKey: string;
+            urlKey: string;
+        };
+        filters: {
+            category: string[];
+        };
+        back: {
+            title: string;
+            url: string;
+        };
+        parent: {
+            title: string;
+            url: string;
+        };
+        current: {
+            title: string;
+            description: string;
+        };
+    };
+};

package/dist/iife/constants/development/searchResultsDev.example.const.d.ts

@@ -20,6 +20,9 @@ export declare const SEARCH_RESULTS_CONFIGURATION: {
         similarQuery: string;
         similarQueries: string;
     };
+    toolbar: {
+        totalCount: boolean;
+    };
     grid: {
         columns: {
             xl: number;
@@ -56,11 +59,16 @@ export declare const SEARCH_RESULTS_CONFIGURATION: {
                 title: string;
                 clearAll: string;
             };
+            mobileSidebar: {
+                showFilterCount: boolean;
+                activeFiltersExpanded: boolean;
+            };
         };
         facets: {
             labels: {
                 title: string;
                 showAll: string;
+                showLess: string;
                 facetFilter: string;
             };
             hierarchy: {
@@ -68,6 +76,14 @@ export declare const SEARCH_RESULTS_CONFIGURATION: {
                 topLevelValueCountLimit: number;
                 filterable: boolean;
             };
+            stats: {
+                slider: boolean;
+                inputs: boolean;
+                labels: {
+                    from: string;
+                    to: string;
+                };
+            };
             filterable: {
                 minValues: number;
             };

package/dist/iife/constants/global.const.d.ts

@@ -11,3 +11,4 @@ export declare const XL_MIN_WIDTH = 1199;
 export declare const MAX_FACET_VALUES = 1000;
 export declare const CURRENCY_KEY_INDICATOR = "price";
 export declare const DEFAULT_PAGE_SIZE = 12;
+export declare const LUPA_ROUTING_EVENT = "lupaRedirect";

package/dist/iife/constants/searchResults.const.d.ts

@@ -6,6 +6,7 @@ export declare const DEFAULT_OPTIONS_RESULTS: {
     };
     queryKey: string;
     containerSelector: string;
+    searchTitlePosition: string;
     labels: {
         pageSize: string;
         sortBy: string;

package/dist/iife/index-iife.d.ts

@@ -1,4 +1,5 @@
 import { TrackingOptions } from "./types/General";
+import { ProductListOptions } from "./types/product-list/ProductListOptions";
 import { SearchBoxOptions } from "./types/search-box/SearchBoxOptions";
 import { SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
 declare global {
@@ -7,15 +8,19 @@ declare global {
             searchBox: (options: SearchBoxOptions) => void;
             searchResults: (options: SearchResultsOptions) => void;
             tracking: (options: TrackingOptions) => void;
+            productList: (options: ProductListOptions) => void;
             clearSearchBox: () => void;
             clearSearchResults: () => void;
+            clearProductList: () => void;
         };
         lupaSearch: {
             searchBox: (options: SearchBoxOptions) => void;
             searchResults: (options: SearchResultsOptions) => void;
             tracking: (options: TrackingOptions) => void;
+            productList: (options: ProductListOptions) => void;
             clearSearchBox: () => void;
             clearSearchResults: () => void;
+            clearProductList: () => void;
         };
     }
 }

package/dist/iife/index.d.ts

@@ -1,12 +1,15 @@
 import { SearchBoxOptions } from "./types/search-box/SearchBoxOptions";
 import { SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
 import { TrackingOptions } from "./types/General";
+import { ProductListOptions } from "./types/product-list/ProductListOptions";
 declare const lupaSearch: {
     searchBox: (options: SearchBoxOptions) => void;
     searchResults: (options: SearchResultsOptions) => void;
     tracking: (options: TrackingOptions) => void;
+    productList: (options: ProductListOptions) => void;
     clearSearchBox: () => void;
     clearSearchResults: () => void;
+    clearProductList: () => void;
 };
 export { TrackingOptions, SearchBoxOptions, SearchResultsOptions };
 export default lupaSearch;