@getlupa/client 0.4.3-1

package/dist/cjs/main.d.ts

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

package/dist/cjs/store/__tests__/history.spec.d.ts

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

package/dist/cjs/store/__tests__/params.spec.d.ts

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

package/dist/cjs/store/__tests__/searchBox.spec.d.ts

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

package/dist/cjs/store/__tests__/searchResult.spec.d.ts

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

package/dist/cjs/store/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vuex").Store<any>;
+export default _default;

package/dist/cjs/store/modules/history.d.ts

@@ -0,0 +1,13 @@
+import { VuexModule } from "vuex-module-decorators";
+export default class HistoryModule extends VuexModule {
+    items: string[];
+    get count(): number;
+    save(items: string[]): void;
+    add({ item }: {
+        item?: string;
+    }): string[];
+    remove({ item }: {
+        item: string;
+    }): string[];
+    clear(): string[];
+}

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

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

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

@@ -0,0 +1,55 @@
+import { InputSuggestionFacet } from "@/types/search-box/Common";
+import { QueryParams } from "@/types/search-results/QueryParams";
+import { FilterGroup } from "@getlupa/client-sdk/Types";
+import { VuexModule } from "vuex-module-decorators";
+export default class ParamsModule extends VuexModule {
+    params: QueryParams;
+    defaultLimit: number;
+    searchResultsLink: string;
+    searchString: string;
+    get query(): string;
+    get page(): number;
+    get limit(): number;
+    get sort(): string | string[];
+    get filters(): FilterGroup;
+    save({ params, defaultLimit, searchResultsLink, searchString, }: {
+        params?: QueryParams;
+        defaultLimit?: number;
+        searchResultsLink?: string;
+        searchString?: string;
+    }): void;
+    add(params: QueryParams): {
+        params: QueryParams;
+    };
+    removeAllFilters(): {
+        params: QueryParams;
+        searchString: string;
+    };
+    removeParams({ paramsToRemove }: {
+        paramsToRemove?: "all" | string[];
+    }): {
+        params: QueryParams;
+        searchString: string;
+    };
+    goToResults({ searchText, facet, }: {
+        searchText: string;
+        facet?: InputSuggestionFacet;
+    }): void;
+    appendParams({ params, paramsToRemove, encode, }: {
+        params: {
+            name: string;
+            value: string;
+        }[];
+        paramsToRemove?: "all" | string[];
+        encode?: boolean;
+    }): {
+        params: QueryParams;
+        searchString?: string;
+    };
+    setDefaultLimit(defaultLimit: number): {
+        defaultLimit: number;
+    };
+    setSearchResultsLink(searchResultsLink: string): {
+        searchResultsLink: string;
+    };
+}

package/dist/cjs/store/modules/searchBox.d.ts

