@getlupa/client 0.13.0-alpha-6 → 0.14.0

package/dist/es/store/modules/dynamicData.d.ts

@@ -0,0 +1,21 @@
+import { DynamicData } from "@/types/search-results/SearchResultsOptions";
+import { Document, SearchQueryResult } from "@getlupa/client-sdk/Types";
+import { VuexModule } from "vuex-module-decorators";
+export default class DynamicDataModule extends VuexModule {
+    loading: boolean;
+    dynamicDataIdMap: Record<string, Document>;
+    get loadedIds(): string[];
+    get searchResultOptions(): any;
+    get searchBoxOptions(): any;
+    get dynamicSearchResultData(): DynamicData | undefined;
+    get dynamicSearchBoxData(): DynamicData | undefined;
+    get isDynamicDataEnabledForSearchResults(): boolean;
+    get isDynamicDataEnabledForSearchBox(): boolean;
+    get isCacheEnabled(): boolean;
+    enhanceSearchResultsWithDynamicData({ result, mode, }: {
+        result?: SearchQueryResult;
+        mode?: "searchBox" | "searchResults";
+    }): Promise<Record<string, Document>>;
+    save(newData: Record<string, Document>): void;
+    setLoading(state: boolean): void;
+}

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

@@ -6,6 +6,7 @@ export declare enum DocumentElementType {
     PRICE = "price",
     REGULARPRICE = "regularPrice",
     RATING = "rating",
+    SINGLE_STAR_RATING = "singleStarRating",
     ADDTOCART = "addToCart",
     CUSTOM_HTML = "customHtml"
 }
@@ -14,6 +15,8 @@ export declare type DocumentElementBase<T = any> = {
     key?: string;
     display?: (document: T) => boolean;
     isHtml?: boolean;
+    group?: string;
+    dynamic?: boolean;
 };
 export declare type ImageDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.IMAGE;
@@ -57,6 +60,14 @@ export declare type RatingElement<T = any> = DocumentElementBase<T> & {
     getRatingPercentage?: (doc: T) => number;
     key: string;
 };
+export declare type SingleStarRatingElement<T = any> = DocumentElementBase<T> & {
+    type: DocumentElementType.SINGLE_STAR_RATING;
+    labels: RatingLabels;
+    links: RatingLinks;
+    key: string;
+    totalKey: string;
+    displayRating: (doc: T) => string;
+};
 export declare type RatingLabels = {
     numberOfRatings: string;
 };
@@ -75,4 +86,4 @@ export declare type CustomHtmlElement<T = any> = DocumentElementBase<T> & {
     html: (document: T) => string;
     className: string;
 };
-export declare type DocumentElement = ImageDocumentElement | TitleDocumentElement | DescriptionDocumentElement | CustomDocumentElement | PriceElement | RegularPriceDocumentElement | RatingElement | AddToCartElement | CustomHtmlElement;
+export declare type DocumentElement = ImageDocumentElement | TitleDocumentElement | DescriptionDocumentElement | CustomDocumentElement | PriceElement | RegularPriceDocumentElement | RatingElement | SingleStarRatingElement | AddToCartElement | CustomHtmlElement;

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

@@ -1,11 +1,13 @@
 import { SdkOptions } from "../General";
 import { RoutingBehavior } from "../search-results/RoutingBehavior";
