@getlupa/client 0.4.3-1

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

@@ -0,0 +1,33 @@
+import { DocumentElement } from "@/types/DocumentElement";
+import { TrackableEventData } from "@/types/search-box/Common";
+import { BadgeOptions } from "@/types/search-results/BadgeOptions";
+import { ResultsLayout } from "@/types/search-results/ResultsLayout";
+import { SearchResultsOptionLabels } from "@/types/search-results/SearchResultsOptions";
+import { SearchResultsProductCardOptions } from "@/types/search-results/SearchResultsProductCardOptions";
+import { Document, ReportableEventType } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchResultsProductCard extends Vue {
+    product: Document;
+    options: SearchResultsProductCardOptions;
+    isAdditionalPanel: boolean;
+    layout: ResultsLayout;
+    query: string;
+    trackClick: ({ queryKey, data, }: {
+        queryKey: string;
+        data: TrackableEventData;
+    }) => void;
+    get listLayoutClass(): string;
+    get badgesOptions(): BadgeOptions;
+    get imageElements(): DocumentElement[];
+    get detailElements(): DocumentElement[];
+    get labels(): SearchResultsOptionLabels;
+    get link(): string;
+    isInStock: boolean;
+    mounted(): void;
+    checkIfIsInStock(): Promise<void>;
+    get id(): string;
+    handleClick(): void;
+    handleProductEvent(item: {
+        type: ReportableEventType;
+    }): void;
+}

package/dist/es/components/search-results/products/product-card/__tests__/SearchResultsBadgeWrapper.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/__tests__/SearchResultsProductCard.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/badges/CustomBadge.vue.d.ts

@@ -0,0 +1,7 @@
+import { CustomHtmlBadgeElement } from "@/types/search-results/BadgeOptions";
+import Vue from "vue";
+export default class CustomBadge extends Vue {
+    badge: CustomHtmlBadgeElement;
+    get text(): string;
+    get className(): string;
+}

package/dist/es/components/search-results/products/product-card/badges/ImageBadge.vue.d.ts

@@ -0,0 +1,8 @@
+import { ImageBadgeElement } from "@/types/search-results/BadgeOptions";
+import Vue from "vue";
+export default class ImageBadge extends Vue {
+    badge: ImageBadgeElement;
+    get badges(): string[];
+    getImageUrl(src: string): string;
+    get displayBadges(): string[];
+}

package/dist/es/components/search-results/products/product-card/badges/SearchResultsBadgeWrapper.vue.d.ts

@@ -0,0 +1,9 @@
+import { BadgeElement, BadgeOptions } from "@/types/search-results/BadgeOptions";
+import { AnchorPosition } from "@/types/search-results/SearchResultsProductCardOptions";
+import Vue from "vue";
+export default class SearchResultsBadgeWrapper extends Vue {
+    options: BadgeOptions;
+    get anchorPosition(): AnchorPosition;
+    get badges(): BadgeElement[];
+    getBadgeComponent(type: string): string;
+}

package/dist/es/components/search-results/products/product-card/badges/TextBadge.vue.d.ts