@@ -0,0 +1,65 @@
+import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
+import { Options, 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";
+export default class SearchBoxModule extends VuexModule {
+    options: SearchBoxOptions;
+    docResults: Record<string, SearchQueryResult>;
+    suggestionResults: Record<string, DisplaySuggestion[]>;
+    highlightedIndex: number;
+    inputValue: string;
+    saveOptions({ options }: {
+        options: SearchBoxOptions;
+    }): void;
+    saveInputValue({ input }: {
+        input: string;
+    }): void;
+    get resultsVisible(): boolean;
+    get panelItemCounts(): {
+        queryKey: string;
+        count: number;
+        panel: SearchBoxPanel;
+    }[];
+    get totalCount(): number;
+    get highlightedItem(): {
+        queryKey: string;
+        index: number;
+        panel: SearchBoxPanel;
+    } | undefined;
+    get highlightedDocument(): HighlightedDocInfo;
+    saveSuggestions({ queryKey, suggestions, inputValue, }: {
+        queryKey: string;
+        suggestions?: Suggestion[];
+        inputValue?: string;
+    }): void;
+    saveResults({ queryKey, result, }: {
+        queryKey: string;
+        result?: SearchQueryResult;
+    }): void;
+    saveHighlight({ highlightIndex }: {
+        highlightIndex: number;
+    }): void;
+    querySuggestions({ queryKey, publicQuery, options, }: {
+        queryKey: string;
+        publicQuery: PublicQuery;
+        options?: Options | undefined;
+    }): Promise<{
+        queryKey: string;
+        suggestions?: Suggestion[];
+        inputValue?: string;
+    }>;
+    queryDocuments({ queryKey, publicQuery, options, }: {
+        queryKey: string;
+        publicQuery: PublicQuery;
+        options?: Options | undefined;
+    }): Promise<{
+        queryKey: string;
+        result?: SearchQueryResult;
+    }>;
+    highlightChange({ action }: {
+        action: "down" | "up" | "clear";
+    }): {
+        highlightIndex: number;
+    };
+}

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

@@ -0,0 +1,47 @@
+import { ResultsLayout } from "@/types/search-results/ResultsLayout";
+import { ProductGrid } from "@/types/search-results/SearchResultsOptions";
+import { FacetResult, FilterGroup, SearchQueryResult } from "@getlupa/client-sdk/Types";
+import { VuexModule } from "vuex-module-decorators";
+export default class SearchResultModule extends VuexModule {
+    searchResult: SearchQueryResult;
+    columnCount: number;
+    addToCartAmount: number;
+    layout: ResultsLayout;
+    loading: boolean;
+    isMobileSidebarVisible: boolean;
+    get facets(): FacetResult[] | undefined;
+    get currentFilters(): FilterGroup | undefined;
+    get filters(): FilterGroup;
+    get currentQueryText(): string;
+    get totalItems(): number;
+    get hasResults(): boolean;
+    get hasAnyFilter(): boolean;
+    get itemRange(): number[];
+    setSidebarVisibility({ visible }: {
+        visible: boolean;
+    }): void;
+    save({ searchResult, columnCount, addToCartAmount, layout, }: {
+        searchResult?: SearchQueryResult;
+        columnCount?: number;
+        addToCartAmount?: number;
+        layout?: ResultsLayout;
+    }): void;
+    load(loading: boolean): void;
+    add(searchResult: SearchQueryResult): {
+        searchResult: SearchQueryResult;
+        pageSize: number;
+    };
+    setColumnCount({ width, grid }: {
+        width: number;
+        grid: ProductGrid;
+    }): {
+        columnCount: number;
+    };
+    setAddToCartAmount(addToCartAmount: number): {
+        addToCartAmount: number;
+    };
+    setLayout(layout: ResultsLayout): {
+        layout: ResultsLayout;
+    };
+    setLoading(loading: boolean): boolean;
+}

package/dist/cjs/store/modules/tracking.d.ts

@@ -0,0 +1,17 @@
+import { TrackableEventData } from "@/types/search-box/Common";
+import { PublicQuery, SearchQueryResult } from "@getlupa/client-sdk/Types";
+import { VuexModule } from "vuex-module-decorators";
+export default class TrackingModule extends VuexModule {
+    trackSearch({ queryKey, query, }: {
+        queryKey: string;
+        query: PublicQuery;
+    }): void;
+    trackResults({ queryKey, results, }: {
+        queryKey: string;
+        results: SearchQueryResult;
+    }): void;
+    track({ queryKey, data, }: {
+        queryKey: string;
+        data: TrackableEventData;
+    }): void;
+}

package/dist/cjs/store/types/State.d.ts

@@ -0,0 +1,38 @@
+import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
+import { QueryParams } from "@/types/search-results/QueryParams";
+import { SearchBoxPanelOptions } from "@/types/search-box/SearchBoxOptions";
+import { SearchQueryResult, Suggestion } from "@getlupa/client-sdk/Types";
+import { SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
+import { ResultsLayout } from "@/types/search-results/ResultsLayout";
+export declare type HistoryState = {
+    items: string[];
+};
+export declare type SearchResultState = {
+    searchResult: SearchQueryResult;
+    columnCount: number;
+    addToCartAmount: number;
+    layout: ResultsLayout;
+    loading: boolean;
+};
+export declare type ParamsState = {
+    params: QueryParams;
+    defaultLimit: number;
+};
+export declare type SearchBoxState = {
+    docResults: Record<string, SearchQueryResult>;
+    suggestionResults: Record<string, Suggestion[]>;
+    options: SearchBoxPanelOptions;
+    highlightedIndex: number;
+    inputValue: string;
+};
+export declare type OptionsState = {
+    searchBoxOptions: SearchBoxOptions;
+    searchResultOptions: SearchResultsOptions;
+};
+export declare type RootState = {
+    history: HistoryState;
+    searchResult: SearchResultState;
+    params: ParamsState;
+    searchBox: SearchBoxState;
+    options: OptionsState;
+};

package/dist/cjs/types/AnalyticsOptions.d.ts

@@ -0,0 +1,7 @@
+export declare const PARENT_EVENT_NAME = "GetLupa";
+export declare type AnalyticsEventType = "search" | "search_form_submit" | "autocomplete_keyword_click" | "autocomplete_product_click" | "zero_results" | "filters" | "add_to_cart";
+export declare type AnalyticsOptions = {
+    type: "ua";
+    enabled: boolean;
+    parentEventName: string;
+};

package/dist/cjs/types/DocumentElement.d.ts

@@ -0,0 +1,68 @@
+import { Document } from "@getlupa/client-sdk/Types";
+export declare enum DocumentElementType {
+    IMAGE = "image",
+    TITLE = "title",
+    CUSTOM = "custom",
+    DESCRIPTION = "description",
+    PRICE = "price",
+    REGULARPRICE = "regularPrice",
+    RATING = "rating",
+    ADDTOCART = "addToCart",
+    CUSTOM_HTML = "customHtml"
+}
+export declare type DocumentElementBase = {
+    type: DocumentElementType;
+    key: string;
+    display?: (document: Record<string, unknown>) => boolean;
+    isHtml?: boolean;
+};
+export declare type ImageDocumentElement = DocumentElementBase & {
+    type: DocumentElementType.IMAGE;
+    placeholder: string;
+    baseUrl?: string;
+};
+export declare type TitleDocumentElement = DocumentElementBase & {
+    type: DocumentElementType.TITLE;
+    maxLines: number;
+    link?: boolean;
+};
+export declare type DescriptionDocumentElement = DocumentElementBase & {
+    type: DocumentElementType.DESCRIPTION;
+    maxLines: number;
+};
+export declare type CustomDocumentElement = DocumentElementBase & {
+    type: DocumentElementType.CUSTOM;
+    className: string;
+};
+export declare type PriceElement = DocumentElementBase & {
+    type: DocumentElementType.PRICE;
+};
+export declare type RegularPriceDocumentElement = DocumentElementBase & {
+    type: DocumentElementType.REGULARPRICE;
+};
+export declare type RatingElement = DocumentElementBase & {
+    type: DocumentElementType.RATING;
+    labels: RatingLabels;
+    links: RatingLinks;
+    totalKey: string;
+    getRatingPercentage?: (doc: Document) => number;
+};
+export declare type RatingLabels = {
+    numberOfRatings: string;
+};
+export declare type RatingLinks = {
+    ratingDetails?: string;
+};
+export declare type AddToCartElement = DocumentElementBase & {
+    type: DocumentElementType.ADDTOCART;
+    action: (document: Document, amount: number) => Promise<unknown> | undefined;
+    labels: {
+        addToCart: "Add to Cart";
+    };
+};
+export declare type CustomHtmlElement = DocumentElementBase & {
+    type: DocumentElementType.CUSTOM_HTML;
+    html: (document: Document) => string;
+    className: string;
+};
+export declare type DocumentElement = ImageDocumentElement | TitleDocumentElement | DescriptionDocumentElement | CustomDocumentElement | PriceElement | RegularPriceDocumentElement | RatingElement | AddToCartElement | CustomHtmlElement;

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

@@ -0,0 +1,12 @@
+import { Environment } from "@getlupa/client-sdk/Types";
+import { AnalyticsOptions } from "./AnalyticsOptions";
+export declare type SdkOptions = {
+    environment: Environment;
+};
+export declare type TrackingOptions = {
+    trackBase?: boolean;
+    trackSession?: boolean;
+    trackUser?: boolean;
+    userKey?: string;
+    analytics?: AnalyticsOptions;
+};

package/dist/cjs/types/search-box/Common.d.ts

@@ -0,0 +1,44 @@
+import { Document, Suggestion, ReportableEventType } from "@getlupa/client-sdk/Types";
+import { AnalyticsEventType } from "../AnalyticsOptions";
+import { SearchBoxPanelType } from "./SearchBoxPanel";
+export declare type FetchedData = {
+    items: Document[] | Suggestion[];
+    type: SearchBoxPanelType;
+};
+export declare type InputSuggestion = {
+    item: Suggestion;
+    queryKey: string;
+    override: boolean;
+    facet?: InputSuggestionFacet;
+};
+export declare type InputSuggestionFacet = {
+    label?: string;
+    count?: number;
+    key: string;
+    title: string;
+};
+export declare type DisplaySuggestion = {
+    suggestion: Suggestion;
+    display: string;
+    displayHighlight: string;
+    facet?: InputSuggestionFacet;
+};
+export declare type SelectedData = {
+    item: Document | InputSuggestion;
+    type: SearchBoxPanelType;
+};
+export declare type TrackableEventData = {
+    type?: ReportableEventType;
+    searchQuery?: string;
+    itemId?: string;
+    analytics?: {
+        type: AnalyticsEventType;
+        label: string;
+    };
+};
+export declare type HighlightedDocInfo = {
+    doc?: Document;
+    link?: string;
+    queryKey?: string;
+    id?: unknown;
+};

package/dist/cjs/types/search-box/SearchBoxHistory.d.ts

@@ -0,0 +1,6 @@
+export declare type SearchBoxHistory = {
+    labels: HistoryLabel;
+};
+export declare type HistoryLabel = {
+    clear: string;
+};

package/dist/cjs/types/search-box/SearchBoxOptions.d.ts

@@ -0,0 +1,30 @@
+import { SdkOptions } from "../General";
+import { SearchBoxHistory } from "./SearchBoxHistory";
+import { SearchBoxPanel } from "./SearchBoxPanel";
+export declare type SearchBoxOptions = SearchBoxPanelOptions & {
+    inputSelector: string;
+    searchTriggers?: string[];
+};
+export declare type SearchBoxOptionLabels = {
+    placeholder: string;
+    noResults: string;
+    moreResults: string;
+    currency: string;
+    defaultFacetLabel?: string;
+};
+export declare type SearchBoxOptionLinks = {
+    searchResults: string;
+};
+export declare type SearchBoxInputOptions = {
+    minInputLength: number;
+    labels: SearchBoxOptionLabels;
+    links: SearchBoxOptionLinks;
+    inputAttributes?: Record<string, string>;
+};
+export declare type SearchBoxPanelOptions = SearchBoxInputOptions & {
+    history: SearchBoxHistory;
+    panels: SearchBoxPanel[];
+    options: SdkOptions;
+    debounce?: number;
+    showTotalCount?: boolean;
+};

package/dist/cjs/types/search-box/SearchBoxPanel.d.ts

@@ -0,0 +1,28 @@
+import { DocumentElement } from "../DocumentElement";
+export declare enum SearchBoxPanelType {
+    SUGGESTION = "suggestion",
+    DOCUMENT = "document"
+}
+export declare type SearchBoxPanelLinks = {
+    details: string;
+};
+export declare type SearchBoxPanelBase = {
+    type: SearchBoxPanelType;
+    queryKey: string;
+    limit: number;
+};
+export declare type DocumentSearchBoxPanel = SearchBoxPanelBase & {
+    type: SearchBoxPanelType.DOCUMENT;
+    links: SearchBoxPanelLinks;
+    elements: DocumentElement[];
+    titleKey?: string;
+    idKey?: string;
+    customClassName?: string;
+    searchBySuggestion?: boolean;
+};
+export declare type SuggestionSearchBoxPanel = SearchBoxPanelBase & {
+    type: SearchBoxPanelType.SUGGESTION;
+    highlight: boolean;
+    customClassName?: string;
+};
+export declare type SearchBoxPanel = DocumentSearchBoxPanel | SuggestionSearchBoxPanel;

package/dist/cjs/types/search-results/BadgeOptions.d.ts

@@ -0,0 +1,42 @@
+import { Document } from "@getlupa/client-sdk/Types";
+import { AnchorPosition } from "./SearchResultsProductCardOptions";
+export declare type SearchResultBadgeType = "text" | "image" | "customHtml";
+export declare type BadgeOptions = {
+    anchor: AnchorPosition;
+    elements: BadgeElement[];
+    product: Document;
+};
+export declare type SearchResultBadgeElement = {
+    type: SearchResultBadgeType;
+    key: string;
+    isHtml: boolean;
+    product: Document;
+    display?: (document: Record<string, unknown>) => boolean;
+};
+export declare type BaseBadgeElement = SearchResultBadgeElement & {
+    value?: string;
+};
+export declare type TextBadgeElement = BaseBadgeElement & {
+    type: "text";
+    prefix?: string;
+    maxItems?: number;
+};
+export declare type ImageBadgeElement = BaseBadgeElement & {
+    type: "image";
+    rootImageUrl?: string;
+    maxItems?: number;
+};
+export declare type CustomHtmlBadgeElement = BaseBadgeElement & {
+    type: "customHtml";
+    className: string;
+    html: (doc: Document) => string;
+};
+export declare type BadgeElement = BaseBadgeElement | TextBadgeElement;
+export declare enum BadgeType {
+    DISCOUNTPERCENTAGE = "discountPercentage",
+    DISCOUNTAMOUNT = "discountAmount",
+    NEWITEM = "newItem",
+    TEXT = "text",
+    IMAGE = "image",
+    CUSTOM_HTML = "customHtml"
+}

package/dist/cjs/types/search-results/FacetAction.d.ts

@@ -0,0 +1,16 @@
+export declare type TermFacetAction = {
+    type: "terms";
+    value: string;
+    key: string;
+};
+export declare type HierarchyFacetAction = {
+    type: "hierarchy";
+    value: string;
+    key: string;
+};
+export declare type RangeFacetAction = {
+    type: "range";
+    value: string[];
+    key: string;
+};
+export declare type FacetAction = TermFacetAction | RangeFacetAction | HierarchyFacetAction;

package/dist/cjs/types/search-results/Filters.d.ts

@@ -0,0 +1,9 @@
+export declare type UnfoldedFilter = {
+    key: string;
+    value: string;
+    type: FilterType;
+};
+export declare type LabeledFilter = UnfoldedFilter & {
+    label: string;
+};
+export declare type FilterType = "terms" | "range" | "hierarchy";

package/dist/cjs/types/search-results/PaginationOptions.d.ts

@@ -0,0 +1,19 @@
+import { SearchResultsPaginationLabels } from "./SearchResultsPagination";
+export declare type PaginationOptions = {
+    pageSize: PaginationPageSize;
+    pageSelect: PaginationPageSelect;
+    labels: SearchResultsPaginationLabels;
+};
+export declare type PaginationPageSize = {
+    sizes: number[];
+    selectedSize: number;
+};
+export declare type PaginationPageSelect = {
+    count: number;
+    selectedPage: number;
+    display: number;
+};
+export declare type PaginationDisplay = {
+    pageSize: boolean;
+    pageSelect: boolean;
+};

package/dist/cjs/types/search-results/QueryParams.d.ts

@@ -0,0 +1,4 @@
+import { FilterGroup } from "@getlupa/client-sdk/Types";
+export declare type QueryParams = {
+    filters?: FilterGroup;
+} & Record<string, string>;

package/dist/cjs/types/search-results/ResultsLayout.d.ts

@@ -0,0 +1,5 @@
+export declare type ResultsLayout = "Grid" | "List";
+export declare enum ResultsLayoutEnum {
+    GRID = "Grid",
+    LIST = "List"
+}

package/dist/cjs/types/search-results/SearchResultsAdditionalPanelOptions.d.ts

@@ -0,0 +1,15 @@
+import { DocumentElement } from "../DocumentElement";
+export declare type SearchResultsAdditionalPanelOptions = {
+    location: "top" | "bottom";
+    queryKey: string;
+    initialCountLimit: number;
+    totalCountLimit: number;
+    links?: {
+        details: string;
+    };
+    labels: {
+        showMore: string;
+        showLess: string;
+    };
+    elements: DocumentElement[];
+};