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

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/searchBox.d.ts

@@ -1,8 +1,9 @@
 import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
-import { Options, PublicQuery, SearchQueryResult, Suggestion } from "@getlupa/client-sdk/Types";
+import { PublicQuery, SearchQueryResult, Suggestion } from "@getlupa/client-sdk/Types";
 import { VuexModule } from "vuex-module-decorators";
 import { DisplaySuggestion, HighlightedDocInfo } from "@/types/search-box/Common";
 import { SearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+import { SdkOptions } from "@/types/General";
 export default class SearchBoxModule extends VuexModule {
     options: SearchBoxOptions;
     docResults: Record<string, SearchQueryResult>;
@@ -43,7 +44,7 @@ export default class SearchBoxModule extends VuexModule {
     querySuggestions({ queryKey, publicQuery, options, }: {
         queryKey: string;
         publicQuery: PublicQuery;
-        options?: Options | undefined;
+        options?: SdkOptions;
     }): Promise<{
         queryKey: string;
         suggestions?: Suggestion[];
@@ -52,7 +53,7 @@ export default class SearchBoxModule extends VuexModule {
     queryDocuments({ queryKey, publicQuery, options, }: {
         queryKey: string;
         publicQuery: PublicQuery;
-        options?: Options | undefined;
+        options?: SdkOptions;
     }): Promise<{
         queryKey: string;
         result?: SearchQueryResult;

package/dist/es/types/General.d.ts

@@ -2,6 +2,10 @@ import { Environment } from "@getlupa/client-sdk/Types";
 import { AnalyticsOptions } from "./AnalyticsOptions";
 export declare type SdkOptions = {
     environment: Environment;
+    customUrl?: string;
+    customPayload?: Record<string, unknown>;
+    customHeaders?: Record<string, string>;
+    onError?: (err: unknown) => unknown;
 };
 export declare type TrackingOptions = {
     trackBase?: boolean;

package/dist/es/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/es/types/search-box/SearchBoxOptions.d.ts

@@ -10,6 +10,7 @@ export declare type SearchBoxOptionLabels = {
     noResults: string;
     moreResults: string;
     currency: string;
+    priceSeparator?: string;
     defaultFacetLabel?: string;
 };
 export declare type SearchBoxOptionLinks = {

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";
@@ -18,6 +19,7 @@ export declare type SearchResultsSimilarQueriesLabels = {
 export declare type SearchResultsOptionLabels = SearchResultsPaginationLabels & SearchResultsDidYouMeanLabels & SearchResultsSimilarQueriesLabels & {
     sortBy: string;
     currency: string;
+    priceSeparator?: string;
     itemCount: string;
     emptyResults: string;
     mobileFilterButton: string;
@@ -102,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/es/utils/filter.toggle.utils.d.ts

@@ -16,7 +16,7 @@ export declare const getFacetParam: (key: string, value: string[] | string, type
 };
 export declare const toggleTermFilter: (appendParams: AppendParams, facetAction: TermFacetAction, currentFilters?: FilterGroup | undefined) => void;
 export declare const toggleHierarchyFilter: (appendParams: AppendParams, facetAction: HierarchyFacetAction, currentFilters?: FilterGroup | undefined, removeAllLevels?: boolean) => void;
-export declare const toggleRangeFilter: (appendParams: AppendParams, facetAction: RangeFacetAction) => void;
+export declare const toggleRangeFilter: (appendParams: AppendParams, facetAction: RangeFacetAction, currentFilters?: FilterGroup | undefined) => void;
 export declare const toggleTermParam: (params?: string[], param?: string) => string[];
 export declare const toggleLastPram: (params?: string[], param?: string) => string[];
 export declare const toggleHierarchyParam: (params?: string[], param?: string, removeAllLevels?: boolean) => string[];

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

@@ -8,3 +8,4 @@ export declare const isArrayKey: (key: string) => boolean;
 export declare const getMostSpecificHierarchyTerms: (terms: string[]) => string[];
 export declare const recursiveFilter: (items: HierarchyTree[], query?: string) => HierarchyTree[];
 export declare const recursiveFilterItem: (item: HierarchyTree, query?: string) => HierarchyTree | undefined;
+export declare const rangeFilterToString: (rangeFilter: FilterGroupItemTypeRange, separator?: string | undefined) => string;

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

@@ -1,2 +1,2 @@
-export declare const formatPrice: (price?: string | number | undefined, currency?: string) => string;
-export declare const formatPriceSummary: ([min, max]: [min?: string | number | undefined, max?: string | number | undefined], currency?: string | undefined) => string;
+export declare const formatPrice: (price?: string | number | undefined, currency?: string, separator?: string) => string;
+export declare const formatPriceSummary: ([min, max]: [min?: string | number | undefined, max?: string | number | undefined], currency?: string | undefined, separator?: string) => string;

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/es/utils/tracking.utils.d.ts

@@ -2,4 +2,8 @@ import { TrackingOptions } from "@/types/General";
 import { TrackableEventData } from "@/types/search-box/Common";
 import { Options } from "@getlupa/client-sdk/Types";
 export declare const initTracking: (options: TrackingOptions) => void;
+export declare const getLupaTrackingContext: () => {
+    userId?: string;
+    sessionId?: string;
+};
 export declare const track: (queryKey?: string | undefined, data?: TrackableEventData, options?: Options | undefined) => 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,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/iife/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/iife/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/iife/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/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

@@ -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/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/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/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;