@getlupa/client 0.15.2 → 0.16.0-alpha-1

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

@@ -1,5 +1,5 @@
 export declare const PARENT_EVENT_NAME = "GetLupa";
-export declare type AnalyticsEventType = "search_query" | "search_form_submit" | "autocomplete_suggestion_click" | "autocomplete_product_click" | "search_product_click" | "search_zero_results" | "search_filters" | "search_add_to_cart" | "view_item_list" | "select_item";
+export declare type AnalyticsEventType = "search_query" | "search_form_submit" | "autocomplete_suggestion_click" | "autocomplete_product_click" | "search_product_click" | "search_zero_results" | "search_filters" | "search_add_to_cart" | "view_item_list" | "select_item" | "product_recommendation_click";
 export declare type AnalyticsOptions = {
     type: "ua" | "ga4" | "debug";
     enabled: boolean;
@@ -7,3 +7,8 @@ export declare type AnalyticsOptions = {
     ignoreEvents?: AnalyticsEventType[];
     itemMap?: (item: Record<string, unknown>) => Record<string, unknown>;
 };
+export declare type ProductClickTrackingSettings = {
+    eventType?: AnalyticsEventType;
+    eventLabel?: string;
+    listLabel?: string;
+};

package/dist/es/types/recommendations/RecommendationsOptions.d.ts

@@ -0,0 +1,22 @@
+import { SdkOptions } from "../General";
+import { SearchResultsProductCardOptions } from "../search-results/SearchResultsProductCardOptions";
+export declare type ProductRecommendationOptions = SearchResultsProductCardOptions & {
+    options: SdkOptions;
+} & {
+    containerSelector: string;
+    queryKey: string;
+    itemId: string;
+    abTesting?: RecommendationABTestingOptions;
+    carousel?: {
+        pageSizes: number[][];
+    };
+};
+export declare type RecommendationABTestingOptions = {
+    enabled: boolean;
+    originalIds?: string[];
+    events?: {
+        lupaSearchEventName: string;
+        originalEventName: string;
+    };
+    oldRecommenderDisplayRatio?: number;
+};

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

@@ -36,6 +36,7 @@ export declare type TrackableEventData = {
         label: string;
         listLabel?: string;
         items?: Record<string, unknown>[];
+        itemId?: string;
     };
     options?: {
         allowEmptySearchQuery: boolean;

package/dist/iife/RecommendationsEntry.vue.d.ts

@@ -0,0 +1,6 @@
+import Vue from "vue";
+import { ProductRecommendationOptions } from "./types/recommendations/RecommendationsOptions";
+export default class RecommendationsEntry extends Vue {
+    recommendationOptions: ProductRecommendationOptions;
+    fetch(): void;
+}

package/dist/iife/components/recommendations/Recommendations.vue.d.ts

@@ -0,0 +1,22 @@
+import Vue from "vue";
+import { ProductRecommendationOptions } from "@/types/recommendations/RecommendationsOptions";
+import { Document } from "@getlupa/client-sdk/Types";
+import { ProductClickTrackingSettings } from "@/types/AnalyticsOptions";
+import { SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
+export default class Recommendations extends Vue {
+    options: ProductRecommendationOptions;
+    recommendations: Document[];
+    recommendationsType: "recommendations_original" | "recommendations_lupasearch";
+    loading: boolean;
+    setSearchResultOptions: ({ options, }: {
+        options: SearchResultsOptions;
+    }) => void;
+    get pages(): number[][];
+    mounted(): void;
+    getProductKey(index: number, product: Document): string;
+    loadRecommendations(): void;
+    fetch(): void;
+    loadOriginalRecommendations(): Promise<void>;
+    loadLupaRecommendations(): Promise<void>;
+    get clickTrackingSettings(): ProductClickTrackingSettings;
+}

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

@@ -8,10 +8,12 @@ import { SearchResultsOptionLabels, SearchResultsOptions } from "@/types/search-
 import { SearchResultsProductCardOptions } from "@/types/search-results/SearchResultsProductCardOptions";
 import { Document, ReportableEventType } from "@getlupa/client-sdk/Types";
 import Vue from "vue";
+import { ProductClickTrackingSettings, AnalyticsEventType } from "@/types/AnalyticsOptions";
 export default class SearchResultsProductCard extends Vue {
     product: Document;
     options: SearchResultsProductCardOptions;
     isAdditionalPanel: boolean;
+    clickTrackingSettings: ProductClickTrackingSettings;
     isInStock: boolean;
     layout: ResultsLayout;
     searchResultsRoutingBehavior: RoutingBehavior;
@@ -35,6 +37,9 @@ export default class SearchResultsProductCard extends Vue {
     checkIfIsInStock(): Promise<void>;
     get id(): string;
     get title(): string;
+    get clickTrackingType(): AnalyticsEventType;
+    get trackingLabel(): string | undefined;
+    get trackingListLabel(): string | undefined;
     handleClick(): void;
     handleProductEvent(item: {
         type: ReportableEventType;

package/dist/iife/constants/development/recommendations.example.const.d.ts

@@ -0,0 +1,2 @@
+import { ProductRecommendationOptions } from "@/types/recommendations/RecommendationsOptions";
+export declare const RECOMMENDATIONS_OPTIONS: ProductRecommendationOptions;

package/dist/iife/index.d.ts

@@ -9,6 +9,7 @@ import { AnchorPosition } from "./types/search-results/SearchResultsProductCardO
 import { BadgeGenerateOptions, BadgeGenerateSeed, BadgeOptions, BadgeType, SearchResultBadgeElement, SearchResultBadgeType } from "./types/search-results/BadgeOptions";
 import { SearchResultsSortOptions, SortOptions } from "./types/search-results/SearchResultsSort";
 import { SearchContainerConfigOptions, SearchContainerOptions } from "./types/search-container/SearchContainerOptions";
+import { ProductRecommendationOptions, RecommendationABTestingOptions } from "./types/recommendations/RecommendationsOptions";
 declare type MountOptions = {
     fetch: boolean;
 };
@@ -18,10 +19,12 @@ declare const lupaSearch: {
     tracking: (options: TrackingOptions) => void;
     productList: (options: ProductListOptions, mountOptions?: MountOptions | undefined) => void;
     searchContainer: (options: SearchContainerOptions, mountOptions?: MountOptions | undefined) => void;
+    recommendations: (options: ProductRecommendationOptions, mountOptions?: MountOptions | undefined) => void;
     clearSearchBox: (selector?: string | undefined) => void;
     clearSearchResults: (selector?: string | undefined) => void;
     clearProductList: (selector?: string | undefined) => void;
     clearSearchContainer: (selector?: string | undefined) => void;
+    clearRecommendations: (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, SingleStarRatingElement, DynamicData, };
+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, ProductRecommendationOptions, RecommendationABTestingOptions, };
 export default lupaSearch;