@getlupa/client 0.5.0 → 0.5.1-alpha-1

package/dist/cjs/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/cjs/types/product-list/ProductListOptions.d.ts

@@ -0,0 +1,28 @@
+import { FilterGroup } from "@getlupa/client-sdk/Types";
+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 RoutingBehavior = "direct-link" | "event";
+export declare type ProductListOptions = SearchResultsOptions & {
+    initialFilters?: FilterGroup;
+    categories?: CategoryFilterOptions;
+};

package/dist/cjs/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";
@@ -103,6 +104,7 @@ export declare type ResultFacetOptions = {
 export declare type SearchResultsFilterOptions = {
     currentFilters?: ResultCurrentFilterOptions;
     facets?: ResultFacetOptions;
+    categories?: CategoryFilterOptions;
 };
 export declare type SearchResultsBreadcrumb = {
     label: string;

package/dist/cjs/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/cjs/utils/routing.utils.d.ts

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

package/dist/es/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/es/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/es/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/es/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/es/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/es/components/search-results/SearchResults.vue.d.ts

@@ -1,9 +1,11 @@
 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;
     get didYouMeanLabels(): SearchResultsDidYouMeanLabels;
     get queryText(): string;
@@ -28,6 +30,9 @@ export default class SearchResults extends Vue {
     setSearchResultOptions: ({ options, }: {
         options: SearchResultsOptions;
     }) => void;
+    setInitialFilters: ({ initialFilters, }: {
+        initialFilters: FilterGroup;
+    }) => void;
     mounted(): void;
     beforeDestroy(): void;
     handleMounted(): void;

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

@@ -9,6 +9,8 @@ export default class CurrentFilters extends Vue {
     isOpen: boolean;
     currentFilters: FilterGroup;
     facets: FacetResult[] | undefined;
+    initialFilters: FilterGroup;
+    get displayFilters(): LabeledFilter[];
     get labeledFilters(): LabeledFilter[];
     get hasFilters(): boolean;
     get filterCount(): number;

package/dist/es/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/es/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/es/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/es/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;