@getlupa/vue 0.13.7 → 0.14.1

package/dist/src/components/search-box/products/elements/SearchBoxProductCustomHtml.vue.d.ts

@@ -1,4 +1,5 @@
 import type { PropType as __PropType } from 'vue';
+import type { Document } from '@getlupa/client-sdk/Types';
 import type { CustomHtmlElement } from '../../../../types/DocumentElement';
 declare const _sfc_main: import("vue").DefineComponent<{
     item: {

package/dist/src/types/DataExtraction.d.ts

@@ -0,0 +1,19 @@
+export type ExtractFrom = 'url' | 'localStorage' | 'sessionStorage' | 'htmlElementText';
+export type BaseExtractFrom = {
+    extractFrom: ExtractFrom;
+    default: string | number | Record<string, unknown>;
+};
+export type ExtractFromUrl = BaseExtractFrom & {
+    extractFrom: 'url';
+    regex: string;
+};
+export type ExtractFromStorage = BaseExtractFrom & {
+    extractFrom: 'localStorage' | 'sessionStorage';
+    key: string;
+    path?: string;
+};
+export type ExtractFromHtmlElementText = BaseExtractFrom & {
+    extractFrom: 'htmlElementText';
+    querySelector: string;
+};
+export type DataExtraction = ExtractFromUrl | ExtractFromStorage | ExtractFromHtmlElementText;

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

@@ -10,10 +10,14 @@ export declare enum DocumentElementType {
     ADDTOCART = "addToCart",
     CUSTOM_HTML = "customHtml"
 }
+export type DisplayCondition = {
+    condition: 'exists' | 'equals' | 'notEquals' | 'greaterThan' | 'lessThan' | 'greaterThanOrEquals' | 'lessThanOrEquals';
+    fields: (string | number)[];
+};
 export type DocumentElementBase<T = any> = {
     type: DocumentElementType;
     key?: string;
-    display?: (document: T) => boolean;
+    display?: DisplayCondition | ((document: T) => boolean);
     isHtml?: boolean;
     group?: string;
     dynamic?: boolean;
@@ -87,13 +91,14 @@ export type RatingLinks = {
 export type AddToCartElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.ADDTOCART;
     action: (document: T, amount: number) => Promise<unknown> | undefined;
+    emitEvent: string;
     labels: {
         addToCart: string;
     };
 };
 export type CustomHtmlElement<T = any> = DocumentElementBase<T> & {
     type: DocumentElementType.CUSTOM_HTML;
-    html: (document: T) => string;
+    html: string | ((document: T) => string);
     className: string;
     action?: (document: T) => Promise<unknown> | undefined;
     reportEventOnClick?: string;

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

@@ -1,6 +1,7 @@
 import type { FilterGroup } from '@getlupa/client-sdk/Types';
 import type { RoutingBehavior } from '../search-results/RoutingBehavior';
 import type { SearchResultsOptions } from '../search-results/SearchResultsOptions';
+import { DataExtraction } from '../DataExtraction';
 export type CategoryFilterOptions = {
     queryKey?: string;
     routingBehavior?: RoutingBehavior;
@@ -24,6 +25,6 @@ export type CategoryFilterOptions = {
     };
 };
 export type ProductListOptions = SearchResultsOptions & {
-    initialFilters?: FilterGroup;
+    initialFilters?: FilterGroup | Record<string, DataExtraction>;
     categories?: CategoryFilterOptions;
 };

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

@@ -1,6 +1,7 @@
 import { FilterGroup } from '@getlupa/client-sdk/Types';
 import type { SdkOptions } from '../General';
 import { SearchResultsProductOptions } from '../search-results/SearchResultsOptions';
+import { DataExtraction } from '../DataExtraction';
 export type RecommenderCarouselOptions = {
     itemsToShow?: number;
     snapAlign?: string;
@@ -12,7 +13,7 @@ export type ProductRecommendationOptions = SearchResultsProductOptions & {
 } & {
     containerSelector: string;
     queryKey: string;
-    itemId: string[] | string;
+    itemId: DataExtraction | (string[] | string);
     abTesting?: RecommendationABTestingOptions;
     carousel?: RecommenderCarouselOptions;
     recommendationFilters?: FilterGroup;

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

@@ -1,4 +1,4 @@
-import type { DocumentElement } from '../DocumentElement';
+import type { DisplayCondition, DocumentElement } from '../DocumentElement';
 import type { Document } from '@getlupa/client-sdk/Types';
 import { CustomDocumentHtmlAttributes } from '../General';
 import { SearchBoxBadgeOptions } from './SearchBoxBadgeOptions';
@@ -34,7 +34,7 @@ export type DocumentSearchBoxPanel = SearchBoxPanelBase & {
     searchBySuggestion?: boolean;
     badges?: SearchBoxBadgeOptions;
     showGoToResults?: boolean;
-    isInStock?: (doc: Document) => boolean;
+    isInStock?: DisplayCondition | ((doc: Document) => boolean);
     customDocumentHtmlAttributes?: CustomDocumentHtmlAttributes;
 };
 export type RelatedSourcePanel = Omit<DocumentSearchBoxPanel, 'type'> & {

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

@@ -1,3 +1,4 @@
+import { DisplayCondition } from '../DocumentElement';
 import type { AnchorPosition } from './SearchResultsProductCardOptions';
 export type SearchResultBadgeType = 'text' | 'image' | 'customHtml';
 export type BadgeGenerateSeed = {
@@ -27,10 +28,10 @@ export type SearchResultBadgeElement<T = any> = {
     isHtml?: boolean;
     className?: string;
     product?: T;
-    display?: (document: T) => boolean;
+    display?: DisplayCondition | ((document: T) => boolean);
     rootImageUrl?: string;
     maxItems?: number;
-    html?: (doc: T) => string;
+    html?: string | ((doc: T) => string);
     position?: 'card' | 'image';
 };
 export type BaseBadgeElement<T = any> = SearchResultBadgeElement<T> & {
@@ -49,7 +50,7 @@ export type ImageBadgeElement<T = any> = BaseBadgeElement<T> & {
 export type CustomHtmlBadgeElement<T = any> = BaseBadgeElement<T> & {
     type: 'customHtml';
     className?: string;
-    html: (doc: T) => string;
+    html?: string | ((doc: T) => string);
 };
 export type BadgeElement = BaseBadgeElement | TextBadgeElement;
 export declare enum BadgeType {

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

@@ -1,5 +1,5 @@
 import type { Document } from '@getlupa/client-sdk/Types';
-import type { DocumentElement } from '../DocumentElement';
+import type { DisplayCondition, DocumentElement } from '../DocumentElement';
 import type { BadgeElement, BadgeGenerateOptions } from './BadgeOptions';
 import type { RoutingBehavior } from './RoutingBehavior';
 import type { SearchResultsOptionLabels } from './SearchResultsOptions';
@@ -7,7 +7,7 @@ import { CustomDocumentHtmlAttributes } from '../General';
 export type SearchResultsProductCardOptions = {
     labels: SearchResultsOptionLabels;
     routingBehavior?: RoutingBehavior;
-    isInStock?: (doc: Document) => boolean;
+    isInStock?: DisplayCondition | ((doc: Document) => boolean);
     badges?: SearchResultBadgeOptions;
     links?: {
         details: string;

package/dist/src/utils/extraction.utils.d.ts

@@ -0,0 +1,3 @@
+import { DataExtraction } from '../types/DataExtraction';
+export declare const extractValue: <T>(options: DataExtraction) => T;
+export declare const processExtractionObject: (value?: Record<string, unknown>) => Record<string, unknown>;

package/dist/src/utils/picker.utils.d.ts

@@ -3,3 +3,4 @@ export declare const getHint: (suggestion: string, inputValue: string) => string
 export declare const reverseKeyValue: (obj: Record<string, string>) => Record<string, string>;
 export declare const pickClosestNumber: (numbers: number[], closestTo: number) => number;
 export declare const getPageCount: (total: number, limit: number) => number;
+export declare const isObject: (value: unknown) => boolean;

package/dist/src/utils/render.utils.d.ts

@@ -0,0 +1,3 @@
+import { DisplayCondition } from '../types/DocumentElement';
+export declare const renderHtmlTemplate: (template: string, document?: Record<string, unknown>) => string;
+export declare const processDisplayCondition: (displayCondition: DisplayCondition, doc?: Record<string, unknown>) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getlupa/vue",
-  "version": "0.13.7",
+  "version": "0.14.1",
   "main": "dist/lupaSearch.mjs",
   "module": "dist/lupaSearch.mjs",
   "types": "dist/src/index.d.ts",
@@ -66,5 +66,9 @@
     "vue": "^3.3.4",
     "vue-tsc": "^1.6.5",
     "vue3-carousel": "^0.3.1"
+  },
+  "dependencies": {
+    "mustache": "^4.2.0",
+    "sanitize-html": "^2.13.0"
   }
 }