+import { DynamicData } from "../search-results/SearchResultsOptions";
 import { SearchBoxHistory } from "./SearchBoxHistory";
 import { SearchBoxPanel } from "./SearchBoxPanel";
 export declare type SearchBoxOptions = SearchBoxPanelOptions & {
     inputSelector: string;
     searchTriggers?: string[];
     routingBehavior?: RoutingBehavior;
+    dynamicData?: DynamicData;
 };
 export declare type SearchBoxOptionLabels = {
     placeholder: string;

package/dist/es/types/search-results/SearchResultsOptions.d.ts

@@ -10,6 +10,7 @@ export declare type SearchResultsOptions = SearchResultsProductOptions & SearchR
     disallowEmptyQuery?: boolean;
     callbacks?: SearchResultEventCallbacks;
     categories?: CategoryFilterOptions;
+    dynamicData?: DynamicData;
 };
 export declare type SearchTitlePosition = "page-top" | "search-results-top";
 export declare type SearchResultsDidYouMeanLabels = {
@@ -163,3 +164,8 @@ export declare type SearchResultsBreadcrumb = {
     label: string;
     link?: string;
 };
+export declare type DynamicData = {
+    enabled?: boolean;
+    cache?: boolean;
+    handler?: (documentIds: string[]) => Promise<Record<"id" | string, unknown>[]>;
+};

package/dist/iife/components/search-box/products/SearchBoxProductsWrapper.vue.d.ts

@@ -19,8 +19,14 @@ export default class SearchBoxProductsWrapper extends Vue {
         queryKey: string;
         result?: SearchQueryResult;
     }>;
+    enhanceData: ({ result, mode, }: {
+        result: SearchQueryResult;
+        mode: "searchBox";
+    }) => Promise<void>;
     created(): void;
     onInputChange(): void;
     getItemsDebounced: () => unknown;
+    enhanceDataDebounced: () => unknown;
+    enhancePanelData(): Promise<void>;
     getItems(): void;
 }

package/dist/iife/components/search-box/products/elements/SearchBoxProductElement.vue.d.ts

@@ -6,6 +6,10 @@ export default class SearchBoxProductElement extends Vue {
     item: Document;
     element: DocumentElement;
     labels?: SearchBoxOptionLabels;
+    loading: boolean;
+    dynamicDataIdMap: Record<string, Document>;
     get elementComponent(): string;
     get displayElement(): boolean;
+    get isLoadingDynamicData(): boolean;
+    get enhancedItem(): Document;
 }

package/dist/iife/components/search-results/SearchResults.vue.d.ts

@@ -24,6 +24,9 @@ export default class SearchResults extends Vue {
         queryKey: string;
         results: SearchQueryResult;
     }) => void;
+    enhanceData: ({ result, }: {
+        result: SearchQueryResult;
+    }) => Promise<void>;
     searchString: string;
     setDefaultLimit: (defaultLimit: number) => {
         defaultLimit: number;
@@ -62,7 +65,7 @@ export default class SearchResults extends Vue {
     handleResults({ queryKey, results, }: {
         queryKey: string;
         results: SearchQueryResult;
-    }): void;
+    }): Promise<void>;
     setScreenWidth: ({ width, }: {
         width: number;
     }) => void;

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