@@ -0,0 +1,7 @@
+import { TextBadgeElement } from "@/types/search-results/BadgeOptions";
+import Vue from "vue";
+export default class TextBadge extends Vue {
+    badge: TextBadgeElement;
+    get badges(): string[];
+    get displayBadges(): string[];
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductAddToCart.vue.d.ts

@@ -0,0 +1,12 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { AddToCartElement } from "@/types/DocumentElement";
+export default class SearchResultsProductAddToCart extends Vue {
+    item: Document;
+    options: AddToCartElement;
+    inStock: boolean;
+    addToCartAmount: number;
+    loading: boolean;
+    get label(): string;
+    handleClick(): Promise<void>;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductCardElement.vue.d.ts

@@ -0,0 +1,16 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { SearchBoxOptionLabels } from "@/types/search-box/SearchBoxOptions";
+import { DocumentElement } from "@/types/DocumentElement";
+export default class SearchResultsProductCardElement extends Vue {
+    item: Document;
+    element: DocumentElement;
+    labels?: SearchBoxOptionLabels;
+    inStock?: boolean;
+    link: string;
+    get elementComponent(): string;
+    get displayElement(): boolean;
+    handleProductEvent(item: {
+        type: string;
+    }): void;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductCustom.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { CustomDocumentElement } from "@/types/DocumentElement";
+export default class SearchResultsProductCustom extends Vue {
+    item: Document;
+    options: CustomDocumentElement;
+    get text(): string;
+    get className(): string;
+    get isHtml(): boolean;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductDescription.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { DescriptionDocumentElement } from "@/types/DocumentElement";
+export default class SearchResultsProductDescription extends Vue {
+    item: Document;
+    options: DescriptionDocumentElement;
+    get description(): unknown;
+    get isHtml(): boolean;
+    get maxLines(): number;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductImage.vue.d.ts

@@ -0,0 +1,14 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { ImageDocumentElement } from "@/types/DocumentElement";
+export default class SearchResultsProductImage extends Vue {
+    item: Document;
+    options: ImageDocumentElement;
+    get hasFullImageUrl(): boolean;
+    get rootImageUrl(): string | undefined;
+    get image(): string;
+    get imageUrl(): string;
+    get hasImage(): boolean;
+    get placeholder(): string;
+    replaceWithPlaceholder(e: Event): void;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductPrice.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { RegularPriceDocumentElement } from "@/types/DocumentElement";
+import { SearchResultsOptionLabels } from "@/types/search-results/SearchResultsOptions";
+export default class SearchResultsProductPrice extends Vue {
+    item: Document;
+    options: RegularPriceDocumentElement;
+    labels?: SearchResultsOptionLabels;
+    get price(): string;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductRating.vue.d.ts

@@ -0,0 +1,13 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { RatingElement } from "@/types/DocumentElement";
+export default class SearchResultsProductRating extends Vue {
+    item: Document;
+    options: RatingElement;
+    get totalRatings(): string;
+    get currentRating(): number;
+    get baseStars(): string[];
+    get highlightedStars(): string[];
+    get ratingPercentage(): number;
+    get ratingLink(): string;
+}

package/dist/es/components/search-results/products/product-card/elements/SearchResultsProductRegularPrice.vue.d.ts

@@ -0,0 +1,10 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { RegularPriceDocumentElement } from "@/types/DocumentElement";
+import { SearchResultsOptionLabels } from "@/types/search-results/SearchResultsOptions";
+export default class SearchResultsProductRegularPrice extends Vue {
+    item: Document;
+    options: RegularPriceDocumentElement;
+    labels: SearchResultsOptionLabels;
+    get price(): string;
+}

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

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

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductAddToCart.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductCustom.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductCustomHtmlElement.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductDescription.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductImage.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductPrice.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductRating.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/__tests__/SearchResultsProductTitle.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/es/components/search-results/products/product-card/elements/custom/SearchResultsProductCustomHtmlElement.vue.d.ts

@@ -0,0 +1,9 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { CustomHtmlElement } from "@/types/DocumentElement";
+export default class SearchResultsProductCustomHtmlElement extends Vue {
+    item: Document;
+    options: CustomHtmlElement;
+    get text(): string;
+    get className(): string;
+}

package/dist/es/components/search-results/products/similar-queries/SearchResultsSimilarQueries.vue.d.ts

@@ -0,0 +1,19 @@
+import { InputSuggestionFacet } from "@/types/search-box/Common";
+import { QueryParams } from "@/types/search-results/QueryParams";
+import { SearchResultsSimilarQueriesLabels } from "@/types/search-results/SearchResultsOptions";
+import { SearchResultsProductCardOptions } from "@/types/search-results/SearchResultsProductCardOptions";
+import { Document, SimilarQueryResult } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SearchResultsSimilarQueries extends Vue {
+    labels: SearchResultsSimilarQueriesLabels;
+    columnSize: string;
+    productCardOptions: SearchResultsProductCardOptions;
+    similarQueries: SimilarQueryResult[];
+    getProductKey(index: string, product: Document): string;
+    goToResults: ({ searchText, facet, }: {
+        searchText: string;
+        facet?: InputSuggestionFacet;
+    }) => {
+        params: QueryParams;
+    };
+}

package/dist/es/components/search-results/products/similar-queries/SimilarQueryText.vue.d.ts

@@ -0,0 +1,10 @@
+import { SimilarQueryResult } from "@getlupa/client-sdk/Types";
+import Vue from "vue";
+export default class SimilarQueryText extends Vue {
+    similarQuery: SimilarQueryResult;
+    label: string;
+    searchText: string;
+    get count(): number;
+    insertValue(text: string, query: string): string[];
+    getStyle(text: string): string;
+}

package/dist/es/components/search-results/products/sort/SearchResultsSort.vue.d.ts

@@ -0,0 +1,23 @@
+import { QueryParams } from "@/types/search-results/QueryParams";
+import { SearchResultsSortOptions, SortOptions } from "@/types/search-results/SearchResultsSort";
+import Vue from "vue";
+export default class SearchResultsSort extends Vue {
+    options: SortOptions;
+    selectedKey: string;
+    sort: string;
+    get sortItems(): SearchResultsSortOptions[];
+    get defaultSortValue(): SearchResultsSortOptions;
+    mounted(): void;
+    handleSortChange(): void;
+    setSortValue(): void;
+    appendParams: ({ params, paramsToRemove, }: {
+        params: {
+            name: string;
+            value: string;
+        }[];
+        paramsToRemove?: string[];
+    }) => {
+        params: QueryParams;
+    };
+    handleSelect(): void;
+}

package/dist/es/components/search-results/products/sort/__tests__/SearchResultsSort.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,27 @@
+import { SdkOptions } from "@/types/General";
+import { SearchBoxPanel } from "@/types/search-box/SearchBoxPanel";
+export declare const SEARCH_BOX_CONFIGURATION: {
+    options: SdkOptions;
+    minInputLength: number;
+    showTotalCount: boolean;
+    inputAttributes: {
+        name: string;
+    };
+    debounce: number;
+    labels: {
+        placeholder: string;
+        noResults: string;
+        moreResults: string;
+        currency: string;
+        defaultFacetLabel: string;
+    };
+    links: {
+        searchResults: string;
+    };
+    panels: SearchBoxPanel[];
+    history: {
+        labels: {
+            clear: string;
+        };
+    };
+};

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

@@ -0,0 +1,91 @@
+import { SdkOptions } from "@/types/General";
+import { DocumentElement } from "@/types/DocumentElement";
+import { SearchResultBadgeOptions } from "@/types/search-results/SearchResultsProductCardOptions";
+import { SearchResultsSortOptions } from "@/types/search-results/SearchResultsSort";
+export declare const SEARCH_RESULTS_CONFIGURATION: {
+    options: SdkOptions;
+    queryKey: string;
+    labels: {
+        pageSize: string;
+        sortBy: string;
+        itemCount: string;
+        currency: string;
+        showMore: string;
+        emptyResults: string;
+        mobileFilterButton: string;
+        htmlTitleTemplate: string;
+        noResultsSuggestion: string;
+        didYouMean: string;
+        similarQuery: string;
+        similarQueries: string;
+    };
+    grid: {
+        columns: {
+            xl: number;
+            l: number;
+            md: number;
+            sm: number;
+            xs: number;
+        };
+    };
+    pagination: {
+        sizeSelection: {
+            position: {
+                top: boolean;
+                bottom: boolean;
+            };
+            sizes: number[];
+        };
+        pageSelection: {
+            position: {
+                top: boolean;
+                bottom: boolean;
+            };
+            display: number;
+        };
+    };
+    sort: SearchResultsSortOptions[];
+    filters: {
+        currentFilters: {
+            visibility: {
+                mobileSidebar: boolean;
+                mobileToolbar: boolean;
+            };
+            labels: {
+                title: string;
+                clearAll: string;
+            };
+        };
+        facets: {
+            labels: {
+                title: string;
+                showAll: string;
+                facetFilter: string;
+            };
+            hierarchy: {
+                maxInitialLevel: number;
+                topLevelValueCountLimit: number;
+                filterable: boolean;
+            };
+            filterable: {
+                minValues: number;
+            };
+            facetValueCountLimit: number;
+            showDocumentCount: boolean;
+        };
+    };
+    isInStock: () => boolean;
+    badges: SearchResultBadgeOptions;
+    links: {
+        details: string;
+    };
+    idKey: string;
+    elements: DocumentElement[];
+    breadcrumbs: ({
+        label: string;
+        link: string;
+    } | {
+        label: string;
+        link?: undefined;
+    })[];
+};

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

@@ -0,0 +1,13 @@
+export declare const HISTORY_LOCAL_STORAGE_KEY = "LUPA_HISTORY";
+export declare const TRACKING_STORAGE_KEY = "LUPA_STATS";
+export declare const TRACKING_STORAGE_KEY_BASE = "LUPA_STATS_BASE";
+export declare const TRACKING_ANALYTICS_KEY = "LUPA_ANALYTICS";
+export declare const TRACKING_KEY_LENGTH = 10;
+export declare const HISTORY_MAX_ITEMS = 7;
+export declare const S_MIN_WIDTH = 575;
+export declare const MD_MIN_WIDTH = 767;
+export declare const L_MIN_WIDTH = 991;
+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;

package/dist/es/constants/mockData..const.d.ts

@@ -0,0 +1,4 @@
+import { DisplaySuggestion } from "@/types/search-box/Common";
+import { SuggestionQueryResult } from "@getlupa/client-sdk/Types";
+export declare const SuggestionsMockData: SuggestionQueryResult;
+export declare const DisplaySuggestionsMockData: (input: string) => DisplaySuggestion[];

package/dist/es/constants/queryParams.const.d.ts

@@ -0,0 +1,25 @@
+export declare const QUERY_PARAMS: {
+    QUERY: string;
+    PAGE: string;
+    LIMIT: string;
+    SORT: string;
+};
+export declare const QUERY_PARAMS_PARSED: {
+    QUERY: string;
+    PAGE: string;
+    LIMIT: string;
+    SORT: string;
+};
+export declare const FACET_PARAMS_TYPE: {
+    TERMS: string;
+    RANGE: string;
+    HIERARCHY: string;
+};
+export declare const FACET_FILTER_MAP: {
+    terms: string;
+    range: string;
+    hierarchy: string;
+};
+export declare const FACET_KEY_SEPARATOR = ".";
+export declare const FACET_RANGE_SEPARATOR = ":";
+export declare const HIERARCHY_SEPARATOR = ">";

package/dist/es/constants/searchBox.const.d.ts

@@ -0,0 +1,48 @@
+export declare const DEFAULT_SEARCH_BOX_OPTIONS: {
+    inputSelector: string;
+    options: {
+        environment: string;
+    };
+    showTotalCount: boolean;
+    minInputLength: number;
+    inputAttributes: {
+        name: string;
+    };
+    debounce: number;
+    labels: {
+        placeholder: string;
+        noResults: string;
+        moreResults: string;
+        currency: string;
+        defaultFacetLabel: string;
+    };
+    links: {
+        searchResults: string;
+    };
+    panels: ({
+        type: string;
+        queryKey: string;
+        highlight: boolean;
+        limit: number;
+        searchBySuggestion?: undefined;
+        links?: undefined;
+        titleKey?: undefined;
+        elements?: undefined;
+    } | {
+        type: string;
+        queryKey: string;
+        limit: number;
+        searchBySuggestion: boolean;
+        links: {
+            details: string;
+        };
+        titleKey: string;
+        elements: never[];
+        highlight?: undefined;
+    })[];
+    history: {
+        labels: {
+            clear: string;
+        };
+    };
+};

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

@@ -0,0 +1,105 @@
+import { AnchorPosition } from "@/types/search-results/SearchResultsProductCardOptions";
+import { FacetStyle } from "@/types/search-results/SearchResultsOptions";
+export declare const DEFAULT_OPTIONS_RESULTS: {
+    options: {
+        environment: string;
+    };
+    queryKey: string;
+    containerSelector: string;
+    labels: {
+        pageSize: string;
+        sortBy: string;
+        itemCount: string;
+        filteredItemCount: string;
+        currency: string;
+        showMore: string;
+        searchResults: string;
+        emptyResults: string;
+        mobileFilterButton: string;
+        htmlTitleTemplate: string;
+        noResultsSuggestion: string;
+        didYouMean: string;
+        similarQuery: string;
+        similarQueries: string;
+    };
+    grid: {
+        columns: {
+            xl: number;
+            l: number;
+            md: number;
+            sm: number;
+            xs: number;
+        };
+    };
+    pagination: {
+        sizeSelection: {
+            position: {
+                top: boolean;
+                bottom: boolean;
+            };
+            sizes: number[];
+        };
+        pageSelection: {
+            position: {
+                top: boolean;
+                bottom: boolean;
+            };
+            display: number;
+        };
+    };
+    sort: never[];
+    filters: {
+        currentFilters: {
+            visibility: {
+                mobileSidebar: boolean;
+                mobileToolbar: boolean;
+            };
+            labels: {
+                title: string;
+                clearAll: string;
+            };
+        };
+        facets: {
+            labels: {
+                title: string;
+                showAll: string;
+                facetFilter: string;
+                facetClear: string;
+            };
+            filterable: {
+                minValues: number;
+            };
+            hierarchy: {
+                maxInitialLevel: number;
+                topLevelValueCountLimit: number;
+                filterable: boolean;
+            };
+            facetValueCountLimit: number;
+            showDocumentCount: boolean;
+            style: {
+                type: FacetStyle;
+            };
+        };
+    };
+    toolbar: {
+        layoutSelector: boolean;
+        itemSummary: boolean;
+        clearFilters: boolean;
+    };
+    isInStock: () => boolean;
+    badges: {
+        anchor: AnchorPosition;
+        elements: never[];
+    };
+    links: {
+        details: string;
+    };
+    elements: never[];
+    breadcrumbs: ({
+        label: string;
+        link: string;
+    } | {
+        label: string;
+        link?: undefined;
+    })[];
+};

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

@@ -0,0 +1,21 @@
+import { TrackingOptions } from "./types/General";
+import { SearchBoxOptions } from "./types/search-box/SearchBoxOptions";
+import { SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
+declare global {
+    interface Window {
+        getLupa: {
+            searchBox: (options: SearchBoxOptions) => void;
+            searchResults: (options: SearchResultsOptions) => void;
+            tracking: (options: TrackingOptions) => void;
+            clearSearchBox: () => void;
+            clearSearchResults: () => void;
+        };
+        lupaSearch: {
+            searchBox: (options: SearchBoxOptions) => void;
+            searchResults: (options: SearchResultsOptions) => void;
+            tracking: (options: TrackingOptions) => void;
+            clearSearchBox: () => void;
+            clearSearchResults: () => void;
+        };
+    }
+}

package/dist/es/index.d.ts

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