@getlupa/client 0.13.0-alpha-6 → 0.14.1

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

@@ -0,0 +1,22 @@
+import { SearchBoxOptions } from "@/types/search-box/SearchBoxOptions";
+import { DynamicData, SearchResultsOptions } 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(): SearchResultsOptions;
+    get searchBoxOptions(): SearchBoxOptions;
+    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/iife/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/iife/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/iife/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getlupa/client",
-  "version": "0.13.0-alpha-6",
+  "version": "0.14.1",
   "main": "dist/cjs/index.min.js",
   "module": "dist/es/index.min.js",
   "types": "dist/es/index.d.ts",