@@ -11,6 +11,7 @@ export default class SearchResultsProductCard extends Vue {
     product: Document;
     options: SearchResultsProductCardOptions;
     isAdditionalPanel: boolean;
+    isInStock: boolean;
     layout: ResultsLayout;
     searchResultsRoutingBehavior: RoutingBehavior;
     searchResultOptions: SearchResultsOptions;
@@ -26,7 +27,8 @@ export default class SearchResultsProductCard extends Vue {
     get labels(): SearchResultsOptionLabels;
     get link(): string;
     get hasEventRouting(): boolean;
-    isInStock: boolean;
+    get elementGroups(): string[];
+    getGroupElements(group: string): DocumentElement[];
     mounted(): void;
     checkIfIsInStock(): Promise<void>;
     get id(): string;

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

@@ -8,8 +8,12 @@ export default class SearchResultsProductCardElement extends Vue {
     labels?: SearchBoxOptionLabels;
     inStock?: boolean;
     link: string;
+    dynamicDataIdMap: Record<string, Document>;
+    loading: boolean;
     get elementComponent(): string;
     get displayElement(): boolean;
+    get isLoadingDynamicData(): boolean;
+    get enhancedItem(): Document;
     handleProductEvent(item: {
         type: string;
     }): void;

package/dist/iife/components/search-results/products/product-card/elements/SearchResultsProductSingleStarRating.vue.d.ts

@@ -0,0 +1,11 @@
+import Vue from "vue";
+import { Document } from "@getlupa/client-sdk/Types";
+import { SingleStarRatingElement } from "@/types/DocumentElement";
+export default class SearchResultsProductSingleStarRating extends Vue {
+    item: Document;
+    options: SingleStarRatingElement;
+    get totalRatings(): string;
+    get ratingLink(): string;
+    get rating(): string;
+    get star(): string;
+}

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

@@ -14,3 +14,4 @@ export declare const DEFAULT_PAGE_SIZE = 12;
 export declare const DEFAULT_PAGE_SIZE_SELECTION: number[];
 export declare const LUPA_ROUTING_EVENT = "lupaRedirect";
 export declare const DEFAULT_CONTAINER_STYLE = "containerStyle.css";
+export declare const RATING_STAR_HTML = "☆";

package/dist/iife/index.d.ts

@@ -1,8 +1,8 @@
 import { SearchBoxOptions } from "./types/search-box/SearchBoxOptions";
-import { CallbackContext, FacetFilterQuery, FacetStyle, ResultFacetOptions, SearchResultEventCallbacks, SearchResultsFilterOptions, SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
+import { CallbackContext, DynamicData, FacetFilterQuery, FacetStyle, ResultFacetOptions, SearchResultEventCallbacks, SearchResultsFilterOptions, SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
 import { SdkOptions, TrackingOptions, Environment, SortDirection } from "./types/General";
 import { CategoryFilterOptions, ProductListOptions } from "./types/product-list/ProductListOptions";
-import { AddToCartElement, CustomDocumentElement, CustomHtmlElement, DescriptionDocumentElement, DocumentElement, DocumentElementType, ImageDocumentElement, PriceElement, RatingElement, RegularPriceDocumentElement, TitleDocumentElement } from "./types/DocumentElement";
+import { AddToCartElement, CustomDocumentElement, CustomHtmlElement, DescriptionDocumentElement, DocumentElement, DocumentElementType, ImageDocumentElement, PriceElement, RatingElement, RegularPriceDocumentElement, SingleStarRatingElement, TitleDocumentElement } from "./types/DocumentElement";
 import { SearchBoxPanelType } from "./types/search-box/SearchBoxPanel";
 import { RoutingBehavior } from "./types/search-results/RoutingBehavior";
 import { AnchorPosition } from "./types/search-results/SearchResultsProductCardOptions";
@@ -23,5 +23,5 @@ declare const lupaSearch: {
     clearProductList: (selector?: string | undefined) => void;
     clearSearchContainer: (selector?: string | undefined) => void;
 };
-export { TrackingOptions, SearchBoxOptions, SearchResultsOptions, ProductListOptions, SdkOptions, DocumentElementType, SearchBoxPanelType, FacetStyle, Environment, RoutingBehavior, AnchorPosition, BadgeType, SortDirection, DocumentElement, ImageDocumentElement, TitleDocumentElement, DescriptionDocumentElement, CustomDocumentElement, PriceElement, RegularPriceDocumentElement, RatingElement, AddToCartElement, CustomHtmlElement, SortOptions, SearchResultsSortOptions, SearchResultEventCallbacks, CallbackContext, FacetFilterQuery, CategoryFilterOptions, SearchResultsFilterOptions, SearchResultBadgeType, SearchResultBadgeElement, ResultFacetOptions, BadgeGenerateSeed, BadgeGenerateOptions, BadgeOptions, MountOptions, SearchContainerOptions, SearchContainerConfigOptions, };
+export { TrackingOptions, SearchBoxOptions, SearchResultsOptions, ProductListOptions, SdkOptions, DocumentElementType, SearchBoxPanelType, FacetStyle, Environment, RoutingBehavior, AnchorPosition, BadgeType, SortDirection, DocumentElement, ImageDocumentElement, TitleDocumentElement, DescriptionDocumentElement, CustomDocumentElement, PriceElement, RegularPriceDocumentElement, RatingElement, AddToCartElement, CustomHtmlElement, SortOptions, SearchResultsSortOptions, SearchResultEventCallbacks, CallbackContext, FacetFilterQuery, CategoryFilterOptions, SearchResultsFilterOptions, SearchResultBadgeType, SearchResultBadgeElement, ResultFacetOptions, BadgeGenerateSeed, BadgeGenerateOptions, BadgeOptions, MountOptions, SearchContainerOptions, SearchContainerConfigOptions, SingleStarRatingElement, DynamicData, };
 export default lupaSearch;