@getlupa/client 0.7.0 → 0.8.0-alpha-1

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

@@ -1,4 +1,3 @@
-import { Document } from "@getlupa/client-sdk/Types";
 export declare enum DocumentElementType {
     IMAGE = "image",
     TITLE = "title",
@@ -10,48 +9,50 @@ export declare enum DocumentElementType {
     ADDTOCART = "addToCart",
     CUSTOM_HTML = "customHtml"
 }
-export declare type DocumentElementBase = {
+export declare type DocumentElementBase<T = any> = {
     type: DocumentElementType;
     key?: string;
-    display?: (document: Record<string, unknown>) => boolean;
+    display?: (document: T) => boolean;
     isHtml?: boolean;
 };
-export declare type ImageDocumentElement = DocumentElementBase & {
+export declare type ImageDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.IMAGE;
     placeholder: string;
     baseUrl?: string;
     key: string;
 };
-export declare type TitleDocumentElement = DocumentElementBase & {
+export declare type TitleDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.TITLE;
     maxLines: number;
     link?: boolean;
     key: string;
 };
-export declare type DescriptionDocumentElement = DocumentElementBase & {
+export declare type DescriptionDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.DESCRIPTION;
     maxLines: number;
     key: string;
+    className: string;
 };
-export declare type CustomDocumentElement = DocumentElementBase & {
+export declare type CustomDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.CUSTOM;
+    maxLines?: number;
     className: string;
     key: string;
 };
-export declare type PriceElement = DocumentElementBase & {
+export declare type PriceElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.PRICE;
     key: string;
 };
-export declare type RegularPriceDocumentElement = DocumentElementBase & {
+export declare type RegularPriceDocumentElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.REGULARPRICE;
     key: string;
 };
-export declare type RatingElement = DocumentElementBase & {
+export declare type RatingElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.RATING;
     labels: RatingLabels;
     links: RatingLinks;
     totalKey: string;
-    getRatingPercentage?: (doc: Document) => number;
+    getRatingPercentage?: (doc: T) => number;
     key: string;
 };
 export declare type RatingLabels = {
@@ -60,16 +61,16 @@ export declare type RatingLabels = {
 export declare type RatingLinks = {
     ratingDetails?: string;
 };
-export declare type AddToCartElement = DocumentElementBase & {
+export declare type AddToCartElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.ADDTOCART;
-    action: (document: Document, amount: number) => Promise<unknown> | undefined;
+    action: (document: T, amount: number) => Promise<unknown> | undefined;
     labels: {
         addToCart: string;
     };
 };
-export declare type CustomHtmlElement = DocumentElementBase & {
+export declare type CustomHtmlElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.CUSTOM_HTML;
-    html: (document: Document) => string;
+    html: (document: T) => string;
     className: string;
 };
 export declare type DocumentElement = ImageDocumentElement | TitleDocumentElement | DescriptionDocumentElement | CustomDocumentElement | PriceElement | RegularPriceDocumentElement | RatingElement | AddToCartElement | CustomHtmlElement;

package/dist/cjs/types/product-list/ProductListOptions.d.ts

@@ -14,12 +14,13 @@ export declare type CategoryFilterOptions = {
         title: string;
     };
     parent?: {
-        url: string;
-        title: string;
+        url?: string;
+        title?: string;
     };
     current?: {
-        title: string;
-        description: string;
+        title?: string;
+        description?: string;
+        descriptionTop?: string;
     };
 };
 export declare type ProductListOptions = SearchResultsOptions & {

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

@@ -1,35 +1,52 @@
-import { Document } from "@getlupa/client-sdk/Types";
 import { AnchorPosition } from "./SearchResultsProductCardOptions";
 export declare type SearchResultBadgeType = "text" | "image" | "customHtml";
+export declare type BadgeGenerateSeed = {
+    id?: string;
+    backgroundColor?: string;
+    color?: string;
+    titleText?: string;
+    additionalText?: string;
+};
+export declare type BadgeGenerateOptions<T = Record<string, any>> = {
+    key?: string;
+    keyMap?: Record<keyof BadgeGenerateSeed, keyof T>;
+    image?: (field: BadgeGenerateSeed) => string | undefined;
+};
 export declare type BadgeOptions = {
     anchor: AnchorPosition;
     elements: BadgeElement[];
-    product: Document;
+    generate?: BadgeGenerateOptions;
+    product?: any;
 };
-export declare type SearchResultBadgeElement = {
+export declare type SearchResultBadgeElement<T = any> = {
     type: SearchResultBadgeType;
     key: string;
-    isHtml: boolean;
-    product: Document;
-    display?: (document: Record<string, unknown>) => boolean;
+    isHtml?: boolean;
+    className?: string;
+    product?: T;
+    display?: (document: T) => boolean;
+    rootImageUrl?: string;
+    maxItems?: number;
+    html?: (doc: T) => string;
+    position?: "card" | "image";
 };
-export declare type BaseBadgeElement = SearchResultBadgeElement & {
+export declare type BaseBadgeElement<T = any> = SearchResultBadgeElement<T> & {
     value?: string;
 };
-export declare type TextBadgeElement = BaseBadgeElement & {
+export declare type TextBadgeElement<T = any> = BaseBadgeElement<T> & {
     type: "text";
     prefix?: string;
     maxItems?: number;
 };
-export declare type ImageBadgeElement = BaseBadgeElement & {
+export declare type ImageBadgeElement<T = any> = BaseBadgeElement<T> & {
     type: "image";
     rootImageUrl?: string;
     maxItems?: number;
 };
-export declare type CustomHtmlBadgeElement = BaseBadgeElement & {
+export declare type CustomHtmlBadgeElement<T = any> = BaseBadgeElement<T> & {
     type: "customHtml";
-    className: string;
-    html: (doc: Document) => string;
+    className?: string;
+    html: (doc: T) => string;
 };
 export declare type BadgeElement = BaseBadgeElement | TextBadgeElement;
 export declare enum BadgeType {

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

@@ -9,6 +9,7 @@ export declare type SearchResultsOptions = SearchResultsProductOptions & SearchR
     classMap?: Record<string, string>;
     disallowEmptyQuery?: boolean;
     callbacks?: SearchResultEventCallbacks;
+    categories?: CategoryFilterOptions;
 };
 export declare type SearchTitlePosition = "page-top" | "search-results-top";
 export declare type SearchResultsDidYouMeanLabels = {
@@ -22,12 +23,15 @@ export declare type SearchResultsSimilarQueriesLabels = {
 };
 export declare type CallbackContext = {
     queryKey: string;
-    hasResults: boolean;
+    hasResults?: boolean;
+    urlQueryString?: string;
 };
 export declare type SearchResultEventCallbacks = {
     onSearchResults?: (context: CallbackContext) => unknown;
     onAdditionalPanelResults?: (context: CallbackContext) => unknown;
     onCategoryFilterResults?: (context: CallbackContext) => unknown;
+    onProductClick?: (context: CallbackContext) => unknown;
+    onUrlQueryChange?: (context: CallbackContext) => unknown;
     onMounted?: () => unknown;
 };
 export declare type SearchResultsOptionLabels = SearchResultsPaginationLabels & SearchResultsDidYouMeanLabels & SearchResultsSimilarQueriesLabels & {
@@ -73,6 +77,7 @@ export declare type ProductGrid = {
 export declare type SearchResultsPaginationLabels = {
     pageSize: string;
     showMore: string;
+    showLess?: string;
 };
 export declare type ResponsiveSearchResultPageSizes = {
     xs: number[];

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

@@ -1,6 +1,6 @@
 import { Document } from "@getlupa/client-sdk/Types";
 import { DocumentElement } from "../DocumentElement";
-import { BadgeElement } from "./BadgeOptions";
+import { BadgeElement, BadgeGenerateOptions } from "./BadgeOptions";
 import { RoutingBehavior } from "./RoutingBehavior";
 import { SearchResultsOptionLabels } from "./SearchResultsOptions";
 export declare type SearchResultsProductCardOptions = {
@@ -18,5 +18,6 @@ export declare type SearchResultsProductCardOptions = {
 export declare type SearchResultBadgeOptions = {
     anchor: AnchorPosition;
     elements: BadgeElement[];
+    generate?: BadgeGenerateOptions;
 };
 export declare type AnchorPosition = "tr" | "tl";

package/dist/es/ProductListEntry.vue.d.ts

@@ -3,4 +3,5 @@ import { ProductListOptions } from "./types/product-list/ProductListOptions";
 export default class ProductListEntry extends Vue {
     productListOptions: ProductListOptions;
     get fullProductListOptions(): ProductListOptions;
+    fetch(): void;
 }

package/dist/es/SearchBoxEntry.vue.d.ts

@@ -3,4 +3,5 @@ import Vue from "vue";
 export default class SearchBoxEntry extends Vue {
     searchBoxOptions: SearchBoxOptions;
     get fullSearchBoxOptions(): SearchBoxOptions;
+    fetch(): void;
 }

package/dist/es/SearchResultsEntry.vue.d.ts

@@ -3,4 +3,5 @@ import { SearchResultsOptions } from "./types/search-results/SearchResultsOption
 export default class SearchResultsEntry extends Vue {
     searchResultsOptions: SearchResultsOptions;
     get fullSearchResultsOptions(): SearchResultsOptions;
+    fetch(): void;
 }

package/dist/es/components/product-list/ProductList.vue.d.ts

@@ -3,4 +3,5 @@ import { ProductListOptions } from "@/types/product-list/ProductListOptions";
 export default class ProductList extends Vue {
     options: ProductListOptions;
     get componentOptions(): ProductListOptions;
+    fetch(): void;
 }

package/dist/es/components/search-results/SearchResultsTitle.vue.d.ts

@@ -9,5 +9,6 @@ export default class SearchResultsTitle extends Vue {
     get queryText(): string;
     get showProductCount(): boolean;
     get showSearchTitle(): boolean;
+    get descriptionTop(): string | undefined;
     getLabel(label: string): string;
 }

package/dist/es/components/search-results/filters/facets/StatsFacet.vue.d.ts

@@ -26,6 +26,8 @@ export default class TermFacet extends Vue {
     get facetMin(): number;
     get facetMax(): number;
     get statsSummary(): string;
+    get separator(): string;
+    get sliderInputFormat(): string | undefined;
     onMinValueChange(): void;
     onMaxValueChange(): void;
     handleInputChange(): void;

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

@@ -3,7 +3,7 @@ import { TrackableEventData } from "@/types/search-box/Common";
 import { BadgeOptions } from "@/types/search-results/BadgeOptions";
 import { ResultsLayout } from "@/types/search-results/ResultsLayout";
 import { RoutingBehavior } from "@/types/search-results/RoutingBehavior";
-import { SearchResultsOptionLabels } from "@/types/search-results/SearchResultsOptions";
+import { SearchResultsOptionLabels, SearchResultsOptions } from "@/types/search-results/SearchResultsOptions";
 import { SearchResultsProductCardOptions } from "@/types/search-results/SearchResultsProductCardOptions";
 import { Document, ReportableEventType } from "@getlupa/client-sdk/Types";
 import Vue from "vue";
@@ -13,6 +13,7 @@ export default class SearchResultsProductCard extends Vue {
     isAdditionalPanel: boolean;
     layout: ResultsLayout;
     searchResultsRoutingBehavior: RoutingBehavior;
+    searchResultOptions: SearchResultsOptions;
     query: string;
     trackClick: ({ queryKey, data, }: {
         queryKey: string;

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

@@ -0,0 +1,9 @@
+import { BadgeGenerateSeed, BadgeOptions } from "@/types/search-results/BadgeOptions";
+import Vue from "vue";
+export default class SearchResultGeneratedBadge extends Vue {
+    options: BadgeOptions;
+    badge: BadgeGenerateSeed;
+    get image(): string | undefined;
+    get hasAdditionalText(): boolean;
+    get hasTitleText(): boolean;
+}

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

@@ -0,0 +1,9 @@
+import { BadgeGenerateSeed, BadgeOptions } from "@/types/search-results/BadgeOptions";
+import Vue from "vue";
+export default class SearchResultGeneratedBadges extends Vue {
+    options: BadgeOptions;
+    get badgeField(): Record<string, any>[];
+    get keyMap(): Record<string, string>;
+    get hasBadges(): boolean;
+    get badges(): BadgeGenerateSeed[];
+}

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

@@ -2,8 +2,10 @@ 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 {
+    position: "card" | "image";
     options: BadgeOptions;
     get anchorPosition(): AnchorPosition;
     get badges(): BadgeElement[];
+    get displayBadges(): BadgeElement[];
     getBadgeComponent(type: string): string;
 }

package/dist/es/index.d.ts

@@ -1,21 +1,24 @@
 import { SearchBoxOptions } from "./types/search-box/SearchBoxOptions";
-import { CallbackContext, FacetFilterQuery, FacetStyle, SearchResultEventCallbacks, SearchResultsOptions } from "./types/search-results/SearchResultsOptions";
+import { CallbackContext, 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 { SearchBoxPanelType } from "./types/search-box/SearchBoxPanel";
 import { RoutingBehavior } from "./types/search-results/RoutingBehavior";
 import { AnchorPosition } from "./types/search-results/SearchResultsProductCardOptions";
-import { BadgeType } from "./types/search-results/BadgeOptions";
+import { BadgeGenerateOptions, BadgeGenerateSeed, BadgeOptions, BadgeType, SearchResultBadgeElement, SearchResultBadgeType } from "./types/search-results/BadgeOptions";
 import { SearchResultsSortOptions, SortOptions } from "./types/search-results/SearchResultsSort";
+declare type MountOptions = {
+    fetch: boolean;
+};
 declare const lupaSearch: {
-    searchBox: (options: SearchBoxOptions) => void;
-    searchResults: (options: SearchResultsOptions) => void;
+    searchBox: (options: SearchBoxOptions, mountOptions?: MountOptions | undefined) => void;
+    searchResults: (options: SearchResultsOptions, mountOptions?: MountOptions | undefined) => void;
     tracking: (options: TrackingOptions) => void;
-    productList: (options: ProductListOptions) => void;
-    clearSearchBox: () => void;
-    clearSearchResults: () => void;
-    clearProductList: () => void;
+    productList: (options: ProductListOptions, mountOptions?: MountOptions | undefined) => void;
+    clearSearchBox: (selector?: string | undefined) => void;
+    clearSearchResults: (selector?: string | undefined) => void;
+    clearProductList: (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, };
+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, };
 export default lupaSearch;