@getlupa/client 0.4.3-2 → 0.5.1-alpha-1

package/README.md

@@ -14,7 +14,7 @@ To
 
 - `src/constants/development/searchResultsDev.const.ts`.
 
-If files are copied, development build will not work.
+If files are not copied, development build will not work.
 
 ## Project setup
 
@@ -62,10 +62,18 @@ See [Configuration Reference](https://cli.vuejs.org/config/).
 
 ## Documentation
 
-If you are integrating standalone version of the plugin (as a cdn link):
+If you are integrating **standalone** version of the plugin (as a **cdn** link):
 
 - See [Getting Started - Standalone](/docs/getting-started-standalone.md) for more information about plugin integration.
 
-For integration as an npm package:
+For integration as an **npm package**:
 
 - See [Getting Started - npm](/docs/getting-started-npm.md) for more information about plugin integration.
+
+For more information about individual components and all available options:
+
+- [Search Box](/docs/components/search-box.md)
+
+- [Search Results](/docs/components/search-results.md)
+
+- [Tracing and Analytics](/docs/components/tracking.md)

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/components/search-results/filters/facets/TermFacet.vue.d.ts

@@ -1,10 +1,10 @@
 import Vue from "vue";
-import { FacetGroup, FacetGroupItem, FilterGroupItemTypeTerms } from "@getlupa/client-sdk/Types";
+import { FacetGroup, FacetGroupItem, FilterGroupItemTypeRange, FilterGroupItemTypeTerms } from "@getlupa/client-sdk/Types";
 import { ResultFacetOptions } from "@/types/search-results/SearchResultsOptions";
 export default class TermFacet extends Vue {
     options: ResultFacetOptions;
     facet: FacetGroup;
-    currentFilters: FilterGroupItemTypeTerms;
+    currentFilters: FilterGroupItemTypeTerms | FilterGroupItemTypeRange[];
     showAll: boolean;
     termFilter: string;
     get itemLimit(): number;
@@ -12,6 +12,7 @@ export default class TermFacet extends Vue {
     get displayValues(): FacetGroupItem[];
     get filteredValues(): FacetGroupItem[];
     get isFilterable(): boolean;
+    get isRange(): boolean;
     handleFacetClick(item: FacetGroupItem): void;
     handleShowAll(): void;
     isChecked(item: FacetGroupItem): boolean;

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

@@ -13,6 +13,7 @@ export declare const SEARCH_BOX_CONFIGURATION: {
         noResults: string;
         moreResults: string;
         currency: string;
+        priceSeparator: string;
         defaultFacetLabel: string;
     };
     links: {

package/dist/cjs/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/cjs/constants/development/searchResultsDev.example.const.d.ts

@@ -10,6 +10,7 @@ export declare const SEARCH_RESULTS_CONFIGURATION: {
         sortBy: string;
         itemCount: string;
         currency: string;
+        priceSeparator: string;
         showMore: string;
         emptyResults: string;
         mobileFilterButton: string;

package/dist/cjs/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/cjs/constants/queryParams.const.d.ts

@@ -23,3 +23,4 @@ export declare const FACET_FILTER_MAP: {
 export declare const FACET_KEY_SEPARATOR = ".";
 export declare const FACET_RANGE_SEPARATOR = ":";
 export declare const HIERARCHY_SEPARATOR = ">";
+export declare const FACET_TERM_RANGE_SEPARATOR = "-";

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